Skip to content
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

fix(plugins/materials): fix new app with no page should not set url page id to undefined #1061

Conversation

rhlin
Copy link
Collaborator

@rhlin rhlin commented Jan 22, 2025

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?

空应用(没有页面的应用)会跳 pageid=undefined, 导致解析器认为pageid是undefined,会去查询pageid为'undefined'相关的内容

Issue Number: N/A

What is the new behavior?

如果没有pageid就跳url

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

Summary by CodeRabbit

  • New Features

    • Enhanced page navigation functionality with improved URL handling and history management.
  • Bug Fixes

    • Refined page initialization process to ensure more precise location tracking and history updates.

Copy link
Contributor

coderabbitai bot commented Jan 22, 2025

Walkthrough

The pull request modifies the useResource.js file by introducing a new goPage(pageId) function that updates the browser's URL with a pageid query parameter and triggers a location history change. The change shifts the URL update and history change logic from a finally block to a more direct execution path within the initPage function, improving the control flow for handling page navigation and status updates.

Changes

File Change Summary
packages/plugins/materials/src/composable/useResource.js Added goPage(pageId) function to update URL and post location history change

Sequence Diagram

sequenceDiagram
    participant User
    participant Page
    participant Browser
    
    User->>Page: Trigger page navigation
    Page->>Page: initPage()
    Page->>Page: goPage(pageId)
    Page->>Browser: Update URL with pageid
    Page->>Page: Post location history change
Loading

Possibly related PRs

Suggested labels

bug

Suggested reviewers

  • hexqi
  • chilingling

Poem

🐰 A rabbit's tale of pages new,
Where URLs dance and histories brew,
With goPage hopping swift and light,
Changing paths with digital might,
A navigation journey true! 🌐


📜 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 448cc75 and 302e4c4.

📒 Files selected for processing (1)
  • packages/plugins/materials/src/composable/useResource.js (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • packages/plugins/materials/src/composable/useResource.js
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: push-check

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 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. (Beta)
  • @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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 3

🧹 Nitpick comments (1)
packages/plugins/materials/src/composable/useResource.js (1)

41-55: Consider architectural improvements for better maintainability.

The current implementation mixes URL management with page initialization logic. Consider these architectural improvements:

  1. Create a dedicated URL management service
  2. Add explicit error handling for edge cases
  3. Document the fallback behavior

Example structure:

// urlService.ts
interface URLService {
  setPageId(pageId: string | undefined): void;
  getPageId(): string | undefined;
}

// pageService.ts
interface PageService {
  initPage(pageInfo: PageInfo): void;
  handleEmptyPage(): void;
}

This separation would make the code more maintainable and easier to test. Would you like me to help with this refactoring?

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between dd8ae42 and 448cc75.

📒 Files selected for processing (1)
  • packages/plugins/materials/src/composable/useResource.js (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: push-check

@hexqi hexqi added this to the v2.2.0 milestone Jan 23, 2025
@hexqi hexqi merged commit 5162ab4 into opentiny:release/v2.2.0 Jan 23, 2025
2 checks passed
hexqi pushed a commit to hexqi/tiny-engine that referenced this pull request Jan 25, 2025
@coderabbitai coderabbitai bot mentioned this pull request Jan 26, 2025
14 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants