Add timeout configuration functionality to netlify/primitives

packages/dev-utils/package.json

@@ -41,7 +41,7 @@
   },
   "author": "Netlify Inc.",
   "devDependencies": {
-    "@netlify/types": "2.0.1",
+    "@netlify/types": "2.0.2",
     "@types/lodash.debounce": "^4.0.9",
     "@types/node": "^18.19.110",
     "@types/parse-gitignore": "^1.0.2",

packages/dev-utils/src/lib/function-timeout.test.ts

@@ -0,0 +1,65 @@
+import { describe, expect, test } from 'vitest'
+
+import type { FunctionTimeoutConfig } from '@netlify/types'
+
+import { SYNCHRONOUS_FUNCTION_TIMEOUT, BACKGROUND_FUNCTION_TIMEOUT, getFunctionTimeout } from './function-timeout.js'
+
+describe('Function Timeout Configuration', () => {
+  test('should export correct default timeout constants', () => {
+    expect(SYNCHRONOUS_FUNCTION_TIMEOUT).toBe(30)
+    expect(BACKGROUND_FUNCTION_TIMEOUT).toBe(900)
+  })
+
+  test('should return default timeout for sync functions when no site config provided', () => {
+    const siteConfig: FunctionTimeoutConfig = {}
+    const timeout = getFunctionTimeout(siteConfig, false)
+    expect(timeout).toBe(30)
+  })
+
+  test('should return default timeout for background functions when no site config provided', () => {
+    const siteConfig: FunctionTimeoutConfig = {}
+    const timeout = getFunctionTimeout(siteConfig, true)
+    expect(timeout).toBe(900)
+  })
+
+  test('should respect functionsTimeout from site config', () => {
+    const siteConfig: FunctionTimeoutConfig = {
+      functionsTimeout: 60
+    }
+
+    // Should use site timeout for both sync and background functions
+    expect(getFunctionTimeout(siteConfig, false)).toBe(60)
+    expect(getFunctionTimeout(siteConfig, true)).toBe(60)
+  })
+
+  test('should respect functionsConfig.timeout from site config', () => {
+    const siteConfig: FunctionTimeoutConfig = {
+      functionsConfig: {
+        timeout: 120
+      }
+    }
+
+    // Should use site timeout for both sync and background functions
+    expect(getFunctionTimeout(siteConfig, false)).toBe(120)
+    expect(getFunctionTimeout(siteConfig, true)).toBe(120)
+  })
+
+  test('should prioritize functionsTimeout over functionsConfig.timeout', () => {
+    const siteConfig: FunctionTimeoutConfig = {
+      functionsTimeout: 60,
+      functionsConfig: {
+        timeout: 120
+      }
+    }
+
+    // Should use functionsTimeout as it has higher priority
+    expect(getFunctionTimeout(siteConfig, false)).toBe(60)
+    expect(getFunctionTimeout(siteConfig, true)).toBe(60)
+  })
+
+  test('should default to sync timeout when isBackground is not specified', () => {
+    const siteConfig: FunctionTimeoutConfig = {}
+    const timeout = getFunctionTimeout(siteConfig)
+    expect(timeout).toBe(30)
+  })
+})

packages/dev-utils/src/lib/function-timeout.ts

@@ -0,0 +1,32 @@
+import type { FunctionTimeoutConfig } from '@netlify/types'
+
+/**
+ * Default timeout for synchronous functions in seconds
+ */
+export const SYNCHRONOUS_FUNCTION_TIMEOUT = 30
+
+/**
+ * Default timeout for background functions in seconds
+ */
+export const BACKGROUND_FUNCTION_TIMEOUT = 900
+
+/**
+ * Get the effective function timeout considering site-specific configuration
+ * @param siteConfig - Site configuration with timeout options
+ * @param isBackground - Whether this is a background function
+ * @returns Function timeout in seconds
+ */
+export function getFunctionTimeout(
+  siteConfig: FunctionTimeoutConfig,
+  isBackground = false
+): number {
+  // Check for site-specific timeout configuration
+  const siteTimeout = siteConfig.functionsTimeout ?? siteConfig.functionsConfig?.timeout
+
+  if (siteTimeout) {
+    return siteTimeout
+  }
+
+  // Use default timeout based on function type
+  return isBackground ? BACKGROUND_FUNCTION_TIMEOUT : SYNCHRONOUS_FUNCTION_TIMEOUT
+}

packages/dev-utils/src/main.ts

@@ -2,6 +2,7 @@ export { getAPIToken } from './lib/api-token.js'
 export { shouldBase64Encode } from './lib/base64.js'
 export { renderFunctionErrorPage } from './lib/errors.js'
 export { DevEvent, DevEventHandler } from './lib/event.js'
+export { SYNCHRONOUS_FUNCTION_TIMEOUT, BACKGROUND_FUNCTION_TIMEOUT, getFunctionTimeout } from './lib/function-timeout.js'
 export { type Geolocation, mockLocation } from './lib/geo-location.js'
 export { ensureNetlifyIgnore } from './lib/gitignore.js'
 export { headers, toMultiValueHeaders } from './lib/headers.js'

packages/types/src/lib/function-timeout.test.ts

@@ -0,0 +1,37 @@
+import { describe, expect, test } from 'vitest'
+
+import type { FunctionTimeoutConfig } from './function-timeout.js'
+
+describe('FunctionTimeoutConfig Type', () => {
+  test('should allow empty configuration', () => {
+    const config: FunctionTimeoutConfig = {}
+    expect(config).toEqual({})
+  })
+
+  test('should allow functionsTimeout configuration', () => {
+    const config: FunctionTimeoutConfig = {
+      functionsTimeout: 60
+    }
+    expect(config.functionsTimeout).toBe(60)
+  })
+
+  test('should allow functionsConfig.timeout configuration', () => {
+    const config: FunctionTimeoutConfig = {
+      functionsConfig: {
+        timeout: 120
+      }
+    }
+    expect(config.functionsConfig?.timeout).toBe(120)
+  })
+
+  test('should allow both timeout configurations', () => {
+    const config: FunctionTimeoutConfig = {
+      functionsTimeout: 60,
+      functionsConfig: {
+        timeout: 120
+      }
+    }
+    expect(config.functionsTimeout).toBe(60)
+    expect(config.functionsConfig?.timeout).toBe(120)
+  })
+})

packages/types/src/lib/function-timeout.ts

@@ -0,0 +1,15 @@
+/**
+ * Configuration for function timeout options
+ */
+export interface FunctionTimeoutConfig {
+  /**
+   * Site-specific function timeout in seconds
+   */
+  functionsTimeout?: number
+  /**
+   * Function-specific timeout configuration
+   */
+  functionsConfig?: {
+    timeout?: number
+  }
+}

packages/types/src/main.ts

@@ -1,4 +1,5 @@
 export type { Context } from './lib/context/context.js'
 export type { Cookie } from './lib/context/cookies.js'
 export type { EnvironmentVariables } from './lib/environment-variables.js'
+export type { FunctionTimeoutConfig } from './lib/function-timeout.js'
 export type { NetlifyGlobal } from './lib/globals.js'