feat: add document path annotation to logs

Author: fwal

packages/admin/src/lib/functions/on-document-created.ts

@@ -1,4 +1,4 @@
-import { Effect, Schema } from 'effect';
+import { Effect, pipe, Schema } from 'effect';
 import {
   onDocumentCreated,
   onDocumentCreatedWithAuthContext,
@@ -47,15 +47,21 @@ export function onDocumentCreatedEffect<
   const schema = options.schema ?? Schema.Unknown;
 
   return onDocumentCreated(options, async (event) => {
-    const effect = Effect.gen(function* () {
-      const data = yield* decodeDocumentData(
+    const effect = pipe(
+      decodeDocumentData(
         event.data?.data(),
         event.data?.id,
         schema,
         options.idField
-      );
-      return yield* handler(data as Schema.Schema.Type<S>, event);
-    }).pipe(Effect.withSpan('onDocumentCreatedEffect'));
+      ),
+      Effect.tap(() =>
+        Effect.annotateCurrentSpan({
+          document: event.data?.ref.path ?? 'unknown',
+        })
+      ),
+      Effect.flatMap((data) => handler(data as Schema.Schema.Type<S>, event)),
+      Effect.withSpan('onDocumentCreatedEffect')
+    );
 
     await run(
       options.runtime,
@@ -97,6 +103,9 @@ export function onDocumentCreatedWithAuthContextEffect<
 
   return onDocumentCreatedWithAuthContext(options, async (event) => {
     const effect = Effect.gen(function* () {
+      yield* Effect.annotateCurrentSpan({
+        document: event.data?.ref.path ?? 'unknown',
+      });
       const data = yield* decodeDocumentData(
         event.data?.data(),
         event.data?.id,

packages/admin/src/lib/functions/on-document-deleted.ts

@@ -48,6 +48,9 @@ export function onDocumentDeletedEffect<
 
   return onDocumentDeleted(options, async (event) => {
     const effect = Effect.gen(function* () {
+      yield* Effect.annotateCurrentSpan({
+        document: event.data?.ref.path ?? 'unknown',
+      });
       const data = yield* decodeDocumentData(
         event.data?.data(),
         event.data?.id,
@@ -97,6 +100,9 @@ export function onDocumentDeletedWithAuthContextEffect<
 
   return onDocumentDeletedWithAuthContext(options, async (event) => {
     const effect = Effect.gen(function* () {
+      yield* Effect.annotateCurrentSpan({
+        document: event.data?.ref.path ?? 'unknown',
+      });
       const data = yield* decodeDocumentData(
         event.data?.data(),
         event.data?.id,

packages/admin/src/lib/functions/on-document-updated.ts

@@ -60,6 +60,9 @@ export function onDocumentUpdatedEffect<
 
   return onDocumentUpdated(options, async (event) => {
     const effect = Effect.gen(function* () {
+      yield* Effect.annotateCurrentSpan({
+        document: event.data?.before.ref.path ?? 'unknown',
+      });
       const docId = event.data?.before.id;
 
       const before = yield* decodeDocumentData(
@@ -127,6 +130,9 @@ export function onDocumentUpdatedWithAuthContextEffect<
 
   return onDocumentUpdatedWithAuthContext(options, async (event) => {
     const effect = Effect.gen(function* () {
+      yield* Effect.annotateCurrentSpan({
+        document: event.data?.before.ref.path ?? 'unknown',
+      });
       const docId = event.data?.before.id;
       const before = yield* decodeDocumentData(
         event.data?.before.data(),

packages/admin/src/lib/functions/on-document-written.ts

@@ -61,6 +61,12 @@ export function onDocumentWrittenEffect<
 
   return onDocumentWritten(options, async (event) => {
     const effect = Effect.gen(function* () {
+      yield* Effect.annotateCurrentSpan({
+        document:
+          event.data?.after.ref.path ??
+          event.data?.before.ref.path ??
+          'unknown',
+      });
       const docId = event.data?.after.id ?? event.data?.before.id;
       const beforeData = event.data?.before.data();
       const afterData = event.data?.after.data();
@@ -130,6 +136,12 @@ export function onDocumentWrittenWithAuthContextEffect<
 
   return onDocumentWrittenWithAuthContext(options, async (event) => {
     const effect = Effect.gen(function* () {
+      yield* Effect.annotateCurrentSpan({
+        document:
+          event.data?.after.ref.path ??
+          event.data?.before.ref.path ??
+          'unknown',
+      });
       const docId = event.data?.after.id ?? event.data?.before.id;
       const beforeData = event.data?.before.data();
       const afterData = event.data?.after.data();