feat: add placeholder-level error handling #8118
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Reviewer's Guide by SourceryThis pull request refactors error handling when rendering placeholders. It introduces a try-except block to catch exceptions during plugin rendering and template rendering, and logs the error. It also adds a visual representation of the error in the CMS when in edit mode. Sequence diagram for placeholder error handling flowsequenceDiagram
participant CMS as CMS System
participant Renderer as ContentRenderer
participant Plugin as Plugin Instance
participant Template as Template Engine
participant Logger as Error Logger
CMS->>Renderer: render_placeholder()
activate Renderer
Renderer->>Plugin: render_plugin()
activate Plugin
alt Successful rendering
Plugin-->>Renderer: rendered content
else Exception occurs
Plugin-->>Renderer: throws exception
Renderer->>Logger: log error
alt Edit mode active
Renderer-->>CMS: error visualization
else Production mode
alt CATCH_PLUGIN_500_EXCEPTION enabled
Renderer-->>CMS: empty content
else
Renderer-->>CMS: re-raise exception
end
end
end
deactivate Plugin
deactivate Renderer
Class diagram for renderer error handlingclassDiagram
class BaseRenderer {
+render_placeholder()
+render_plugin()
}
class ContentRenderer {
+render_exception(action, context, placeholder, editable)
+render_placeholder()
+render_plugin()
}
class StructureRenderer {
+render_placeholder()
+render_plugin()
}
class LegacyRenderer {
+render_placeholder()
+get_editable_placeholder_context()
}
BaseRenderer <|-- ContentRenderer
BaseRenderer <|-- StructureRenderer
ContentRenderer <|-- LegacyRenderer
note for ContentRenderer "New error handling logic"
File-Level Changes
Assessment against linked issues
Possibly linked issues
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
|
@florianschieder Please comment. |
|
Looks good on a first glance 👍 |
vinitkumar
approved these changes
Jan 27, 2025
@fsbraun Looks great! Thank you very much for the helpful solution! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
fixes #7974
Since django CMS 4, exceptions that happen during plugin rendering have been caught and displayed a message at the plugin's position.
After feedback from the community, this PR refactors error handling when rendering placeholders.
.
Exceptions are now caught on placeholder level.
In edit mode, a message about the exception is shown for the placeholder. If
settings.DEBUG == Truethis message includes the full Django trace.Editors still can edit plugins causing the exception. It can be edited by double-clicking the error message or through the structure board.
In preview mode and on site, the placeholder containing the plugin will render empty.
If
settings.CMS_CATCH_PLUGIN_500_EXCEPTIONis set toFalse, trying to view content that raises an exception will trigger a server error (http 500). Preview and edit modes will still work.Screenshot
This is a full error message in edit mode and with
DEBUG = True. The plugin with pk 35 caused a division by zero exception. It can be edited by double-clicking the red error message. Toolbar and structure board are available.The same warning message on a production system is shorter:
Related resources
Checklist
develop-4Summary by Sourcery
Bug Fixes: