Pass Custom Context to afterOperation Hook

[wp99cp]

I try to set up instrumentation through OpenTelemetry and want to wrap all calls to payload with a span. I imagine a setup as follows, where we construct a new span in the beforeOperation hook and end the span in the afterOperation hook. If the request failed, we handle that within the afterError hook.

However, to achieve this, I would need to pass the span via context to the afterOperation hook, but this is not possible. Is there a reason why the custom context is not passed to the afterOperation hook? Custom context is available in most of the other hooks and would be ideal for that use case.

As an alternative, I could use the req.context; however, this leads to issues where a single request executes multiple payload operations, which is commonly the case for the admin panel.

Example Usecase

const otelBeforeOperation: CollectionBeforeOperationHook = ({
  collection,
  operation,
  req,
  context,
}) => {
    const span: Span = tracer.startSpan(`payload.${collection.slug}.${operation}`);
};

const otelAfterOperation: CollectionAfterOperationHook = ({ context, result }) => {
  const span = context['span'] as Span | undefined;
  if (span === undefined) return;
  span.setStatus({ code: SpanStatusCode.OK });
  span.end();
  return result;
};

const otelAfterError: CollectionAfterErrorHook = ({ error, context }) => {
  const span = context['span'] as Span | undefined;
  if (span === undefined) return;
  span.recordException(error);
  span.setStatus({ code: SpanStatusCode.ERROR, message: error.message });
};

/**
 *
 * Usage:
 * const instrumentedCollection = asInstrumentalCollection(originalCollectionConfig);
 *
 */
export const asInstrumentalCollection = (config: CollectionConfig): CollectionConfig => {
  return {
    ...config, // we keep most of the original collection configuration

    hooks: {
      // Spread any existing hooks from the original config
      ...config.hooks,

      // Add OpenTelemetry hooks, ensuring they don't overwrite existing hooks.
      beforeOperation: [otelBeforeOperation, ...(config.hooks?.beforeOperation ?? [])],
      afterOperation: [...(config.hooks?.afterOperation ?? []), otelAfterOperation],
      afterError: [...(config.hooks?.afterError ?? []), otelAfterError],
    },
  };
};