perf: beforeClose of drawer support promise

[imdap]

drawer的beforeClose与modal保持一致 支持Promise

[changeset-bot]

⚠️ No Changeset found

Latest commit: fb819d2

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]

Walkthrough

The changes modify the drawer closing functionality by converting the close method in the DrawerApi from a synchronous to an asynchronous function. The method now awaits the onBeforeClose hook, which can return a promise or a boolean, determining whether the drawer should close. Additionally, the type definitions and documentation are updated to reflect the new behavior and to standardize terminology from popup to drawer.

Changes

File	Change Summary
packages/@core/ui-kit/.../drawer-api.ts	Made the close() method asynchronous by updating its signature to async close() and awaiting the onBeforeClose hook. Documentation updated to reflect the drawer terminology and behavior.
packages/@core/ui-kit/.../drawer.ts	Updated DrawerApiOptions interface changing onBeforeClose from a synchronous callback to one returning a `MaybePromise<boolean
packages/@core/ui-kit/.../drawer/__tests__/drawer-api.test.ts	Removed the line drawerApi.open(); from the test case, altering the logic to directly check the closing functionality without first opening the drawer.

Sequence Diagram(s)

sequenceDiagram
  participant U as User
  participant D as DrawerApi
  participant H as onBeforeClose Hook

  U->>D: Call close()
  D->>H: Await onBeforeClose?()
  H-->>D: Return boolean/promise resolution
  alt Hook approves closure
    D-->U: Complete drawer close
  else Hook rejects closure
    D-->U: Cancel drawer close
  end

Loading

Poem

I'm a nimble rabbit in the code terrain,
Hopping through async changes without any strain.
The drawer now waits for its pre-close check,
A promise of order, no function to wreck.
With a twitch of my whiskers and a carrot in sight,
I celebrate our clean commit—oh what a delight!

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)

• We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.

---

📜 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 59de9cc and fb819d2.

📒 Files selected for processing (1)

• packages/@core/ui-kit/popup-ui/src/drawer/__tests__/drawer-api.test.ts (0 hunks)

💤 Files with no reviewable changes (1)

• packages/@core/ui-kit/popup-ui/src/drawer/tests/drawer-api.test.ts

⏰ Context from checks skipped due to timeout of 90000ms (8)

• GitHub Check: Check (windows-latest)
• GitHub Check: Check (ubuntu-latest)
• GitHub Check: Lint (ubuntu-latest)
• GitHub Check: Test (windows-latest)
• GitHub Check: Lint (windows-latest)
• GitHub Check: Analyze (javascript-typescript)
• GitHub Check: post-update (windows-latest)
• GitHub Check: post-update (ubuntu-latest)

---

🪧 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.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

packages/@core/ui-kit/popup-ui/src/drawer/drawer-api.ts (2)

92-96: Implementation now properly supports async beforeClose handling.

The close method has been converted to an async function that awaits the result of the onBeforeClose hook. This allows the hook to return a Promise or a boolean value, providing more flexibility for users.

Consider adding error handling for potential Promise rejections:

  async close() {
    // 通过 onBeforeClose 钩子函数来判断是否允许关闭弹窗
    // 如果 onBeforeClose 返回 false，则不关闭弹窗
-   const allowClose = (await this.api.onBeforeClose?.()) ?? true;
+   let allowClose = true;
+   try {
+     allowClose = (await this.api.onBeforeClose?.()) ?? true;
+   } catch (error) {
+     console.error('Error in onBeforeClose:', error);
+   }
    if (allowClose) {
      this.store.setState((prev) => ({
        ...prev,
        isOpen: false,
        submitting: false,
      }));
    }
  }

---

93-94: Update inline comments for terminology consistency.

The inline comments still refer to "弹窗" (popup) instead of "抽屉" (drawer), which is inconsistent with the updated documentation.

- // 通过 onBeforeClose 钩子函数来判断是否允许关闭弹窗
- // 如果 onBeforeClose 返回 false，则不关闭弹窗
+ // 通过 onBeforeClose 钩子函数来判断是否允许关闭抽屉
+ // 如果 onBeforeClose 返回 false，则不关闭抽屉

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between a8c4786 and 59de9cc.

📒 Files selected for processing (2)

• packages/@core/ui-kit/popup-ui/src/drawer/drawer-api.ts (1 hunks)
• packages/@core/ui-kit/popup-ui/src/drawer/drawer.ts (2 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (1)

packages/@core/ui-kit/popup-ui/src/drawer/drawer.ts (1)

packages/@core/base/typings/src/helper.d.ts (1)

• MaybePromise (123-123)

⏰ Context from checks skipped due to timeout of 90000ms (4)

• GitHub Check: Lint (windows-latest)
• GitHub Check: Check (windows-latest)
• GitHub Check: post-update (ubuntu-latest)
• GitHub Check: post-update (windows-latest)

🔇 Additional comments (3)

packages/@core/ui-kit/popup-ui/src/drawer/drawer-api.ts (1)

88-91: Documentation updated for consistency and clarity.

The documentation has been appropriately updated to change "弹窗" (popup) to "抽屉" (drawer) for better terminology consistency, and now includes details about the onBeforeClose behavior.

packages/@core/ui-kit/popup-ui/src/drawer/drawer.ts (2)

3-3: Added MaybePromise import to support the new type definition.

The import statement has been correctly updated to include the MaybePromise type from the @vben-core/typings module, which is needed for the updated return type of onBeforeClose.

---

154-154: Updated type definition to support Promise returns.

The type definition for onBeforeClose has been updated to return MaybePromise<boolean | undefined>, which correctly aligns with the implementation in close() that now awaits the result.

This change is essential for enabling async handling in the onBeforeClose hook and maintains compatibility with existing code by accepting both synchronous and asynchronous responses.

[jinmao88]

#5932 (review) 这个机器人提示 有需要优化的地方