test: add tests for netlify functions

.github/workflows/netlify-edge-functions-test.yml

@@ -0,0 +1,20 @@
+name: Run tests for netlify edge-functions
+
+on:
+  workflow_dispatch
+
+jobs:
+  netlify-tests:
+    strategy:
+      matrix:
+        deno-version: [1.30.0]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup Deno
+        uses: denolib/setup-deno@v2
+        with:
+          deno-version: ${{ matrix.deno-version }}
+      - name: Test with Deno
+        run: deno test --allow-env --trace-ops
+

netlify/edge-functions/serve-definitions.ts

@@ -1,4 +1,4 @@
-import type { Context } from "netlify:edge";
+import type { Context } from "https://edge-bootstrap.netlify.app/v1/index.ts";
 
 const GITHUB_TOKEN = Deno.env.get("GITHUB_TOKEN_NR");
 const NR_API_KEY = Deno.env.get("NR_API_KEY");
@@ -69,7 +69,9 @@ export default async (request: Request, context: Context) => {
 
 function buildRewrite(originalRequest: Request): (Request | null) {
   const extractResult = legitimateRequestRegex.exec(new URL(originalRequest.url).pathname);
-  if (extractResult === null) {
+
+  // No need to rewrite the request if it's not a legitimate request for a definition file
+  if (extractResult === null || extractResult.length < 2 || !extractResult[2]) {
     return null;
   }
 

netlify/edge-functions/tests/serve-definitions.test.ts

@@ -0,0 +1,105 @@
+import serveDefinitions from "../serve-definitions.ts";
+import { Context } from "https://edge-bootstrap.netlify.app/v1/index.ts";
+import * as mf from "https://deno.land/x/[email protected]/mod.ts";
+import { assertEquals } from "https://deno.land/[email protected]/assert/assert_equals.ts";
+
+const metricURL = "https://metric-api.eu.newrelic.com/metric/v1";
+
+const validRequests = [
+  {
+    requestURL: "https://asyncapi.com/definitions/2.4.0/info.json",
+    responseURL:
+      "https://raw.githubusercontent.com/asyncapi/spec-json-schemas/master/definitions/2.4.0/info.json",
+  },
+  {
+    requestURL: "https://asyncapi.com/schema-store/2.5.0-without-$id.json",
+    responseURL:
+      "https://raw.githubusercontent.com/asyncapi/spec-json-schemas/master/schemas/2.5.0-without-$id.json",
+  },
+];
+
+const invalidRequests = [
+  {
+    requestURL: "https://asyncapi.com/definitions/asyncapi.yaml",
+  },
+  {
+    requestURL: "https://asyncapi.com/schema-store/2.4.0.JSON",
+  },
+  {
+    requestURL: "https://asyncapi.com/foobar",
+  }
+];
+
+const context = {
+  next: () => {},
+  log: () => {},
+};
+
+let metricCalls = 0;
+
+function setup() {
+  mf.install();
+
+  mf.mock("*", (req) => {
+    console.log(req.url);
+
+    if( req.url === metricURL ) {
+      metricCalls++;
+    }
+
+    const body = {
+      url: req.url,
+      method: req.method,
+      headers: req.headers,
+    };
+
+    return new Response(JSON.stringify(body), {
+      status: 200,
+      headers: {
+        "Content-Type": "application/json",
+      },
+    });
+  });
+}
+
+Deno.test("serve-definitions test for validRequests", async () => {
+  metricCalls = 0;
+
+  setup();
+
+  for (const entry of validRequests) {
+    console.log("Testing: " + entry.requestURL);
+
+    const request = new Request(entry.requestURL, { method: "GET" });
+    const response = await serveDefinitions(request, context as Context);
+    const body = await response.json();
+
+    assertEquals(response.status, 200);
+    assertEquals(body.url, entry.responseURL);
+
+    console.log("\n");
+  }
+
+  assertEquals(metricCalls, validRequests.length);
+
+  mf.uninstall();
+});
+
+Deno.test("serve-definitions test for invalidRequests", async () => {
+  metricCalls = 0;
+
+  setup();
+
+  for (const entry of invalidRequests) {
+    console.log("Testing: " + entry.requestURL);
+    const request = new Request(entry.requestURL, { method: "GET" });
+    const response = await serveDefinitions(request, context as Context);
+
+    assertEquals(response, undefined);    
+  }
+
+  // No metrics should be sent for invalid requests
+  assertEquals(metricCalls, 0);
+
+  mf.uninstall();
+});

package.json

@@ -15,6 +15,7 @@
     "generate:videos": "node scripts/build-newsroom-videos.js",
     "generate:tools": "node scripts/build-tools.js",
     "test": "npx cypress run --component",
+    "test:netlify": "deno test --allow-env --trace-ops",
     "cy:open": "cypress open",
     "cy:run": "cypress run"
   },