Skip to content

Commit

Permalink
feat(bundle): remove rebuild because it causes slow performance on bi…
Browse files Browse the repository at this point in the history
…g… (#528)

* fix(bundle): remove rebuild because it causes slow performance on big projects

* feat(bundle): add skipRebuild option

* docs: add skipRebuild option
  • Loading branch information
BorjaMacedo authored Mar 7, 2024
1 parent 7688e6f commit b5a233b
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 3 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down
10 changes: 7 additions & 3 deletions src/bundle.ts
Original file line number Diff line number Diff line change
Expand Up @@ -108,9 +108,13 @@ export async function bundle(this: EsbuildServerlessPlugin): Promise<void> {
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);
}

Expand Down
1 change: 1 addition & 0 deletions src/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down

0 comments on commit b5a233b

Please sign in to comment.