Skip to content

feat(Watermark): add protected logic #5135

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

Merged
merged 5 commits into from
Jan 17, 2025
Merged

feat(Watermark): add protected logic #5135

merged 5 commits into from
Jan 17, 2025

Conversation

ArgoZhang
Copy link
Collaborator

@ArgoZhang ArgoZhang commented Jan 17, 2025

add protected logic

Summary of the changes (Less than 80 chars)

简单描述你更改了什么, 不超过80个字符;如果有关联 Issue 请在下方填写相关编号

Description

fixes #5134

Regression?

  • Yes
  • No

[If yes, specify the version the behavior has regressed from]

[是否影响老版本]

Risk

  • High
  • Medium
  • Low

[Justify the selection above]

Verification

  • Manual (required)
  • Automated

Packaging changes reviewed?

  • Yes
  • No
  • N/A

☑️ Self Check before Merge

⚠️ Please check all items below before review. ⚠️

  • Doc is updated/provided or not needed
  • Demo is updated/provided or not needed
  • Merge the latest code from the main branch

Summary by Sourcery

Add logic to protect watermarks from being removed.

New Features:

  • Added a feature to protect watermarks from being removed.

Tests:

  • Added unit tests to verify the watermark protection logic.

@bb-auto bb-auto bot added the enhancement New feature or request label Jan 17, 2025
@bb-auto bb-auto bot added this to the v9.2.0 milestone Jan 17, 2025
Copy link
Contributor

sourcery-ai bot commented Jan 17, 2025

Reviewer's Guide by Sourcery

This pull request implements protected logic for the Watermark component to prevent unauthorized removal or modification. It does this by periodically monitoring the watermark element and restoring it if any changes are detected.

Sequence diagram for Watermark protection monitoring

sequenceDiagram
    participant W as Watermark Component
    participant M as Monitor Function
    participant RAF as RequestAnimationFrame

    W->>M: Start monitoring
    activate M
    M->>M: Check watermark integrity
    alt Watermark modified
        M->>W: Clear watermark
        W->>W: Recreate watermark
    else Watermark intact
        M->>RAF: Schedule next check
        RAF-->>M: Next frame
    end
    deactivate M
Loading

State diagram for Watermark protection checks

stateDiagram-v2
    [*] --> Monitoring
    Monitoring --> CheckingProperties: Monitor tick
    CheckingProperties --> Compromised: Invalid properties detected
    CheckingProperties --> Monitoring: All properties valid
    Compromised --> Monitoring: Watermark restored

    state CheckingProperties {
        [*] --> CheckDisplay
        CheckDisplay --> CheckOpacity
        CheckOpacity --> CheckPosition
        CheckPosition --> CheckInset
        CheckInset --> CheckZIndex
        CheckZIndex --> CheckBackgroundProps
        CheckBackgroundProps --> [*]
    }
Loading

File-Level Changes

Change Details Files
Added logic to monitor and restore the watermark if it is modified or removed by external scripts or user interactions.
  • Added a monitor function that checks the watermark's styles and attributes.
  • Added a clearWatermark function to remove the watermark and disconnect the observer.
  • Added logic to recreate the watermark if any of its properties are modified.
  • Modified the createWatermark function to call the monitor function after creating the watermark.
  • Stored the watermark options and observer in the watermark object for later use in the monitor and clearWatermark functions.
  • Fixed a floating-point precision issue in the background size calculation by using toFixed(3).
src/BootstrapBlazor/Components/Watermark/Watermark.razor.js

Assessment against linked issues

Issue Objective Addressed Explanation
#5134 Add protected logic to the Watermark component

Possibly linked issues


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

@ArgoZhang ArgoZhang merged commit 6980608 into main Jan 17, 2025
3 checks passed
@ArgoZhang ArgoZhang deleted the feat-watermark branch January 17, 2025 04:06
Copy link

codecov bot commented Jan 17, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (cf6aaab) to head (7b98a16).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #5135   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          634       634           
  Lines        28181     28181           
  Branches      4040      4040           
=========================================
  Hits         28181     28181           

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

feat(Watermark): add protected logic
1 participant