Skip to content

Async local storage example as CLS replacement#1018

Open
marleystipich2 wants to merge 1 commit intomasterfrom
async-local-storage-example
Open

Async local storage example as CLS replacement#1018
marleystipich2 wants to merge 1 commit intomasterfrom
async-local-storage-example

Conversation

@marleystipich2
Copy link
Copy Markdown
Collaborator

@marleystipich2 marleystipich2 commented Mar 11, 2026

Summary by Sourcery

Migrate the request-scoped context implementation from express-http-context/CLS to Node.js AsyncLocalStorage while keeping the existing cls API surface intact.

Enhancements:

  • Replace express-http-context, cls-bluebird, and Sequelize CLS usage with an AsyncLocalStorage-based implementation that preserves the existing middleware and getReq interface.
  • Simplify cls.patchMiddleware now that AsyncLocalStorage automatically propagates context without manual binding.
  • Remove express-http-context usage from the main routing setup in favor of the new AsyncLocalStorage-backed cls middleware.

Documentation:

  • Add a detailed AsyncLocalStorage migration guide explaining the rationale, required code changes, and verification steps.

@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai bot commented Mar 11, 2026

Reviewer's Guide

Replaces the custom CLS/express-http-context-based request context handling with Node.js AsyncLocalStorage, removes related middleware wiring, and adds a migration guide documenting the change and its rationale.

Sequence diagram for AsyncLocalStorage-based request context access

sequenceDiagram
    actor Client
    participant ExpressApp
    participant CLSMiddleware
    participant RouteHandler
    participant CLSUtil
    participant AsyncLocalStorage

    Client->>ExpressApp: HTTP request
    ExpressApp->>CLSMiddleware: middleware(req, res, next)
    CLSMiddleware->>AsyncLocalStorage: run({ req }, next)
    activate AsyncLocalStorage
    AsyncLocalStorage-->>RouteHandler: invoke next within context
    deactivate AsyncLocalStorage

    RouteHandler->>CLSUtil: getReq()
    CLSUtil->>AsyncLocalStorage: getStore()
    AsyncLocalStorage-->>CLSUtil: { req }
    CLSUtil-->>RouteHandler: req
    RouteHandler-->>Client: HTTP response
Loading

File-Level Changes

Change Details Files
Replace express-http-context/CLS integration with AsyncLocalStorage-based request storage.
  • Remove express-http-context, cls-bluebird, Bluebird, and Sequelize CLS initialization from the CLS utility module.
  • Introduce a shared AsyncLocalStorage instance and use it in the CLS middleware to wrap each request with a context object containing req.
  • Update getReq helper to read req from the AsyncLocalStorage store and handle missing context safely.
  • Simplify patchMiddleware to return the original middleware function without manual binding since AsyncLocalStorage propagates context automatically.
src/util/cls.js
Align routing setup with new CLS implementation and drop express-http-context middleware.
  • Remove express-http-context import from the routes setup.
  • Stop registering express-http-context middleware while keeping cls.middleware in the Express app pipeline.
src/routes.js
Add documentation describing the AsyncLocalStorage migration and its impact.
  • Create a detailed migration guide explaining the switch from cls-hooked/express-http-context to AsyncLocalStorage, including code before/after, rationale, transactional behavior analysis, and testing steps.
  • Document optional package.json cleanup to remove now-unused CLS-related dependencies in a follow-up change.
ASYNC_LOCAL_STORAGE_MIGRATION.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Copy Markdown
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@marleystipich2 marleystipich2 force-pushed the async-local-storage-example branch from 04c2cc0 to aab8d63 Compare March 11, 2026 15:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant