fix: #7633 page global perms 'can_view' unclear admin ui text #8256

wesleyboar · 2025-06-16T21:35:36Z

Description

Clarify misleadingly vague model description.

Important

Status:

Open against release/3.11.X.
Delete new migration.
Add to latest migration in v3.11.x.

— #8256 (comment)

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.

(off of `main` branch)

sourcery-ai · 2025-06-16T21:35:41Z

Reviewer's Guide

This PR refines the semantics of the page-level “can_view” permission by updating its admin help text, adding a migration for the change, and introducing tests to ensure it only grants access to published restricted pages and not to unpublished ones.

Class diagram for updated AbstractPagePermission and PagePermission models

classDiagram
    class AbstractPagePermission {
        +BooleanField can_change_permissions
        +BooleanField can_move_page
        +BooleanField can_view
    }
    note for AbstractPagePermission "can_view: Grants access to published pages with view restrictions. Does not allow viewing unpublished pages."
    class PagePermission {
        +BooleanField can_view
    }
    note for PagePermission "can_view: Grants access to published pages with view restrictions. Does not allow viewing unpublished pages."
    AbstractPagePermission <|-- PagePermission

File-Level Changes

Change	Details	Files
Clarified the “can_view” field’s label and help text to specify its scope.	Renamed label to “can view restricted pages” Expanded help text to state it only applies to published restricted pages and blocks unpublished ones	`cms/models/permissionmodels.py`
Added a migration to apply the updated help text to the database schema.	Created migration 0043 to alter the can_view field’s help_text	`cms/migrations/0043_alter_pagepermission_can_view_help_text.py`
Introduced a test to verify correct can_view behavior on published vs unpublished pages.	Added test_view_permission_behavior to check access on published restricted pages Ensured unpublished pages are not viewable even with can_view	`cms/tests/test_permissions.py`

Assessment against linked issues

Issue	Objective	Addressed	Explanation
#7633	Clarify the meaning of 'View restricted' in the Page Global Permissions admin UI.	✅
#7633	Clarify the meaning of 'frontend view restriction' in the Page Global Permissions admin UI.	✅
#7633	Address the unclear error message 'Edit permissions required' when creating a Page Global Permission.	❌	The PR does not address the error message 'Edit permissions required'.

Possibly linked issues

[BUG] Admin UI Text in Page Global Permissions is Unclear #7633: The PR clarifies the 'View restricted' label and 'frontend view restriction' help text for the 'can_view' permission as described in the issue by updating the text and adding a migration.
[BUG] Admin UI Text in Page Global Permissions is Unclear #7633: PR updates 'can_view' permission help text and adds migration to clarify its behavior.

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

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 @wesleyboar - I've reviewed your changes - here's some feedback:

Please remove the “Generated by AI (Claude Sonnet 3.5)” header from the migration file to keep the commit history clean.
Now that the changes are complete, you can delete or update the “[!IMPORTANT] Incomplete” note in the PR description.

Prompt for AI Agents

Please address the comments from this code review:
## Overall Comments
- Please remove the “Generated by AI (Claude Sonnet 3.5)” header from the migration file to keep the commit history clean.
- Now that the changes are complete, you can delete or update the “[!IMPORTANT] Incomplete” note in the PR description.

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.}

wesleyboar · 2025-06-16T23:58:49Z

In response to @sorcery-ai:

Please remove the “Generated by AI (Claude Sonnet 3.5)” header from the migration file to keep the commit history clean.

Not unless a human says so, because the comment has purpose.

Other migrations have comment that they were auto-generated, so I think this was should explain how it was generated.

❌ The PR does not address the error message 'Edit permissions required'.

I suggest we not require that be addressed, because it is working as intended.

It's annoying to stumble through the error, but (1) I have not found a built in field-value-dependency mechanism in Django, (2) building a one-off with JavaScript seems like overkill, and (3) something like that would "best" be done by Django or Django CMS as a new feature any admin form could use.

fsbraun · 2025-06-17T05:45:51Z

@wesleyboar Thanks for clarifying and creating this! This clearly is v3 code - as of v4, no publishing logic is available in django CMS' core. Tests will fail :-(

Can I suggest the following:

Reopen against release/3.11.x
After approval, let us agree on the desired behavior on v4+
dCA creates the ports for v4 and v5

Now, django CMS 3.11 must not contain new migrations. Since you only change the label and help text of model fields, the corresponding migration is a database no-op. I suggest updating the latest relevant one instead of creating a new one.

wesleyboar · 2025-06-17T17:10:10Z

Excellent. Makes sense.* Tasks added. PR converted to draft.

* Does it, though? Yes; see notes for self.

The comment indicates that the pull request contains code written for Django CMS v3, which assumes publishing logic exists in the core ("each published page in the CMS exists in as two cms.Page instances: public and draft"). Since v4 removed this core publishing functionality and moved it to external packages like djangocms-versioning, any tests or code that relies on the old v3 publishing system will fail when run against v4+.

wesleyboar added 4 commits June 16, 2025 20:55

fix: django-cms#7633 global page perms unclear admin ui text

d40a466

(off of `main` branch)

fix: django-cms#7633 admin ui text migrations

4a1a641

fix: django-cms#7633 admin ui text migrations

a7119c6

test: django-cms#7633 page global perms 'can_view'

b0d27ef

wesleyboar mentioned this pull request Jun 16, 2025

fix: #7633 unclear admin ui text for page global perms #8255

Closed

test: django-cms#7633 fix permission name

e1abe4b

wesleyboar mentioned this pull request Jun 16, 2025

[BUG] Admin UI Text in Page Global Permissions is Unclear #7633

Open

1 task

wesleyboar marked this pull request as ready for review June 16, 2025 23:38

sourcery-ai bot reviewed Jun 16, 2025

View reviewed changes

wesleyboar marked this pull request as draft June 17, 2025 17:07

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

fix: #7633 page global perms 'can_view' unclear admin ui text #8256

fix: #7633 page global perms 'can_view' unclear admin ui text #8256

Uh oh!

wesleyboar commented Jun 16, 2025 •

edited

Loading

Uh oh!

sourcery-ai bot commented Jun 16, 2025 •

edited

Loading

Interacting with Sourcery

Customizing Your Experience

Getting Help

Uh oh!

sourcery-ai bot left a comment

Uh oh!

wesleyboar commented Jun 16, 2025

Uh oh!

fsbraun commented Jun 17, 2025

Uh oh!

wesleyboar commented Jun 17, 2025 •

edited

Loading

Uh oh!

Uh oh!

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Uh oh!

fix: #7633 page global perms 'can_view' unclear admin ui text #8256

Are you sure you want to change the base?

fix: #7633 page global perms 'can_view' unclear admin ui text #8256

Uh oh!

Conversation

wesleyboar commented Jun 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Related resources

Checklist

Uh oh!

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

Uh oh!

Reviewer's Guide

Class diagram for updated AbstractPagePermission and PagePermission models

File-Level Changes

Assessment against linked issues

Possibly linked issues

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!

wesleyboar commented Jun 16, 2025

Uh oh!

fsbraun commented Jun 17, 2025

Uh oh!

wesleyboar commented Jun 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

wesleyboar commented Jun 16, 2025 •

edited

Loading

sourcery-ai bot commented Jun 16, 2025 •

edited

Loading

wesleyboar commented Jun 17, 2025 •

edited

Loading