fix: watermark settings in the preferences modified accidentally

[mynetfan]

Description

修复水印偏好设置被意外修改的问题。

fixed: #5817

Type of change

Please delete options that are not relevant.

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• This change requires a documentation update
• Please, don't make changes to pnpm-lock.yaml unless you introduce a new test example.

Checklist

ℹ️ Check all checkboxes - this will indicate that you have done everything in accordance with the rules in CONTRIBUTING.

• If you introduce new functionality, document it. You can run documentation with pnpm run docs:dev command.
• Run the tests with pnpm test.
• Changes in changelog are generated from PR name. Please, make sure that it explains your changes in an understandable manner. Please, prefix changeset messages with feat:, fix:, perf:, docs:, or chore:.
• My code follows the style guidelines of this project
• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• I have added tests that prove my fix is effective or that my feature works
• New and existing unit tests pass locally with my changes
• Any dependent changes have been merged and published in downstream modules

Summary by CodeRabbit

• New Features

  • The watermark now displays both your username and real name for improved user identification.

• Chores

  • Enhanced lifecycle management to ensure the watermark is properly removed when needed.
  • Removed redundant preference updates associated with watermark activation and deactivation.

[coderabbitai]

Walkthrough

The pull request updates the watermark content in several layout files to combine the username with the user’s real name. In addition, it removes updatePreferences calls from the watermark hook and introduces an onBeforeMount lifecycle hook in one layout to clear the watermark based on preference settings. These changes adjust the displayed user information and modify the watermark update control flow without altering the overall application structure.

Changes

File(s)	Changes Summary
apps/web-antd/src/layouts/basic.vue, apps/web-ele/src/layouts/basic.vue, apps/web-naive/src/layouts/basic.vue	Updated the watermark update in the watch function to use the combined string ${username} - ${realName} instead of just the username.
playground/src/.../basic.vue	Updated the watermark content string as above and added an onBeforeMount hook to check preferences and destroy the watermark if enabled.
packages/effects/hooks/src/use-watermark.ts	Removed calls to updatePreferences that previously indicated watermark activation and deactivation.

Sequence Diagram(s)

sequenceDiagram
    participant Component as Playground Component
    participant Pref as Preferences
    participant Watermark as Watermark Service

    Component->>Pref: Check if watermark enabled
    alt Watermark enabled
        Component->>Watermark: destroyWatermark()
    end
    Component->>Component: Generate watermark string (${username} - ${realName})
    Component->>Watermark: updateWatermark(updated string)

Loading

Assessment against linked issues

Objective	Addressed	Explanation
Fix watermark bug (#5817)	✅

Possibly related PRs

• fix: adjust useWatermark logic #4896: Modifies the watermark content update to include the user's real name alongside the username.

Suggested labels

bug

Suggested reviewers

• anncwb
• vince292007

Poem

I'm a rabbit with a code-filled cheer,
Hopping through changes, I hold them dear.
Updated watermarks now proudly display,
Both name and nick in a bright array.
Bugs scurry off as improvements bloom,
In this code garden, joy finds room!
🥕🐇

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between df6341f and e36df4b.

📒 Files selected for processing (5)

• apps/web-antd/src/layouts/basic.vue (1 hunks)
• apps/web-ele/src/layouts/basic.vue (1 hunks)
• apps/web-naive/src/layouts/basic.vue (1 hunks)
• packages/effects/hooks/src/use-watermark.ts (0 hunks)
• playground/src/layouts/basic.vue (3 hunks)

💤 Files with no reviewable changes (1)

• packages/effects/hooks/src/use-watermark.ts

⏰ Context from checks skipped due to timeout of 90000ms (4)

• GitHub Check: Lint (windows-latest)
• GitHub Check: Check (windows-latest)
• GitHub Check: post-update (windows-latest)
• GitHub Check: post-update (ubuntu-latest)

🔇 Additional comments (6)

apps/web-antd/src/layouts/basic.vue (1)

113-113: Improved watermark content display

The change enhances the watermark by showing both username and real name, providing better user identification in the watermark. This is part of standardizing the watermark display across all UI implementations.

apps/web-ele/src/layouts/basic.vue (1)

113-113: Improved watermark content display

The change enhances the watermark by showing both username and real name, providing better user identification in the watermark. This is part of standardizing the watermark display across all UI implementations.

apps/web-naive/src/layouts/basic.vue (1)

114-114: Improved watermark content display

The change enhances the watermark by showing both username and real name, providing better user identification in the watermark. This is part of standardizing the watermark display across all UI implementations.

playground/src/layouts/basic.vue (3)

4-4: Added onBeforeMount to imports

Added the onBeforeMount lifecycle hook to the imports to support the new initialization logic for watermark handling.

---

129-129: Improved watermark content display

The change enhances the watermark by showing both username and real name, providing better user identification in the watermark. This is part of standardizing the watermark display across all UI implementations.

---

140-144: Added initialization to prevent accidental watermark preference changes

This onBeforeMount hook ensures that any existing watermark is cleaned up when the component initializes, preventing potential issues with watermark preferences being accidentally modified. This addresses the core issue described in the PR by ensuring consistent watermark behavior.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.