wip on cleanup

Author: brendan-kellam

.github/workflows/fly-deploy-staging.yml

@@ -79,8 +79,8 @@ jobs:
           platforms: ${{ matrix.platform }}
           outputs: type=image,name=${{ env.REGISTRY_IMAGE }},push-by-digest=true,name-canonical=true,push=true
           build-args: |
-            SOURCEBOT_VERSION=${{ github.ref_name }}
-            POSTHOG_PAPIK=${{ secrets.POSTHOG_PAPIK }}
+            NEXT_PUBLIC_SOURCEBOT_VERSION=${{ github.ref_name }}
+            NEXT_PUBLIC_POSTHOG_PAPIK=${{ secrets.POSTHOG_PAPIK }}
             
       - name: Export digest
         run: |

.github/workflows/fly-deploy.yml

@@ -69,9 +69,12 @@ jobs:
           platforms: ${{ matrix.platform }}
           outputs: type=image,name=${{ env.REGISTRY_IMAGE }},push-by-digest=true,name-canonical=true,push=true
           build-args: |
-            SOURCEBOT_VERSION=${{ github.ref_name }}
-            POSTHOG_PAPIK=${{ secrets.POSTHOG_PAPIK }}
+            NEXT_PUBLIC_SOURCEBOT_VERSION=${{ github.ref_name }}
+            NEXT_PUBLIC_POSTHOG_PAPIK=${{ secrets.POSTHOG_PAPIK }}
             NEXT_PUBLIC_SOURCEBOT_CLOUD_ENVIRONMENT=staging
+            NEXT_PUBLIC_SENTRY_ENVIRONMENT=staging
+            NEXT_PUBLIC_SENTRY_WEBAPP_DSN=${{ secrets.SENTRY_WEBAPP_DSN }}
+            NEXT_PUBLIC_SENTRY_BACKEND_DSN=${{ secrets.SENTRY_BACKEND_DSN }}
 
       - name: Export digest
         run: |

.github/workflows/ghcr-publish.yml

@@ -1,15 +1,22 @@
 # ------ Global scope variables ------
+
 # Set of global build arguments.
+# These are considered "public" and will be baked into the image.
+# The convention is to prefix these with `NEXT_PUBLIC_` so that
+# they can be optionally be passed as client-side environment variables
+# in the webapp.
 # @see: https://docs.docker.com/build/building/variables/#scoping
 
-ARG SOURCEBOT_VERSION
+ARG NEXT_PUBLIC_SOURCEBOT_VERSION
 # PAPIK = Project API Key
 # Note that this key does not need to be kept secret, so it's not
 # necessary to use Docker build secrets here.
 # @see: https://posthog.com/tutorials/api-capture-events#authenticating-with-the-project-api-key
-ARG POSTHOG_PAPIK
-ARG SENTRY_ENVIRONMENT
-ARG SOURCEBOT_CLOUD_ENVIRONMENT
+ARG NEXT_PUBLIC_POSTHOG_PAPIK
+ARG NEXT_PUBLIC_SENTRY_ENVIRONMENT
+ARG NEXT_PUBLIC_SOURCEBOT_CLOUD_ENVIRONMENT
+ARG NEXT_PUBLIC_SENTRY_WEBAPP_DSN
+ARG NEXT_PUBLIC_SENTRY_BACKEND_DSN
 
 FROM node:20-alpine3.19 AS node-alpine
 FROM golang:1.23.4-alpine3.19 AS go-alpine
@@ -46,16 +53,14 @@ RUN yarn workspace @sourcebot/error install
 FROM node-alpine AS web-builder
 ENV SKIP_ENV_VALIDATION=1
 # -----------
-# Global args
-ARG SOURCEBOT_VERSION
-ENV NEXT_PUBLIC_SOURCEBOT_VERSION=$SOURCEBOT_VERSION
-ARG POSTHOG_PAPIK
-ENV NEXT_PUBLIC_POSTHOG_PAPIK=$POSTHOG_PAPIK
-ARG SENTRY_ENVIRONMENT
-ENV NEXT_PUBLIC_SENTRY_ENVIRONMENT=$SENTRY_ENVIRONMENT
-ARG SOURCEBOT_CLOUD_ENVIRONMENT
-ENV NEXT_PUBLIC_SOURCEBOT_CLOUD_ENVIRONMENT=$SOURCEBOT_CLOUD_ENVIRONMENT
-# Local args
+ARG NEXT_PUBLIC_SOURCEBOT_VERSION
+ENV NEXT_PUBLIC_SOURCEBOT_VERSION=$NEXT_PUBLIC_SOURCEBOT_VERSION
+ARG NEXT_PUBLIC_POSTHOG_PAPIK
+ENV NEXT_PUBLIC_POSTHOG_PAPIK=$NEXT_PUBLIC_POSTHOG_PAPIK
+ARG NEXT_PUBLIC_SENTRY_ENVIRONMENT
+ENV NEXT_PUBLIC_SENTRY_ENVIRONMENT=$NEXT_PUBLIC_SENTRY_ENVIRONMENT
+ARG NEXT_PUBLIC_SOURCEBOT_CLOUD_ENVIRONMENT
+ENV NEXT_PUBLIC_SOURCEBOT_CLOUD_ENVIRONMENT=$NEXT_PUBLIC_SOURCEBOT_CLOUD_ENVIRONMENT
 ARG NEXT_PUBLIC_SENTRY_WEBAPP_DSN
 ENV NEXT_PUBLIC_SENTRY_WEBAPP_DSN=$NEXT_PUBLIC_SENTRY_WEBAPP_DSN
 # -----------
@@ -102,17 +107,19 @@ ENV SKIP_ENV_VALIDATION=0
 # ------ Runner ------
 FROM node-alpine AS runner
 # -----------
-# Global args
-ARG SOURCEBOT_VERSION
-ENV SOURCEBOT_VERSION=$SOURCEBOT_VERSION
-ARG POSTHOG_PAPIK
-ENV POSTHOG_PAPIK=$POSTHOG_PAPIK
-ARG SENTRY_ENVIRONMENT
-ENV SENTRY_ENVIRONMENT=$SENTRY_ENVIRONMENT
-# Local args
+ARG NEXT_PUBLIC_SOURCEBOT_VERSION
+ENV NEXT_PUBLIC_SOURCEBOT_VERSION=$NEXT_PUBLIC_SOURCEBOT_VERSION
+ARG NEXT_PUBLIC_POSTHOG_PAPIK
+ENV NEXT_PUBLIC_POSTHOG_PAPIK=$NEXT_PUBLIC_POSTHOG_PAPIK
+ARG NEXT_PUBLIC_SENTRY_ENVIRONMENT
+ENV NEXT_PUBLIC_SENTRY_ENVIRONMENT=$NEXT_PUBLIC_SENTRY_ENVIRONMENT
+ARG NEXT_PUBLIC_SENTRY_WEBAPP_DSN
+ENV NEXT_PUBLIC_SENTRY_WEBAPP_DSN=$NEXT_PUBLIC_SENTRY_WEBAPP_DSN
+ARG NEXT_PUBLIC_SENTRY_BACKEND_DSN
+ENV NEXT_PUBLIC_SENTRY_BACKEND_DSN=$NEXT_PUBLIC_SENTRY_BACKEND_DSN
 # -----------
 
-RUN echo "Sourcebot Version: $SOURCEBOT_VERSION"
+RUN echo "Sourcebot Version: $NEXT_PUBLIC_SOURCEBOT_VERSION"
 
 WORKDIR /app
 ENV NODE_ENV=production
@@ -172,17 +179,6 @@ COPY --from=shared-libs-builder /app/packages/error ./packages/error
 
 # Configure dependencies
 RUN apk add --no-cache git ca-certificates bind-tools tini jansson wget supervisor uuidgen curl perl jq redis postgresql postgresql-contrib openssl util-linux unzip
-RUN curl -sL https://sentry.io/get-cli/ | sh
-
-# Install grafana alloy. libc6-compat is required because alloy dynamically links against glibc which doesn't exist in alpine by default
-# @nocheckin: figure out how to handle this for self hosted case (especially the config)
-RUN apk add --no-cache libc6-compat 
-RUN wget https://github.com/grafana/alloy/releases/download/v1.7.0/alloy-linux-amd64.zip \
-    && unzip alloy-linux-amd64.zip \
-    && mv alloy-linux-amd64 /usr/local/bin/alloy \
-    && chmod +x /usr/local/bin/alloy \
-    && rm alloy-linux-amd64.zip
-COPY grafana.alloy .
 
 # Configure the database
 RUN mkdir -p /run/postgresql && \

.github/workflows/staging-ghcr-public.yml

@@ -1,11 +1,11 @@
 #!/bin/sh
 set -e
 
