Skip to content

fix: Migration error with cms.0027_title_placeholders_data_migration #8249

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
Jun 18, 2025
Merged

fix: Migration error with cms.0027_title_placeholders_data_migration #8249

merged 4 commits into from
Jun 18, 2025

Conversation

jmit-modern
Copy link
Contributor

@jmit-modern jmit-modern commented Jun 5, 2025 •
edited by sourcery-ai bot
Loading

fix #8243: Migration error with cms.0027_title_placeholders_data_migration

  • 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:

  • Add .only("pk") to the placeholder queryset in the 0027 migration to prevent loading unsupported fields during data migration.

@sourcery-ai Sourcery AI
Copy link
Contributor

sourcery-ai bot commented Jun 5, 2025 •
edited
Loading

Reviewer's Guide

The PR updates the 0027 migration by adding a .only("pk") clause to the placeholder QuerySet, restricting loaded fields to the primary key and preventing migration errors when annotating plugin counts.

Sequence Diagram: Optimized Placeholder Query in Migration 0027

sequenceDiagram
    participant MS as "Migration Script (0027_title_placeholders_data_migration.py)"
    participant ORM as "Django ORM"
    participant DB as "Database"

    MS->>ORM: Build QuerySet for Old Placeholders with .only("pk"):
    Note right of ORM: Query includes: <br/> .filter(pk__in=old_placeholder_ids) <br/> .annotate(plugin_count=models.Count('cmsplugin')) <br/> .only("pk")
    ORM->>DB: Execute SQL Query (Optimized to select only 'pk' and aggregated 'plugin_count')
    DB-->>ORM: Return results (primary keys and plugin_count for each)
    ORM-->>MS: Provide QuerySet with Placeholder objects (only 'pk' field loaded from DB + 'plugin_count' annotation)
Loading

File-Level Changes

Change Details Files
Limit fields loaded in the placeholder QuerySet
  • Inserted .only("pk") after the .annotate(plugin_count=…) call
 cms/migrations/0027_title_placeholders_data_migration.py

Assessment against linked issues

Issue Objective Addressed Explanation
#8243 Fix the migration error in cms.0027_title_placeholders_data_migration when upgrading from django CMS v3.11.1 to v5.1.0, specifically the django.db.utils.ProgrammingError related to the GROUP BY clause. ✅

Possibly linked issues

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 Jun 5, 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 Jun 5, 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 @jmit-modern - 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.

@fsbraun fsbraun added the needs to be backported Commits need to be backported label Jun 18, 2025
@fsbraun fsbraun merged commit fc5b68c into django-cms:main Jun 18, 2025
64 checks passed
fsbraun added a commit that referenced this pull request Jun 18, 2025
@jmit-modern @vkeni @fsbraun
add only('pk') where to get old_placeholders (#8249)
b5b7f30 
Co-authored-by: keni <v-keni@kexp.org>
Co-authored-by: Fabian Braun <fsbraun@gmx.de>
fsbraun added a commit that referenced this pull request Jun 18, 2025
@jmit-modern @vkeni @fsbraun
add only('pk') where to get old_placeholders (#8249)
bcf7f89 
Co-authored-by: keni <v-keni@kexp.org>
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
needs to be backported Commits need to be backported
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[BUG] 5.0.1: Migration error with cms.0027_title_placeholders_data_migration
3 participants
@jmit-modern @fsbraun @vkeni