Skip to content
This repository was archived by the owner on May 22, 2024. It is now read-only.

Commit 71aeff3

Browse files
danezdanez
authoredApr 20, 2023
feat!: refactor enums and export types (#1392)
`ZipFunctionOptions`, `ZipFunctionsOption`, `Config`, and `FunctionConfig` are now exported BREAKING CHANGE: The exported typescript types for `NodeBundlerType`, `RuntimeType`, and `ModuleFormat` are not enums anymore but unions of strings. Use the newly exported `NODE_BUNDLER`, `RUNTIME`, and `MODULE_FORMAT` for constants. Also the types `NodeBundlerType` and `RuntimeType` were renamed to `NodeBundlerName` and `RuntimeName` respectively.
·
v9.32.2v9.0.0
1 parent 4a8f058 commit 71aeff3

32 files changed

+220
-197
lines changed
 

‎src/archive.ts

+8-2
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,16 @@ import { promisify } from 'util'
66
import archiver, { Archiver } from 'archiver'
77
import endOfStream from 'end-of-stream'
88

9+
import { ObjectValues } from './types/utils.js'
10+
911
export { Archiver as ZipArchive } from 'archiver'
1012

11-
// TODO make enum
12-
export type ArchiveFormat = 'none' | 'zip'
13+
export const ARCHIVE_FORMAT = {
14+
NONE: 'none',
15+
ZIP: 'zip',
16+
} as const
17+
18+
export type ArchiveFormat = ObjectValues<typeof ARCHIVE_FORMAT>
1319

1420
const pEndOfStream = promisify(endOfStream)
1521

‎src/bin.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import { argv, exit } from 'process'
44
import yargs from 'yargs'
55
import { hideBin } from 'yargs/helpers'
66

7-
import type { ArchiveFormat } from './archive.js'
7+
import { ARCHIVE_FORMAT } from './archive.js'
88
import { zipFunctions } from './main.js'
99

1010
declare global {
@@ -39,8 +39,8 @@ const parseArgs = function () {
3939
.parse()
4040
}
4141

42-
const archiveFormats: ArchiveFormat[] = ['none', 'zip']
43-
const defaultArchiveFormat: ArchiveFormat = 'zip'
42+
const archiveFormats = Object.values(ARCHIVE_FORMAT)
43+
const defaultArchiveFormat = ARCHIVE_FORMAT.ZIP
4444

4545
const OPTIONS = {
4646
'archive-format': {

‎src/config.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import isPathInside from 'is-path-inside'
66
import mergeOptions from 'merge-options'
77

88
import { FunctionSource } from './function.js'
9-
import type { NodeBundlerType } from './runtimes/node/bundlers/types.js'
9+
import type { NodeBundlerName } from './runtimes/node/bundlers/types.js'
1010
import type { ModuleFormat } from './runtimes/node/utils/module_format.js'
1111
import { minimatch } from './utils/matching.js'
1212

@@ -15,7 +15,7 @@ interface FunctionConfig {
1515
includedFiles?: string[]
1616
includedFilesBasePath?: string
1717
ignoredNodeModules?: string[]
18-
nodeBundler?: NodeBundlerType
18+
nodeBundler?: NodeBundlerName
1919
nodeSourcemap?: boolean
2020
nodeVersion?: string
2121
processDynamicNodeImports?: boolean

‎src/main.ts

+9-7
Original file line numberDiff line numberDiff line change
@@ -5,20 +5,22 @@ import { FeatureFlags, getFlags } from './feature_flags.js'
55
import { FunctionSource } from './function.js'
66
import { getFunctionFromPath, getFunctionsFromPaths } from './runtimes/index.js'
77
import { findISCDeclarationsInPath, ISCValues } from './runtimes/node/in_source_config/index.js'
8-
import { GetSrcFilesFunction, RuntimeType } from './runtimes/runtime.js'
8+
import { GetSrcFilesFunction, RuntimeName, RUNTIME } from './runtimes/runtime.js'
99
import { RuntimeCache } from './utils/cache.js'
1010
import { listFunctionsDirectories, resolveFunctionsDirectories } from './utils/fs.js'
1111

12-
export { zipFunction, zipFunctions } from './zip.js'
12+
export { Config, FunctionConfig } from './config.js'
13+
export { zipFunction, zipFunctions, ZipFunctionOptions, ZipFunctionsOptions } from './zip.js'
1314

14-
export { NodeBundlerType } from './runtimes/node/bundlers/types.js'
15-
export { RuntimeType } from './runtimes/runtime.js'
16-
export { ModuleFormat } from './runtimes/node/utils/module_format.js'
15+
export { ArchiveFormat, ARCHIVE_FORMAT } from './archive.js'
16+
export { NodeBundlerName, NODE_BUNDLER } from './runtimes/node/bundlers/types.js'
17+
export { RuntimeName, RUNTIME } from './runtimes/runtime.js'
18+
export { ModuleFormat, MODULE_FORMAT } from './runtimes/node/utils/module_format.js'
1719

1820
export interface ListedFunction {
1921
name: string
2022
mainFile: string
21-
runtime: RuntimeType
23+
runtime: RuntimeName
2224
extension: string
2325
schedule?: string
2426
displayName?: string
@@ -44,7 +46,7 @@ interface AugmentedFunctionSource extends FunctionSource {
4446
const augmentWithISC = async (func: FunctionSource): Promise<AugmentedFunctionSource> => {
4547
// ISC is currently only supported in JavaScript and TypeScript functions
4648
// and only supports scheduled functions.
47-
if (func.runtime.name !== RuntimeType.JAVASCRIPT) {
49+
if (func.runtime.name !== RUNTIME.JAVASCRIPT) {
4850
return func
4951
}
5052

‎src/runtimes/detect_runtime.ts

+4-4
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import { readFile } from 'fs/promises'
22

33
import { detect, Runtime as BinaryRuntime, Arch, Platform, BinaryInfo } from '@netlify/binary-info'
44

5-
import { RuntimeType } from './runtime.js'
5+
import { RuntimeName, RUNTIME } from './runtime.js'
66

77
const isValidFunctionBinary = (info: BinaryInfo) => info.arch === Arch.Amd64 && info.platform === Platform.Linux
88

@@ -19,7 +19,7 @@ The binary needs to be built for Linux/Amd64, but it was built for ${Platform[bi
1919
}
2020

2121
// Try to guess the runtime by inspecting the binary file.
22-
export const detectBinaryRuntime = async function ({ path }: { path: string }): Promise<RuntimeType | undefined> {
22+
export const detectBinaryRuntime = async function ({ path }: { path: string }): Promise<RuntimeName | undefined> {
2323
try {
2424
const fileContents = await readFile(path)
2525
const binaryInfo = detect(fileContents)
@@ -30,9 +30,9 @@ export const detectBinaryRuntime = async function ({ path }: { path: string }):
3030

3131
switch (binaryInfo.runtime) {
3232
case BinaryRuntime.Go:
33-
return RuntimeType.GO
33+
return RUNTIME.GO
3434
case BinaryRuntime.Rust:
35-
return RuntimeType.RUST
35+
return RUNTIME.RUST
3636
default:
3737
return undefined
3838
}

‎src/runtimes/go/builder.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import { basename } from 'path'
33

44
import { FunctionBundlingUserError } from '../../utils/error.js'
55
import { shellUtils } from '../../utils/shell.js'
6-
import { RuntimeType } from '../runtime.js'
6+
import { RUNTIME } from '../runtime.js'
77

88
export const build = async ({ destPath, mainFile, srcDir }: { destPath: string; mainFile: string; srcDir: string }) => {
99
const functionName = basename(srcDir)
@@ -20,7 +20,7 @@ export const build = async ({ destPath, mainFile, srcDir }: { destPath: string;
2020
} catch (error) {
2121
console.error(`Could not compile Go function ${functionName}:\n`)
2222

23-
throw FunctionBundlingUserError.addCustomErrorInfo(error, { functionName, runtime: RuntimeType.GO })
23+
throw FunctionBundlingUserError.addCustomErrorInfo(error, { functionName, runtime: RUNTIME.GO })
2424
}
2525

2626
const stat = await fs.lstat(destPath)

‎src/runtimes/go/index.ts

+3-9
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,7 @@ import getInternalValue from '../../utils/get_internal_value.js'
1010
import { nonNullable } from '../../utils/non_nullable.js'
1111
import { zipBinary } from '../../zip_binary.js'
1212
import { detectBinaryRuntime } from '../detect_runtime.js'
13-
import {
14-
FindFunctionInPathFunction,
15-
FindFunctionsInPathsFunction,
16-
Runtime,
17-
RuntimeType,
18-
ZipFunction,
19-
} from '../runtime.js'
13+
import { FindFunctionInPathFunction, FindFunctionsInPathsFunction, Runtime, RUNTIME, ZipFunction } from '../runtime.js'
2014

2115
import { build } from './builder.js'
2216

@@ -53,7 +47,7 @@ const findFunctionsInPaths: FindFunctionsInPathsFunction = async function ({ cac
5347
const findFunctionInPath: FindFunctionInPathFunction = async function ({ cache, path }) {
5448
const runtime = await detectBinaryRuntime({ path })
5549

56-
if (runtime === RuntimeType.GO) {
50+
if (runtime === RUNTIME.GO) {
5751
return processBinary({ cache, path })
5852
}
5953

@@ -169,6 +163,6 @@ const zipFunction: ZipFunction = async function ({
169163
}
170164
}
171165

172-
const runtime: Runtime = { findFunctionsInPaths, findFunctionInPath, name: RuntimeType.GO, zipFunction }
166+
const runtime: Runtime = { findFunctionsInPaths, findFunctionInPath, name: RUNTIME.GO, zipFunction }
173167

174168
export default runtime

‎src/runtimes/node/bundlers/esbuild/bundler.ts

+6-6
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ import type { FunctionConfig } from '../../../../config.js'
77
import { FeatureFlags } from '../../../../feature_flags.js'
88
import { FunctionBundlingUserError } from '../../../../utils/error.js'
99
import { getPathWithExtension, safeUnlink } from '../../../../utils/fs.js'
10-
import { RuntimeType } from '../../../runtime.js'
11-
import { getFileExtensionForFormat, ModuleFormat } from '../../utils/module_format.js'
12-
import { NodeBundlerType } from '../types.js'
10+
import { RUNTIME } from '../../../runtime.js'
11+
import { getFileExtensionForFormat, MODULE_FORMAT } from '../../utils/module_format.js'
12+
import { NODE_BUNDLER } from '../types.js'
1313

1414
import { getBundlerTarget, getModuleFormat } from './bundler_target.js'
1515
import { getDynamicImportsPlugin } from './plugin_dynamic_imports.js'
@@ -117,7 +117,7 @@ export const bundleJsFile = async function ({
117117

118118
try {
119119
const { metafile = { inputs: {}, outputs: {} }, warnings } = await build({
120-
banner: moduleFormat === ModuleFormat.ESM ? { js: esmJSBanner } : undefined,
120+
banner: moduleFormat === MODULE_FORMAT.ESM ? { js: esmJSBanner } : undefined,
121121
bundle: true,
122122
entryPoints: [srcFile],
123123
external,
@@ -159,8 +159,8 @@ export const bundleJsFile = async function ({
159159
} catch (error) {
160160
throw FunctionBundlingUserError.addCustomErrorInfo(error, {
161161
functionName: name,
162-
runtime: RuntimeType.JAVASCRIPT,
163-
bundler: NodeBundlerType.ESBUILD,
162+
runtime: RUNTIME.JAVASCRIPT,
163+
bundler: NODE_BUNDLER.ESBUILD,
164164
})
165165
}
166166
}

‎src/runtimes/node/bundlers/esbuild/bundler_target.ts

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import { FeatureFlags } from '../../../../feature_flags.js'
2-
import { ModuleFileExtension, ModuleFormat } from '../../utils/module_format.js'
2+
import { ModuleFormat, MODULE_FILE_EXTENSION, MODULE_FORMAT } from '../../utils/module_format.js'
33
import { DEFAULT_NODE_VERSION, getNodeSupportMatrix, parseVersion } from '../../utils/node_version.js'
44
import { getClosestPackageJson } from '../../utils/package_json.js'
55

@@ -27,10 +27,10 @@ const getModuleFormat = async (
2727
extension: string,
2828
configVersion?: string,
2929
): Promise<{ includedFiles: string[]; moduleFormat: ModuleFormat }> => {
30-
if (featureFlags.zisi_pure_esm_mjs && extension === ModuleFileExtension.MJS) {
30+
if (featureFlags.zisi_pure_esm_mjs && extension === MODULE_FILE_EXTENSION.MJS) {
3131
return {
3232
includedFiles: [],
33-
moduleFormat: ModuleFormat.ESM,
33+
moduleFormat: MODULE_FORMAT.ESM,
3434
}
3535
}
3636

@@ -41,14 +41,14 @@ const getModuleFormat = async (
4141
if (packageJsonFile?.contents.type === 'module' && nodeSupport.esm) {
4242
return {
4343
includedFiles: [packageJsonFile.path],
44-
moduleFormat: ModuleFormat.ESM,
44+
moduleFormat: MODULE_FORMAT.ESM,
4545
}
4646
}
4747
}
4848

4949
return {
5050
includedFiles: [],
51-
moduleFormat: ModuleFormat.COMMONJS,
51+
moduleFormat: MODULE_FORMAT.COMMONJS,
5252
}
5353
}
5454

‎src/runtimes/node/bundlers/index.ts

+16-16
Original file line numberDiff line numberDiff line change
@@ -3,27 +3,27 @@ import { extname } from 'path'
33
import { FunctionConfig } from '../../../config.js'
44
import { FeatureFlags } from '../../../feature_flags.js'
55
import { detectEsModule } from '../utils/detect_es_module.js'
6-
import { ModuleFileExtension } from '../utils/module_format.js'
6+
import { MODULE_FILE_EXTENSION } from '../utils/module_format.js'
77

88
import esbuildBundler from './esbuild/index.js'
99
import nftBundler from './nft/index.js'
1010
import noBundler from './none/index.js'
11-
import { NodeBundler, NodeBundlerType } from './types.js'
11+
import { NodeBundler, NodeBundlerName, NODE_BUNDLER } from './types.js'
1212
import zisiBundler from './zisi/index.js'
1313

14-
export const getBundler = (name: NodeBundlerType): NodeBundler => {
14+
export const getBundler = (name: NodeBundlerName): NodeBundler => {
1515
switch (name) {
16-
case NodeBundlerType.ESBUILD:
17-
case NodeBundlerType.ESBUILD_ZISI:
16+
case NODE_BUNDLER.ESBUILD:
17+
case NODE_BUNDLER.ESBUILD_ZISI:
1818
return esbuildBundler
1919

20-
case NodeBundlerType.NFT:
20+
case NODE_BUNDLER.NFT:
2121
return nftBundler
2222

23-
case NodeBundlerType.ZISI:
23+
case NODE_BUNDLER.ZISI:
2424
return zisiBundler
2525

26-
case NodeBundlerType.NONE:
26+
case NODE_BUNDLER.NONE:
2727
return noBundler
2828

2929
default:
@@ -41,7 +41,7 @@ export const getBundlerName = async ({
4141
extension: string
4242
featureFlags: FeatureFlags
4343
mainFile: string
44-
}): Promise<NodeBundlerType> => {
44+
}): Promise<NodeBundlerName> => {
4545
if (nodeBundler) {
4646
return nodeBundler
4747
}
@@ -61,20 +61,20 @@ const getDefaultBundler = async ({
6161
extension: string
6262
mainFile: string
6363
featureFlags: FeatureFlags
64-
}): Promise<NodeBundlerType> => {
65-
if (extension === ModuleFileExtension.MJS && featureFlags.zisi_pure_esm_mjs) {
66-
return NodeBundlerType.NFT
64+
}): Promise<NodeBundlerName> => {
65+
if (extension === MODULE_FILE_EXTENSION.MJS && featureFlags.zisi_pure_esm_mjs) {
66+
return NODE_BUNDLER.NFT
6767
}
6868

6969
if (ESBUILD_EXTENSIONS.has(extension)) {
70-
return NodeBundlerType.ESBUILD
70+
return NODE_BUNDLER.ESBUILD
7171
}
7272

7373
if (featureFlags.traceWithNft) {
74-
return NodeBundlerType.NFT
74+
return NODE_BUNDLER.NFT
7575
}
7676

77-
const functionIsESM = extname(mainFile) !== ModuleFileExtension.CJS && (await detectEsModule({ mainFile }))
77+
const functionIsESM = extname(mainFile) !== MODULE_FILE_EXTENSION.CJS && (await detectEsModule({ mainFile }))
7878

79-
return functionIsESM ? NodeBundlerType.NFT : NodeBundlerType.ZISI
79+
return functionIsESM ? NODE_BUNDLER.NFT : NODE_BUNDLER.ZISI
8080
}

‎src/runtimes/node/bundlers/nft/es_modules.ts

+6-6
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import type { FunctionConfig } from '../../../../config.js'
66
import { FeatureFlags } from '../../../../feature_flags.js'
77
import type { RuntimeCache } from '../../../../utils/cache.js'
88
import { cachedReadFile } from '../../../../utils/fs.js'
9-
import { ModuleFileExtension, ModuleFormat } from '../../utils/module_format.js'
9+
import { ModuleFormat, MODULE_FILE_EXTENSION, MODULE_FORMAT } from '../../utils/module_format.js'
1010
import { getNodeSupportMatrix } from '../../utils/node_version.js'
1111
import { getPackageJsonIfAvailable, PackageJson } from '../../utils/package_json.js'
1212

@@ -72,17 +72,17 @@ export const processESM = async ({
7272

7373
// If this is a .mjs file and we want to output pure ESM files, we don't need
7474
// to transpile anything.
75-
if (extension === ModuleFileExtension.MJS && featureFlags.zisi_pure_esm_mjs) {
75+
if (extension === MODULE_FILE_EXTENSION.MJS && featureFlags.zisi_pure_esm_mjs) {
7676
return {
77-
moduleFormat: ModuleFormat.ESM,
77+
moduleFormat: MODULE_FORMAT.ESM,
7878
}
7979
}
8080

8181
const entrypointIsESM = isEntrypointESM({ basePath, esmPaths, mainFile })
8282

8383
if (!entrypointIsESM) {
8484
return {
85-
moduleFormat: ModuleFormat.COMMONJS,
85+
moduleFormat: MODULE_FORMAT.COMMONJS,
8686
}
8787
}
8888

@@ -91,14 +91,14 @@ export const processESM = async ({
9191

9292
if (featureFlags.zisi_pure_esm && packageJson.type === 'module' && nodeSupport.esm) {
9393
return {
94-
moduleFormat: ModuleFormat.ESM,
94+
moduleFormat: MODULE_FORMAT.ESM,
9595
}
9696
}
9797

9898
const rewrites = await transpileESM({ basePath, cache, config, esmPaths, reasons, name })
9999

100100
return {
101-
moduleFormat: ModuleFormat.COMMONJS,
101+
moduleFormat: MODULE_FORMAT.COMMONJS,
102102
rewrites,
103103
}
104104
}

‎src/runtimes/node/bundlers/nft/transpile.ts

+6-6
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@ import { build } from '@netlify/esbuild'
22

33
import type { FunctionConfig } from '../../../../config.js'
44
import { FunctionBundlingUserError } from '../../../../utils/error.js'
5-
import { RuntimeType } from '../../../runtime.js'
6-
import { ModuleFormat } from '../../utils/module_format.js'
5+
import { RUNTIME } from '../../../runtime.js'
6+
import { MODULE_FORMAT } from '../../utils/module_format.js'
77
import { getBundlerTarget } from '../esbuild/bundler_target.js'
8-
import { NodeBundlerType } from '../types.js'
8+
import { NODE_BUNDLER } from '../types.js'
99

1010
export const transpile = async (path: string, config: FunctionConfig, functionName: string) => {
1111
// The version of ECMAScript to use as the build target. This will determine
@@ -16,7 +16,7 @@ export const transpile = async (path: string, config: FunctionConfig, functionNa
1616
const transpiled = await build({
1717
bundle: false,
1818
entryPoints: [path],
19-
format: ModuleFormat.COMMONJS,
19+
format: MODULE_FORMAT.COMMONJS,
2020
logLevel: 'error',
2121
platform: 'node',
2222
sourcemap: Boolean(config.nodeSourcemap),
@@ -28,8 +28,8 @@ export const transpile = async (path: string, config: FunctionConfig, functionNa
2828
} catch (error) {
2929
throw FunctionBundlingUserError.addCustomErrorInfo(error, {
3030
functionName,
31-
runtime: RuntimeType.JAVASCRIPT,
32-
bundler: NodeBundlerType.NFT,
31+
runtime: RUNTIME.JAVASCRIPT,
32+
bundler: NODE_BUNDLER.NFT,
3333
})
3434
}
3535
}

1 commit comments

Comments
 (1)

github-actions[bot] commented on Apr 20, 2023

@github-actions[bot]
github-actions[bot]
on Apr 20, 2023
Contributor

⏱ Benchmark results

  • largeDepsEsbuild: 2.6s
  • largeDepsNft: 10s
  • largeDepsZisi: 17.8s
This repository has been archived.