feat: add timeout config prop for functions (#5683)

Co-authored-by: Antonio Rodríguez <[email protected]> Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
netlify · May 29, 2024 · 7bfd4ea · 7bfd4ea
1 parent 3aecbfc
commit 7bfd4ea
Show file tree

Hide file tree

Showing 13 changed files with 165 additions and 3 deletions.
diff --git a/packages/zip-it-and-ship-it/src/config.ts b/packages/zip-it-and-ship-it/src/config.ts
@@ -22,6 +22,7 @@ interface FunctionConfig {
   zipGo?: boolean
   name?: string
   generator?: string
+  timeout?: number
 
   // Temporary configuration property, only meant to be used by the deploy
   // configuration API. Once we start emitting ESM files for all ESM functions,

diff --git a/packages/zip-it-and-ship-it/src/main.ts b/packages/zip-it-and-ship-it/src/main.ts
@@ -29,6 +29,7 @@ export interface ListedFunction {
   schedule?: string
   displayName?: string
   generator?: string
+  timeout?: number
   inputModuleFormat?: ModuleFormat
 }
 
@@ -151,6 +152,7 @@ const getListedFunction = function ({
     displayName: config.name,
     extension,
     generator: config.generator,
+    timeout: config.timeout,
     mainFile,
     name,
     runtime: runtime.name,

diff --git a/packages/zip-it-and-ship-it/src/manifest.ts b/packages/zip-it-and-ship-it/src/manifest.ts
@@ -38,6 +38,7 @@ interface ManifestFunction {
   displayName?: string
   bundler?: string
   generator?: string
+  timeout?: number
   priority?: number
   trafficRules?: TrafficRules
 }
@@ -81,11 +82,13 @@ const formatFunctionForManifest = ({
   runtimeVersion,
   runtimeAPIVersion,
   schedule,
+  timeout,
 }: FunctionResult): ManifestFunction => {
   const manifestFunction: ManifestFunction = {
     bundler,
     displayName,
     generator,
+    timeout,
     invocationMode,
     buildData: { runtimeAPIVersion },
     mainFile,

diff --git a/packages/zip-it-and-ship-it/src/runtimes/node/in_source_config/index.ts b/packages/zip-it-and-ship-it/src/runtimes/node/in_source_config/index.ts
@@ -25,6 +25,7 @@ export type ISCValues = {
   trafficRules?: TrafficRules
   name?: string
   generator?: string
+  timeout?: number
 }
 
 export interface StaticAnalysisResult extends ISCValues {
@@ -187,6 +188,10 @@ export const parseSource = (source: string, { functionName }: FindISCDeclaration
       result.generator = configExport.generator
     }
 
+    if (typeof configExport.timeout === 'number') {
+      result.timeout = configExport.timeout
+    }
+
     if (configExport.method !== undefined) {
       result.methods = normalizeMethods(configExport.method, functionName)
     }

diff --git a/packages/zip-it-and-ship-it/src/runtimes/node/index.ts b/packages/zip-it-and-ship-it/src/runtimes/node/index.ts
@@ -141,7 +141,12 @@ const zipFunction: ZipFunction = async function ({
     invocationMode = INVOCATION_MODE.Background
   }
 
-  const { trafficRules, generator: staticAnalysisGenerator, name: staticAnalysisName } = staticAnalysisResult
+  const {
+    trafficRules,
+    generator: staticAnalysisGenerator,
+    name: staticAnalysisName,
+    timeout: staticAnalysisTimeout,
+  } = staticAnalysisResult
 
   const outputModuleFormat =
     extname(finalMainFile) === MODULE_FILE_EXTENSION.MJS ? MODULE_FORMAT.ESM : MODULE_FORMAT.COMMONJS
@@ -154,6 +159,7 @@ const zipFunction: ZipFunction = async function ({
     displayName: staticAnalysisName || config?.name,
     entryFilename: zipPath.entryFilename,
     generator: staticAnalysisGenerator || config?.generator || getInternalValue(isInternal),
+    timeout: staticAnalysisTimeout || config?.timeout,
     inputs,
     includedFiles,
     staticAnalysisResult,

diff --git a/packages/zip-it-and-ship-it/src/runtimes/runtime.ts b/packages/zip-it-and-ship-it/src/runtimes/runtime.ts
@@ -48,6 +48,7 @@ export interface ZipFunctionResult {
   config: FunctionConfig
   displayName?: string
   generator?: string
+  timeout?: number
   inputs?: string[]
   includedFiles?: string[]
   invocationMode?: InvocationMode

diff --git a/packages/zip-it-and-ship-it/tests/__snapshots__/list_function.test.ts.snap b/packages/zip-it-and-ship-it/tests/__snapshots__/list_function.test.ts.snap
@@ -12,5 +12,6 @@ exports[`listFunction > V2 API > listFunction includes metadata properties when
   "runtimeAPIVersion": 2,
   "schedule": undefined,
   "srcFile": undefined,
+  "timeout": undefined,
 }
 `;
diff --git a/packages/zip-it-and-ship-it/tests/__snapshots__/list_functions.test.ts.snap b/packages/zip-it-and-ship-it/tests/__snapshots__/list_functions.test.ts.snap
@@ -12,6 +12,7 @@ exports[`listFunctions > V2 API > listFunctions includes runtimeAPIVersion when
   "runtimeAPIVersion": 2,
   "schedule": undefined,
   "srcFile": undefined,
+  "timeout": undefined,
 }
 `;
 
@@ -28,6 +29,7 @@ exports[`listFunctions > v1 > Can list function main files from multiple source
     "runtimeAPIVersion": undefined,
     "schedule": undefined,
     "srcFile": undefined,
+    "timeout": undefined,
   },
   {
     "displayName": undefined,
@@ -40,6 +42,7 @@ exports[`listFunctions > v1 > Can list function main files from multiple source
     "runtimeAPIVersion": undefined,
     "schedule": undefined,
     "srcFile": undefined,
+    "timeout": undefined,
   },
   {
     "displayName": undefined,
@@ -52,6 +55,7 @@ exports[`listFunctions > v1 > Can list function main files from multiple source
     "runtimeAPIVersion": undefined,
     "schedule": undefined,
     "srcFile": undefined,
+    "timeout": undefined,
   },
   {
     "displayName": undefined,
@@ -64,6 +68,7 @@ exports[`listFunctions > v1 > Can list function main files from multiple source
     "runtimeAPIVersion": undefined,
     "schedule": undefined,
     "srcFile": undefined,
+    "timeout": undefined,
   },
 ]
 `;
@@ -81,6 +86,7 @@ exports[`listFunctions > v1 > Can list function main files with listFunctions()
     "runtimeAPIVersion": undefined,
     "schedule": undefined,
     "srcFile": undefined,
+    "timeout": undefined,
   },
   {
     "displayName": undefined,
@@ -93,6 +99,7 @@ exports[`listFunctions > v1 > Can list function main files with listFunctions()
     "runtimeAPIVersion": undefined,
     "schedule": undefined,
     "srcFile": undefined,
+    "timeout": undefined,
   },
   {
     "displayName": undefined,
@@ -105,6 +112,7 @@ exports[`listFunctions > v1 > Can list function main files with listFunctions()
     "runtimeAPIVersion": undefined,
     "schedule": undefined,
     "srcFile": undefined,
+    "timeout": undefined,
   },
   {
     "displayName": undefined,
@@ -117,6 +125,7 @@ exports[`listFunctions > v1 > Can list function main files with listFunctions()
     "runtimeAPIVersion": undefined,
     "schedule": undefined,
     "srcFile": undefined,
+    "timeout": undefined,
   },
   {
     "displayName": undefined,
@@ -129,6 +138,7 @@ exports[`listFunctions > v1 > Can list function main files with listFunctions()
     "runtimeAPIVersion": undefined,
     "schedule": undefined,
     "srcFile": undefined,
+    "timeout": undefined,
   },
   {
     "displayName": undefined,
@@ -141,6 +151,7 @@ exports[`listFunctions > v1 > Can list function main files with listFunctions()
     "runtimeAPIVersion": undefined,
     "schedule": undefined,
     "srcFile": undefined,
+    "timeout": undefined,
   },
   {
     "displayName": undefined,
@@ -153,6 +164,7 @@ exports[`listFunctions > v1 > Can list function main files with listFunctions()
     "runtimeAPIVersion": undefined,
     "schedule": undefined,
     "srcFile": undefined,
+    "timeout": undefined,
   },
 ]
 `;
@@ -170,6 +182,7 @@ exports[`listFunctions > v1 > listFunctions includes in-source config declaratio
     "runtimeAPIVersion": 1,
     "schedule": "@daily",
     "srcFile": undefined,
+    "timeout": undefined,
   },
   {
     "displayName": undefined,
@@ -182,6 +195,7 @@ exports[`listFunctions > v1 > listFunctions includes in-source config declaratio
     "runtimeAPIVersion": 1,
     "schedule": "@daily",
     "srcFile": undefined,
+    "timeout": undefined,
   },
   {
     "displayName": undefined,
@@ -194,6 +208,7 @@ exports[`listFunctions > v1 > listFunctions includes in-source config declaratio
     "runtimeAPIVersion": 1,
     "schedule": "@daily",
     "srcFile": undefined,
+    "timeout": undefined,
   },
   {
     "displayName": undefined,
@@ -206,6 +221,7 @@ exports[`listFunctions > v1 > listFunctions includes in-source config declaratio
     "runtimeAPIVersion": 1,
     "schedule": "@daily",
     "srcFile": undefined,
+    "timeout": undefined,
   },
   {
     "displayName": undefined,
@@ -218,6 +234,7 @@ exports[`listFunctions > v1 > listFunctions includes in-source config declaratio
     "runtimeAPIVersion": 1,
     "schedule": "@daily",
     "srcFile": undefined,
+    "timeout": undefined,
   },
   {
     "displayName": undefined,
@@ -230,6 +247,7 @@ exports[`listFunctions > v1 > listFunctions includes in-source config declaratio
     "runtimeAPIVersion": 1,
     "schedule": "@daily",
     "srcFile": undefined,
+    "timeout": undefined,
   },
   {
     "displayName": undefined,
@@ -242,6 +260,7 @@ exports[`listFunctions > v1 > listFunctions includes in-source config declaratio
     "runtimeAPIVersion": 1,
     "schedule": "@daily",
     "srcFile": undefined,
+    "timeout": undefined,
   },
   {
     "displayName": undefined,
@@ -254,6 +273,7 @@ exports[`listFunctions > v1 > listFunctions includes in-source config declaratio
     "runtimeAPIVersion": 1,
     "schedule": "@daily",
     "srcFile": undefined,
+    "timeout": undefined,
   },
   {
     "displayName": undefined,
@@ -266,6 +286,7 @@ exports[`listFunctions > v1 > listFunctions includes in-source config declaratio
     "runtimeAPIVersion": 1,
     "schedule": "@daily",
     "srcFile": undefined,
+    "timeout": undefined,
   },
   {
     "displayName": undefined,
@@ -278,6 +299,7 @@ exports[`listFunctions > v1 > listFunctions includes in-source config declaratio
     "runtimeAPIVersion": 1,
     "schedule": "@daily",
     "srcFile": undefined,
+    "timeout": undefined,
   },
   {
     "displayName": undefined,
@@ -290,6 +312,7 @@ exports[`listFunctions > v1 > listFunctions includes in-source config declaratio
     "runtimeAPIVersion": 1,
     "schedule": "@daily",
     "srcFile": undefined,
+    "timeout": undefined,
   },
   {
     "displayName": undefined,
@@ -302,6 +325,7 @@ exports[`listFunctions > v1 > listFunctions includes in-source config declaratio
     "runtimeAPIVersion": 1,
     "schedule": "@daily",
     "srcFile": undefined,
+    "timeout": undefined,
   },
   {
     "displayName": undefined,
@@ -314,6 +338,7 @@ exports[`listFunctions > v1 > listFunctions includes in-source config declaratio
     "runtimeAPIVersion": 1,
     "schedule": "@daily",
     "srcFile": undefined,
+    "timeout": undefined,
   },
 ]
 `;