8000 fix: Async support and middleware update for django CMS 4.2+ by fsbraun · Pull Request #8147 · django-cms/django-cms · GitHub
[go: up one dir, main page]
Skip to content

fix: Async support and middleware update for django CMS 4.2+ #8147

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 4 commits into from
Feb 19, 2025
Merged

fix: Async support and middleware update for django CMS 4.2+ #8147

merged 4 commits into from
Feb 19, 2025

Conversation

fsbraun
Copy link
Member
@fsbraun fsbraun commented Feb 17, 2025 •
edited
Loading

Description

This PR removes the use of the compatibility MiddlewareMixin which is a tool to migrate old-style middleware to new-style middleware.

Except user middleware (which sets affects the current thread) all middlewares should in principle support async calls.

Related resources

Checklist

  • I have opened this pull request against develop-4
  • I have added or modified the tests when changing logic
  • I have followed the conventional commits guidelines to add meaningful information into the changelog
  • I have read the contribution guidelines and I have joined the channel #pr-reviews on our Discord Server to find a “pr review buddy” who is going to review my pull request.

@sourcery-ai Sourcery AI
Copy link
Contributor
sourcery-ai bot commented Feb 17, 2025 •
edited by fsbraun
Loading

Reviewer's Guide by Sourcery

This pull request removes the MiddlewareMixin class from several CMS middlewares to ensure compatibility with Django's asynchronous request handling in django CMS 4.2+. The affected middlewares are ToolbarMiddleware, ApphookReloadMiddleware, LanguageCookieMiddleware, CurrentPageMiddleware, and CurrentUserMiddleware. The CurrentUserMiddleware is marked as not async capable.

Updated class diagram for ToolbarMiddleware

classDiagram
  class ToolbarMiddleware {
    +__init__(get_response)
    +is_edit_mode(request)
    +process_request(request)
    +process_response(request, response)
    +__call__(request)
    +__acall__(request)
  }
Loading

Updated class diagram for ApphookReloadMiddleware

classDiagram
  class ApphookReloadMiddleware {
    +__init__(get_response)
    +__call__(request)
    +__acall__(request)
  }
Loading

Updated class diagram for LanguageCookieMiddleware

classDiagram
  class LanguageCookieMiddleware {
    +__init__(get_response)
    +__call__(request)
    +__acall__(request)
    +process_response(request, response)
  }
Loading

Updated class diagram for CurrentPageMiddleware

classDiagram
  class CurrentPageMiddleware {
    +__init__(get_response)
    +__call__(request)
    +__acall__(request)
  }
Loading

Updated class diagram for CurrentUserMiddleware

classDiagram
  class CurrentUserMiddleware {
    +async_capable
    +__init__(get_response)
    +__call__(request)
  }
Loading

File-Level Changes

Change Details Files
Removed MiddlewareMixin and updated middleware structure for asynchronous compatibility.
  • Removed inheritance from MiddlewareMixin.
  • Added a constructor __init__ that accepts get_response.
  • Added a __call__ method to process standard requests.
  • Added an __acall__ method to process asynchronous requests.
  • Adjusted the call to super().__init__() in the constructor.
 cms/middleware/toolbar.py
cms/middleware/utils.py
cms/middleware/language.py
cms/middleware/page.py
Updated CurrentUserMiddleware to be compatible with the new middleware structure.
  • Removed inheritance from MiddlewareMixin.
  • Added a constructor __init__ that accepts get_response.
  • Added a __call__ method to process standard requests.
  • Set async_capable = False.
 cms/middleware/user.py
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 8000 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!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

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

sourcery-ai[bot]
sourcery-ai bot reviewed Feb 17, 2025
View reviewed changes
Copy link
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 @fsbraun - I've reviewed your changes - here's some feedback:

Overall Comments:

  • It looks like you've removed MiddlewareMixin and added __call__ and __acall__ methods to support both synchronous and asynchronous requests, which is great. However, you're calling self.process_request and self.process_response in both __call__ and __acall__. Consider if these methods need to be async as well.
  • The CurrentUserMiddleware has async_capable = False, but the other middlewares don't. Should this be explicitly set to True on the other middlewares?
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good
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.

@vinitkumar
Copy link
Member
vinitkumar 8000 commented Feb 18, 2025

@fsbraun This is some great work. Thank you. Looks good, merging it.

@fsbraun fsbraun merged commit 693e910 into develop-4 Feb 19, 2025
64 checks passed
@fsbraun fsbraun deleted the backport/async-middleware branch February 19, 2025 06:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sourcery-ai sourcery-ai[bot] sourcery-ai[bot] left review comments

@vinitkumar vinitkumar vinitkumar approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@fsbraun @vinitkumar @jbazik
0