Skip to content

Update roadmap for middleware tasks#78

Merged
leynos merged 3 commits intomainfrom
codex/implement-middleware-architecture
Jun 19, 2025
Merged

Update roadmap for middleware tasks#78
leynos merged 3 commits intomainfrom
codex/implement-middleware-architecture

Conversation

@leynos
Copy link
Copy Markdown
Owner

@leynos leynos commented Jun 19, 2025

Summary

  • flesh out middleware tasks in the project roadmap

Testing

  • mdformat-all docs/roadmap.md
  • markdownlint docs/roadmap.md
  • nixie docs/roadmap.md
  • make fmt
  • make lint
  • make test

https://chatgpt.com/codex/tasks/task_e_6853ec69352483229239a0438a93587d

Summary by Sourcery

Update the project roadmap to add detailed middleware implementation, testing, and documentation tasks

Documentation:

  • Flesh out middleware roadmap with ServiceRequest/ServiceResponse wrappers, Next helper, and from_fn helper
  • Add tests for middleware to verify request modification and response observation
  • Clarify middleware registration order and wrap chain execution behavior
  • Include a logging example in the middleware use cases documentation

Summary by CodeRabbit

  • Documentation
    • Expanded and clarified the roadmap with more detailed subtasks for middleware and extractors.
    • Added clearer descriptions of middleware implementation steps and registration order.
    • Included an explicit example for logging middleware in the documentation.

@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai Bot commented Jun 19, 2025

Reviewer's Guide

Expanded the middleware tasks section in docs/roadmap.md with detailed subtasks outlining wrapper types, helper functions, test requirements, execution ordering, and usage examples.

Class diagram for planned middleware types and helpers

classDiagram
    class ServiceRequest {
    }
    class ServiceResponse {
    }
    class Next {
        +call(request: ServiceRequest): ServiceResponse
    }
    class Middleware {
        <<interface>>
        +call(request: ServiceRequest, next: Next): ServiceResponse
    }
    class Transform {
        <<trait>>
        +new_service(): Service
    }
    class Service {
        <<trait>>
        +call(request: ServiceRequest): ServiceResponse
    }
    class FromFn {
        +from_fn(fn): Middleware
    }
    ServiceRequest <.. Next
    ServiceResponse <.. Next
    Middleware <|.. FromFn
    Transform <|.. Middleware
    Middleware <|.. Service
    Next --> Middleware
Loading

Flow diagram for updated middleware execution order

flowchart TD
    A[Register middleware with WireframeApp::wrap] --> B[Build middleware chain around handlers]
    B --> C[Last registered middleware runs first on requests]
    B --> D[Last registered middleware runs first on responses]
    C --> E[Handler executes]
    D --> E
Loading

Flow diagram for middleware test requirements

flowchart TD
    A[Write tests for middleware] --> B[Verify middleware can modify requests]
    A --> C[Verify middleware can observe responses]
Loading

Flow diagram for middleware usage example documentation

flowchart TD
    A[Document common middleware use cases] --> B[Logging]
    A --> C[Authentication]
    B --> D[Include logging example using from_fn]
Loading

File-Level Changes

Change Details Files
Flesh out middleware implementation details in the roadmap
  • Define ServiceRequest/ServiceResponse wrappers and introduce Next helper for async chaining
  • Add a from_fn helper for functional middleware
  • Include tests to verify middleware can modify requests and inspect responses
  • Clarify middleware registration order so the last wrapped runs first on requests and first on responses
  • Add a logging example using from_fn in the documentation
docs/roadmap.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

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jun 19, 2025

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The roadmap documentation for middleware and extractors was expanded with more detailed subtasks. Middleware implementation was broken down into finer-grained tasks, clarifying the order of middleware registration and enhancing documentation requirements. No changes were made to code or exported entities.

Changes

File(s) Change Summary
docs/roadmap.md Expanded middleware and extractor roadmap sections with detailed subtasks, clarified registration order, and added logging example requirements.

Possibly related PRs

Suggested reviewers

  • codescene-delta-analysis

Poem

In the warren of docs, a roadmap grew,
With middleware plans, now clearer to view.
Tasks split like carrots, each with a role,
From wrappers to logging, all under control.
With clarity hopping, the journey’s begun,
The path for new features now neatly spun!
🥕

✨ Finishing Touches
🧪 Generate Unit Tests
  • Create PR with Unit Tests
  • Post Copyable Unit Tests in Comment
  • Commit Unit Tests in branch codex/implement-middleware-architecture

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai auto-generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

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 @leynos - 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.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 3

📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c09669d and 45da367.

📒 Files selected for processing (1)
  • docs/roadmap.md (1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/roadmap.md

[uncategorized] ~94-~94: Use a comma before ‘so’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... and build the chain around handlers so the last registered middleware runs fir...

(COMMA_COMPOUND_SENTENCE_2)

⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: build-test

Comment thread docs/roadmap.md Outdated
Comment thread docs/roadmap.md
Comment thread docs/roadmap.md
@leynos leynos merged commit d98121b into main Jun 19, 2025
5 checks passed
@leynos leynos deleted the codex/implement-middleware-architecture branch June 19, 2025 14:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant