Don't autoclose file

More visibility into the samples by having it on the main README. Easier to see, better SEO.

README.md

@@ -54,9 +54,26 @@ jobs:
       run: /primes.sh -d prime-numbers
 ```
 
-## Ecosystem Examples
+## Implementation Examples
+
+Every programming language and framework has it's own way of caching. 
+
+See [Examples](examples.md) for a list of `actions/cache` implementations for use with:
+
+- [C# - Nuget](./examples.md#c---nuget)
+- [Elixir - Mix](./examples.md#elixir---mix)
+- [Go - Modules](./examples.md#go---modules)
+- [Java - Gradle](./examples.md#java---gradle)
+- [Java - Maven](./examples.md#java---maven)
+- [Node - npm](./examples.md#node---npm)
+- [Node - Yarn](./examples.md#node---yarn)
+- [PHP - Composer](./examples.md#php---composer)
+- [Python - pip](./examples.md#python---pip)
+- [Ruby - Gem](./examples.md#ruby---gem)
+- [Rust - Cargo](./examples.md#rust---cargo)
+- [Swift, Objective-C - Carthage](./examples.md#swift-objective-c---carthage)
+- [Swift, Objective-C - CocoaPods](./examples.md#swift-objective-c---cocoapods)
 
-See [Examples](examples.md)
 
 ## Cache Limits
 

__tests__/restore.test.ts

@@ -1,16 +1,18 @@
 import * as core from "@actions/core";
+import * as exec from "@actions/exec";
+import * as io from "@actions/io";
 import * as path from "path";
 import * as cacheHttpClient from "../src/cacheHttpClient";
 import { Events, Inputs } from "../src/constants";
 import { ArtifactCacheEntry } from "../src/contracts";
 import run from "../src/restore";
-import * as tar from "../src/tar";
 import * as actionUtils from "../src/utils/actionUtils";
 import * as testUtils from "../src/utils/testUtils";
 
-jest.mock("../src/cacheHttpClient");
+jest.mock("@actions/exec");
-jest.mock("../src/tar");
+jest.mock("@actions/io");
 jest.mock("../src/utils/actionUtils");
+jest.mock("../src/cacheHttpClient");
 
 beforeAll(() => {
     jest.spyOn(actionUtils, "resolvePath").mockImplementation(filePath => {
@@ -33,6 +35,10 @@ beforeAll(() => {
         const actualUtils = jest.requireActual("../src/utils/actionUtils");
         return actualUtils.getSupportedEvents();
     });
+
+    jest.spyOn(io, "which").mockImplementation(tool => {
+        return Promise.resolve(tool);
+    });
 });
 
 beforeEach(() => {
@@ -239,7 +245,8 @@ test("restore with cache found", async () => {
         .spyOn(actionUtils, "getArchiveFileSize")
         .mockReturnValue(fileSize);
 
-    const extractTarMock = jest.spyOn(tar, "extractTar");
+    const mkdirMock = jest.spyOn(io, "mkdirP");
+    const execMock = jest.spyOn(exec, "exec");
     const setCacheHitOutputMock = jest.spyOn(actionUtils, "setCacheHitOutput");
 
     await run();
@@ -248,11 +255,27 @@ test("restore with cache found", async () => {
     expect(getCacheMock).toHaveBeenCalledWith([key]);
     expect(setCacheStateMock).toHaveBeenCalledWith(cacheEntry);
     expect(createTempDirectoryMock).toHaveBeenCalledTimes(1);
-    expect(downloadCacheMock).toHaveBeenCalledWith(cacheEntry, archivePath);
+    expect(downloadCacheMock).toHaveBeenCalledWith(
+        cacheEntry.archiveLocation,
+        archivePath
+    );
     expect(getArchiveFileSizeMock).toHaveBeenCalledWith(archivePath);
+    expect(mkdirMock).toHaveBeenCalledWith(cachePath);
 
-    expect(extractTarMock).toHaveBeenCalledTimes(1);
+    const IS_WINDOWS = process.platform === "win32";
-    expect(extractTarMock).toHaveBeenCalledWith(archivePath, cachePath);
+    const args = IS_WINDOWS
+        ? [
+              "-xz",
+              "--force-local",
+              "-f",
+              archivePath.replace(/\\/g, "/"),
+              "-C",
+              cachePath.replace(/\\/g, "/")
+          ]
+        : ["-xz", "-f", archivePath, "-C", cachePath];
+
+    expect(execMock).toHaveBeenCalledTimes(1);
+    expect(execMock).toHaveBeenCalledWith(`"tar"`, args);
 
     expect(setCacheHitOutputMock).toHaveBeenCalledTimes(1);
     expect(setCacheHitOutputMock).toHaveBeenCalledWith(true);
@@ -303,7 +326,8 @@ test("restore with a pull request event and cache found", async () => {
         .spyOn(actionUtils, "getArchiveFileSize")
         .mockReturnValue(fileSize);
 
-    const extractTarMock = jest.spyOn(tar, "extractTar");
+    const mkdirMock = jest.spyOn(io, "mkdirP");
+    const execMock = jest.spyOn(exec, "exec");
     const setCacheHitOutputMock = jest.spyOn(actionUtils, "setCacheHitOutput");
 
     await run();
@@ -312,12 +336,28 @@ test("restore with a pull request event and cache found", async () => {
     expect(getCacheMock).toHaveBeenCalledWith([key]);
     expect(setCacheStateMock).toHaveBeenCalledWith(cacheEntry);
     expect(createTempDirectoryMock).toHaveBeenCalledTimes(1);
-    expect(downloadCacheMock).toHaveBeenCalledWith(cacheEntry, archivePath);
+    expect(downloadCacheMock).toHaveBeenCalledWith(
+        cacheEntry.archiveLocation,
+        archivePath
+    );
     expect(getArchiveFileSizeMock).toHaveBeenCalledWith(archivePath);
     expect(infoMock).toHaveBeenCalledWith(`Cache Size: ~60 MB (62915000 B)`);
+    expect(mkdirMock).toHaveBeenCalledWith(cachePath);
 
-    expect(extractTarMock).toHaveBeenCalledTimes(1);
+    const IS_WINDOWS = process.platform === "win32";
-    expect(extractTarMock).toHaveBeenCalledWith(archivePath, cachePath);
+    const args = IS_WINDOWS
+        ? [
+              "-xz",
+              "--force-local",
+              "-f",
+              archivePath.replace(/\\/g, "/"),
+              "-C",
+              cachePath.replace(/\\/g, "/")
+          ]
+        : ["-xz", "-f", archivePath, "-C", cachePath];
+
+    expect(execMock).toHaveBeenCalledTimes(1);
+    expect(execMock).toHaveBeenCalledWith(`"tar"`, args);
 
     expect(setCacheHitOutputMock).toHaveBeenCalledTimes(1);
     expect(setCacheHitOutputMock).toHaveBeenCalledWith(true);
@@ -368,7 +408,8 @@ test("restore with cache found for restore key", async () => {
         .spyOn(actionUtils, "getArchiveFileSize")
         .mockReturnValue(fileSize);
 
-    const extractTarMock = jest.spyOn(tar, "extractTar");
+    const mkdirMock = jest.spyOn(io, "mkdirP");
+    const execMock = jest.spyOn(exec, "exec");
     const setCacheHitOutputMock = jest.spyOn(actionUtils, "setCacheHitOutput");
 
     await run();
@@ -377,12 +418,28 @@ test("restore with cache found for restore key", async () => {
     expect(getCacheMock).toHaveBeenCalledWith([key, restoreKey]);
     expect(setCacheStateMock).toHaveBeenCalledWith(cacheEntry);
     expect(createTempDirectoryMock).toHaveBeenCalledTimes(1);
-    expect(downloadCacheMock).toHaveBeenCalledWith(cacheEntry, archivePath);
+    expect(downloadCacheMock).toHaveBeenCalledWith(
+        cacheEntry.archiveLocation,
+        archivePath
+    );
     expect(getArchiveFileSizeMock).toHaveBeenCalledWith(archivePath);
     expect(infoMock).toHaveBeenCalledWith(`Cache Size: ~0 MB (142 B)`);
+    expect(mkdirMock).toHaveBeenCalledWith(cachePath);
 
-    expect(extractTarMock).toHaveBeenCalledTimes(1);
+    const IS_WINDOWS = process.platform === "win32";
-    expect(extractTarMock).toHaveBeenCalledWith(archivePath, cachePath);
+    const args = IS_WINDOWS
+        ? [
+              "-xz",
+              "--force-local",
+              "-f",
+              archivePath.replace(/\\/g, "/"),
+              "-C",
+              cachePath.replace(/\\/g, "/")
+          ]
+        : ["-xz", "-f", archivePath, "-C", cachePath];
+
+    expect(execMock).toHaveBeenCalledTimes(1);
+    expect(execMock).toHaveBeenCalledWith(`"tar"`, args);
 
     expect(setCacheHitOutputMock).toHaveBeenCalledTimes(1);
     expect(setCacheHitOutputMock).toHaveBeenCalledWith(false);

__tests__/save.test.ts

@@ -1,17 +1,19 @@
 import * as core from "@actions/core";
+import * as exec from "@actions/exec";
+import * as io from "@actions/io";
 import * as path from "path";
 import * as cacheHttpClient from "../src/cacheHttpClient";
 import { Events, Inputs } from "../src/constants";
 import { ArtifactCacheEntry } from "../src/contracts";
 import run from "../src/save";
-import * as tar from "../src/tar";
 import * as actionUtils from "../src/utils/actionUtils";
 import * as testUtils from "../src/utils/testUtils";
 
 jest.mock("@actions/core");
-jest.mock("../src/cacheHttpClient");
+jest.mock("@actions/exec");
-jest.mock("../src/tar");
+jest.mock("@actions/io");
 jest.mock("../src/utils/actionUtils");
+jest.mock("../src/cacheHttpClient");
 
 beforeAll(() => {
     jest.spyOn(core, "getInput").mockImplementation((name, options) => {
@@ -47,6 +49,10 @@ beforeAll(() => {
     jest.spyOn(actionUtils, "createTempDirectory").mockImplementation(() => {
         return Promise.resolve("/foo/bar");
     });
+
+    jest.spyOn(io, "which").mockImplementation(tool => {
+        return Promise.resolve(tool);
+    });
 });
 
 beforeEach(() => {
@@ -122,7 +128,7 @@ test("save with exact match returns early", async () => {
             return primaryKey;
         });
 
-    const createTarMock = jest.spyOn(tar, "createTar");
+    const execMock = jest.spyOn(exec, "exec");
 
     await run();
 
@@ -130,7 +136,7 @@ test("save with exact match returns early", async () => {
         `Cache hit occurred on the primary key ${primaryKey}, not saving cache.`
     );
 
-    expect(createTarMock).toHaveBeenCalledTimes(0);
+    expect(execMock).toHaveBeenCalledTimes(0);
 
     expect(failedMock).toHaveBeenCalledTimes(0);
 });
@@ -192,9 +198,9 @@ test("save with large cache outputs warning", async () => {
     const cachePath = path.resolve(inputPath);
     testUtils.setInput(Inputs.Path, inputPath);
 
-    const createTarMock = jest.spyOn(tar, "createTar");
+    const execMock = jest.spyOn(exec, "exec");
 
-    const cacheSize = 1024 * 1024 * 1024; //~1GB, over the 400MB limit
+    const cacheSize = 4 * 1024 * 1024 * 1024; //~4GB, over the 2GB limit
     jest.spyOn(actionUtils, "getArchiveFileSize").mockImplementationOnce(() => {
         return cacheSize;
     });
@@ -203,12 +209,25 @@ test("save with large cache outputs warning", async () => {
 
     const archivePath = path.join("/foo/bar", "cache.tgz");
 
-    expect(createTarMock).toHaveBeenCalledTimes(1);
+    const IS_WINDOWS = process.platform === "win32";
-    expect(createTarMock).toHaveBeenCalledWith(archivePath, cachePath);
+    const args = IS_WINDOWS
+        ? [
+              "-cz",
+              "--force-local",
+              "-f",
+              archivePath.replace(/\\/g, "/"),
+              "-C",
+              cachePath.replace(/\\/g, "/"),
+              "."
+          ]
+        : ["-cz", "-f", archivePath, "-C", cachePath, "."];
+
+    expect(execMock).toHaveBeenCalledTimes(1);
+    expect(execMock).toHaveBeenCalledWith(`"tar"`, args);
 
     expect(logWarningMock).toHaveBeenCalledTimes(1);
     expect(logWarningMock).toHaveBeenCalledWith(
-        "Cache size of ~1024 MB (1073741824 B) is over the 400MB limit, not saving cache."
+        "Cache size of ~4 GB (4294967296 B) is over the 2GB limit, not saving cache."
     );
 
     expect(failedMock).toHaveBeenCalledTimes(0);
@@ -240,7 +259,7 @@ test("save with server error outputs warning", async () => {
     const cachePath = path.resolve(inputPath);
     testUtils.setInput(Inputs.Path, inputPath);
 
-    const createTarMock = jest.spyOn(tar, "createTar");
+    const execMock = jest.spyOn(exec, "exec");
 
     const saveCacheMock = jest
         .spyOn(cacheHttpClient, "saveCache")
@@ -252,8 +271,21 @@ test("save with server error outputs warning", async () => {
 
     const archivePath = path.join("/foo/bar", "cache.tgz");
 
-    expect(createTarMock).toHaveBeenCalledTimes(1);
+    const IS_WINDOWS = process.platform === "win32";
-    expect(createTarMock).toHaveBeenCalledWith(archivePath, cachePath);
+    const args = IS_WINDOWS
+        ? [
+              "-cz",
+              "--force-local",
+              "-f",
+              archivePath.replace(/\\/g, "/"),
+              "-C",
+              cachePath.replace(/\\/g, "/"),
+              "."
+          ]
+        : ["-cz", "-f", archivePath, "-C", cachePath, "."];
+
+    expect(execMock).toHaveBeenCalledTimes(1);
+    expect(execMock).toHaveBeenCalledWith(`"tar"`, args);
 
     expect(saveCacheMock).toHaveBeenCalledTimes(1);
     expect(saveCacheMock).toHaveBeenCalledWith(primaryKey, archivePath);
@@ -289,15 +321,29 @@ test("save with valid inputs uploads a cache", async () => {
     const cachePath = path.resolve(inputPath);
     testUtils.setInput(Inputs.Path, inputPath);
 
-    const createTarMock = jest.spyOn(tar, "createTar");
+    const execMock = jest.spyOn(exec, "exec");
+
     const saveCacheMock = jest.spyOn(cacheHttpClient, "saveCache");
 
     await run();
 
     const archivePath = path.join("/foo/bar", "cache.tgz");
 
-    expect(createTarMock).toHaveBeenCalledTimes(1);
+    const IS_WINDOWS = process.platform === "win32";
-    expect(createTarMock).toHaveBeenCalledWith(archivePath, cachePath);
+    const args = IS_WINDOWS
+        ? [
+              "-cz",
+              "--force-local",
+              "-f",
+              archivePath.replace(/\\/g, "/"),
+              "-C",
+              cachePath.replace(/\\/g, "/"),
+              "."
+          ]
+        : ["-cz", "-f", archivePath, "-C", cachePath, "."];
+
+    expect(execMock).toHaveBeenCalledTimes(1);
+    expect(execMock).toHaveBeenCalledWith(`"tar"`, args);
 
     expect(saveCacheMock).toHaveBeenCalledTimes(1);
     expect(saveCacheMock).toHaveBeenCalledWith(primaryKey, archivePath);

__tests__/tar.test.ts

@@ -1,60 +0,0 @@
-import * as exec from "@actions/exec";
-import * as io from "@actions/io";
-import * as tar from "../src/tar";
-
-jest.mock("@actions/exec");
-jest.mock("@actions/io");
-
-beforeAll(() => {
-    process.env["windir"] = "C:";
-
-    jest.spyOn(io, "which").mockImplementation(tool => {
-        return Promise.resolve(tool);
-    });
-});
-
-afterAll(() => {
-    delete process.env["windir"];
-});
-
-test("extract tar", async () => {
-    const mkdirMock = jest.spyOn(io, "mkdirP");
-    const execMock = jest.spyOn(exec, "exec");
-
-    const archivePath = "cache.tar";
-    const targetDirectory = "~/.npm/cache";
-    await tar.extractTar(archivePath, targetDirectory);
-
-    expect(mkdirMock).toHaveBeenCalledWith(targetDirectory);
-
-    const IS_WINDOWS = process.platform === "win32";
-    const tarPath = IS_WINDOWS ? "C:\\System32\\tar.exe" : "tar";
-    expect(execMock).toHaveBeenCalledTimes(1);
-    expect(execMock).toHaveBeenCalledWith(`"${tarPath}"`, [
-        "-xz",
-        "-f",
-        archivePath,
-        "-C",
-        targetDirectory
-    ]);
-});
-
-test("create tar", async () => {
-    const execMock = jest.spyOn(exec, "exec");
-
-    const archivePath = "cache.tar";
-    const sourceDirectory = "~/.npm/cache";
-    await tar.createTar(archivePath, sourceDirectory);
-
-    const IS_WINDOWS = process.platform === "win32";
-    const tarPath = IS_WINDOWS ? "C:\\System32\\tar.exe" : "tar";
-    expect(execMock).toHaveBeenCalledTimes(1);
-    expect(execMock).toHaveBeenCalledWith(`"${tarPath}"`, [
-        "-cz",
-        "-f",
-        archivePath,
-        "-C",
-        sourceDirectory,
-        "."
-    ]);
-});

dist/restore/index.js

@@ -1496,47 +1496,56 @@ const fs = __importStar(__webpack_require__(747));
 const Handlers_1 = __webpack_require__(941);
 const HttpClient_1 = __webpack_require__(874);
 const RestClient_1 = __webpack_require__(105);
-function getCacheUrl() {
+const utils = __importStar(__webpack_require__(443));
+const MAX_CHUNK_SIZE = 4000000; // 4 MB Chunks
+function isSuccessStatusCode(statusCode) {
+    return statusCode >= 200 && statusCode < 300;
+}
+function getCacheApiUrl() {
     // Ideally we just use ACTIONS_CACHE_URL
-    const cacheUrl = (process.env["ACTIONS_CACHE_URL"] ||
+    const baseUrl = (process.env["ACTIONS_CACHE_URL"] ||
         process.env["ACTIONS_RUNTIME_URL"] ||
         "").replace("pipelines", "artifactcache");
-    if (!cacheUrl) {
+    if (!baseUrl) {
         throw new Error("Cache Service Url not found, unable to restore cache.");
     }
-    core.debug(`Cache Url: ${cacheUrl}`);
+    core.debug(`Cache Url: ${baseUrl}`);
-    return cacheUrl;
+    return `${baseUrl}_apis/artifactcache/`;
 }
 function createAcceptHeader(type, apiVersion) {
     return `${type};api-version=${apiVersion}`;
 }
 function getRequestOptions() {
     const requestOptions = {
-        acceptHeader: createAcceptHeader("application/json", "5.2-preview.1")
+        acceptHeader: createAcceptHeader("application/json", "6.0-preview.1")
     };
     return requestOptions;
 }
+function createRestClient() {
+    const token = process.env["ACTIONS_RUNTIME_TOKEN"] || "";
+    const bearerCredentialHandler = new Handlers_1.BearerCredentialHandler(token);
+    return new RestClient_1.RestClient("actions/cache", getCacheApiUrl(), [
+        bearerCredentialHandler
+    ]);
+}
 function getCacheEntry(keys) {
+    var _a;
     return __awaiter(this, void 0, void 0, function* () {
-        const cacheUrl = getCacheUrl();
+        const restClient = createRestClient();
-        const token = process.env["ACTIONS_RUNTIME_TOKEN"] || "";
+        const resource = `cache?keys=${encodeURIComponent(keys.join(","))}`;
-        const bearerCredentialHandler = new Handlers_1.BearerCredentialHandler(token);
-        const resource = `_apis/artifactcache/cache?keys=${encodeURIComponent(keys.join(","))}`;
-        const restClient = new RestClient_1.RestClient("actions/cache", cacheUrl, [
-            bearerCredentialHandler
-        ]);
         const response = yield restClient.get(resource, getRequestOptions());
         if (response.statusCode === 204) {
             return null;
         }
-        if (response.statusCode !== 200) {
+        if (!isSuccessStatusCode(response.statusCode)) {
             throw new Error(`Cache service responded with ${response.statusCode}`);
         }
         const cacheResult = response.result;
-        if (!cacheResult || !cacheResult.archiveLocation) {
+        const cacheDownloadUrl = (_a = cacheResult) === null || _a === void 0 ? void 0 : _a.archiveLocation;
+        if (!cacheDownloadUrl) {
             throw new Error("Cache not found.");
         }
-        core.setSecret(cacheResult.archiveLocation);
+        core.setSecret(cacheDownloadUrl);
         core.debug(`Cache Result:`);
         core.debug(JSON.stringify(cacheResult));
         return cacheResult;
@@ -1552,34 +1561,90 @@ function pipeResponseToStream(response, stream) {
         });
     });
 }
-function downloadCache(cacheEntry, archivePath) {
+function downloadCache(archiveLocation, archivePath) {
     return __awaiter(this, void 0, void 0, function* () {
         const stream = fs.createWriteStream(archivePath);
         const httpClient = new HttpClient_1.HttpClient("actions/cache");
-        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+        const downloadResponse = yield httpClient.get(archiveLocation);
-        const downloadResponse = yield httpClient.get(cacheEntry.archiveLocation);
         yield pipeResponseToStream(downloadResponse, stream);
     });
 }
 exports.downloadCache = downloadCache;
-function saveCache(key, archivePath) {
+// Reserve Cache
+function reserveCache(key) {
+    var _a, _b, _c;
     return __awaiter(this, void 0, void 0, function* () {
-        const stream = fs.createReadStream(archivePath);
+        const restClient = createRestClient();
-        const cacheUrl = getCacheUrl();
+        const reserveCacheRequest = {
-        const token = process.env["ACTIONS_RUNTIME_TOKEN"] || "";
+            key
-        const bearerCredentialHandler = new Handlers_1.BearerCredentialHandler(token);
+        };
-        const resource = `_apis/artifactcache/cache/${encodeURIComponent(key)}`;
+        const response = yield restClient.create("caches", reserveCacheRequest, getRequestOptions());
-        const postUrl = cacheUrl + resource;
+        return _c = (_b = (_a = response) === null || _a === void 0 ? void 0 : _a.result) === null || _b === void 0 ? void 0 : _b.cacheId, (_c !== null && _c !== void 0 ? _c : -1);
-        const restClient = new RestClient_1.RestClient("actions/cache", undefined, [
+    });
-            bearerCredentialHandler
+}
-        ]);
+exports.reserveCache = reserveCache;
+function getContentRange(start, end) {
+    // Format: `bytes start-end/filesize
+    // start and end are inclusive
+    // filesize can be *
+    // For a 200 byte chunk starting at byte 0:
+    // Content-Range: bytes 0-199/*
+    return `bytes ${start}-${end}/*`;
+}
+// function bufferToStream(buffer: Buffer): NodeJS.ReadableStream {
+//     const stream = new Duplex();
+//     stream.push(buffer);
+//     stream.push(null);
+//     return stream;
+// }
+function uploadChunk(restClient, resourceUrl, data, start, end) {
+    return __awaiter(this, void 0, void 0, function* () {
+        core.debug(`Uploading chunk of size ${end - start + 1} bytes at offset ${start} with content range: ${getContentRange(start, end)}`);
         const requestOptions = getRequestOptions();
         requestOptions.additionalHeaders = {
-            "Content-Type": "application/octet-stream"
+            "Content-Type": "application/octet-stream",
+            "Content-Range": getContentRange(start, end)
         };
-        const response = yield restClient.uploadStream("POST", postUrl, stream, requestOptions);
+        return yield restClient.uploadStream("PATCH", resourceUrl, data, requestOptions);
-        if (response.statusCode !== 200) {
+    });
-            throw new Error(`Cache service responded with ${response.statusCode}`);
+}
+function commitCache(restClient, cacheId, filesize) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const requestOptions = getRequestOptions();
+        const commitCacheRequest = { size: filesize };
+        return yield restClient.create(`caches/${cacheId.toString()}`, commitCacheRequest, requestOptions);
+    });
+}
+function saveCache(cacheId, archivePath) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const restClient = createRestClient();
+        core.debug("Uploading chunks");
+        // Upload Chunks
+        const fileSize = fs.statSync(archivePath).size;
+        const resourceUrl = getCacheApiUrl() + "caches/" + cacheId.toString();
+        const uploads = [];
+        const fd = fs.openSync(archivePath, "r"); // Use the same fd for serial reads? Will this work for parallel too?
+        let offset = 0;
+        while (offset < fileSize) {
+            const chunkSize = offset + MAX_CHUNK_SIZE > fileSize ? fileSize - offset : MAX_CHUNK_SIZE;
+            const end = offset + chunkSize - 1;
+            const chunk = fs.createReadStream(archivePath, { fd, start: offset, end, autoClose: false });
+            uploads.push(yield uploadChunk(restClient, resourceUrl, chunk, offset, end)); // Making this serial
+            offset += MAX_CHUNK_SIZE;
+        }
+        fs.closeSync(fd);
+        core.debug("Awaiting all uploads");
+        //const responses = await Promise.all(uploads);
+        const failedResponse = uploads.find(x => !isSuccessStatusCode(x.statusCode));
+        if (failedResponse) {
+            throw new Error(`Cache service responded with ${failedResponse.statusCode} during chunk upload.`);
+        }
+        core.debug("Commiting cache");
+        // Commit Cache
+        const cacheSize = utils.getArchiveFileSize(archivePath);
+        const commitCacheResponse = yield commitCache(restClient, cacheId, cacheSize);
+        if (!isSuccessStatusCode(commitCacheResponse.statusCode)) {
+            throw new Error(`Cache service responded with ${commitCacheResponse.statusCode} during commit cache.`);
         }
         core.info("Cache saved successfully");
     });
