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: drawer console warning #4871

Merged
merged 2 commits into from
Nov 12, 2024
Merged

fix: drawer console warning #4871

merged 2 commits into from
Nov 12, 2024

Conversation

vince292007
Copy link
Collaborator

@vince292007 vince292007 commented Nov 12, 2024

Description

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update
  • Please, don't make changes to pnpm-lock.yaml unless you introduce a new test example.

Checklist

ℹ️ Check all checkboxes - this will indicate that you have done everything in accordance with the rules in CONTRIBUTING.

  • If you introduce new functionality, document it. You can run documentation with pnpm run docs:dev command.
  • Run the tests with pnpm test.
  • Changes in changelog are generated from PR name. Please, make sure that it explains your changes in an understandable manner. Please, prefix changeset messages with feat:, fix:, perf:, docs:, or chore:.
  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

Summary by CodeRabbit

Release Notes

  • New Features

    • Enhanced accessibility in the Drawer component by ensuring consistent header structure even when no title or description is provided.
  • Bug Fixes

    • Improved error handling for invalid input types in the file download functions.
  • Chores

    • Updated various package dependencies to improve performance and compatibility.

@vince292007 vince292007 added the bug Something isn't working label Nov 12, 2024
@vince292007 vince292007 requested a review from anncwb as a code owner November 12, 2024 05:22
Copy link

changeset-bot bot commented Nov 12, 2024

⚠️ No Changeset found

Latest commit: c791463

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

Copy link
Contributor

coderabbitai bot commented Nov 12, 2024

Walkthrough

This pull request introduces several changes across multiple files. In download.ts, modifications include the removal of parameter documentation and enhanced error handling for the downloadFileFromBlob and downloadFileFromBlobPart functions. The triggerDownload function now has a default revokeDelay value. In drawer.vue, a new template block improves accessibility by ensuring hidden elements are rendered when no title or description is provided. The package.json and pnpm-workspace.yaml files reflect various dependency updates, including version changes and the removal of the dayjs dependency.

Changes

File Path Change Summary
packages/@core/base/shared/src/utils/download.ts - Removed parameter documentation from downloadFileFromBlob and downloadFileFromBlobPart.
- Added type checks for source in both functions.
- Updated triggerDownload to set default revokeDelay to 100 ms.
packages/@core/ui-kit/popup-ui/src/drawer/drawer.vue - Added <template v-else> in <SheetHeader> for accessibility when title/description are absent.
- Updated handleFocusOutside to prevent default behavior and stop propagation.
packages/effects/plugins/package.json - Updated version to 5.4.6 and removed dayjs dependency.
pnpm-workspace.yaml - Updated various package dependency versions, including @ast-grep/napi and @vitejs/plugin-vue.

Possibly related PRs

Suggested reviewers

  • anncwb

Poem

🐇 In the meadow where the code does flow,
Changes made, like seeds we sow.
Headers now hidden, yet still they shine,
With every update, our work aligns.
So hop along, let’s celebrate,
For in this code, we create our fate! 🌼

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/@core/ui-kit/popup-ui/src/drawer/drawer.vue

Oops! Something went wrong! :(

ESLint: 9.14.0

Error [ERR_MODULE_NOT_FOUND]: Cannot find module '/node_modules/@vben/eslint-config/dist/index.mjs' imported from /eslint.config.mjs
at finalizeResolution (node:internal/modules/esm/resolve:257:11)
at moduleResolve (node:internal/modules/esm/resolve:914:10)
at defaultResolve (node:internal/modules/esm/resolve:1038:11)
at ModuleLoader.defaultResolve (node:internal/modules/esm/loader:557:12)
at ModuleLoader.resolve (node:internal/modules/esm/loader:525:25)
at ModuleLoader.getModuleJob (node:internal/modules/esm/loader:246:38)
at ModuleJob._link (node:internal/modules/esm/module_job:126:49)


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

🧹 Outside diff range and nitpick comments (2)
packages/@core/ui-kit/popup-ui/src/drawer/drawer.vue (2)

181-186: Great accessibility improvement!

The addition of hidden ARIA landmarks when no visible title/description is present ensures better screen reader compatibility and maintains a consistent DOM structure.

Consider documenting this accessibility feature in the component's documentation to help other developers understand its purpose and importance.


181-186: Consider enhancing accessibility further

While the hidden elements improve accessibility, consider adding these enhancements:

 <template v-else>
-  <VisuallyHidden>
+  <VisuallyHidden
+    role="dialog"
+    :aria-label="$t('drawer')"
+    :aria-modal="modal">
     <SheetTitle />
     <SheetDescription />
   </VisuallyHidden>
 </template>
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 1ff1e4a and c791463.

⛔ Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
📒 Files selected for processing (4)
  • packages/@core/base/shared/src/utils/download.ts (0 hunks)
  • packages/@core/ui-kit/popup-ui/src/drawer/drawer.vue (1 hunks)
  • packages/effects/plugins/package.json (0 hunks)
  • pnpm-workspace.yaml (9 hunks)
💤 Files with no reviewable changes (2)
  • packages/@core/base/shared/src/utils/download.ts
  • packages/effects/plugins/package.json
🔇 Additional comments (3)
pnpm-workspace.yaml (2)

16-16: Dependency updates look safe.

The remaining updates are mostly patch and minor version bumps that should maintain backward compatibility:

  • Build tools: postcss (^8.4.47 → ^8.4.49), vite (^5.4.10 → ^5.4.11)
  • Linting: typescript-eslint, eslint plugins
  • Testing: happy-dom (^15.11.0 → ^15.11.2)
  • UI components: vxe-table (^4.8.9 → ^4.8.10)

These changes appear to be routine maintenance updates.

Also applies to: 30-30, 33-33, 52-53, 91-91, 93-93, 102-102, 108-108, 127-127, 131-131, 152-152, 162-162, 168-168, 177-178


56-57: Review Vue ecosystem updates for drawer warning fix.

The updates to Vue-related packages could be relevant to fixing the drawer console warning:

  • @vitejs/plugin-vue: ^5.1.4 → ^5.1.5
  • @vitejs/plugin-vue-jsx: ^4.0.1 → ^4.1.0
  • ant-design-vue: ^4.2.5 → ^4.2.6

Please verify that these updates don't introduce any new console warnings.

Also applies to: 63-63

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

Line range hint 89-92: Verify focus management behavior

The current implementation of handleFocusOutside aggressively blocks all focus-related events. This could impact keyboard navigation accessibility.

Let's check if other drawer implementations in the codebase handle focus differently:

✅ Verification successful

Let me gather more information about the focus handling implementation in both drawer and modal components.


Let me try one more search with different patterns to find the focus handling implementations.


Focus event blocking is consistent with modal pattern

The aggressive focus management implementation is actually correct and consistent across both drawer and modal components. This is a standard pattern for modal/drawer components where:

  1. Both components use identical focus management to maintain focus within the modal/drawer
  2. Preventing event propagation is necessary to trap focus within these components for accessibility
  3. The implementation aligns with WAI-ARIA modal dialog patterns where focus should be contained
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for similar drawer components and their focus handling
ast-grep --pattern 'function handle$_Focus($_) {
  $$$
}'

# Search for focus-related event handlers
rg -A 3 '@(focus-outside|close-auto-focus)'

Length of output: 1344


Script:

#!/bin/bash
# Check the implementation of handleFocusOutside in both components
ast-grep --pattern 'function handleFocusOutside($_) {
  $$$
}'

# Check for any focus-trap or focus management related imports
rg -l "focus-trap|focus.*management"

# Look for any accessibility-related comments or documentation
rg -i "a11y|accessibility|keyboard.*navigation"

Length of output: 168


Script:

#!/bin/bash
# Search for the handleFocusOutside function with a more specific pattern
ast-grep --pattern 'handleFocusOutside(e) {
  $$$
}'

# Also try searching with ripgrep for the function definition
rg -A 5 "handleFocusOutside.*\{" 

# Check if there are any focus-related utilities or composables
fd -e ts -e js -e vue . | xargs rg "useFocus|createFocus"

Length of output: 992

@vince292007 vince292007 merged commit 67c2b13 into main Nov 12, 2024
14 checks passed
@vince292007 vince292007 deleted the issue-4863 branch November 12, 2024 05:34
@coderabbitai coderabbitai bot mentioned this pull request Dec 4, 2024
16 tasks
@github-actions github-actions bot locked and limited conversation to collaborators Dec 15, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant