[back-end] Add Glitchtip error tracking

apps/back-end/package.json

@@ -22,6 +22,7 @@
   },
   "dependencies": {
     "@fastify/cors": "^9.0.1",
+    "@immobiliarelabs/fastify-sentry": "^8.0.2",
     "@mykomap/common": "*",
     "@mykomap/node-utils": "*",
     "@seriousme/openapi-schema-validator": "^2.2.1",

apps/back-end/src/errors.ts

@@ -0,0 +1,7 @@
+export class HttpError extends Error {
+  statusCode: number;
+  constructor(statusCode: number, message: string) {
+    super(message);
+    this.statusCode = statusCode;
+  }
+}

apps/back-end/src/index.ts

@@ -1,3 +1,4 @@
+import fastifySentryPlugin from "@immobiliarelabs/fastify-sentry";
 import closeWithGrace from "close-with-grace";
 import Fastify from "fastify";
 import cors from "@fastify/cors";
@@ -35,6 +36,20 @@ export const start = async () => {
     querystringParser: (str) => qs.parse(str),
   });
 
+  // The Sentry error handler must be the first plugin registered
+  if (process.env.GLITCHTIP_KEY) {
+    console.log("Initialising Sentry...");
+    app.register(fastifySentryPlugin, {
+      dsn: `https://${process.env.GLITCHTIP_KEY}@app.glitchtip.com/9203`,
+      environment: process.env.NODE_ENV,
+      release: __BUILD_INFO__.version.join("."),
+      // Capture all uncaught or HTTP 4xx and 5xx errors
+      // Note this doesn't work for TsRestResponseErrors since they skip this middleware
+      shouldHandleError: (error) =>
+        !error.statusCode || error.statusCode >= 400,
+    });
+  }
+
   // This closes the application with a delay to clear up.
   closeWithGrace(
     { delay: closeGraceDelay },

apps/back-end/src/routes.ts

@@ -1,4 +1,3 @@
-import { TsRestResponseError } from "@ts-rest/core";
 import { RouterImplementation } from "@ts-rest/fastify";
 import { contract } from "@mykomap/common";
 import { FastifyPluginOptions } from "fastify";
@@ -11,6 +10,7 @@ import {
   initDatasets,
   searchDataset,
 } from "./services/datasetService.js";
+import { HttpError } from "./errors.js";
 
 /** Provides the shared configuration options for the Mykomap router implementation. */
 export interface MykomapRouterConfig extends FastifyPluginOptions {
@@ -92,10 +92,7 @@ export function MykomapRouter(
       // assume it is an Index.
       // TODO: extend this method to handle full IDs too
       if (!datasetItemIdOrIx.startsWith("@")) {
-        throw new TsRestResponseError(contract.getDatasetItem, {
-          status: 400,
-          body: { message: `We can only handle item indexes right now` },
-        });
+        throw new HttpError(400, `We can only handle item indexes right now`);
       }
 
       const itemIx = Number(datasetItemIdOrIx.substring(1));

apps/back-end/src/services/Dataset.ts

@@ -1,16 +1,15 @@
 import fs from "node:fs";
 import path from "node:path";
 import _ from "lodash";
-import { TsRestResponseError } from "@ts-rest/core";
 import { z } from "zod";
 
 import {
-  contract,
   PropDefs,
   PropDefsFactory,
   schemas,
   TextSearch,
 } from "@mykomap/common";
+import { HttpError } from "../errors.js";
 
 // Infer type from Zod schema
 type ConfigData = z.infer<typeof schemas.ConfigData>;
@@ -90,12 +89,10 @@ export class Dataset {
 
   getItem = (itemIx: number) => {
     if (!fs.existsSync(path.join(this.folderPath, "items", `${itemIx}.json`))) {
-      throw new TsRestResponseError(contract.getDatasetItem, {
-        status: 404,
-        body: {
-          message: `can't retrieve data for dataset ${this.id} item @${itemIx}`,
-        },
-      });
+      throw new HttpError(
+        404,
+        `Can't retrieve data for dataset ${this.id}, item index @${itemIx}`,
+      );
     }
 
     return JSON.parse(
@@ -135,12 +132,7 @@ export class Dataset {
 
         const propDef = this?.propDefs[propName];
         if (!propDef?.isFiltered())
-          throw new TsRestResponseError(contract.searchDataset, {
-            status: 400,
-            body: {
-              message: `Unknown propery name '${propName}'`,
-            },
-          });
+          throw new HttpError(400, `Unknown propery name '${propName}'`);
 
         const isMulti = propDef.type === "multi";
         const propMatcher = (value: string | string[]) => {
@@ -218,12 +210,7 @@ export class Dataset {
 
           for (const prop of returnProps) {
             if (item[prop] === undefined) {
-              throw new TsRestResponseError(contract.searchDataset, {
-                status: 400,
-                body: {
-                  message: `Unknown propery name '${prop}'`,
-                },
-              });
+              throw new HttpError(400, `Unknown propery name '${prop}'`);
             }
             strippedItem[prop] = item[prop];
           }

apps/back-end/src/services/datasetService.ts

@@ -1,13 +1,10 @@
 import fs from "node:fs";
 import path from "node:path";
-import {
-  AppRoute,
-  ServerInferResponseBody,
-  TsRestResponseError,
-} from "@ts-rest/core";
+import { AppRoute, ServerInferResponseBody } from "@ts-rest/core";
 
 import { contract } from "@mykomap/common";
 import { Dataset } from "./Dataset.js";
+import { HttpError } from "../errors.js";
 
 type GetConfigBody = ServerInferResponseBody<typeof contract.getConfig, 200>;
 type SearchDatasetBody = ServerInferResponseBody<
@@ -40,11 +37,7 @@ const getDatasetOrThrow404 = (
 ): Dataset => {
   const dataset = datasets[datasetId];
 
-  if (!dataset)
-    throw new TsRestResponseError(appRoute, {
-      status: 404,
-      body: { message: `dataset ${datasetId} doesn't exist` },
-    });
+  if (!dataset) throw new HttpError(404, `dataset ${datasetId} doesn't exist`);
 
   return dataset;
 };

apps/front-end/.env.example

@@ -1,3 +1,2 @@
 VITE_API_URL=replace-me
-VITE_GLITCHTIP_KEY=replace-me
 VITE_MAPTILER_API_KEY=replace-me

deploy.sh

@@ -21,7 +21,8 @@ set -vx
 #   - PROXY_PORT: the port number being proxied (e.g. '4000')
 #   - PROXY_PATH: the path being proxied (e.g. '/api')
 #   - BASE_URL_PATH # not actually used but might be in future?
-#   - GLITCHTIP_KEY
+#   - FE_GLITCHTIP_KEY
+#   - BE_GLITCHTIP_KEY
 #   - MAPTILER_API_KEY
 #   - DBUS_SESSION_BUS_ADDRESS: required for service management
 # - FIXME the user can write to DEPLOY_DEST, WWW_ROOT
@@ -84,7 +85,7 @@ cp .tool-versions "$DEPLOY_DEST"
   # FIXME these shouldn't be hardwired!
   cat >>.env <<EOF
 VITE_API_URL=/api
-VITE_GLITCHTIP_KEY=${GLITCHTIP_KEY:?}
+VITE_GLITCHTIP_KEY=${FE_GLITCHTIP_KEY:?}
 VITE_MAPTILER_API_KEY=${MAPTILER_API_KEY:?}
 EOF
 
@@ -105,6 +106,7 @@ EOF
   cat >>"$BE_DEST/.env" <<EOF
 SERVER_DATA_ROOT=$DATA_DEST
 FASTIFY_PORT=$PROXY_PORT
+GLITCHTIP_KEY=${BE_GLITCHTIP_KEY:?}
 #   root address?
 EOF
 

docs/deployment.md

@@ -76,7 +76,8 @@ values redacted:
     export PROXY_PORT=1$UID
     export PROXY_PATH=/api
     export DBUS_SESSION_BUS_ADDRESS=unix:path=/run/user/$UID/bus
-    export GLITCHTIP_KEY=*REDACTED*
+    export FE_GLITCHTIP_KEY=*REDACTED*
+    export BE_GLITCHTIP_KEY=*REDACTED*
     export MAPTILER_API_KEY=*REDACTED*
 
 *Note: paths here should be absolute - relative paths will not work in