noir-gates-diff/src/format/contract.ts

Github Action reporting gates diff from Nargo info reports

import colors from "colors";
import _sortBy from "lodash/sortBy";

import { ContractDiffReport, DiffCell } from "../types";

import {
  alignPattern,
  center,
  generateCommitInfo,
  parenthesized,
  plusSign,
  TextAlign,
} from "./utils";

export const formatShellCell = (cell: DiffCell, length = 10) => {
  const format = colors[cell.delta > 0 ? "red" : cell.delta < 0 ? "green" : "reset"];

  return [
    cell.current.toLocaleString().padStart(length) +
      " " +
      format(parenthesized(plusSign(cell.delta) + cell.delta.toLocaleString()).padEnd(length)),
    colors.bold(
      format(
        (
          plusSign(cell.percentage) +
          (cell.percentage === Infinity ? "∞" : cell.percentage.toFixed(2)) +
          "%"
        ).padStart(9)
      )
    ),
  ];
};

const selectSummaryDiffs = (
  diffs: ContractDiffReport[],
  minCircuitChangePercentage: number
): ContractDiffReport[] =>
  diffs
    .map(({ functions, ...diff }) => ({
      ...diff,
      functions: functions.filter(
        (method) =>
          Math.abs(method.circuit_size.percentage) >= minCircuitChangePercentage &&
          (method.opcodes.delta !== 0 || method.circuit_size.delta !== 0)
      ),
    }))
    .filter((diff) => diff.functions.length > 0);

export const formatShellDiff = (diffs: ContractDiffReport[], summaryQuantile = 0.8) => {
  const maxContractLength = Math.max(8, ...diffs.map(({ name }) => name.length));
  const maxMethodLength = Math.max(
    7,
    ...diffs.flatMap(({ functions }) => functions.map(({ name }) => name.length))
  );

  const SHELL_SUMMARY_COLS = [
    { txt: "", length: 0 },
    { txt: "Contract", length: maxContractLength },
    { txt: "Method", length: maxMethodLength },
    { txt: "ACIR opcodes (+/-)", length: 33 },
    { txt: "Circuit size (+/-)", length: 33 },
    { txt: "", length: 0 },
  ];

  const SHELL_DIFF_COLS = [
    { txt: "", length: 0 },
    { txt: "Contract", length: maxContractLength },
    { txt: "Method", length: maxMethodLength },
    { txt: "ACIR opcodes (+/-)", length: 33 },
    { txt: "Circuit size (+/-)", length: 33 },
    { txt: "", length: 0 },
  ];

  const summaryHeader = SHELL_SUMMARY_COLS.map((entry) =>
    colors.bold(center(entry.txt, entry.length || 0))
  )
    .join(" | ")
    .trim();
  const summarySeparator = SHELL_SUMMARY_COLS.map(({ length }) =>
    length > 0 ? "-".repeat(length + 2) : ""
  )
    .join("|")
    .trim();

  const diffHeader = SHELL_DIFF_COLS.map((entry) =>
    colors.bold(center(entry.txt, entry.length || 0))
  )
    .join(" | ")
    .trim();
  const diffSeparator = SHELL_DIFF_COLS.map(({ length }) =>
    length > 0 ? "-".repeat(length + 2) : ""
  )
    .join("|")
    .trim();

  const sortedMethods = _sortBy(
    diffs.flatMap((diff) => diff.functions),
    (method) => Math.abs(method.circuit_size.percentage)
  );
  const circuitChangeQuantile = Math.abs(
    sortedMethods[Math.floor((sortedMethods.length - 1) * summaryQuantile)]?.circuit_size
      .percentage ?? 0
  );

  const summaryRows = selectSummaryDiffs(diffs, circuitChangeQuantile).flatMap((diff) =>
    diff.functions
      .map((method, methodIndex) =>
        [
          "",
          colors.bold(colors.grey((methodIndex === 0 ? diff.name : "").padEnd(maxContractLength))),
          colors.italic(method.name.padEnd(maxMethodLength)),
          ...formatShellCell(method.opcodes),
          ...formatShellCell(method.circuit_size),
          "",
        ]
          .join(" | ")
          .trim()
      )
      .join("\n")
      .trim()
  );

  const fullReportRows = diffs.map((diff) =>
    diff.functions
      .map((method, methodIndex) =>
        [
          "",
          colors.bold(colors.grey((methodIndex === 0 ? diff.name : "").padEnd(maxContractLength))),
          colors.italic(method.name.padEnd(maxMethodLength)),
          ...formatShellCell(method.opcodes),
          ...formatShellCell(method.circuit_size),
          "",
        ]
          .join(" | ")
          .trim()
      )
      .join("\n")
      .trim()
  );

  return (
    colors.underline(
      colors.bold(
        colors.yellow(
          `🧾 Summary (${Math.round((1 - summaryQuantile) * 100)}% most significant diffs)\n\n`
        )
      )
    ) +
    ["", summaryHeader, ...summaryRows, ""].join(`\n${summarySeparator}\n`).trim() +
    colors.underline(colors.bold(colors.yellow("\n\nFull diff report 👇\n\n"))) +
    ["", diffHeader, ...fullReportRows, ""].join(`\n${diffSeparator}\n`).trim()
  );
};

