feat: serve AsyncAPI JSON Schema definitions

README.md

@@ -65,6 +65,14 @@ npm run build
 
 Generated files of the website go to the `.next` folder.
 
+## JSON Schema definitions
+
+All AsyncAPI JSON Schema definition files are being served within the `/definitions/<file>` path. The content is being served from GH, in particular from https://github.com/asyncapi/spec-json-schemas/tree/master/schemas.
+This is possible thanks to the following:
+
+1. A [Netlify Rewrite rule](https://docs.netlify.com/routing/redirects/rewrites-proxies/) located in the [netlify.toml](netlify.toml) file, which acts as proxy for all requests to the `/definitions/<file>` path, serving the content from GH without having an HTTP redirect.
+2. A [Netlify Edge Function](https://docs.netlify.com/netlify-labs/experimental-features/edge-functions/) that modifies the `Content-Type` header of the rewrite response to become `application/schema+json`. This lets tooling, such as [Hyperjump](https://json-schema.hyperjump.io), to fetch the schemas directly from their URL.
+
 ## Project structure
 
 This repository has the following structure:
@@ -85,6 +93,8 @@ This repository has the following structure:
   ├── public                      # Data for site metadata and static blog such as images
   ├── scripts                     # Scripts used in the build and dev processes
   ├── next.config.js              # Next.js configuration file
+  ├── netlify                     # Code that runs on Netlify
+  │    ├── edge-functions         # Netlify Edge-Functions code
   ├── postcss.config.js           # PostCSS configuration file
   └── tailwind.config.js          # TailwindCSS configuration file
 ```

netlify.toml

@@ -7,4 +7,34 @@
   command = "npm run build && npm run export"
   functions = "netlify/functions"
   publish = "out"
-
+
+# Used by JSON Schema definitions fetched directly from AsyncAPI website
+[[redirects]]
+  from = "/definitions"
+  to = "https://github.com/asyncapi/spec-json-schemas/tree/master/schemas"
+  status = 200
+
+[[redirects]]
+  from = "/definitions/*"
+  to = "https://raw.githubusercontent.com/asyncapi/spec-json-schemas/master/schemas/:splat"
+  status = 200
+
+[[edge_functions]]
+function = "serve-definitions"
+path = "/definitions/*"
+
+# Used by JSON Schema definitions fetched from schemastore.org
+[[redirects]]
+  from = "/schema-store"
+  to = "https://github.com/asyncapi/spec-json-schemas/tree/master/schemas"
+  status = 200
+
+[[redirects]]
+  from = "/schema-store/*"
+  to = "https://raw.githubusercontent.com/asyncapi/spec-json-schemas/master/schemas/:splat"
+  status = 200
+
+[[edge_functions]]
+function = "serve-definitions"
+path = "/schema-store/*"
+

netlify/edge-functions/serve-definitions.ts

@@ -0,0 +1,123 @@
+import type { Context } from "netlify:edge";
+
+const GITHUB_TOKEN = Deno.env.get("GITHUB_TOKEN_NR");
+const NR_API_KEY = Deno.env.get("NR_API_KEY");
+const NR_METRICS_ENDPOINT = Deno.env.get("NR_METRICS_ENDPOINT") || "https://metric-api.eu.newrelic.com/metric/v1";
+
+export default async (request: Request, context: Context) => {
+  // Deleting Origin header, which is involved in the cache policy, so requests can hit GH cache.
+  // Reason: raw.githubusercontent.com responses include vary: Authorization,Accept-Encoding,Origin
+  request.headers.delete("origin");
+
+  // Setting GH Token to increase GH rate limit to 5,000 req/h.
+  request.headers.set("Authorization", "token " + GITHUB_TOKEN);
+
+  // Fetching the definition file
+  const response = await context.next();
+
+  const isRequestingAFile = request.url.charAt(request.url.length - 1) !== "/";
+  if (isRequestingAFile) {
+    if (response.ok) {
+      // Setting proper Content-Type header for JSON Schema files.
+      // This lets tooling fetch the schemas directly from their URL.
+      response.headers.set("Content-Type", "application/schema+json");
+
+      // Sending metrics to NR.
+      const metric = newNRMetricCount("asyncapi.jsonschema.download.success", request)
+
+      await sendMetricToNR(context, metric);
+    } else {
+      // Notifying NR of the error.
+      const attributes = {
+        "responseStatus": response.status,
+        "responseStatusText": response.statusText,
+      };
+      const metric = newNRMetricCount("asyncapi.jsonschema.download.error", request, attributes);
+
+      await sendMetricToNR(context, metric);
+    }
+  }
+
+  return response;
+};
+
+interface TimeoutRequestInit extends RequestInit {
+  timeout: number;
+}
+
+async function doFetch(resource: string, options: TimeoutRequestInit): Promise<Response> {
+  const { timeout = 5000 } = options;
+
+  const controller = new AbortController();
+  const timeoutId = setTimeout(() => controller.abort(), timeout);
+  const response = await fetch(resource, { ...options, signal: controller.signal });
+  clearTimeout(timeoutId);
+  return response;
+}
+
+async function sendMetricToNR(context: Context, metric: NRMetric) {
+  const metrics = [{ "metrics": [metric] }];
+
+  console.log(JSON.stringify(metrics));
+  try {
+    const rawResponse = await doFetch(NR_METRICS_ENDPOINT, {
+      timeout: 2000, // Success in 2 seconds, cancel if not. User's request is more important than collecting metrics.
+      method: 'POST',
+      headers: {
+        'Api-Key': NR_API_KEY || "",
+        'Content-Type': 'application/json'
+      },
+      body: JSON.stringify(metrics)
+    });
+
+    if (!rawResponse.ok) {
+      context.log(`Unexpected response status code when sending metrics: ${rawResponse.status} ${rawResponse.statusText}`);
+    }
+  } catch (e) {
+    if (e instanceof DOMException) {
+      context.log(`Timeout during sending metrics: ${e}`);
+    } else {
+      context.log(`Unexpected error sending metrics: ${e}`);
+    }
+  }
+}
+
+function newNRMetricCount(name: string, request: Request, attributes: any = {}): NRMetric {
+  var metric = new NRMetric(name, NRMetricType.Count, 1);
+  metric["interval.ms"] = 1;
+
+  const splitPath = new URL(request.url).pathname.split("/");
+
+  metric.attributes = {
+    "source": splitPath[1],
+    "file": splitPath[2],
+    "url": request.url,
+    ...attributes,
+  };
+
+  return metric;
+}
+
+enum NRMetricType {
+  Count = "count",
+  Distribution = "distribution",
+  Gauge = "gauge",
+  Summary = "summary",
+  UniqueCount = "uniqueCount",
+}
+
+class NRMetric {
+  name: string;
+  value: number | any;
+  timestamp: number;
+  "interval.ms": number;
+  type: NRMetricType;
+  attributes: any;
+
+  constructor(name: string, type = NRMetricType.Count, value = 1, timestamp = Date.now()) {
+    this.name = name;
+    this.type = type;
+    this.value = value;
+    this.timestamp = timestamp;
+  }
+}