This repository has been archived by the owner on May 22, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 35
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: always transform V2 functions (#1597)
* feat: always bundle V2 functions * refactor: rename to `transformer` * refactor: always bundle * refactor: update conditions * chore: update tests
- Loading branch information
1 parent
1eccedc
commit c9e5384
Showing
8 changed files
with
286 additions
and
261 deletions.
There are no files selected for viewing
This file contains 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 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,141 @@ | ||
| import { dirname, extname, resolve } from 'path' | ||
|
|
||
| import { build, BuildOptions } from 'esbuild' | ||
|
|
||
| import type { FunctionConfig } from '../../../../config.js' | ||
| import { FunctionBundlingUserError } from '../../../../utils/error.js' | ||
| import { getPathWithExtension } from '../../../../utils/fs.js' | ||
| import { RUNTIME } from '../../../runtime.js' | ||
| import { CJS_SHIM } from '../../utils/esm_cjs_compat.js' | ||
| import { MODULE_FORMAT, MODULE_FILE_EXTENSION, ModuleFormat } from '../../utils/module_format.js' | ||
| import { getClosestPackageJson } from '../../utils/package_json.js' | ||
| import { getBundlerTarget } from '../esbuild/bundler_target.js' | ||
| import { NODE_BUNDLER } from '../types.js' | ||
|
|
||
| type Transformer = { | ||
| aliases: Map<string, string> | ||
| bundle?: boolean | ||
| bundledPaths?: string[] | ||
| format: ModuleFormat | ||
| newMainFile?: string | ||
| rewrites: Map<string, string> | ||
| } | ||
|
|
||
| /** | ||
| * Returns the module format that should be used for a given function file. | ||
| */ | ||
| const getModuleFormat = async ( | ||
| mainFile: string, | ||
| runtimeAPIVersion: number, | ||
| repositoryRoot?: string, | ||
| ): Promise<ModuleFormat> => { | ||
| const extension = extname(mainFile) | ||
|
|
||
| // TODO: This check should go away. We should always respect the format from | ||
| // the extension. We'll do this at a later stage, after we roll out the V2 | ||
| // API with no side-effects on V1 functions. | ||
| if (runtimeAPIVersion === 2) { | ||
| if (extension === MODULE_FILE_EXTENSION.MJS || extension === MODULE_FILE_EXTENSION.MTS) { | ||
| return MODULE_FORMAT.ESM | ||
| } | ||
|
|
||
| if (extension === MODULE_FILE_EXTENSION.CTS || extension === MODULE_FILE_EXTENSION.CTS) { | ||
| return MODULE_FORMAT.COMMONJS | ||
| } | ||
| } | ||
|
|
||
| // At this point, we need to infer the module type from the `type` field in | ||
| // the closest `package.json`. | ||
| try { | ||
| const packageJSON = await getClosestPackageJson(dirname(mainFile), repositoryRoot) | ||
|
|
||
| if (packageJSON?.contents.type === 'module') { | ||
| return MODULE_FORMAT.ESM | ||
| } | ||
| } catch { | ||
| // no-op | ||
| } | ||
|
|
||
| return MODULE_FORMAT.COMMONJS | ||
| } | ||
|
|
||
| export const getTransformer = async ( | ||
| runtimeAPIVersion: number, | ||
| mainFile: string, | ||
| repositoryRoot?: string, | ||
| ): Promise<Transformer | undefined> => { | ||
| const format = await getModuleFormat(mainFile, runtimeAPIVersion, repositoryRoot) | ||
| const aliases = new Map<string, string>() | ||
| const rewrites = new Map<string, string>() | ||
| const transformer = { | ||
| aliases, | ||
| format, | ||
| rewrites, | ||
| } | ||
|
|
||
| if (runtimeAPIVersion === 2) { | ||
| // For V2 functions, we want to emit a main file with an unambiguous | ||
| // extension (i.e. `.cjs` or `.mjs`), so that the file is loaded with | ||
| // the correct format regardless of what is set in `package.json`. | ||
| const newExtension = format === MODULE_FORMAT.COMMONJS ? MODULE_FILE_EXTENSION.CJS : MODULE_FILE_EXTENSION.MJS | ||
| const newMainFile = getPathWithExtension(mainFile, newExtension) | ||
|
|
||
| return { | ||
| ...transformer, | ||
| bundle: true, | ||
| bundledPaths: [], | ||
| newMainFile, | ||
| } | ||
| } | ||
|
|
||
| return transformer | ||
| } | ||
|
|
||
| interface TransformOptions { | ||
| bundle?: boolean | ||
| config: FunctionConfig | ||
| format?: ModuleFormat | ||
| name: string | ||
| path: string | ||
| } | ||
|
|
||
| export const transform = async ({ bundle = false, config, format, name, path }: TransformOptions) => { | ||
| // The version of ECMAScript to use as the build target. This will determine | ||
| // whether certain features are transpiled down or left untransformed. | ||
| const nodeTarget = getBundlerTarget(config.nodeVersion) | ||
| const bundleOptions: BuildOptions = { | ||
| bundle: false, | ||
| } | ||
|
|
||
| if (bundle) { | ||
| bundleOptions.bundle = true | ||
| bundleOptions.packages = 'external' | ||
|
|
||
| if (format === MODULE_FORMAT.ESM) { | ||
| bundleOptions.banner = { js: CJS_SHIM } | ||
| } | ||
| } | ||
|
|
||
| try { | ||
| const transpiled = await build({ | ||
| ...bundleOptions, | ||
| entryPoints: [path], | ||
| format, | ||
| logLevel: 'error', | ||
| metafile: true, | ||
| platform: 'node', | ||
| sourcemap: Boolean(config.nodeSourcemap), | ||
| target: [nodeTarget], | ||
| write: false, | ||
| }) | ||
| const bundledPaths = bundle ? Object.keys(transpiled.metafile.inputs).map((inputPath) => resolve(inputPath)) : [] | ||
|
|
||
| return { bundledPaths, transpiled: transpiled.outputFiles[0].text } | ||
| } catch (error) { | ||
| throw FunctionBundlingUserError.addCustomErrorInfo(error, { | ||
| functionName: name, | ||
| runtime: RUNTIME.JAVASCRIPT, | ||
| bundler: NODE_BUNDLER.NFT, | ||
| }) | ||
| } | ||
| } |
Oops, something went wrong.
c9e5384There 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.
⏱ Benchmark results