Skip to content

Commit 251ffcc

Browse files
eduardoboucaseduardoboucas
authoredJun 14, 2024··
feat: update method for merging ISC with TOML config (#5712)
* feat: update method for merging ISC with TOML config * fix: hide generated properties * refactor: use zod * chore: clean up * fix: fix imports * fix: fix validation * chore: add assertions * refactor: small things * feat: support `nodeVersion` in ISC
·
zip-it-and-ship-it-v10.0.4build-info-v7.14.0
1 parent 461e1ca commit 251ffcc

File tree

24 files changed

+466
-320
lines changed

24 files changed

+466
-320
lines changed
 

‎package-lock.json

+11-2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎packages/zip-it-and-ship-it/package.json

+3-2
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,8 @@
7373
"toml": "^3.0.0",
7474
"unixify": "^1.0.0",
7575
"urlpattern-polyfill": "8.0.2",
76-
"yargs": "^17.0.0"
76+
"yargs": "^17.0.0",
77+
"zod": "^3.23.8"
7778
},
7879
"devDependencies": {
7980
"@types/archiver": "5.3.4",
@@ -92,7 +93,7 @@
9293
"cardinal": "2.1.1",
9394
"cpy": "9.0.1",
9495
"decompress": "4.2.1",
95-
"deepmerge": "4.3.1",
96+
"deepmerge": "^4.3.1",
9697
"get-stream": "8.0.1",
9798
"is-ci": "3.0.1",
9899
"lambda-local": "2.2.0",

‎packages/zip-it-and-ship-it/src/config.ts

+21-18
Original file line numberDiff line numberDiff line change
@@ -3,32 +3,35 @@ import { basename, extname, dirname, join } from 'path'
33

44
import isPathInside from 'is-path-inside'
55
import mergeOptions from 'merge-options'
6+
import { z } from 'zod'
67

78
import { FunctionSource } from './function.js'
8-
import type { NodeBundlerName } from './runtimes/node/bundlers/types.js'
9-
import type { ModuleFormat } from './runtimes/node/utils/module_format.js'
9+
import { nodeBundler } from './runtimes/node/bundlers/types.js'
10+
import { moduleFormat } from './runtimes/node/utils/module_format.js'
1011
import { minimatch } from './utils/matching.js'
1112

12-
interface FunctionConfig {
13-
externalNodeModules?: string[]
14-
includedFiles?: string[]
15-
includedFilesBasePath?: string
16-
ignoredNodeModules?: string[]
17-
nodeBundler?: NodeBundlerName
18-
nodeSourcemap?: boolean
19-
nodeVersion?: string
20-
rustTargetDirectory?: string
21-
schedule?: string
22-
zipGo?: boolean
23-
name?: string
24-
generator?: string
25-
timeout?: number
13+
export const functionConfig = z.object({
14+
externalNodeModules: z.array(z.string()).optional().catch([]),
15+
generator: z.string().optional().catch(undefined),
16+
includedFiles: z.array(z.string()).optional().catch([]),
17+
includedFilesBasePath: z.string().optional().catch(undefined),
18+
ignoredNodeModules: z.array(z.string()).optional().catch([]),
19+
name: z.string().optional().catch(undefined),
20+
nodeBundler: nodeBundler.optional().catch(undefined),
21+
nodeSourcemap: z.boolean().optional().catch(undefined),
22+
nodeVersion: z.string().optional().catch(undefined),
23+
rustTargetDirectory: z.string().optional().catch(undefined),
24+
schedule: z.string().optional().catch(undefined),
25+
timeout: z.number().optional().catch(undefined),
26+
zipGo: z.boolean().optional().catch(undefined),
2627

2728
// Temporary configuration property, only meant to be used by the deploy
2829
// configuration API. Once we start emitting ESM files for all ESM functions,
2930
// we can remove this.
30-
nodeModuleFormat?: ModuleFormat
31-
}
31+
nodeModuleFormat: moduleFormat.optional().catch(undefined),
32+
})
33+
34+
type FunctionConfig = z.infer<typeof functionConfig>
3235

3336
interface FunctionConfigFile {
3437
config: FunctionConfig

‎packages/zip-it-and-ship-it/src/main.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ export { ArchiveFormat, ARCHIVE_FORMAT } from './archive.js'
1717
export { NodeBundlerName, NODE_BUNDLER } from './runtimes/node/bundlers/types.js'
1818
export { RuntimeName, RUNTIME } from './runtimes/runtime.js'
1919
export { ModuleFormat, MODULE_FORMAT } from './runtimes/node/utils/module_format.js'
20-
export { TrafficRules, Manifest } from './manifest.js'
20+
export { Manifest } from './manifest.js'
2121
export { FunctionResult } from './utils/format_result.js'
2222

2323
export interface ListedFunction {
@@ -157,7 +157,7 @@ const getListedFunction = function ({
157157
name,
158158
runtime: runtime.name,
159159
runtimeAPIVersion: staticAnalysisResult ? staticAnalysisResult?.runtimeAPIVersion ?? 1 : undefined,
160-
schedule: staticAnalysisResult?.schedule ?? config.schedule,
160+
schedule: staticAnalysisResult?.config?.schedule ?? config.schedule,
161161
inputModuleFormat: staticAnalysisResult?.inputModuleFormat,
162162
}
163163
}

‎packages/zip-it-and-ship-it/src/manifest.ts

+1-19
Original file line numberDiff line numberDiff line change
@@ -3,28 +3,10 @@ import { resolve } from 'path'
33
import { arch, platform } from 'process'
44

55
import type { InvocationMode } from './function.js'
6+
import type { TrafficRules } from './rate_limit.js'
67
import type { FunctionResult } from './utils/format_result.js'
78
import type { Route } from './utils/routes.js'
89

9-
export interface TrafficRules {
10-
action: {
11-
type: string
12-
config: {
13-
rateLimitConfig: {
14-
algorithm: string
15-
windowSize: number
16-
windowLimit: number
17-
}
18-
aggregate: {
19-
keys: {
20-
type: string
21-
}[]
22-
}
23-
to?: string
24-
}
25-
}
26-
}
27-
2810
interface ManifestFunction {
2911
buildData?: Record<string, unknown>
3012
invocationMode?: InvocationMode

‎packages/zip-it-and-ship-it/src/rate_limit.ts

+62-23
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,69 @@
1-
export enum RateLimitAlgorithm {
2-
SlidingWindow = 'sliding_window',
3-
}
1+
import { z } from 'zod'
42

5-
export enum RateLimitAggregator {
6-
Domain = 'domain',
7-
IP = 'ip',
3+
export interface TrafficRules {
4+
action: {
5+
type: string
6+
config: {
7+
rateLimitConfig: {
8+
algorithm: string
9+
windowSize: number
10+
windowLimit: number
11+
}
12+
aggregate: {
13+
keys: {
14+
type: string
15+
}[]
16+
}
17+
to?: string
18+
}
19+
}
820
}
921

10-
export enum RateLimitAction {
11-
Limit = 'rate_limit',
12-
Rewrite = 'rewrite',
13-
}
22+
const rateLimitAction = z.enum(['rate_limit', 'rewrite'])
23+
const rateLimitAlgorithm = z.enum(['sliding_window'])
24+
const rateLimitAggregator = z.enum(['domain', 'ip'])
25+
const slidingWindow = z.object({
26+
windowLimit: z.number(),
27+
windowSize: z.number(),
28+
})
29+
const rewriteActionConfig = z.object({
30+
to: z.string(),
31+
})
1432

15-
interface SlidingWindow {
16-
windowLimit: number
17-
windowSize: number
18-
}
33+
export const rateLimit = z
34+
.object({
35+
action: rateLimitAction.optional(),
36+
aggregateBy: rateLimitAggregator.or(z.array(rateLimitAggregator)).optional(),
37+
algorithm: rateLimitAlgorithm.optional(),
38+
})
39+
.merge(slidingWindow)
40+
.merge(rewriteActionConfig.partial())
1941

20-
export type RewriteActionConfig = SlidingWindow & {
21-
to: string
22-
}
42+
type RateLimit = z.infer<typeof rateLimit>
2343

24-
interface RateLimitConfig {
25-
action?: RateLimitAction
26-
aggregateBy?: RateLimitAggregator | RateLimitAggregator[]
27-
algorithm?: RateLimitAlgorithm
28-
}
44+
/**
45+
* Takes a rate limiting configuration object and returns a traffic rules
46+
* object that is added to the manifest.
47+
*/
48+
export const getTrafficRulesConfig = (input: RateLimit): TrafficRules | undefined => {
49+
const { windowSize, windowLimit, algorithm, aggregateBy, action, to } = input
50+
const rateLimitAgg = Array.isArray(aggregateBy) ? aggregateBy : [rateLimitAggregator.Enum.domain]
51+
const rewriteConfig = to ? { to: input.to } : undefined
2952

30-
export type RateLimit = RateLimitConfig & (SlidingWindow | RewriteActionConfig)
53+
return {
54+
action: {
55+
type: action || rateLimitAction.Enum.rate_limit,
56+
config: {
57+
...rewriteConfig,
58+
rateLimitConfig: {
59+
windowLimit,
60+
windowSize,
61+
algorithm: algorithm || rateLimitAlgorithm.Enum.sliding_window,
62+
},
63+
aggregate: {
64+
keys: rateLimitAgg.map((agg) => ({ type: agg })),
65+
},
66+
},
67+
},
68+
}
69+
}

‎packages/zip-it-and-ship-it/src/runtimes/node/bundlers/types.ts

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
import type { Message } from 'esbuild'
2+
import { z } from 'zod'
23

34
import type { FunctionConfig } from '../../../config.js'
45
import type { FeatureFlags } from '../../../feature_flags.js'
56
import type { FunctionSource } from '../../../function.js'
6-
import { ObjectValues } from '../../../types/utils.js'
77
import type { RuntimeCache } from '../../../utils/cache.js'
88
import { Logger } from '../../../utils/logger.js'
99
import type { ModuleFormat } from '../utils/module_format.js'
@@ -16,7 +16,9 @@ export const NODE_BUNDLER = {
1616
NONE: 'none',
1717
} as const
1818

19-
export type NodeBundlerName = ObjectValues<typeof NODE_BUNDLER>
19+
export const nodeBundler = z.nativeEnum(NODE_BUNDLER)
20+
21+
export type NodeBundlerName = z.infer<typeof nodeBundler>
2022

2123
// TODO: Create a generic warning type
2224
type BundlerWarning = Message

‎packages/zip-it-and-ship-it/src/runtimes/node/in_source_config/index.ts

+115-154
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
import type { ArgumentPlaceholder, Expression, SpreadElement, JSXNamespacedName } from '@babel/types'
2+
import mergeOptions from 'merge-options'
3+
import { z } from 'zod'
24

5+
import { FunctionConfig, functionConfig } from '../../../config.js'
36
import { InvocationMode, INVOCATION_MODE } from '../../../function.js'
4-
import { TrafficRules } from '../../../manifest.js'
5-
import { RateLimitAction, RateLimitAggregator, RateLimitAlgorithm } from '../../../rate_limit.js'
7+
import { rateLimit } from '../../../rate_limit.js'
68
import { FunctionBundlingUserError } from '../../../utils/error.js'
7-
import { nonNullable } from '../../../utils/non_nullable.js'
8-
import { getRoutes, Route } from '../../../utils/routes.js'
9+
import { Route, getRoutes } from '../../../utils/routes.js'
910
import { RUNTIME } from '../../runtime.js'
10-
import { NODE_BUNDLER } from '../bundlers/types.js'
1111
import { createBindingsMethod } from '../parser/bindings.js'
1212
import { traverseNodes } from '../parser/exports.js'
1313
import { getImports } from '../parser/imports.js'
@@ -18,26 +18,55 @@ import { parse as parseSchedule } from './properties/schedule.js'
1818

1919
export const IN_SOURCE_CONFIG_MODULE = '@netlify/functions'
2020

21-
export type ISCValues = {
22-
routes?: Route[]
23-
schedule?: string
24-
methods?: string[]
25-
trafficRules?: TrafficRules
26-
name?: string
27-
generator?: string
28-
timeout?: number
29-
}
30-
31-
export interface StaticAnalysisResult extends ISCValues {
21+
export interface StaticAnalysisResult {
22+
config: InSourceConfig
3223
inputModuleFormat?: ModuleFormat
3324
invocationMode?: InvocationMode
25+
routes?: Route[]
3426
runtimeAPIVersion?: number
3527
}
3628

3729
interface FindISCDeclarationsOptions {
3830
functionName: string
3931
}
4032

33+
const ensureArray = (input: unknown) => (Array.isArray(input) ? input : [input])
34+
35+
const httpMethods = z.preprocess(
36+
(input) => (typeof input === 'string' ? input.toUpperCase() : input),
37+
z.enum(['GET', 'POST', 'PUT', 'PATCH', 'OPTIONS', 'DELETE', 'HEAD']),
38+
)
39+
const path = z.string().startsWith('/', { message: "Must start with a '/'" })
40+
41+
export const inSourceConfig = functionConfig
42+
.pick({
43+
externalNodeModules: true,
44+
generator: true,
45+
includedFiles: true,
46+
ignoredNodeModules: true,
47+
name: true,
48+
nodeBundler: true,
49+
nodeVersion: true,
50+
schedule: true,
51+
timeout: true,
52+
})
53+
.extend({
54+
method: z
55+
.union([httpMethods, z.array(httpMethods)], {
56+
errorMap: () => ({ message: 'Must be a string or array of strings' }),
57+
})
58+
.transform(ensureArray)
59+
.optional(),
60+
path: z
61+
.union([path, z.array(path)], { errorMap: () => ({ message: 'Must be a string or array of strings' }) })
62+
.transform(ensureArray)
63+
.optional(),
64+
preferStatic: z.boolean().optional().catch(undefined),
65+
rateLimit: rateLimit.optional().catch(undefined),
66+
})
67+
68+
export type InSourceConfig = z.infer<typeof inSourceConfig>
69+
4170
const validateScheduleFunction = (functionFound: boolean, scheduleFound: boolean, functionName: string): void => {
4271
if (!functionFound) {
4372
throw new FunctionBundlingUserError(
@@ -54,83 +83,6 @@ const validateScheduleFunction = (functionFound: boolean, scheduleFound: boolean
5483
}
5584
}
5685

57-
/**
58-
* Normalizes method names into arrays of uppercase strings.
59-
* (e.g. "get" becomes ["GET"])
60-
*/
61-
const normalizeMethods = (input: unknown, name: string): string[] | undefined => {
62-
const methods = Array.isArray(input) ? input : [input]
63-
64-
return methods.map((method) => {
65-
if (typeof method !== 'string') {
66-
throw new FunctionBundlingUserError(
67-
`Could not parse method declaration of function '${name}'. Expecting HTTP Method, got ${method}`,
68-
{
69-
functionName: name,
70-
runtime: RUNTIME.JAVASCRIPT,
71-
bundler: NODE_BUNDLER.ESBUILD,
72-
},
73-
)
74-
}
75-
76-
return method.toUpperCase()
77-
})
78-
}
79-
80-
/**
81-
* Extracts the `ratelimit` configuration from the exported config.
82-
*/
83-
const getTrafficRulesConfig = (input: unknown, name: string): TrafficRules | undefined => {
84-
if (typeof input !== 'object' || input === null) {
85-
throw new FunctionBundlingUserError(
86-
`Could not parse ratelimit declaration of function '${name}'. Expecting an object, got ${input}`,
87-
{
88-
functionName: name,
89-
runtime: RUNTIME.JAVASCRIPT,
90-
bundler: NODE_BUNDLER.ESBUILD,
91-
},
92-
)
93-
}
94-
95-
const { windowSize, windowLimit, algorithm, aggregateBy, action } = input as Record<string, unknown>
96-
97-
if (
98-
typeof windowSize !== 'number' ||
99-
typeof windowLimit !== 'number' ||
100-
!Number.isInteger(windowSize) ||
101-
!Number.isInteger(windowLimit)
102-
) {
103-
throw new FunctionBundlingUserError(
104-
`Could not parse ratelimit declaration of function '${name}'. Expecting 'windowSize' and 'limitSize' integer properties, got ${input}`,
105-
{
106-
functionName: name,
107-
runtime: RUNTIME.JAVASCRIPT,
108-
bundler: NODE_BUNDLER.ESBUILD,
109-
},
110-
)
111-
}
112-
113-
const rateLimitAgg = Array.isArray(aggregateBy) ? aggregateBy : [RateLimitAggregator.Domain]
114-
const rewriteConfig = 'to' in input && typeof input.to === 'string' ? { to: input.to } : undefined
115-
116-
return {
117-
action: {
118-
type: (action as RateLimitAction) || RateLimitAction.Limit,
119-
config: {
120-
...rewriteConfig,
121-
rateLimitConfig: {
122-
windowLimit,
123-
windowSize,
124-
algorithm: (algorithm as RateLimitAlgorithm) || RateLimitAlgorithm.SlidingWindow,
125-
},
126-
aggregate: {
127-
keys: rateLimitAgg.map((agg) => ({ type: agg })),
128-
},
129-
},
130-
},
131-
}
132-
}
133-
13486
/**
13587
* Loads a file at a given path, parses it into an AST, and returns a series of
13688
* data points, such as in-source configuration properties and other metadata.
@@ -142,7 +94,9 @@ export const parseFile = async (
14294
const source = await safelyReadSource(sourcePath)
14395

14496
if (source === null) {
145-
return {}
97+
return {
98+
config: {},
99+
}
146100
}
147101

148102
return parseSource(source, { functionName })
@@ -157,7 +111,9 @@ export const parseSource = (source: string, { functionName }: FindISCDeclaration
157111
const ast = safelyParseSource(source)
158112

159113
if (ast === null) {
160-
return {}
114+
return {
115+
config: {},
116+
}
161117
}
162118

163119
const imports = ast.body.flatMap((node) => getImports(node, IN_SOURCE_CONFIG_MODULE))
@@ -172,92 +128,97 @@ export const parseSource = (source: string, { functionName }: FindISCDeclaration
172128

173129
if (isV2API) {
174130
const result: StaticAnalysisResult = {
131+
config: {},
175132
inputModuleFormat,
176133
runtimeAPIVersion: 2,
177134
}
135+
const { data, error, success } = inSourceConfig.safeParse(configExport)
136+
137+
if (success) {
138+
result.config = data
139+
result.routes = getRoutes({
140+
functionName,
141+
methods: data.method ?? [],
142+
path: data.path,
143+
preferStatic: data.preferStatic,
144+
})
145+
} else {
146+
// TODO: Handle multiple errors.
147+
const [issue] = error.issues
178148

179-
if (typeof configExport.schedule === 'string') {
180-
result.schedule = configExport.schedule
181-
}
182-
183-
if (typeof configExport.name === 'string') {
184-
result.name = configExport.name
149+
throw new FunctionBundlingUserError(
150+
`Function ${functionName} has a configuration error on '${issue.path.join('.')}': ${issue.message}`,
151+
{
152+
functionName,
153+
runtime: RUNTIME.JAVASCRIPT,
154+
},
155+
)
185156
}
186157

187-
if (typeof configExport.generator === 'string') {
188-
result.generator = configExport.generator
189-
}
158+
return result
159+
}
190160

191-
if (typeof configExport.timeout === 'number') {
192-
result.timeout = configExport.timeout
193-
}
161+
const result: StaticAnalysisResult = {
162+
config: {},
163+
inputModuleFormat,
164+
runtimeAPIVersion: 1,
165+
}
194166

195-
if (configExport.method !== undefined) {
196-
result.methods = normalizeMethods(configExport.method, functionName)
167+
handlerExports.forEach((node) => {
168+
// We're only interested in exports with call expressions, since that's
169+
// the pattern we use for the wrapper functions.
170+
if (node.type !== 'call-expression') {
171+
return
197172
}
198173

199-
result.routes = getRoutes({
200-
functionName,
201-
methods: result.methods ?? [],
202-
path: configExport.path,
203-
preferStatic: configExport.preferStatic === true,
204-
})
174+
const { args, local: exportName } = node
175+
const matchingImport = imports.find(({ local: importName }) => importName === exportName)
205176

206-
if (configExport.rateLimit !== undefined) {
207-
result.trafficRules = getTrafficRulesConfig(configExport.rateLimit, functionName)
177+
if (matchingImport === undefined) {
178+
return
208179
}
209180

210-
return result
211-
}
181+
switch (matchingImport.imported) {
182+
case 'schedule': {
183+
const parsed = parseSchedule({ args }, getAllBindings)
212184

213-
const iscExports = handlerExports
214-
.map((node) => {
215-
// We're only interested in exports with call expressions, since that's
216-
// the pattern we use for the wrapper functions.
217-
if (node.type !== 'call-expression') {
218-
return null
219-
}
185+
scheduledFunctionFound = true
186+
if (parsed.schedule) {
187+
scheduleFound = true
188+
}
220189

221-
const { args, local: exportName } = node
222-
const matchingImport = imports.find(({ local: importName }) => importName === exportName)
190+
if (parsed.schedule !== undefined) {
191+
result.config.schedule = parsed.schedule
192+
}
223193

224-
if (matchingImport === undefined) {
225-
return null
194+
return
226195
}
227196

228-
switch (matchingImport.imported) {
229-
case 'schedule': {
230-
const parsed = parseSchedule({ args }, getAllBindings)
231-
232-
scheduledFunctionFound = true
233-
if (parsed.schedule) {
234-
scheduleFound = true
235-
}
197+
case 'stream': {
198+
result.invocationMode = INVOCATION_MODE.Stream
236199

237-
return parsed
238-
}
239-
240-
case 'stream': {
241-
return {
242-
invocationMode: INVOCATION_MODE.Stream,
243-
}
244-
}
245-
246-
default:
247-
// no-op
200+
return
248201
}
249202

250-
return null
251-
})
252-
.filter(nonNullable)
203+
default:
204+
// no-op
205+
}
206+
207+
return
208+
})
253209

254210
if (scheduledFunctionExpected) {
255211
validateScheduleFunction(scheduledFunctionFound, scheduleFound, functionName)
256212
}
257213

258-
const mergedExports: ISCValues = iscExports.reduce((acc, obj) => ({ ...acc, ...obj }), {})
214+
return result
215+
}
259216

260-
return { ...mergedExports, inputModuleFormat, runtimeAPIVersion: 1 }
217+
export const augmentFunctionConfig = (
218+
tomlConfig: FunctionConfig,
219+
inSourceConfig: InSourceConfig = {},
220+
): FunctionConfig & InSourceConfig => {
221+
return mergeOptions.call({ concatArrays: true }, tomlConfig, inSourceConfig)
261222
}
262223

263224
export type ISCHandlerArg = ArgumentPlaceholder | Expression | SpreadElement | JSXNamespacedName

‎packages/zip-it-and-ship-it/src/runtimes/node/index.ts

+13-16
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,14 @@ import { copyFile } from 'cp-file'
44

55
import { INVOCATION_MODE } from '../../function.js'
66
import { Priority } from '../../priority.js'
7+
import { getTrafficRulesConfig } from '../../rate_limit.js'
78
import getInternalValue from '../../utils/get_internal_value.js'
89
import { GetSrcFilesFunction, Runtime, RUNTIME, ZipFunction } from '../runtime.js'
910

1011
import { getBundler, getBundlerName } from './bundlers/index.js'
1112
import { NODE_BUNDLER } from './bundlers/types.js'
1213
import { findFunctionsInPaths, findFunctionInPath } from './finder.js'
13-
import { parseFile } from './in_source_config/index.js'
14+
import { augmentFunctionConfig, parseFile } from './in_source_config/index.js'
1415
import { MODULE_FORMAT, MODULE_FILE_EXTENSION } from './utils/module_format.js'
1516
import { getNodeRuntime, getNodeRuntimeForV2 } from './utils/node_runtime.js'
1617
import { createAliases as createPluginsModulesPathAliases, getPluginsModulesPath } from './utils/plugin_modules_path.js'
@@ -64,10 +65,10 @@ const zipFunction: ZipFunction = async function ({
6465

6566
const staticAnalysisResult = await parseFile(mainFile, { functionName: name })
6667
const runtimeAPIVersion = staticAnalysisResult.runtimeAPIVersion === 2 ? 2 : 1
67-
68+
const mergedConfig = augmentFunctionConfig(config, staticAnalysisResult.config)
6869
const pluginsModulesPath = await getPluginsModulesPath(srcDir)
6970
const bundlerName = await getBundlerName({
70-
config,
71+
config: mergedConfig,
7172
extension,
7273
featureFlags,
7374
mainFile,
@@ -89,7 +90,7 @@ const zipFunction: ZipFunction = async function ({
8990
} = await bundler.bundle({
9091
basePath,
9192
cache,
92-
config,
93+
config: mergedConfig,
9394
extension,
9495
featureFlags,
9596
filename,
@@ -141,25 +142,19 @@ const zipFunction: ZipFunction = async function ({
141142
invocationMode = INVOCATION_MODE.Background
142143
}
143144

144-
const {
145-
trafficRules,
146-
generator: staticAnalysisGenerator,
147-
name: staticAnalysisName,
148-
timeout: staticAnalysisTimeout,
149-
} = staticAnalysisResult
150-
151145
const outputModuleFormat =
152146
extname(finalMainFile) === MODULE_FILE_EXTENSION.MJS ? MODULE_FORMAT.ESM : MODULE_FORMAT.COMMONJS
153147
const priority = isInternal ? Priority.GeneratedFunction : Priority.UserFunction
148+
const trafficRules = mergedConfig?.rateLimit ? getTrafficRulesConfig(mergedConfig.rateLimit) : undefined
154149

155150
return {
156151
bundler: bundlerName,
157152
bundlerWarnings,
158-
config,
159-
displayName: staticAnalysisName || config?.name,
153+
config: mergedConfig,
154+
displayName: mergedConfig?.name,
160155
entryFilename: zipPath.entryFilename,
161-
generator: staticAnalysisGenerator || config?.generator || getInternalValue(isInternal),
162-
timeout: staticAnalysisTimeout || config?.timeout,
156+
generator: mergedConfig?.generator || getInternalValue(isInternal),
157+
timeout: mergedConfig?.timeout,
163158
inputs,
164159
includedFiles,
165160
staticAnalysisResult,
@@ -170,7 +165,9 @@ const zipFunction: ZipFunction = async function ({
170165
priority,
171166
trafficRules,
172167
runtimeVersion:
173-
runtimeAPIVersion === 2 ? getNodeRuntimeForV2(config.nodeVersion) : getNodeRuntime(config.nodeVersion),
168+
runtimeAPIVersion === 2
169+
? getNodeRuntimeForV2(mergedConfig.nodeVersion)
170+
: getNodeRuntime(mergedConfig.nodeVersion),
174171
}
175172
}
176173

‎packages/zip-it-and-ship-it/src/runtimes/node/utils/module_format.ts

+5-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
import { z } from 'zod'
2+
13
import type { FeatureFlags } from '../../../feature_flags.js'
24
import { ObjectValues } from '../../../types/utils.js'
35

@@ -8,7 +10,9 @@ export const MODULE_FORMAT = {
810
ESM: 'esm',
911
} as const
1012

11-
export type ModuleFormat = ObjectValues<typeof MODULE_FORMAT>
13+
export const moduleFormat = z.nativeEnum(MODULE_FORMAT)
14+
15+
export type ModuleFormat = z.infer<typeof moduleFormat>
1216

1317
export const MODULE_FILE_EXTENSION = {
1418
CJS: '.cjs',

‎packages/zip-it-and-ship-it/src/runtimes/runtime.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import type { FunctionConfig } from '../config.js'
33
import type { FeatureFlags } from '../feature_flags.js'
44
import type { FunctionSource, InvocationMode, SourceFile } from '../function.js'
55
import type { ModuleFormat } from '../main.js'
6-
import { TrafficRules } from '../manifest.js'
6+
import type { TrafficRules } from '../rate_limit.js'
77
import { ObjectValues } from '../types/utils.js'
88
import type { RuntimeCache } from '../utils/cache.js'
99
import { Logger } from '../utils/logger.js'

‎packages/zip-it-and-ship-it/src/utils/format_result.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ export const formatZipResult = (archive: FunctionArchive) => {
1818
staticAnalysisResult: undefined,
1919
routes: archive.staticAnalysisResult?.routes,
2020
runtime: archive.runtime.name,
21-
schedule: archive.staticAnalysisResult?.schedule ?? archive?.config?.schedule,
21+
schedule: archive.staticAnalysisResult?.config?.schedule ?? archive?.config?.schedule,
2222
runtimeAPIVersion: archive.staticAnalysisResult?.runtimeAPIVersion,
2323
}
2424

‎packages/zip-it-and-ship-it/tests/fixtures-esm/v2-api-bundler-none/function.js

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
export default async () =>
2+
new Response('<h1>Hello world</h1>', {
3+
headers: {
4+
'content-type': 'text/html',
5+
},
6+
})
7+
8+
export const config = {
9+
nodeBundler: 'none',
10+
}

‎packages/zip-it-and-ship-it/tests/fixtures-esm/v2-api-bundler-none/package.json

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"type": "module"
3+
}

‎packages/zip-it-and-ship-it/tests/fixtures-esm/v2-api-included-files/blog/author1.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Author 1

‎packages/zip-it-and-ship-it/tests/fixtures-esm/v2-api-included-files/blog/post1.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Post 1

‎packages/zip-it-and-ship-it/tests/fixtures-esm/v2-api-included-files/blog/post2.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Post 2

‎packages/zip-it-and-ship-it/tests/fixtures-esm/v2-api-included-files/function.js

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
export default async () =>
2+
new Response('<h1>Hello world</h1>', {
3+
headers: {
4+
'content-type': 'text/html',
5+
},
6+
})
7+
8+
export const config = {
9+
includedFiles: ['blog/author*'],
10+
}

‎packages/zip-it-and-ship-it/tests/fixtures-esm/v2-api-included-files/package.json

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"type": "module"
3+
}

‎packages/zip-it-and-ship-it/tests/fixtures-esm/v2-api-node-version/function.js

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
export default async () =>
2+
new Response('<h1>Hello world</h1>', {
3+
headers: {
4+
'content-type': 'text/html',
5+
},
6+
})
7+
8+
export const config = {
9+
nodeVersion: '20',
10+
}

‎packages/zip-it-and-ship-it/tests/fixtures-esm/v2-api-node-version/package.json

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"type": "module"
3+
}

‎packages/zip-it-and-ship-it/tests/unit/runtimes/node/in_source_config.test.ts

+89-61
Large diffs are not rendered by default.

‎packages/zip-it-and-ship-it/tests/v2api.test.ts

+94-17
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ import { dir as getTmpDir } from 'tmp-promise'
1010
import { afterEach, describe, expect, test, vi } from 'vitest'
1111

1212
import { ARCHIVE_FORMAT } from '../src/archive.js'
13+
import { DEFAULT_NODE_VERSION } from '../src/runtimes/node/utils/node_version.js'
1314

1415
import { invokeLambda, readAsBuffer } from './helpers/lambda.js'
1516
import { zipFixture, unzipFiles, importFunctionFile, FIXTURES_ESM_DIR, FIXTURES_DIR } from './helpers/main.js'
@@ -396,34 +397,42 @@ describe.runIf(semver.gte(nodeVersion, '18.13.0'))('V2 functions API', () => {
396397
},
397398
})
398399

399-
expect.assertions(files.length + 2)
400+
expect(files.some(({ name }) => name === 'with-literal')).toBeTruthy()
401+
expect(files.some(({ name }) => name === 'with-named-group')).toBeTruthy()
402+
expect(files.some(({ name }) => name === 'with-regex')).toBeTruthy()
403+
404+
const expectedRoutes = [
405+
[{ pattern: '/products', literal: '/products', methods: ['GET', 'POST'] }],
406+
[
407+
{
408+
pattern: '/products/:id',
409+
expression: '^\\/products(?:\\/([^\\/]+?))\\/?$',
410+
methods: [],
411+
},
412+
],
413+
[
414+
{
415+
pattern: '/numbers/(\\d+)',
416+
expression: '^\\/numbers(?:\\/(\\d+))\\/?$',
417+
methods: [],
418+
},
419+
],
420+
]
400421

401422
for (const file of files) {
402423
switch (file.name) {
403424
case 'with-literal':
404-
expect(file.routes).toEqual([{ pattern: '/products', literal: '/products', methods: ['GET', 'POST'] }])
425+
expect(file.routes).toEqual(expectedRoutes[0])
405426

406427
break
407428

408429
case 'with-named-group':
409-
expect(file.routes).toEqual([
410-
{
411-
pattern: '/products/:id',
412-
expression: '^\\/products(?:\\/([^\\/]+?))\\/?$',
413-
methods: [],
414-
},
415-
])
430+
expect(file.routes).toEqual(expectedRoutes[1])
416431

417432
break
418433

419434
case 'with-regex':
420-
expect(file.routes).toEqual([
421-
{
422-
pattern: '/numbers/(\\d+)',
423-
expression: '^\\/numbers(?:\\/(\\d+))\\/?$',
424-
methods: [],
425-
},
426-
])
435+
expect(file.routes).toEqual(expectedRoutes[2])
427436

428437
break
429438

@@ -434,8 +443,15 @@ describe.runIf(semver.gte(nodeVersion, '18.13.0'))('V2 functions API', () => {
434443

435444
const manifestString = await readFile(manifestPath, { encoding: 'utf8' })
436445
const manifest = JSON.parse(manifestString)
437-
expect(manifest.functions[0].routes[0].methods).toEqual(['GET', 'POST'])
446+
447+
expect(manifest.functions[0].routes).toEqual(expectedRoutes[0])
438448
expect(manifest.functions[0].buildData.runtimeAPIVersion).toEqual(2)
449+
450+
expect(manifest.functions[1].routes).toEqual(expectedRoutes[1])
451+
expect(manifest.functions[1].buildData.runtimeAPIVersion).toEqual(2)
452+
453+
expect(manifest.functions[2].routes).toEqual(expectedRoutes[2])
454+
expect(manifest.functions[2].buildData.runtimeAPIVersion).toEqual(2)
439455
})
440456

441457
test('Flags invalid values of the `path` in-source configuration property as user errors', async () => {
@@ -581,4 +597,65 @@ describe.runIf(semver.gte(nodeVersion, '18.13.0'))('V2 functions API', () => {
581597
expect(positionOfBootstrapImport).toBeLessThan(positionOfUserCodeImport)
582598
},
583599
)
600+
601+
testMany(
602+
'Includes in the bundle files included in the TOML and in the function source',
603+
['bundler_default'],
604+
async (options) => {
605+
const fixtureName = 'v2-api-included-files'
606+
const { files, tmpDir } = await zipFixture(fixtureName, {
607+
fixtureDir: FIXTURES_ESM_DIR,
608+
opts: merge(options, {
609+
archiveFormat: ARCHIVE_FORMAT.NONE,
610+
config: {
611+
'*': {
612+
includedFiles: ['blog/post*'],
613+
},
614+
},
615+
}),
616+
})
617+
618+
const [{ name: archive, entryFilename, includedFiles, runtimeAPIVersion }] = files
619+
const func = await importFunctionFile(`${tmpDir}/${archive}/${entryFilename}`)
620+
const { body: bodyStream, multiValueHeaders = {}, statusCode } = await invokeLambda(func)
621+
const body = await readAsBuffer(bodyStream)
622+
623+
expect(body).toBe('<h1>Hello world</h1>')
624+
expect(multiValueHeaders['content-type']).toEqual(['text/html'])
625+
expect(statusCode).toBe(200)
626+
expect(runtimeAPIVersion).toBe(2)
627+
expect(includedFiles).toEqual([
628+
resolve(FIXTURES_ESM_DIR, fixtureName, 'blog/author1.md'),
629+
resolve(FIXTURES_ESM_DIR, fixtureName, 'blog/post1.md'),
630+
resolve(FIXTURES_ESM_DIR, fixtureName, 'blog/post2.md'),
631+
])
632+
},
633+
)
634+
635+
test('Uses the bundler specified in the `nodeBundler` property from the in-source configuration', async () => {
636+
const fixtureName = 'v2-api-bundler-none'
637+
const { files } = await zipFixture(fixtureName, {
638+
fixtureDir: FIXTURES_ESM_DIR,
639+
})
640+
641+
const unzippedFunctions = await unzipFiles(files)
642+
const originalFile = await readFile(join(FIXTURES_ESM_DIR, fixtureName, 'function.js'), 'utf8')
643+
const bundledFile = await readFile(join(unzippedFunctions[0].unzipPath, 'function.js'), 'utf8')
644+
645+
expect(originalFile).toBe(bundledFile)
646+
})
647+
648+
test('Uses the Node.js version specified in the `nodeVersion` property from the in-source configuration', async () => {
649+
const fixtureName = 'v2-api-node-version'
650+
const { files } = await zipFixture(fixtureName, {
651+
fixtureDir: FIXTURES_ESM_DIR,
652+
})
653+
654+
expect(
655+
`nodejs${DEFAULT_NODE_VERSION}.x`,
656+
'The Node.js version extracted from the function is the same as the default version, which defeats the point of the assertion. If you have updated the default Node.js version, please update the fixture to use a different version.',
657+
).not.toBe(files[0].runtimeVersion)
658+
expect(files[0].config.nodeVersion).toBe('20')
659+
expect(files[0].runtimeVersion).toBe('nodejs20.x')
660+
})
584661
})

‎packages/zip-it-and-ship-it/tsconfig.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22
"extends": "../../tsconfig.base.json",
33
"compilerOptions": {
44
"outDir": "dist" /* Specify an output folder for all emitted files. */,
5-
"esModuleInterop": true
5+
"esModuleInterop": true,
6+
"strict": true
67
},
78
"include": ["src"],
89
"exclude": ["tests/**"]

0 commit comments

Comments
 (0)
Please sign in to comment.