From b5a233bd13d6ff2d65368bacbfee04c20b5a25e6 Mon Sep 17 00:00:00 2001 From: Borja De Macedo Date: Thu, 7 Mar 2024 16:10:07 +0100 Subject: [PATCH] =?UTF-8?q?feat(bundle):=20remove=20rebuild=20because=20it?= =?UTF-8?q?=20causes=20slow=20performance=20on=20big=E2=80=A6=20(#528)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * fix(bundle): remove rebuild because it causes slow performance on big projects * feat(bundle): add skipRebuild option * docs: add skipRebuild option --- README.md | 1 + src/bundle.ts | 10 +++++++--- src/types.ts | 1 + 3 files changed, 9 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index fc4be68..51f07f1 100644 --- a/README.md +++ b/README.md @@ -89,6 +89,7 @@ See [example folder](examples) for some example configurations. | `packagerOptions` | Extra options for packagers for `external` dependency resolution. | [Packager Options](#packager-options) | | `watch` | Watch options for `serverless-offline`. | [Watch Options](#watch-options) | | `skipBuild` | Avoid rebuilding lambda artifacts in favor of reusing previous build artifacts. | `false` | +| `skipRebuild` | A boolean defining whether rebuild is avoided. Generally rebuild produces faster builds but in some context scenarios with many lambdas or low memory computer (like Github Actions) it can cause memory leaks. | `false` | | `skipBuildExcludeFns` | An array of lambda names that will always be rebuilt if `skipBuild` is set to `true` and bundling individually. This is helpful for dynamically generated functions like serverless-plugin-warmup. | `[]` | | `stripEntryResolveExtensions` | A boolean that determines if entrypoints using custom file extensions provided in the `resolveExtensions` ESbuild setting should be stripped of their custom extension upon packing the final bundle for that file. Example: `myLambda.custom.ts` would result in `myLambda.js` instead of `myLambda.custom.js`. | `disposeContext` | An option to disable the disposal of the context.(Functions can override the global `disposeContext` configuration by specifying their own `disposeContext` option in their individual configurations.) | `true` diff --git a/src/bundle.ts b/src/bundle.ts index 41373e9..891263f 100644 --- a/src/bundle.ts +++ b/src/bundle.ts @@ -108,9 +108,13 @@ export async function bundle(this: EsbuildServerlessPlugin): Promise { type WithContext = typeof pkg & { context?: ContextFn }; const context = await (pkg as WithContext).context?.(options); - let result = await context?.rebuild(); - - if (!result) { + let result; + if (!buildOptions.skipRebuild) { + result = await context?.rebuild(); + if (!result) { + result = await pkg.build(options); + } + } else { result = await pkg.build(options); } diff --git a/src/types.ts b/src/types.ts index f3c8115..9ba69a5 100644 --- a/src/types.ts +++ b/src/types.ts @@ -46,6 +46,7 @@ export interface Configuration extends EsbuildOptions { outputFileExtension: '.js' | '.cjs' | '.mjs'; nodeExternals?: NodeExternalsOptions; skipBuild?: boolean; + skipRebuild?: boolean; skipBuildExcludeFns: string[]; stripEntryResolveExtensions?: boolean; disposeContext?: boolean;