fix: revert slash validation and change validation message (netlify/e…

…dge-bundler#343)

* fix: change validation message

* Apply suggestions from code review

Co-authored-by: Kristen Lavavej <35638702+klavavej@users.noreply.github.com>
Co-authored-by: Eduardo Bouças <mail@eduardoboucas.com>

* chore: fix snapshots

* chore: do not validate pattern for beginning slash

---------

Co-authored-by: Kristen Lavavej <35638702+klavavej@users.noreply.github.com>
Co-authored-by: Eduardo Bouças <mail@eduardoboucas.com>

packages/edge-bundler/node/feature_flags.ts

@@ -2,7 +2,6 @@ const defaultFlags = {
   edge_functions_correct_order: false,
   edge_functions_fail_unsupported_regex: false,
   edge_functions_invalid_config_throw: false,
-  edge_functions_manifest_validate_slash: false,
 }
 
 type FeatureFlag = keyof typeof defaultFlags

packages/edge-bundler/node/validation/manifest/__snapshots__/index.test.ts.snap

@@ -122,25 +122,12 @@ ADDTIONAL PROPERTY must NOT have additional properties
 
 exports[`route > should throw on invalid pattern 1`] = `
 "Validation of Edge Functions manifest failed
-FORMAT pattern needs to be a regex that starts with ^ followed by / and ends with $ without any additional slashes before and afterwards
+FORMAT pattern must be a regex that starts with ^ and ends with $ (e.g. ^/blog/[d]{4}$)
 
   10 |       \\"name\\": \\"name\\",
   11 |       \\"function\\": \\"hello\\",
 > 12 |       \\"pattern\\": \\"/^/hello/?$/\\",
-     |                  ^^^^^^^^^^^^^^ 👈🏽  format pattern needs to be a regex that starts with ^ followed by / and ends with $ without any additional slashes before and afterwards
-  13 |       \\"generator\\": \\"@netlify/fake-plugin@1.0.0\\"
-  14 |     }
-  15 |   ],"
-`;
-
-exports[`route > should throw on missing beginning slash with FF 1`] = `
-"Validation of Edge Functions manifest failed
-FORMAT pattern needs to be a regex that starts with ^ followed by / and ends with $ without any additional slashes before and afterwards
-
-  10 |       \\"name\\": \\"name\\",
-  11 |       \\"function\\": \\"hello\\",
-> 12 |       \\"pattern\\": \\"^hello/?$\\",
-     |                  ^^^^^^^^^^^ 👈🏽  format pattern needs to be a regex that starts with ^ followed by / and ends with $ without any additional slashes before and afterwards
+     |                  ^^^^^^^^^^^^^^ 👈🏽  format pattern must be a regex that starts with ^ and ends with $ (e.g. ^/blog/[d]{4}$)
   13 |       \\"generator\\": \\"@netlify/fake-plugin@1.0.0\\"
   14 |     }
   15 |   ],"

packages/edge-bundler/node/validation/manifest/index.test.ts

@@ -1,5 +1,5 @@
 import chalk from 'chalk'
-import { test, expect, describe, beforeEach, vi } from 'vitest'
+import { test, expect, describe } from 'vitest'
 
 import { validateManifest, ManifestValidationError } from './index.js'
 
@@ -112,57 +112,32 @@ describe('bundle', () => {
 })
 
 describe('route', () => {
-  let freshValidateManifest: typeof validateManifest
-
-  beforeEach(async () => {
-    // reset all modules, to get a fresh AJV validator for FF changes
-    vi.resetModules()
-    const indexImport = await import('./index.js')
-    freshValidateManifest = indexImport.validateManifest
-  })
-
   test('should throw on additional property', () => {
     const manifest = getBaseManifest()
     manifest.routes[0].foo = 'bar'
 
-    expect(() => freshValidateManifest(manifest)).toThrowErrorMatchingSnapshot()
+    expect(() => validateManifest(manifest)).toThrowErrorMatchingSnapshot()
   })
 
   test('should throw on invalid pattern', () => {
     const manifest = getBaseManifest()
     manifest.routes[0].pattern = '/^/hello/?$/'
 
-    expect(() => freshValidateManifest(manifest)).toThrowErrorMatchingSnapshot()
-  })
-
-  test('should not throw on missing beginning slash without FF', () => {
-    const manifest = getBaseManifest()
-    manifest.routes[0].pattern = '^hello/?$'
-
-    expect(() => freshValidateManifest(manifest, { edge_functions_manifest_validate_slash: false })).not.toThrowError()
-  })
-
-  test('should throw on missing beginning slash with FF', () => {
-    const manifest = getBaseManifest()
-    manifest.routes[0].pattern = '^hello/?$'
-
-    expect(() =>
-      freshValidateManifest(manifest, { edge_functions_manifest_validate_slash: true }),
-    ).toThrowErrorMatchingSnapshot()
+    expect(() => validateManifest(manifest)).toThrowErrorMatchingSnapshot()
   })
 
   test('should throw on missing function', () => {
     const manifest = getBaseManifest()
     delete manifest.routes[0].function
 
-    expect(() => freshValidateManifest(manifest)).toThrowErrorMatchingSnapshot()
+    expect(() => validateManifest(manifest)).toThrowErrorMatchingSnapshot()
   })
 
   test('should throw on missing pattern', () => {
     const manifest = getBaseManifest()
     delete manifest.routes[0].pattern
 
-    expect(() => freshValidateManifest(manifest)).toThrowErrorMatchingSnapshot()
+    expect(() => validateManifest(manifest)).toThrowErrorMatchingSnapshot()
   })
 })
 

packages/edge-bundler/node/validation/manifest/index.ts

@@ -11,14 +11,14 @@ import edgeManifestSchema from './schema.js'
 
 let manifestValidator: ValidateFunction<Manifest>
 
-const initializeValidator = (featureFlags: FeatureFlags) => {
+const initializeValidator = () => {
   if (manifestValidator === undefined) {
     const ajv = new Ajv({ allErrors: true })
     ajvErrors(ajv)
 
     // regex pattern for manifest route pattern
     // checks if the pattern string starts with ^ and ends with $
-    const normalizedPatternRegex = featureFlags.edge_functions_manifest_validate_slash ? /^\^\/.*\$$/ : /^\^.*\$$/
+    const normalizedPatternRegex = /^\^.*\$$/
     ajv.addFormat('regexPattern', {
       validate: (data: string) => normalizedPatternRegex.test(data),
     })
@@ -30,8 +30,9 @@ const initializeValidator = (featureFlags: FeatureFlags) => {
 }
 
 // throws on validation error
-export const validateManifest = (manifestData: unknown, featureFlags: FeatureFlags = {}): void => {
-  const validate = initializeValidator(featureFlags)
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+export const validateManifest = (manifestData: unknown, _featureFlags: FeatureFlags = {}): void => {
+  const validate = initializeValidator()
 
   const valid = validate(manifestData)
 

packages/edge-bundler/node/validation/manifest/schema.ts

@@ -17,8 +17,7 @@ const routesSchema = {
     pattern: {
       type: 'string',
       format: 'regexPattern',
-      errorMessage:
-        'pattern needs to be a regex that starts with ^ followed by / and ends with $ without any additional slashes before and afterwards',
+      errorMessage: 'pattern must be a regex that starts with ^ and ends with $ (e.g. ^/blog/[d]{4}$)',
     },
     generator: { type: 'string' },
   },
@@ -35,7 +34,7 @@ const functionConfigSchema = {
         type: 'string',
         format: 'regexPattern',
         errorMessage:
-          'excluded_patterns needs to be an array of regex that starts with ^ followed by / and ends with $ without any additional slashes before and afterwards',
+          'excluded_patterns must be an array of regex that starts with ^ and ends with $ (e.g. ^/blog/[d]{4}$)',
       },
     },
     on_error: { type: 'string' },