cache/src/restore.ts

import * as cache from "@actions/cache";
import * as core from "@actions/core";

import { Events, Inputs, State, Variables } from "./constants";
import * as utils from "./utils/actionUtils";

async function run(): Promise<void> {
    try {
        if (!utils.isCacheFeatureAvailable()) {
            utils.setCacheHitOutput(false);
            return;
        }

        // Validate inputs, this can cause task failure
        if (!utils.isValidEvent()) {
            utils.logWarning(
                `Event Validation Error: The event type ${
                    process.env[Events.Key]
                } is not supported because it's not tied to a branch or tag ref.`
            );
            return;
        }

        const primaryKey = core.getInput(Inputs.Key, { required: true });
        core.saveState(State.CachePrimaryKey, primaryKey);

        const restoreKeys = utils.getInputAsArray(Inputs.RestoreKeys);
        const cachePaths = utils.getInputAsArray(Inputs.Path, {
            required: true
        });

        const cacheKey = await cache.restoreCache(
            cachePaths,
            primaryKey,
            restoreKeys
        );

        //Check if user wants to save cache despite of failure in any previous job
        const saveCache = core.getInput(Inputs.SaveOnAnyFailure).toLowerCase();
        if (saveCache == "true") {
            core.debug(
                `Exporting environment variable ${Variables.SaveCacheOnAnyFailure}`
            );
            core.exportVariable(Variables.SaveCacheOnAnyFailure, saveCache);
            core.info(
                `Input Variable ${Variables.SaveCacheOnAnyFailure} is set to true, the cache will be saved despite of any failure in the build.`
            );
        }

        if (!cacheKey) {
            if (core.getInput(Inputs.FailOnCacheMiss).toLowerCase() == "true") {
                throw new Error(
                    `Cache with the given input key ${primaryKey} is not found, hence exiting the workflow as the fail-on-cache-miss requirement is not met.`
                );
            }
            core.info(
                `Cache not found for input keys: ${[
                    primaryKey,
                    ...restoreKeys
                ].join(", ")}`
            );
            return;
        }
        // Store the matched cache key
        utils.setCacheState(cacheKey);

        const isExactKeyMatch = utils.isExactKeyMatch(primaryKey, cacheKey);
        utils.setCacheHitOutput(isExactKeyMatch);

        if (
            !isExactKeyMatch &&
            core.getBooleanInput(Inputs.FailOnCacheMiss) == true
        ) {
            throw new Error(
                `Restored cache key doesn't match the given input key ${primaryKey}, hence exiting the workflow as the fail-on-cache-miss requirement is not met.`
            );
        }
        core.info(`Cache restored from key: ${cacheKey}`);
    } catch (error: unknown) {
        core.setFailed((error as Error).message);
    }
}

run();

export default run;