@@ -2991,12 +3056,14 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const core = __importStar(__webpack_require__(470));
+const exec_1 = __webpack_require__(986);
+const io = __importStar(__webpack_require__(1));
 const path = __importStar(__webpack_require__(622));
 const cacheHttpClient = __importStar(__webpack_require__(154));
 const constants_1 = __webpack_require__(694);
-const tar_1 = __webpack_require__(943);
 const utils = __importStar(__webpack_require__(443));
 function run() {
+    var _a, _b;
     return __awaiter(this, void 0, void 0, function* () {
         try {
             // Validate inputs, this can cause task failure
@@ -3034,7 +3101,7 @@ function run() {
             }
             try {
                 const cacheEntry = yield cacheHttpClient.getCacheEntry(keys);
-                if (!cacheEntry) {
+                if (!cacheEntry || !((_a = cacheEntry) === null || _a === void 0 ? void 0 : _a.archiveLocation)) {
                     core.info(`Cache not found for input keys: ${keys.join(", ")}.`);
                     return;
                 }
@@ -3043,10 +3110,28 @@ function run() {
                 // Store the cache result
                 utils.setCacheState(cacheEntry);
                 // Download the cache from the cache entry
-                yield cacheHttpClient.downloadCache(cacheEntry, archivePath);
+                yield cacheHttpClient.downloadCache((_b = cacheEntry) === null || _b === void 0 ? void 0 : _b.archiveLocation, archivePath);
+                yield exec_1.exec(`md5sum`, [archivePath]);
                 const archiveFileSize = utils.getArchiveFileSize(archivePath);
                 core.info(`Cache Size: ~${Math.round(archiveFileSize / (1024 * 1024))} MB (${archiveFileSize} B)`);
-                yield tar_1.extractTar(archivePath, cachePath);
+                // Create directory to extract tar into
+                yield io.mkdirP(cachePath);
+                // http://man7.org/linux/man-pages/man1/tar.1.html
+                // tar [-options] <name of the tar archive> [files or directories which to add into archive]
+                const IS_WINDOWS = process.platform === "win32";
+                const args = IS_WINDOWS
+                    ? [
+                        "-xz",
+                        "--force-local",
+                        "-f",
+                        archivePath.replace(/\\/g, "/"),
+                        "-C",
+                        cachePath.replace(/\\/g, "/")
+                    ]
+                    : ["-xz", "-f", archivePath, "-C", cachePath];
+                const tarPath = yield io.which("tar", true);
+                core.debug(`Tar Path: ${tarPath}`);
+                yield exec_1.exec(`"${tarPath}"`, args);
                 const isExactKeyMatch = utils.isExactKeyMatch(primaryKey, cacheEntry);
                 utils.setCacheHitOutput(isExactKeyMatch);
                 core.info(`Cache restored from key: ${cacheEntry && cacheEntry.cacheKey}`);
@@ -5142,63 +5227,6 @@ var personalaccesstoken_1 = __webpack_require__(327);
 exports.PersonalAccessTokenCredentialHandler = personalaccesstoken_1.PersonalAccessTokenCredentialHandler;
 
 
-/***/ }),
-
-/***/ 943:
-/***/ (function(__unusedmodule, exports, __webpack_require__) {
-
-"use strict";
-
-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) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (Object.hasOwnProperty.call(mod, k)) result[k] = mod[k];
-    result["default"] = mod;
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const exec_1 = __webpack_require__(986);
-const io = __importStar(__webpack_require__(1));
-function extractTar(archivePath, targetDirectory) {
-    return __awaiter(this, void 0, void 0, function* () {
-        // Create directory to extract tar into
-        yield io.mkdirP(targetDirectory);
-        // http://man7.org/linux/man-pages/man1/tar.1.html
-        // tar [-options] <name of the tar archive> [files or directories which to add into archive]
-        const args = ["-xz", "-f", archivePath, "-C", targetDirectory];
-        yield exec_1.exec(`"${yield getTarPath()}"`, args);
-    });
-}
-exports.extractTar = extractTar;
-function createTar(archivePath, sourceDirectory) {
-    return __awaiter(this, void 0, void 0, function* () {
-        // http://man7.org/linux/man-pages/man1/tar.1.html
-        // tar [-options] <name of the tar archive> [files or directories which to add into archive]
-        const args = ["-cz", "-f", archivePath, "-C", sourceDirectory, "."];
-        yield exec_1.exec(`"${yield getTarPath()}"`, args);
-    });
-}
-exports.createTar = createTar;
-function getTarPath() {
-    return __awaiter(this, void 0, void 0, function* () {
-        // Explicitly use BSD Tar on Windows
-        const IS_WINDOWS = process.platform === "win32";
-        return IS_WINDOWS
-            ? `${process.env["windir"]}\\System32\\tar.exe`
-            : yield io.which("tar", true);
-    });
-}
-
-
 /***/ }),
 
 /***/ 986:

dist/save/index.js

@@ -1496,47 +1496,56 @@ const fs = __importStar(__webpack_require__(747));
 const Handlers_1 = __webpack_require__(941);
 const HttpClient_1 = __webpack_require__(874);
 const RestClient_1 = __webpack_require__(105);
-function getCacheUrl() {
+const utils = __importStar(__webpack_require__(443));
+const MAX_CHUNK_SIZE = 4000000; // 4 MB Chunks
+function isSuccessStatusCode(statusCode) {
+    return statusCode >= 200 && statusCode < 300;
+}
+function getCacheApiUrl() {
     // Ideally we just use ACTIONS_CACHE_URL
-    const cacheUrl = (process.env["ACTIONS_CACHE_URL"] ||
+    const baseUrl = (process.env["ACTIONS_CACHE_URL"] ||
         process.env["ACTIONS_RUNTIME_URL"] ||
         "").replace("pipelines", "artifactcache");
-    if (!cacheUrl) {
+    if (!baseUrl) {
         throw new Error("Cache Service Url not found, unable to restore cache.");
     }
-    core.debug(`Cache Url: ${cacheUrl}`);
+    core.debug(`Cache Url: ${baseUrl}`);
-    return cacheUrl;
+    return `${baseUrl}_apis/artifactcache/`;
 }
 function createAcceptHeader(type, apiVersion) {
     return `${type};api-version=${apiVersion}`;
 }
 function getRequestOptions() {
     const requestOptions = {
-        acceptHeader: createAcceptHeader("application/json", "5.2-preview.1")
+        acceptHeader: createAcceptHeader("application/json", "6.0-preview.1")
     };
     return requestOptions;
 }
+function createRestClient() {
+    const token = process.env["ACTIONS_RUNTIME_TOKEN"] || "";
+    const bearerCredentialHandler = new Handlers_1.BearerCredentialHandler(token);
+    return new RestClient_1.RestClient("actions/cache", getCacheApiUrl(), [
+        bearerCredentialHandler
+    ]);
+}
 function getCacheEntry(keys) {
+    var _a;
     return __awaiter(this, void 0, void 0, function* () {
-        const cacheUrl = getCacheUrl();
+        const restClient = createRestClient();
-        const token = process.env["ACTIONS_RUNTIME_TOKEN"] || "";
+        const resource = `cache?keys=${encodeURIComponent(keys.join(","))}`;
-        const bearerCredentialHandler = new Handlers_1.BearerCredentialHandler(token);
-        const resource = `_apis/artifactcache/cache?keys=${encodeURIComponent(keys.join(","))}`;
-        const restClient = new RestClient_1.RestClient("actions/cache", cacheUrl, [
-            bearerCredentialHandler
-        ]);
         const response = yield restClient.get(resource, getRequestOptions());
         if (response.statusCode === 204) {
             return null;
         }
-        if (response.statusCode !== 200) {
+        if (!isSuccessStatusCode(response.statusCode)) {
             throw new Error(`Cache service responded with ${response.statusCode}`);
         }
         const cacheResult = response.result;
-        if (!cacheResult || !cacheResult.archiveLocation) {
+        const cacheDownloadUrl = (_a = cacheResult) === null || _a === void 0 ? void 0 : _a.archiveLocation;
+        if (!cacheDownloadUrl) {
             throw new Error("Cache not found.");
         }
-        core.setSecret(cacheResult.archiveLocation);
+        core.setSecret(cacheDownloadUrl);
         core.debug(`Cache Result:`);
         core.debug(JSON.stringify(cacheResult));
         return cacheResult;
@@ -1552,34 +1561,90 @@ function pipeResponseToStream(response, stream) {
         });
     });
 }
-function downloadCache(cacheEntry, archivePath) {
+function downloadCache(archiveLocation, archivePath) {
     return __awaiter(this, void 0, void 0, function* () {
         const stream = fs.createWriteStream(archivePath);
         const httpClient = new HttpClient_1.HttpClient("actions/cache");
-        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+        const downloadResponse = yield httpClient.get(archiveLocation);
-        const downloadResponse = yield httpClient.get(cacheEntry.archiveLocation);
         yield pipeResponseToStream(downloadResponse, stream);
     });
 }
 exports.downloadCache = downloadCache;
-function saveCache(key, archivePath) {
+// Reserve Cache
+function reserveCache(key) {
+    var _a, _b, _c;
     return __awaiter(this, void 0, void 0, function* () {
-        const stream = fs.createReadStream(archivePath);
+        const restClient = createRestClient();
-        const cacheUrl = getCacheUrl();
+        const reserveCacheRequest = {
-        const token = process.env["ACTIONS_RUNTIME_TOKEN"] || "";
+            key
-        const bearerCredentialHandler = new Handlers_1.BearerCredentialHandler(token);
+        };
-        const resource = `_apis/artifactcache/cache/${encodeURIComponent(key)}`;
+        const response = yield restClient.create("caches", reserveCacheRequest, getRequestOptions());
-        const postUrl = cacheUrl + resource;
+        return _c = (_b = (_a = response) === null || _a === void 0 ? void 0 : _a.result) === null || _b === void 0 ? void 0 : _b.cacheId, (_c !== null && _c !== void 0 ? _c : -1);
-        const restClient = new RestClient_1.RestClient("actions/cache", undefined, [
+    });
-            bearerCredentialHandler
+}
-        ]);
+exports.reserveCache = reserveCache;
+function getContentRange(start, end) {
+    // Format: `bytes start-end/filesize
+    // start and end are inclusive
+    // filesize can be *
+    // For a 200 byte chunk starting at byte 0:
+    // Content-Range: bytes 0-199/*
+    return `bytes ${start}-${end}/*`;
+}
+// function bufferToStream(buffer: Buffer): NodeJS.ReadableStream {
+//     const stream = new Duplex();
+//     stream.push(buffer);
+//     stream.push(null);
+//     return stream;
+// }
+function uploadChunk(restClient, resourceUrl, data, start, end) {
+    return __awaiter(this, void 0, void 0, function* () {
+        core.debug(`Uploading chunk of size ${end - start + 1} bytes at offset ${start} with content range: ${getContentRange(start, end)}`);
         const requestOptions = getRequestOptions();
         requestOptions.additionalHeaders = {
-            "Content-Type": "application/octet-stream"
+            "Content-Type": "application/octet-stream",
+            "Content-Range": getContentRange(start, end)
         };
-        const response = yield restClient.uploadStream("POST", postUrl, stream, requestOptions);
+        return yield restClient.uploadStream("PATCH", resourceUrl, data, requestOptions);
-        if (response.statusCode !== 200) {
+    });
-            throw new Error(`Cache service responded with ${response.statusCode}`);
+}
+function commitCache(restClient, cacheId, filesize) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const requestOptions = getRequestOptions();
+        const commitCacheRequest = { size: filesize };
+        return yield restClient.create(`caches/${cacheId.toString()}`, commitCacheRequest, requestOptions);
+    });
+}
+function saveCache(cacheId, archivePath) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const restClient = createRestClient();
+        core.debug("Uploading chunks");
+        // Upload Chunks
+        const fileSize = fs.statSync(archivePath).size;
+        const resourceUrl = getCacheApiUrl() + "caches/" + cacheId.toString();
+        const uploads = [];
+        const fd = fs.openSync(archivePath, "r"); // Use the same fd for serial reads? Will this work for parallel too?
+        let offset = 0;
+        while (offset < fileSize) {
+            const chunkSize = offset + MAX_CHUNK_SIZE > fileSize ? fileSize - offset : MAX_CHUNK_SIZE;
+            const end = offset + chunkSize - 1;
+            const chunk = fs.createReadStream(archivePath, { fd, start: offset, end, autoClose: false });
+            uploads.push(yield uploadChunk(restClient, resourceUrl, chunk, offset, end)); // Making this serial
+            offset += MAX_CHUNK_SIZE;
+        }
+        fs.closeSync(fd);
+        core.debug("Awaiting all uploads");
+        //const responses = await Promise.all(uploads);
+        const failedResponse = uploads.find(x => !isSuccessStatusCode(x.statusCode));
+        if (failedResponse) {
+            throw new Error(`Cache service responded with ${failedResponse.statusCode} during chunk upload.`);
+        }
+        core.debug("Commiting cache");
+        // Commit Cache
+        const cacheSize = utils.getArchiveFileSize(archivePath);
+        const commitCacheResponse = yield commitCache(restClient, cacheId, cacheSize);
+        if (!isSuccessStatusCode(commitCacheResponse.statusCode)) {
+            throw new Error(`Cache service responded with ${commitCacheResponse.statusCode} during commit cache.`);
         }
         core.info("Cache saved successfully");
     });
@@ -2879,10 +2944,11 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const core = __importStar(__webpack_require__(470));
+const exec_1 = __webpack_require__(986);
+const io = __importStar(__webpack_require__(1));
 const path = __importStar(__webpack_require__(622));
 const cacheHttpClient = __importStar(__webpack_require__(154));
 const constants_1 = __webpack_require__(694);
-const tar_1 = __webpack_require__(943);
 const utils = __importStar(__webpack_require__(443));
 function run() {
     return __awaiter(this, void 0, void 0, function* () {
@@ -2904,19 +2970,44 @@ function run() {
                 core.info(`Cache hit occurred on the primary key ${primaryKey}, not saving cache.`);
                 return;
             }
+            core.debug("Reserving Cache");
+            const cacheId = yield cacheHttpClient.reserveCache(primaryKey);
+            if (cacheId < 0) {
+                core.info(`Unable to reserve cache with key ${primaryKey}, another job may be creating this cache.`);
+                return;
+            }
+            core.debug(`Cache ID: ${cacheId}`);
             const cachePath = utils.resolvePath(core.getInput(constants_1.Inputs.Path, { required: true }));
             core.debug(`Cache Path: ${cachePath}`);
             const archivePath = path.join(yield utils.createTempDirectory(), "cache.tgz");
             core.debug(`Archive Path: ${archivePath}`);
-            yield tar_1.createTar(archivePath, cachePath);
+            // http://man7.org/linux/man-pages/man1/tar.1.html
-            const fileSizeLimit = 400 * 1024 * 1024; // 400MB
+            // tar [-options] <name of the tar archive> [files or directories which to add into archive]
+            const IS_WINDOWS = process.platform === "win32";
+            const args = IS_WINDOWS
+                ? [
+                    "-cz",
+                    "--force-local",
+                    "-f",
+                    archivePath.replace(/\\/g, "/"),
+                    "-C",
+                    cachePath.replace(/\\/g, "/"),
+                    "."
+                ]
+                : ["-cz", "-f", archivePath, "-C", cachePath, "."];
+            const tarPath = yield io.which("tar", true);
+            core.debug(`Tar Path: ${tarPath}`);
+            yield exec_1.exec(`"${tarPath}"`, args);
+            const fileSizeLimit = 2 * 1024 * 1024 * 1024; // 2GB per repo limit
             const archiveFileSize = utils.getArchiveFileSize(archivePath);
             core.debug(`File Size: ${archiveFileSize}`);
             if (archiveFileSize > fileSizeLimit) {
-                utils.logWarning(`Cache size of ~${Math.round(archiveFileSize / (1024 * 1024))} MB (${archiveFileSize} B) is over the 400MB limit, not saving cache.`);
+                utils.logWarning(`Cache size of ~${Math.round(archiveFileSize / (1024 * 1024 * 1024))} GB (${archiveFileSize} B) is over the 2GB limit, not saving cache.`);
                 return;
             }
-            yield cacheHttpClient.saveCache(primaryKey, archivePath);
+            yield exec_1.exec(`md5sum`, [archivePath]);
+            core.debug("Saving Cache");
+            yield cacheHttpClient.saveCache(cacheId, archivePath);
         }
         catch (error) {
             utils.logWarning(error.message);
@@ -5116,63 +5207,6 @@ var personalaccesstoken_1 = __webpack_require__(327);
 exports.PersonalAccessTokenCredentialHandler = personalaccesstoken_1.PersonalAccessTokenCredentialHandler;
 
 
-/***/ }),
-
-/***/ 943:
-/***/ (function(__unusedmodule, exports, __webpack_require__) {
-
-"use strict";
-
-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) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (Object.hasOwnProperty.call(mod, k)) result[k] = mod[k];
-    result["default"] = mod;
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const exec_1 = __webpack_require__(986);
-const io = __importStar(__webpack_require__(1));
-function extractTar(archivePath, targetDirectory) {
-    return __awaiter(this, void 0, void 0, function* () {
-        // Create directory to extract tar into
-        yield io.mkdirP(targetDirectory);
-        // http://man7.org/linux/man-pages/man1/tar.1.html
-        // tar [-options] <name of the tar archive> [files or directories which to add into archive]
-        const args = ["-xz", "-f", archivePath, "-C", targetDirectory];
-        yield exec_1.exec(`"${yield getTarPath()}"`, args);
-    });
-}
-exports.extractTar = extractTar;
-function createTar(archivePath, sourceDirectory) {
-    return __awaiter(this, void 0, void 0, function* () {
-        // http://man7.org/linux/man-pages/man1/tar.1.html
-        // tar [-options] <name of the tar archive> [files or directories which to add into archive]
-        const args = ["-cz", "-f", archivePath, "-C", sourceDirectory, "."];
-        yield exec_1.exec(`"${yield getTarPath()}"`, args);
-    });
-}
-exports.createTar = createTar;
-function getTarPath() {
-    return __awaiter(this, void 0, void 0, function* () {
-        // Explicitly use BSD Tar on Windows
-        const IS_WINDOWS = process.platform === "win32";
-        return IS_WINDOWS
-            ? `${process.env["windir"]}\\System32\\tar.exe`
-            : yield io.which("tar", true);
-    });
-}
-
-
 /***/ }),
 
 /***/ 986:

package-lock.json

@@ -4859,9 +4859,9 @@
       "dev": true
     },
     "prettier": {
-      "version": "1.18.2",
+      "version": "1.19.1",
-      "resolved": "https://registry.npmjs.org/prettier/-/prettier-1.18.2.tgz",
+      "resolved": "https://registry.npmjs.org/prettier/-/prettier-1.19.1.tgz",
-      "integrity": "sha512-OeHeMc0JhFE9idD4ZdtNibzY0+TPHSpSSb9h8FqtP+YnoZZ1sl8Vc9b1sasjfymH3SonAF4QcA2+mzHPhMvIiw==",
+      "integrity": "sha512-s7PoyDv/II1ObgQunCbB9PdLmUcBZcnWOcxDh7O0N/UwDEsHyqkW+Qh28jW+mVuCdx7gLB0BotYI1Y6uI9iyew==",
       "dev": true
     },
     "prettier-linter-helpers": {
@@ -5983,9 +5983,9 @@
       }
     },
     "typescript": {
-      "version": "3.6.4",
+      "version": "3.7.3",
-      "resolved": "https://registry.npmjs.org/typescript/-/typescript-3.6.4.tgz",
+      "resolved": "https://registry.npmjs.org/typescript/-/typescript-3.7.3.tgz",
-      "integrity": "sha512-unoCll1+l+YK4i4F8f22TaNVPRHcD9PA3yCuZ8g5e0qGqlVlJ/8FSateOLLSagn+Yg5+ZwuPkL8LFUc0Jcvksg==",
+      "integrity": "sha512-Mcr/Qk7hXqFBXMN7p7Lusj1ktCBydylfQM/FZCk5glCNQJrCUKPkMHdo9R0MTFWsC/4kPFvDS0fDPvukfCkFsw==",
       "dev": true
     },
     "uglify-js": {

package.json

@@ -1,6 +1,6 @@
 {
   "name": "cache",
-  "version": "1.0.3",
+  "version": "1.1.0",
   "private": true,
   "description": "Cache dependencies and build outputs",
   "main": "dist/restore/index.js",
@@ -46,8 +46,8 @@
     "jest": "^24.8.0",
     "jest-circus": "^24.7.1",
     "nock": "^11.7.0",
-    "prettier": "1.18.2",
+    "prettier": "^1.19.1",
     "ts-jest": "^24.0.2",
-    "typescript": "^3.6.4"
+    "typescript": "^3.7.3"
   }
 }

src/cacheHttpClient.ts

@@ -3,24 +3,39 @@ import * as fs from "fs";
 import { BearerCredentialHandler } from "typed-rest-client/Handlers";
 import { HttpClient } from "typed-rest-client/HttpClient";
 import { IHttpClientResponse } from "typed-rest-client/Interfaces";
-import { IRequestOptions, RestClient } from "typed-rest-client/RestClient";
+import {
-import { ArtifactCacheEntry } from "./contracts";
+    IRequestOptions,
+    RestClient,
+    IRestResponse
+} from "typed-rest-client/RestClient";
+import {
+    ArtifactCacheEntry,
+    CommitCacheRequest,
+    ReserveCacheRequest,
+    ReserverCacheResponse
+} from "./contracts";
+import * as utils from "./utils/actionUtils";
 
-function getCacheUrl(): string {
+const MAX_CHUNK_SIZE = 4000000; // 4 MB Chunks
+
+function isSuccessStatusCode(statusCode: number): boolean {
+    return statusCode >= 200 && statusCode < 300;
+}
+function getCacheApiUrl(): string {
     // Ideally we just use ACTIONS_CACHE_URL
-    const cacheUrl: string = (
+    const baseUrl: string = (
         process.env["ACTIONS_CACHE_URL"] ||
         process.env["ACTIONS_RUNTIME_URL"] ||
         ""
     ).replace("pipelines", "artifactcache");
-    if (!cacheUrl) {
+    if (!baseUrl) {
         throw new Error(
             "Cache Service Url not found, unable to restore cache."
         );
     }
 
-    core.debug(`Cache Url: ${cacheUrl}`);
+    core.debug(`Cache Url: ${baseUrl}`);
-    return cacheUrl;
+    return `${baseUrl}_apis/artifactcache/`;
 }
 
 function createAcceptHeader(type: string, apiVersion: string): string {
@@ -29,26 +44,26 @@ function createAcceptHeader(type: string, apiVersion: string): string {
 
 function getRequestOptions(): IRequestOptions {
     const requestOptions: IRequestOptions = {
-        acceptHeader: createAcceptHeader("application/json", "5.2-preview.1")
+        acceptHeader: createAcceptHeader("application/json", "6.0-preview.1")
     };
 
     return requestOptions;
 }
 
-export async function getCacheEntry(
+function createRestClient(): RestClient {
-    keys: string[]
-): Promise<ArtifactCacheEntry | null> {
-    const cacheUrl = getCacheUrl();
     const token = process.env["ACTIONS_RUNTIME_TOKEN"] || "";
     const bearerCredentialHandler = new BearerCredentialHandler(token);
 
-    const resource = `_apis/artifactcache/cache?keys=${encodeURIComponent(
+    return new RestClient("actions/cache", getCacheApiUrl(), [
-        keys.join(",")
-    )}`;
-
-    const restClient = new RestClient("actions/cache", cacheUrl, [
         bearerCredentialHandler
     ]);
+}
+
+export async function getCacheEntry(
+    keys: string[]
+): Promise<ArtifactCacheEntry | null> {
+    const restClient = createRestClient();
+    const resource = `cache?keys=${encodeURIComponent(keys.join(","))}`;
 
     const response = await restClient.get<ArtifactCacheEntry>(
         resource,
@@ -57,14 +72,15 @@ export async function getCacheEntry(
     if (response.statusCode === 204) {
         return null;
     }
-    if (response.statusCode !== 200) {
+    if (!isSuccessStatusCode(response.statusCode)) {
         throw new Error(`Cache service responded with ${response.statusCode}`);
     }
     const cacheResult = response.result;
-    if (!cacheResult || !cacheResult.archiveLocation) {
+    const cacheDownloadUrl = cacheResult?.archiveLocation;
+    if (!cacheDownloadUrl) {
         throw new Error("Cache not found.");
     }
-    core.setSecret(cacheResult.archiveLocation);
+    core.setSecret(cacheDownloadUrl);
     core.debug(`Cache Result:`);
     core.debug(JSON.stringify(cacheResult));
 
@@ -83,46 +99,129 @@ async function pipeResponseToStream(
 }
 
 export async function downloadCache(
-    cacheEntry: ArtifactCacheEntry,
+    archiveLocation: string,
     archivePath: string
 ): Promise<void> {
     const stream = fs.createWriteStream(archivePath);
     const httpClient = new HttpClient("actions/cache");
-    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    const downloadResponse = await httpClient.get(archiveLocation);
-    const downloadResponse = await httpClient.get(cacheEntry.archiveLocation!);
     await pipeResponseToStream(downloadResponse, stream);
 }
 
-export async function saveCache(
+// Reserve Cache
-    key: string,
+export async function reserveCache(
-    archivePath: string
+    key: string
-): Promise<void> {
+): Promise<number> {
-    const stream = fs.createReadStream(archivePath);
+    const restClient = createRestClient();
 
-    const cacheUrl = getCacheUrl();
+    const reserveCacheRequest: ReserveCacheRequest = {
-    const token = process.env["ACTIONS_RUNTIME_TOKEN"] || "";
+        key
-    const bearerCredentialHandler = new BearerCredentialHandler(token);
+    };
+    const response = await restClient.create<ReserverCacheResponse>(
+        "caches",
+        reserveCacheRequest,
+        getRequestOptions()
+    );
 
-    const resource = `_apis/artifactcache/cache/${encodeURIComponent(key)}`;
+    return response?.result?.cacheId ?? -1;
-    const postUrl = cacheUrl + resource;
+}
 
-    const restClient = new RestClient("actions/cache", undefined, [
+function getContentRange(start: number, end: number): string {
-        bearerCredentialHandler
+    // Format: `bytes start-end/filesize
-    ]);
+    // start and end are inclusive
+    // filesize can be *
+    // For a 200 byte chunk starting at byte 0:
+    // Content-Range: bytes 0-199/*
+    return `bytes ${start}-${end}/*`;
+}
 
+// function bufferToStream(buffer: Buffer): NodeJS.ReadableStream {
+//     const stream = new Duplex();
+//     stream.push(buffer);
+//     stream.push(null);
+
+//     return stream;
+// }
+
+async function uploadChunk(
+    restClient: RestClient,
+    resourceUrl: string,
+    data: NodeJS.ReadableStream,
+    start: number,
+    end: number
+): Promise<IRestResponse<void>> {
+    core.debug(`Uploading chunk of size ${end - start + 1} bytes at offset ${start} with content range: ${getContentRange(start, end)}`);
     const requestOptions = getRequestOptions();
     requestOptions.additionalHeaders = {
-        "Content-Type": "application/octet-stream"
+        "Content-Type": "application/octet-stream",
+        "Content-Range": getContentRange(start, end)
     };
 
-    const response = await restClient.uploadStream<void>(
+    return await restClient.uploadStream<void>("PATCH", resourceUrl, data, requestOptions);
-        "POST",
+}
-        postUrl,
+
-        stream,
+async function commitCache(
+    restClient: RestClient,
+    cacheId: number,
+    filesize: number
+): Promise<IRestResponse<void>> {
+    const requestOptions = getRequestOptions();
+    const commitCacheRequest: CommitCacheRequest = { size: filesize };
+    return await restClient.create(
+        `caches/${cacheId.toString()}`,
+        commitCacheRequest,
         requestOptions
     );
-    if (response.statusCode !== 200) {
+}
-        throw new Error(`Cache service responded with ${response.statusCode}`);
+
+export async function saveCache(
+    cacheId: number,
+    archivePath: string
+): Promise<void> {
+    const restClient = createRestClient();
+
+    core.debug("Uploading chunks");
+    // Upload Chunks
+    const fileSize = fs.statSync(archivePath).size;
+    const resourceUrl = getCacheApiUrl() + "caches/" + cacheId.toString();
+    const uploads: IRestResponse<void>[] = [];
+
+    const fd = fs.openSync(archivePath, "r"); // Use the same fd for serial reads? Will this work for parallel too?
+    let offset = 0;
+    while (offset < fileSize) {
+        const chunkSize = offset + MAX_CHUNK_SIZE > fileSize ? fileSize - offset : MAX_CHUNK_SIZE;
+        const end = offset + chunkSize - 1;
+        const chunk = fs.createReadStream(archivePath, { fd, start: offset, end, autoClose: false });
+        uploads.push(await uploadChunk(restClient, resourceUrl, chunk, offset, end)); // Making this serial
+        offset += MAX_CHUNK_SIZE;
+    }
+
+    fs.closeSync(fd);
+
+    core.debug("Awaiting all uploads");
+    //const responses = await Promise.all(uploads);
+
+    const failedResponse = uploads.find(
+        x => !isSuccessStatusCode(x.statusCode)
+    );
+    if (failedResponse) {
+        throw new Error(
+            `Cache service responded with ${failedResponse.statusCode} during chunk upload.`
+        );
+    }
+
+    core.debug("Commiting cache");
+    // Commit Cache
+    const cacheSize = utils.getArchiveFileSize(archivePath);
+    const commitCacheResponse = await commitCache(
+        restClient,
+        cacheId,
+        cacheSize
+    );
+    if (!isSuccessStatusCode(commitCacheResponse.statusCode)) {
+        throw new Error(
+            `Cache service responded with ${commitCacheResponse.statusCode} during commit cache.`
+        );
     }
 
     core.info("Cache saved successfully");

src/contracts.d.ts

@@ -4,3 +4,16 @@ export interface ArtifactCacheEntry {
     creationTime?: string;
     archiveLocation?: string;
 }
+
+export interface CommitCacheRequest {
+    size: number;
+}
+
+export interface ReserveCacheRequest {
+    key: string;
+    version?: string;
+}
+
+export interface ReserverCacheResponse {
+    cacheId: number;
+}

src/restore.ts

@@ -1,8 +1,9 @@
 import * as core from "@actions/core";
+import { exec } from "@actions/exec";
+import * as io from "@actions/io";
 import * as path from "path";
 import * as cacheHttpClient from "./cacheHttpClient";
 import { Events, Inputs, State } from "./constants";
-import { extractTar } from "./tar";
 import * as utils from "./utils/actionUtils";
 
 async function run(): Promise<void> {
@@ -60,7 +61,7 @@ async function run(): Promise<void> {
 
         try {
             const cacheEntry = await cacheHttpClient.getCacheEntry(keys);
-            if (!cacheEntry) {
+            if (!cacheEntry || !cacheEntry?.archiveLocation) {
                 core.info(
                     `Cache not found for input keys: ${keys.join(", ")}.`
                 );
@@ -77,7 +78,11 @@ async function run(): Promise<void> {
             utils.setCacheState(cacheEntry);
 
             // Download the cache from the cache entry
-            await cacheHttpClient.downloadCache(cacheEntry, archivePath);
+            await cacheHttpClient.downloadCache(
+                cacheEntry?.archiveLocation,
+                archivePath
+            );
+            await exec(`md5sum`, [archivePath]);
 
             const archiveFileSize = utils.getArchiveFileSize(archivePath);
             core.info(
@@ -86,7 +91,27 @@ async function run(): Promise<void> {
                 )} MB (${archiveFileSize} B)`
             );
 
-            await extractTar(archivePath, cachePath);
+            // Create directory to extract tar into
+            await io.mkdirP(cachePath);
+
+            // http://man7.org/linux/man-pages/man1/tar.1.html
+            // tar [-options] <name of the tar archive> [files or directories which to add into archive]
+            const IS_WINDOWS = process.platform === "win32";
+            const args = IS_WINDOWS
+                ? [
+                      "-xz",
+                      "--force-local",
+                      "-f",
+                      archivePath.replace(/\\/g, "/"),
+                      "-C",
+                      cachePath.replace(/\\/g, "/")
+                  ]
+                : ["-xz", "-f", archivePath, "-C", cachePath];
+
+            const tarPath = await io.which("tar", true);
+            core.debug(`Tar Path: ${tarPath}`);
+
+            await exec(`"${tarPath}"`, args);
 
             const isExactKeyMatch = utils.isExactKeyMatch(
                 primaryKey,

src/save.ts

@@ -1,8 +1,9 @@
 import * as core from "@actions/core";
+import { exec } from "@actions/exec";
+import * as io from "@actions/io";
 import * as path from "path";
 import * as cacheHttpClient from "./cacheHttpClient";
 import { Events, Inputs, State } from "./constants";
-import { createTar } from "./tar";
 import * as utils from "./utils/actionUtils";
 
 async function run(): Promise<void> {
@@ -34,6 +35,13 @@ async function run(): Promise<void> {
             return;
         }
 
+        core.debug("Reserving Cache");
+        const cacheId = await cacheHttpClient.reserveCache(primaryKey);
+        if (cacheId < 0) {
+            core.info(`Unable to reserve cache with key ${primaryKey}, another job may be creating this cache.`);
+            return;
+        }
+        core.debug(`Cache ID: ${cacheId}`);
         const cachePath = utils.resolvePath(
             core.getInput(Inputs.Path, { required: true })
         );
@@ -45,21 +53,40 @@ async function run(): Promise<void> {
         );
         core.debug(`Archive Path: ${archivePath}`);
 
-        await createTar(archivePath, cachePath);
+        // http://man7.org/linux/man-pages/man1/tar.1.html
+        // tar [-options] <name of the tar archive> [files or directories which to add into archive]
+        const IS_WINDOWS = process.platform === "win32";
+        const args = IS_WINDOWS
+            ? [
+                  "-cz",
+                  "--force-local",
+                  "-f",
+                  archivePath.replace(/\\/g, "/"),
+                  "-C",
+                  cachePath.replace(/\\/g, "/"),
+                  "."
+              ]
+            : ["-cz", "-f", archivePath, "-C", cachePath, "."];
 
-        const fileSizeLimit = 400 * 1024 * 1024; // 400MB
+        const tarPath = await io.which("tar", true);
+        core.debug(`Tar Path: ${tarPath}`);
+        await exec(`"${tarPath}"`, args);
+
+        const fileSizeLimit = 2 * 1024 * 1024 * 1024; // 2GB per repo limit
         const archiveFileSize = utils.getArchiveFileSize(archivePath);
         core.debug(`File Size: ${archiveFileSize}`);
         if (archiveFileSize > fileSizeLimit) {
             utils.logWarning(
                 `Cache size of ~${Math.round(
-                    archiveFileSize / (1024 * 1024)
+                    archiveFileSize / (1024 * 1024 * 1024)
-                )} MB (${archiveFileSize} B) is over the 400MB limit, not saving cache.`
+                )} GB (${archiveFileSize} B) is over the 2GB limit, not saving cache.`
             );
             return;
         }
 
-        await cacheHttpClient.saveCache(primaryKey, archivePath);
+        await exec(`md5sum`, [archivePath]);
+        core.debug("Saving Cache");
+        await cacheHttpClient.saveCache(cacheId, archivePath);
     } catch (error) {
         utils.logWarning(error.message);
     }

src/tar.ts

@@ -1,33 +0,0 @@
-import { exec } from "@actions/exec";
-import * as io from "@actions/io";
-
-async function getTarPath(): Promise<string> {
-    // Explicitly use BSD Tar on Windows
-    const IS_WINDOWS = process.platform === "win32";
-    return IS_WINDOWS
-        ? `${process.env["windir"]}\\System32\\tar.exe`
-        : await io.which("tar", true);
-}
-
-export async function extractTar(
-    archivePath: string,
-    targetDirectory: string
-): Promise<void> {
-    // Create directory to extract tar into
-    await io.mkdirP(targetDirectory);
-
-    // http://man7.org/linux/man-pages/man1/tar.1.html
-    // tar [-options] <name of the tar archive> [files or directories which to add into archive]
-    const args = ["-xz", "-f", archivePath, "-C", targetDirectory];
-    await exec(`"${await getTarPath()}"`, args);
-}
-
-export async function createTar(
-    archivePath: string,
-    sourceDirectory: string
-): Promise<void> {
-    // http://man7.org/linux/man-pages/man1/tar.1.html
-    // tar [-options] <name of the tar archive> [files or directories which to add into archive]
-    const args = ["-cz", "-f", archivePath, "-C", sourceDirectory, "."];
-    await exec(`"${await getTarPath()}"`, args);
-}