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.

Sign up for GitHub

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

[core] Replace bundle size reporter filter #38979

Merged
merged 6 commits into from
Apr 12, 2024
Merged

[core] Replace bundle size reporter filter #38979

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
7243bd5
Replace bundle size reporter filter to include more entries in the da…
Janpot Sep 14, 2023
ae83c19
clean up comments
oliviertassinari Sep 14, 2023
dfacb22
Update dangerfile.ts
Janpot Sep 15, 2023
5183a33
Update dangerfile.ts
Janpot Sep 15, 2023
776f968
Merge remote-tracking branch 'upstream/master' into danger
Janpot Sep 20, 2023
9395efd
Merge remote-tracking branch 'upstream/next' into danger
Janpot Mar 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion dangerfile.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ function createComparisonFilter(parsedThreshold: number, gzipThreshold: number)
*/
function isPackageComparison(comparisonEntry: [string, any]) {
Copy link
Member

@oliviertassinari oliviertassinari Sep 14, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need this filter in the first place? It feels like

Suggested change
function isPackageComparison(comparisonEntry: [string, any]) {

could do the job.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need this filter in the first place?

As far as I'm concerned, that's up to the core team to decide 🙂. I'm fine with either way.

Copy link
Member

@oliviertassinari oliviertassinari Sep 14, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I imagine the main downside is about the number of diffs it could create. We could workaround it, say:

diff --git a/dangerfile.ts b/dangerfile.ts
index bd769f141a..aedc4d72d7 100644
--- a/dangerfile.ts
+++ b/dangerfile.ts
@@ -55,16 +55,6 @@ function createComparisonFilter(parsedThreshold: number, gzipThreshold: number)
   };
 }

-/**
- * Checks if the bundle is of a package e.b. `@mui/material` but not
- * `@mui/material/Paper`.
- * @param {[string, any]} comparisonEntry
- */
-function isPackageComparison(comparisonEntry: [string, any]) {
-  const [bundleKey] = comparisonEntry;
-  return !/^@[\w-]+\/[\w-]+\/.+$/.test(bundleKey);
-}
-
 /**
  * Generates a user-readable string from a percentage change.
  * @param {number} change
@@ -160,12 +150,23 @@ async function reportBundleSize() {
   if (anyResultsChanges.length > 0) {
     const importantChanges = mainResults
       .filter(createComparisonFilter(parsedSizeChangeThreshold, gzipSizeChangeThreshold))
-      .filter(isPackageComparison)
+      .sort(([, a], [, b]) => {
+        const aDiff = Math.abs(a.parsed.absoluteDiff) + Math.abs(a.gzip.absoluteDiff);
+        const bDiff = Math.abs(b.parsed.absoluteDiff) + Math.abs(b.gzip.absoluteDiff);
+        return bDiff - aDiff;
+      })
       .map(generateEmphasizedChange);

     // have to guard against empty strings
     if (importantChanges.length > 0) {
-      markdown(importantChanges.join('\n'));
+      let text = importantChanges.slice(0, 9).join('\n');
+
+      if (importantChanges.length > 10) {
+        text += '\n';
+        text += `and ${importantChanges.length - 10} more changes`;
+      }
+
+      markdown(text);
     }

     const details = `## Bundle size report

Copy link
Member Author

@Janpot Janpot Sep 20, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tweaked the implementation a bit (the slice is off by one 🙂) and added to this PR. Also defaulted to 20 items, because why not?

const [bundleKey] = comparisonEntry;
return /^@[\w-]+\/[\w-]+$/.test(bundleKey);
return !/^@[\w-]+\/[\w-]+\/.+$/.test(bundleKey);
}

/**
Expand Down
Loading