check numDiffs for posting markdown not diffCircuitRows.length

noir-lang · Sep 25, 2024 · ca7ea34 · ca7ea34
1 parent ef8aaf4
commit ca7ea34
Show file tree

Hide file tree

Showing 5 changed files with 28 additions and 9 deletions.
diff --git a/dist/index.js b/dist/index.js
@@ -114,7 +114,7 @@ const formatShellBrilligRows = (diffs, summaryQuantile = 0.8) => {
     return [summaryRows, fullReportRows];
 };
 exports.formatShellBrilligRows = formatShellBrilligRows;
-const formatShellDiffBrillig = (diffs, summaryRows, fullReportRows, summaryQuantile = 0.8) => {
+const formatShellDiffBrillig = (diffs, summaryRows, fullReportRows, brillig_report_bytes, summaryQuantile = 0.8) => {
     const maxProgramLength = Math.max(8, ...diffs.map(({ name }) => name.length));
     const SHELL_SUMMARY_COLS = [
         { txt: "", length: 0 },
@@ -128,6 +128,10 @@ const formatShellDiffBrillig = (diffs, summaryRows, fullReportRows, summaryQuant
         { txt: "Brillig opcodes (+/-)", length: 33 },
         { txt: "", length: 0 },
     ];
+    if (brillig_report_bytes) {
+        SHELL_SUMMARY_COLS[2].txt = "Bytecode size in bytes (+/-)";
+        SHELL_DIFF_COLS[2].txt = "Bytecode size in bytes (+/-)";
+    }
     const summaryHeader = SHELL_SUMMARY_COLS.map((entry) => colors_1.default.bold((0, utils_1.center)(entry.txt, entry.length || 0)))
         .join(" | ")
         .trim();
@@ -523,7 +527,7 @@ function run() {
             if (brillig_report) {
                 core.info(`Format Brillig diffs`);
                 const [summaryRowsShell, fullReportRowsShell] = (0, program_1.formatShellBrilligRows)(diffBrilligRows, summaryQuantile);
-                shell = (0, program_1.formatShellDiffBrillig)(diffCircuitRows, summaryRowsShell, fullReportRowsShell, summaryQuantile);
+                shell = (0, program_1.formatShellDiffBrillig)(diffCircuitRows, summaryRowsShell, fullReportRowsShell, brillig_report_bytes == "true", summaryQuantile);
             }
             else {
                 core.info(`Format ACIR diffs`);
@@ -532,7 +536,7 @@ function run() {
             }
             core.endGroup();
             console.log(shell);
-            if (diffCircuitRows.length > 0) {
+            if (numDiffs > 0) {
                 core.setOutput("shell", shell);
                 core.setOutput("markdown", markdown);
             }

diff --git a/dist/index.js.map b/dist/index.js.map
diff --git a/src/format/program.ts b/src/format/program.ts
@@ -191,6 +191,7 @@ export const formatShellDiffBrillig = (
   diffs: DiffBrillig[],
   summaryRows: string[],
   fullReportRows: string[],
+  brillig_report_bytes: boolean,
   summaryQuantile = 0.8
 ) => {
   const maxProgramLength = Math.max(8, ...diffs.map(({ name }) => name.length));
@@ -209,6 +210,11 @@ export const formatShellDiffBrillig = (
     { txt: "", length: 0 },
   ];
 
+  if (brillig_report_bytes) {
+    SHELL_SUMMARY_COLS[2].txt = "Bytecode size in bytes (+/-)";
+    SHELL_DIFF_COLS[2].txt = "Bytecode size in bytes (+/-)";
+  }
+
   const summaryHeader = SHELL_SUMMARY_COLS.map((entry) =>
     colors.bold(center(entry.txt, entry.length || 0))
   )

diff --git a/src/index.ts b/src/index.ts
@@ -167,6 +167,7 @@ async function run() {
         diffCircuitRows,
         summaryRowsShell,
         fullReportRowsShell,
+        brillig_report_bytes == "true",
         summaryQuantile
       );
     } else {
@@ -187,7 +188,7 @@ async function run() {
 
     console.log(shell);
 
-    if (diffCircuitRows.length > 0) {
+    if (numDiffs > 0) {
       core.setOutput("shell", shell);
       core.setOutput("markdown", markdown);
     }

diff --git a/tests/program_report.test.ts b/tests/program_report.test.ts
@@ -129,7 +129,9 @@ describe("Shell format", () => {
     console.log(formatShellDiff(circuitDiffs, summaryRows, fullReportRows));
 
     const [summaryRowsBrillig, fullReportRowsBrillig] = formatShellBrilligRows(brilligDiffs);
-    console.log(formatShellDiffBrillig(brilligDiffs, summaryRowsBrillig, fullReportRowsBrillig));
+    console.log(
+      formatShellDiffBrillig(brilligDiffs, summaryRowsBrillig, fullReportRowsBrillig, false)
+    );
   });
 
   it("should compare 1 to 2", () => {
@@ -143,7 +145,9 @@ describe("Shell format", () => {
     console.log(formatShellDiff(circuitDiffs, summaryRows, fullReportRows));
 
     const [summaryRowsBrillig, fullReportRowsBrillig] = formatShellBrilligRows(brilligDiffs);
-    console.log(formatShellDiffBrillig(brilligDiffs, summaryRowsBrillig, fullReportRowsBrillig));
+    console.log(
+      formatShellDiffBrillig(brilligDiffs, summaryRowsBrillig, fullReportRowsBrillig, false)
+    );
   });
 
   // This test is just to make sure that we are accurately resetting our reference
@@ -169,7 +173,9 @@ describe("Shell format", () => {
     console.log(formatShellDiff(circuitDiffs, summaryRows, fullReportRows));
 
     const [summaryRowsBrillig, fullReportRowsBrillig] = formatShellBrilligRows(brilligDiffs);
-    console.log(formatShellDiffBrillig(brilligDiffs, summaryRowsBrillig, fullReportRowsBrillig));
+    console.log(
+      formatShellDiffBrillig(brilligDiffs, summaryRowsBrillig, fullReportRowsBrillig, false)
+    );
   });
 
   it("should compare 2 to 1", () => {
@@ -183,6 +189,8 @@ describe("Shell format", () => {
     console.log(formatShellDiff(circuitDiffs, summaryRows, fullReportRows));
 
     const [summaryRowsBrillig, fullReportRowsBrillig] = formatShellBrilligRows(brilligDiffs);
-    console.log(formatShellDiffBrillig(brilligDiffs, summaryRowsBrillig, fullReportRowsBrillig));
+    console.log(
+      formatShellDiffBrillig(brilligDiffs, summaryRowsBrillig, fullReportRowsBrillig, false)
+    );
   });
 });