Add sentry error tracking

.github/workflows/test.yml

@@ -29,6 +29,9 @@ jobs:
         run: deno lint
 
       - name: Run tests
+        env:
+          DOPPLER_ENVIRONMENT: gitlab_ci
+          KEYS_VERSION: gitlab_ci
         run: |
           deno test --coverage=coverage
           deno coverage ./coverage --lcov --output=coverage.lcov

Dockerfile

@@ -15,4 +15,4 @@ ADD . .
 # Compile the main app so that it doesn't need to be compiled each startup/entry.
 RUN deno cache main.ts
 
-CMD ["run", "--allow-net", "--allow-env", "main.ts"]
+CMD ["run", "--allow-net", "--allow-env", "--allow-read=./src", "main.ts"]

README.md

@@ -29,7 +29,7 @@ curl "https://keys.demery.net/api?allOf=demery&allOf=thunderbird&noneOf=disabled
 ### Running locally
 
 ```sh
-deno run --allow-net --allow-env main.ts
+doppler run -- deno run --allow-net --allow-env --allow-read=./src main.ts
 ```
 
 ### Run tests

deps.ts

@@ -1,2 +1,3 @@
 export { z } from "https://deno.land/x/[email protected]/mod.ts";
 export { ZodError } from "https://deno.land/x/[email protected]/ZodError.ts";
+export * as Sentry from "https://deno.land/x/[email protected]/index.mjs";

flake.nix

@@ -20,6 +20,7 @@
             nativeBuildInputs = [ pkgs.bashInteractive ];
             buildInputs = with pkgs; [
               deno
+              doppler
             ];
           };
         });

helm/templates/deployment.yaml

@@ -28,7 +28,7 @@ spec:
             - name: http-web
               containerPort: 8000
           env:
-            - name: VERSION
+            - name: KEYS_VERSION
               value: {{ .Values.version | quote }}
           envFrom:
             - secretRef:

main.ts

@@ -2,11 +2,25 @@ import start from "./src/server.ts";
 import keys from "./src/public_keys.ts";
 import { filterIncludesKey, parseParameters } from "./src/filter.ts";
 import { parseEnvironmentVariables } from "./src/environment.ts";
+import { Sentry } from "./deps.ts";
 
 const environment = parseEnvironmentVariables(Deno.env.toObject());
 
-start(environment.PORT, {
-  filterIncludesKey,
-  parseParameters,
-  keys,
-});
+if (environment.SENTRY_DSN) {
+  Sentry.init({
+    dsn: environment.SENTRY_DSN,
+    environment: environment.DOPPLER_ENVIRONMENT,
+    tracesSampleRate: 1.0,
+    release: environment.KEYS_VERSION,
+  });
+}
+
+start(
+  environment.PORT,
+  {
+    filterIncludesKey,
+    parseParameters,
+    keys,
+  },
+  environment.KEYS_VERSION,
+);

src/environment.test.ts

@@ -5,28 +5,43 @@ import {
 import { parseEnvironmentVariables } from "./environment.ts";
 import { ZodError } from "../deps.ts";
 
+const baseVariables = {
+  DOPPLER_ENVIRONMENT: "unit_tests",
+  KEYS_VERSION: "unit_tests",
+};
+
 Deno.test(
   "parseEnvironmentVariables: must convert string variables to correct types",
   () => {
     const variables = {
+      ...baseVariables,
       PORT: "1234",
     };
 
-    assertEquals(parseEnvironmentVariables(variables), { PORT: 1234 });
+    assertEquals(parseEnvironmentVariables(variables), {
+      ...baseVariables,
+      PORT: 1234,
+    });
   },
 );
 Deno.test(
   "parseEnvironmentVariables: must use defaults if variables are not supplied",
   () => {
-    const variables = {};
+    const variables = {
+      ...baseVariables,
+    };
 
-    assertEquals(parseEnvironmentVariables(variables), { PORT: 8000 });
+    assertEquals(parseEnvironmentVariables(variables), {
+      ...baseVariables,
+      PORT: 8000,
+    });
   },
 );
 Deno.test(
   "parseEnvironmentVariables: must throw ZodError if input is invalid",
   () => {
     const variables = {
+      ...baseVariables,
       PORT: "not-a-number",
     };
 

src/environment.ts

@@ -2,6 +2,9 @@ import { z } from "../deps.ts";
 
 const environmentSchema = z.object({
   PORT: z.string().regex(/^\d+$/).transform(Number).default("8000"),
+  DOPPLER_ENVIRONMENT: z.string(),
+  SENTRY_DSN: z.string().optional(),
+  KEYS_VERSION: z.string(),
 });
 
 export function parseEnvironmentVariables(variableObject: unknown) {

src/server.test.ts

@@ -40,6 +40,7 @@ Deno.test(
     const response = await handleRequest(
       new Request(`${TEST_URL}/not_found`),
       emptyDependencies,
+      "unit_tests",
     );
 
     assertEquals(response.status, 404);
@@ -51,6 +52,7 @@ Deno.test("handleRequest: must return pgp key for /pgp", async () => {
   const response = await handleRequest(
     new Request(`${TEST_URL}/pgp`),
     emptyDependencies,
+    "unit_tests",
   );
 
   assertEquals(response.status, 200);
@@ -67,6 +69,7 @@ Deno.test(
     const response = await handleRequest(
       new Request(`${TEST_URL}/pgp/daniel_emery.pub.asc`),
       emptyDependencies,
+      "unit_tests",
     );
 
     assertEquals(response.status, 200);
@@ -94,7 +97,7 @@ Deno.test(
       parseParameters: parseParametersSpy,
       filterIncludesKey: filterIncludesKeySpy,
       keys: fakeKeys,
-    });
+    }, "unit_tests");
 
     assertSpyCalls(parseParametersSpy, 1);
     assertSpyCall(parseParametersSpy, 0, {
@@ -127,7 +130,7 @@ Deno.test(
       parseParameters: parseParametersStub,
       filterIncludesKey: filterIncludesKeyStub,
       keys: fakeKeys,
-    });
+    }, "unit_tests");
 
     assertSpyCalls(parseParametersStub, 1);
     assertSpyCall(parseParametersStub, 0, {

src/server.ts

@@ -19,15 +19,23 @@
  * parameters.
  * @param port The port to listen on.
  */
-export default function start(port: number, dependencies: ServerDependencies) {
+export default function start(
+  port: number,
+  dependencies: ServerDependencies,
+  version: string,
+) {
   console.log(`Server listening at :${port}/api`);
   Deno.serve({
     port,
-    handler: (req) => handleRequest(req, dependencies),
+    handler: (req) => handleRequest(req, dependencies, version),
   });
 }
 
-export function handleRequest(req: Request, dependencies: ServerDependencies) {
+export function handleRequest(
+  req: Request,
+  dependencies: ServerDependencies,
+  version: string,
+) {
   const { filterIncludesKey, parseParameters, keys } = dependencies;
   try {
     const url = new URL(req.url);
@@ -72,6 +80,9 @@
     return new Response(responseData, {
       status: STATUS_CODE.OK,
       statusText: STATUS_TEXT[STATUS_CODE.OK],
+      headers: {
+        "X-Keys-Version": version,
+      },
     });
   } catch (err) {
     console.error(err);