Merge pull request #78 from nix-community/unit-suffixes

Support human-readable inputs for store size

Author: deemp

.github/workflows/ci.yaml

@@ -350,7 +350,7 @@ jobs:
           # except the version with the `primary-key`, if it exists
           purge-primary-key: never
           # and collect garbage in the Nix store until it reaches this size in bytes
-          gc-max-store-size: 0
+          gc-max-store-size: 0M
 
       # Uncomment to debug this job
       # - name: Setup tmate session

README.md

@@ -84,8 +84,8 @@ See [Caching Approaches](#caching-approaches).
     restore-prefixes-first-match: nix-${{ runner.os }}-
     # collect garbage until Nix store size (in bytes) is at most this number
     # before trying to save a new cache
-    # 1 GB = 1073741824 B
-    gc-max-store-size-linux: 1073741824
+    # 1G = 1073741824
+    gc-max-store-size-linux: 1G
     # do purge caches
     purge: true
     # purge all versions of the cache
@@ -134,7 +134,7 @@ See [action.yml](action.yml).
 | `paths-macos`                     | <ul> <li>Overrides <code>paths</code>.</li> <li>Can have an effect only when the action runs on a <code>macOS</code> runner.</li> </ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       | `false`  | `""`                  |
 | `paths-linux`                     | <ul> <li>Overrides <code>paths</code>.</li> <li>Can have an effect only when the action runs on a <code>Linux</code> runner.</li> </ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       | `false`  | `""`                  |
 | `backend`                         | <p>Choose an implementation of the <code>cache</code> package.</p> <ul> <li>When <code>actions</code>, use the <a href="https://github.com/actions/toolkit/tree/main/packages/cache">actions version</a> from <a href="https://github.com/nix-community/cache-nix-action/tree/actions-toolkit/packages/cache">here</a>.</li> <li>When <code>buildjet</code>, use the <a href="https://github.com/BuildJet/toolkit/tree/main/packages/cache-buildjet">BuildJet version</a> from <a href="https://github.com/nix-community/cache-nix-action/tree/buildjet-toolkit/packages/cache">here</a>.</li> </ul>                                                                                                                                                          | `false`  | `actions`             |
-| `gc-max-store-size`               | <ul> <li>Can have an effect only when <code>nix: true</code>, <code>save: true</code>.</li> <li>The input has no effect if "primary-key" hit occurs when starting to save the new cache.</li> <li>When a number, the action collects garbage (via <code>nix store gc --max ...</code>) until the Nix store size (in bytes) is at most this number just before the action tries to save a new cache.</li> <li>Otherwise, this input has no effect.</li> </ul>                                                                                                                                                                                                                                                                                                  | `false`  | `""`                  |
+| `gc-max-store-size`               | <ul> <li>Can have an effect only when <code>nix: true</code>, <code>save: true</code>.</li> <li>The input has no effect if "primary-key" hit occurs when starting to save the new cache.</li> <li>When a non-negative integer number (possibly with a suffix), the action collects garbage (via <code>nix store gc --max ...</code>) until the Nix store size (in bytes) is at most this number just before the action tries to save a new cache.</li> <li>If you specify a suffix, it must be <code>K</code> (kibibytes, 2 ^ 10 bytes), <code>M</code> (mebibytes, 2 ^ 20 bytes) or <code>G</code> (gibibytes, 2 ^ 30 bytes), where <code>2 ^ N</code> means <code>2 to the power N</code>.</li> <li>Otherwise, this input has no effect.</li> </ul>         | `false`  | `""`                  |
 | `gc-max-store-size-macos`         | <ul> <li>Overrides <code>gc-max-store-size</code>.</li> <li>Can have an effect only when the action runs on a <code>macOS</code> runner.</li> </ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           | `false`  | `""`                  |
 | `gc-max-store-size-linux`         | <ul> <li>Overrides <code>gc-max-store-size</code>.</li> <li>Can have an effect only when the action runs on a <code>Linux</code> runner.</li> </ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           | `false`  | `""`                  |
 | `purge`                           | <ul> <li>When <code>true</code>, the action purges (possibly zero) caches.</li> <li>The action purges only caches scoped to the current <a href="https://docs.github.com/en/actions/learn-github-actions/variables#default-environment-variables">GITHUB_REF</a>.</li> <li>Otherwise, this input has no effect.</li> </ul>                                                                                                                                                                                                                                                                                                                                                                                                                                    | `false`  | `false`               |

action.nix

@@ -163,7 +163,8 @@ in
                   ]
                 }
                 - The input has no effect if "${primary-key}" hit occurs when starting to save the new cache.
-                - When a non-negative number, the action collects garbage (via `nix store gc --max ...`) until the Nix store size (in bytes) is at most this number just before the action tries to save a new cache.
+                - When a non-negative integer number (possibly with a suffix), the action collects garbage (via `nix store gc --max ...`) until the Nix store size (in bytes) is at most this number just before the action tries to save a new cache.
+                - If you specify a suffix, it must be `K` (kibibytes, 2 ^ 10 bytes), `M` (mebibytes, 2 ^ 20 bytes) or `G` (gibibytes, 2 ^ 30 bytes), where `2 ^ N` means `2 to the power N`.
                 - ${noEffectOtherwise}
               default: ""
             ${gc-max-store-size}-macos:

action.yml

@@ -88,7 +88,8 @@ inputs:
     description: |
       - Can have an effect only when `nix: true`, `save: true`.
       - The input has no effect if "primary-key" hit occurs when starting to save the new cache.
-      - When a number, the action collects garbage (via `nix store gc --max ...`) until the Nix store size (in bytes) is at most this number just before the action tries to save a new cache.
+      - When a non-negative integer number (possibly with a suffix), the action collects garbage (via `nix store gc --max ...`) until the Nix store size (in bytes) is at most this number just before the action tries to save a new cache.
+      - If you specify a suffix, it must be `K` (kibibytes, 2 ^ 10 bytes), `M` (mebibytes, 2 ^ 20 bytes) or `G` (gibibytes, 2 ^ 30 bytes), where `2 ^ N` means `2 to the power N`.
       - Otherwise, this input has no effect.
     default: ""
   gc-max-store-size-macos:

dist/restore-only/index.js

@@ -83753,7 +83753,8 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.backend = exports.Backend = exports.token = exports.uploadChunkSize = exports.purgeCreated = exports.purgeLastAccessed = exports.purgePrefixes = exports.purgePrimaryKey = exports.purge = exports.gcMaxStoreSize = exports.save = exports.paths = exports.nix = exports.isMacos = exports.isLinux = exports.failOn = exports.skipRestoreOnHitPrimaryKey = exports.restorePrefixesAllMatches = exports.restorePrefixesFirstMatch = exports.primaryKey = void 0;
+exports.backend = exports.Backend = exports.token = exports.uploadChunkSize = exports.purgeCreated = exports.purgeLastAccessed = exports.purgePrefixes = exports.purgePrimaryKey = exports.purge = exports.gcMaxStoreSize = exports.gcMaxStoreSizeInputName = exports.save = exports.paths = exports.nix = exports.isMacos = exports.isLinux = exports.failOn = exports.skipRestoreOnHitPrimaryKey = exports.restorePrefixesAllMatches = exports.restorePrefixesFirstMatch = exports.primaryKey = void 0;
+exports.choose = choose;
 const core = __importStar(__nccwpck_require__(7484));
 const constants_1 = __nccwpck_require__(7242);
 const utils = __importStar(__nccwpck_require__(9612));
@@ -83809,10 +83810,11 @@ exports.paths = (exports.nix
         return paths;
 })());
 exports.save = utils.getInputAsBool(constants_1.Inputs.Save);
+exports.gcMaxStoreSizeInputName = choose(constants_1.Inputs.GCMaxStoreSizeLinux, constants_1.Inputs.GCMaxStoreSizeMacos, constants_1.Inputs.GCMaxStoreSize);
 exports.gcMaxStoreSize = exports.nix
     ? (function () {
-        const gcMaxStoreSize = utils.getInputAsInt(constants_1.Inputs.GCMaxStoreSize);
-        const gcMaxStoreSizePlatform = utils.getInputAsInt(choose(constants_1.Inputs.GCMaxStoreSizeLinux, constants_1.Inputs.GCMaxStoreSizeMacos, constants_1.Inputs.GCMaxStoreSize));
+        const gcMaxStoreSize = utils.parseNixGcMax(constants_1.Inputs.GCMaxStoreSize);
+        const gcMaxStoreSizePlatform = utils.parseNixGcMax(exports.gcMaxStoreSizeInputName);
         return gcMaxStoreSizePlatform !== undefined
             ? gcMaxStoreSizePlatform
             : gcMaxStoreSize;
@@ -84725,6 +84727,7 @@ var __importStar = (this && this.__importStar) || (function () {
 })();
 Object.defineProperty(exports, "__esModule", ({ value: true }));
 exports.getInputAsArray = getInputAsArray;
+exports.parseNixGcMax = parseNixGcMax;
 exports.getInputAsInt = getInputAsInt;
 exports.getInputAsBool = getInputAsBool;
 const core = __importStar(__nccwpck_require__(7484));
@@ -84735,6 +84738,41 @@ function getInputAsArray(name, options) {
         .map(s => s.replace(/^!\s+/, "!").trim())
         .filter(x => x !== "");
 }
+// https://github.com/NixOS/nix/blob/a047dec120672d00e069bacf10ffdda420fd1048/src/libutil/util.hh#L88
+function parseNixGcMax(name, options) {
+    const input = core.getInput(name, options);
+    if (input.length == 0) {
+        return undefined;
+    }
+    const chars = [...input];
+    let result = 0;
+    for (let i = 0; i < chars.length; i++) {
+        const char = chars[i];
+        const digit = parseInt(char);
+        if (!isNaN(digit)) {
+            result = result * 10 + digit;
+        }
+        else {
+            if (i == chars.length - 1) {
+                switch (char) {
+                    case "K":
+                        result <<= 10;
+                    case "M":
+                        result <<= 20;
+                    case "G":
+                        result <<= 30;
+                    default:
+                        result = NaN;
+                }
+            }
+            else {
+                result = NaN;
+                break;
+            }
+        }
+    }
+    return isNaN(result) ? undefined : { input, value: result };
+}
 function getInputAsInt(name, options) {
     const value = parseInt(core.getInput(name, options));
     if (isNaN(value) || value < 0) {

dist/restore/index.js

@@ -83753,7 +83753,8 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.backend = exports.Backend = exports.token = exports.uploadChunkSize = exports.purgeCreated = exports.purgeLastAccessed = exports.purgePrefixes = exports.purgePrimaryKey = exports.purge = exports.gcMaxStoreSize = exports.save = exports.paths = exports.nix = exports.isMacos = exports.isLinux = exports.failOn = exports.skipRestoreOnHitPrimaryKey = exports.restorePrefixesAllMatches = exports.restorePrefixesFirstMatch = exports.primaryKey = void 0;
+exports.backend = exports.Backend = exports.token = exports.uploadChunkSize = exports.purgeCreated = exports.purgeLastAccessed = exports.purgePrefixes = exports.purgePrimaryKey = exports.purge = exports.gcMaxStoreSize = exports.gcMaxStoreSizeInputName = exports.save = exports.paths = exports.nix = exports.isMacos = exports.isLinux = exports.failOn = exports.skipRestoreOnHitPrimaryKey = exports.restorePrefixesAllMatches = exports.restorePrefixesFirstMatch = exports.primaryKey = void 0;
+exports.choose = choose;
 const core = __importStar(__nccwpck_require__(7484));
 const constants_1 = __nccwpck_require__(7242);
 const utils = __importStar(__nccwpck_require__(9612));
@@ -83809,10 +83810,11 @@ exports.paths = (exports.nix
         return paths;
 })());
 exports.save = utils.getInputAsBool(constants_1.Inputs.Save);
+exports.gcMaxStoreSizeInputName = choose(constants_1.Inputs.GCMaxStoreSizeLinux, constants_1.Inputs.GCMaxStoreSizeMacos, constants_1.Inputs.GCMaxStoreSize);
 exports.gcMaxStoreSize = exports.nix
     ? (function () {
-        const gcMaxStoreSize = utils.getInputAsInt(constants_1.Inputs.GCMaxStoreSize);
-        const gcMaxStoreSizePlatform = utils.getInputAsInt(choose(constants_1.Inputs.GCMaxStoreSizeLinux, constants_1.Inputs.GCMaxStoreSizeMacos, constants_1.Inputs.GCMaxStoreSize));
+        const gcMaxStoreSize = utils.parseNixGcMax(constants_1.Inputs.GCMaxStoreSize);
+        const gcMaxStoreSizePlatform = utils.parseNixGcMax(exports.gcMaxStoreSizeInputName);
         return gcMaxStoreSizePlatform !== undefined
             ? gcMaxStoreSizePlatform
             : gcMaxStoreSize;
@@ -84725,6 +84727,7 @@ var __importStar = (this && this.__importStar) || (function () {
 })();
 Object.defineProperty(exports, "__esModule", ({ value: true }));
 exports.getInputAsArray = getInputAsArray;
+exports.parseNixGcMax = parseNixGcMax;
 exports.getInputAsInt = getInputAsInt;
 exports.getInputAsBool = getInputAsBool;
 const core = __importStar(__nccwpck_require__(7484));
@@ -84735,6 +84738,41 @@ function getInputAsArray(name, options) {
         .map(s => s.replace(/^!\s+/, "!").trim())
         .filter(x => x !== "");
 }
+// https://github.com/NixOS/nix/blob/a047dec120672d00e069bacf10ffdda420fd1048/src/libutil/util.hh#L88
+function parseNixGcMax(name, options) {
+    const input = core.getInput(name, options);
+    if (input.length == 0) {
+        return undefined;
+    }
+    const chars = [...input];
+    let result = 0;
+    for (let i = 0; i < chars.length; i++) {
+        const char = chars[i];
+        const digit = parseInt(char);
+        if (!isNaN(digit)) {
+            result = result * 10 + digit;
+        }
+        else {
+            if (i == chars.length - 1) {
+                switch (char) {
+                    case "K":
+                        result <<= 10;
+                    case "M":
+                        result <<= 20;
+                    case "G":
+                        result <<= 30;
+                    default:
+                        result = NaN;
+                }
+            }
+            else {
+                result = NaN;
+                break;
+            }
+        }
+    }
+    return isNaN(result) ? undefined : { input, value: result };
+}
 function getInputAsInt(name, options) {
     const value = parseInt(core.getInput(name, options));
     if (isNaN(value) || value < 0) {