Skip to content
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.

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

bug/use Worker threads for full API routes cache busting in development mode #1105

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
43 changes: 43 additions & 0 deletions packages/cli/src/lib/api-route-worker.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
// https://github.com/nodejs/modules/issues/307#issuecomment-858729422
import { parentPort } from 'worker_threads';

// based on https://stackoverflow.com/questions/57447685/how-can-i-convert-a-request-object-into-a-stringifiable-object-in-javascript
async function responseAsObject (response) {
if (!response instanceof Response) {
throw Object.assign(
new Error(),
{ name: 'TypeError', message: 'Argument must be a Response object' }
);
}
response = response.clone();

function stringifiableObject (obj) {
const filtered = {};
for (const key in obj) {
if (['boolean', 'number', 'string'].includes(typeof obj[key]) || obj[key] === null) {
filtered[key] = obj[key];
}
}
return filtered;
}

// TODO handle full response
// https://github.com/ProjectEvergreen/greenwood/issues/1048
return {
...stringifiableObject(response),
headers: Object.fromEntries(response.headers),
// signal: stringifiableObject(request.signal),
body: await response.text()
};
}

async function executeRouteModule({ href, request }) {
const { handler } = await import(href);
const response = await handler(request);

parentPort.postMessage(await responseAsObject(response));
}

parentPort.on('message', async (task) => {
await executeRouteModule(task);
});
70 changes: 62 additions & 8 deletions packages/cli/src/plugins/resource/plugin-api-routes.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,37 @@
*
*/
import { ResourceInterface } from '../../lib/resource-interface.js';
import { Worker } from 'worker_threads';

// https://stackoverflow.com/questions/57447685/how-can-i-convert-a-request-object-into-a-stringifiable-object-in-javascript
function requestAsObject (request) {
if (!request instanceof Request) {
throw Object.assign(
new Error(),
{ name: 'TypeError', message: 'Argument must be a Request object' }
);
}
request = request.clone();

function stringifiableObject (obj) {
const filtered = {};
for (const key in obj) {
if (['boolean', 'number', 'string'].includes(typeof obj[key]) || obj[key] === null) {
filtered[key] = obj[key];
}
}
return filtered;
}

// TODO handle full response
// https://github.com/ProjectEvergreen/greenwood/issues/1048
return {
...stringifiableObject(request),
headers: Object.fromEntries(request.headers),
signal: stringifiableObject(request.signal)
// bodyText: await request.text(), // requires function to be async
};
}

class ApiRoutesResource extends ResourceInterface {
constructor(compilation, options) {
Expand All @@ -19,17 +50,40 @@ class ApiRoutesResource extends ResourceInterface {
async serve(url, request) {
const api = this.compilation.manifest.apis.get(url.pathname);
const apiUrl = new URL(`.${api.path}`, this.compilation.context.userWorkspace);
// https://github.com/nodejs/modules/issues/307#issuecomment-1165387383
const href = process.env.__GWD_COMMAND__ === 'develop' // eslint-disable-line no-underscore-dangle
? `${apiUrl.href}?t=${Date.now()}`
: apiUrl.href;

const { handler } = await import(href);
const req = new Request(new URL(`${request.url.origin}${url}`), {
const href = apiUrl.href;
const req = new Request(new URL(url), {
...request
});

return await handler(req);
// TODO does this ever run in anything but development mode?
if (process.env.__GWD_COMMAND__ === 'develop') { // eslint-disable-line no-underscore-dangle
const workerUrl = new URL('../../lib/api-route-worker.js', import.meta.url);

const response = await new Promise((resolve, reject) => {
const worker = new Worker(workerUrl);
const req = requestAsObject(request);

worker.on('message', (result) => {
resolve(result);
});
worker.on('error', reject);
worker.on('exit', (code) => {
if (code !== 0) {
reject(new Error(`Worker stopped with exit code ${code}`));
}
});

worker.postMessage({ href, request: req });
});

return new Response(response.body, {
...response
});
} else {
const { handler } = await import(href);

return await handler(req);
}
}
}

Expand Down