env.js

/* global BRANCH, VERSION, COMMITHASH, SENTRY_RELEASE */
import Toucan from 'toucan-js'

import pkg from '../package.json'
import { Logging } from './logs.js'
import { DBClient } from './utils/db-client.js'

/**
 * @typedef {Object} EnvInput
 * @property {string} ENV
 * @property {string} GATEWAY_DOMAIN
 * @property {string} SALT
 * @property {string} DATABASE_URL
 * @property {string} DATABASE_TOKEN
 * @property {string} [SENTRY_DSN]
 * @property {string} [LOGTAIL_TOKEN]
 * @property {number} [REQUEST_TIMEOUT]
 * @property {KVNamespace} PERMACACHE
 * @property {KVNamespace} PERMACACHE_HISTORY
 * @property {R2Bucket} SUPERHOT
 *
 * @typedef {Object} EnvTransformed
 * @property {string} VERSION
 * @property {string} COMMITHASH
 * @property {string} BRANCH
 * @property {string} DEBUG
 * @property {string} SENTRY_RELEASE
 * @property {number} REQUEST_TIMEOUT
 * @property {DBClient} db
 * @property {Toucan} [sentry]
 * @property {Logging} [log]
 *
 * @typedef {EnvInput & EnvTransformed} Env
 */

/**
 * @param {Request} request
 * @param {Env} env
 * @param {import('.').Ctx} ctx
 */
export function envAll(request, env, ctx) {
  // These values are replaced at build time by esbuild `define`
  env.BRANCH = BRANCH
  env.VERSION = VERSION
  env.COMMITHASH = COMMITHASH
  env.SENTRY_RELEASE = SENTRY_RELEASE

  env.sentry = getSentry(request, env, ctx)
  env.REQUEST_TIMEOUT = env.REQUEST_TIMEOUT || 30000
  env.SALT = env.SALT

  env.db = new DBClient({
    endpoint: env.DATABASE_URL,
    token: env.DATABASE_TOKEN,
  })

  env.log = new Logging(request, env, ctx)
  env.log.time('request')

  /**
   * Add gateway environment
   * will be removed once workers bindings are in place.
   */
  // @ts-ignore types not complete - Special inputs for Env
  env.ipfsGateways = JSON.parse(env.IPFS_GATEWAYS)
}

/**
 * Get sentry instance if configured
 *
 * @param {Request} request
 * @param {Env} env
 * @param {import('.').Ctx} ctx
 */
function getSentry(request, env, ctx) {
  if (!env.SENTRY_DSN) {
    return
  }

  return new Toucan({
    request,
    dsn: env.SENTRY_DSN,
    context: ctx,
    allowedHeaders: ['user-agent'],
    allowedSearchParams: /(.*)/,
    debug: false,
    environment: env.ENV || 'dev',
    rewriteFrames: {
      // strip . from start of the filename ./worker.mjs as set by cloudflare, to make absolute path `/worker.mjs`
      iteratee: (frame) => ({
        ...frame,
        filename: frame.filename.substring(1),
      }),
    },
    release: env.VERSION,
    pkg,
  })
}

/**
 * From: https://github.com/cloudflare/workers-types
 *
 * @typedef {Object} KVNamespacePutOptions
 * @property {any} [metadata]
 * @property {number} [expiration]
 * @property {number} [expirationTtl]
 *
 * @typedef {Object} KVNamespaceListOptions
 * @property {number} [limit]
 * @property {string} [prefix]
 * @property {string} [cursor]
 *
 * @typedef {Object} KVNamespaceListKey
 * @property {string} name
 * @property {number} [expiration]
 * @property {any} [metadata]
 *
 * @typedef {Object} KVNamespaceListResult
 * @property {KVNamespaceListKey[]} [keys]
 * @property {boolean} [list_complete]
 * @property {string} [cursor]
 *
 * @typedef {Object} KVNamespace
 * @property {(key: string) => Promise<string | null>} get
 * @property {(key: string, value: string, options?: KVNamespacePutOptions) => Promise<string | null>} put
 * @property {(options: KVNamespaceListOptions) => Promise<KVNamespaceListResult>} list
 *
 * @typedef {Object} R2PutOptions
 * @property {Headers} [httpMetadata]
 * @property {Record<string, string>} [customMetadata]
 *
 * @typedef {Object} R2Object
 * @property {Date} uploaded
 * @property {number} size
 * @property {Headers} [httpMetadata]
 * @property {Record<string, string>} [customMetadata]
 *
 * @typedef {Object} R2ObjectBody
 * @property {ReadableStream} body
 * @property {() => Promise<ArrayBuffer>} arrayBuffer
 * @property {() => Promise<string>} text
 * @property {() => Promise<JSON>} json
 * @property {() => Promise<Blob>} blob
 * @property {Date} uploaded
 * @property {Headers} [httpMetadata]
 * @property {Record<string, string>} [customMetadata]
 *
 * @typedef {Object} R2Bucket
 * @property {(key: string) => Promise<R2Object | null>} head
 * @property {(key: string) => Promise<R2ObjectBody | null>} get
 * @property {(key: string, value: ReadableStream | ArrayBuffer | ArrayBufferView | string | null, options?: R2PutOptions) => Promise<R2Object>} put
 * @property {(key: string) => Promise<void>} delete
 */