-echo -e "\e[34m[Info] Sourcebot version: $SOURCEBOT_VERSION\e[0m"
+echo -e "\e[34m[Info] Sourcebot version: $NEXT_PUBLIC_SOURCEBOT_VERSION\e[0m"
 
 # If we don't have a PostHog key, then we need to disable telemetry.
-if [ -z "$POSTHOG_PAPIK" ]; then
-    echo -e "\e[33m[Warning] POSTHOG_PAPIK was not set. Setting SOURCEBOT_TELEMETRY_DISABLED.\e[0m"
+if [ -z "$NEXT_PUBLIC_POSTHOG_PAPIK" ]; then
+    echo -e "\e[33m[Warning] NEXT_PUBLIC_POSTHOG_PAPIK was not set. Setting SOURCEBOT_TELEMETRY_DISABLED.\e[0m"
     export SOURCEBOT_TELEMETRY_DISABLED=true
 fi
 
@@ -81,7 +81,7 @@ fi
 
 # In order to detect if this is the first run, we create a `.installed` file in
 # the cache directory.
-FIRST_RUN_FILE="$DATA_CACHE_DIR/.installedv2"
+FIRST_RUN_FILE="$DATA_CACHE_DIR/.installedv3"
 
 if [ ! -f "$FIRST_RUN_FILE" ]; then
     touch "$FIRST_RUN_FILE"
@@ -91,11 +91,11 @@ if [ ! -f "$FIRST_RUN_FILE" ]; then
     # (if telemetry is enabled)
     if [ "$SOURCEBOT_TELEMETRY_DISABLED" = "false" ]; then
         if ! ( curl -L --output /dev/null --silent --fail --header "Content-Type: application/json" -d '{
-            "api_key": "'"$POSTHOG_PAPIK"'",
+            "api_key": "'"$NEXT_PUBLIC_POSTHOG_PAPIK"'",
             "event": "install",
             "distinct_id": "'"$SOURCEBOT_INSTALL_ID"'",
             "properties": {
-                "sourcebot_version": "'"$SOURCEBOT_VERSION"'"
+                "sourcebot_version": "'"$NEXT_PUBLIC_SOURCEBOT_VERSION"'"
             }
         }' https://us.i.posthog.com/capture/ ) then
             echo -e "\e[33m[Warning] Failed to send install event.\e[0m"
@@ -106,17 +106,17 @@ else
     PREVIOUS_VERSION=$(cat "$FIRST_RUN_FILE" | jq -r '.version')
 
     # If the version has changed, we assume an upgrade has occurred.
-    if [ "$PREVIOUS_VERSION" != "$SOURCEBOT_VERSION" ]; then
-        echo -e "\e[34m[Info] Upgraded from version $PREVIOUS_VERSION to $SOURCEBOT_VERSION\e[0m"
+    if [ "$PREVIOUS_VERSION" != "$NEXT_PUBLIC_SOURCEBOT_VERSION" ]; then
+        echo -e "\e[34m[Info] Upgraded from version $PREVIOUS_VERSION to $NEXT_PUBLIC_SOURCEBOT_VERSION\e[0m"
 
         if [ "$SOURCEBOT_TELEMETRY_DISABLED" = "false" ]; then
             if ! ( curl -L --output /dev/null --silent --fail --header "Content-Type: application/json" -d '{
-                "api_key": "'"$POSTHOG_PAPIK"'",
+                "api_key": "'"$NEXT_PUBLIC_POSTHOG_PAPIK"'",
                 "event": "upgrade",
                 "distinct_id": "'"$SOURCEBOT_INSTALL_ID"'",
                 "properties": {
                     "from_version": "'"$PREVIOUS_VERSION"'",
-                    "to_version": "'"$SOURCEBOT_VERSION"'"
+                    "to_version": "'"$NEXT_PUBLIC_SOURCEBOT_VERSION"'"
                 }
             }' https://us.i.posthog.com/capture/ ) then
                 echo -e "\e[33m[Warning] Failed to send upgrade event.\e[0m"
@@ -125,7 +125,7 @@ else
     fi
 fi
 
-echo "{\"version\": \"$SOURCEBOT_VERSION\", \"install_id\": \"$SOURCEBOT_INSTALL_ID\"}" > "$FIRST_RUN_FILE"
+echo "{\"version\": \"$NEXT_PUBLIC_SOURCEBOT_VERSION\", \"install_id\": \"$SOURCEBOT_INSTALL_ID\"}" > "$FIRST_RUN_FILE"
 
 
 # Start the database and wait for it to be ready before starting any other service

