Add change highlight threshold option (#1)

davidwlhlm · web-flow · commit daec5775adb2 · 2023-05-04T10:05:22.000+02:00
diff --git a/action.yml b/action.yml
@@ -35,6 +35,10 @@ inputs:
     required: false
     default: 0.0125
     description: "The percentage threshold for size changes before posting a comment"
+  change_highlight_threshold:
+    required: false
+    default: 0
+    description: "The percentage threshold for changes to be highlighted with an emoji"
 runs:
   using: "node16"
   main: "dist/index.js"
diff --git a/dist/index.js b/dist/index.js
@@ -21686,38 +21686,38 @@ class SizeLimit {
         }
         return `${Math.ceil(seconds * 1000)} ms`;
     }
-    formatChange(base = 0, current = 0) {
+    formatChange(base = 0, current = 0, changeHighlightThreshold = 0) {
         if (base === 0) {
-            return "added";
+            return "added 🆕";
         }
         if (current === 0) {
-            return "removed";
+            return "removed 🚮";
         }
         const value = ((current - base) / base) * 100;
         const formatted = (Math.sign(value) * Math.ceil(Math.abs(value) * 100)) / 100;
         if (value > 0) {
-            return `+${formatted}% 🔺`;
+            return value - changeHighlightThreshold > 0 ? `+${formatted}% 🔺` : `+${formatted}%`;
         }
         if (value === 0) {
             return `${formatted}%`;
         }
-        return `${formatted}% 🔽`;
+        return value + changeHighlightThreshold < 0 ? `${formatted}% 🔽` : `${formatted}%`;
     }
     formatLine(value, change) {
         return `${value} (${change})`;
     }
-    formatSizeResult(name, base, current) {
+    formatSizeResult(name, base, current, changeHighlightThreshold) {
         return [
             name,
-            this.formatLine(this.formatBytes(current.size), this.formatChange(base.size, current.size)),
+            this.formatLine(this.formatBytes(current.size), this.formatChange(base.size, current.size, changeHighlightThreshold)),
         ];
     }
-    formatTimeResult(name, base, current) {
+    formatTimeResult(name, base, current, changeHighlightThreshold) {
         return [
             name,
-            this.formatLine(this.formatBytes(current.size), this.formatChange(base.size, current.size)),
-            this.formatLine(this.formatTime(current.loading), this.formatChange(base.loading, current.loading)),
-            this.formatLine(this.formatTime(current.running), this.formatChange(base.running, current.running)),
+            this.formatLine(this.formatBytes(current.size), this.formatChange(base.size, current.size, changeHighlightThreshold)),
+            this.formatLine(this.formatTime(current.loading), this.formatChange(base.loading, current.loading, changeHighlightThreshold)),
+            this.formatLine(this.formatTime(current.running), this.formatChange(base.running, current.running, changeHighlightThreshold)),
             this.formatTime(current.total),
         ];
     }
@@ -21757,7 +21757,7 @@ class SizeLimit {
                 threshold);
         });
     }
-    formatResults(base, current) {
+    formatResults(base, current, changeHighlightThreshold = 0) {
         const names = [
             ...new Set([...(base ? Object.keys(base) : []), ...Object.keys(current)]),
         ];
@@ -21769,9 +21769,9 @@ class SizeLimit {
             const baseResult = (base === null || base === void 0 ? void 0 : base[name]) || EmptyResult;
             const currentResult = current[name] || EmptyResult;
             if (isSize) {
-                return this.formatSizeResult(name, baseResult, currentResult);
+                return this.formatSizeResult(name, baseResult, currentResult, changeHighlightThreshold);
             }
-            return this.formatTimeResult(name, baseResult, currentResult);
+            return this.formatTimeResult(name, baseResult, currentResult, changeHighlightThreshold);
         });
         return [header, ...fields];
     }
