fix: Avoid downcasting of text-enabled child plugins if plugins are already downcasted

[fsbraun]

Summary by Sourcery

Fix the downcasting of text-enabled child plugins.

Bug Fixes:

• Prevent unnecessary downcasting of plugins when they are already downcasted.

Enhancements:

• Improve type hinting in multiple utility functions.

Tests:

• Update tests to reflect changes in plugin handling.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request addresses an issue where text-enabled child plugins were being unnecessarily downcasted, even when they were already downcasted. This was causing issues with rendering and editing of child plugins. The changes ensure that downcasting is only performed when necessary, improving the overall stability and performance of the text plugin.

Sequence diagram for plugin rendering with optimized downcasting

sequenceDiagram
    participant Editor
    participant TextPlugin
    participant PluginRenderer
    participant ChildPlugins

    Editor->>TextPlugin: Request render plugin
    TextPlugin->>PluginRenderer: plugin_tags_to_html()
    alt Child plugins already downcasted
        PluginRenderer->>ChildPlugins: Use existing instances
    else Child plugins not downcasted
        PluginRenderer->>ChildPlugins: Get plugins from text
        ChildPlugins-->>PluginRenderer: Return downcasted plugins
    end
    PluginRenderer-->>TextPlugin: Return rendered HTML
    TextPlugin-->>Editor: Display rendered content

Loading

Class diagram showing updated function signatures

classDiagram
    class utils {
        +_render_cms_plugin(plugin: CMSPlugin, context)
        +random_comment_exempt(view_func: callable): callable
        +plugin_to_tag(obj: CMSPlugin, content: str, admin: bool)
        +_plugin_tags_to_html(text: str, output_func: callable, child_plugin_instances: Optional[list[CMSPlugin]]): str
        +plugin_tags_to_user_html(text: str, context: Context, child_plugin_instances: list[CMSPlugin]): str
        +plugin_tags_to_admin_html(text: str, context: Context, child_plugin_instances: list[CMSPlugin]): str
        +plugin_tags_to_db(text: str): str
        +replace_plugin_tags(text: str, id_dict, regex: str): str
    }
    note for utils "Added type hints and new child_plugin_instances parameter"

Loading

Flow diagram of plugin rendering process

flowchart TD
    A[Start Render] --> B{Child plugins provided?}
    B -->|Yes| C[Use existing instances]
    B -->|No| D[Get plugins from text]
    C --> E[Render plugins]
    D --> E
    E --> F[Convert to HTML]
    F --> G[Return rendered content]
    G --> H[End Render]

Loading

File-Level Changes

Change	Details	Files
Avoid downcasting of text-enabled child plugins if plugins are already downcasted	Modified _plugin_tags_to_html to accept an optional child_plugin_instances argument. Modified plugin_tags_to_user_html and plugin_tags_to_admin_html to pass the child_plugin_instances to _plugin_tags_to_html. Modified plugin_tags_to_db to pass None as child_plugin_instances to _plugin_tags_to_html. Added type hints to function definitions.	djangocms_text/utils.py
Pass child plugin instances to the rendering functions	Modified get_form_class to pass child_plugin_instances to plugin_tags_to_admin_html. Modified render to pass child_plugin_instances to plugin_tags_to_admin_html and plugin_tags_to_user_html.	djangocms_text/cms_plugins.py
Update test cases to reflect changes in rendering functions	Modified _replace_plugin_contents to pass None as child_plugin_instances to _plugin_tags_to_html. Modified test_change_form_has_rendered_plugin_content to pass None as child_plugin_instances to plugin_tags_to_admin_html. Removed print statement from test_user_cant_edit_child_plugins_directly. Cast the result of TextPlugin.get_child_plugin_candidates to a list in test cases.	tests/test_plugin.py
Removed unnecessary reload of the browser on cms-content-refresh event	Commented out the line that reloads the browser on cms-content-refresh event.	private/js/cms.editor.js

---

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

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

• Please add a comment explaining why it's now safe to remove the browser reload call in cms.editor.js. This will help future maintainers understand the change.

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 ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 81.40%. Comparing base (223150b) to head (94abd47).
Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main      #58      +/-   ##
==========================================
+ Coverage   81.28%   81.40%   +0.11%     
==========================================
  Files          17       17              
  Lines         935      941       +6     
  Branches      104      105       +1     
==========================================
+ Hits          760      766       +6     
  Misses        132      132              
  Partials       43       43              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.