fix: Added the new delete confirmation for pages also to delete translation #8111

fsbraun · 2025-01-15T21:15:31Z

Description

#8070 added an improved delete confirmation message for pages. The confirmation message for "delete translation" was kept unchanged. This PR adds the same message for delete translation:

The format is identical to avoid confusion (delete translation will never delete a page)
Implementation collects the code for both the PageAdmin and PageContentAdmin in a common mixin
It respects the need to delete more than one PageContent objects when using versioning.

Backport needed for the last point to the release/4.1.x branch.

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

Standardize the delete confirmation message for pages and translations.

Enhancements:

Use a common mixin to handle delete confirmations for both PageAdmin and PageContentAdmin.
Improve the delete confirmation message for page translations to match the format of the improved message for pages introduced in feat: Improved delete page confirmation message #8070.

…ations

sourcery-ai · 2025-01-15T21:15:35Z

Reviewer's Guide by Sourcery

This pull request improves the delete confirmation message for page translations by using the same message as for deleting pages. It also refactors the code to use a common mixin for both PageAdmin and PageContentAdmin, and handles the deletion of multiple PageContent objects when versioning is enabled.

Sequence diagram for the improved page translation deletion process

sequenceDiagram
    actor Admin
    participant PA as PageContentAdmin
    participant PDM as PageDeleteMessageMixin
    participant PC as PageContent
    participant P as Page
    participant PL as Plugins

    Admin->>PA: Request delete translation
    PA->>PDM: get_deleted_objects()
    PDM-->>PA: Filtered objects to delete

    PA->>PC: Delete page content
    PA->>P: Update page cache
    PA->>PL: Delete associated plugins

    Note over PA,PL: Now handles multiple PageContent objects<br/>when versioning is enabled

    PA-->>Admin: Show success message

Class diagram showing the new PageDeleteMessageMixin inheritance

classDiagram
    class PageDeleteMessageMixin {
      +delete_confirmation_template: str
      +get_deleted_objects(objs, request)
    }
    class PageAdmin {
    }
    class PageContentAdmin {
    }
    class ModelAdmin {
    }
    ModelAdmin <|-- PageAdmin
    ModelAdmin <|-- PageContentAdmin
    PageDeleteMessageMixin <|-- PageAdmin
    PageDeleteMessageMixin <|-- PageContentAdmin
    note for PageDeleteMessageMixin "New mixin for shared delete confirmation logic"

File-Level Changes

Change	Details	Files
Added a common mixin for the delete confirmation message.	Created `PageDeleteMessageMixin` to handle the improved delete confirmation message. Used `PageDeleteMessageMixin` in both `PageAdmin` and `PageContentAdmin`.	`cms/admin/pageadmin.py`
Improved the delete confirmation message for translations.	Standardized the delete confirmation message for both pages and translations. Updated tests to reflect the changes in the confirmation message.	`cms/admin/pageadmin.py` `cms/tests/test_admin.py`
Updated database migration for menus.	Changed the `id` field in the `CacheKey` model to `BigAutoField`.	`menus/migrations/0002_alter_cachekey_id.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.
Generate a pull request title: Write @sourcery-ai anywhere in the pull
request title to generate a 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. You can also use
this command to specify where the summary should be inserted.

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

Contact our support team for questions or feedback.
Visit our documentation for detailed guides and information.
Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

sourcery-ai

Hey @fsbraun - I've reviewed your changes - here's some feedback:

Overall Comments:

There are commented out test assertions in test_delete_translation() - these should either be fixed to match the new behavior or an explanation provided for why they were disabled

Here's what I looked at during the review

🟢 General issues: all looks good
🟢 Security: all looks good
🟡 Testing: 1 issue found
🟢 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.}

cms/tests/test_admin.py

jrief

my team tested all the functionally

….1 (#8112) * backport: Delete translation deletes all page content objects with the page/language combination * fix typo * Fix message action * Update cms/admin/pageadmin.py

docs/upgrade/4.2.0.rst

fsbraun added 2 commits January 15, 2025 22:01

fix: Add consistent delete messages for delete page and delete transl…

75241ea

…ations

fix typo

d046e10

sourcery-ai bot reviewed Jan 15, 2025

View reviewed changes

cms/tests/test_admin.py Outdated Show resolved Hide resolved

Improve tests

db825b9

This was referenced Jan 16, 2025

feat: Re-introduce deleting languages of a page django-cms/djangocms-versioning#443

Merged

chore: Backport the delete translations fix for #8111 to django CMS 4.1 #8112

Merged

fsbraun requested a review from jrief January 16, 2025 17:39

fsbraun added 3 commits January 22, 2025 09:11

Merge branch 'develop-4' into fix/translation-delete

1a8894d

Update spelling in placeholderadmin.py

9e277c3

Fix spelling in 02-templates_placeholders.rst

a30b053

jrief approved these changes Jan 22, 2025

View reviewed changes

fsbraun added 2 commits January 23, 2025 10:32

Merge branch 'develop-4' into fix/translation-delete

f16e2e5

Merge branch 'develop-4' into fix/translation-delete

f729770

fsbraun added the 5.0 label Jan 27, 2025

fsbraun added 2 commits January 28, 2025 13:03

Update message

468cc7f

Update release notes

618f9a2

fsbraun commented Jan 28, 2025

View reviewed changes

docs/upgrade/4.2.0.rst Outdated Show resolved Hide resolved

fsbraun commented Jan 28, 2025

View reviewed changes

docs/upgrade/4.2.0.rst Outdated Show resolved Hide resolved

fsbraun added 3 commits January 28, 2025 22:00

Fix typos

7d1b15b

Update tests

0ac3feb

Merge branch 'develop-4' into fix/translation-delete

352856a

fsbraun merged commit df40666 into django-cms:develop-4 Jan 30, 2025
51 checks passed

fsbraun deleted the fix/translation-delete branch January 30, 2025 11:52

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

fix: Added the new delete confirmation for pages also to delete translation #8111

fix: Added the new delete confirmation for pages also to delete translation #8111

Uh oh!

fsbraun commented Jan 15, 2025 •

edited

Loading

Uh oh!

sourcery-ai bot commented Jan 15, 2025 •

edited

Loading

Interacting with Sourcery

Customizing Your Experience

Getting Help

Uh oh!

sourcery-ai bot left a comment

Uh oh!

Uh oh!

jrief left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

fix: Added the new delete confirmation for pages also to delete translation #8111

fix: Added the new delete confirmation for pages also to delete translation #8111

Uh oh!

Conversation

fsbraun commented Jan 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Related resources

Checklist

Summary by Sourcery

Uh oh!

sourcery-ai bot commented Jan 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer's Guide by Sourcery

Sequence diagram for the improved page translation deletion process

Class diagram showing the new PageDeleteMessageMixin inheritance

File-Level Changes

Interacting with Sourcery

Customizing Your Experience

Getting Help

Uh oh!

sourcery-ai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

jrief left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

fsbraun commented Jan 15, 2025 •

edited

Loading

sourcery-ai bot commented Jan 15, 2025 •

edited

Loading