const formatMarkdownSummaryCell = (rows: DiffCell[]) => [
  rows
    .map(
      (row) =>
        plusSign(row.delta) +
        row.delta.toLocaleString() +
        " " +
        (row.delta > 0 ? "❌" : row.delta < 0 ? "✅" : "➖")
    )
    .join("<br />"),
  rows
    .map(
      (row) =>
        "**" +
        plusSign(row.percentage) +
        (row.percentage === Infinity ? "∞" : row.percentage.toFixed(2)) +
        "%**"
    )
    .join("<br />"),
];

const formatMarkdownFullCell = (rows: DiffCell[]) => [
  rows
    .map(
      (row) =>
        row.current.toLocaleString() +
        "&nbsp;(" +
        plusSign(row.delta) +
        row.delta.toLocaleString() +
        ")"
    )
    .join("<br />"),
  rows
    .map(
      (row) =>
        "**" +
        plusSign(row.percentage) +
        (row.percentage === Infinity ? "∞" : row.percentage.toFixed(2)) +
        "%**"
    )
    .join("<br />"),
];

const MARKDOWN_SUMMARY_COLS = [
  { txt: "" },
  { txt: "Contract", align: TextAlign.LEFT },
  { txt: "Method", align: TextAlign.LEFT },
  { txt: "ACIR opcodes (+/-)", align: TextAlign.RIGHT },
  { txt: "%", align: TextAlign.RIGHT },
  { txt: "Circuit size (+/-)", align: TextAlign.RIGHT },
  { txt: "%", align: TextAlign.RIGHT },
  { txt: "" },
];

const MARKDOWN_DIFF_COLS = [
  { txt: "" },
  { txt: "Contract", align: TextAlign.LEFT },
  { txt: "Method", align: TextAlign.LEFT },
  { txt: "ACIR opcodes (+/-)", align: TextAlign.RIGHT },
  { txt: "%", align: TextAlign.RIGHT },
  { txt: "Circuit size (+/-)", align: TextAlign.RIGHT },
  { txt: "%", align: TextAlign.RIGHT },
  { txt: "" },
];

export const formatMarkdownDiff = (
  header: string,
  diffs: ContractDiffReport[],
  repository: string,
  commitHash: string,
  refCommitHash?: string,
  summaryQuantile = 0.8
) => {
  const diffReport = [header, "", generateCommitInfo(repository, commitHash, refCommitHash)];
  if (diffs.length === 0)
    return diffReport.concat(["", "### There are no changes in circuit sizes"]).join("\n").trim();

  const summaryHeader = MARKDOWN_SUMMARY_COLS.map((entry) => entry.txt)
    .join(" | ")
    .trim();
  const summaryHeaderSeparator = MARKDOWN_SUMMARY_COLS.map((entry) =>
    entry.txt ? alignPattern(entry.align) : ""
  )
    .join("|")
    .trim();

  const diffHeader = MARKDOWN_DIFF_COLS.map((entry) => entry.txt)
    .join(" | ")
    .trim();
  const diffHeaderSeparator = MARKDOWN_DIFF_COLS.map((entry) =>
    entry.txt ? alignPattern(entry.align) : ""
  )
    .join("|")
    .trim();

  const sortedMethods = _sortBy(
    diffs.flatMap((diff) => diff.functions),
    (method) => Math.abs(method.circuit_size.percentage)
  );
  const circuitChangeQuantile = Math.abs(
    sortedMethods[Math.floor((sortedMethods.length - 1) * summaryQuantile)]?.circuit_size
      .percentage ?? 0
  );

  const summaryRows = selectSummaryDiffs(diffs, circuitChangeQuantile).flatMap((diff) =>
    [
      "",
      `**${diff.name}**`,
      diff.functions.map((method) => `_${method.name}_`).join("<br />"),
      ...formatMarkdownSummaryCell(diff.functions.map((method) => method.opcodes)),
      ...formatMarkdownSummaryCell(diff.functions.map((method) => method.circuit_size)),
      "",
    ]
      .join(" | ")
      .trim()
  );

  const fullReportRows = diffs.flatMap((diff) =>
    [
      "",
      `**${diff.name}**`,
      diff.functions.map((method) => `_${method.name}_`).join("<br />"),
      ...formatMarkdownFullCell(diff.functions.map((method) => method.opcodes)),
      ...formatMarkdownFullCell(diff.functions.map((method) => method.circuit_size)),
      "",
    ]
      .join(" | ")
      .trim()
  );

  return diffReport
    .concat([
      "",
      `### 🧾 Summary (${Math.round((1 - summaryQuantile) * 100)}% most significant diffs)`,
      "",
      summaryHeader,
      summaryHeaderSeparator,
      ...summaryRows,
      "---",
      "",
      "<details>",
      "<summary><strong>Full diff report</strong> 👇</summary>",
      "<br />",
      "",
      diffHeader,
      diffHeaderSeparator,
      ...fullReportRows,
      "</details>",
      "",
    ])
    .join("\n")
    .trim();
};