Skip to content

Conversation

@wenmine
Copy link
Collaborator

@wenmine wenmine commented Aug 15, 2024

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?

在处理内部iframe时,发现存在问题,会直接访问openFilePicker报错,需要修改

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
    • Enhanced support detection for filesystem access with a new function that improves maintainability and consistency.
  • Bug Fixes
    • Clarified variable naming in the download link process for better readability, without affecting functionality.
  • Improvements
    • Updated error messaging in the filesystem access functions to reflect a broader context of unsupported environments.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Aug 15, 2024

Walkthrough

Recent changes enhance the clarity and maintainability of the filesystem utility code. The saveAs function's variable name was updated for clarity, while the isSupportFileSystemAccess was transitioned from a boolean to a function. This new function encapsulates checks for filesystem access support, streamlining related functions and ensuring consistency. Overall, these updates simplify the code and reduce redundancy.

Changes

File Summary
.../fs/fszip.js Renamed variable zipLink to downloadLink in saveAs function for clarity.
.../fs/index.js Changed isSupportFileSystemAccess from a boolean to a function; updated related functions to use the new approach, enhancing code clarity and maintainability.

Poem

🐰 In the code where rabbits play,
Clarity hops in, brightening the day!
A link renamed, a check refined,
Now our functions are more aligned.
With each change, we leap and bound,
In tidy code, joy is found! 🌟


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 1ed9198 and 34d48b6.

Files selected for processing (2)
  • packages/utils/src/fs/fszip.js (1 hunks)
  • packages/utils/src/fs/index.js (4 hunks)
Files skipped from review due to trivial changes (1)
  • packages/utils/src/fs/fszip.js
Additional comments not posted (4)
packages/utils/src/fs/index.js (4)

18-19: LGTM! The logic encapsulation is a good improvement.

The conversion of isSupportFileSystemAccess to a function encapsulating the check for showDirectoryPicker and iframe context is a positive change. It enhances maintainability and consistency.


28-30: LGTM! Consistent usage of the new function.

The use of isSupportFileSystemAccess() ensures consistent checks for filesystem access support, aligning with the refactoring goals.


84-86: LGTM! Error handling for unsupported browsers is clear.

The function now throws an error when filesystem access is not supported, providing a clear message. This improves robustness.


188-191: LGTM! Consistent decision logic for file writing.

The use of isSupportFileSystemAccess() to determine the method of file writing aligns with the overall refactoring, ensuring consistent logic application.

chilingling
chilingling previously approved these changes Aug 16, 2024
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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 34d48b6 and 7428b95.

Files selected for processing (1)
  • packages/utils/src/fs/index.js (2 hunks)
Additional comments not posted (2)
packages/utils/src/fs/index.js (2)

Line range hint 11-12:
LGTM! The transformation to a function enhances maintainability.

The change from a boolean to a function centralizes the logic for checking filesystem access support, improving maintainability and consistency.


28-28: Consistent usage of isSupportFileSystemAccess.

Both getUserBaseDirHandle and getUserFileHandle correctly utilize the new function. The error message in getUserFileHandle now provides clearer context regarding unsupported environments.

Also applies to: 84-85

@chilingling chilingling merged commit 59eaf03 into opentiny:develop Aug 16, 2024
chilingling added a commit that referenced this pull request Sep 24, 2024
* fix(mockServer): mockServer page preview can't render element-plus element (#503)

