feat: change access-api wrangler.toml to be no_bundle=false. use wrangler bundling

.github/workflows/reusable-deploy-api.yml

@@ -42,8 +42,23 @@ jobs:
         with:
           node-version: 18
           cache: 'pnpm'
-      - run: pnpm install
-      # Migration database
+      - run: pnpm --filter '@web3-storage/access-api...' install
+      # get release name that will be used for sentry
+      - id: set-release-name
+        env:
+          ENV: ${{ inputs.environment }}
+        run: |
+          echo "release_name=$(node packages/access-api/scripts/release.js)" >> "$GITHUB_OUTPUT"
+      - run: echo "release name is ${{ steps.set-release-name.outputs.release_name }}"
+      # write release info to ./src so it can be imported at runtime (e.g. used by toucan-js for `opts.release`)
+      # be sure to keep this before wrangler-action bundles+deploys
+      - name: write release info to src
+        working-directory: packages/access-api/
+        env:
+          ENV: ${{ vars.ENV }}
+        run: |
+          node scripts/release.js esm > src/utils/release.build.js
+      # Apply D1 Migrations
       - run: pnpm -r --filter @web3-storage/access-api exec wrangler d1 migrations apply __D1_BETA__ --env ${{ inputs.environment }}
         env:
           CLOUDFLARE_API_TOKEN: ${{ secrets.CF_TOKEN }}
@@ -69,3 +84,18 @@ jobs:
           SENTRY_TOKEN: ${{ secrets.SENTRY_TOKEN }}
           LOGTAIL_TOKEN: ${{ secrets.LOGTAIL_TOKEN }}
           UCAN_LOG_BASIC_AUTH: ${{ secrets.UCAN_LOG_BASIC_AUTH }}
+      - name: create sentry release
+        working-directory: packages/access-api
+        run: |
+          # write ./dist/index.{js,js.map}
+          pnpm exec wrangler --env="$ENV" publish --dry-run --outdir=dist
+          # create sentry release
+          pnpm exec sentry-cli releases new "$RELEASE_NAME" --finalize
+          # associate wrangler-built src+map to sentry release
+          pnpm exec sentry-cli releases files "$RELEASE_NAME" upload-sourcemaps ./dist
+        env:
+          ENV: ${{ vars.ENV }}
+          RELEASE_NAME: ${{ steps.set-release-name.outputs.release_name }}
+          SENTRY_ORG: ${{ vars.SENTRY_ORG }}
+          SENTRY_PROJECT: ${{ vars.SENTRY_PROJECT }}
+          SENTRY_AUTH_TOKEN: ${{ secrets.SENTRY_TOKEN }}

packages/access-api/.gitignore

@@ -0,0 +1 @@
+.dev.vars

packages/access-api/scripts/release.js

@@ -0,0 +1,52 @@
+/* eslint-disable unicorn/prefer-top-level-await */
+/* eslint-disable no-console */
+/* eslint-disable unicorn/prefer-module */
+/**
+ * @file
+ * use this at build time (node.js) to create files that can be
+ * imported at runtime (maybe workerd).
+ */
+import sade from 'sade'
+import * as url from 'node:url'
+import { getReleaseName } from '../src/utils/release.node.js'
+import path from 'path'
+import { fileURLToPath } from 'url'
+// @ts-ignore
+import git from 'git-rev-sync'
+
+function __dirname() {
+  return path.dirname(fileURLToPath(import.meta.url))
+}
+
+if (import.meta.url.startsWith('file:')) {
+  const modulePath = url.fileURLToPath(import.meta.url)
+  if (process.argv[1] === modulePath) {
+    main().catch((error) => {
+      throw error
+    })
+  }
+}
+
+async function main(argv = process.argv) {
+  const cli = sade('access-api-release')
+  cli
+    .command('name', '', { default: true })
+    .option('--env', 'Environment', process.env.ENV)
+    .action((opts) => {
+      const releaseName = getReleaseName(opts.env)
+      console.log(releaseName)
+    })
+  cli
+    .command('esm', 'print release info as ES Module string')
+    .option('--env', 'Environment', process.env.ENV)
+    .action((opts) => {
+      const lines = [
+        `/** @type {string|undefined} */`,
+        `export const gitRevShort = '${git.short(__dirname())}'`,
+        `/** @type {string|undefined} */`,
+        `export const name = '${getReleaseName(opts.env)}'`,
+      ]
+      console.log(lines.join('\n'))
+    })
+  cli.parse(argv)
+}

packages/access-api/src/config.js

@@ -2,6 +2,7 @@
 // eslint-disable-next-line no-unused-vars
 import * as UCAN from '@ucanto/interface'
 import { DID } from '@ucanto/core'
+import * as release from './utils/release.build.js'
 
 /**
  * Loads configuration variables from the global environment and returns a JS object
@@ -14,15 +15,7 @@ export function loadConfig(env) {
   const vars = {}
 
   /** @type {Array<keyof env>} */
-  const required = [
-    'DID',
-    'ENV',
-    'DEBUG',
-    'PRIVATE_KEY',
-    'SENTRY_DSN',
-    'POSTMARK_TOKEN',
-    'LOGTAIL_TOKEN',
-  ]
+  const required = ['DID', 'ENV', 'DEBUG', 'PRIVATE_KEY']
 
   for (const name of required) {
     const val = env[name]
@@ -47,21 +40,21 @@ export function loadConfig(env) {
 
     POSTMARK_TOKEN: vars.POSTMARK_TOKEN,
     POSTMARK_SENDER: env.POSTMARK_SENDER,
-    SENTRY_DSN: vars.SENTRY_DSN,
-    LOGTAIL_TOKEN: vars.LOGTAIL_TOKEN,
+    SENTRY_DSN: env.SENTRY_DSN,
+    LOGTAIL_TOKEN: env.LOGTAIL_TOKEN,
     UCAN_LOG_BASIC_AUTH: env.UCAN_LOG_BASIC_AUTH,
     UCAN_LOG_URL: env.UCAN_LOG_URL,
 
     // These are injected in esbuild
     // @ts-ignore
     // eslint-disable-next-line no-undef
-    BRANCH: ACCOUNT_BRANCH,
+    BRANCH: env.ACCOUNT_BRANCH ?? '',
     // @ts-ignore
     // eslint-disable-next-line no-undef
-    VERSION: ACCOUNT_VERSION,
+    VERSION: env.ACCOUNT_VERSION ?? release.name ?? '',
     // @ts-ignore
     // eslint-disable-next-line no-undef
-    COMMITHASH: ACCOUNT_COMMITHASH,
+    COMMITHASH: env.ACCOUNT_COMMITHASH ?? release.gitRevShort ?? '',
 
     PRIVATE_KEY: vars.PRIVATE_KEY,
     DID: /** @type {UCAN.DID<"web">} */ (DID.parse(vars.DID).did()),

packages/access-api/src/utils/context.js

@@ -15,6 +15,7 @@ import {
 } from '../models/delegations.js'
 import { createD1Database } from './d1.js'
 import { DbProvisions } from '../models/provisions.js'
+import * as release from './release.build.js'
 
 /**
  * Obtains a route context object.
@@ -44,6 +45,10 @@ export function getContext(request, env, ctx) {
       : UCANLog.debug()
 
   // Sentry
+  // eslint-disable-next-line no-console
+  console.warn('constructing toucan-js', {
+    release: String(release.name),
+  })
   const sentry = new Toucan({
     context: ctx,
     integrations: [
@@ -56,14 +61,14 @@ export function getContext(request, env, ctx) {
     dsn: config.SENTRY_DSN,
     debug: false,
     environment: config.ENV,
-    release: config.VERSION,
+    release: release.name,
   })
 
   // Logging
   const log = new Logging(request, ctx, {
     token: config.LOGTAIL_TOKEN,
     debug: config.DEBUG,
-    sentry: ['test', 'dev'].includes(config.ENV) ? undefined : sentry,
+    sentry: ['test'].includes(config.ENV) ? undefined : sentry,
     branch: config.BRANCH,
     version: config.VERSION,
     commit: config.COMMITHASH,

packages/access-api/src/utils/release.build.js

@@ -0,0 +1,9 @@
+/**
+ * @file
+ * This file MAY be rewritten during build
+ * to make some buildtime variables available at runtime.
+ */
+/** @type {string|undefined} */
+export const gitRevShort = undefined
+/** @type {string|undefined} */
+export const name = undefined

packages/access-api/src/utils/release.node.js

@@ -0,0 +1,39 @@
+/**
+ * @file
+ * utils related to sentry that rely on node.
+ * These might be used at build time,
+ * but won't work at run-time in cloudflare workers
+ */
+/* eslint-disable no-console */
+/* eslint-disable unicorn/prefer-module */
+
+// @ts-ignore
+import git from 'git-rev-sync'
+import path from 'path'
+import { fileURLToPath } from 'url'
+import { createRequire } from 'node:module'
+
+const packageJson = createRequire(import.meta.url)('../../package.json')
+const __dirname = () => path.dirname(fileURLToPath(import.meta.url))
+
+/**
+ * Create a string to be used for the sentry release value
+ *
+ * @param {string} [env] - environment name e.g. 'dev'
+ * @param {object} pkg - package.json info
+ * @param {string} pkg.name
+ * @param {string} pkg.version
+ * @param {string} gitShort - git-rev-parse short value
+ * @returns {string} release name e.g. `@web3-storage__access-api@6.0.0-staging+92a89d3`
+ */
+export function getReleaseName(
+  env,
+  pkg = packageJson,
+  gitShort = git.short(__dirname())
+) {
+  const version = `${pkg.name}@${pkg.version}-${env}+${gitShort}`.replace(
+    '/',
+    '__'
+  )
+  return version
+}

packages/access-api/wrangler.toml

@@ -1,15 +1,12 @@
 # Development
 name = "w3access-local"
 account_id = "fffa4b4363a7e5250af8357087263b3a"
-main = "./dist/worker.js"
+main = "./src/index.js"
 
 # Compatibility flags https://github.com/cloudflare/wrangler/pull/2009
 compatibility_date = "2022-09-28"
 compatibility_flags = ["url_standard"]
 
-# We need to let wrangler bundle while D1 is in Beta
-no_bundle = false
-
 [[kv_namespaces]]
 binding = "SPACES"
 id = "e9fad7e04b254bf49206e08e50074387"
@@ -28,43 +25,52 @@ database_id = "7c676e0c-b9e7-4711-97c8-7b1c8eb229ae"
 [[r2_buckets]]
 binding = "DELEGATIONS_BUCKET"
 bucket_name = "w3up-delegations-dev-0"
+preview_bucket_name = "w3up-delegations-dev-0"
 
 [vars]
 ENV = "dev"
 DEBUG = "true"
 DID = "did:web:local.web3.storage"
+PRIVATE_KEY="MgCYWjE6vp0cn3amPan2xPO+f6EZ3I+KwuN1w2vx57vpJ9O0Bn4ci4jn8itwc121ujm7lDHkCW24LuKfZwIdmsifVysY="
 UPLOAD_API_URL = "https://up.web3.storage"
 
 [build]
-command = "scripts/cli.js build"
 watch_dir = "src"
 
 [miniflare]
 d1_persist = ".wrangler/miniflare"
 
+rules = [
+  { type = "Text", globs = ["package.json"], fallthrough = true }
+]
+
 # Dev
 [env.dev]
 name = "w3access-dev"
 workers_dev = true
 vars = { ENV = "dev", DEBUG = "false", DID = "did:web:dev.web3.storage", UPLOAD_API_URL = "https://staging.up.web3.storage" }
-build = { command = "scripts/cli.js build --env dev", watch_dir = "src" }
 kv_namespaces = [
     { binding = "SPACES", id = "5697e95e1aaa436788e6d697fd3350be" },
     { binding = "VALIDATIONS", id = "ea17f472b37a43d29c1faf7af9512e03" },
 ]
-d1_databases = [
-    { binding = "__D1_BETA__", database_name = "access-dev", database_id = "4145a261-e54c-411d-a001-050fc30e4678" },
-]
 unsafe = { bindings = [
     { type = "analytics_engine", dataset = "W3ACCESS_METRICS", name = "W3ACCESS_METRICS" },
 ] }
 
+[[env.dev.d1_databases]]
+binding = "__D1_BETA__"
+database_name = "access-dev"
+database_id = "7f5c4ec7-610b-4885-b9f7-0886ce0639f6"
+
+[[env.dev.r2_buckets]]
+binding = "DELEGATIONS_BUCKET"
+bucket_name = "w3up-delegations-dev-0"
+preview_bucket_name = "w3up-delegations-dev-0"
 
 # Staging
 [env.staging]
 name = "w3access-staging"
 workers_dev = true
-build = { command = "scripts/cli.js build --env staging", watch_dir = "src" }
 kv_namespaces = [
     { binding = "SPACES", id = "b0e5ca990dda4e3784a1741dfa28a52e" },
     { binding = "VALIDATIONS", id = "b13f07c88fe848db9ccf651a0fea3fb6" },
@@ -90,7 +96,6 @@ bucket_name = "w3up-delegations-staging-0"
 [env.production]
 name = "w3access"
 routes = [{ pattern = "access.web3.storage", custom_domain = true }]
-build = { command = "scripts/cli.js build --env production", watch_dir = "src" }
 kv_namespaces = [
     { binding = "SPACES", id = "5437954e8cfd4f7d98557132b0a2e93f" },
     { binding = "VALIDATIONS", id = "fb7cf10c725f45948321e88b8cb168ad" },