DX-1797: Add WorkflowMiddleware #97

CahidArda · 2025-05-05T13:34:18Z

Adds WorkflowMiddleware which simplifies tracking steps and their executions. In the initial version, we omit the step results. In the future we can build on top of this middleware.

Already this middleware allows writing a simple Sentry middleware.

Sentry Middleware

import * as Sentry from "@sentry/core";
import { WorkflowMiddleware } from "@upstash/workflow";

export interface SentryMiddlewareOptions {
  disableAutomaticFlush?: boolean;
}

export const sentryMiddleware = (
  opts?: SentryMiddlewareOptions,
): WorkflowMiddleware => {
  const mw = new WorkflowMiddleware({
    name: "upstash-workflow-sentry-middleware",
    init({ workflowRunId }) {
      return Sentry.withIsolationScope((scope) => {
        const sharedTags: Record<string, string | undefined> = {
          "workflow.run.id": workflowRunId,
        };

        scope.setTags(sharedTags);

        let execSpan: Sentry.Span;

        return Sentry.startSpanManual(
          {
            name: "Upstash Workflow Run",
            op: "run",
            attributes: {
              ...sharedTags,
            },
            scope,
          },
          (reqSpan) => {
            return {
              beforeExecution({ stepName }) {
                  Sentry.startSpanManual(
                    {
                      name: "Execution",
                      op: "execution",
                      attributes: {
                        ...sharedTags,
                        "workflow.step.name": stepName,
                      },
                      scope,
                    },
                    (_execSpan) => {
                      execSpan = _execSpan;
                    },
                  );
              },
              afterExecution() {
                execSpan?.end();
              },
              async runCompleted() {
                if (!opts?.disableAutomaticFlush) {
                  await Sentry.flush();
                }
              },
              async onError({ error }) {
                Sentry.withActiveSpan(reqSpan, (scope) => {
                  scope.setTags(sharedTags);
                  scope.setTransactionName(`workflow.run.error`);
                  scope.captureException(error);
                });
              }
            };
          },
        );
    })
    },
  });

  return mw as WorkflowMiddleware;
};

linear · 2025-05-05T13:34:21Z

DX-1797 [POC] Sentry middleware for Workflow

CahidArda added 3 commits May 5, 2025 11:51

feat: add middleware

e03e5d1

feat: add name and workflowRunId params

538c10b

fix: run afterExecution in the same request and add onError

ae40015

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

DX-1797: Add WorkflowMiddleware #97

DX-1797: Add WorkflowMiddleware #97

Uh oh!

Uh oh!

Uh oh!

Uh oh!

DX-1797: Add WorkflowMiddleware #97

Are you sure you want to change the base?

DX-1797: Add WorkflowMiddleware #97

Uh oh!

Conversation

Uh oh!

Uh oh!

Uh oh!