codeql-action/lib/diff-informed-analysis-utils.js

"use strict";
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
    if (k2 === undefined) k2 = k;
    var desc = Object.getOwnPropertyDescriptor(m, k);
    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
      desc = { enumerable: true, get: function() { return m[k]; } };
    }
    Object.defineProperty(o, k2, desc);
}) : (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 () {
    var ownKeys = function(o) {
        ownKeys = Object.getOwnPropertyNames || function (o) {
            var ar = [];
            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
            return ar;
        };
        return ownKeys(o);
    };
    return function (mod) {
        if (mod && mod.__esModule) return mod;
        var result = {};
        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
        __setModuleDefault(result, mod);
        return result;
    };
})();
Object.defineProperty(exports, "__esModule", { value: true });
exports.shouldPerformDiffInformedAnalysis = shouldPerformDiffInformedAnalysis;
exports.getDiffInformedAnalysisBranches = getDiffInformedAnalysisBranches;
exports.writeDiffRangesJsonFile = writeDiffRangesJsonFile;
exports.readDiffRangesJsonFile = readDiffRangesJsonFile;
const fs = __importStar(require("fs"));
const path = __importStar(require("path"));
const github = __importStar(require("@actions/github"));
const actionsUtil = __importStar(require("./actions-util"));
const feature_flags_1 = require("./feature-flags");
function getPullRequestBranches() {
    const pullRequest = github.context.payload.pull_request;
    if (pullRequest) {
        return {
            base: pullRequest.base.ref,
            // We use the head label instead of the head ref here, because the head
            // ref lacks owner information and by itself does not uniquely identify
            // the head branch (which may be in a forked repository).
            head: pullRequest.head.label,
        };
    }
    // PR analysis under Default Setup does not have the pull_request context,
    // but it should set CODE_SCANNING_REF and CODE_SCANNING_BASE_BRANCH.
    const codeScanningRef = process.env.CODE_SCANNING_REF;
    const codeScanningBaseBranch = process.env.CODE_SCANNING_BASE_BRANCH;
    if (codeScanningRef && codeScanningBaseBranch) {
        return {
            base: codeScanningBaseBranch,
            // PR analysis under Default Setup analyzes the PR head commit instead of
            // the merge commit, so we can use the provided ref directly.
            head: codeScanningRef,
        };
    }
    return undefined;
}
/**
 * Check if the action should perform diff-informed analysis.
 */
async function shouldPerformDiffInformedAnalysis(codeql, features, logger) {
    return ((await getDiffInformedAnalysisBranches(codeql, features, logger)) !==
        undefined);
}
/**
 * Get the branches to use for diff-informed analysis.
 *
 * @returns If the action should perform diff-informed analysis, return
 * the base and head branches that should be used to compute the diff ranges.
 * Otherwise return `undefined`.
 */
async function getDiffInformedAnalysisBranches(codeql, features, logger) {
    if (!(await features.getValue(feature_flags_1.Feature.DiffInformedQueries, codeql))) {
        return undefined;
    }
    const branches = getPullRequestBranches();
    if (!branches) {
        logger.info("Not performing diff-informed analysis " +
            "because we are not analyzing a pull request.");
    }
    return branches;
}
function getDiffRangesJsonFilePath() {
    return path.join(actionsUtil.getTemporaryDirectory(), "pr-diff-range.json");
}
function writeDiffRangesJsonFile(logger, ranges) {
    const jsonContents = JSON.stringify(ranges, null, 2);
    const jsonFilePath = getDiffRangesJsonFilePath();
    fs.writeFileSync(jsonFilePath, jsonContents);
    logger.debug(`Wrote pr-diff-range JSON file to ${jsonFilePath}:\n${jsonContents}`);
}
function readDiffRangesJsonFile(logger) {
    const jsonFilePath = getDiffRangesJsonFilePath();
    if (!fs.existsSync(jsonFilePath)) {
        logger.debug(`Diff ranges JSON file does not exist at ${jsonFilePath}`);
        return undefined;
    }
    const jsonContents = fs.readFileSync(jsonFilePath, "utf8");
    logger.debug(`Read pr-diff-range JSON file from ${jsonFilePath}:\n${jsonContents}`);
    return JSON.parse(jsonContents);
}
//# sourceMappingURL=diff-informed-analysis-utils.js.map