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(ui): BundleAssets - add "No chunk" filter #4850

Merged
merged 1 commit into from
Nov 20, 2024
Merged

Conversation

vio
Copy link
Member

@vio vio commented Nov 20, 2024

Summary by CodeRabbit

  • New Features
    • Introduced a "No chunk" filter for assets, enhancing the filtering capabilities of the asset reporting functionality.
  • Improvements
    • Updated filtering logic to account for assets without a specified chunk ID, ensuring comprehensive asset management.

Copy link

coderabbitai bot commented Nov 20, 2024

Walkthrough

The changes introduce a new constant NO_CHUNK_FILTER in the bundle-assets.utils.ts file, which serves as a filter for assets not associated with any chunk. This constant is integrated into the getFilters function, adding an entry for "No chunk" in the chunksFilter object. Additionally, the generateGetRowFilter function is updated to include NO_CHUNK_FILTER in the filtersChunkIds array, enhancing the logic for processing chunk filters. The mapping of run.chunkId in the rowRunsChunkIds array is also modified to default to NO_CHUNK_FILTER when run.chunkId is undefined.

Changes

File Path Change Summary
packages/ui/src/components/bundle-assets/bundle-assets.utils.ts Introduced NO_CHUNK_FILTER constant; updated getFilters and generateGetRowFilter functions to incorporate this constant for improved asset filtering.

Possibly related PRs

  • Assets chunks filter #4843: The changes in this PR involve the removal of the bundle-assets.utils.js file, which included utility functions for managing asset data, including filtering. This is related to the main PR as it also deals with filtering logic, specifically the introduction of NO_CHUNK_FILTER in the bundle-assets.utils.ts file, which enhances the filtering capabilities for assets.

Poem

In the bundle where assets play,
A new filter joins the fray.
"No chunk," it proudly stands,
Helping us with its gentle hands.
With each run, it finds its way,
Making filtering bright as day! 🐰✨


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

relativeci bot commented Nov 20, 2024

#11694 Bundle Size — 380.81KiB (+0.03%).

0cb8759(current) vs 9162b8a master#11692(baseline)

Warning

Bundle contains 2 duplicate packages – View duplicate packages

Bundle metrics  Change 2 changes Regression 1 regression
                 Current
#11694
     Baseline
#11692
Regression  Initial JS 333.93KiB(+0.03%) 333.81KiB
No change  Initial CSS 46.89KiB 46.89KiB
Change  Cache Invalidation 28.53% 0%
No change  Chunks 3 3
No change  Assets 4 4
No change  Modules 699 699
No change  Duplicate Modules 0 0
No change  Duplicate Code 0% 0%
No change  Packages 39 39
No change  Duplicate Packages 1 1
Bundle size by type  Change 1 change Regression 1 regression
                 Current
#11694
     Baseline
#11692
Regression  JS 333.93KiB (+0.03%) 333.81KiB
No change  CSS 46.89KiB 46.89KiB

Bundle analysis reportBranch fix-asset-chunk-filterProject dashboard


Generated by RelativeCIDocumentationReport issue

Copy link

@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 (1)
packages/ui/src/components/bundle-assets/bundle-assets.utils.ts (1)

171-181: Consider adding a comment to explain the "No chunk" filter placement.

The implementation is correct and follows the existing patterns. The placement at the start of the children array makes sense as it's a special case.

Consider adding a comment to explain why the "No chunk" filter is placed first:

 const chunksFilter: FilterGroupFieldData = {
   label: 'Chunks',
   children: [
+    // Place "No chunk" filter first as it's a special case
     {
       key: NO_CHUNK_FILTER,
       label: 'No chunk',
       defaultValue: filters[`${ASSET_CHUNK}.${NO_CHUNK_FILTER}`] ?? true,
     },
   ],
 };
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between e4da3b7 and 0cb8759.

📒 Files selected for processing (1)
  • packages/ui/src/components/bundle-assets/bundle-assets.utils.ts (4 hunks)
🔇 Additional comments (2)
packages/ui/src/components/bundle-assets/bundle-assets.utils.ts (2)

22-22: LGTM: Constant declaration is clear and follows conventions.

The constant name and value are descriptive and appropriate for its purpose.


234-235: Verify edge cases and consider making the fallback more explicit.

The changes correctly handle assets without chunks, but there are a few points to consider:

  1. The length comparison for hasChunkFilters now includes the NO_CHUNK_FILTER, which is correct but could be more explicit
  2. The fallback to NO_CHUNK_FILTER could be made more readable

Consider these improvements:

 // List of chunks ids, including the NO_CHUNK
 const filtersChunkIds = [NO_CHUNK_FILTER, ...chunkIds];
 
+// Track which filters are enabled
 filtersChunkIds.forEach((chunkId) => {
   if (filters[`${ASSET_CHUNK}.${chunkId}`]) {
     checkedChunkIds.push(chunkId);
   }
 });

 const hasChunkFilters =
   checkedChunkIds.length > 0 && checkedChunkIds.length !== filtersChunkIds.length;

-const rowRunsChunkIds = item?.runs?.map((run) => run?.chunkId || NO_CHUNK_FILTER) || [];
+const rowRunsChunkIds = item?.runs?.map((run) => (
+  // Explicitly mark assets without chunks
+  run?.chunkId === undefined ? NO_CHUNK_FILTER : run.chunkId
+)) || [];

Let's verify the changes handle all edge cases:

Also applies to: 237-244, 268-269

@vio vio merged commit 2cf7ed9 into master Nov 20, 2024
28 checks passed
@vio vio deleted the fix-asset-chunk-filter branch November 20, 2024 22:01
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.

1 participant