* fix(style): fix render error caused by inline style breaks (#526)

* fix(metaComp): fix bug where metaHtmlText could set value to incorret schema children (#473)

* fix(vue-generator): fix globalstate codegen error (#547)

* fix(material): add componentsMap to app Schema after material build (#527)

* fix: slot params missing double quote (#605)

* fix: slot params missing double quote

* fix: exclude nodemodule test case

* fix: 修复onMouseover拼写错误 (#662)

* fix: esbuild install failed on node v16 (#668)

* fix: esbuild install failed on nodev16

* fix: esbuild install failed on nodev16

* fix: builtin components can't generate import statement with genSFCWithDefaultPlugin method (#656)

* fix: esbuild install failed on nodev16 (#671)

* fix: esbuild install failed on nodev16

* fix: esbuild install failed on nodev16

* fix: remove deps on root pkg.json

* fix(preview): multiple nested blocks cannot preview #663 (#665)

* fix(material): add missing componentsMap to mockServer (#701)

* fix(setting): fix bindEvent dialog visible can't work on tinyvue 3.17 (#715)

* feat(download-code): support download zip for not support browsers (#703)

* feat(download-code): support download zip for not support browsers

* feat(download-code): support download zip for not support browsers - review

* feat(download-code): support download zip for not support browsers - review

* docs: update milestone (#728)

* docs: update milestone

* fix: tab

* fix: abaolute canvas init inlineStyle should be string (#730)

* fix(download): Optimize download logic and adapt to iframe (#739)

* fix(download): Optimize download logic and adapt to iframe

* feat(cdn): change cdn from onmicrosoft to unpkg (#750)

* fix: 隐藏画布根节点的包裹元素的操作选项 (#492)

* fix(script): translate log (#549)

* fix: translate log

* Update scripts/connection.mjs

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* Update scripts/connection.mjs

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* Update scripts/connection.mjs

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

---------

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* fix: reset spacing cannot generate correct source code (#657)

* fix: jsx slot modelvalue can't update value (#734)

* fix: jsx slot modelvalue can't update value

* fix: add unit test for updateModel event

* fix(canvas): absolute dnd update position to schema. close #664 (#751)

* fix(generate-vue):修复出码文件选择界面打包后样式丢失问题 (#789)

Co-authored-by: wangwenbing <11535041@qq.com>

* fix(stylePanel): fix setting border-radius could not work on first time (#481)

* fix(common): fix verify required (#787)

* fix: mixed lifeCyclesContent when empty lifecycles (#810)

close #806
修复生命周期为空时,取当前页面schema生命周期值的 bug

---------

Co-authored-by: chilingling <26962197+chilingling@users.noreply.github.com>
Co-authored-by: yeser <631300329@qq.com>
Co-authored-by: wenmine <wwmmail@foxmail.com>
Co-authored-by: Gene <Pacify.98@gmail.com>
Co-authored-by: yaoyun8 <142570291+yaoyun8@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: bwrong <ibwrong@foxmail.com>
Co-authored-by: wangwenbing <11535041@qq.com>
Co-authored-by: Xie Jay <xiejay97@gmail.com>
yy-wow pushed a commit to yy-wow/tiny-engine that referenced this pull request Oct 10, 2024
)

* fix(download): Optimize download logic and adapt to iframe
yy-wow pushed a commit to yy-wow/tiny-engine that referenced this pull request Oct 10, 2024
* fix(mockServer): mockServer page preview can't render element-plus element (opentiny#503)

* fix(style): fix render error caused by inline style breaks (opentiny#526)

* fix(metaComp): fix bug where metaHtmlText could set value to incorret schema children (opentiny#473)

* fix(vue-generator): fix globalstate codegen error (opentiny#547)

* fix(material): add componentsMap to app Schema after material build (opentiny#527)

* fix: slot params missing double quote (opentiny#605)

* fix: slot params missing double quote

* fix: exclude nodemodule test case

* fix: 修复onMouseover拼写错误 (opentiny#662)

* fix: esbuild install failed on node v16 (opentiny#668)

* fix: esbuild install failed on nodev16

* fix: esbuild install failed on nodev16

* fix: builtin components can't generate import statement with genSFCWithDefaultPlugin method (opentiny#656)

* fix: esbuild install failed on nodev16 (opentiny#671)

* fix: esbuild install failed on nodev16

* fix: esbuild install failed on nodev16

* fix: remove deps on root pkg.json

* fix(preview): multiple nested blocks cannot preview opentiny#663 (opentiny#665)

* fix(material): add missing componentsMap to mockServer (opentiny#701)

* fix(setting): fix bindEvent dialog visible can't work on tinyvue 3.17 (opentiny#715)

* feat(download-code): support download zip for not support browsers (opentiny#703)

* feat(download-code): support download zip for not support browsers

* feat(download-code): support download zip for not support browsers - review

* feat(download-code): support download zip for not support browsers - review

* docs: update milestone (opentiny#728)

* docs: update milestone

* fix: tab

* fix: abaolute canvas init inlineStyle should be string (opentiny#730)

* fix(download): Optimize download logic and adapt to iframe (opentiny#739)

* fix(download): Optimize download logic and adapt to iframe

* feat(cdn): change cdn from onmicrosoft to unpkg (opentiny#750)

* fix: 隐藏画布根节点的包裹元素的操作选项 (opentiny#492)

* fix(script): translate log (opentiny#549)

* fix: translate log

* Update scripts/connection.mjs

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* Update scripts/connection.mjs

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* Update scripts/connection.mjs

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

---------

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* fix: reset spacing cannot generate correct source code (opentiny#657)

* fix: jsx slot modelvalue can't update value (opentiny#734)

* fix: jsx slot modelvalue can't update value

* fix: add unit test for updateModel event

* fix(canvas): absolute dnd update position to schema. close opentiny#664 (opentiny#751)

* fix(generate-vue):修复出码文件选择界面打包后样式丢失问题 (opentiny#789)

Co-authored-by: wangwenbing <11535041@qq.com>

* fix(stylePanel): fix setting border-radius could not work on first time (opentiny#481)

* fix(common): fix verify required (opentiny#787)

* fix: mixed lifeCyclesContent when empty lifecycles (opentiny#810)

close opentiny#806
修复生命周期为空时,取当前页面schema生命周期值的 bug

---------

Co-authored-by: chilingling <26962197+chilingling@users.noreply.github.com>
Co-authored-by: yeser <631300329@qq.com>
Co-authored-by: wenmine <wwmmail@foxmail.com>
Co-authored-by: Gene <Pacify.98@gmail.com>
Co-authored-by: yaoyun8 <142570291+yaoyun8@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: bwrong <ibwrong@foxmail.com>
Co-authored-by: wangwenbing <11535041@qq.com>
Co-authored-by: Xie Jay <xiejay97@gmail.com>
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.

3 participants