test: refactor serverless invocations so in-process and sandbox implementation use shared code and ability to run multiple invocations in same sandbox #2871
There are no files selected for viewing
File renamed without changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,2 @@ | ||
| export * from './helpers.js' | ||
| export * from './mock-file-system.js' | ||
|
There was a problem hiding this comment. this was never imported anywhere |
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,181 @@ | ||
| // @ts-check | ||
|
|
||
| // this is not TS file because it's used both directly inside test process | ||
| // as well as child process that lacks TS on-the-fly transpilation | ||
|
Comment on lines
+3
to
+4
There was a problem hiding this comment. I wonder if we could just use There was a problem hiding this comment. We could try, but ideally this is one that matches what vitest is using and I wasn't sure it was worth the effort given TS-ish jsdocs are possibility. I've done something like that in gatsbyjs/gatsby#32120 (you can grep for There was a problem hiding this comment. but I'd leave this as maybe for the future, ideally we won't have to touch this code for a long time (I only touched sandbox code once before - when it was originally written heh and now I'm touching it only to add a feature to it) |
||
|
|
||
| import { join } from 'node:path' | ||
| import { BLOB_TOKEN } from './constants.mjs' | ||
| import { execute as untypedExecute } from 'lambda-local' | ||
|
|
||
| const SERVER_HANDLER_NAME = '___netlify-server-handler' | ||
|
There was a problem hiding this comment. this is copied from (for the serverless invocation in same process it was imported from there, but it was previously already copied for sandboxed invocation because it can't import TS, so not fully new that this is duplicated) |
||
|
|
||
| /** | ||
| * @typedef {import('./contexts').FixtureTestContext} FixtureTestContext | ||
| * | ||
| * @typedef {Awaited<ReturnType<ReturnType<typeof import('@netlify/serverless-functions-api').getLambdaHandler>>>} LambdaResult | ||
| * | ||
| * @typedef {Object} FunctionInvocationOptions | ||
| * @property {Record<string, string>} [env] Environment variables that should be set during the invocation | ||
| * @property {string} [httpMethod] The http method that is used for the invocation. Defaults to 'GET' | ||
| * @property {string} [url] TThe relative path that should be requested. Defaults to '/' | ||
| * @property {Record<string, string>} [headers] The headers used for the invocation | ||
| * @property {Record<string, unknown>} [flags] Feature flags that should be set during the invocation | ||
| */ | ||
|
|
||
| /** | ||
| * This is helper to get LambdaLocal's execute to actually provide result type instead of `unknown` | ||
| * Because jsdoc doesn't seem to have equivalent of `as` in TS and trying to assign `LambdaResult` type | ||
| * to return value of `execute` leading to `Type 'unknown' is not assignable to type 'LambdaResult'` | ||
| * error, this types it as `any` instead which allow to later type it as `LambdaResult`. | ||
| * @param {Parameters<typeof untypedExecute>} args | ||
| * @returns {Promise<LambdaResult>} | ||
| */ | ||
| async function execute(...args) { | ||
| /** | ||
| * @type {any} | ||
| */ | ||
| const anyResult = await untypedExecute(...args) | ||
|
|
||
| return anyResult | ||
| } | ||
|
Comment on lines
+27
to
+42
There was a problem hiding this comment. This is equavalent for |
||
|
|
||
| /** | ||
| * @param {FixtureTestContext} ctx | ||
| */ | ||
| export const createBlobContext = (ctx) => | ||
| Buffer.from( | ||
| JSON.stringify({ | ||
| edgeURL: `http://${ctx.blobStoreHost}`, | ||
| uncachedEdgeURL: `http://${ctx.blobStoreHost}`, | ||
| token: BLOB_TOKEN, | ||
| siteID: ctx.siteID, | ||
| deployID: ctx.deployID, | ||
| primaryRegion: 'us-test-1', | ||
| }), | ||
| ).toString('base64') | ||
|
|
||
| /** | ||
| * Converts a readable stream to a buffer | ||
| * @param {NodeJS.ReadableStream} stream | ||
| * @returns {Promise<Buffer>} | ||
| */ | ||
| function streamToBuffer(stream) { | ||
| /** | ||
| * @type {Buffer[]} | ||
| */ | ||
| const chunks = [] | ||
|
|
||
| return new Promise((resolve, reject) => { | ||
| stream.on('data', (chunk) => chunks.push(Buffer.from(chunk))) | ||
| stream.on('error', (err) => reject(err)) | ||
| stream.on('end', () => resolve(Buffer.concat(chunks))) | ||
| }) | ||
| } | ||
|
|
||
| /** | ||
| * @param {FixtureTestContext} ctx | ||
| * @param {Record<string, string>} [env] | ||
| */ | ||
| function temporarilySetEnv(ctx, env) { | ||
| const environment = { | ||
| NODE_ENV: 'production', | ||
| NETLIFY_BLOBS_CONTEXT: createBlobContext(ctx), | ||
| ...(env || {}), | ||
| } | ||
|
|
||
| const envVarsToRestore = {} | ||
|
|
||
| // We are not using lambda-local's environment variable setting because it cleans up | ||
| // environment vars to early (before stream is closed) | ||
| Object.keys(environment).forEach(function (key) { | ||
| if (typeof process.env[key] !== 'undefined') { | ||
| envVarsToRestore[key] = process.env[key] | ||
| } | ||
| process.env[key] = environment[key] | ||
| }) | ||
|
|
||
| return function restoreEnvironment() { | ||
| Object.keys(environment).forEach(function (key) { | ||
| if (typeof envVarsToRestore[key] !== 'undefined') { | ||
| process.env[key] = envVarsToRestore[key] | ||
| } else { | ||
| delete process.env[key] | ||
| } | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| const DEFAULT_FLAGS = {} | ||
|
|
||
| /** | ||
| * @param {FixtureTestContext} ctx | ||
| * @param {FunctionInvocationOptions} options | ||
| */ | ||
| export async function loadAndInvokeFunctionImpl( | ||
| ctx, | ||
| { headers, httpMethod, flags, url, env } = {}, | ||
| ) { | ||
| const { handler } = await import( | ||
| 'file:///' + join(ctx.functionDist, SERVER_HANDLER_NAME, '___netlify-entry-point.mjs') | ||
| ) | ||
|
|
||
| const restoreEnvironment = temporarilySetEnv(ctx, env) | ||
|
|
||
| let resolveInvocation, rejectInvocation | ||
| const invocationPromise = new Promise((resolve, reject) => { | ||
| resolveInvocation = resolve | ||
| rejectInvocation = reject | ||
| }) | ||
|
|
||
| const response = await execute({ | ||
| event: { | ||
| headers: headers || {}, | ||
| httpMethod: httpMethod || 'GET', | ||
| rawUrl: new URL(url || '/', 'https://example.netlify').href, | ||
| flags: flags ?? DEFAULT_FLAGS, | ||
| }, | ||
| lambdaFunc: { handler }, | ||
| timeoutMs: 4_000, | ||
| onInvocationEnd: (error) => { | ||
| // lambda-local resolve promise return from execute when response is closed | ||
| // but we should wait for tracked background work to finish | ||
| // before resolving the promise to allow background work to finish | ||
| if (error) { | ||
| rejectInvocation(error) | ||
| } else { | ||
| resolveInvocation() | ||
| } | ||
| }, | ||
| }) | ||
|
|
||
| await invocationPromise | ||
|
|
||
| if (!response) { | ||
| throw new Error('No response from lambda-local') | ||
| } | ||
|
|
||
| const responseHeaders = Object.entries(response.multiValueHeaders || {}).reduce( | ||
| (prev, [key, value]) => ({ | ||
| ...prev, | ||
| [key]: value.length === 1 ? `${value}` : value.join(', '), | ||
| }), | ||
| response.headers || {}, | ||
| ) | ||
|
|
||
| const bodyBuffer = await streamToBuffer(response.body) | ||
|
|
||
| restoreEnvironment() | ||
|
|
||
| return { | ||
| statusCode: response.statusCode, | ||
| bodyBuffer, | ||
| body: bodyBuffer.toString('utf-8'), | ||
| headers: responseHeaders, | ||
| isBase64Encoded: response.isBase64Encoded, | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * @typedef {typeof loadAndInvokeFunctionImpl} InvokeFunction | ||
| * @typedef {Promise<Awaited<ReturnType<InvokeFunction>>>} InvokeFunctionResult | ||
| */ | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this type was no longer even exported so I got this type in a bit different way in new place by doing some typescript transformations - it seems like we don't check types in test helpers generally (not something to address in this PR tho)