feat: move EF validation logic to edge-bundler

Author: danez

package-lock.json

@@ -73,8 +73,6 @@
     "@netlify/run-utils": "^5.0.2",
     "@netlify/zip-it-and-ship-it": "^7.1.2",
     "@sindresorhus/slugify": "^2.0.0",
-    "ajv": "^8.11.0",
-    "ajv-errors": "^3.0.0",
     "ansi-escapes": "^5.0.0",
     "chalk": "^5.0.0",
     "clean-stack": "^4.0.0",

packages/build/package.json

@@ -0,0 +1,32 @@
+import { promises as fs } from 'fs'
+import { join, resolve } from 'path'
+
+import { ManifestValidationError, validateManifest } from '@netlify/edge-bundler'
+
+import { addErrorInfo } from '../../../error/info.js'
+
+export const validateEdgeFunctionsManifest = async function ({
+  buildDir,
+  constants: { EDGE_FUNCTIONS_DIST: distDirectory },
+}: {
+  buildDir: string
+  constants: { EDGE_FUNCTIONS_DIST: string }
+}) {
+  const edgeFunctionsDistPath = resolve(buildDir, distDirectory)
+  const manifestPath = join(edgeFunctionsDistPath, 'manifest.json')
+  const data = await fs.readFile(manifestPath)
+  // @ts-expect-error TypeScript is not aware that parse can handle Buffer
+  const manifestData = JSON.parse(data)
+
+  try {
+    validateManifest(manifestData)
+  } catch (error) {
+    if (error instanceof ManifestValidationError) {
+      addErrorInfo(error, { type: 'coreStep' })
+    }
+
+    throw error
+  }
+
+  return {}
+}

packages/build/src/plugins_core/edge_functions/validate_manifest/validate_edge_functions_manifest.js

@@ -4,83 +4,22 @@ The actual snapshot is saved in `tests.js.snap`.
 
 Generated by [AVA](https://avajs.dev).
 
-## should detect invalid route pattern in manifest
+## should print error on invalid manifest
 
 > Snapshot 1
 
-    `[␊
-      {␊
-        "instancePath": "/routes/2/pattern",␊
-        "schemaPath": "#/properties/routes/items/properties/pattern/errorMessage",␊
-        "keyword": "errorMessage",␊
-        "params": {␊
-          "errors": [␊
-            {␊
-              "instancePath": "/routes/2/pattern",␊
-              "schemaPath": "#/properties/routes/items/properties/pattern/format",␊
-              "keyword": "format",␊
-              "params": {␊
-                "format": "regexPattern"␊
-              },␊
-              "message": "must match format \\"regexPattern\\"",␊
-              "emUsed": true␊
-            }␊
-          ]␊
-        },␊
-        "message": "must match format /^\\\\^.*\\\\$$/"␊
-      }␊
-    ]`
+    `Validation of Edge Functions manifest failed␊
+    TYPE must be object␊
+    ␊
+    > 1 | "json"␊
+        | ^^^^^^ 👈🏽  type must be object`
 
-## should detect missing property in manifest
+## should print error on empty manifest
 
 > Snapshot 1
 
-    `[␊
-      {␊
-        "instancePath": "",␊
-        "schemaPath": "#/errorMessage",␊
-        "keyword": "errorMessage",␊
-        "params": {␊
-          "errors": [␊
-            {␊
-              "instancePath": "/bundles/0",␊
-              "schemaPath": "#/properties/bundles/items/required",␊
-              "keyword": "required",␊
-              "params": {␊
-                "missingProperty": "format"␊
-              },␊
-              "message": "must have required property 'format'",␊
-              "emUsed": true␊
-            }␊
-          ]␊
-        },␊
-        "message": "Couldn't validate Edge Functions manifest.json"␊
-      }␊
-    ]`
-
-## should detect extra property in manifest
-
-> Snapshot 1
-
-    `[␊
-      {␊
-        "instancePath": "",␊
-        "schemaPath": "#/errorMessage",␊
-        "keyword": "errorMessage",␊
-        "params": {␊
-          "errors": [␊
-            {␊
-              "instancePath": "/routes/0",␊
-              "schemaPath": "#/properties/routes/items/additionalProperties",␊
-              "keyword": "additionalProperties",␊
-              "params": {␊
-                "additionalProperty": "extra"␊
-              },␊
-              "message": "must NOT have additional properties",␊
-              "emUsed": true␊
-            }␊
-          ]␊
-        },␊
-        "message": "Couldn't validate Edge Functions manifest.json"␊
-      }␊
-    ]`
+    `Validation of Edge Functions manifest failed␊
+    REQUIRED must have required property 'bundler_version'␊
+    ␊
+    > 1 | {}␊
+        | ^ ☹️  bundler_version is missing here!`

packages/build/src/plugins_core/edge_functions/validate_manifest/validate_edge_functions_manifest.ts

@@ -15,33 +15,22 @@ test('should validate valid manifest', async (t) => {
   )
 })
 
-test('should detect invalid route pattern in manifest', async (t) => {
+test('should print error on invalid manifest', async (t) => {
   const error = await t.throwsAsync(
     validateEdgeFunctionsManifest({
       buildDir: FIXTURES_DIR,
-      constants: { EDGE_FUNCTIONS_DIST: 'invalid_manifest_wrong_route_pattern' },
+      constants: { EDGE_FUNCTIONS_DIST: 'invalid_manifest' },
     }),
   )
 
   t.snapshot(error.message)
 })
 
-test('should detect missing property in manifest', async (t) => {
+test('should print error on empty manifest', async (t) => {
   const error = await t.throwsAsync(
     validateEdgeFunctionsManifest({
       buildDir: FIXTURES_DIR,
-      constants: { EDGE_FUNCTIONS_DIST: 'invalid_manifest_missing_property' },
-    }),
-  )
-
-  t.snapshot(error.message)
-})
-
-test('should detect extra property in manifest', async (t) => {
-  const error = await t.throwsAsync(
-    validateEdgeFunctionsManifest({
-      buildDir: FIXTURES_DIR,
-      constants: { EDGE_FUNCTIONS_DIST: 'invalid_manifest_extra_property' },
+      constants: { EDGE_FUNCTIONS_DIST: 'empty_manifest' },
     }),
   )
 

packages/build/tests/unit/validate_edge_manifest/snapshots/tests.js.md

@@ -0,0 +1,3 @@
+{
+  "bundler_version": 123
+}

packages/build/tests/unit/validate_edge_manifest/snapshots/tests.js.snap

@@ -0,0 +1 @@
+"json"