Configure sentry for uploading and releasing during the publish webapp step

Author: ericallam

.github/workflows/publish-webapp.yml

@@ -86,3 +86,8 @@ jobs:
             BUILD_GIT_SHA=${{ steps.set_build_info.outputs.BUILD_GIT_SHA }}
             BUILD_GIT_REF_NAME=${{ steps.set_build_info.outputs.BUILD_GIT_REF_NAME }}
             BUILD_TIMESTAMP_SECONDS=${{ steps.set_build_info.outputs.BUILD_TIMESTAMP_SECONDS }}
+            SENTRY_RELEASE=${{ steps.set_build_info.outputs.BUILD_GIT_SHA }}
+            SENTRY_ORG=triggerdev
+            SENTRY_PROJECT=trigger-cloud
+          secrets: |
+            sentry_auth_token=${{ secrets.SENTRY_AUTH_TOKEN }}

apps/webapp/package.json

@@ -6,9 +6,9 @@
   "scripts": {
     "build": "run-s build:** && pnpm run upload:sourcemaps",
     "build:db:seed": "esbuild --platform=node --bundle --minify --format=cjs ./prisma/seed.ts --outdir=prisma",
-    "build:remix": "remix build",
+    "build:remix": "remix build --sourcemap",
     "build:server": "esbuild --platform=node --format=cjs ./server.ts --outdir=build --sourcemap",
-    "build:instrument": "esbuild --platform=node --format=cjs ./instrument.server.ts --outdir=build --sourcemap",
+    "build:sentry": "esbuild --platform=node --format=cjs ./sentry.server.ts --outdir=build --sourcemap",
     "dev": "cross-env PORT=3030 remix dev -c \"node ./build/server.js\"",
     "dev:worker": "cross-env NODE_PATH=../../node_modules/.pnpm/node_modules node ./build/server.js",
     "format": "prettier --write .",
@@ -217,6 +217,7 @@
     "@remix-run/testing": "^2.1.0",
     "@swc/core": "^1.3.4",
     "@swc/helpers": "^0.4.11",
+    "@sentry/cli": "2.50.2",
     "@tailwindcss/forms": "^0.5.3",
     "@tailwindcss/typography": "^0.5.9",
     "@total-typescript/ts-reset": "^0.4.2",
@@ -278,4 +279,4 @@
   "engines": {
     "node": ">=16.0.0"
   }
-}
+}

apps/webapp/instrument.server.ts renamed to apps/webapp/sentry.server.ts

@@ -20,7 +20,7 @@ if (process.env.SENTRY_DSN) {
     shutdownTimeout: 10,
 
     serverName: process.env.SERVICE_NAME,
-    environment: process.env.NODE_ENV,
+    environment: process.env.APP_ENV,
 
     integrations: [eventLoopBlockIntegration({ threshold: 1000 })],
   });

apps/webapp/server.ts

@@ -1,4 +1,4 @@
-import "./instrument.server";
+import "./sentry.server";
 
 import { createRequestHandler } from "@remix-run/express";
 import { broadcastDevReady, logDevReady } from "@remix-run/server-runtime";

apps/webapp/upload-sourcemaps.sh

@@ -1,7 +1,11 @@
 #!/bin/bash
-if [ -n "$SENTRY_ORG" ] && [ -n "$SENTRY_PROJECT" ] && [ -n "$SENTRY_AUTH_TOKEN" ]; then
-  sentry-upload-sourcemaps --org $SENTRY_ORG --project $SENTRY_PROJECT --buildPath ./build
+set -euo pipefail
+
+if [ -n "$SENTRY_ORG" ] && [ -n "$SENTRY_PROJECT" ] && [ -n "$SENTRY_AUTH_TOKEN" ] && [ -n "$SENTRY_RELEASE" ]; then
+  sentry-cli releases new $SENTRY_RELEASE
+  sentry-cli sourcemaps inject ./build
+  sentry-cli sourcemaps upload ./build --release $SENTRY_RELEASE
 else
   echo "Skipping sourcemap upload: Missing required environment variables"
-  echo "Required: SENTRY_ORG, SENTRY_PROJECT, SENTRY_AUTH_TOKEN"
+  echo "Required: SENTRY_ORG, SENTRY_PROJECT, SENTRY_AUTH_TOKEN, SENTRY_RELEASE"
 fi

docker/Dockerfile

@@ -42,10 +42,20 @@ RUN --mount=type=cache,id=pnpm,target=/root/.local/share/pnpm/store pnpx prisma@
 
 ## Builder (builds the webapp)
 FROM base AS builder
+RUN apt-get update && apt-get install -y openssl dumb-init ca-certificates
 WORKDIR /triggerdotdev
 # Corepack is used to install pnpm
 RUN corepack enable
 
+ARG SENTRY_RELEASE
+ARG SENTRY_ORG
+ARG SENTRY_PROJECT
+# Remove SENTRY_AUTH_TOKEN from build args since we'll use secrets
+ENV SENTRY_RELEASE=${SENTRY_RELEASE} \
+    SENTRY_ORG=${SENTRY_ORG} \
+    SENTRY_PROJECT=${SENTRY_PROJECT}
+# Remove SENTRY_AUTH_TOKEN from env vars since it will be mounted as secret
+
 # Goose and schemas
 COPY --from=goose_builder /go/bin/goose /usr/local/bin/goose
 RUN chmod +x /usr/local/bin/goose
@@ -60,7 +70,9 @@ RUN chmod +x ./scripts/entrypoint.sh
 COPY --chown=node:node .configs/tsconfig.base.json .configs/tsconfig.base.json
 COPY --chown=node:node scripts/updateVersion.ts scripts/updateVersion.ts
 RUN pnpm run generate
-RUN pnpm run build --filter=webapp...
+RUN --mount=type=secret,id=sentry_auth_token \
+    SENTRY_AUTH_TOKEN=$(cat /run/secrets/sentry_auth_token) \
+    pnpm run build --filter=webapp...
 
 # Runner
 FROM ${NODE_IMAGE} AS runner