lim 0.24.0 → 0.25.0

package/dist/lib/cache.js

@@ -0,0 +1,165 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseCacheConfig = parseCacheConfig;
+exports.wantsRestore = wantsRestore;
+exports.restoreProgressLine = restoreProgressLine;
+exports.saveProgressLine = saveProgressLine;
+exports.restoreOutcome = restoreOutcome;
+exports.skippedKeyLines = skippedKeyLines;
+exports.saveOutcome = saveOutcome;
+exports.formatBytes = formatBytes;
+const duration_1 = require("./duration");
+/** The cache configuration a create request carries, or undefined for an ordinary instance. */
+function parseCacheConfig(flags) {
+    const key = flags['cache-key']?.trim() || undefined;
+    const restoreKeys = splitList(flags['cache-restore-keys']);
+    const paths = splitList(flags['cache-paths']);
+    if (!key && !restoreKeys && !paths) {
+        return undefined;
+    }
+    return {
+        ...(key ? { key } : {}),
+        ...(restoreKeys ? { restoreKeys } : {}),
+        ...(paths ? { paths } : {}),
+    };
+}
+function splitList(value) {
+    if (!value)
+        return undefined;
+    const items = value
+        .split(',')
+        .map((item) => item.trim())
+        .filter(Boolean);
+    return items.length > 0 ? items : undefined;
+}
+/** Whether a config asks for a restore at all, which is what makes create block. */
+function wantsRestore(config) {
+    return !!config && ((config.restoreKeys?.length ?? 0) > 0 || !!config.key);
+}
+const RESTORE_PROGRESS = {
+    placing: 'preparing the workspace directory',
+    downloading: 'downloading the archive',
+    materializing: 'unpacking the archive into the workspace',
+};
+const SAVE_PROGRESS = {
+    idle: 'waiting for the build sandbox to stop',
+    quiescing: 'stopping the build sandbox',
+    archiving: 'archiving the workspace',
+    uploading: 'uploading the archive',
+    verifying: 'verifying the upload',
+};
+const REASONS = {
+    no_match: 'no archive matched the restore keys',
+    in_use: 'the stable workspace directory is in use by another instance',
+    link_conflict: 'the stable workspace directory conflicts with an existing one',
+    unsupported_node: 'the node this instance landed on has no cache storage configured',
+    checksum: 'the archive checksum did not match',
+    directory_key_mismatch: 'the archive belongs to a different workspace directory',
+    root_name_mismatch: 'the archive was built under a different project root name',
+    scope_mismatch: 'the archive stores a different set of paths',
+    xcode_version_mismatch: 'the archive was built with a different Xcode',
+    disk_headroom: 'the node does not have enough free disk space',
+    transport: 'the transfer failed',
+    publish_deadline: 'publication ran past the time limit',
+    no_pod: 'the instance had no node left to publish from',
+};
+function explain(reason) {
+    if (!reason)
+        return undefined;
+    return REASONS[reason] ?? reason;
+}
+/** A line for a phase that is still moving, or undefined for phases with nothing to say. */
+function restoreProgressLine(cache) {
+    const text = RESTORE_PROGRESS[cache.restore.phase];
+    return text ? `Cache restore: ${text}...` : undefined;
+}
+function saveProgressLine(cache) {
+    const text = SAVE_PROGRESS[cache.save.phase];
+    return text ? `Cache publish: ${text}...` : undefined;
+}
+/**
+ * How the restore ended, in one line, plus whether it is the kind of ending a caller reacts to.
+ * A cold instance is a normal outcome; only `failed` means the warm workspace that was asked
+ * for is not there and something is actually wrong.
+ */
+function restoreOutcome(cache, fallbackMs) {
+    const restore = cache.restore;
+    const took = ` in ${(0, duration_1.formatDurationMs)(durationMs(restore, fallbackMs))}`;
+    switch (restore.phase) {
+        case 'restored': {
+            const from = restore.matchedKey ? ` from ${restore.matchedKey}` : '';
+            const kind = restore.matchKind === 'prefix_hit' ? ' (prefix match)' : '';
+            const size = restore.bytes ? `, ${formatBytes(restore.bytes)}` : '';
+            const via = restore.source === 'tag' ? ' via the regional accelerator'
+                : restore.source === 'tigris' ? ' direct from object storage'
+                    : '';
+            return { line: `Cache restored${from}${kind}${size}${via}${took}.`, failed: false };
+        }
+        case 'failed': {
+            const why = explain(restore.reason);
+            const detail = restore.message ? `: ${restore.message}` : '';
+            return {
+                line: `Cache restore failed${why ? ` — ${why}` : ''}${detail}${took}.`,
+                failed: true,
+            };
+        }
+        default: {
+            const why = explain(restore.reason);
+            return {
+                line: `No cache restored${why ? ` — ${why}` : ''}. Continuing with a cold workspace.`,
+                failed: false,
+            };
+        }
+    }
+}
+/** The keys resolution passed over, as indented lines, so a miss is explainable. */
+function skippedKeyLines(cache) {
+    return (cache.restore.skippedKeys ?? []).map((skipped) => `  ${skipped.key}: ${explain(skipped.reason) ?? skipped.reason}`);
+}
+function saveOutcome(cache, fallbackMs) {
+    const save = cache.save;
+    const took = ` in ${(0, duration_1.formatDurationMs)(durationMs(save, fallbackMs))}`;
+    const why = explain(save.reason);
+    switch (save.phase) {
+        case 'published': {
+            const under = save.cacheKey ? ` under ${save.cacheKey}` : '';
+            const size = save.bytes ? `, ${formatBytes(save.bytes)}` : '';
+            return { line: `Cache published${under}${size}${took}.`, failed: false };
+        }
+        case 'failed':
+            return {
+                line: `Cache publish failed${why ? ` — ${why}` : ''}${save.message ? `: ${save.message}` : ''}${took}.`,
+                failed: true,
+            };
+        case 'timed_out':
+            return { line: `Cache publish timed out${took}. The previous archive is untouched.`, failed: true };
+        default:
+            return { line: `Nothing published${why ? ` — ${why}` : ''}.`, failed: false };
+    }
+}
+/**
+ * Server-measured duration when the status carries both ends, since that is the time the
+ * transfer actually took rather than the time this process spent watching it.
+ */
+function durationMs(status, fallbackMs) {
+    if (status.startedAt && status.finishedAt) {
+        const started = Date.parse(status.startedAt);
+        const finished = Date.parse(status.finishedAt);
+        if (!Number.isNaN(started) && !Number.isNaN(finished) && finished >= started) {
+            return finished - started;
+        }
+    }
+    return fallbackMs;
+}
+function formatBytes(bytes) {
+    const units = ['B', 'KB', 'MB', 'GB', 'TB'];
+    let value = bytes;
+    let unit = 0;
+    while (value >= 1024 && unit < units.length - 1) {
+        value /= 1024;
+        unit++;
+    }
+    const rounded = unit === 0 || value >= 100 ? Math.round(value) : Number(value.toFixed(1));
+    return `${rounded} ${units[unit]}`;
+}
+//# sourceMappingURL=cache.js.map

package/dist/lib/cache.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cache.js","sourceRoot":"","sources":["../../src/lib/cache.ts"],"names":[],"mappings":";;AAkBA,4CAYC;AAYD,oCAEC;AAsCD,kDAGC;AAED,4CAGC;AAOD,wCAiCC;AAGD,0CAIC;AAED,kCAyBC;AAiBD,kCAUC;AAzLD,yCAA8C;AAW9C,+FAA+F;AAC/F,SAAgB,gBAAgB,CAAC,KAAiB;IAChD,MAAM,GAAG,GAAG,KAAK,CAAC,WAAW,CAAC,EAAE,IAAI,EAAE,IAAI,SAAS,CAAC;IACpD,MAAM,WAAW,GAAG,SAAS,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC,CAAC;IAC3D,MAAM,KAAK,GAAG,SAAS,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC;IAC9C,IAAI,CAAC,GAAG,IAAI,CAAC,WAAW,IAAI,CAAC,KAAK,EAAE,CAAC;QACnC,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO;QACL,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACvB,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACvC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KAC5B,CAAC;AACJ,CAAC;AAED,SAAS,SAAS,CAAC,KAAyB;IAC1C,IAAI,CAAC,KAAK;QAAE,OAAO,SAAS,CAAC;IAC7B,MAAM,KAAK,GAAG,KAAK;SAChB,KAAK,CAAC,GAAG,CAAC;SACV,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;SAC1B,MAAM,CAAC,OAAO,CAAC,CAAC;IACnB,OAAO,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;AAC9C,CAAC;AAED,oFAAoF;AACpF,SAAgB,YAAY,CAAC,MAAoC;IAC/D,OAAO,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,MAAM,CAAC,WAAW,EAAE,MAAM,IAAI,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;AAC7E,CAAC;AAED,MAAM,gBAAgB,GAA2B;IAC/C,OAAO,EAAE,mCAAmC;IAC5C,WAAW,EAAE,yBAAyB;IACtC,aAAa,EAAE,0CAA0C;CAC1D,CAAC;AAEF,MAAM,aAAa,GAA2B;IAC5C,IAAI,EAAE,uCAAuC;IAC7C,SAAS,EAAE,4BAA4B;IACvC,SAAS,EAAE,yBAAyB;IACpC,SAAS,EAAE,uBAAuB;IAClC,SAAS,EAAE,sBAAsB;CAClC,CAAC;AAEF,MAAM,OAAO,GAA2B;IACtC,QAAQ,EAAE,qCAAqC;IAC/C,MAAM,EAAE,8DAA8D;IACtE,aAAa,EAAE,+DAA+D;IAC9E,gBAAgB,EAAE,kEAAkE;IACpF,QAAQ,EAAE,oCAAoC;IAC9C,sBAAsB,EAAE,wDAAwD;IAChF,kBAAkB,EAAE,2DAA2D;IAC/E,cAAc,EAAE,6CAA6C;IAC7D,sBAAsB,EAAE,8CAA8C;IACtE,aAAa,EAAE,+CAA+C;IAC9D,SAAS,EAAE,qBAAqB;IAChC,gBAAgB,EAAE,qCAAqC;IACvD,MAAM,EAAE,+CAA+C;CACxD,CAAC;AAEF,SAAS,OAAO,CAAC,MAA0B;IACzC,IAAI,CAAC,MAAM;QAAE,OAAO,SAAS,CAAC;IAC9B,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,MAAM,CAAC;AACnC,CAAC;AAED,4FAA4F;AAC5F,SAAgB,mBAAmB,CAAC,KAAyB;IAC3D,MAAM,IAAI,GAAG,gBAAgB,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IACnD,OAAO,IAAI,CAAC,CAAC,CAAC,kBAAkB,IAAI,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;AACxD,CAAC;AAED,SAAgB,gBAAgB,CAAC,KAAyB;IACxD,MAAM,IAAI,GAAG,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC7C,OAAO,IAAI,CAAC,CAAC,CAAC,kBAAkB,IAAI,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;AACxD,CAAC;AAED;;;;GAIG;AACH,SAAgB,cAAc,CAC5B,KAAyB,EACzB,UAAkB;IAElB,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC;IAC9B,MAAM,IAAI,GAAG,OAAO,IAAA,2BAAgB,EAAC,UAAU,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC,EAAE,CAAC;IACxE,QAAQ,OAAO,CAAC,KAAK,EAAE,CAAC;QACtB,KAAK,UAAU,CAAC,CAAC,CAAC;YAChB,MAAM,IAAI,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACrE,MAAM,IAAI,GAAG,OAAO,CAAC,SAAS,KAAK,YAAY,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,EAAE,CAAC;YACzE,MAAM,IAAI,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACpE,MAAM,GAAG,GACP,OAAO,CAAC,MAAM,KAAK,KAAK,CAAC,CAAC,CAAC,+BAA+B;gBAC1D,CAAC,CAAC,OAAO,CAAC,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,6BAA6B;oBAC7D,CAAC,CAAC,EAAE,CAAC;YACP,OAAO,EAAE,IAAI,EAAE,iBAAiB,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,GAAG,GAAG,IAAI,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC;QACtF,CAAC;QACD,KAAK,QAAQ,CAAC,CAAC,CAAC;YACd,MAAM,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YACpC,MAAM,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YAC7D,OAAO;gBACL,IAAI,EAAE,uBAAuB,GAAG,CAAC,CAAC,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE,GAAG,MAAM,GAAG,IAAI,GAAG;gBACtE,MAAM,EAAE,IAAI;aACb,CAAC;QACJ,CAAC;QACD,OAAO,CAAC,CAAC,CAAC;YACR,MAAM,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YACpC,OAAO;gBACL,IAAI,EAAE,oBAAoB,GAAG,CAAC,CAAC,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE,qCAAqC;gBACrF,MAAM,EAAE,KAAK;aACd,CAAC;QACJ,CAAC;IACH,CAAC;AACH,CAAC;AAED,oFAAoF;AACpF,SAAgB,eAAe,CAAC,KAAyB;IACvD,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,WAAW,IAAI,EAAE,CAAC,CAAC,GAAG,CAC1C,CAAC,OAAO,EAAE,EAAE,CAAC,KAAK,OAAO,CAAC,GAAG,KAAK,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,OAAO,CAAC,MAAM,EAAE,CAC9E,CAAC;AACJ,CAAC;AAED,SAAgB,WAAW,CACzB,KAAyB,EACzB,UAAkB;IAElB,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;IACxB,MAAM,IAAI,GAAG,OAAO,IAAA,2BAAgB,EAAC,UAAU,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,EAAE,CAAC;IACrE,MAAM,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACjC,QAAQ,IAAI,CAAC,KAAK,EAAE,CAAC;QACnB,KAAK,WAAW,CAAC,CAAC,CAAC;YACjB,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,UAAU,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YAC7D,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YAC9D,OAAO,EAAE,IAAI,EAAE,kBAAkB,KAAK,GAAG,IAAI,GAAG,IAAI,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC;QAC3E,CAAC;QACD,KAAK,QAAQ;YACX,OAAO;gBACL,IAAI,EAAE,uBAAuB,GAAG,CAAC,CAAC,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE,GACjD,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,EACvC,GAAG,IAAI,GAAG;gBACV,MAAM,EAAE,IAAI;aACb,CAAC;QACJ,KAAK,WAAW;YACd,OAAO,EAAE,IAAI,EAAE,0BAA0B,IAAI,sCAAsC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;QACtG;YACE,OAAO,EAAE,IAAI,EAAE,oBAAoB,GAAG,CAAC,CAAC,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC;IAClF,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,SAAS,UAAU,CAAC,MAAsD,EAAE,UAAkB;IAC5F,IAAI,MAAM,CAAC,SAAS,IAAI,MAAM,CAAC,UAAU,EAAE,CAAC;QAC1C,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAC7C,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;QAC/C,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,QAAQ,IAAI,OAAO,EAAE,CAAC;YAC7E,OAAO,QAAQ,GAAG,OAAO,CAAC;QAC5B,CAAC;IACH,CAAC;IACD,OAAO,UAAU,CAAC;AACpB,CAAC;AAED,SAAgB,WAAW,CAAC,KAAa;IACvC,MAAM,KAAK,GAAG,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IAC5C,IAAI,KAAK,GAAG,KAAK,CAAC;IAClB,IAAI,IAAI,GAAG,CAAC,CAAC;IACb,OAAO,KAAK,IAAI,IAAI,IAAI,IAAI,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAChD,KAAK,IAAI,IAAI,CAAC;QACd,IAAI,EAAE,CAAC;IACT,CAAC;IACD,MAAM,OAAO,GAAG,IAAI,KAAK,CAAC,IAAI,KAAK,IAAI,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;IAC1F,OAAO,GAAG,OAAO,IAAI,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;AACrC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lim",
-  "version": "0.24.0",
+  "version": "0.25.0",
   "description": "Use remote XCode, Gradle, iOS Simulator, Android Emulator and more to build and test apps from Linux, Windows or macOS.",
   "bin": {
     "lim": "./bin/run.js"
@@ -25,7 +25,7 @@
     "test": "jest"
   },
   "dependencies": {
-    "@limrun/api": "0.46.1",
+    "@limrun/api": "0.46.2",
     "@oclif/core": "^4",
     "cli-progress": "^3.12.0",
     "cli-table3": "^0.6.5",