src: add sentry breadcrumbs, tail worker

src/middleware/cacheMiddleware.ts

@@ -23,6 +23,13 @@ export function cached(middleware: Middleware): Middleware {
 
   const wrapper: Middleware = {
     async handle(request, ctx, next) {
+      ctx.sentry.addBreadcrumb({
+        category: 'CacheMiddleware',
+        data: {
+          underlyingMiddleware: middleware.constructor.name,
+        },
+      });
+
       if (!isCacheEnabled(ctx.env)) {
         return middleware.handle(request, ctx, next);
       }

src/middleware/notFoundMiddleware.ts

@@ -1,9 +1,15 @@
+import type { Context } from '../context';
 import responses from '../responses';
 import type { Request } from '../routes/request';
 import type { Middleware } from './middleware';
 
 export class NotFoundMiddleware implements Middleware {
-  handle(request: Request): Promise<Response> {
+  handle(request: Request, ctx: Context): Promise<Response> {
+    ctx.sentry.addBreadcrumb({
+      category: 'NotFoundMiddleware',
+      message: 'hit',
+    });
+
     return Promise.resolve(responses.fileNotFound(request.method));
   }
 }

src/middleware/optionsMiddleware.ts

@@ -1,11 +1,17 @@
 import { CACHE_HEADERS } from '../constants/cache';
+import type { Context } from '../context';
 import type { Middleware } from './middleware';
 
 /**
  * Handles OPTION requests, just returns what HTTP methods we support
  */
 export class OptionsMiddleware implements Middleware {
-  handle(): Promise<Response> {
+  handle(_: Request, ctx: Context): Promise<Response> {
+    ctx.sentry.addBreadcrumb({
+      category: 'OptionsMiddleware',
+      message: 'hit',
+    });
+
     return Promise.resolve(
       new Response(undefined, {
         headers: {

src/middleware/originMiddleware.ts

@@ -13,6 +13,11 @@ import type { Middleware } from './middleware';
  */
 export class OriginMiddleware implements Middleware {
   async handle(request: Request, ctx: Context): Promise<Response> {
+    ctx.sentry.addBreadcrumb({
+      category: 'OriginMiddleware',
+      message: 'hit',
+    });
+
     const res = await fetch(
       `${ctx.env.ORIGIN_HOST}${request.urlObj.pathname}`,
       {

src/middleware/r2Middleware.ts

@@ -17,6 +17,14 @@ export class R2Middleware implements Middleware {
     const path = getR2Path(request);
     const isPathADirectory = isDirectoryPath(path);
 
+    ctx.sentry.addBreadcrumb({
+      category: 'R2Middleware',
+      data: {
+        r2Path: path,
+        isPathADirectory,
+      },
+    });
+
     return isPathADirectory
       ? handleDirectory(request, path, ctx)
       : handleFile(request, path, ctx);

src/middleware/subtituteMiddleware.ts

@@ -22,12 +22,19 @@ export class SubtitutionMiddleware implements Middleware {
     this.replaceValue = replaceValue;
   }
 
-  handle(request: Request, _: Context): Promise<Response> {
+  handle(request: Request, ctx: Context): Promise<Response> {
+    const newUrl = request.url.replaceAll(this.searchValue, this.replaceValue);
+
+    ctx.sentry.addBreadcrumb({
+      type: 'navigation',
+      category: 'SubstitutionMiddleware',
+      data: {
+        from: request.url,
+        to: newUrl,
+      },
+    });
+
     // todo fix this
-    return Promise.resolve(
-      Response.redirect(
-        request.url.replaceAll(this.searchValue, this.replaceValue)
-      )
-    );
+    return Promise.resolve(Response.redirect(newUrl));
   }
 }

tests/unit/middleware/substituteMiddleware.test.ts

@@ -39,5 +39,9 @@ it('correctly substitutes url `/dist/latest` to `/dist/v1.0.0`', async () => {
   const middleware = new SubtitutionMiddleware(router, 'latest', 'v1.0.0');
 
   // @ts-expect-error full request & ctx not needed
-  middleware.handle(originalRequest, undefined);
+  middleware.handle(originalRequest, {
+    sentry: {
+      addBreadcrumb: () => {},
+    },
+  });
 });

wrangler.toml

@@ -40,6 +40,9 @@ S3_ENDPOINT = 'https://07be8d2fbc940503ca1be344714cb0d1.r2.cloudflarestorage.com
 BUCKET_NAME='dist-prod'
 ORIGIN_HOST = 'https://origin.nodejs.org'
 
+[env.prod.tail_consumers]
+service = "dist-worker-prod-tail"
+
 [[env.prod.r2_buckets]]
 binding = 'R2_BUCKET'
 preview_bucket_name = 'dist-prod'