feat(Watermark): update logic to prevent errors #5791
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
Contributor
Reviewer's Guide by SourceryThis pull request enhances the watermark component by addressing potential errors and improving its visibility. It includes a null check to prevent errors when accessing class lists and increases the z-index to ensure the watermark is displayed above other elements. Sequence diagram for updating the watermarksequenceDiagram
participant MutationObserver
participant DOM
participant Watermark
MutationObserver->>DOM: Detects removed nodes
DOM->>MutationObserver: Returns removed nodes
MutationObserver->>DOM: Checks if dom.classList exists
alt dom.classList exists
MutationObserver->>DOM: Checks if removed node has class 'bb-watermark-bg'
DOM->>MutationObserver: Returns true if class exists
MutationObserver->>Watermark: Calls createWatermark(watermark)
Watermark->>DOM: Creates and adds watermark to DOM
else dom.classList does not exist
MutationObserver->>MutationObserver: Skips watermark creation
end
File-Level Changes
Assessment against linked issues
Possibly linked issues
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Hey @ArgoZhang - I've reviewed your changes - here's some feedback:
Overall Comments:
- Consider adding a comment explaining why the z-index was increased to 9999.
Here's what I looked at during the review
- 🟡 General issues: 1 issue found
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
| for (const record of records) { | ||
| for (const dom of record.removedNodes) { | ||
| if (dom.classList.contains('bb-watermark-bg')) { | ||
| if (dom.classList && dom.classList.contains('bb-watermark-bg')) { |
Contributor
There was a problem hiding this comment.
suggestion (bug_risk): Added null-check for classList enhances robustness.
The additional check prevents runtime errors when 'dom' may not have a classList. Ensure similar checks are applied if there are other DOM manipulations that assume element properties.
Suggested implementation:
if (div && div.style && div.classList) {
div.style.opacity = '1';
div.style.position = 'absolute';
div.style.inset = '0';
div.style.zIndex = '9999';
div.classList.add("bb-watermark-bg");
} let mark;
if (el && typeof el.querySelector === 'function') {
mark = el.querySelector('.bb-watermark-bg');
}If there are any other places in this file (or related files) where DOM properties are accessed without checking for null (or property existence), similar conditional checks are recommended.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #5791 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 658 658
Lines 30056 30056
Branches 4243 4243
=========================================
Hits 30056 30056 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
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.
Link issues
fixes #5790
Summary By Copilot
This pull request includes several changes to the
src/BootstrapBlazor/Components/Watermark/Watermark.razor.jsfile to improve the watermark functionality. The most important changes are as follows:Improvements to watermark handling:
updateWatermarkfunction: Added a check to ensuredom.classListis not null before callingcontainsto prevent potential errors.Adjustments to z-index values:
createWatermarkfunction: Increased thez-indexvalue from999to9999to ensure the watermark is displayed above other elements.monitorfunction: Updated thez-indexcheck from999to9999to match the newz-indexvalue set increateWatermark.Regression?
Risk
Verification
Packaging changes reviewed?
☑️ Self Check before Merge
Summary by Sourcery
Update watermark component to improve error handling and z-index positioning
Bug Fixes:
Enhancements: