refactor: modify the default homepage path loaded from the preference…

[aonoa]

complete issues 5659

Description

Type of change

Please delete options that are not relevant.

• Bug fix (non-breaking change which fixes an issue)

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 default home page path is now configurable through application preferences, allowing for greater customization.

• Documentation

  • Updated guides and documentation to describe the new defaultHomePath preference and its usage.

• Refactor

  • Replaced all usages of a fixed default home path constant with a dynamic value from user preferences across all relevant modules.
  • Removed the previously used constant for the default home path from the codebase.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 5f707c6

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[coderabbitai]

Important

Review skipped

Review was skipped due to path filters

⛔ Files ignored due to path filters (1)

• packages/@core/preferences/__tests__/__snapshots__/config.test.ts.snap is excluded by !**/*.snap

CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including **/dist/** will override the default block on the dist directory, by removing the pattern from both the lists.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

This change refactors the handling of the application's default home path across multiple projects and packages. The previously used constant DEFAULT_HOME_PATH is removed from the codebase and replaced with a new, configurable property defaultHomePath within the preferences.app object. All references to the old constant in routing guards, route definitions, and authentication logic are updated to use this new preference-based value. Documentation and type definitions are also updated to reflect the new property, and the constant is removed from the constants package.

Changes

Files	Change Summary
apps/web-antd/src/router/guard.ts, apps/web-ele/src/router/guard.ts, apps/web-naive/src/router/guard.ts, playground/src/router/guard.ts	Replaced all usage of DEFAULT_HOME_PATH with preferences.app.defaultHomePath in access guard logic.
apps/web-antd/src/router/routes/core.ts, apps/web-ele/src/router/routes/core.ts, apps/web-naive/src/router/routes/core.ts, playground/src/router/routes/core.ts	Updated root route redirect from DEFAULT_HOME_PATH to preferences.app.defaultHomePath.
apps/web-antd/src/store/auth.ts, apps/web-ele/src/store/auth.ts, apps/web-naive/src/store/auth.ts, playground/src/store/auth.ts	Changed post-login fallback redirect from DEFAULT_HOME_PATH to preferences.app.defaultHomePath.
packages/@core/preferences/src/config.ts	Added defaultHomePath: '/analytics' to the app section of defaultPreferences.
packages/@core/preferences/src/types.ts	Added defaultHomePath: string to the AppPreferences interface.
docs/src/en/guide/essentials/settings.md, docs/src/guide/essentials/settings.md	Documented new defaultHomePath property in preferences and updated AppPreferences interface.
packages/constants/src/core.ts	Removed the exported DEFAULT_HOME_PATH constant.
packages/constants/README.md	Updated usage example to remove DEFAULT_HOME_PATH and use LOGIN_PATH instead.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Router
    participant Preferences
    participant AuthStore

    User->>Router: Initiates login or accesses root route
    Router->>Preferences: Retrieve app.defaultHomePath
    Preferences-->>Router: Return defaultHomePath (e.g., '/analytics')
    Router->>AuthStore: Complete login or redirect logic
    AuthStore->>Router: Use preferences.app.defaultHomePath for redirect
    Router->>User: Redirects user to default home path

Loading

Suggested reviewers

• anncwb
• jinmao88

Poem

Oh, the path to home is now set free,
No longer bound by constancy!
With preferences to guide our way,
Each user finds their own new day.
The code hops forward, neat and bright—
🐇 A rabbit’s joy in every byte!
/analytics awaits, just out of sight.

---

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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in 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.