10000 fix: replace outdated usage of `page__node__path` with `page__path` by PeterW-LWL · Pull Request #8238 · django-cms/django-cms · GitHub
[go: up one dir, main page]
Skip to content

fix: replace outdated usage of page__node__path with page__path #8238

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 3 commits into from
May 26, 2025
Merged

fix: replace outdated usage of page__node__path with page__path #8238

merged 3 commits into from
May 26, 2025

Conversation

PeterW-LWL
Copy link
Contributor
@PeterW-LWL PeterW-LWL commented May 22, 2025 •
edited by sourcery-ai bot
Loading

Description

I noticed that there was still a usage of the removed node in a order_by of a query.

Related resources

Checklist

  • I have opened this pull request against main
  • 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.

Summary by Sourcery

Bug Fixes:

  • Replace outdated page__node__path reference with page__path in query ordering.

@sourcery-ai Sourcery AI
Copy link
Contributor
sourcery-ai bot commented May 22, 2025 •
edited
Loading

Reviewer's Guide

Replaced deprecated page__node__path ordering with the updated page__path field in the placeholder slots query, ensuring compatibility with the removed node reference.

Class Diagram: Models Involved in Page Path Ordering Update

classDiagram
    class Title {
        <<Model>>
        +page: Page
        +get_placeholder_slots(): List~string~
    }
    class Page {
        <<Model>>
        +path: string
    }
    Title "1" -- "1" Page : page_relationship
Loading

Flow Diagram: Change in Data Access Logic for Page Path

graph TD
    subgraph "Old Data Access Path for Ordering"
        direction LR
        OldQuery["Title.get_placeholder_slots() Query"] --> OldPage["Page object"]
        OldPage --".node (page__node)"--> OldNode["Node object"]
        OldNode --".path"--> OldPathValue["Path string"]
    end

    subgraph "New Data Access Path for Ordering"
        direction LR
        NewQuery["Title.get_placeholder_slots() Query"] --> NewPage["Page object"]
        NewPage --".path (page__path)"--> NewPathValue["Path string"]
    end
Loading

File-Level Changes

Change Details Files
Updated ordering field in ancestor titles query
  • Replaced .order_by("-page__node__path") with .order_by("-page__path")
 cms/models/contentmodels.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 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

github-actions[bot]
github-actions bot reviewed May 22, 2025
View reviewed changes
Copy link
@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Hello! Thank you for your contribution! 🎉

As it's your first contribution, be sure to check out the contribution docs.

We invite you to join us on our Discord Server!

Welcome aboard ⛵️!

sourcery-ai[bot]
sourcery-ai bot reviewed May 22, 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 @PeterW-LWL - I've reviewed your changes and they look great!

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.

@PeterW-LWL PeterW-LWL changed the title replace outdated usage of page__node__path with page__path fix: replace outdated usage of page__node__path with page__path May 22, 2025
@fsbraun
Copy link
Member
fsbraun commented May 22, 2025

Great catch, @PeterW-LWL !

get_placeholder_slots() apparently is not tested when inheriting templates. Do you think you can add a regression test in cms.tests.test_templates?

@PeterW-LWL
Copy link
Contributor Author
PeterW-LWL commented May 22, 2025 •
edited
Loading

@fsbraun I have no idea how I would recreate that. It seems I can't even reproduce the bug in the running instance that I have with version 5.0.1

The bug happened while I was creating the first page of a newly created instance via the admin.

Edit:

I was able to recreate the bug locally now.
I forgot to set the CMS_TEMPLATE in my settings.py.

@fsbraun
Copy link
Member
fsbraun commented May 22, 2025

@PeterW-LWL Maybe the best way is to add

   @override_settings(
            CMS_PLACEHOLDERS=(
                ("nav_playground.html", ("right-column", "body"), "Nav placeholders"),
                ("col_two.html", ("left-column", "right-column"), "Col Two placeholders"),
            ),
            CMS_TEMPLATES=[],  # CMS_PLACEHOLDERS is only effective if no templates are present
        )
    def test_placeholder_slot_inheritance_magic_with_three_levels_of_inheritance_inherits_from_grandparent(self):
        admin_user = self.get_superuser()
        grandparent_page = create_page("grandparent-page", "nav_playground.html", "en", created_by=admin_user)
        parent_page = create_page(
            "parent-page", TEMPLATE_INHERITANCE_MAGIC, "en", created_by=admin_user, parent=grandparent_page
        )
        child_page = create_page("child-page", "col_two.html", "en", created_by=admin_user, parent=parent_page)

        parent_slots = parent_page.get_content_obj("en").get_placeholder_slots()
        child_slots = child_page.get_content_obj("en").get_placeholder_slots()

        self.assertEqual(parent_slots, ("right-column", "body"))
        self.assertEqual(child_slots, ("left-column", "right-column"))

in cms.tests.test_admin in after lines 437? The test is a bit tricky, since the placeholder slots are only evaluated if not templates are defined.

@PeterW-LWL
Copy link
Contributor Author

@fsbraun I added a test case based on your suggestion. This case will error out on the current main branch. But with the fix in the first commit of this PR it will pass.

fsbraun
fsbraun approved these changes May 26, 2025
View reviewed changes
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.

LGTM! Thanks for the great work!

@fsbraun fsbraun merged commit 3baa44a into django-cms:main May 26, 2025
64 checks passed
fsbraun added a commit that referenced this pull request May 26, 2025
@PeterW-LWL @fsbraun
fix: replace outdated usage of page__node__path with page__path (#…
a9105a7 
…8238)

* fix: replace outdated usage of `page__node__path` with `page__path`

* add test case for `PageContent.get_placeholder_slots()` with empty `CMS_TEMPLATES` setting

---------

Co-authored-by: Fabian Braun <fsbraun@gmx.de>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@github-actions github-actions[bot] github-actions[bot] left review comments

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

@fsbraun fsbraun fsbraun 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.
2 participants
@PeterW-LWL @fsbraun
0