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: resolve the issue of dynamic component URL errors when using relative path scripts in materials. #958

Merged
merged 1 commit into from
Jan 13, 2025

Conversation

BWrong
Copy link
Contributor

@BWrong BWrong commented Dec 25, 2024

English | 简体中文

PR fix: 修复在物料使用相对路径的script时,动态导入组件url报错问题

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 URL handling for script loading, particularly when executed within an iframe.

Copy link
Contributor

coderabbitai bot commented Dec 25, 2024

Walkthrough

The pull request modifies the dynamicImportComponents function in the utils.js file to improve URL handling, particularly when the code is executed within an iframe. A new href variable is introduced to retrieve the parent window's location URL or default to the current location's URL. This ensures that the scriptUrl is constructed using the correct base URL, addressing potential issues with dynamic component imports across different browsing contexts.

Changes

File Change Summary
packages/canvas/common/src/utils.js Modified dynamicImportComponents function to use a new href variable for determining the base URL when constructing scriptUrl

Possibly related PRs

Suggested labels

bug, refactor-main

Suggested reviewers

  • hexqi
  • chilingling

Poem

🐰 In the realm of iframes wide,
A rabbit's code takes a clever stride
URL hunting with grace and might
Fixing imports, making things right!
Dynamic components now sing true
A coding dance, a rabbit's view 🌐

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. We would love to hear your feedback on Discord.


📜 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 7716dda and 2324b31.

📒 Files selected for processing (1)
  • packages/canvas/common/src/utils.js (1 hunks)
🔇 Additional comments (1)
packages/canvas/common/src/utils.js (1)

65-66: Use consistent fallback strategy for URL retrieval

It’s great that you have addressed the issue by defaulting to window.parent.location.href or location.href. However, please consider how window.parent.location.href behaves when the current window is not in an iframe or if window.parent is cross-origin. For cross-origin situations, accessing window.parent.location.href may throw an exception. Also, if the code is not in an iframe, window.parent typically references the same window object, so this fallback might effectively be redundant.

Consider verifying these scenarios in your testing strategy to ensure no runtime error is thrown in cross-origin iframes or top-level windows, and that the expected href is used.


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 bug Something isn't working refactor-main refactor/develop branch feature labels Dec 25, 2024
@hexqi hexqi added this to the v2.2.0 milestone Jan 13, 2025
@hexqi hexqi changed the title fix: 修复在物料使用相对路径的script时,动态导入组件url报错问题 fix: resolve the issue of dynamic component URL errors when using relative path scripts in materials. Jan 13, 2025
@hexqi hexqi merged commit a5ebe01 into opentiny:refactor/develop Jan 13, 2025
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working refactor-main refactor/develop branch feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants