fix: page API modification

[lu-yg]

English | 简体中文

PR

PR Checklist

Please check if your PR fulfills the following requirements:

• The commit message follows our Commit Message Guidelines
• Tests for the changes have been added (for bug fixes / features)
• Docs have been added / updated (for bug fixes / features)
• Built its own designer, fully self-validated

PR Type

What kind of change does this PR introduce?

• Bugfix
• Feature
• Code style update (formatting, local variables)
• Refactoring (no functional changes, no api changes)
• Build related changes
• CI related changes
• Documentation content changes
• Other... Please describe:

Background and solution

What is the current behavior?

Issue Number: N/A

What is the new behavior?

Does this PR introduce a breaking change?

• Yes
• No

Other information

Summary by CodeRabbit

• New Features
  • Page updates now accept an optional flag to designate a default page.
• Refactor
  • Streamlined the handling of default pages to improve update reliability.
• Bug Fixes
  • Updated error messages for default page modifications in both English and Chinese for clearer feedback.

[coderabbitai]

Walkthrough

The pull request updates the page update functionality by integrating a new optional property named isDefault. This property is now included in the parameters picked and validated in the controller, interface, and validation rule. The pages service is refactored by removing an extra parameter from the protectDefaultPage method and introducing two helper methods (getParentPage and getSubPage) to better manage default page protection. Additionally, minor formatting improvements and import ordering adjustments have been made, and the error messages in the locale configuration files have been updated.

Changes

File(s)	Change Summary
app/controller/app-center/pages.ts, app/lib/interface.ts, app/validate/app-center/pages.ts	Expanded update parameters to include isDefault (added property in interface, controller, and validation rules); minor formatting adjustments and import reordering applied.
app/service/app-center/pages.ts	Refactored protectDefaultPage by removing the id parameter; added protected methods getParentPage and getSubPage to streamline default page protection logic; updated comments and formatting.
config/locale/en-US.json, config/locale/zh-CN.json	Updated error message for key CM301 to indicate that modifying the default page has failed rather than being prohibited.

Sequence Diagram(s)

sequenceDiagram
    participant Controller as PagesController
    participant Service as PagesService
    participant DB as Database

    Controller->>Service: updatePage(pageInfo with isDefault)
    Service->>Service: protectDefaultPage(pageInfo)
    alt Sub-page exists
        Service->>Service: getParentPage(parentId)
        Service->>Service: getSubPage(parentId)
        Service->>DB: update sub-page (set isDefault: false)
        DB-->>Service: update result
    else No sub-page found
        Service-->>Service: Return true
    end
    Service-->>Controller: Return update result

Loading

Poem

I'm a bunny in this code-filled glen,
Hopping through functions again and again.
"isDefault" now joins our parade,
With helper methods cleverly made.
Leaping over bugs with a joyful spin,
I nibble on changes with a playful grin!

---

📜 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 df4b0d9 and 124ae18.

📒 Files selected for processing (1)

• app/service/app-center/pages.ts (9 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• app/service/app-center/pages.ts

---

🪧 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 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.