Dockerfile

@@ -25,18 +25,18 @@ export const env = createEnv({
         SOURCEBOT_LOG_LEVEL: z.enum(["info", "debug", "warn", "error"]).default("info"),
         SOURCEBOT_TELEMETRY_DISABLED: booleanSchema.default("false"),
         SOURCEBOT_INSTALL_ID: z.string().default("unknown"),
-        SOURCEBOT_VERSION: z.string().default("unknown"),
+        NEXT_PUBLIC_SOURCEBOT_VERSION: z.string().default("unknown"),
 
-        POSTHOG_PAPIK: z.string().optional(),
+        NEXT_PUBLIC_POSTHOG_PAPIK: z.string().optional(),
 
         FALLBACK_GITHUB_CLOUD_TOKEN: z.string().optional(),
         FALLBACK_GITLAB_CLOUD_TOKEN: z.string().optional(),
         FALLBACK_GITEA_CLOUD_TOKEN: z.string().optional(),
 
         REDIS_URL: z.string().url().default("redis://localhost:6379"),
 
-        SENTRY_BACKEND_DSN: z.string().optional(),
-        SENTRY_ENVIRONMENT: z.string().optional(),
+        NEXT_PUBLIC_SENTRY_BACKEND_DSN: z.string().optional(),
+        NEXT_PUBLIC_SENTRY_ENVIRONMENT: z.string().optional(),
 
         LOGTAIL_TOKEN: z.string().optional(),
         LOGTAIL_HOST: z.string().url().optional(),

entrypoint.sh

@@ -1,8 +1,12 @@
 import * as Sentry from "@sentry/node";
 import { env } from "./env.js";
 
-Sentry.init({
-  dsn: env.SENTRY_BACKEND_DSN,
-  release: env.SOURCEBOT_VERSION,
-  environment: env.SENTRY_ENVIRONMENT,
-});
+if (!!env.NEXT_PUBLIC_SENTRY_BACKEND_DSN && !!env.NEXT_PUBLIC_SENTRY_ENVIRONMENT) {
+    Sentry.init({
+        dsn: env.NEXT_PUBLIC_SENTRY_BACKEND_DSN,
+        release: env.NEXT_PUBLIC_SOURCEBOT_VERSION,
+        environment: env.NEXT_PUBLIC_SENTRY_ENVIRONMENT,
+    });
+} else {
+    console.debug("Sentry was not initialized");
+}

packages/backend/src/env.ts

@@ -4,9 +4,9 @@ import { env } from './env.js';
 
 let posthog: PostHog | undefined = undefined;
 
-if (env.POSTHOG_PAPIK) {
+if (env.NEXT_PUBLIC_POSTHOG_PAPIK) {
     posthog = new PostHog(
-        env.POSTHOG_PAPIK,
+        env.NEXT_PUBLIC_POSTHOG_PAPIK,
         {
             host: "https://us.i.posthog.com",
         }
@@ -23,7 +23,7 @@ export function captureEvent<E extends PosthogEvent>(event: E, properties: Posth
         event: event,
         properties: {
             ...properties,
-            sourcebot_version: env.SOURCEBOT_VERSION,
+            sourcebot_version: env.NEXT_PUBLIC_SOURCEBOT_VERSION,
         },
     });
 }

packages/backend/src/instrument.ts

@@ -4,10 +4,14 @@
 
 import * as Sentry from "@sentry/nextjs";
 
-Sentry.init({
-  dsn: process.env.NEXT_PUBLIC_SENTRY_WEBAPP_DSN,
-  environment: process.env.NEXT_PUBLIC_SENTRY_ENVIRONMENT || 'unknown',
+if (!!process.env.NEXT_PUBLIC_SENTRY_WEBAPP_DSN && !!process.env.NEXT_PUBLIC_SENTRY_ENVIRONMENT) {
+    Sentry.init({
+        dsn: process.env.NEXT_PUBLIC_SENTRY_WEBAPP_DSN,
+        environment: process.env.NEXT_PUBLIC_SENTRY_ENVIRONMENT,
 
-  // Setting this option to true will print useful information to the console while you're setting up Sentry.
-  debug: false,
-});
+        // Setting this option to true will print useful information to the console while you're setting up Sentry.
+        debug: false,
+    });
+} else {
+    console.debug("[client] Sentry was not initialized");
+}