Skip to content

Conversation

@nchaourar
Copy link
Contributor

@nchaourar nchaourar commented Jul 20, 2025

Hello just a quick PR to fix the CarouselSlidePlugin url generation.

The URL returned was a json object '{'internal_link': 'cms.page:2', 'cache': '/real/url'}' instead of the real URL.
I think it was just a small oversight in the code due to a refactoring 4 month ago (490f018).

Summary by Sourcery

Bug Fixes:

  • Correct the CarouselSlidePlugin’s link rendering to output the actual URL instead of a JSON object by renaming the context key to mixin_link and adjusting templates accordingly

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Jul 20, 2025

Reviewer's Guide

This PR corrects URL rendering for the CarouselSlidePlugin by unifying the context key to mixin_link and updating related templates to reference mixin_link instead of the old link key, ensuring real URLs are output.

Class diagram for CarouselSlidePlugin context changes

classDiagram
    class CarouselSlidePlugin {
        +render(context, instance, placeholder)
        - context["link"]
        + context["mixin_link"]
    }
Loading

File-Level Changes

Change Details Files
Use mixin_link for URL in render context
  • Replace context['link'] assignment with context['mixin_link'] in render method
  • Assign instance.get_link() to mixin_link
djangocms_frontend/contrib/carousel/frameworks/bootstrap5.py
Update carousel slide template to reference mixin_link
  • Change opening anchor tag condition to use mixin_link
  • Bind href attribute to mixin_link
  • Change closing anchor tag condition to use mixin_link
djangocms_frontend/contrib/carousel/templates/djangocms_frontend/bootstrap5/carousel/default/slide.html
Adjust link template to use mixin_link for wrap conditions
  • Use mixin_link for opening condition and href
  • Use mixin_link for closing condition
djangocms_frontend/contrib/link/templates/djangocms_frontend/bootstrap5/link/default/link.html

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

@codecov
Copy link

codecov bot commented Jul 21, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 89.01%. Comparing base (a518608) to head (a314b92).
⚠️ Report is 26 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #293   +/-   ##
=======================================
  Coverage   89.01%   89.01%           
=======================================
  Files         124      124           
  Lines        3385     3385           
  Branches      288      288           
=======================================
  Hits         3013     3013           
  Misses        254      254           
  Partials      118      118           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@fsbraun
Copy link
Member

fsbraun commented Jul 21, 2025

@nchaourar Nice catch! This probably got through undetected since we do not test the link functionality in tests.carousel.test_plugins. Do you think you can add a test that check a link is preserved? It can easily be an external link for simplicity (see, e.g., tests.link.test_plugins).

Copy link
Member

@fsbraun fsbraun left a comment

Choose a reason for hiding this comment

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

Nice!

@fsbraun fsbraun merged commit 91bd664 into django-cms:main Jul 24, 2025
21 checks passed
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.

2 participants