@@ -21941,6 +21941,7 @@ function run() {
             const windowsVerbatimArguments = getInput("windows_verbatim_arguments") === "true" ? true : false;
             const githubToken = getInput("github_token");
             const threshold = getInput("threshold");
+            const changeHighlightThreshold = getInput("change_highlight_threshold");
             const octokit = (0, github_1.getOctokit)(githubToken);
             const term = new Term_1.default();
             const limit = new SizeLimit_1.default();
@@ -21997,9 +21998,10 @@ function run() {
                 limit.hasSizeChanges(base, current, thresholdNumber) ||
                 sizeLimitComment;
             if (shouldComment) {
+                const changeHighlightThresholdNumber = Number(changeHighlightThreshold);
                 const body = [
                     SIZE_LIMIT_HEADING,
-                    (0, markdown_table_1.markdownTable)(limit.formatResults(base, current)),
+                    (0, markdown_table_1.markdownTable)(limit.formatResults(base, current, changeHighlightThresholdNumber)),
                 ].join("\r\n");
                 try {
                     if (!sizeLimitComment) {
diff --git a/src/SizeLimit.spec.ts b/src/SizeLimit.spec.ts
@@ -118,7 +118,7 @@ describe("SizeLimit", () => {
     expect(limit.formatResults(base, current)).toEqual([
       SizeLimit.SIZE_RESULTS_HEADER,
       ["dist/index.js", "98.53 KB (-9.02% 🔽)"],
-      ["dist/new.js", "98.53 KB (added)"],
+      ["dist/new.js", "98.53 KB (added 🆕)"],
     ]);
   });
 
@@ -139,8 +139,56 @@ describe("SizeLimit", () => {
 
     expect(limit.formatResults(base, current)).toEqual([
       SizeLimit.SIZE_RESULTS_HEADER,
-      ["dist/index.js", "0 B (removed)"],
-      ["dist/new.js", "98.53 KB (added)"],
+      ["dist/index.js", "0 B (removed 🚮)"],
+      ["dist/new.js", "98.53 KB (added 🆕)"],
+    ]);
+  });
+
+  test("should format size-limit with change emojis only if change highlight threshold surpassed", () => {
+    const limit = new SizeLimit();
+    const base = {
+      "dist/around-same-size.js": {
+        name: "dist/around-same-size.js",
+        size: 110894,
+      },
+      "dist/much-bigger.js": {
+        name: "dist/much-bigger.js",
+        size: 133742,
+      },
+      "dist/slightly-smaller.js": {
+        name: "dist/slightly-smaller.js",
+        size: 1402,
+      },
+    };
+    const current = {
+      "dist/around-same-size.js": {
+        name: "dist/around-same-size.js",
+        size: 110642,
+      },
+      "dist/much-bigger.js": {
+        name: "dist/much-bigger.js",
+        size: 153293,
+      },
+      "dist/slightly-smaller.js": {
+        name: "dist/slightly-smaller.js",
+        size: 1374,
+      },
+    };
+
+    expect(limit.formatResults(base, current, 2)).toEqual([
+      SizeLimit.SIZE_RESULTS_HEADER,
+      [
+        "dist/around-same-size.js",
+        "108.05 KB (-0.23%)",
+      ],
+      [
+        "dist/much-bigger.js",
+        "149.7 KB (+14.62% 🔺)",
+      ],
+      [
+        "dist/slightly-smaller.js",
+        "1.34 KB (-2%)",
+      ],
     ]);
   });
 
diff --git a/src/SizeLimit.ts b/src/SizeLimit.ts
@@ -40,28 +40,28 @@ class SizeLimit {
     return `${Math.ceil(seconds * 1000)} ms`;
   }
 
-  private formatChange(base: number = 0, current: number = 0): string {
+  private formatChange(base: number = 0, current: number = 0, changeHighlightThreshold = 0): string {
     if (base === 0) {
-      return "added";
+      return "added 🆕";
     }
 
     if (current === 0) {
-      return "removed";
+      return "removed 🚮";
     }
 
     const value = ((current - base) / base) * 100;
     const formatted =
       (Math.sign(value) * Math.ceil(Math.abs(value) * 100)) / 100;
 
     if (value > 0) {
-      return `+${formatted}% 🔺`;
+      return value - changeHighlightThreshold > 0 ? `+${formatted}% 🔺` : `+${formatted}%`;
     }
 
     if (value === 0) {
       return `${formatted}%`;
     }
 
-    return `${formatted}% 🔽`;
+    return value + changeHighlightThreshold < 0 ? `${formatted}% 🔽` : `${formatted}%`;
   }
 
   private formatLine(value: string, change: string) {
@@ -71,35 +71,37 @@ class SizeLimit {
   private formatSizeResult(
     name: string,
     base: IResult,
-    current: IResult
+    current: IResult,
+    changeHighlightThreshold: number,
   ): Array<string> {
     return [
       name,
       this.formatLine(
         this.formatBytes(current.size),
-        this.formatChange(base.size, current.size)
+        this.formatChange(base.size, current.size, changeHighlightThreshold)
       ),
     ];
   }
 
   private formatTimeResult(
     name: string,
     base: IResult,
-    current: IResult
+    current: IResult,
+    changeHighlightThreshold: number,
   ): Array<string> {
     return [
       name,
       this.formatLine(
         this.formatBytes(current.size),
-        this.formatChange(base.size, current.size)
+        this.formatChange(base.size, current.size, changeHighlightThreshold)
       ),
       this.formatLine(
         this.formatTime(current.loading),
-        this.formatChange(base.loading, current.loading)
+        this.formatChange(base.loading, current.loading, changeHighlightThreshold)
       ),
       this.formatLine(
         this.formatTime(current.running),
-        this.formatChange(base.running, current.running)
+        this.formatChange(base.running, current.running, changeHighlightThreshold)
       ),
       this.formatTime(current.total),
     ];
@@ -171,7 +173,8 @@ class SizeLimit {
 
   formatResults(
     base: { [name: string]: IResult },
-    current: { [name: string]: IResult }
+    current: { [name: string]: IResult },
+    changeHighlightThreshold: number = 0,
   ): Array<Array<string>> {
     const names = [
       ...new Set([...(base ? Object.keys(base) : []), ...Object.keys(current)]),
@@ -187,9 +190,9 @@ class SizeLimit {
       const currentResult = current[name] || EmptyResult;
 
       if (isSize) {
-        return this.formatSizeResult(name, baseResult, currentResult);
+        return this.formatSizeResult(name, baseResult, currentResult, changeHighlightThreshold);
       }
-      return this.formatTimeResult(name, baseResult, currentResult);
+      return this.formatTimeResult(name, baseResult, currentResult, changeHighlightThreshold);
     });
 
     return [header, ...fields];
diff --git a/src/main.ts b/src/main.ts
@@ -63,6 +63,7 @@ async function run() {
       getInput("windows_verbatim_arguments") === "true" ? true : false;
     const githubToken = getInput("github_token");
     const threshold = getInput("threshold");
+    const changeHighlightThreshold = getInput("change_highlight_threshold");
 
     const octokit = getOctokit(githubToken);
     const term = new Term();
@@ -153,9 +154,11 @@ async function run() {
       sizeLimitComment;
 
     if (shouldComment) {
+      const changeHighlightThresholdNumber = Number(changeHighlightThreshold);
+
       const body = [
         SIZE_LIMIT_HEADING,
-        markdownTable(limit.formatResults(base, current)),
+        markdownTable(limit.formatResults(base, current, changeHighlightThresholdNumber)),
       ].join("\r\n");
 
       try {
