Move logs, SARIF actions uploads to post: hooks

analyze/action.yml

@@ -74,3 +74,4 @@ outputs:
 runs:
   using: "node16"
   main: "../lib/analyze-action.js"
+  post: "../lib/analyze-action-cleanup.js"

init/action.yml

@@ -78,3 +78,4 @@ outputs:
 runs:
   using: 'node16'
   main: '../lib/init-action.js'
+  post: '../lib/init-action-cleanup.js'

lib/actions-util.js

@@ -19,15 +19,17 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.sanitizeArifactName = exports.isAnalyzingDefaultBranch = exports.getRelativeScriptPath = exports.isRunningLocalAction = exports.sendStatusReport = exports.createStatusReportBase = exports.getActionsStatus = exports.getRef = exports.computeAutomationID = exports.getAutomationID = exports.getAnalysisKey = exports.getWorkflowRunID = exports.getWorkflow = exports.formatWorkflowCause = exports.formatWorkflowErrors = exports.validateWorkflow = exports.getWorkflowErrors = exports.WorkflowErrors = exports.patternIsSuperset = exports.determineMergeBaseCommitOid = exports.getCommitOid = exports.getTemporaryDirectory = exports.getOptionalInput = exports.getRequiredInput = void 0;
+exports.uploadDatabaseBundleDebugArtifact = exports.uploadDebugArtifacts = exports.doesDirectoryExist = exports.sanitizeArifactName = exports.isAnalyzingDefaultBranch = exports.getRelativeScriptPath = exports.isRunningLocalAction = exports.sendStatusReport = exports.createStatusReportBase = exports.getActionsStatus = exports.getRef = exports.computeAutomationID = exports.getAutomationID = exports.getAnalysisKey = exports.getWorkflowRunID = exports.getWorkflow = exports.formatWorkflowCause = exports.formatWorkflowErrors = exports.validateWorkflow = exports.getWorkflowErrors = exports.WorkflowErrors = exports.patternIsSuperset = exports.determineMergeBaseCommitOid = exports.getCommitOid = exports.getTemporaryDirectory = exports.getOptionalInput = exports.getRequiredInput = void 0;
 const fs = __importStar(require("fs"));
 const os = __importStar(require("os"));
 const path = __importStar(require("path"));
+const artifact = __importStar(require("@actions/artifact"));
 const core = __importStar(require("@actions/core"));
 const toolrunner = __importStar(require("@actions/exec/lib/toolrunner"));
 const safeWhich = __importStar(require("@chrisgavin/safe-which"));
 const yaml = __importStar(require("js-yaml"));
 const api = __importStar(require("./api-client"));
+const codeql_1 = require("./codeql");
 const sharedEnv = __importStar(require("./shared-environment"));
 const util_1 = require("./util");
 // eslint-disable-next-line import/no-commonjs
@@ -681,4 +683,43 @@ function sanitizeArifactName(name) {
     return name.replace(/[^a-zA-Z0-9_\\-]+/g, "");
 }
 exports.sanitizeArifactName = sanitizeArifactName;
+// REVIEW: Not sure this is the best place for this function?
+function doesDirectoryExist(dirPath) {
+    try {
+        const stats = fs.lstatSync(dirPath);
+        return stats.isDirectory();
+    }
+    catch (e) {
+        return false;
+    }
+}
+exports.doesDirectoryExist = doesDirectoryExist;
+async function uploadDebugArtifacts(toUpload, rootDir, artifactName) {
+    if (toUpload.length === 0) {
+        return;
+    }
+    let suffix = "";
+    const matrix = getRequiredInput("matrix");
+    if (matrix !== undefined && matrix !== "null") {
+        for (const entry of Object.entries(JSON.parse(matrix)).sort())
+            suffix += `-${entry[1]}`;
+    }
+    await artifact.create().uploadArtifact(sanitizeArifactName(`${artifactName}${suffix}`), toUpload.map((file) => path.normalize(file)), path.normalize(rootDir));
+}
+exports.uploadDebugArtifacts = uploadDebugArtifacts;
+// TODO(angelapwen): this method doesn't work yet for incomplete database
+// bundles. Move caller to init-action-cleanup after implementation.
+async function uploadDatabaseBundleDebugArtifact(config) {
+    try {
+        const toUpload = [];
+        for (const language of config.languages) {
+            toUpload.push(await (0, util_1.bundleDb)(config, language, await (0, codeql_1.getCodeQL)(config.codeQLCmd), `${config.debugDatabaseName}-${language}`));
+        }
+        await uploadDebugArtifacts(toUpload, config.dbLocation, config.debugArtifactName);
+    }
+    catch (error) {
+        console.log(`Failed to upload database debug bundles: ${error}`);
+    }
+}
+exports.uploadDatabaseBundleDebugArtifact = uploadDatabaseBundleDebugArtifact;
 //# sourceMappingURL=actions-util.js.map

lib/analyze-action-cleanup.js

@@ -0,0 +1,64 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs = __importStar(require("fs"));
+const path = __importStar(require("path"));
+const core = __importStar(require("@actions/core"));
+const actionsUtil = __importStar(require("./actions-util"));
+const config_utils_1 = require("./config-utils");
+const logging_1 = require("./logging");
+async function uploadSarifDebugArtifact(config, outputDir) {
+    if (!actionsUtil.doesDirectoryExist(outputDir)) {
+        return;
+    }
+    let toUpload = [];
+    for (const lang of config.languages) {
+        const sarifFile = path.resolve(outputDir, `${lang}.sarif`);
+        if (fs.existsSync(sarifFile)) {
+            toUpload = toUpload.concat(sarifFile);
+        }
+    }
+    await actionsUtil.uploadDebugArtifacts(toUpload, outputDir, config.debugArtifactName);
+}
+async function run() {
+    const logger = (0, logging_1.getActionsLogger)();
+    let config = undefined;
+    config = await (0, config_utils_1.getConfig)(actionsUtil.getTemporaryDirectory(), logger);
+    if (config === undefined) {
+        throw new Error("Config file could not be found at expected location. Has the 'init' action been called?");
+    }
+    // Upload Actions SARIF artifacts for debugging
+    if (config === null || config === void 0 ? void 0 : config.debugMode) {
+        const outputDir = actionsUtil.getRequiredInput("output");
+        await uploadSarifDebugArtifact(config, outputDir);
+    }
+}
+async function runWrapper() {
+    try {
+        await run();
+    }
+    catch (error) {
+        core.setFailed(`analyze action cleanup failed: ${error}`);
+        console.log(error);
+    }
+}
+void runWrapper();
+//# sourceMappingURL=analyze-action-cleanup.js.map

lib/analyze-action-cleanup.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"analyze-action-cleanup.js","sourceRoot":"","sources":["../src/analyze-action-cleanup.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;AAAA,uCAAyB;AACzB,2CAA6B;AAE7B,oDAAsC;AAEtC,4DAA8C;AAC9C,iDAAmD;AACnD,uCAA6C;AAE7C,KAAK,UAAU,wBAAwB,CAAC,MAAc,EAAE,SAAiB;IACvE,IAAI,CAAC,WAAW,CAAC,kBAAkB,CAAC,SAAS,CAAC,EAAE;QAC9C,OAAO;KACR;IAED,IAAI,QAAQ,GAAa,EAAE,CAAC;IAC5B,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,SAAS,EAAE;QACnC,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,GAAG,IAAI,QAAQ,CAAC,CAAC;QAC3D,IAAI,EAAE,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE;YAC5B,QAAQ,GAAG,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;SACvC;KACF;IACD,MAAM,WAAW,CAAC,oBAAoB,CACpC,QAAQ,EACR,SAAS,EACT,MAAM,CAAC,iBAAiB,CACzB,CAAC;AACJ,CAAC;AAED,KAAK,UAAU,GAAG;IAChB,MAAM,MAAM,GAAG,IAAA,0BAAgB,GAAE,CAAC;IAElC,IAAI,MAAM,GAAuB,SAAS,CAAC;IAC3C,MAAM,GAAG,MAAM,IAAA,wBAAS,EAAC,WAAW,CAAC,qBAAqB,EAAE,EAAE,MAAM,CAAC,CAAC;IACtE,IAAI,MAAM,KAAK,SAAS,EAAE;QACxB,MAAM,IAAI,KAAK,CACb,yFAAyF,CAC1F,CAAC;KACH;IAED,+CAA+C;IAC/C,IAAI,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,SAAS,EAAE;QACrB,MAAM,SAAS,GAAG,WAAW,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;QACzD,MAAM,wBAAwB,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;KACnD;AACH,CAAC;AAED,KAAK,UAAU,UAAU;IACvB,IAAI;QACF,MAAM,GAAG,EAAE,CAAC;KACb;IAAC,OAAO,KAAK,EAAE;QACd,IAAI,CAAC,SAAS,CAAC,kCAAkC,KAAK,EAAE,CAAC,CAAC;QAC1D,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;KACpB;AACH,CAAC;AAED,KAAK,UAAU,EAAE,CAAC"}

lib/analyze-action.js

@@ -20,9 +20,6 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.runPromise = exports.sendStatusReport = void 0;
-const fs = __importStar(require("fs"));
-const path = __importStar(require("path"));
-const artifact = __importStar(require("@actions/artifact"));
 const core = __importStar(require("@actions/core"));
 const actionsUtil = __importStar(require("./actions-util"));
 const analyze_1 = require("./analyze");
@@ -35,7 +32,6 @@ const logging_1 = require("./logging");
 const repository_1 = require("./repository");
 const upload_lib = __importStar(require("./upload-lib"));
 const util = __importStar(require("./util"));
