Skip to content

exposed manifest to independent API consumers #174

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
FND wants to merge 2 commits into
base: main
Choose a base branch
from
Open

exposed manifest to independent API consumers #174

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6f30a16
exposed manifest to independent API consumers
FND Nov 21, 2025
fab81e3
removed obsolete polyfill
FND Nov 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion lib/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,12 @@ exports.faucetDispatch = async function faucetDispatch(referenceDir, config,
server.live(liveserve, assetManager.manifest.webRoot);
}

return res; // notifies consumers once the initial build has completed
// notify consumers once the initial build has completed
return res.then(() => ({
get manifest() {
return assetManager.manifest.entries;
}
Copy link
Contributor Author

@FND FND Nov 21, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This might be dangerously misleading: If consumers cache this value, they're gonna be working with an outdated manifest:

let { manifest } = await faucetDispatch(…);
await faucetDispatch(…);
console.log(manifest);

Here manifest ends up being a stale copy, not the live object.

}));
};

function buildStep(plugins) {
Expand Down
12 changes: 5 additions & 7 deletions lib/manifest.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,14 +42,12 @@ exports.Manifest = class Manifest {
this._index.set(key, uri);

let fp = this.filepath;
return fp ? createFile(fp, JSON.stringify(this) + "\n") : Promise.resolve(null);
return fp ?
createFile(fp, JSON.stringify(this.entries) + "\n") :
Promise.resolve(null);
}

toJSON() {
let index = this._index;
return Array.from(index.keys()).sort().reduce((memo, key) => {
memo[key] = index.get(key);
return memo;
}, {});
get entries() {
return Object.fromEntries(this._index);
}
};
21 changes: 2 additions & 19 deletions lib/util/runner.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ exports.SerializedRunner = class SerializedRunner {

run(...args) {
if(!this._pending) { // prevent concurrent execution
this._pending = augment(this.asyncOp(...args)).
this._pending = this.asyncOp(...args).
finally(() => {
this._pending = null;
});
Expand All @@ -24,7 +24,7 @@ exports.SerializedRunner = class SerializedRunner {
let enqueue = this._pending;
let res = this.run(...args);
if(enqueue) {
this._queued = res = augment(res).
this._queued = res = res.
finally(() => {
this._queued = null;
}).
Expand All @@ -33,20 +33,3 @@ exports.SerializedRunner = class SerializedRunner {
return res;
}
};

function augment(promise) {
promise.finally = always;
return promise;
}

// poor man's `Promise#finally` polyfill
function always(fn) {
return this.
then(res => {
fn();
return res;
}, err => {
fn();
throw err;
});
}
19 changes: 13 additions & 6 deletions test/test_manifest.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ let { describe, it, before, after } = require("node:test");
let path = require("path");
let assert = require("assert");

let assertSame = assert.strictEqual;
let assertDeep = assert.deepStrictEqual;

describe("manifest", () => {
let root = path.resolve(__dirname, "fixtures");
Expand All @@ -24,19 +24,26 @@ describe("manifest", () => {
let manifest = new Manifest(root);
return manifest.set("foo.png", "foo-abc123.png").
then(() => {
assertSame(JSON.stringify(manifest), '{"foo.png":"/foo-abc123.png"}');
assertDeep(manifest.entries, {
"foo.png": "/foo-abc123.png"
});

return manifest.set("bar.css", "bar-def456.css");
}).
then(() => {
assertSame(JSON.stringify(manifest),
'{"bar.css":"/bar-def456.css","foo.png":"/foo-abc123.png"}');
assertDeep(manifest.entries, {
"foo.png": "/foo-abc123.png",
"bar.css": "/bar-def456.css"
});

return manifest.set("xox.js", "xox-ghi789.js");
}).
then(() => {
assertSame(JSON.stringify(manifest), // eslint-disable-next-line max-len
'{"bar.css":"/bar-def456.css","foo.png":"/foo-abc123.png","xox.js":"/xox-ghi789.js"}');
assertDeep(manifest.entries, {
"foo.png": "/foo-abc123.png",
"bar.css": "/bar-def456.css",
"xox.js": "/xox-ghi789.js"
});
});
});
});