ref: allow hosted js sdk bundles (#3365)

* ref: allow hosted js sdk bundles


---------

Co-authored-by: Burak Yigit Kaya <[email protected]>

Author: aldy505

.env

@@ -17,3 +17,5 @@ HEALTHCHECK_RETRIES=10
 # Caution: Raising max connections of postgres increases CPU and RAM usage
 # see https://github.com/getsentry/self-hosted/pull/2740 for more information
 POSTGRES_MAX_CONNECTIONS=100
+# Set SETUP_JS_SDK_ASSETS to 1 to enable the setup of JS SDK assets
+# SETUP_JS_SDK_ASSETS=1

_unit-test/js-sdk-assets-test.sh

@@ -0,0 +1,26 @@
+#!/usr/bin/env bash
+
+source _unit-test/_test_setup.sh
+source install/dc-detect-version.sh
+$dcb --force-rm web
+
+export SETUP_JS_SDK_ASSETS=1
+
+source install/setup-js-sdk-assets.sh
+
+sdk_files=$(docker compose run --no-deps --rm -v "sentry-nginx-www:/var/www" nginx ls -lah /var/www/js-sdk/)
+sdk_tree=$(docker compose run --no-deps --rm -v "sentry-nginx-www:/var/www" nginx tree /var/www/js-sdk/ | tail -n 1)
+
+# `sdk_files` should contains 2 lines, `7.*` and `8.*`
+echo $sdk_files
+total_directories=$(echo "$sdk_files" | grep -c '[78]\.[0-9]*\.[0-9]*$')
+echo $total_directories
+test "2" == "$total_directories"
+echo "Pass"
+
+# `sdk_tree` should outputs "2 directories, 10 files"
+echo "$sdk_tree"
+test "2 directories, 10 files" == "$(echo "$sdk_tree")"
+echo "Pass"
+
+report_success

docker-compose.yml

@@ -460,6 +460,7 @@ services:
         source: ./nginx
         target: /etc/nginx
       - sentry-nginx-cache:/var/cache/nginx
+      - sentry-nginx-www:/var/www
     depends_on:
       - web
       - relay
@@ -529,6 +530,9 @@ volumes:
     external: true
   sentry-symbolicator:
     external: true
+  # This volume stores JS SDK assets and the data inside this volume should
+  # be cleaned periodically on upgrades.
+  sentry-nginx-www:
   # This volume stores profiles and should be persisted.
   # Not being external will still persist data across restarts.
   # It won't persist if someone does a docker compose down -v.

install.sh

@@ -36,4 +36,5 @@ source install/bootstrap-snuba.sh
 source install/upgrade-postgres.sh
 source install/set-up-and-migrate-database.sh
 source install/geoip.sh
+source install/setup-js-sdk-assets.sh
 source install/wrap-up.sh

install/setup-js-sdk-assets.sh

@@ -0,0 +1,38 @@
+# This will only run if the SETUP_JS_SDK_ASSETS environment variable is set to 1.
+# Think of this as some kind of a feature flag.
+if [[ "${SETUP_JS_SDK_ASSETS:-}" == "1" ]]; then
+  echo "${_group}Setting up JS SDK assets"
+
+  # If the `sentry-nginx-www` volume exists, we need to prune the contents.
+  # We don't want to fill the volume with old JS SDK assets.
+  # If people want to keep the old assets, they can set the environment variable
+  # `SETUP_JS_SDK_KEEP_OLD_ASSETS` to any value.
+  if [[ -z "${SETUP_JS_SDK_KEEP_OLD_ASSETS:-}" ]]; then
+    echo "Cleaning up old JS SDK assets..."
+    $dcr --no-deps --rm -v "sentry-nginx-www:/var/www" nginx rm -rf /var/www/js-sdk/*
+  fi
+
+  $dbuild -t sentry-self-hosted-jq-local --platform="$DOCKER_PLATFORM" jq
+
+  jq="docker run --rm -i sentry-self-hosted-jq-local"
+
+  loader_registry=$($dcr --no-deps --rm -T web cat /usr/src/sentry/src/sentry/loader/_registry.json)
+  # The `loader_registry` should start with "Updating certificates...", we want to delete that and the subsequent ca-certificates related lines.
+  # We want to remove everything before the first '{'.
+  loader_registry=$(echo "$loader_registry" | sed '0,/{/s/[^{]*//')
+
+  latest_js_v7=$(echo "$loader_registry" | $jq -r '.versions | reverse | map(select(.|any(.; startswith("7.")))) | .[0]')
+  latest_js_v8=$(echo "$loader_registry" | $jq -r '.versions | reverse | map(select(.|any(.; startswith("8.")))) | .[0]')
+
+  echo "Found JS SDKs v${latest_js_v7} and v${latest_js_v8}, downloading from upstream.."
+
+  # Download those two using wget
+  for version in "${latest_js_v7}" "${latest_js_v8}"; do
+    $dcr --no-deps --rm -v "sentry-nginx-www:/var/www" nginx mkdir -p /var/www/js-sdk/${version}
+    for variant in "tracing" "tracing.replay" "replay" "tracing.replay.feedback" "feedback"; do
+      $dcr --no-deps --rm -v "sentry-nginx-www:/var/www" nginx wget -q -O /var/www/js-sdk/${version}/bundle.${variant}.min.js "https://browser.sentry-cdn.com/${version}/bundle.${variant}.min.js"
+    done
+  done
+
+  echo "${_endgroup}"
+fi

nginx/nginx.conf

@@ -88,6 +88,10 @@ http {
 		location ^~ /api/0/relays/ {
 			proxy_pass http://relay;
 		}
+		location ^~ /js-sdk/ {
+			autoindex on;
+			root  /var/www/js-sdk;
+		}
 		location / {
 			proxy_pass http://sentry;
 		}

sentry/sentry.conf.example.py

@@ -378,6 +378,17 @@ def get_internal_network():
 # JS SDK Loader #
 #################
 
+# Configure Sentry JS SDK bundle URL template for Loader Scripts.
+# Learn more about the Loader Scripts: https://docs.sentry.io/platforms/javascript/install/loader/
+
+# If you wish to host your own JS SDK bundles, set `SETUP_JS_SDK_ASSETS` environment variable to `1`
+# on your `.env` or `.env.custom` file. Then, replace the value below with your own public URL.
+# For example: "https://sentry.example.com/js-sdk/%s/bundle%s.min.js"
+#
+# By default, the previous JS SDK assets version will be pruned during upgrades, if you wish
+# to keep the old assets, set `SETUP_JS_SDK_KEEP_OLD_ASSETS` environment variable to any value on
+# your `.env` or `.env.custom` file. The files should only be a few KBs, and this might be useful
+# if you're using it directly like a CDN instead of using the loader script.
 JS_SDK_LOADER_DEFAULT_SDK_URL = "https://browser.sentry-cdn.com/%s/bundle%s.min.js"