8000 fix: Placeholder page getter failed for unpublished pages (#8115) by fsbraun · Pull Request #8124 · django-cms/django-cms · GitHub
[go: up one dir, main page]
Skip to content

fix: Placeholder page getter failed for unpublished pages (#8115) #8124

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 1 commit into from
Jan 30, 2025
Merged

fix: Placeholder page getter failed for unpublished pages (#8115) #8124

merged 1 commit into from
Jan 30, 2025

Conversation

fsbraun
Copy link
Member
@fsbraun fsbraun commented Jan 29, 2025 •
edited by sourcery-ai bot
Loading

  • Fix: Placeholder page getter fails for unpublished pages

  • Update cms/models/placeholdermodel.py

  • Update cms/models/placeholdermodel.py

Description

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.

Summary by Sourcery

Bug Fixes:

  • Fix an issue where the placeholder page getter would fail for unpublished pages.

@fsbraun
fix: Placeholder page getter failed for unpublished pages (django-cms…
dde308c 
…#8115)

* Fix: Placeholder page getter fails for unpublished pages

* Update cms/models/placeholdermodel.py

* Update cms/models/placeholdermodel.py
@sourcery-ai Sourcery AI
Copy link
Contributor
sourcery-ai bot commented Jan 29, 2025 •
edited
Loading

Reviewer's Guide by Sourcery

The placeholder page getter was failing for unpublished pages. This change fixes the issue by using the PageContent model to get the page associated with the placeholder.

Sequence diagram for placeholder page getter

sequenceDiagram
    participant Placeholder
    participant PageContent
    participant Page

    Placeholder->>PageContent: admin_manager.filter(placeholders=self)
    PageContent->>PageContent: select_related('page')
    PageContent->>Placeholder: first().page
    Note over Placeholder: Returns None if no page found
    Note over Placeholder: Works for both published and unpublished pages
Loading

Class diagram showing the relationship between Placeholder and Page models

classDiagram
    class Placeholder {
        +page_getter()
    }
    class PageContent {
        +admin_manager
        +placeholders
        +page
    }
    class Page {
    }

    Placeholder "*" -- "1" PageContent
    PageContent "*" -- "1" Page
    note for Placeholder "Now uses PageContent as intermediary
to fetch associated Page"
Loading

File-Level Changes

Change Details Files
Fixed placeholder page getter for unpublished pages.
  • Changed from using the Page model to using the PageContent model to get the page associated with the placeholder.
  • Added a filter to get the page content associated with the placeholder.
  • Used select_related to optimize the query.
  • Used .first() to get the first page associated with the placeholder.
  • Added an AttributeError exception to handle cases where no page is found.
 cms/models/placeholdermodel.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!
  • 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 Jan 29, 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:

  • Consider using more specific error handling instead of catching AttributeError, which could mask other potential issues. The original exceptions (DoesNotExist, MultipleObjectsReturned) were more explicit about what could go wrong.
  • Since this changes error handling behavior, please add tests to verify the placeholder page getter works correctly for both published and unpublished pages.
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.

@fsbraun fsbraun merged commit baa722d into django-cms:release/4.1.x Jan 30, 2025
93 of 94 checks passed
@fsbraun fsbraun deleted the fix/backport-8115 branch January 30, 2025 06:20
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

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

Successfully merging this pull request may close these issues.
1 participant
@fsbraun
0