buildSummary.ts

// Copyright 2024-25 The MathWorks, Inc.
import * as core from "@actions/core";
import { join } from "path";
import { readFileSync, unlinkSync, existsSync } from "fs";

export function addSummary(taskSummaryTableRows: string[][]) {
    try {
        core.summary.addHeading("MATLAB Build Results").addTable(taskSummaryTableRows);
    } catch (e) {
        console.error("An error occurred while adding the build results table to the summary:", e);
    }
}

export function getSummaryRows(buildSummary: string): any[] {
    const rows = JSON.parse(buildSummary).map((t: any) => {
        if (t.failed) {
            return [t.name, "🔴 Failed", t.description, t.duration];
        } else if (t.skipped) {
            return [
                t.name,
                "🔵 Skipped" + " (" + interpretSkipReason(t.skipReason) + ")",
                t.description,
                t.duration,
            ];
        } else {
            return [t.name, "🟢 Successful", t.description, t.duration];
        }
    });
    return rows;
}

export function interpretSkipReason(skipReason: string) {
    switch (skipReason) {
        case "UpToDate":
            return "up-to-date";
        case "UserSpecified":
        case "UserRequested":
            return "user requested";
        case "DependencyFailed":
            return "dependency failed";
        default:
            return skipReason;
    }
}

export function processAndAddBuildSummary(runnerTemp: string, runId: string) {
    const header = [
        { data: "MATLAB Task", header: true },
        { data: "Status", header: true },
        { data: "Description", header: true },
        { data: "Duration (HH:mm:ss)", header: true },
    ];

    const filePath: string = join(runnerTemp, `buildSummary${runId}.json`);
    let taskSummaryTable;
    if (existsSync(filePath)) {
        try {
            const buildSummary = readFileSync(filePath, { encoding: "utf8" });
            const rows = getSummaryRows(buildSummary);
            taskSummaryTable = [header, ...rows];
        } catch (e) {
            console.error("An error occurred while reading the build summary file:", e);
            return;
        } finally {
            try {
                unlinkSync(filePath);
            } catch (e) {
                console.error(
                    `An error occurred while trying to delete the build summary file ${filePath}:`,
                    e,
                );
            }
        }
        addSummary(taskSummaryTable);
    }
}