Skip to content
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.

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

fix: incompatibility with djangocms-versioning-filer 1.3 was fixed #1509

Conversation

fscherf
Copy link
Contributor

@fscherf fscherf commented Nov 25, 2024

When used with djangocms-versioning-filer, the FileAdminChangeForm might not have a file field due to missing permissions.
Since djangocms-versioning-filer 1.3 the constructor of FileAdminChangeForm crashes when opening the change URL of a published image.

This patch fixes this issue by adding a check whether the file field is present before overriding it.

Description

Checklist

  • I have opened this pull request against master
  • 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 #workgroup-pr-review on
    Slack to find a “pr review buddy” who is going to review my pull request.

Summary by Sourcery

Fix compatibility issue with djangocms-versioning-filer 1.3 by ensuring the FileAdminChangeForm does not crash when the file field is missing due to permissions.

Bug Fixes:

  • Fix crash in FileAdminChangeForm constructor when used with djangocms-versioning-filer 1.3 by checking for the presence of the file field before overriding it.

Tests:

  • Modify tests to accommodate the logic change in FileAdminChangeForm.

When used with djangocms-versioning-filer, the `FileAdminChangeForm` might not
have a file field due to missing permissions.
Since djangocms-versioning-filer 1.3 the constructor of `FileAdminChangeForm`
crashes when opening the change URL of a published image.

This patch fixes this issue by adding a check whether the file field is present
before overriding it.

Signed-off-by: Florian Scherf <[email protected]>
Copy link
Contributor

sourcery-ai bot commented Nov 25, 2024

Reviewer's Guide by Sourcery

This PR fixes a compatibility issue with djangocms-versioning-filer 1.3 by adding a conditional check before modifying the file field widget in the FileAdminChangeForm. The change prevents the form from crashing when the file field is not present due to missing permissions.

Class diagram for FileAdminChangeForm modification

classDiagram
    class FileAdminChangeForm {
        +__init__(*args, **kwargs)
        +clean()
    }
    note for FileAdminChangeForm "Added conditional check for 'file' field presence before setting widget"
Loading

File-Level Changes

Change Details Files
Added a defensive check before modifying the file field widget
  • Added a conditional check to verify if 'file' exists in form fields
  • Only set the FileInput widget when the file field is present
filer/admin/fileadmin.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

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 @fscherf - 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 merged commit 91a382d into django-cms:master Dec 6, 2024
34 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants