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: preview page breadcrumb don't exist useBlock method and preview block error when type undefined #988

Merged
merged 2 commits into from
Jan 2, 2025

Conversation

chilingling
Copy link
Member

@chilingling chilingling commented Jan 2, 2025

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

  • Bug Fixes
    • Improved error handling for block retrieval to prevent potential runtime issues with safer method access.
    • Adjusted property type handling to ensure accurate representation when generating props.

Sorry, something went wrong.

Verified

This commit was signed with the committer’s verified signature. The key has expired.
Copy link
Contributor

coderabbitai bot commented Jan 2, 2025

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 eslint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

packages/vue-generator/src/generator/vue/sfc/generateScript.js

Oops! Something went wrong! :(

ESLint: 8.57.1

Error: Cannot read config file: /packages/vue-generator/.eslintrc.cjs
Error: Cannot find module '@rushstack/eslint-patch/modern-module-resolution'
Require stack:

  • /packages/vue-generator/.eslintrc.cjs
  • /node_modules/.pnpm/@eslint+eslintrc@2.1.4/node_modules/@eslint/eslintrc/dist/eslintrc.cjs
  • /node_modules/.pnpm/eslint@8.57.1/node_modules/eslint/lib/cli-engine/cli-engine.js
  • /node_modules/.pnpm/eslint@8.57.1/node_modules/eslint/lib/eslint/eslint.js
  • /node_modules/.pnpm/eslint@8.57.1/node_modules/eslint/lib/eslint/index.js
  • /node_modules/.pnpm/eslint@8.57.1/node_modules/eslint/lib/cli.js
  • /node_modules/.pnpm/eslint@8.57.1/node_modules/eslint/bin/eslint.js
    at Module._resolveFilename (node:internal/modules/cjs/loader:1248:15)
    at Module._load (node:internal/modules/cjs/loader:1074:27)
    at TracingChannel.traceSync (node:diagnostics_channel:315:14)
    at wrapModuleLoad (node:internal/modules/cjs/loader:217:24)
    at Module.require (node:internal/modules/cjs/loader:1339:12)
    at require (node:internal/modules/helpers:135:16)
    at Object. (/packages/vue-generator/.eslintrc.cjs:4:1)
    at Module._compile (node:internal/modules/cjs/loader:1546:14)
    at Module._extensions..js (node:internal/modules/cjs/loader:1691:10)
    at Module.load (node:internal/modules/cjs/loader:1317:32)

Walkthrough

The pull request modifies the currentBlock computed property in a Vue component's setup function. The change introduces optional chaining when accessing the getCurrentBlock method from the useBlock utility, enhancing the robustness of block retrieval by preventing potential runtime errors if the method or its parent object is undefined. Additionally, it updates the defaultGenPropsHook function in generateScript.js to include a conditional check when assigning property types, ensuring accurate representation of potentially undefined types.

Changes

File Change Summary
packages/toolbars/breadcrumb/src/Main.vue Updated currentBlock computed property to use optional chaining for safer method access.
packages/vue-generator/src/generator/vue/sfc/generateScript.js Modified defaultGenPropsHook to conditionally assign propType based on the truthiness of type.

Possibly related PRs

Suggested labels

ready_for_review

Suggested reviewers

  • yy-wow

Poem

🐰 In the code where blocks reside,
Optional chaining is our guide.
With types that may not always show,
We handle them gently, to and fro.
Hopping through Vue, with joy we sing,
Safe and sound, let the changes ring! 🌟


📜 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 0d725a0 and c80583b.

📒 Files selected for processing (1)
  • packages/vue-generator/src/generator/vue/sfc/generateScript.js (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • packages/vue-generator/src/generator/vue/sfc/generateScript.js

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.

@github-actions github-actions bot added the bug Something isn't working label Jan 2, 2025
@chilingling chilingling changed the title fix: preview breadcrumb don't exist useBlock method fix: preview page breadcrumb don't exist useBlock method Jan 2, 2025
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: 0

🧹 Nitpick comments (1)
packages/toolbars/breadcrumb/src/Main.vue (1)

80-80: Consider providing a fallback or logging for undefined block references

While optional chaining safely prevents runtime errors if useBlock or getCurrentBlock returns undefined, you might have scenarios where the absence of a block warrants additional handling or at least a log message to aid in troubleshooting. As a good practice, consider returning an empty object or logging a warning to ensure that such cases are visible during development.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between d30593a and 8fb3e9b.

📒 Files selected for processing (1)
  • packages/toolbars/breadcrumb/src/Main.vue (1 hunks)

@hexqi hexqi changed the title fix: preview page breadcrumb don't exist useBlock method fix: preview page breadcrumb don't exist useBlock method and preview block error when type undefined Jan 2, 2025

Verified

This commit was signed with the committer’s verified signature.
hexqi Hexqi
@hexqi hexqi force-pushed the fix/previewBreadcrumb branch from 0d725a0 to c80583b Compare January 2, 2025 09:09
@hexqi hexqi merged commit 3e63170 into opentiny:release/v2.1.0 Jan 2, 2025
2 checks passed
chilingling added a commit that referenced this pull request Jan 3, 2025

Unverified

This commit is not signed, but one or more authors requires that any commit attributed to them is signed.
…block error when type undefined (#988)

* fix: preview breadcrumb don't exist useBlock method

* fix: resolve block preview error when type is undefined

---------

Co-authored-by: hexqi <wu_12556@126.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants