Merge pull request #1034 from actions/kotewar/save-warnings

Warning added for save only action

.devcontainer/devcontainer.json

@@ -6,7 +6,7 @@
 	// Use 'forwardPorts' to make a list of ports inside the container available locally.
 	// "forwardPorts": [],
 	// Use 'postCreateCommand' to run commands after the container is created.
-	"postCreateCommand": "npm install && npm run build"
+	"postCreateCommand": "npm install"
 	// Configure tool-specific properties.
 	// "customizations": {},
 	// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.

__tests__/saveOnly.test.ts

@@ -91,3 +91,31 @@ test("save with valid inputs uploads a cache", async () => {
 
     expect(failedMock).toHaveBeenCalledTimes(0);
 });
+
+test("save failing logs the warning message", async () => {
+    const warningMock = jest.spyOn(core, "warning");
+
+    const primaryKey = "Linux-node-bb828da54c148048dd17899ba9fda624811cfb43";
+
+    const inputPath = "node_modules";
+    testUtils.setInput(Inputs.Key, primaryKey);
+    testUtils.setInput(Inputs.Path, inputPath);
+    testUtils.setInput(Inputs.UploadChunkSize, "4000000");
+
+    const cacheId = -1;
+    const saveCacheMock = jest
+        .spyOn(cache, "saveCache")
+        .mockImplementationOnce(() => {
+            return Promise.resolve(cacheId);
+        });
+
+    await run();
+
+    expect(saveCacheMock).toHaveBeenCalledTimes(1);
+    expect(saveCacheMock).toHaveBeenCalledWith([inputPath], primaryKey, {
+        uploadChunkSize: 4000000
+    });
+
+    expect(warningMock).toHaveBeenCalledTimes(1);
+    expect(warningMock).toHaveBeenCalledWith("Cache save failed.");
+});

__tests__/stateProvider.test.ts

@@ -25,16 +25,15 @@ afterEach(() => {
 });
 
 test("StateProvider saves states", async () => {
+    const states = new Map<string, string>();
     const getStateMock = jest
         .spyOn(core, "getState")
-        .mockImplementation(name =>
-            jest.requireActual("@actions/core").getState(name)
-        );
+        .mockImplementation(key => states.get(key) || "");
 
     const saveStateMock = jest
         .spyOn(core, "saveState")
         .mockImplementation((key, value) => {
-            return jest.requireActual("@actions/core").saveState(key, value);
+            states.set(key, value);
         });
 
     const setOutputMock = jest
@@ -48,9 +47,11 @@ test("StateProvider saves states", async () => {
     const stateProvider: IStateProvider = new StateProvider();
     stateProvider.setState("stateKey", "stateValue");
     stateProvider.setState(State.CacheMatchedKey, cacheMatchedKey);
-    stateProvider.getState("stateKey");
-    stateProvider.getCacheState();
+    const stateValue = stateProvider.getState("stateKey");
+    const cacheStateValue = stateProvider.getCacheState();
 
+    expect(stateValue).toBe("stateValue");
+    expect(cacheStateValue).toBe(cacheMatchedKey);
     expect(getStateMock).toHaveBeenCalledTimes(2);
     expect(saveStateMock).toHaveBeenCalledTimes(2);
     expect(setOutputMock).toHaveBeenCalledTimes(0);

dist/save-only/index.js

@@ -1043,6 +1043,29 @@ class ExecState extends events.EventEmitter {
 
 "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 (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;
+};
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
@@ -1056,11 +1079,15 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+const core = __importStar(__webpack_require__(470));
 const saveImpl_1 = __importDefault(__webpack_require__(471));
 const stateProvider_1 = __webpack_require__(309);
 function run() {
     return __awaiter(this, void 0, void 0, function* () {
-        yield (0, saveImpl_1.default)(new stateProvider_1.NullStateProvider());
+        const cacheId = yield (0, saveImpl_1.default)(new stateProvider_1.NullStateProvider());
+        if (cacheId === -1) {
+            core.warning(`Cache save failed.`);
+        }
     });
 }
 run();
@@ -41092,6 +41119,7 @@ const utils = __importStar(__webpack_require__(443));
 process.on("uncaughtException", e => utils.logWarning(e.message));
 function saveImpl(stateProvider) {
     return __awaiter(this, void 0, void 0, function* () {
+        let cacheId = -1;
         try {
             if (!utils.isCacheFeatureAvailable()) {
                 return;
@@ -41118,7 +41146,7 @@ function saveImpl(stateProvider) {
             const cachePaths = utils.getInputAsArray(constants_1.Inputs.Path, {
                 required: true
             });
-            const cacheId = yield cache.saveCache(cachePaths, primaryKey, {
+            cacheId = yield cache.saveCache(cachePaths, primaryKey, {
                 uploadChunkSize: utils.getInputAsInt(constants_1.Inputs.UploadChunkSize)
             });
             if (cacheId != -1) {
@@ -41128,6 +41156,7 @@ function saveImpl(stateProvider) {
         catch (error) {
             utils.logWarning(error.message);
         }
+        return cacheId;
     });
 }
 exports.default = saveImpl;

dist/save/index.js

@@ -41063,6 +41063,7 @@ const utils = __importStar(__webpack_require__(443));
 process.on("uncaughtException", e => utils.logWarning(e.message));
 function saveImpl(stateProvider) {
     return __awaiter(this, void 0, void 0, function* () {
+        let cacheId = -1;
         try {
             if (!utils.isCacheFeatureAvailable()) {
                 return;
@@ -41089,7 +41090,7 @@ function saveImpl(stateProvider) {
             const cachePaths = utils.getInputAsArray(constants_1.Inputs.Path, {
                 required: true
             });
-            const cacheId = yield cache.saveCache(cachePaths, primaryKey, {
+            cacheId = yield cache.saveCache(cachePaths, primaryKey, {
                 uploadChunkSize: utils.getInputAsInt(constants_1.Inputs.UploadChunkSize)
             });
             if (cacheId != -1) {
@@ -41099,6 +41100,7 @@ function saveImpl(stateProvider) {
         catch (error) {
             utils.logWarning(error.message);
         }
+        return cacheId;
     });
 }
 exports.default = saveImpl;

src/saveImpl.ts

@@ -10,7 +10,8 @@ import * as utils from "./utils/actionUtils";
 // throw an uncaught exception.  Instead of failing this action, just warn.
 process.on("uncaughtException", e => utils.logWarning(e.message));
 
-async function saveImpl(stateProvider: IStateProvider): Promise<void> {
+async function saveImpl(stateProvider: IStateProvider): Promise<number | void> {
+    let cacheId = -1;
     try {
         if (!utils.isCacheFeatureAvailable()) {
             return;
@@ -51,7 +52,7 @@ async function saveImpl(stateProvider: IStateProvider): Promise<void> {
             required: true
         });
 
-        const cacheId = await cache.saveCache(cachePaths, primaryKey, {
+        cacheId = await cache.saveCache(cachePaths, primaryKey, {
             uploadChunkSize: utils.getInputAsInt(Inputs.UploadChunkSize)
         });
 
@@ -61,6 +62,7 @@ async function saveImpl(stateProvider: IStateProvider): Promise<void> {
     } catch (error: unknown) {
         utils.logWarning((error as Error).message);
     }
+    return cacheId;
 }
 
 export default saveImpl;

src/saveOnly.ts

@@ -1,8 +1,13 @@
+import * as core from "@actions/core";
+
 import saveImpl from "./saveImpl";
 import { NullStateProvider } from "./stateProvider";
 
 async function run(): Promise<void> {
-    await saveImpl(new NullStateProvider());
+    const cacheId = await saveImpl(new NullStateProvider());
+    if (cacheId === -1) {
+        core.warning(`Cache save failed.`);
+    }
 }
 
 run();