feat!: replace mode property with cache (#190)

.eslintrc.cjs

@@ -13,6 +13,7 @@ module.exports = {
     'max-lines': 'off',
     'max-statements': 'off',
     'node/no-missing-import': 'off',
+    'no-shadow': 'off',
     'unicorn/prefer-json-parse-buffer': 'off',
   },
   overrides: [

node/config.ts

@@ -10,7 +10,6 @@ import { ImportMap } from './import_map.js'
 import { Logger } from './logger.js'
 import { getPackagePath } from './package_json.js'
 
-// eslint-disable-next-line no-shadow
 enum ConfigExitCode {
   Success = 0,
   UnhandledError = 1,
@@ -21,14 +20,13 @@ enum ConfigExitCode {
   SerializationError,
 }
 
-// eslint-disable-next-line no-shadow
-export const enum Mode {
-  BeforeCache = 'before-cache',
-  AfterCache = 'after-cache',
+export const enum Cache {
+  Off = 'off',
+  Manual = 'manual',
 }
 
 export interface FunctionConfig {
-  mode?: Mode
+  cache?: Cache
   path?: string
 }
 

node/declaration.ts

@@ -1,8 +1,8 @@
 import { FunctionConfig } from './config.js'
 
 interface BaseDeclaration {
+  cache?: string
   function: string
-  mode?: string
   name?: string
 }
 

node/manifest.test.ts

@@ -116,8 +116,8 @@ test('Generates a manifest with pre and post-cache routes', () => {
   ]
   const declarations = [
     { function: 'func-1', path: '/f1' },
-    { function: 'func-2', mode: 'not_a_supported_mode', path: '/f2' },
-    { function: 'func-3', mode: 'after-cache', path: '/f3' },
+    { function: 'func-2', cache: 'not_a_supported_value', path: '/f2' },
+    { function: 'func-3', cache: 'manual', path: '/f3' },
   ]
   const manifest = generateManifest({ bundles: [bundle1, bundle2], declarations, functions })
 

node/manifest.ts

@@ -4,7 +4,7 @@ import { join } from 'path'
 import globToRegExp from 'glob-to-regexp'
 
 import type { Bundle } from './bundle.js'
-import { Mode } from './config.js'
+import { Cache } from './config.js'
 import type { Declaration } from './declaration.js'
 import { EdgeFunction } from './edge_function.js'
 import { getPackageVersion } from './package_json.js'
@@ -50,7 +50,7 @@ const generateManifest = ({ bundles = [], declarations = [], functions }: Genera
       pattern: serializablePattern,
     }
 
-    if (declaration.mode === Mode.AfterCache) {
+    if (declaration.cache === Cache.Manual) {
       postCacheRoutes.push(route)
     } else {
       preCacheRoutes.push(route)

test/fixtures/with_config/netlify/edge-functions/user-func3.ts

@@ -1,6 +1,6 @@
 export default async () => new Response('Hello from user function 3')
 
 export const config = () => ({
-  mode: 'not_a_supported_mode',
+  cache: 'not_a_supported_value',
   path: '/user-func3',
 })

test/fixtures/with_config/netlify/edge-functions/user-func4.ts

@@ -1,6 +1,11 @@
-export default async () => new Response('Hello from user function 4. I should run after the cache!')
+export default async () =>
+  new Response('Hello from user function 4. I will be cached!', {
+    headers: {
+      'cache-control': 'public, s-maxage=60',
+    },
+  })
 
 export const config = () => ({
-  mode: 'after-cache',
+  cache: 'manual',
   path: '/user-func4',
 })