-const util_1 = require("./util");
 // eslint-disable-next-line import/no-commonjs
 const pkg = require("../package.json");
 async function sendStatusReport(startedAt, config, stats, error) {
@@ -83,27 +79,6 @@ async function run() {
         await (0, analyze_1.runFinalize)(outputDir, threads, memory, config, logger, featureFlags);
         if (actionsUtil.getRequiredInput("skip-queries") !== "true") {
             runStats = await (0, analyze_1.runQueries)(outputDir, memory, util.getAddSnippetsFlag(actionsUtil.getRequiredInput("add-snippets")), threads, actionsUtil.getOptionalInput("category"), config, logger);
-            if (config.debugMode) {
-                // Upload the SARIF files as an Actions artifact for debugging
-                await uploadDebugArtifacts(config.languages.map((lang) => path.resolve(outputDir, `${lang}.sarif`)), outputDir, config.debugArtifactName);
-            }
-        }
-        const codeql = await (0, codeql_1.getCodeQL)(config.codeQLCmd);
-        if (config.debugMode) {
-            // Upload the logs as an Actions artifact for debugging
-            let toUpload = [];
-            for (const language of config.languages) {
-                toUpload = toUpload.concat(listFolder(path.resolve(util.getCodeQLDatabasePath(config, language), "log")));
-            }
-            if (await (0, util_1.codeQlVersionAbove)(codeql, codeql_1.CODEQL_VERSION_NEW_TRACING)) {
-                // Multilanguage tracing: there are additional logs in the root of the cluster
-                toUpload = toUpload.concat(listFolder(path.resolve(config.dbLocation, "log")));
-            }
-            await uploadDebugArtifacts(toUpload, config.dbLocation, config.debugArtifactName);
-            if (!(await (0, util_1.codeQlVersionAbove)(codeql, codeql_1.CODEQL_VERSION_NEW_TRACING))) {
-                // Before multi-language tracing, we wrote a compound-build-tracer.log in the temp dir
-                await uploadDebugArtifacts([path.resolve(config.tempDir, "compound-build-tracer.log")], config.tempDir, config.debugArtifactName);
-            }
         }
         if (actionsUtil.getOptionalInput("cleanup-level") !== "none") {
             await (0, analyze_1.runCleanup)(config, actionsUtil.getOptionalInput("cleanup-level") || "brutal", logger);
@@ -146,38 +121,7 @@ async function run() {
     }
     finally {
         if (config === null || config === void 0 ? void 0 : config.debugMode) {
-            try {
-                // Upload the database bundles as an Actions artifact for debugging
-                const toUpload = [];
-                for (const language of config.languages) {
-                    toUpload.push(await (0, util_1.bundleDb)(config, language, await (0, codeql_1.getCodeQL)(config.codeQLCmd), `${config.debugDatabaseName}-${language}`));
-                }
-                await uploadDebugArtifacts(toUpload, config.dbLocation, config.debugArtifactName);
-            }
-            catch (error) {
-                console.log(`Failed to upload database debug bundles: ${error}`);
-            }
-        }
-        if (config === null || config === void 0 ? void 0 : config.debugMode) {
-            core.info("Debug mode is on. Printing CodeQL debug logs...");
-            for (const language of config.languages) {
-                const databaseDirectory = util.getCodeQLDatabasePath(config, language);
-                const logsDirectory = path.join(databaseDirectory, "log");
-                const walkLogFiles = (dir) => {
-                    const entries = fs.readdirSync(dir, { withFileTypes: true });
-                    for (const entry of entries) {
-                        if (entry.isFile()) {
-                            core.startGroup(`CodeQL Debug Logs - ${language} - ${entry.name}`);
-                            process.stdout.write(fs.readFileSync(path.resolve(dir, entry.name)));
-                            core.endGroup();
-                        }
-                        else if (entry.isDirectory()) {
-                            walkLogFiles(path.resolve(dir, entry.name));
-                        }
-                    }
-                };
-                walkLogFiles(logsDirectory);
-            }
+            await actionsUtil.uploadDatabaseBundleDebugArtifact(config);
         }
     }
     if (runStats && uploadResult) {
@@ -193,28 +137,6 @@ async function run() {
         await sendStatusReport(startedAt, config, undefined);
     }
 }
-async function uploadDebugArtifacts(toUpload, rootDir, artifactName) {
-    let suffix = "";
-    const matrix = actionsUtil.getRequiredInput("matrix");
-    if (matrix !== undefined && matrix !== "null") {
-        for (const entry of Object.entries(JSON.parse(matrix)).sort())
-            suffix += `-${entry[1]}`;
-    }
-    await artifact.create().uploadArtifact(actionsUtil.sanitizeArifactName(`${artifactName}${suffix}`), toUpload.map((file) => path.normalize(file)), path.normalize(rootDir));
-}
-function listFolder(dir) {
-    const entries = fs.readdirSync(dir, { withFileTypes: true });
-    let files = [];
-    for (const entry of entries) {
-        if (entry.isFile()) {
-            files.push(path.resolve(dir, entry.name));
-        }
-        else if (entry.isDirectory()) {
-            files = files.concat(listFolder(path.resolve(dir, entry.name)));
-        }
-    }
-    return files;
-}
 exports.runPromise = run();
 async function runWrapper() {
     try {

lib/init-action-cleanup.js

@@ -0,0 +1,121 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs = __importStar(require("fs"));
+const path = __importStar(require("path"));
+const core = __importStar(require("@actions/core"));
+const actionsUtil = __importStar(require("./actions-util"));
+const codeql_1 = require("./codeql");
+const config_utils_1 = require("./config-utils");
+const logging_1 = require("./logging");
+const util_1 = require("./util");
+function listFolder(dir) {
+    const entries = fs.readdirSync(dir, { withFileTypes: true });
+    let files = [];
+    for (const entry of entries) {
+        if (entry.isFile()) {
+            files.push(path.resolve(dir, entry.name));
+        }
+        else if (entry.isDirectory()) {
+            files = files.concat(listFolder(path.resolve(dir, entry.name)));
+        }
+    }
+    return files;
+}
+async function uploadLogsDebugArtifact(config) {
+    const codeql = await (0, codeql_1.getCodeQL)(config.codeQLCmd);
+    let toUpload = [];
+    for (const language of config.languages) {
+        const databaseDirectory = (0, util_1.getCodeQLDatabasePath)(config, language);
+        const logsDirectory = path.resolve(databaseDirectory, "log");
+        if (actionsUtil.doesDirectoryExist(logsDirectory)) {
+            toUpload = toUpload.concat(listFolder(logsDirectory));
+        }
+    }
+    if (await (0, util_1.codeQlVersionAbove)(codeql, codeql_1.CODEQL_VERSION_NEW_TRACING)) {
+        // Multilanguage tracing: there are additional logs in the root of the cluster
+        const multiLanguageTracingLogsDirectory = path.resolve(config.dbLocation, "log");
+        if (actionsUtil.doesDirectoryExist(multiLanguageTracingLogsDirectory)) {
+            toUpload = toUpload.concat(listFolder(multiLanguageTracingLogsDirectory));
+        }
+    }
+    await actionsUtil.uploadDebugArtifacts(toUpload, config.dbLocation, config.debugArtifactName);
+    // Before multi-language tracing, we wrote a compound-build-tracer.log in the temp dir
+    if (!(await (0, util_1.codeQlVersionAbove)(codeql, codeql_1.CODEQL_VERSION_NEW_TRACING))) {
+        const compoundBuildTracerLogDirectory = path.resolve(config.tempDir, "compound-build-tracer.log");
+        if (actionsUtil.doesDirectoryExist(compoundBuildTracerLogDirectory)) {
+            await actionsUtil.uploadDebugArtifacts([compoundBuildTracerLogDirectory], config.tempDir, config.debugArtifactName);
+        }
+    }
+}
+async function uploadFinalLogsDebugArtifact(config) {
+    core.info("Debug mode is on. Printing CodeQL debug logs...");
+    for (const language of config.languages) {
+        const databaseDirectory = (0, util_1.getCodeQLDatabasePath)(config, language);
+        const logsDirectory = path.join(databaseDirectory, "log");
+        if (!actionsUtil.doesDirectoryExist(logsDirectory)) {
+            core.info(`Directory ${logsDirectory} does not exist.`);
+            continue; // Skip this language database.
+        }
+        const walkLogFiles = (dir) => {
+            const entries = fs.readdirSync(dir, { withFileTypes: true });
+            if (entries.length === 0) {
+                core.info(`No debug logs found at directory ${logsDirectory}.`);
+            }
+            for (const entry of entries) {
+                if (entry.isFile()) {
+                    core.startGroup(`CodeQL Debug Logs - ${language} - ${entry.name}`);
+                    process.stdout.write(fs.readFileSync(path.resolve(dir, entry.name)));
+                    core.endGroup();
+                }
+                else if (entry.isDirectory()) {
+                    walkLogFiles(path.resolve(dir, entry.name));
+                }
+            }
+        };
+        walkLogFiles(logsDirectory);
+    }
+}
+async function run() {
+    const logger = (0, logging_1.getActionsLogger)();
+    let config = undefined;
+    config = await (0, config_utils_1.getConfig)(actionsUtil.getTemporaryDirectory(), logger);
+    if (config === undefined) {
+        throw new Error("Config file could not be found at expected location. Has the 'init' action been called?");
+    }
+    // Upload appropriate Actions artifacts for debugging
+    if (config === null || config === void 0 ? void 0 : config.debugMode) {
+        await uploadLogsDebugArtifact(config);
+        await uploadFinalLogsDebugArtifact(config);
+        // TODO(angelapwen): Add database bundle upload.
+    }
+}
+async function runWrapper() {
+    try {
+        await run();
+    }
+    catch (error) {
+        core.setFailed(`init action cleanup failed: ${error}`);
+        console.log(error);
+    }
+}
+void runWrapper();
+//# sourceMappingURL=init-action-cleanup.js.map

lib/init-action-cleanup.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"init-action-cleanup.js","sourceRoot":"","sources":["../src/init-action-cleanup.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;AAAA,uCAAyB;AACzB,2CAA6B;AAE7B,oDAAsC;AAEtC,4DAA8C;AAC9C,qCAAiE;AACjE,iDAAmD;AACnD,uCAA6C;AAC7C,iCAAmE;AAEnE,SAAS,UAAU,CAAC,GAAW;IAC7B,MAAM,OAAO,GAAG,EAAE,CAAC,WAAW,CAAC,GAAG,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;IAC7D,IAAI,KAAK,GAAa,EAAE,CAAC;IACzB,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE;QAC3B,IAAI,KAAK,CAAC,MAAM,EAAE,EAAE;YAClB,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;SAC3C;aAAM,IAAI,KAAK,CAAC,WAAW,EAAE,EAAE;YAC9B,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;SACjE;KACF;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,KAAK,UAAU,uBAAuB,CAAC,MAAc;IACnD,MAAM,MAAM,GAAG,MAAM,IAAA,kBAAS,EAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAEjD,IAAI,QAAQ,GAAa,EAAE,CAAC;IAC5B,KAAK,MAAM,QAAQ,IAAI,MAAM,CAAC,SAAS,EAAE;QACvC,MAAM,iBAAiB,GAAG,IAAA,4BAAqB,EAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;QAClE,MAAM,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,iBAAiB,EAAE,KAAK,CAAC,CAAC;QAC7D,IAAI,WAAW,CAAC,kBAAkB,CAAC,aAAa,CAAC,EAAE;YACjD,QAAQ,GAAG,QAAQ,CAAC,MAAM,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC,CAAC;SACvD;KACF;IAED,IAAI,MAAM,IAAA,yBAAkB,EAAC,MAAM,EAAE,mCAA0B,CAAC,EAAE;QAChE,8EAA8E;QAC9E,MAAM,iCAAiC,GAAG,IAAI,CAAC,OAAO,CACpD,MAAM,CAAC,UAAU,EACjB,KAAK,CACN,CAAC;QACF,IAAI,WAAW,CAAC,kBAAkB,CAAC,iCAAiC,CAAC,EAAE;YACrE,QAAQ,GAAG,QAAQ,CAAC,MAAM,CAAC,UAAU,CAAC,iCAAiC,CAAC,CAAC,CAAC;SAC3E;KACF;IACD,MAAM,WAAW,CAAC,oBAAoB,CACpC,QAAQ,EACR,MAAM,CAAC,UAAU,EACjB,MAAM,CAAC,iBAAiB,CACzB,CAAC;IAEF,sFAAsF;IACtF,IAAI,CAAC,CAAC,MAAM,IAAA,yBAAkB,EAAC,MAAM,EAAE,mCAA0B,CAAC,CAAC,EAAE;QACnE,MAAM,+BAA+B,GAAG,IAAI,CAAC,OAAO,CAClD,MAAM,CAAC,OAAO,EACd,2BAA2B,CAC5B,CAAC;QACF,IAAI,WAAW,CAAC,kBAAkB,CAAC,+BAA+B,CAAC,EAAE;YACnE,MAAM,WAAW,CAAC,oBAAoB,CACpC,CAAC,+BAA+B,CAAC,EACjC,MAAM,CAAC,OAAO,EACd,MAAM,CAAC,iBAAiB,CACzB,CAAC;SACH;KACF;AACH,CAAC;AAED,KAAK,UAAU,4BAA4B,CAAC,MAAc;IACxD,IAAI,CAAC,IAAI,CAAC,iDAAiD,CAAC,CAAC;IAC7D,KAAK,MAAM,QAAQ,IAAI,MAAM,CAAC,SAAS,EAAE;QACvC,MAAM,iBAAiB,GAAG,IAAA,4BAAqB,EAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;QAClE,MAAM,aAAa,GAAG,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,KAAK,CAAC,CAAC;QAC1D,IAAI,CAAC,WAAW,CAAC,kBAAkB,CAAC,aAAa,CAAC,EAAE;YAClD,IAAI,CAAC,IAAI,CAAC,aAAa,aAAa,kBAAkB,CAAC,CAAC;YACxD,SAAS,CAAC,+BAA+B;SAC1C;QAED,MAAM,YAAY,GAAG,CAAC,GAAW,EAAE,EAAE;YACnC,MAAM,OAAO,GAAG,EAAE,CAAC,WAAW,CAAC,GAAG,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;YAC7D,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE;gBACxB,IAAI,CAAC,IAAI,CAAC,oCAAoC,aAAa,GAAG,CAAC,CAAC;aACjE;YACD,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE;gBAC3B,IAAI,KAAK,CAAC,MAAM,EAAE,EAAE;oBAClB,IAAI,CAAC,UAAU,CAAC,uBAAuB,QAAQ,MAAM,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC;oBACnE,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;oBACrE,IAAI,CAAC,QAAQ,EAAE,CAAC;iBACjB;qBAAM,IAAI,KAAK,CAAC,WAAW,EAAE,EAAE;oBAC9B,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;iBAC7C;aACF;QACH,CAAC,CAAC;QACF,YAAY,CAAC,aAAa,CAAC,CAAC;KAC7B;AACH,CAAC;AAED,KAAK,UAAU,GAAG;IAChB,MAAM,MAAM,GAAG,IAAA,0BAAgB,GAAE,CAAC;IAElC,IAAI,MAAM,GAAuB,SAAS,CAAC;IAC3C,MAAM,GAAG,MAAM,IAAA,wBAAS,EAAC,WAAW,CAAC,qBAAqB,EAAE,EAAE,MAAM,CAAC,CAAC;IACtE,IAAI,MAAM,KAAK,SAAS,EAAE;QACxB,MAAM,IAAI,KAAK,CACb,yFAAyF,CAC1F,CAAC;KACH;IAED,qDAAqD;IACrD,IAAI,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,SAAS,EAAE;QACrB,MAAM,uBAAuB,CAAC,MAAM,CAAC,CAAC;QACtC,MAAM,4BAA4B,CAAC,MAAM,CAAC,CAAC;QAC3C,gDAAgD;KACjD;AACH,CAAC;AAED,KAAK,UAAU,UAAU;IACvB,IAAI;QACF,MAAM,GAAG,EAAE,CAAC;KACb;IAAC,OAAO,KAAK,EAAE;QACd,IAAI,CAAC,SAAS,CAAC,+BAA+B,KAAK,EAAE,CAAC,CAAC;QACvD,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;KACpB;AACH,CAAC;AAED,KAAK,UAAU,EAAE,CAAC"}

src/actions-util.ts

@@ -2,14 +2,18 @@ import * as fs from "fs";
 import * as os from "os";
 import * as path from "path";
 
+import * as artifact from "@actions/artifact";
 import * as core from "@actions/core";
 import * as toolrunner from "@actions/exec/lib/toolrunner";
 import * as safeWhich from "@chrisgavin/safe-which";
 import * as yaml from "js-yaml";
 
 import * as api from "./api-client";
+import { getCodeQL } from "./codeql";
+import { Config } from "./config-utils";
 import * as sharedEnv from "./shared-environment";
 import {
+  bundleDb,
   getCachedCodeQlVersion,
   getRequiredEnvParam,
   GITHUB_DOTCOM_URL,
@@ -875,3 +879,59 @@ export async function isAnalyzingDefaultBranch(): Promise<boolean> {
 export function sanitizeArifactName(name: string): string {
   return name.replace(/[^a-zA-Z0-9_\\-]+/g, "");
 }
+
+// REVIEW: Not sure this is the best place for this function?
+export function doesDirectoryExist(dirPath: string) {
+  try {
+    const stats = fs.lstatSync(dirPath);
+    return stats.isDirectory();
+  } catch (e) {
+    return false;
+  }
+}
+
+export async function uploadDebugArtifacts(
+  toUpload: string[],
+  rootDir: string,
+  artifactName: string
+) {
+  if (toUpload.length === 0) {
+    return;
+  }
+  let suffix = "";
+  const matrix = getRequiredInput("matrix");
+  if (matrix !== undefined && matrix !== "null") {
+    for (const entry of Object.entries(JSON.parse(matrix)).sort())
+      suffix += `-${entry[1]}`;
+  }
+  await artifact.create().uploadArtifact(
+    sanitizeArifactName(`${artifactName}${suffix}`),
+    toUpload.map((file) => path.normalize(file)),
+    path.normalize(rootDir)
+  );
+}
+
+// TODO(angelapwen): this method doesn't work yet for incomplete database
+// bundles. Move caller to init-action-cleanup after implementation.
+export async function uploadDatabaseBundleDebugArtifact(config: Config) {
+  try {
+    const toUpload: string[] = [];
+    for (const language of config.languages) {
+      toUpload.push(
+        await bundleDb(
+          config,
+          language,
+          await getCodeQL(config.codeQLCmd),
+          `${config.debugDatabaseName}-${language}`
+        )
+      );
+    }
+    await uploadDebugArtifacts(
+      toUpload,
+      config.dbLocation,
+      config.debugArtifactName
+    );
+  } catch (error) {
+    console.log(`Failed to upload database debug bundles: ${error}`);
+  }
+}

src/analyze-action-cleanup.ts

@@ -0,0 +1,56 @@
+import * as fs from "fs";
+import * as path from "path";
+
+import * as core from "@actions/core";
+
+import * as actionsUtil from "./actions-util";
+import { Config, getConfig } from "./config-utils";
+import { getActionsLogger } from "./logging";
+
+async function uploadSarifDebugArtifact(config: Config, outputDir: string) {
+  if (!actionsUtil.doesDirectoryExist(outputDir)) {
+    return;
+  }
+
+  let toUpload: string[] = [];
+  for (const lang of config.languages) {
+    const sarifFile = path.resolve(outputDir, `${lang}.sarif`);
+    if (fs.existsSync(sarifFile)) {
+      toUpload = toUpload.concat(sarifFile);
+    }
+  }
+  await actionsUtil.uploadDebugArtifacts(
+    toUpload,
+    outputDir,
+    config.debugArtifactName
+  );
+}
+
+async function run() {
+  const logger = getActionsLogger();
+
+  let config: Config | undefined = undefined;
+  config = await getConfig(actionsUtil.getTemporaryDirectory(), logger);
+  if (config === undefined) {
+    throw new Error(
+      "Config file could not be found at expected location. Has the 'init' action been called?"
+    );
+  }
+
+  // Upload Actions SARIF artifacts for debugging
+  if (config?.debugMode) {
+    const outputDir = actionsUtil.getRequiredInput("output");
+    await uploadSarifDebugArtifact(config, outputDir);
+  }
+}
+
+async function runWrapper() {
+  try {
+    await run();
+  } catch (error) {
+    core.setFailed(`analyze action cleanup failed: ${error}`);
+    console.log(error);
+  }
+}
+
+void runWrapper();

src/analyze-action.ts

@@ -1,7 +1,3 @@
-import * as fs from "fs";
-import * as path from "path";
-
-import * as artifact from "@actions/artifact";
 import * as core from "@actions/core";
 
 import * as actionsUtil from "./actions-util";
@@ -13,7 +9,7 @@ import {
   runFinalize,
 } from "./analyze";
 import { getGitHubVersionActionsOnly } from "./api-client";
-import { CODEQL_VERSION_NEW_TRACING, getCodeQL } from "./codeql";
+import { getCodeQL } from "./codeql";
 import { Config, getConfig } from "./config-utils";
 import { uploadDatabases } from "./database-upload";
 import { GitHubFeatureFlags } from "./feature-flags";
@@ -22,7 +18,6 @@ import { parseRepositoryNwo } from "./repository";
 import * as upload_lib from "./upload-lib";
 import { UploadResult } from "./upload-lib";
 import * as util from "./util";
-import { bundleDb, codeQlVersionAbove } from "./util";
 
 // eslint-disable-next-line import/no-commonjs
 const pkg = require("../package.json");
@@ -134,50 +129,6 @@ async function run() {
         config,
         logger
       );
-
-      if (config.debugMode) {
-        // Upload the SARIF files as an Actions artifact for debugging
-        await uploadDebugArtifacts(
-          config.languages.map((lang) =>
-            path.resolve(outputDir, `${lang}.sarif`)
-          ),
-          outputDir,
-          config.debugArtifactName
-        );
-      }
-    }
-
-    const codeql = await getCodeQL(config.codeQLCmd);
-
-    if (config.debugMode) {
-      // Upload the logs as an Actions artifact for debugging
-      let toUpload: string[] = [];
-      for (const language of config.languages) {
-        toUpload = toUpload.concat(
-          listFolder(
-            path.resolve(util.getCodeQLDatabasePath(config, language), "log")
-          )
-        );
-      }
-      if (await codeQlVersionAbove(codeql, CODEQL_VERSION_NEW_TRACING)) {
-        // Multilanguage tracing: there are additional logs in the root of the cluster
-        toUpload = toUpload.concat(
-          listFolder(path.resolve(config.dbLocation, "log"))
-        );
-      }
-      await uploadDebugArtifacts(
-        toUpload,
-        config.dbLocation,
-        config.debugArtifactName
-      );
-      if (!(await codeQlVersionAbove(codeql, CODEQL_VERSION_NEW_TRACING))) {
-        // Before multi-language tracing, we wrote a compound-build-tracer.log in the temp dir
-        await uploadDebugArtifacts(
-          [path.resolve(config.tempDir, "compound-build-tracer.log")],
-          config.tempDir,
-          config.debugArtifactName
-        );
-      }
     }
 
     if (actionsUtil.getOptionalInput("cleanup-level") !== "none") {
@@ -239,53 +190,7 @@ async function run() {
     return;
   } finally {
     if (config?.debugMode) {
-      try {
-        // Upload the database bundles as an Actions artifact for debugging
-        const toUpload: string[] = [];
-        for (const language of config.languages) {
-          toUpload.push(
-            await bundleDb(
-              config,
-              language,
-              await getCodeQL(config.codeQLCmd),
-              `${config.debugDatabaseName}-${language}`
-            )
-          );
-        }
-        await uploadDebugArtifacts(
-          toUpload,
-          config.dbLocation,
-          config.debugArtifactName
-        );
-      } catch (error) {
-        console.log(`Failed to upload database debug bundles: ${error}`);
-      }
-    }
-
-    if (config?.debugMode) {
-      core.info("Debug mode is on. Printing CodeQL debug logs...");
-      for (const language of config.languages) {
-        const databaseDirectory = util.getCodeQLDatabasePath(config, language);
-        const logsDirectory = path.join(databaseDirectory, "log");
-
-        const walkLogFiles = (dir: string) => {
-          const entries = fs.readdirSync(dir, { withFileTypes: true });
-          for (const entry of entries) {
-            if (entry.isFile()) {
-              core.startGroup(
-                `CodeQL Debug Logs - ${language} - ${entry.name}`
-              );
-              process.stdout.write(
-                fs.readFileSync(path.resolve(dir, entry.name))
-              );
-              core.endGroup();
-            } else if (entry.isDirectory()) {
-              walkLogFiles(path.resolve(dir, entry.name));
-            }
-          }
-        };
-        walkLogFiles(logsDirectory);
-      }
+      await actionsUtil.uploadDatabaseBundleDebugArtifact(config);
     }
   }
 
@@ -301,37 +206,6 @@ async function run() {
   }
 }
 
-async function uploadDebugArtifacts(
-  toUpload: string[],
-  rootDir: string,
-  artifactName: string
-) {
-  let suffix = "";
-  const matrix = actionsUtil.getRequiredInput("matrix");
-  if (matrix !== undefined && matrix !== "null") {
-    for (const entry of Object.entries(JSON.parse(matrix)).sort())
-      suffix += `-${entry[1]}`;
-  }
-  await artifact.create().uploadArtifact(
-    actionsUtil.sanitizeArifactName(`${artifactName}${suffix}`),
-    toUpload.map((file) => path.normalize(file)),
-    path.normalize(rootDir)
-  );
-}
-
-function listFolder(dir: string): string[] {
-  const entries = fs.readdirSync(dir, { withFileTypes: true });
-  let files: string[] = [];
-  for (const entry of entries) {
-    if (entry.isFile()) {
-      files.push(path.resolve(dir, entry.name));
-    } else if (entry.isDirectory()) {
-      files = files.concat(listFolder(path.resolve(dir, entry.name)));
-    }
-  }
-  return files;
-}
-
 export const runPromise = run();
 
 async function runWrapper() {

src/init-action-cleanup.ts

@@ -0,0 +1,126 @@
+import * as fs from "fs";
+import * as path from "path";
+
+import * as core from "@actions/core";
+
+import * as actionsUtil from "./actions-util";
+import { CODEQL_VERSION_NEW_TRACING, getCodeQL } from "./codeql";
+import { Config, getConfig } from "./config-utils";
+import { getActionsLogger } from "./logging";
+import { codeQlVersionAbove, getCodeQLDatabasePath } from "./util";
+
+function listFolder(dir: string): string[] {
+  const entries = fs.readdirSync(dir, { withFileTypes: true });
+  let files: string[] = [];
+  for (const entry of entries) {
+    if (entry.isFile()) {
+      files.push(path.resolve(dir, entry.name));
+    } else if (entry.isDirectory()) {
+      files = files.concat(listFolder(path.resolve(dir, entry.name)));
+    }
+  }
+  return files;
+}
+
+async function uploadLogsDebugArtifact(config: Config) {
+  const codeql = await getCodeQL(config.codeQLCmd);
+
+  let toUpload: string[] = [];
+  for (const language of config.languages) {
+    const databaseDirectory = getCodeQLDatabasePath(config, language);
+    const logsDirectory = path.resolve(databaseDirectory, "log");
+    if (actionsUtil.doesDirectoryExist(logsDirectory)) {
+      toUpload = toUpload.concat(listFolder(logsDirectory));
+    }
+  }
+
+  if (await codeQlVersionAbove(codeql, CODEQL_VERSION_NEW_TRACING)) {
+    // Multilanguage tracing: there are additional logs in the root of the cluster
+    const multiLanguageTracingLogsDirectory = path.resolve(
+      config.dbLocation,
+      "log"
+    );
+    if (actionsUtil.doesDirectoryExist(multiLanguageTracingLogsDirectory)) {
+      toUpload = toUpload.concat(listFolder(multiLanguageTracingLogsDirectory));
+    }
+  }
+  await actionsUtil.uploadDebugArtifacts(
+    toUpload,
+    config.dbLocation,
+    config.debugArtifactName
+  );
+
+  // Before multi-language tracing, we wrote a compound-build-tracer.log in the temp dir
+  if (!(await codeQlVersionAbove(codeql, CODEQL_VERSION_NEW_TRACING))) {
+    const compoundBuildTracerLogDirectory = path.resolve(
+      config.tempDir,
+      "compound-build-tracer.log"
+    );
+    if (actionsUtil.doesDirectoryExist(compoundBuildTracerLogDirectory)) {
+      await actionsUtil.uploadDebugArtifacts(
+        [compoundBuildTracerLogDirectory],
+        config.tempDir,
+        config.debugArtifactName
+      );
+    }
+  }
+}
+
+async function uploadFinalLogsDebugArtifact(config: Config) {
+  core.info("Debug mode is on. Printing CodeQL debug logs...");
+  for (const language of config.languages) {
+    const databaseDirectory = getCodeQLDatabasePath(config, language);
+    const logsDirectory = path.join(databaseDirectory, "log");
+    if (!actionsUtil.doesDirectoryExist(logsDirectory)) {
+      core.info(`Directory ${logsDirectory} does not exist.`);
+      continue; // Skip this language database.
+    }
+
+    const walkLogFiles = (dir: string) => {
+      const entries = fs.readdirSync(dir, { withFileTypes: true });
+      if (entries.length === 0) {
+        core.info(`No debug logs found at directory ${logsDirectory}.`);
+      }
+      for (const entry of entries) {
+        if (entry.isFile()) {
+          core.startGroup(`CodeQL Debug Logs - ${language} - ${entry.name}`);
+          process.stdout.write(fs.readFileSync(path.resolve(dir, entry.name)));
+          core.endGroup();
+        } else if (entry.isDirectory()) {
+          walkLogFiles(path.resolve(dir, entry.name));
+        }
+      }
+    };
+    walkLogFiles(logsDirectory);
+  }
+}
+
+async function run() {
+  const logger = getActionsLogger();
+
+  let config: Config | undefined = undefined;
+  config = await getConfig(actionsUtil.getTemporaryDirectory(), logger);
+  if (config === undefined) {
+    throw new Error(
+      "Config file could not be found at expected location. Has the 'init' action been called?"
+    );
+  }
+
+  // Upload appropriate Actions artifacts for debugging
+  if (config?.debugMode) {
+    await uploadLogsDebugArtifact(config);
+    await uploadFinalLogsDebugArtifact(config);
+    // TODO(angelapwen): Add database bundle upload.
+  }
+}
+
+async function runWrapper() {
+  try {
+    await run();
+  } catch (error) {
+    core.setFailed(`init action cleanup failed: ${error}`);
+    console.log(error);
+  }
+}
+
+void runWrapper();