renovate 42.0.0-next.2 → 42.0.0

package/dist/modules/versioning/semver-partial/index.js

@@ -0,0 +1,211 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.api = exports.supportedRangeStrategies = exports.supportsRanges = exports.urls = exports.displayName = exports.id = void 0;
+const tslib_1 = require("tslib");
+const is_1 = tslib_1.__importDefault(require("@sindresorhus/is"));
+const semver_1 = tslib_1.__importDefault(require("semver"));
+const regex_1 = require("../../../util/regex");
+exports.id = 'semver-partial';
+exports.displayName = 'Partial Semantic Versioning';
+exports.urls = [
+    'https://docs.gitlab.com/ci/components/#partial-semantic-versions',
+];
+exports.supportsRanges = true;
+exports.supportedRangeStrategies = ['pin', 'replace'];
+function isLatest(input) {
+    return input === '~latest';
+}
+function massageValue(input) {
+    return input.trim().replace((0, regex_1.regEx)(/^v/i), '');
+}
+function parseVersion(input) {
+    return semver_1.default.parse(massageValue(input));
+}
+function parseRange(input) {
+    const stripped = massageValue(input);
+    const coerced = semver_1.default.coerce(stripped);
+    if (!coerced) {
+        return null;
+    }
+    const { major, minor } = coerced;
+    if ((0, regex_1.regEx)(/^\d+$/).test(stripped)) {
+        return { major };
+    }
+    return { major, minor };
+}
+function isValid(input) {
+    return isLatest(input) || !!parseVersion(input) || !!parseRange(input);
+}
+function isVersion(input) {
+    if (!input) {
+        return false;
+    }
+    return !!parseVersion(input);
+}
+function isStable(version) {
+    const v = parseVersion(version);
+    if (!v) {
+        return false;
+    }
+    return v.prerelease.length === 0;
+}
+function isSingleVersion(input) {
+    return isVersion(input);
+}
+function getMajor(version) {
+    return parseVersion(version)?.major ?? null;
+}
+function getMinor(version) {
+    return parseVersion(version)?.minor ?? null;
+}
+function getPatch(version) {
+    return parseVersion(version)?.patch ?? null;
+}
+function sortVersions(x, y) {
+    const a = parseVersion(x);
+    const b = parseVersion(y);
+    if (!a || !b) {
+        return 0;
+    }
+    return semver_1.default.compare(a, b);
+}
+function equals(x, y) {
+    const a = parseVersion(x);
+    const b = parseVersion(y);
+    if (!a || !b) {
+        return false;
+    }
+    return semver_1.default.eq(a, b);
+}
+function isGreaterThan(x, y) {
+    const a = parseVersion(x);
+    const b = parseVersion(y);
+    if (!a || !b) {
+        return false;
+    }
+    return semver_1.default.gt(a, b);
+}
+function matches(version, range) {
+    const v = parseVersion(version);
+    if (!v) {
+        return false;
+    }
+    if (isLatest(range)) {
+        return true;
+    }
+    const rv = parseVersion(range);
+    if (rv) {
+        return semver_1.default.eq(v, rv);
+    }
+    const r = parseRange(range);
+    if (!r) {
+        return false;
+    }
+    if (v.prerelease.length > 0) {
+        return false;
+    }
+    if (v.major !== r.major) {
+        return false;
+    }
+    if (is_1.default.undefined(r.minor)) {
+        return true;
+    }
+    return v.minor === r.minor;
+}
+function getSatisfyingVersion(versions, range) {
+    const sortedVersions = versions.sort(sortVersions).reverse();
+    for (const version of sortedVersions) {
+        if (matches(version, range)) {
+            return version;
+        }
+    }
+    return null;
+}
+function minSatisfyingVersion(versions, range) {
+    const sortedVersions = versions.sort(sortVersions);
+    for (const version of sortedVersions) {
+        if (matches(version, range)) {
+            return version;
+        }
+    }
+    return null;
+}
+function isLessThanRange(version, range) {
+    const v = parseVersion(version);
+    const r = parseRange(range);
+    if (!v || !r) {
+        return false;
+    }
+    if (v.major !== r.major) {
+        return v.major < r.major;
+    }
+    if (is_1.default.undefined(r.minor)) {
+        return false;
+    }
+    if (v.minor !== r.minor) {
+        return v.minor < r.minor;
+    }
+    return false;
+}
+function getNewValue({ currentValue, rangeStrategy, currentVersion, newVersion, }) {
+    if (rangeStrategy === 'pin') {
+        return newVersion;
+    }
+    if (isLatest(currentValue)) {
+        return currentValue;
+    }
+    const range = parseRange(currentValue);
+    if (!range) {
+        return newVersion;
+    }
+    const newParsed = parseVersion(newVersion);
+    if (!newParsed) {
+        return newVersion;
+    }
+    // Check if currentValue is a full version (has patch component)
+    const currentParsed = parseVersion(currentValue);
+    if (currentParsed) {
+        // currentValue is a full version, return full newVersion
+        return newVersion;
+    }
+    const [prefix] = currentValue.split(massageValue(currentValue));
+    if (is_1.default.undefined(range.minor)) {
+        return `${prefix}${newParsed.major}`;
+    }
+    return `${prefix}${newParsed.major}.${newParsed.minor}`;
+}
+function isCompatible(version) {
+    return isValid(version);
+}
+function isBreaking(version, current) {
+    const versionParsed = parseVersion(version);
+    const currentParsed = parseVersion(current);
+    if (!versionParsed || !currentParsed) {
+        return false;
+    }
+    if (currentParsed.major === 0) {
+        return versionParsed.major > 0 || versionParsed.minor > currentParsed.minor;
+    }
+    return versionParsed.major > currentParsed.major;
+}
+exports.api = {
+    equals,
+    getMajor,
+    getMinor,
+    getPatch,
+    isBreaking,
+    isCompatible,
+    isGreaterThan,
+    isLessThanRange,
+    isSingleVersion,
+    isStable,
+    isValid,
+    isVersion,
+    matches,
+    getSatisfyingVersion,
+    minSatisfyingVersion,
+    getNewValue,
+    sortVersions,
+};
+exports.default = exports.api;
+//# sourceMappingURL=index.js.map

package/dist/modules/versioning/semver-partial/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../lib/modules/versioning/semver-partial/index.ts"],"names":[],"mappings":";;;;AAAA,kEAAkC;AAElC,4DAA4B;AAC5B,+CAA4C;AAG/B,QAAA,EAAE,GAAG,gBAAgB,CAAC;AACtB,QAAA,WAAW,GAAG,6BAA6B,CAAC;AAC5C,QAAA,IAAI,GAAG;IAClB,kEAAkE;CACnE,CAAC;AACW,QAAA,cAAc,GAAG,IAAI,CAAC;AACtB,QAAA,wBAAwB,GAAG,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;AAE3D,SAAS,QAAQ,CAAC,KAAa;IAC7B,OAAO,KAAK,KAAK,SAAS,CAAC;AAC7B,CAAC;AAED,SAAS,YAAY,CAAC,KAAa;IACjC,OAAO,KAAK,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,IAAA,aAAK,EAAC,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC;AAChD,CAAC;AAED,SAAS,YAAY,CAAC,KAAa;IACjC,OAAO,gBAAM,CAAC,KAAK,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC;AAC3C,CAAC;AAOD,SAAS,UAAU,CAAC,KAAa;IAC/B,MAAM,QAAQ,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;IACrC,MAAM,OAAO,GAAG,gBAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IACxC,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,OAAO,IAAI,CAAC;IACd,CAAC;IACD,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC;IAEjC,IAAI,IAAA,aAAK,EAAC,OAAO,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;QAClC,OAAO,EAAE,KAAK,EAAE,CAAC;IACnB,CAAC;IAED,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC;AAC1B,CAAC;AAED,SAAS,OAAO,CAAC,KAAa;IAC5B,OAAO,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;AACzE,CAAC;AAED,SAAS,SAAS,CAAC,KAAgC;IACjD,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,OAAO,KAAK,CAAC;IACf,CAAC;IAED,OAAO,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;AAC/B,CAAC;AAED,SAAS,QAAQ,CAAC,OAAe;IAC/B,MAAM,CAAC,GAAG,YAAY,CAAC,OAAO,CAAC,CAAC;IAChC,IAAI,CAAC,CAAC,EAAE,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;IAED,OAAO,CAAC,CAAC,UAAU,CAAC,MAAM,KAAK,CAAC,CAAC;AACnC,CAAC;AAED,SAAS,eAAe,CAAC,KAAa;IACpC,OAAO,SAAS,CAAC,KAAK,CAAC,CAAC;AAC1B,CAAC;AAED,SAAS,QAAQ,CAAC,OAAe;IAC/B,OAAO,YAAY,CAAC,OAAO,CAAC,EAAE,KAAK,IAAI,IAAI,CAAC;AAC9C,CAAC;AAED,SAAS,QAAQ,CAAC,OAAe;IAC/B,OAAO,YAAY,CAAC,OAAO,CAAC,EAAE,KAAK,IAAI,IAAI,CAAC;AAC9C,CAAC;AAED,SAAS,QAAQ,CAAC,OAAe;IAC/B,OAAO,YAAY,CAAC,OAAO,CAAC,EAAE,KAAK,IAAI,IAAI,CAAC;AAC9C,CAAC;AAED,SAAS,YAAY,CAAC,CAAS,EAAE,CAAS;IACxC,MAAM,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC;IAC1B,MAAM,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC;IAC1B,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;QACb,OAAO,CAAC,CAAC;IACX,CAAC;IACD,OAAO,gBAAM,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AAC9B,CAAC;AAED,SAAS,MAAM,CAAC,CAAS,EAAE,CAAS;IAClC,MAAM,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC;IAC1B,MAAM,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC;IAC1B,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;QACb,OAAO,KAAK,CAAC;IACf,CAAC;IACD,OAAO,gBAAM,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AACzB,CAAC;AAED,SAAS,aAAa,CAAC,CAAS,EAAE,CAAS;IACzC,MAAM,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC;IAC1B,MAAM,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC;IAC1B,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;QACb,OAAO,KAAK,CAAC;IACf,CAAC;IACD,OAAO,gBAAM,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AACzB,CAAC;AAED,SAAS,OAAO,CAAC,OAAe,EAAE,KAAa;IAC7C,MAAM,CAAC,GAAG,YAAY,CAAC,OAAO,CAAC,CAAC;IAChC,IAAI,CAAC,CAAC,EAAE,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IAAI,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QACpB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,EAAE,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;IAC/B,IAAI,EAAE,EAAE,CAAC;QACP,OAAO,gBAAM,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IAC1B,CAAC;IAED,MAAM,CAAC,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC;IAC5B,IAAI,CAAC,CAAC,EAAE,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IAAI,CAAC,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC5B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IAAI,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,KAAK,EAAE,CAAC;QACxB,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IAAI,YAAE,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC;QAC1B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,KAAK,CAAC;AAC7B,CAAC;AAED,SAAS,oBAAoB,CAC3B,QAAkB,EAClB,KAAa;IAEb,MAAM,cAAc,GAAG,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,OAAO,EAAE,CAAC;IAC7D,KAAK,MAAM,OAAO,IAAI,cAAc,EAAE,CAAC;QACrC,IAAI,OAAO,CAAC,OAAO,EAAE,KAAK,CAAC,EAAE,CAAC;YAC5B,OAAO,OAAO,CAAC;QACjB,CAAC;IACH,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,SAAS,oBAAoB,CAC3B,QAAkB,EAClB,KAAa;IAEb,MAAM,cAAc,GAAG,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IACnD,KAAK,MAAM,OAAO,IAAI,cAAc,EAAE,CAAC;QACrC,IAAI,OAAO,CAAC,OAAO,EAAE,KAAK,CAAC,EAAE,CAAC;YAC5B,OAAO,OAAO,CAAC;QACjB,CAAC;IACH,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,SAAS,eAAe,CAAC,OAAe,EAAE,KAAa;IACrD,MAAM,CAAC,GAAG,YAAY,CAAC,OAAO,CAAC,CAAC;IAChC,MAAM,CAAC,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC;IAE5B,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;QACb,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IAAI,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,KAAK,EAAE,CAAC;QACxB,OAAO,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC;IAC3B,CAAC;IAED,IAAI,YAAE,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC;QAC1B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IAAI,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,KAAK,EAAE,CAAC;QACxB,OAAO,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC;IAC3B,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,WAAW,CAAC,EACnB,YAAY,EACZ,aAAa,EACb,cAAc,EACd,UAAU,GACK;IACf,IAAI,aAAa,KAAK,KAAK,EAAE,CAAC;QAC5B,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,IAAI,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC;QAC3B,OAAO,YAAY,CAAC;IACtB,CAAC;IAED,MAAM,KAAK,GAAG,UAAU,CAAC,YAAY,CAAC,CAAC;IACvC,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,MAAM,SAAS,GAAG,YAAY,CAAC,UAAU,CAAC,CAAC;IAC3C,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,gEAAgE;IAChE,MAAM,aAAa,GAAG,YAAY,CAAC,YAAY,CAAC,CAAC;IACjD,IAAI,aAAa,EAAE,CAAC;QAClB,yDAAyD;QACzD,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,MAAM,CAAC,MAAM,CAAC,GAAG,YAAY,CAAC,KAAK,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,CAAC;IAEhE,IAAI,YAAE,CAAC,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;QAC9B,OAAO,GAAG,MAAM,GAAG,SAAS,CAAC,KAAK,EAAE,CAAC;IACvC,CAAC;IAED,OAAO,GAAG,MAAM,GAAG,SAAS,CAAC,KAAK,IAAI,SAAS,CAAC,KAAK,EAAE,CAAC;AAC1D,CAAC;AAED,SAAS,YAAY,CAAC,OAAe;IACnC,OAAO,OAAO,CAAC,OAAO,CAAC,CAAC;AAC1B,CAAC;AAED,SAAS,UAAU,CAAC,OAAe,EAAE,OAAe;IAClD,MAAM,aAAa,GAAG,YAAY,CAAC,OAAO,CAAC,CAAC;IAC5C,MAAM,aAAa,GAAG,YAAY,CAAC,OAAO,CAAC,CAAC;IAE5C,IAAI,CAAC,aAAa,IAAI,CAAC,aAAa,EAAE,CAAC;QACrC,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IAAI,aAAa,CAAC,KAAK,KAAK,CAAC,EAAE,CAAC;QAC9B,OAAO,aAAa,CAAC,KAAK,GAAG,CAAC,IAAI,aAAa,CAAC,KAAK,GAAG,aAAa,CAAC,KAAK,CAAC;IAC9E,CAAC;IAED,OAAO,aAAa,CAAC,KAAK,GAAG,aAAa,CAAC,KAAK,CAAC;AACnD,CAAC;AAEY,QAAA,GAAG,GAAkB;IAChC,MAAM;IACN,QAAQ;IACR,QAAQ;IACR,QAAQ;IACR,UAAU;IACV,YAAY;IACZ,aAAa;IACb,eAAe;IACf,eAAe;IACf,QAAQ;IACR,OAAO;IACP,SAAS;IACT,OAAO;IACP,oBAAoB;IACpB,oBAAoB;IACpB,WAAW;IACX,YAAY;CACb,CAAC;AAEF,kBAAe,WAAG,CAAC","sourcesContent":["import is from '@sindresorhus/is';\nimport type { SemVer } from 'semver';\nimport semver from 'semver';\nimport { regEx } from '../../../util/regex';\nimport type { NewValueConfig, VersioningApi } from '../types';\n\nexport const id = 'semver-partial';\nexport const displayName = 'Partial Semantic Versioning';\nexport const urls = [\n  'https://docs.gitlab.com/ci/components/#partial-semantic-versions',\n];\nexport const supportsRanges = true;\nexport const supportedRangeStrategies = ['pin', 'replace'];\n\nfunction isLatest(input: string): boolean {\n  return input === '~latest';\n}\n\nfunction massageValue(input: string): string {\n  return input.trim().replace(regEx(/^v/i), '');\n}\n\nfunction parseVersion(input: string): SemVer | null {\n  return semver.parse(massageValue(input));\n}\n\ninterface Range {\n  major: number;\n  minor?: number;\n}\n\nfunction parseRange(input: string): Range | null {\n  const stripped = massageValue(input);\n  const coerced = semver.coerce(stripped);\n  if (!coerced) {\n    return null;\n  }\n  const { major, minor } = coerced;\n\n  if (regEx(/^\\d+$/).test(stripped)) {\n    return { major };\n  }\n\n  return { major, minor };\n}\n\nfunction isValid(input: string): boolean {\n  return isLatest(input) || !!parseVersion(input) || !!parseRange(input);\n}\n\nfunction isVersion(input: string | undefined | null): boolean {\n  if (!input) {\n    return false;\n  }\n\n  return !!parseVersion(input);\n}\n\nfunction isStable(version: string): boolean {\n  const v = parseVersion(version);\n  if (!v) {\n    return false;\n  }\n\n  return v.prerelease.length === 0;\n}\n\nfunction isSingleVersion(input: string): boolean {\n  return isVersion(input);\n}\n\nfunction getMajor(version: string): number | null {\n  return parseVersion(version)?.major ?? null;\n}\n\nfunction getMinor(version: string): number | null {\n  return parseVersion(version)?.minor ?? null;\n}\n\nfunction getPatch(version: string): number | null {\n  return parseVersion(version)?.patch ?? null;\n}\n\nfunction sortVersions(x: string, y: string): number {\n  const a = parseVersion(x);\n  const b = parseVersion(y);\n  if (!a || !b) {\n    return 0;\n  }\n  return semver.compare(a, b);\n}\n\nfunction equals(x: string, y: string): boolean {\n  const a = parseVersion(x);\n  const b = parseVersion(y);\n  if (!a || !b) {\n    return false;\n  }\n  return semver.eq(a, b);\n}\n\nfunction isGreaterThan(x: string, y: string): boolean {\n  const a = parseVersion(x);\n  const b = parseVersion(y);\n  if (!a || !b) {\n    return false;\n  }\n  return semver.gt(a, b);\n}\n\nfunction matches(version: string, range: string): boolean {\n  const v = parseVersion(version);\n  if (!v) {\n    return false;\n  }\n\n  if (isLatest(range)) {\n    return true;\n  }\n\n  const rv = parseVersion(range);\n  if (rv) {\n    return semver.eq(v, rv);\n  }\n\n  const r = parseRange(range);\n  if (!r) {\n    return false;\n  }\n\n  if (v.prerelease.length > 0) {\n    return false;\n  }\n\n  if (v.major !== r.major) {\n    return false;\n  }\n\n  if (is.undefined(r.minor)) {\n    return true;\n  }\n\n  return v.minor === r.minor;\n}\n\nfunction getSatisfyingVersion(\n  versions: string[],\n  range: string,\n): string | null {\n  const sortedVersions = versions.sort(sortVersions).reverse();\n  for (const version of sortedVersions) {\n    if (matches(version, range)) {\n      return version;\n    }\n  }\n  return null;\n}\n\nfunction minSatisfyingVersion(\n  versions: string[],\n  range: string,\n): string | null {\n  const sortedVersions = versions.sort(sortVersions);\n  for (const version of sortedVersions) {\n    if (matches(version, range)) {\n      return version;\n    }\n  }\n  return null;\n}\n\nfunction isLessThanRange(version: string, range: string): boolean {\n  const v = parseVersion(version);\n  const r = parseRange(range);\n\n  if (!v || !r) {\n    return false;\n  }\n\n  if (v.major !== r.major) {\n    return v.major < r.major;\n  }\n\n  if (is.undefined(r.minor)) {\n    return false;\n  }\n\n  if (v.minor !== r.minor) {\n    return v.minor < r.minor;\n  }\n\n  return false;\n}\n\nfunction getNewValue({\n  currentValue,\n  rangeStrategy,\n  currentVersion,\n  newVersion,\n}: NewValueConfig): string | null {\n  if (rangeStrategy === 'pin') {\n    return newVersion;\n  }\n\n  if (isLatest(currentValue)) {\n    return currentValue;\n  }\n\n  const range = parseRange(currentValue);\n  if (!range) {\n    return newVersion;\n  }\n\n  const newParsed = parseVersion(newVersion);\n  if (!newParsed) {\n    return newVersion;\n  }\n\n  // Check if currentValue is a full version (has patch component)\n  const currentParsed = parseVersion(currentValue);\n  if (currentParsed) {\n    // currentValue is a full version, return full newVersion\n    return newVersion;\n  }\n\n  const [prefix] = currentValue.split(massageValue(currentValue));\n\n  if (is.undefined(range.minor)) {\n    return `${prefix}${newParsed.major}`;\n  }\n\n  return `${prefix}${newParsed.major}.${newParsed.minor}`;\n}\n\nfunction isCompatible(version: string): boolean {\n  return isValid(version);\n}\n\nfunction isBreaking(version: string, current: string): boolean {\n  const versionParsed = parseVersion(version);\n  const currentParsed = parseVersion(current);\n\n  if (!versionParsed || !currentParsed) {\n    return false;\n  }\n\n  if (currentParsed.major === 0) {\n    return versionParsed.major > 0 || versionParsed.minor > currentParsed.minor;\n  }\n\n  return versionParsed.major > currentParsed.major;\n}\n\nexport const api: VersioningApi = {\n  equals,\n  getMajor,\n  getMinor,\n  getPatch,\n  isBreaking,\n  isCompatible,\n  isGreaterThan,\n  isLessThanRange,\n  isSingleVersion,\n  isStable,\n  isValid,\n  isVersion,\n  matches,\n  getSatisfyingVersion,\n  minSatisfyingVersion,\n  getNewValue,\n  sortVersions,\n};\n\nexport default api;\n"]}

package/dist/modules/versioning/swift/index.js

@@ -13,7 +13,6 @@ exports.supportsRanges = true;
 exports.supportedRangeStrategies = [
     'bump',
     'widen',
-    'pin',
     'replace',
 ];
 const { is: isStable } = semver_stable_1.default;

package/dist/modules/versioning/swift/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../lib/modules/versioning/swift/index.ts"],"names":[],"mappings":";;;;AAAA,4DAA4B;AAC5B,0EAAmC;AAEnC,+CAA4C;AAE5C,mCAAqD;AAExC,QAAA,EAAE,GAAG,OAAO,CAAC;AACb,QAAA,WAAW,GAAG,OAAO,CAAC;AACtB,QAAA,IAAI,GAAG,CAAC,oCAAoC,CAAC,CAAC;AAC9C,QAAA,cAAc,GAAG,IAAI,CAAC;AACtB,QAAA,wBAAwB,GAAoB;IACvD,MAAM;IACN,OAAO;IACP,KAAK;IACL,SAAS;CACV,CAAC;AAEF,MAAM,EAAE,EAAE,EAAE,QAAQ,EAAE,GAAG,uBAAM,CAAC;AAEhC,MAAM,EACJ,OAAO,EAAE,YAAY,EACrB,aAAa,EACb,aAAa,EACb,KAAK,EAAE,QAAQ,EACf,KAAK,EAAE,QAAQ,EACf,KAAK,EAAE,QAAQ,EACf,SAAS,EACT,KAAK,EACL,UAAU,EACV,GAAG,EACH,EAAE,EAAE,aAAa,EACjB,EAAE,EAAE,MAAM,GACX,GAAG,gBAAM,CAAC;AAEJ,MAAM,OAAO,GAAG,CAAC,KAAa,EAAW,EAAE,CAChD,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,UAAU,CAAC,IAAA,qBAAa,EAAC,KAAK,CAAC,CAAC,CAAC;AAD1C,QAAA,OAAO,WACmC;AAEhD,MAAM,SAAS,GAAG,CAAC,KAAa,EAAW,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;AAAvD,QAAA,SAAS,aAA8C;AAEpE,SAAS,oBAAoB,CAC3B,QAAkB,EAClB,KAAa;IAEb,MAAM,kBAAkB,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,IAAA,aAAK,EAAC,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;IAC3E,MAAM,WAAW,GAAG,IAAA,qBAAa,EAAC,KAAK,CAAC,CAAC;IACzC,OAAO,WAAW,CAAC,CAAC,CAAC,aAAa,CAAC,kBAAkB,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;AAC7E,CAAC;AAED,SAAS,oBAAoB,CAC3B,QAAkB,EAClB,KAAa;IAEb,MAAM,kBAAkB,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,IAAA,aAAK,EAAC,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;IAC3E,MAAM,WAAW,GAAG,IAAA,qBAAa,EAAC,KAAK,CAAC,CAAC;IACzC,OAAO,WAAW,CAAC,CAAC,CAAC,aAAa,CAAC,kBAAkB,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;AAC7E,CAAC;AAED,SAAS,eAAe,CAAC,OAAe,EAAE,KAAa;IACrD,MAAM,WAAW,GAAG,IAAA,qBAAa,EAAC,KAAK,CAAC,CAAC;IACzC,OAAO,WAAW,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;AACzD,CAAC;AAED,SAAS,OAAO,CAAC,OAAe,EAAE,KAAa;IAC7C,qCAAqC;IACrC,IAAI,IAAA,iBAAS,EAAC,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC,EAAE,CAAC;QAC/C,OAAO,IAAI,CAAC;IACd,CAAC;IACD,MAAM,WAAW,GAAG,IAAA,qBAAa,EAAC,KAAK,CAAC,CAAC;IACzC,OAAO,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;AAC/D,CAAC;AAEY,QAAA,GAAG,GAAkB;IAChC,MAAM;IACN,QAAQ;IACR,QAAQ;IACR,WAAW,EAAX,mBAAW;IACX,QAAQ;IACR,YAAY,EAAE,iBAAS;IACvB,aAAa;IACb,eAAe;IACf,eAAe,EAAE,iBAAS;IAC1B,QAAQ;IACR,OAAO,EAAP,eAAO;IACP,SAAS,EAAT,iBAAS;IACT,OAAO;IACP,oBAAoB;IACpB,oBAAoB;IACpB,YAAY;CACb,CAAC;AAEF,kBAAe,WAAG,CAAC","sourcesContent":["import semver from 'semver';\nimport stable from 'semver-stable';\nimport type { RangeStrategy } from '../../../types/versioning';\nimport { regEx } from '../../../util/regex';\nimport type { VersioningApi } from '../types';\nimport { getNewValue, toSemverRange } from './range';\n\nexport const id = 'swift';\nexport const displayName = 'Swift';\nexport const urls = ['https://swift.org/package-manager/'];\nexport const supportsRanges = true;\nexport const supportedRangeStrategies: RangeStrategy[] = [\n  'bump',\n  'widen',\n  'pin',\n  'replace',\n];\n\nconst { is: isStable } = stable;\n\nconst {\n  compare: sortVersions,\n  maxSatisfying,\n  minSatisfying,\n  major: getMajor,\n  minor: getMinor,\n  patch: getPatch,\n  satisfies,\n  valid,\n  validRange,\n  ltr,\n  gt: isGreaterThan,\n  eq: equals,\n} = semver;\n\nexport const isValid = (input: string): boolean =>\n  !!valid(input) || !!validRange(toSemverRange(input));\n\nexport const isVersion = (input: string): boolean => !!valid(input);\n\nfunction getSatisfyingVersion(\n  versions: string[],\n  range: string,\n): string | null {\n  const normalizedVersions = versions.map((v) => v.replace(regEx(/^v/), ''));\n  const semverRange = toSemverRange(range);\n  return semverRange ? maxSatisfying(normalizedVersions, semverRange) : null;\n}\n\nfunction minSatisfyingVersion(\n  versions: string[],\n  range: string,\n): string | null {\n  const normalizedVersions = versions.map((v) => v.replace(regEx(/^v/), ''));\n  const semverRange = toSemverRange(range);\n  return semverRange ? minSatisfying(normalizedVersions, semverRange) : null;\n}\n\nfunction isLessThanRange(version: string, range: string): boolean {\n  const semverRange = toSemverRange(range);\n  return semverRange ? ltr(version, semverRange) : false;\n}\n\nfunction matches(version: string, range: string): boolean {\n  // Check if both are an exact version\n  if (isVersion(range) && equals(version, range)) {\n    return true;\n  }\n  const semverRange = toSemverRange(range);\n  return semverRange ? satisfies(version, semverRange) : false;\n}\n\nexport const api: VersioningApi = {\n  equals,\n  getMajor,\n  getMinor,\n  getNewValue,\n  getPatch,\n  isCompatible: isVersion,\n  isGreaterThan,\n  isLessThanRange,\n  isSingleVersion: isVersion,\n  isStable,\n  isValid,\n  isVersion,\n  matches,\n  getSatisfyingVersion,\n  minSatisfyingVersion,\n  sortVersions,\n};\n\nexport default api;\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../lib/modules/versioning/swift/index.ts"],"names":[],"mappings":";;;;AAAA,4DAA4B;AAC5B,0EAAmC;AAEnC,+CAA4C;AAE5C,mCAAqD;AAExC,QAAA,EAAE,GAAG,OAAO,CAAC;AACb,QAAA,WAAW,GAAG,OAAO,CAAC;AACtB,QAAA,IAAI,GAAG,CAAC,oCAAoC,CAAC,CAAC;AAC9C,QAAA,cAAc,GAAG,IAAI,CAAC;AACtB,QAAA,wBAAwB,GAAoB;IACvD,MAAM;IACN,OAAO;IACP,SAAS;CACV,CAAC;AAEF,MAAM,EAAE,EAAE,EAAE,QAAQ,EAAE,GAAG,uBAAM,CAAC;AAEhC,MAAM,EACJ,OAAO,EAAE,YAAY,EACrB,aAAa,EACb,aAAa,EACb,KAAK,EAAE,QAAQ,EACf,KAAK,EAAE,QAAQ,EACf,KAAK,EAAE,QAAQ,EACf,SAAS,EACT,KAAK,EACL,UAAU,EACV,GAAG,EACH,EAAE,EAAE,aAAa,EACjB,EAAE,EAAE,MAAM,GACX,GAAG,gBAAM,CAAC;AAEJ,MAAM,OAAO,GAAG,CAAC,KAAa,EAAW,EAAE,CAChD,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,UAAU,CAAC,IAAA,qBAAa,EAAC,KAAK,CAAC,CAAC,CAAC;AAD1C,QAAA,OAAO,WACmC;AAEhD,MAAM,SAAS,GAAG,CAAC,KAAa,EAAW,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;AAAvD,QAAA,SAAS,aAA8C;AAEpE,SAAS,oBAAoB,CAC3B,QAAkB,EAClB,KAAa;IAEb,MAAM,kBAAkB,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,IAAA,aAAK,EAAC,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;IAC3E,MAAM,WAAW,GAAG,IAAA,qBAAa,EAAC,KAAK,CAAC,CAAC;IACzC,OAAO,WAAW,CAAC,CAAC,CAAC,aAAa,CAAC,kBAAkB,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;AAC7E,CAAC;AAED,SAAS,oBAAoB,CAC3B,QAAkB,EAClB,KAAa;IAEb,MAAM,kBAAkB,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,IAAA,aAAK,EAAC,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;IAC3E,MAAM,WAAW,GAAG,IAAA,qBAAa,EAAC,KAAK,CAAC,CAAC;IACzC,OAAO,WAAW,CAAC,CAAC,CAAC,aAAa,CAAC,kBAAkB,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;AAC7E,CAAC;AAED,SAAS,eAAe,CAAC,OAAe,EAAE,KAAa;IACrD,MAAM,WAAW,GAAG,IAAA,qBAAa,EAAC,KAAK,CAAC,CAAC;IACzC,OAAO,WAAW,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;AACzD,CAAC;AAED,SAAS,OAAO,CAAC,OAAe,EAAE,KAAa;IAC7C,qCAAqC;IACrC,IAAI,IAAA,iBAAS,EAAC,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC,EAAE,CAAC;QAC/C,OAAO,IAAI,CAAC;IACd,CAAC;IACD,MAAM,WAAW,GAAG,IAAA,qBAAa,EAAC,KAAK,CAAC,CAAC;IACzC,OAAO,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;AAC/D,CAAC;AAEY,QAAA,GAAG,GAAkB;IAChC,MAAM;IACN,QAAQ;IACR,QAAQ;IACR,WAAW,EAAX,mBAAW;IACX,QAAQ;IACR,YAAY,EAAE,iBAAS;IACvB,aAAa;IACb,eAAe;IACf,eAAe,EAAE,iBAAS;IAC1B,QAAQ;IACR,OAAO,EAAP,eAAO;IACP,SAAS,EAAT,iBAAS;IACT,OAAO;IACP,oBAAoB;IACpB,oBAAoB;IACpB,YAAY;CACb,CAAC;AAEF,kBAAe,WAAG,CAAC","sourcesContent":["import semver from 'semver';\nimport stable from 'semver-stable';\nimport type { RangeStrategy } from '../../../types/versioning';\nimport { regEx } from '../../../util/regex';\nimport type { VersioningApi } from '../types';\nimport { getNewValue, toSemverRange } from './range';\n\nexport const id = 'swift';\nexport const displayName = 'Swift';\nexport const urls = ['https://swift.org/package-manager/'];\nexport const supportsRanges = true;\nexport const supportedRangeStrategies: RangeStrategy[] = [\n  'bump',\n  'widen',\n  'replace',\n];\n\nconst { is: isStable } = stable;\n\nconst {\n  compare: sortVersions,\n  maxSatisfying,\n  minSatisfying,\n  major: getMajor,\n  minor: getMinor,\n  patch: getPatch,\n  satisfies,\n  valid,\n  validRange,\n  ltr,\n  gt: isGreaterThan,\n  eq: equals,\n} = semver;\n\nexport const isValid = (input: string): boolean =>\n  !!valid(input) || !!validRange(toSemverRange(input));\n\nexport const isVersion = (input: string): boolean => !!valid(input);\n\nfunction getSatisfyingVersion(\n  versions: string[],\n  range: string,\n): string | null {\n  const normalizedVersions = versions.map((v) => v.replace(regEx(/^v/), ''));\n  const semverRange = toSemverRange(range);\n  return semverRange ? maxSatisfying(normalizedVersions, semverRange) : null;\n}\n\nfunction minSatisfyingVersion(\n  versions: string[],\n  range: string,\n): string | null {\n  const normalizedVersions = versions.map((v) => v.replace(regEx(/^v/), ''));\n  const semverRange = toSemverRange(range);\n  return semverRange ? minSatisfying(normalizedVersions, semverRange) : null;\n}\n\nfunction isLessThanRange(version: string, range: string): boolean {\n  const semverRange = toSemverRange(range);\n  return semverRange ? ltr(version, semverRange) : false;\n}\n\nfunction matches(version: string, range: string): boolean {\n  // Check if both are an exact version\n  if (isVersion(range) && equals(version, range)) {\n    return true;\n  }\n  const semverRange = toSemverRange(range);\n  return semverRange ? satisfies(version, semverRange) : false;\n}\n\nexport const api: VersioningApi = {\n  equals,\n  getMajor,\n  getMinor,\n  getNewValue,\n  getPatch,\n  isCompatible: isVersion,\n  isGreaterThan,\n  isLessThanRange,\n  isSingleVersion: isVersion,\n  isStable,\n  isValid,\n  isVersion,\n  matches,\n  getSatisfyingVersion,\n  minSatisfyingVersion,\n  sortVersions,\n};\n\nexport default api;\n"]}

package/dist/modules/versioning/types.d.ts

@@ -85,6 +85,11 @@ export interface VersioningApi {
      * `rangeStrategy` option, and the current and new version.
      */
     getNewValue(newValueConfig: NewValueConfig): string | null;
+    /**
+     * Convert the `newVersion` to a pinned value.
+     * @param newVersion
+     */
+    getPinnedValue?(newVersion: string): string;
     /**
      * Compare two versions. Return `0` if `v1 == v2`, or `1` if `v1` is
      * greater, or `-1` if `v2` is greater.

package/dist/modules/versioning/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../lib/modules/versioning/types.ts"],"names":[],"mappings":"","sourcesContent":["import type { SemVer } from 'semver';\nimport type { RangeStrategy } from '../../types';\n\nexport interface NewValueConfig {\n  currentValue: string;\n  rangeStrategy: RangeStrategy;\n  currentVersion?: string;\n  newVersion: string;\n  isReplacement?: boolean;\n}\nexport interface VersioningApi {\n  // validation\n\n  /**\n   * Check whether the `input` is the valid version or range.\n   *\n   * For some managers, ranges are called \"constraints\",\"specifiers\", \"requirements\", etc.\n   * We stick to the term \"range\" for all of it.\n   */\n  isValid(input: string): boolean;\n\n  /**\n   * Check whether the `input` is a valid version.\n   *\n   * There is no direct way to determine whether the `input` is the range,\n   * but combination of `isVersion` and `isValid` can be used for that:\n   *\n   *    `isValid(input) && !isVersion(input)`\n   */\n  isVersion(input: string | undefined | null): boolean;\n\n  /**\n   * Check whether the `input` is the:\n   *\n   *   1. Version, or\n   *   2. Range with the special syntax of matching exactly one version:\n   *      - `==1.2.3` or `===1.2.3` for Python,\n   *      - `=1.2.3` for NPM,\n   *      - `[1.2.3]` for Maven or NuGet.\n   *\n   * This is used to provide pinning functionality.\n   */\n  isSingleVersion(input: string): boolean;\n\n  /**\n   * Check whether the `version` is considered to be \"stable\".\n   */\n  isStable(version: string): boolean;\n\n  /**\n   * Determines whether the version is compatible with the current one,\n   * in some manager-dependent way.\n   *\n   * For most managers, all valid versions are compatible between each other.\n   *\n   * However, for example, Docker versions `1.2.3` and `1.2.4-alpine` are not compatible,\n   * i.e. `1.2.4-alpine` is not a valid upgrade for `1.2.3`.\n   */\n  isCompatible(version: string, current?: string): boolean;\n\n  isBreaking?(current: string, version: string): boolean;\n\n  // digestion of version\n\n  getMajor(version: string | SemVer): null | number;\n  getMinor(version: string | SemVer): null | number;\n  getPatch(version: string | SemVer): null | number;\n\n  // comparison\n\n  /**\n   * Check whether `version` and `other` are logically equivalent, even if\n   * they're not the exact same string.\n   *\n   * For example, with Semver the build metadata should be ignored when comparing.\n   */\n  equals(version: string, other: string): boolean;\n\n  /**\n   * Check whether `version` is \"greater\" than the `other` version.\n   */\n  isGreaterThan(version: string, other: string): boolean;\n\n  /**\n   * Check whether the `version` is \"less\" than all the versions possible in\n   * the `range`.\n   */\n  isLessThanRange?(version: string, range: string): boolean;\n\n  /**\n   * Select the highest version from `versions` that is within the given\n   * `range` constraint, or return `null` if there is no matching version.\n   */\n  getSatisfyingVersion(versions: string[], range: string): string | null;\n\n  /**\n   * Select the lowest version from `versions` that is within the given\n   * `range` constraint, or return `null` if there is no matching version.\n   */\n  minSatisfyingVersion(versions: string[], range: string): string | null;\n\n  /**\n   * Calculate a new version constraint based on the current constraint, the\n   * `rangeStrategy` option, and the current and new version.\n   */\n  getNewValue(newValueConfig: NewValueConfig): string | null;\n\n  /**\n   * Compare two versions. Return `0` if `v1 == v2`, or `1` if `v1` is\n   * greater, or `-1` if `v2` is greater.\n   */\n  sortVersions(version: string, other: string): number;\n\n  /**\n   * Check whether the `version` satisfies the `range` constraint.\n   */\n  matches(version: string, range: string): boolean;\n\n  valueToVersion?(version: string): string;\n\n  /**\n   * @returns true if subRange is entirely contained by superRange, false otherwise,\n   * and undefined if it cannot determine it.\n   *\n   * @param subRange - the sub range\n   * @param superRange - the dom range\n   */\n  subset?(subRange: string, superRange: string): boolean | undefined;\n\n  /**\n   * Checks whether subRange intersects superRange.\n   */\n  intersects?(subRange: string, superRange: string): boolean;\n\n  /**\n   * Return whether unstable-to-unstable upgrades within the same major version are allowed.\n   */\n  allowUnstableMajorUpgrades?: boolean;\n\n  /**\n   * Check whether the `type` in the `a` and `b` version numbers match.\n   * Both `a` and `b` must pass `isVersion`.\n   */\n  isSame?(type: 'major' | 'minor' | 'patch', a: string, b: string): boolean;\n}\n\nexport type VersioningApiConstructor = new (config?: string) => VersioningApi;\n"]}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../lib/modules/versioning/types.ts"],"names":[],"mappings":"","sourcesContent":["import type { SemVer } from 'semver';\nimport type { RangeStrategy } from '../../types';\n\nexport interface NewValueConfig {\n  currentValue: string;\n  rangeStrategy: RangeStrategy;\n  currentVersion?: string;\n  newVersion: string;\n  isReplacement?: boolean;\n}\nexport interface VersioningApi {\n  // validation\n\n  /**\n   * Check whether the `input` is the valid version or range.\n   *\n   * For some managers, ranges are called \"constraints\",\"specifiers\", \"requirements\", etc.\n   * We stick to the term \"range\" for all of it.\n   */\n  isValid(input: string): boolean;\n\n  /**\n   * Check whether the `input` is a valid version.\n   *\n   * There is no direct way to determine whether the `input` is the range,\n   * but combination of `isVersion` and `isValid` can be used for that:\n   *\n   *    `isValid(input) && !isVersion(input)`\n   */\n  isVersion(input: string | undefined | null): boolean;\n\n  /**\n   * Check whether the `input` is the:\n   *\n   *   1. Version, or\n   *   2. Range with the special syntax of matching exactly one version:\n   *      - `==1.2.3` or `===1.2.3` for Python,\n   *      - `=1.2.3` for NPM,\n   *      - `[1.2.3]` for Maven or NuGet.\n   *\n   * This is used to provide pinning functionality.\n   */\n  isSingleVersion(input: string): boolean;\n\n  /**\n   * Check whether the `version` is considered to be \"stable\".\n   */\n  isStable(version: string): boolean;\n\n  /**\n   * Determines whether the version is compatible with the current one,\n   * in some manager-dependent way.\n   *\n   * For most managers, all valid versions are compatible between each other.\n   *\n   * However, for example, Docker versions `1.2.3` and `1.2.4-alpine` are not compatible,\n   * i.e. `1.2.4-alpine` is not a valid upgrade for `1.2.3`.\n   */\n  isCompatible(version: string, current?: string): boolean;\n\n  isBreaking?(current: string, version: string): boolean;\n\n  // digestion of version\n\n  getMajor(version: string | SemVer): null | number;\n  getMinor(version: string | SemVer): null | number;\n  getPatch(version: string | SemVer): null | number;\n\n  // comparison\n\n  /**\n   * Check whether `version` and `other` are logically equivalent, even if\n   * they're not the exact same string.\n   *\n   * For example, with Semver the build metadata should be ignored when comparing.\n   */\n  equals(version: string, other: string): boolean;\n\n  /**\n   * Check whether `version` is \"greater\" than the `other` version.\n   */\n  isGreaterThan(version: string, other: string): boolean;\n\n  /**\n   * Check whether the `version` is \"less\" than all the versions possible in\n   * the `range`.\n   */\n  isLessThanRange?(version: string, range: string): boolean;\n\n  /**\n   * Select the highest version from `versions` that is within the given\n   * `range` constraint, or return `null` if there is no matching version.\n   */\n  getSatisfyingVersion(versions: string[], range: string): string | null;\n\n  /**\n   * Select the lowest version from `versions` that is within the given\n   * `range` constraint, or return `null` if there is no matching version.\n   */\n  minSatisfyingVersion(versions: string[], range: string): string | null;\n\n  /**\n   * Calculate a new version constraint based on the current constraint, the\n   * `rangeStrategy` option, and the current and new version.\n   */\n  getNewValue(newValueConfig: NewValueConfig): string | null;\n\n  /**\n   * Convert the `newVersion` to a pinned value.\n   * @param newVersion\n   */\n  getPinnedValue?(newVersion: string): string;\n\n  /**\n   * Compare two versions. Return `0` if `v1 == v2`, or `1` if `v1` is\n   * greater, or `-1` if `v2` is greater.\n   */\n  sortVersions(version: string, other: string): number;\n\n  /**\n   * Check whether the `version` satisfies the `range` constraint.\n   */\n  matches(version: string, range: string): boolean;\n\n  valueToVersion?(version: string): string;\n\n  /**\n   * @returns true if subRange is entirely contained by superRange, false otherwise,\n   * and undefined if it cannot determine it.\n   *\n   * @param subRange - the sub range\n   * @param superRange - the dom range\n   */\n  subset?(subRange: string, superRange: string): boolean | undefined;\n\n  /**\n   * Checks whether subRange intersects superRange.\n   */\n  intersects?(subRange: string, superRange: string): boolean;\n\n  /**\n   * Return whether unstable-to-unstable upgrades within the same major version are allowed.\n   */\n  allowUnstableMajorUpgrades?: boolean;\n\n  /**\n   * Check whether the `type` in the `a` and `b` version numbers match.\n   * Both `a` and `b` must pass `isVersion`.\n   */\n  isSame?(type: 'major' | 'minor' | 'patch', a: string, b: string): boolean;\n}\n\nexport type VersioningApiConstructor = new (config?: string) => VersioningApi;\n"]}

package/dist/util/cache/package/decorator.js

@@ -43,21 +43,32 @@ function cache({ namespace, key, cacheable = () => true, ttlMinutes = 30, }) {
         const releaseLock = await (0, mutex_1.acquireLock)(finalKey, finalNamespace);
         try {
             const oldRecord = await packageCache.get(finalNamespace, finalKey);
-            const ttlValues = (0, ttl_1.resolveTtlValues)(finalNamespace, ttlMinutes);
-            const softTtl = ttlValues.softTtlMinutes;
-            const hardTtl = methodName === 'getReleases' || methodName === 'getDigest'
-                ? ttlValues.hardTtlMinutes
-                : // Skip two-tier TTL for any intermediate data fetching
-                    softTtl;
+            // eslint-disable-next-line prefer-const
+            let { softTtlMinutes, hardTtlMinutes } = (0, ttl_1.resolveTtlValues)(finalNamespace, ttlMinutes);
+            // The separation between "soft" and "hard" TTL allows us to treat
+            // data as obsolete according to the "soft" TTL while physically storing it
+            // according to the "hard" TTL.
+            //
+            // This helps us return obsolete data in case of upstream server errors,
+            // which is more useful than throwing exceptions ourselves.
+            //
+            // However, since the default hard TTL is one week, it could create
+            // unnecessary pressure on storage volume. Therefore,
+            // we cache only `getReleases` and `getDigest` results for an extended period.
+            //
+            // For other method names being decorated, the "soft" just equals the "hard" ttl.
+            if (methodName !== 'getReleases' && methodName !== 'getDigest') {
+                hardTtlMinutes = softTtlMinutes;
+            }
             let oldData;
             if (oldRecord) {
                 const now = luxon_1.DateTime.local();
                 const cachedAt = luxon_1.DateTime.fromISO(oldRecord.cachedAt);
-                const softDeadline = cachedAt.plus({ minutes: softTtl });
+                const softDeadline = cachedAt.plus({ minutes: softTtlMinutes });
                 if (now < softDeadline) {
                     return oldRecord.value;
                 }
-                const hardDeadline = cachedAt.plus({ minutes: hardTtl });
+                const hardDeadline = cachedAt.plus({ minutes: hardTtlMinutes });
                 if (now < hardDeadline) {
                     oldData = oldRecord.value;
                 }
@@ -80,7 +91,7 @@ function cache({ namespace, key, cacheable = () => true, ttlMinutes = 30, }) {
                     cachedAt: luxon_1.DateTime.local().toISO(),
                     value: newData,
                 };
-                await packageCache.setWithRawTtl(finalNamespace, finalKey, newRecord, hardTtl);
+                await packageCache.setWithRawTtl(finalNamespace, finalKey, newRecord, hardTtlMinutes);
             }
             return newData;
         }

package/dist/util/cache/package/decorator.js.map

@@ -1 +1 @@
-{"version":3,"file":"decorator.js","sourceRoot":"","sources":["../../../../lib/util/cache/package/decorator.ts"],"names":[],"mappings":";;AAgDA,sBAuGC;;AAvJD,kEAAkC;AAClC,iCAAiC;AACjC,mDAAsD;AACtD,4CAAyC;AAEzC,+CAA2C;AAC3C,uCAA0C;AAC1C,+BAAyC;AAEzC,wDAAkC;AAoClC;;GAEG;AACH,SAAgB,KAAK,CAAI,EACvB,SAAS,EACT,GAAG,EACH,SAAS,GAAG,GAAG,EAAE,CAAC,IAAI,EACtB,UAAU,GAAG,EAAE,GACC;IAChB,OAAO,IAAA,oBAAQ,EAAC,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,UAAU,EAAE,EAAE,EAAE;QACjE,MAAM,oBAAoB,GAAG,qBAAY,CAAC,GAAG,CAC3C,sBAAsB,EACtB,KAAK,CACN,CAAC;QACF,MAAM,WAAW,GAAG,oBAAoB,IAAI,SAAS,CAAC,KAAK,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QAC5E,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,OAAO,QAAQ,EAAE,CAAC;QACpB,CAAC;QAED,IAAI,cAAiD,CAAC;QACtD,IAAI,YAAE,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC;YACzB,cAAc,GAAG,SAAS,CAAC;QAC7B,CAAC;aAAM,IAAI,YAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;YAClC,cAAc,GAAG,SAAS,CAAC,KAAK,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QACnD,CAAC;QAED,IAAI,QAA4B,CAAC;QACjC,IAAI,YAAE,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC;YACnB,QAAQ,GAAG,GAAG,CAAC;QACjB,CAAC;aAAM,IAAI,YAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;YAC5B,QAAQ,GAAG,GAAG,CAAC,KAAK,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QACvC,CAAC;QAED,qBAAqB;QACrB,IAAI,CAAC,cAAc,IAAI,CAAC,QAAQ,EAAE,CAAC;YACjC,OAAO,QAAQ,EAAE,CAAC;QACpB,CAAC;QAED,QAAQ,GAAG,mBAAmB,QAAQ,EAAE,CAAC;QAEzC,iDAAiD;QACjD,MAAM,WAAW,GAAG,MAAM,IAAA,mBAAW,EAAC,QAAQ,EAAE,cAAc,CAAC,CAAC;QAEhE,IAAI,CAAC;YACH,MAAM,SAAS,GAAG,MAAM,YAAY,CAAC,GAAG,CACtC,cAAc,EACd,QAAQ,CACT,CAAC;YAEF,MAAM,SAAS,GAAG,IAAA,sBAAgB,EAAC,cAAc,EAAE,UAAU,CAAC,CAAC;YAC/D,MAAM,OAAO,GAAG,SAAS,CAAC,cAAc,CAAC;YACzC,MAAM,OAAO,GACX,UAAU,KAAK,aAAa,IAAI,UAAU,KAAK,WAAW;gBACxD,CAAC,CAAC,SAAS,CAAC,cAAc;gBAC1B,CAAC,CAAC,uDAAuD;oBACvD,OAAO,CAAC;YAEd,IAAI,OAAgB,CAAC;YACrB,IAAI,SAAS,EAAE,CAAC;gBACd,MAAM,GAAG,GAAG,gBAAQ,CAAC,KAAK,EAAE,CAAC;gBAC7B,MAAM,QAAQ,GAAG,gBAAQ,CAAC,OAAO,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;gBAEtD,MAAM,YAAY,GAAG,QAAQ,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;gBACzD,IAAI,GAAG,GAAG,YAAY,EAAE,CAAC;oBACvB,OAAO,SAAS,CAAC,KAAK,CAAC;gBACzB,CAAC;gBAED,MAAM,YAAY,GAAG,QAAQ,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;gBACzD,IAAI,GAAG,GAAG,YAAY,EAAE,CAAC;oBACvB,OAAO,GAAG,SAAS,CAAC,KAAK,CAAC;gBAC5B,CAAC;YACH,CAAC;YAED,IAAI,OAAgB,CAAC;YACrB,IAAI,OAAO,EAAE,CAAC;gBACZ,IAAI,CAAC;oBACH,OAAO,GAAG,MAAM,QAAQ,EAAE,CAAC;gBAC7B,CAAC;gBAAC,OAAO,GAAG,EAAE,CAAC;oBACb,eAAM,CAAC,KAAK,CACV,EAAE,GAAG,EAAE,EACP,6DAA6D,CAC9D,CAAC;oBACF,OAAO,OAAO,CAAC;gBACjB,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,OAAO,GAAG,MAAM,QAAQ,EAAE,CAAC;YAC7B,CAAC;YAED,IAAI,CAAC,YAAE,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC;gBAC3B,MAAM,SAAS,GAA0B;oBACvC,QAAQ,EAAE,gBAAQ,CAAC,KAAK,EAAE,CAAC,KAAK,EAAE;oBAClC,KAAK,EAAE,OAAO;iBACf,CAAC;gBACF,MAAM,YAAY,CAAC,aAAa,CAC9B,cAAc,EACd,QAAQ,EACR,SAAS,EACT,OAAO,CACR,CAAC;YACJ,CAAC;YAED,OAAO,OAAO,CAAC;QACjB,CAAC;gBAAS,CAAC;YACT,WAAW,EAAE,CAAC;QAChB,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC","sourcesContent":["import is from '@sindresorhus/is';\nimport { DateTime } from 'luxon';\nimport { GlobalConfig } from '../../../config/global';\nimport { logger } from '../../../logger';\nimport type { Decorator } from '../../decorator';\nimport { decorate } from '../../decorator';\nimport { acquireLock } from '../../mutex';\nimport { resolveTtlValues } from './ttl';\nimport type { DecoratorCachedRecord, PackageCacheNamespace } from './types';\nimport * as packageCache from '.';\n\ntype HashFunction<T extends any[] = any[]> = (...args: T) => string;\ntype NamespaceFunction<T extends any[] = any[]> = (\n  ...args: T\n) => PackageCacheNamespace;\ntype BooleanFunction<T extends any[] = any[]> = (...args: T) => boolean;\n\n/**\n * The cache decorator parameters.\n */\ninterface CacheParameters {\n  /**\n   * The cache namespace\n   * Either a string or a hash function that generates a string\n   */\n  namespace: PackageCacheNamespace | NamespaceFunction;\n\n  /**\n   * The cache key\n   * Either a string or a hash function that generates a string\n   */\n  key: string | HashFunction;\n\n  /**\n   * A function that returns true if a result is cacheable\n   * Used to prevent caching of private, sensitive, results\n   */\n  cacheable?: BooleanFunction;\n\n  /**\n   * The TTL (or expiry) of the key in minutes\n   */\n  ttlMinutes?: number;\n}\n\n/**\n * caches the result of a decorated method.\n */\nexport function cache<T>({\n  namespace,\n  key,\n  cacheable = () => true,\n  ttlMinutes = 30,\n}: CacheParameters): Decorator<T> {\n  return decorate(async ({ args, instance, callback, methodName }) => {\n    const cachePrivatePackages = GlobalConfig.get(\n      'cachePrivatePackages',\n      false,\n    );\n    const isCacheable = cachePrivatePackages || cacheable.apply(instance, args);\n    if (!isCacheable) {\n      return callback();\n    }\n\n    let finalNamespace: PackageCacheNamespace | undefined;\n    if (is.string(namespace)) {\n      finalNamespace = namespace;\n    } else if (is.function(namespace)) {\n      finalNamespace = namespace.apply(instance, args);\n    }\n\n    let finalKey: string | undefined;\n    if (is.string(key)) {\n      finalKey = key;\n    } else if (is.function(key)) {\n      finalKey = key.apply(instance, args);\n    }\n\n    // istanbul ignore if\n    if (!finalNamespace || !finalKey) {\n      return callback();\n    }\n\n    finalKey = `cache-decorator:${finalKey}`;\n\n    // prevent concurrent processing and cache writes\n    const releaseLock = await acquireLock(finalKey, finalNamespace);\n\n    try {\n      const oldRecord = await packageCache.get<DecoratorCachedRecord>(\n        finalNamespace,\n        finalKey,\n      );\n\n      const ttlValues = resolveTtlValues(finalNamespace, ttlMinutes);\n      const softTtl = ttlValues.softTtlMinutes;\n      const hardTtl =\n        methodName === 'getReleases' || methodName === 'getDigest'\n          ? ttlValues.hardTtlMinutes\n          : // Skip two-tier TTL for any intermediate data fetching\n            softTtl;\n\n      let oldData: unknown;\n      if (oldRecord) {\n        const now = DateTime.local();\n        const cachedAt = DateTime.fromISO(oldRecord.cachedAt);\n\n        const softDeadline = cachedAt.plus({ minutes: softTtl });\n        if (now < softDeadline) {\n          return oldRecord.value;\n        }\n\n        const hardDeadline = cachedAt.plus({ minutes: hardTtl });\n        if (now < hardDeadline) {\n          oldData = oldRecord.value;\n        }\n      }\n\n      let newData: unknown;\n      if (oldData) {\n        try {\n          newData = await callback();\n        } catch (err) {\n          logger.debug(\n            { err },\n            'Package cache decorator: callback error, returning old data',\n          );\n          return oldData;\n        }\n      } else {\n        newData = await callback();\n      }\n\n      if (!is.undefined(newData)) {\n        const newRecord: DecoratorCachedRecord = {\n          cachedAt: DateTime.local().toISO(),\n          value: newData,\n        };\n        await packageCache.setWithRawTtl(\n          finalNamespace,\n          finalKey,\n          newRecord,\n          hardTtl,\n        );\n      }\n\n      return newData;\n    } finally {\n      releaseLock();\n    }\n  });\n}\n"]}
+{"version":3,"file":"decorator.js","sourceRoot":"","sources":["../../../../lib/util/cache/package/decorator.ts"],"names":[],"mappings":";;AAgDA,sBAqHC;;AArKD,kEAAkC;AAClC,iCAAiC;AACjC,mDAAsD;AACtD,4CAAyC;AAEzC,+CAA2C;AAC3C,uCAA0C;AAC1C,+BAAyC;AAEzC,wDAAkC;AAoClC;;GAEG;AACH,SAAgB,KAAK,CAAI,EACvB,SAAS,EACT,GAAG,EACH,SAAS,GAAG,GAAG,EAAE,CAAC,IAAI,EACtB,UAAU,GAAG,EAAE,GACC;IAChB,OAAO,IAAA,oBAAQ,EAAC,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,UAAU,EAAE,EAAE,EAAE;QACjE,MAAM,oBAAoB,GAAG,qBAAY,CAAC,GAAG,CAC3C,sBAAsB,EACtB,KAAK,CACN,CAAC;QACF,MAAM,WAAW,GAAG,oBAAoB,IAAI,SAAS,CAAC,KAAK,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QAC5E,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,OAAO,QAAQ,EAAE,CAAC;QACpB,CAAC;QAED,IAAI,cAAiD,CAAC;QACtD,IAAI,YAAE,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC;YACzB,cAAc,GAAG,SAAS,CAAC;QAC7B,CAAC;aAAM,IAAI,YAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;YAClC,cAAc,GAAG,SAAS,CAAC,KAAK,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QACnD,CAAC;QAED,IAAI,QAA4B,CAAC;QACjC,IAAI,YAAE,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC;YACnB,QAAQ,GAAG,GAAG,CAAC;QACjB,CAAC;aAAM,IAAI,YAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;YAC5B,QAAQ,GAAG,GAAG,CAAC,KAAK,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QACvC,CAAC;QAED,qBAAqB;QACrB,IAAI,CAAC,cAAc,IAAI,CAAC,QAAQ,EAAE,CAAC;YACjC,OAAO,QAAQ,EAAE,CAAC;QACpB,CAAC;QAED,QAAQ,GAAG,mBAAmB,QAAQ,EAAE,CAAC;QAEzC,iDAAiD;QACjD,MAAM,WAAW,GAAG,MAAM,IAAA,mBAAW,EAAC,QAAQ,EAAE,cAAc,CAAC,CAAC;QAEhE,IAAI,CAAC;YACH,MAAM,SAAS,GAAG,MAAM,YAAY,CAAC,GAAG,CACtC,cAAc,EACd,QAAQ,CACT,CAAC;YAEF,wCAAwC;YACxC,IAAI,EAAE,cAAc,EAAE,cAAc,EAAE,GAAG,IAAA,sBAAgB,EACvD,cAAc,EACd,UAAU,CACX,CAAC;YAEF,kEAAkE;YAClE,2EAA2E;YAC3E,+BAA+B;YAC/B,EAAE;YACF,wEAAwE;YACxE,2DAA2D;YAC3D,EAAE;YACF,mEAAmE;YACnE,qDAAqD;YACrD,8EAA8E;YAC9E,EAAE;YACF,iFAAiF;YACjF,IAAI,UAAU,KAAK,aAAa,IAAI,UAAU,KAAK,WAAW,EAAE,CAAC;gBAC/D,cAAc,GAAG,cAAc,CAAC;YAClC,CAAC;YAED,IAAI,OAAgB,CAAC;YACrB,IAAI,SAAS,EAAE,CAAC;gBACd,MAAM,GAAG,GAAG,gBAAQ,CAAC,KAAK,EAAE,CAAC;gBAC7B,MAAM,QAAQ,GAAG,gBAAQ,CAAC,OAAO,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;gBAEtD,MAAM,YAAY,GAAG,QAAQ,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,cAAc,EAAE,CAAC,CAAC;gBAChE,IAAI,GAAG,GAAG,YAAY,EAAE,CAAC;oBACvB,OAAO,SAAS,CAAC,KAAK,CAAC;gBACzB,CAAC;gBAED,MAAM,YAAY,GAAG,QAAQ,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,cAAc,EAAE,CAAC,CAAC;gBAChE,IAAI,GAAG,GAAG,YAAY,EAAE,CAAC;oBACvB,OAAO,GAAG,SAAS,CAAC,KAAK,CAAC;gBAC5B,CAAC;YACH,CAAC;YAED,IAAI,OAAgB,CAAC;YACrB,IAAI,OAAO,EAAE,CAAC;gBACZ,IAAI,CAAC;oBACH,OAAO,GAAG,MAAM,QAAQ,EAAE,CAAC;gBAC7B,CAAC;gBAAC,OAAO,GAAG,EAAE,CAAC;oBACb,eAAM,CAAC,KAAK,CACV,EAAE,GAAG,EAAE,EACP,6DAA6D,CAC9D,CAAC;oBACF,OAAO,OAAO,CAAC;gBACjB,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,OAAO,GAAG,MAAM,QAAQ,EAAE,CAAC;YAC7B,CAAC;YAED,IAAI,CAAC,YAAE,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC;gBAC3B,MAAM,SAAS,GAA0B;oBACvC,QAAQ,EAAE,gBAAQ,CAAC,KAAK,EAAE,CAAC,KAAK,EAAE;oBAClC,KAAK,EAAE,OAAO;iBACf,CAAC;gBACF,MAAM,YAAY,CAAC,aAAa,CAC9B,cAAc,EACd,QAAQ,EACR,SAAS,EACT,cAAc,CACf,CAAC;YACJ,CAAC;YAED,OAAO,OAAO,CAAC;QACjB,CAAC;gBAAS,CAAC;YACT,WAAW,EAAE,CAAC;QAChB,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC","sourcesContent":["import is from '@sindresorhus/is';\nimport { DateTime } from 'luxon';\nimport { GlobalConfig } from '../../../config/global';\nimport { logger } from '../../../logger';\nimport type { Decorator } from '../../decorator';\nimport { decorate } from '../../decorator';\nimport { acquireLock } from '../../mutex';\nimport { resolveTtlValues } from './ttl';\nimport type { DecoratorCachedRecord, PackageCacheNamespace } from './types';\nimport * as packageCache from '.';\n\ntype HashFunction<T extends any[] = any[]> = (...args: T) => string;\ntype NamespaceFunction<T extends any[] = any[]> = (\n  ...args: T\n) => PackageCacheNamespace;\ntype BooleanFunction<T extends any[] = any[]> = (...args: T) => boolean;\n\n/**\n * The cache decorator parameters.\n */\ninterface CacheParameters {\n  /**\n   * The cache namespace\n   * Either a string or a hash function that generates a string\n   */\n  namespace: PackageCacheNamespace | NamespaceFunction;\n\n  /**\n   * The cache key\n   * Either a string or a hash function that generates a string\n   */\n  key: string | HashFunction;\n\n  /**\n   * A function that returns true if a result is cacheable\n   * Used to prevent caching of private, sensitive, results\n   */\n  cacheable?: BooleanFunction;\n\n  /**\n   * The TTL (or expiry) of the key in minutes\n   */\n  ttlMinutes?: number;\n}\n\n/**\n * caches the result of a decorated method.\n */\nexport function cache<T>({\n  namespace,\n  key,\n  cacheable = () => true,\n  ttlMinutes = 30,\n}: CacheParameters): Decorator<T> {\n  return decorate(async ({ args, instance, callback, methodName }) => {\n    const cachePrivatePackages = GlobalConfig.get(\n      'cachePrivatePackages',\n      false,\n    );\n    const isCacheable = cachePrivatePackages || cacheable.apply(instance, args);\n    if (!isCacheable) {\n      return callback();\n    }\n\n    let finalNamespace: PackageCacheNamespace | undefined;\n    if (is.string(namespace)) {\n      finalNamespace = namespace;\n    } else if (is.function(namespace)) {\n      finalNamespace = namespace.apply(instance, args);\n    }\n\n    let finalKey: string | undefined;\n    if (is.string(key)) {\n      finalKey = key;\n    } else if (is.function(key)) {\n      finalKey = key.apply(instance, args);\n    }\n\n    // istanbul ignore if\n    if (!finalNamespace || !finalKey) {\n      return callback();\n    }\n\n    finalKey = `cache-decorator:${finalKey}`;\n\n    // prevent concurrent processing and cache writes\n    const releaseLock = await acquireLock(finalKey, finalNamespace);\n\n    try {\n      const oldRecord = await packageCache.get<DecoratorCachedRecord>(\n        finalNamespace,\n        finalKey,\n      );\n\n      // eslint-disable-next-line prefer-const\n      let { softTtlMinutes, hardTtlMinutes } = resolveTtlValues(\n        finalNamespace,\n        ttlMinutes,\n      );\n\n      // The separation between \"soft\" and \"hard\" TTL allows us to treat\n      // data as obsolete according to the \"soft\" TTL while physically storing it\n      // according to the \"hard\" TTL.\n      //\n      // This helps us return obsolete data in case of upstream server errors,\n      // which is more useful than throwing exceptions ourselves.\n      //\n      // However, since the default hard TTL is one week, it could create\n      // unnecessary pressure on storage volume. Therefore,\n      // we cache only `getReleases` and `getDigest` results for an extended period.\n      //\n      // For other method names being decorated, the \"soft\" just equals the \"hard\" ttl.\n      if (methodName !== 'getReleases' && methodName !== 'getDigest') {\n        hardTtlMinutes = softTtlMinutes;\n      }\n\n      let oldData: unknown;\n      if (oldRecord) {\n        const now = DateTime.local();\n        const cachedAt = DateTime.fromISO(oldRecord.cachedAt);\n\n        const softDeadline = cachedAt.plus({ minutes: softTtlMinutes });\n        if (now < softDeadline) {\n          return oldRecord.value;\n        }\n\n        const hardDeadline = cachedAt.plus({ minutes: hardTtlMinutes });\n        if (now < hardDeadline) {\n          oldData = oldRecord.value;\n        }\n      }\n\n      let newData: unknown;\n      if (oldData) {\n        try {\n          newData = await callback();\n        } catch (err) {\n          logger.debug(\n            { err },\n            'Package cache decorator: callback error, returning old data',\n          );\n          return oldData;\n        }\n      } else {\n        newData = await callback();\n      }\n\n      if (!is.undefined(newData)) {\n        const newRecord: DecoratorCachedRecord = {\n          cachedAt: DateTime.local().toISO(),\n          value: newData,\n        };\n        await packageCache.setWithRawTtl(\n          finalNamespace,\n          finalKey,\n          newRecord,\n          hardTtlMinutes,\n        );\n      }\n\n      return newData;\n    } finally {\n      releaseLock();\n    }\n  });\n}\n"]}

package/dist/util/cache/package/file.d.ts

@@ -1,5 +1,5 @@
 import type { PackageCacheNamespace } from './types';
 export declare function get<T = never>(namespace: PackageCacheNamespace, key: string): Promise<T | undefined>;
-export declare function set(namespace: PackageCacheNamespace, key: string, value: unknown, ttlMinutes?: number): Promise<void>;
+export declare function set(namespace: PackageCacheNamespace, key: string, value: unknown, hardTtlMinutes?: number): Promise<void>;
 export declare function init(cacheDir: string): string;
 export declare function cleanup(): Promise<void>;

package/dist/util/cache/package/file.js

@@ -43,15 +43,15 @@ async function get(namespace, key) {
     }
     return undefined;
 }
-async function set(namespace, key, value, ttlMinutes = 5) {
+async function set(namespace, key, value, hardTtlMinutes = 5) {
     if (!cacheFileName) {
         return;
     }
-    logger_1.logger.trace({ namespace, key, ttlMinutes }, 'Saving cached value');
+    logger_1.logger.trace({ namespace, key, hardTtlMinutes }, 'Saving cached value');
     await cacache_1.default.put(cacheFileName, getKey(namespace, key), JSON.stringify({
         compress: true,
         value: await (0, compress_1.compressToBase64)(JSON.stringify(value)),
-        expiry: luxon_1.DateTime.local().plus({ minutes: ttlMinutes }),
+        expiry: luxon_1.DateTime.local().plus({ minutes: hardTtlMinutes }),
     }));
 }
 function init(cacheDir) {

package/dist/util/cache/package/file.js.map

@@ -1 +1 @@
-{"version":3,"file":"file.js","sourceRoot":"","sources":["../../../../lib/util/cache/package/file.ts"],"names":[],"mappings":";;AAqBA,kBA0BC;AAED,kBAmBC;AAED,oBAIC;AAED,0BAuCC;;AAnHD,8DAA8B;AAC9B,iCAAiC;AACjC,0DAA0B;AAC1B,4CAAyC;AACzC,6CAAwE;AAGxE,SAAS,MAAM,CAAC,SAAgC,EAAE,GAAW;IAC3D,OAAO,GAAG,SAAS,IAAI,GAAG,EAAE,CAAC;AAC/B,CAAC;AAED,IAAI,aAAqB,CAAC;AAE1B,KAAK,UAAU,EAAE,CACf,SAAgC,EAChC,GAAW;IAEX,eAAM,CAAC,KAAK,CAAC,EAAE,SAAS,EAAE,GAAG,EAAE,EAAE,sBAAsB,CAAC,CAAC;IACzD,MAAM,iBAAO,CAAC,EAAE,CAAC,KAAK,CAAC,aAAa,EAAE,MAAM,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC,CAAC;AAChE,CAAC;AAEM,KAAK,UAAU,GAAG,CACvB,SAAgC,EAChC,GAAW;IAEX,IAAI,CAAC,aAAa,EAAE,CAAC;QACnB,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,IAAI,CAAC;QACH,MAAM,GAAG,GAAG,MAAM,iBAAO,CAAC,GAAG,CAAC,aAAa,EAAE,MAAM,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC,CAAC;QACrE,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;QACpD,IAAI,WAAW,EAAE,CAAC;YAChB,IAAI,gBAAQ,CAAC,KAAK,EAAE,GAAG,gBAAQ,CAAC,OAAO,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC5D,eAAM,CAAC,KAAK,CAAC,EAAE,SAAS,EAAE,GAAG,EAAE,EAAE,wBAAwB,CAAC,CAAC;gBAC3D,qBAAqB;gBACrB,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,CAAC;oBAC1B,OAAO,WAAW,CAAC,KAAK,CAAC;gBAC3B,CAAC;gBACD,MAAM,GAAG,GAAG,MAAM,IAAA,+BAAoB,EAAC,WAAW,CAAC,KAAK,CAAC,CAAC;gBAC1D,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACzB,CAAC;YACD,MAAM,EAAE,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;QAC3B,CAAC;IACH,CAAC;IAAC,MAAM,CAAC;QACP,eAAM,CAAC,KAAK,CAAC,EAAE,SAAS,EAAE,GAAG,EAAE,EAAE,YAAY,CAAC,CAAC;IACjD,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAEM,KAAK,UAAU,GAAG,CACvB,SAAgC,EAChC,GAAW,EACX,KAAc,EACd,UAAU,GAAG,CAAC;IAEd,IAAI,CAAC,aAAa,EAAE,CAAC;QACnB,OAAO;IACT,CAAC;IACD,eAAM,CAAC,KAAK,CAAC,EAAE,SAAS,EAAE,GAAG,EAAE,UAAU,EAAE,EAAE,qBAAqB,CAAC,CAAC;IACpE,MAAM,iBAAO,CAAC,GAAG,CACf,aAAa,EACb,MAAM,CAAC,SAAS,EAAE,GAAG,CAAC,EACtB,IAAI,CAAC,SAAS,CAAC;QACb,QAAQ,EAAE,IAAI;QACd,KAAK,EAAE,MAAM,IAAA,2BAAgB,EAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QACpD,MAAM,EAAE,gBAAQ,CAAC,KAAK,EAAE,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC;KACvD,CAAC,CACH,CAAC;AACJ,CAAC;AAED,SAAgB,IAAI,CAAC,QAAgB;IACnC,aAAa,GAAG,eAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,6BAA6B,CAAC,CAAC;IACpE,eAAM,CAAC,KAAK,CAAC,4CAA4C,GAAG,aAAa,CAAC,CAAC;IAC3E,OAAO,aAAa,CAAC;AACvB,CAAC;AAEM,KAAK,UAAU,OAAO;IAC3B,eAAM,CAAC,KAAK,CAAC,+CAA+C,CAAC,CAAC;IAC9D,IAAI,UAAU,GAAG,CAAC,CAAC;IACnB,IAAI,YAAY,GAAG,CAAC,CAAC;IACrB,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IAC7B,IAAI,UAAU,GAAG,CAAC,CAAC;IACnB,IAAI,KAAK,EAAE,MAAM,IAAI,IAAI,iBAAO,CAAC,EAAE,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE,CAAC;QAC1D,IAAI,CAAC;YACH,UAAU,IAAI,CAAC,CAAC;YAChB,MAAM,UAAU,GAAG,IAAsC,CAAC;YAC1D,MAAM,GAAG,GAAG,MAAM,iBAAO,CAAC,GAAG,CAAC,aAAa,EAAE,UAAU,CAAC,GAAG,CAAC,CAAC;YAC7D,IAAI,WAAgB,CAAC;YACrB,IAAI,CAAC;gBACH,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;YAChD,CAAC;YAAC,MAAM,CAAC;gBACP,eAAM,CAAC,KAAK,CAAC,uCAAuC,CAAC,CAAC;YACxD,CAAC;YACD,IACE,CAAC,WAAW;gBACZ,CAAC,WAAW,EAAE,MAAM;oBAClB,gBAAQ,CAAC,KAAK,EAAE,GAAG,gBAAQ,CAAC,OAAO,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,EAC1D,CAAC;gBACD,MAAM,iBAAO,CAAC,EAAE,CAAC,KAAK,CAAC,aAAa,EAAE,UAAU,CAAC,GAAG,CAAC,CAAC;gBACtD,MAAM,iBAAO,CAAC,EAAE,CAAC,OAAO,CAAC,aAAa,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC;gBAC9D,YAAY,IAAI,CAAC,CAAC;YACpB,CAAC;QACH,CAAC;QAAC,OAAO,GAAG,EAAE,0BAA0B,CAAC,CAAC;YACxC,eAAM,CAAC,KAAK,CAAC,EAAE,GAAG,EAAE,EAAE,+BAA+B,CAAC,CAAC;YACvD,UAAU,IAAI,CAAC,CAAC;QAClB,CAAC;IACH,CAAC;IACD,6CAA6C;IAC7C,IAAI,UAAU,GAAG,CAAC,EAAE,CAAC;QACnB,eAAM,CAAC,KAAK,CAAC,kCAAkC,UAAU,EAAE,CAAC,CAAC;IAC/D,CAAC;IACD,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC,CAAC;IACtD,eAAM,CAAC,KAAK,CACV,WAAW,YAAY,OAAO,UAAU,2BAA2B,UAAU,IAAI,CAClF,CAAC;AACJ,CAAC","sourcesContent":["import cacache from 'cacache';\nimport { DateTime } from 'luxon';\nimport upath from 'upath';\nimport { logger } from '../../../logger';\nimport { compressToBase64, decompressFromBase64 } from '../../compress';\nimport type { PackageCacheNamespace } from './types';\n\nfunction getKey(namespace: PackageCacheNamespace, key: string): string {\n  return `${namespace}-${key}`;\n}\n\nlet cacheFileName: string;\n\nasync function rm(\n  namespace: PackageCacheNamespace,\n  key: string,\n): Promise<void> {\n  logger.trace({ namespace, key }, 'Removing cache entry');\n  await cacache.rm.entry(cacheFileName, getKey(namespace, key));\n}\n\nexport async function get<T = never>(\n  namespace: PackageCacheNamespace,\n  key: string,\n): Promise<T | undefined> {\n  if (!cacheFileName) {\n    return undefined;\n  }\n  try {\n    const res = await cacache.get(cacheFileName, getKey(namespace, key));\n    const cachedValue = JSON.parse(res.data.toString());\n    if (cachedValue) {\n      if (DateTime.local() < DateTime.fromISO(cachedValue.expiry)) {\n        logger.trace({ namespace, key }, 'Returning cached value');\n        // istanbul ignore if\n        if (!cachedValue.compress) {\n          return cachedValue.value;\n        }\n        const res = await decompressFromBase64(cachedValue.value);\n        return JSON.parse(res);\n      }\n      await rm(namespace, key);\n    }\n  } catch {\n    logger.trace({ namespace, key }, 'Cache miss');\n  }\n  return undefined;\n}\n\nexport async function set(\n  namespace: PackageCacheNamespace,\n  key: string,\n  value: unknown,\n  ttlMinutes = 5,\n): Promise<void> {\n  if (!cacheFileName) {\n    return;\n  }\n  logger.trace({ namespace, key, ttlMinutes }, 'Saving cached value');\n  await cacache.put(\n    cacheFileName,\n    getKey(namespace, key),\n    JSON.stringify({\n      compress: true,\n      value: await compressToBase64(JSON.stringify(value)),\n      expiry: DateTime.local().plus({ minutes: ttlMinutes }),\n    }),\n  );\n}\n\nexport function init(cacheDir: string): string {\n  cacheFileName = upath.join(cacheDir, '/renovate/renovate-cache-v1');\n  logger.debug('Initializing Renovate internal cache into ' + cacheFileName);\n  return cacheFileName;\n}\n\nexport async function cleanup(): Promise<void> {\n  logger.debug('Checking file package cache for expired items');\n  let totalCount = 0;\n  let deletedCount = 0;\n  const startTime = Date.now();\n  let errorCount = 0;\n  for await (const item of cacache.ls.stream(cacheFileName)) {\n    try {\n      totalCount += 1;\n      const cachedItem = item as unknown as cacache.CacheObject;\n      const res = await cacache.get(cacheFileName, cachedItem.key);\n      let cachedValue: any;\n      try {\n        cachedValue = JSON.parse(res.data.toString());\n      } catch {\n        logger.debug('Error parsing cached value - deleting');\n      }\n      if (\n        !cachedValue ||\n        (cachedValue?.expiry &&\n          DateTime.local() > DateTime.fromISO(cachedValue.expiry))\n      ) {\n        await cacache.rm.entry(cacheFileName, cachedItem.key);\n        await cacache.rm.content(cacheFileName, cachedItem.integrity);\n        deletedCount += 1;\n      }\n    } catch (err) /* istanbul ignore next */ {\n      logger.trace({ err }, 'Error cleaning up cache entry');\n      errorCount += 1;\n    }\n  }\n  // istanbul ignore if: cannot reproduce error\n  if (errorCount > 0) {\n    logger.debug(`Error count cleaning up cache: ${errorCount}`);\n  }\n  const durationMs = Math.round(Date.now() - startTime);\n  logger.debug(\n    `Deleted ${deletedCount} of ${totalCount} file cached entries in ${durationMs}ms`,\n  );\n}\n"]}
+{"version":3,"file":"file.js","sourceRoot":"","sources":["../../../../lib/util/cache/package/file.ts"],"names":[],"mappings":";;AAqBA,kBA0BC;AAED,kBAmBC;AAED,oBAIC;AAED,0BAuCC;;AAnHD,8DAA8B;AAC9B,iCAAiC;AACjC,0DAA0B;AAC1B,4CAAyC;AACzC,6CAAwE;AAGxE,SAAS,MAAM,CAAC,SAAgC,EAAE,GAAW;IAC3D,OAAO,GAAG,SAAS,IAAI,GAAG,EAAE,CAAC;AAC/B,CAAC;AAED,IAAI,aAAqB,CAAC;AAE1B,KAAK,UAAU,EAAE,CACf,SAAgC,EAChC,GAAW;IAEX,eAAM,CAAC,KAAK,CAAC,EAAE,SAAS,EAAE,GAAG,EAAE,EAAE,sBAAsB,CAAC,CAAC;IACzD,MAAM,iBAAO,CAAC,EAAE,CAAC,KAAK,CAAC,aAAa,EAAE,MAAM,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC,CAAC;AAChE,CAAC;AAEM,KAAK,UAAU,GAAG,CACvB,SAAgC,EAChC,GAAW;IAEX,IAAI,CAAC,aAAa,EAAE,CAAC;QACnB,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,IAAI,CAAC;QACH,MAAM,GAAG,GAAG,MAAM,iBAAO,CAAC,GAAG,CAAC,aAAa,EAAE,MAAM,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC,CAAC;QACrE,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;QACpD,IAAI,WAAW,EAAE,CAAC;YAChB,IAAI,gBAAQ,CAAC,KAAK,EAAE,GAAG,gBAAQ,CAAC,OAAO,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC5D,eAAM,CAAC,KAAK,CAAC,EAAE,SAAS,EAAE,GAAG,EAAE,EAAE,wBAAwB,CAAC,CAAC;gBAC3D,qBAAqB;gBACrB,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,CAAC;oBAC1B,OAAO,WAAW,CAAC,KAAK,CAAC;gBAC3B,CAAC;gBACD,MAAM,GAAG,GAAG,MAAM,IAAA,+BAAoB,EAAC,WAAW,CAAC,KAAK,CAAC,CAAC;gBAC1D,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACzB,CAAC;YACD,MAAM,EAAE,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;QAC3B,CAAC;IACH,CAAC;IAAC,MAAM,CAAC;QACP,eAAM,CAAC,KAAK,CAAC,EAAE,SAAS,EAAE,GAAG,EAAE,EAAE,YAAY,CAAC,CAAC;IACjD,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAEM,KAAK,UAAU,GAAG,CACvB,SAAgC,EAChC,GAAW,EACX,KAAc,EACd,cAAc,GAAG,CAAC;IAElB,IAAI,CAAC,aAAa,EAAE,CAAC;QACnB,OAAO;IACT,CAAC;IACD,eAAM,CAAC,KAAK,CAAC,EAAE,SAAS,EAAE,GAAG,EAAE,cAAc,EAAE,EAAE,qBAAqB,CAAC,CAAC;IACxE,MAAM,iBAAO,CAAC,GAAG,CACf,aAAa,EACb,MAAM,CAAC,SAAS,EAAE,GAAG,CAAC,EACtB,IAAI,CAAC,SAAS,CAAC;QACb,QAAQ,EAAE,IAAI;QACd,KAAK,EAAE,MAAM,IAAA,2BAAgB,EAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QACpD,MAAM,EAAE,gBAAQ,CAAC,KAAK,EAAE,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,cAAc,EAAE,CAAC;KAC3D,CAAC,CACH,CAAC;AACJ,CAAC;AAED,SAAgB,IAAI,CAAC,QAAgB;IACnC,aAAa,GAAG,eAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,6BAA6B,CAAC,CAAC;IACpE,eAAM,CAAC,KAAK,CAAC,4CAA4C,GAAG,aAAa,CAAC,CAAC;IAC3E,OAAO,aAAa,CAAC;AACvB,CAAC;AAEM,KAAK,UAAU,OAAO;IAC3B,eAAM,CAAC,KAAK,CAAC,+CAA+C,CAAC,CAAC;IAC9D,IAAI,UAAU,GAAG,CAAC,CAAC;IACnB,IAAI,YAAY,GAAG,CAAC,CAAC;IACrB,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IAC7B,IAAI,UAAU,GAAG,CAAC,CAAC;IACnB,IAAI,KAAK,EAAE,MAAM,IAAI,IAAI,iBAAO,CAAC,EAAE,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE,CAAC;QAC1D,IAAI,CAAC;YACH,UAAU,IAAI,CAAC,CAAC;YAChB,MAAM,UAAU,GAAG,IAAsC,CAAC;YAC1D,MAAM,GAAG,GAAG,MAAM,iBAAO,CAAC,GAAG,CAAC,aAAa,EAAE,UAAU,CAAC,GAAG,CAAC,CAAC;YAC7D,IAAI,WAAgB,CAAC;YACrB,IAAI,CAAC;gBACH,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;YAChD,CAAC;YAAC,MAAM,CAAC;gBACP,eAAM,CAAC,KAAK,CAAC,uCAAuC,CAAC,CAAC;YACxD,CAAC;YACD,IACE,CAAC,WAAW;gBACZ,CAAC,WAAW,EAAE,MAAM;oBAClB,gBAAQ,CAAC,KAAK,EAAE,GAAG,gBAAQ,CAAC,OAAO,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,EAC1D,CAAC;gBACD,MAAM,iBAAO,CAAC,EAAE,CAAC,KAAK,CAAC,aAAa,EAAE,UAAU,CAAC,GAAG,CAAC,CAAC;gBACtD,MAAM,iBAAO,CAAC,EAAE,CAAC,OAAO,CAAC,aAAa,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC;gBAC9D,YAAY,IAAI,CAAC,CAAC;YACpB,CAAC;QACH,CAAC;QAAC,OAAO,GAAG,EAAE,0BAA0B,CAAC,CAAC;YACxC,eAAM,CAAC,KAAK,CAAC,EAAE,GAAG,EAAE,EAAE,+BAA+B,CAAC,CAAC;YACvD,UAAU,IAAI,CAAC,CAAC;QAClB,CAAC;IACH,CAAC;IACD,6CAA6C;IAC7C,IAAI,UAAU,GAAG,CAAC,EAAE,CAAC;QACnB,eAAM,CAAC,KAAK,CAAC,kCAAkC,UAAU,EAAE,CAAC,CAAC;IAC/D,CAAC;IACD,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC,CAAC;IACtD,eAAM,CAAC,KAAK,CACV,WAAW,YAAY,OAAO,UAAU,2BAA2B,UAAU,IAAI,CAClF,CAAC;AACJ,CAAC","sourcesContent":["import cacache from 'cacache';\nimport { DateTime } from 'luxon';\nimport upath from 'upath';\nimport { logger } from '../../../logger';\nimport { compressToBase64, decompressFromBase64 } from '../../compress';\nimport type { PackageCacheNamespace } from './types';\n\nfunction getKey(namespace: PackageCacheNamespace, key: string): string {\n  return `${namespace}-${key}`;\n}\n\nlet cacheFileName: string;\n\nasync function rm(\n  namespace: PackageCacheNamespace,\n  key: string,\n): Promise<void> {\n  logger.trace({ namespace, key }, 'Removing cache entry');\n  await cacache.rm.entry(cacheFileName, getKey(namespace, key));\n}\n\nexport async function get<T = never>(\n  namespace: PackageCacheNamespace,\n  key: string,\n): Promise<T | undefined> {\n  if (!cacheFileName) {\n    return undefined;\n  }\n  try {\n    const res = await cacache.get(cacheFileName, getKey(namespace, key));\n    const cachedValue = JSON.parse(res.data.toString());\n    if (cachedValue) {\n      if (DateTime.local() < DateTime.fromISO(cachedValue.expiry)) {\n        logger.trace({ namespace, key }, 'Returning cached value');\n        // istanbul ignore if\n        if (!cachedValue.compress) {\n          return cachedValue.value;\n        }\n        const res = await decompressFromBase64(cachedValue.value);\n        return JSON.parse(res);\n      }\n      await rm(namespace, key);\n    }\n  } catch {\n    logger.trace({ namespace, key }, 'Cache miss');\n  }\n  return undefined;\n}\n\nexport async function set(\n  namespace: PackageCacheNamespace,\n  key: string,\n  value: unknown,\n  hardTtlMinutes = 5,\n): Promise<void> {\n  if (!cacheFileName) {\n    return;\n  }\n  logger.trace({ namespace, key, hardTtlMinutes }, 'Saving cached value');\n  await cacache.put(\n    cacheFileName,\n    getKey(namespace, key),\n    JSON.stringify({\n      compress: true,\n      value: await compressToBase64(JSON.stringify(value)),\n      expiry: DateTime.local().plus({ minutes: hardTtlMinutes }),\n    }),\n  );\n}\n\nexport function init(cacheDir: string): string {\n  cacheFileName = upath.join(cacheDir, '/renovate/renovate-cache-v1');\n  logger.debug('Initializing Renovate internal cache into ' + cacheFileName);\n  return cacheFileName;\n}\n\nexport async function cleanup(): Promise<void> {\n  logger.debug('Checking file package cache for expired items');\n  let totalCount = 0;\n  let deletedCount = 0;\n  const startTime = Date.now();\n  let errorCount = 0;\n  for await (const item of cacache.ls.stream(cacheFileName)) {\n    try {\n      totalCount += 1;\n      const cachedItem = item as unknown as cacache.CacheObject;\n      const res = await cacache.get(cacheFileName, cachedItem.key);\n      let cachedValue: any;\n      try {\n        cachedValue = JSON.parse(res.data.toString());\n      } catch {\n        logger.debug('Error parsing cached value - deleting');\n      }\n      if (\n        !cachedValue ||\n        (cachedValue?.expiry &&\n          DateTime.local() > DateTime.fromISO(cachedValue.expiry))\n      ) {\n        await cacache.rm.entry(cacheFileName, cachedItem.key);\n        await cacache.rm.content(cacheFileName, cachedItem.integrity);\n        deletedCount += 1;\n      }\n    } catch (err) /* istanbul ignore next */ {\n      logger.trace({ err }, 'Error cleaning up cache entry');\n      errorCount += 1;\n    }\n  }\n  // istanbul ignore if: cannot reproduce error\n  if (errorCount > 0) {\n    logger.debug(`Error count cleaning up cache: ${errorCount}`);\n  }\n  const durationMs = Math.round(Date.now() - startTime);\n  logger.debug(\n    `Deleted ${deletedCount} of ${totalCount} file cached entries in ${durationMs}ms`,\n  );\n}\n"]}

package/dist/util/cache/package/index.d.ts

@@ -1,10 +1,17 @@
 import type { AllConfig } from '../../../config/types';
 import type { PackageCacheNamespace } from './types';
+declare let cacheType: 'redis' | 'sqlite' | 'memory' | 'file' | undefined;
+export declare function getCacheType(): typeof cacheType;
 export declare function get<T = any>(namespace: PackageCacheNamespace, key: string): Promise<T | undefined>;
-export declare function set(namespace: PackageCacheNamespace, key: string, value: unknown, minutes: number): Promise<void>;
 /**
+ * Set cache value with user-defined TTL overrides.
+ */
+export declare function set(namespace: PackageCacheNamespace, key: string, value: unknown, hardTtlMinutes: number): Promise<void>;
+/**
+ * Set cache value ignoring user-defined TTL overrides.
  * This MUST NOT be used outside of cache implementation
  */
-export declare function setWithRawTtl(namespace: PackageCacheNamespace, key: string, value: unknown, minutes: number): Promise<void>;
+export declare function setWithRawTtl(namespace: PackageCacheNamespace, key: string, value: unknown, hardTtlMinutes: number): Promise<void>;
 export declare function init(config: AllConfig): Promise<void>;
 export declare function cleanup(config: AllConfig): Promise<void>;
+export {};

package/dist/util/cache/package/index.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.getCacheType = getCacheType;
 exports.get = get;
 exports.set = set;
 exports.setWithRawTtl = setWithRawTtl;
@@ -15,6 +16,11 @@ const redisCache = tslib_1.__importStar(require("./redis"));
 const sqlite_1 = require("./sqlite");
 const ttl_1 = require("./ttl");
 let cacheProxy;
+let cacheType;
+/* v8 ignore start -- not important */
+function getCacheType() {
+    return cacheType;
+} /* v8 ignore stop */
 async function get(namespace, key) {
     if (!cacheProxy) {
         return undefined;
@@ -28,33 +34,40 @@ async function get(namespace, key) {
     const result = await p;
     return result;
 }
-async function set(namespace, key, value, minutes) {
-    const rawTtl = (0, ttl_1.getTtlOverride)(namespace) ?? minutes;
+/**
+ * Set cache value with user-defined TTL overrides.
+ */
+async function set(namespace, key, value, hardTtlMinutes) {
+    const rawTtl = (0, ttl_1.getTtlOverride)(namespace) ?? hardTtlMinutes;
     await setWithRawTtl(namespace, key, value, rawTtl);
 }
 /**
+ * Set cache value ignoring user-defined TTL overrides.
  * This MUST NOT be used outside of cache implementation
  */
-async function setWithRawTtl(namespace, key, value, minutes) {
+async function setWithRawTtl(namespace, key, value, hardTtlMinutes) {
     if (!cacheProxy) {
         return;
     }
-    await stats_1.PackageCacheStats.wrapSet(() => cacheProxy.set(namespace, key, value, minutes));
+    await stats_1.PackageCacheStats.wrapSet(() => cacheProxy.set(namespace, key, value, hardTtlMinutes));
     const combinedKey = (0, key_1.getCombinedKey)(namespace, key);
     const p = Promise.resolve(value);
     memCache.set(combinedKey, p);
 }
 async function init(config) {
+    cacheType = undefined;
     if (config.redisUrl) {
         await redisCache.init(config.redisUrl, config.redisPrefix);
         cacheProxy = {
             get: redisCache.get,
             set: redisCache.set,
         };
+        cacheType = 'redis';
         return;
     }
     if ((0, env_1.getEnv)().RENOVATE_X_SQLITE_PACKAGE_CACHE) {
         cacheProxy = await sqlite_1.SqlitePackageCache.init(config.cacheDir);
+        cacheType = 'sqlite';
         return;
     }
     if (config.cacheDir) {
@@ -64,10 +77,12 @@ async function init(config) {
             set: fileCache.set,
             cleanup: fileCache.cleanup,
         };
+        cacheType = 'file';
         return;
     }
 }
 async function cleanup(config) {
+    cacheType = undefined;
     if (config?.redisUrl) {
         await redisCache.end();
     }

package/dist/util/cache/package/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../lib/util/cache/package/index.ts"],"names":[],"mappings":";;AAaA,kBAmBC;AAED,kBAQC;AAKD,sCAiBC;AAED,oBAwBC;AAED,0BAOC;;AAlGD,mCAAmC;AACnC,uCAAgD;AAChD,4DAAsC;AACtC,0DAAoC;AACpC,+BAAuC;AACvC,4DAAsC;AACtC,qCAA8C;AAC9C,+BAAuC;AAGvC,IAAI,UAAoC,CAAC;AAElC,KAAK,UAAU,GAAG,CACvB,SAAgC,EAChC,GAAW;IAEX,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,WAAW,GAAG,IAAA,oBAAc,EAAC,SAAS,EAAE,GAAG,CAAC,CAAC;IACnD,IAAI,CAAC,GAAG,QAAQ,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;IAClC,IAAI,CAAC,CAAC,EAAE,CAAC;QACP,CAAC,GAAG,yBAAiB,CAAC,OAAO,CAAC,GAAG,EAAE,CACjC,UAAW,CAAC,GAAG,CAAW,SAAS,EAAE,GAAG,CAAC,CAC1C,CAAC;QACF,QAAQ,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;IAC/B,CAAC;IAED,MAAM,MAAM,GAAG,MAAM,CAAC,CAAC;IACvB,OAAO,MAAM,CAAC;AAChB,CAAC;AAEM,KAAK,UAAU,GAAG,CACvB,SAAgC,EAChC,GAAW,EACX,KAAc,EACd,OAAe;IAEf,MAAM,MAAM,GAAG,IAAA,oBAAc,EAAC,SAAS,CAAC,IAAI,OAAO,CAAC;IACpD,MAAM,aAAa,CAAC,SAAS,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;AACrD,CAAC;AAED;;GAEG;AACI,KAAK,UAAU,aAAa,CACjC,SAAgC,EAChC,GAAW,EACX,KAAc,EACd,OAAe;IAEf,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,OAAO;IACT,CAAC;IAED,MAAM,yBAAiB,CAAC,OAAO,CAAC,GAAG,EAAE,CACnC,UAAW,CAAC,GAAG,CAAC,SAAS,EAAE,GAAG,EAAE,KAAK,EAAE,OAAO,CAAC,CAChD,CAAC;IAEF,MAAM,WAAW,GAAG,IAAA,oBAAc,EAAC,SAAS,EAAE,GAAG,CAAC,CAAC;IACnD,MAAM,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IACjC,QAAQ,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;AAC/B,CAAC;AAEM,KAAK,UAAU,IAAI,CAAC,MAAiB;IAC1C,IAAI,MAAM,CAAC,QAAQ,EAAE,CAAC;QACpB,MAAM,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,WAAW,CAAC,CAAC;QAC3D,UAAU,GAAG;YACX,GAAG,EAAE,UAAU,CAAC,GAAG;YACnB,GAAG,EAAE,UAAU,CAAC,GAAG;SACpB,CAAC;QACF,OAAO;IACT,CAAC;IAED,IAAI,IAAA,YAAM,GAAE,CAAC,+BAA+B,EAAE,CAAC;QAC7C,UAAU,GAAG,MAAM,2BAAkB,CAAC,IAAI,CAAC,MAAM,CAAC,QAAS,CAAC,CAAC;QAC7D,OAAO;IACT,CAAC;IAED,IAAI,MAAM,CAAC,QAAQ,EAAE,CAAC;QACpB,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAChC,UAAU,GAAG;YACX,GAAG,EAAE,SAAS,CAAC,GAAG;YAClB,GAAG,EAAE,SAAS,CAAC,GAAG;YAClB,OAAO,EAAE,SAAS,CAAC,OAAO;SAC3B,CAAC;QACF,OAAO;IACT,CAAC;AACH,CAAC;AAEM,KAAK,UAAU,OAAO,CAAC,MAAiB;IAC7C,IAAI,MAAM,EAAE,QAAQ,EAAE,CAAC;QACrB,MAAM,UAAU,CAAC,GAAG,EAAE,CAAC;IACzB,CAAC;IACD,IAAI,UAAU,EAAE,OAAO,EAAE,CAAC;QACxB,MAAM,UAAU,CAAC,OAAO,EAAE,CAAC;IAC7B,CAAC;AACH,CAAC","sourcesContent":["import type { AllConfig } from '../../../config/types';\nimport { getEnv } from '../../env';\nimport { PackageCacheStats } from '../../stats';\nimport * as memCache from '../memory';\nimport * as fileCache from './file';\nimport { getCombinedKey } from './key';\nimport * as redisCache from './redis';\nimport { SqlitePackageCache } from './sqlite';\nimport { getTtlOverride } from './ttl';\nimport type { PackageCache, PackageCacheNamespace } from './types';\n\nlet cacheProxy: PackageCache | undefined;\n\nexport async function get<T = any>(\n  namespace: PackageCacheNamespace,\n  key: string,\n): Promise<T | undefined> {\n  if (!cacheProxy) {\n    return undefined;\n  }\n\n  const combinedKey = getCombinedKey(namespace, key);\n  let p = memCache.get(combinedKey);\n  if (!p) {\n    p = PackageCacheStats.wrapGet(() =>\n      cacheProxy!.get<number[]>(namespace, key),\n    );\n    memCache.set(combinedKey, p);\n  }\n\n  const result = await p;\n  return result;\n}\n\nexport async function set(\n  namespace: PackageCacheNamespace,\n  key: string,\n  value: unknown,\n  minutes: number,\n): Promise<void> {\n  const rawTtl = getTtlOverride(namespace) ?? minutes;\n  await setWithRawTtl(namespace, key, value, rawTtl);\n}\n\n/**\n * This MUST NOT be used outside of cache implementation\n */\nexport async function setWithRawTtl(\n  namespace: PackageCacheNamespace,\n  key: string,\n  value: unknown,\n  minutes: number,\n): Promise<void> {\n  if (!cacheProxy) {\n    return;\n  }\n\n  await PackageCacheStats.wrapSet(() =>\n    cacheProxy!.set(namespace, key, value, minutes),\n  );\n\n  const combinedKey = getCombinedKey(namespace, key);\n  const p = Promise.resolve(value);\n  memCache.set(combinedKey, p);\n}\n\nexport async function init(config: AllConfig): Promise<void> {\n  if (config.redisUrl) {\n    await redisCache.init(config.redisUrl, config.redisPrefix);\n    cacheProxy = {\n      get: redisCache.get,\n      set: redisCache.set,\n    };\n    return;\n  }\n\n  if (getEnv().RENOVATE_X_SQLITE_PACKAGE_CACHE) {\n    cacheProxy = await SqlitePackageCache.init(config.cacheDir!);\n    return;\n  }\n\n  if (config.cacheDir) {\n    fileCache.init(config.cacheDir);\n    cacheProxy = {\n      get: fileCache.get,\n      set: fileCache.set,\n      cleanup: fileCache.cleanup,\n    };\n    return;\n  }\n}\n\nexport async function cleanup(config: AllConfig): Promise<void> {\n  if (config?.redisUrl) {\n    await redisCache.end();\n  }\n  if (cacheProxy?.cleanup) {\n    await cacheProxy.cleanup();\n  }\n}\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../lib/util/cache/package/index.ts"],"names":[],"mappings":";;AAgBA,oCAEC;AAED,kBAmBC;AAKD,kBAQC;AAMD,sCAiBC;AAED,oBA6BC;AAED,0BAQC;;AAnHD,mCAAmC;AACnC,uCAAgD;AAChD,4DAAsC;AACtC,0DAAoC;AACpC,+BAAuC;AACvC,4DAAsC;AACtC,qCAA8C;AAC9C,+BAAuC;AAGvC,IAAI,UAAoC,CAAC;AAEzC,IAAI,SAA6D,CAAC;AAElE,sCAAsC;AACtC,SAAgB,YAAY;IAC1B,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC,oBAAoB;AAEf,KAAK,UAAU,GAAG,CACvB,SAAgC,EAChC,GAAW;IAEX,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,WAAW,GAAG,IAAA,oBAAc,EAAC,SAAS,EAAE,GAAG,CAAC,CAAC;IACnD,IAAI,CAAC,GAAG,QAAQ,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;IAClC,IAAI,CAAC,CAAC,EAAE,CAAC;QACP,CAAC,GAAG,yBAAiB,CAAC,OAAO,CAAC,GAAG,EAAE,CACjC,UAAW,CAAC,GAAG,CAAW,SAAS,EAAE,GAAG,CAAC,CAC1C,CAAC;QACF,QAAQ,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;IAC/B,CAAC;IAED,MAAM,MAAM,GAAG,MAAM,CAAC,CAAC;IACvB,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;GAEG;AACI,KAAK,UAAU,GAAG,CACvB,SAAgC,EAChC,GAAW,EACX,KAAc,EACd,cAAsB;IAEtB,MAAM,MAAM,GAAG,IAAA,oBAAc,EAAC,SAAS,CAAC,IAAI,cAAc,CAAC;IAC3D,MAAM,aAAa,CAAC,SAAS,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;AACrD,CAAC;AAED;;;GAGG;AACI,KAAK,UAAU,aAAa,CACjC,SAAgC,EAChC,GAAW,EACX,KAAc,EACd,cAAsB;IAEtB,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,OAAO;IACT,CAAC;IAED,MAAM,yBAAiB,CAAC,OAAO,CAAC,GAAG,EAAE,CACnC,UAAW,CAAC,GAAG,CAAC,SAAS,EAAE,GAAG,EAAE,KAAK,EAAE,cAAc,CAAC,CACvD,CAAC;IAEF,MAAM,WAAW,GAAG,IAAA,oBAAc,EAAC,SAAS,EAAE,GAAG,CAAC,CAAC;IACnD,MAAM,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IACjC,QAAQ,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;AAC/B,CAAC;AAEM,KAAK,UAAU,IAAI,CAAC,MAAiB;IAC1C,SAAS,GAAG,SAAS,CAAC;IAEtB,IAAI,MAAM,CAAC,QAAQ,EAAE,CAAC;QACpB,MAAM,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,WAAW,CAAC,CAAC;QAC3D,UAAU,GAAG;YACX,GAAG,EAAE,UAAU,CAAC,GAAG;YACnB,GAAG,EAAE,UAAU,CAAC,GAAG;SACpB,CAAC;QACF,SAAS,GAAG,OAAO,CAAC;QACpB,OAAO;IACT,CAAC;IAED,IAAI,IAAA,YAAM,GAAE,CAAC,+BAA+B,EAAE,CAAC;QAC7C,UAAU,GAAG,MAAM,2BAAkB,CAAC,IAAI,CAAC,MAAM,CAAC,QAAS,CAAC,CAAC;QAC7D,SAAS,GAAG,QAAQ,CAAC;QACrB,OAAO;IACT,CAAC;IAED,IAAI,MAAM,CAAC,QAAQ,EAAE,CAAC;QACpB,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAChC,UAAU,GAAG;YACX,GAAG,EAAE,SAAS,CAAC,GAAG;YAClB,GAAG,EAAE,SAAS,CAAC,GAAG;YAClB,OAAO,EAAE,SAAS,CAAC,OAAO;SAC3B,CAAC;QACF,SAAS,GAAG,MAAM,CAAC;QACnB,OAAO;IACT,CAAC;AACH,CAAC;AAEM,KAAK,UAAU,OAAO,CAAC,MAAiB;IAC7C,SAAS,GAAG,SAAS,CAAC;IACtB,IAAI,MAAM,EAAE,QAAQ,EAAE,CAAC;QACrB,MAAM,UAAU,CAAC,GAAG,EAAE,CAAC;IACzB,CAAC;IACD,IAAI,UAAU,EAAE,OAAO,EAAE,CAAC;QACxB,MAAM,UAAU,CAAC,OAAO,EAAE,CAAC;IAC7B,CAAC;AACH,CAAC","sourcesContent":["import type { AllConfig } from '../../../config/types';\nimport { getEnv } from '../../env';\nimport { PackageCacheStats } from '../../stats';\nimport * as memCache from '../memory';\nimport * as fileCache from './file';\nimport { getCombinedKey } from './key';\nimport * as redisCache from './redis';\nimport { SqlitePackageCache } from './sqlite';\nimport { getTtlOverride } from './ttl';\nimport type { PackageCache, PackageCacheNamespace } from './types';\n\nlet cacheProxy: PackageCache | undefined;\n\nlet cacheType: 'redis' | 'sqlite' | 'memory' | 'file' | undefined;\n\n/* v8 ignore start -- not important */\nexport function getCacheType(): typeof cacheType {\n  return cacheType;\n} /* v8 ignore stop */\n\nexport async function get<T = any>(\n  namespace: PackageCacheNamespace,\n  key: string,\n): Promise<T | undefined> {\n  if (!cacheProxy) {\n    return undefined;\n  }\n\n  const combinedKey = getCombinedKey(namespace, key);\n  let p = memCache.get(combinedKey);\n  if (!p) {\n    p = PackageCacheStats.wrapGet(() =>\n      cacheProxy!.get<number[]>(namespace, key),\n    );\n    memCache.set(combinedKey, p);\n  }\n\n  const result = await p;\n  return result;\n}\n\n/**\n * Set cache value with user-defined TTL overrides.\n */\nexport async function set(\n  namespace: PackageCacheNamespace,\n  key: string,\n  value: unknown,\n  hardTtlMinutes: number,\n): Promise<void> {\n  const rawTtl = getTtlOverride(namespace) ?? hardTtlMinutes;\n  await setWithRawTtl(namespace, key, value, rawTtl);\n}\n\n/**\n * Set cache value ignoring user-defined TTL overrides.\n * This MUST NOT be used outside of cache implementation\n */\nexport async function setWithRawTtl(\n  namespace: PackageCacheNamespace,\n  key: string,\n  value: unknown,\n  hardTtlMinutes: number,\n): Promise<void> {\n  if (!cacheProxy) {\n    return;\n  }\n\n  await PackageCacheStats.wrapSet(() =>\n    cacheProxy!.set(namespace, key, value, hardTtlMinutes),\n  );\n\n  const combinedKey = getCombinedKey(namespace, key);\n  const p = Promise.resolve(value);\n  memCache.set(combinedKey, p);\n}\n\nexport async function init(config: AllConfig): Promise<void> {\n  cacheType = undefined;\n\n  if (config.redisUrl) {\n    await redisCache.init(config.redisUrl, config.redisPrefix);\n    cacheProxy = {\n      get: redisCache.get,\n      set: redisCache.set,\n    };\n    cacheType = 'redis';\n    return;\n  }\n\n  if (getEnv().RENOVATE_X_SQLITE_PACKAGE_CACHE) {\n    cacheProxy = await SqlitePackageCache.init(config.cacheDir!);\n    cacheType = 'sqlite';\n    return;\n  }\n\n  if (config.cacheDir) {\n    fileCache.init(config.cacheDir);\n    cacheProxy = {\n      get: fileCache.get,\n      set: fileCache.set,\n      cleanup: fileCache.cleanup,\n    };\n    cacheType = 'file';\n    return;\n  }\n}\n\nexport async function cleanup(config: AllConfig): Promise<void> {\n  cacheType = undefined;\n  if (config?.redisUrl) {\n    await redisCache.end();\n  }\n  if (cacheProxy?.cleanup) {\n    await cacheProxy.cleanup();\n  }\n}\n"]}

package/dist/util/cache/package/namespaces.d.ts

@@ -1,3 +1,3 @@
-export declare const packageCacheNamespaces: readonly ["_test-namespace", "changelog-bitbucket-notes@v2", "changelog-bitbucket-release", "changelog-bitbucket-server-notes@v2", "changelog-bitbucket-server-release", "changelog-forgejo-notes@v2", "changelog-forgejo-release", "changelog-gitea-notes@v2", "changelog-gitea-release", "changelog-github-notes@v2", "changelog-github-release", "changelog-gitlab-notes@v2", "changelog-gitlab-release", "datasource-artifactory", "datasource-aws-machine-image", "datasource-aws-rds", "datasource-aws-eks-addon", "datasource-azure-bicep-resource", "datasource-azure-pipelines-tasks", "datasource-bazel", "datasource-bitbucket-tags", "datasource-bitbucket-server-tags", "datasource-bitrise", "datasource-buildpacks-registry", "datasource-cdnjs", "datasource-conan", "datasource-conda", "datasource-cpan", "datasource-crate-metadata", "datasource-crate", "datasource-deb", "datasource-deno", "datasource-docker-architecture", "datasource-docker-hub-cache", "datasource-docker-digest", "datasource-docker-hub-tags", "datasource-docker-imageconfig", "datasource-docker-labels", "datasource-docker-releases-v2", "datasource-docker-tags", "datasource-dotnet-version", "datasource-endoflife-date", "datasource-galaxy-collection", "datasource-galaxy", "datasource-git-refs", "datasource-git-tags", "datasource-git", "datasource-forgejo-releases", "datasource-forgejo-tags", "datasource-gitea-releases", "datasource-gitea-tags", "datasource-github-release-attachments", "datasource-gitlab-packages", "datasource-gitlab-releases", "datasource-gitlab-tags", "datasource-glasskube-packages", "datasource-go-direct", "datasource-go-proxy", "datasource-go", "datasource-golang-version", "datasource-gradle-version", "datasource-helm", "datasource-hermit", "datasource-hex", "datasource-hexpm-bob", "datasource-java-version", "datasource-jenkins-plugins", "datasource-maven:cache-provider", "datasource-maven:postprocess-reject", "datasource-node-version", "datasource-npm:cache-provider", "datasource-nuget-v3", "datasource-orb", "datasource-packagist", "datasource-pod", "datasource-python-version", "datasource-repology", "datasource-rpm", "datasource-ruby-version", "datasource-rubygems", "datasource-sbt-package", "datasource-terraform-module", "datasource-terraform-provider", "datasource-terraform", "datasource-unity3d", "datasource-unity3d-packages", "github-releases-datasource-v2", "github-tags-datasource-v2", "merge-confidence", "preset", "terraform-provider-hash", "url-sha256"];
+export declare const packageCacheNamespaces: readonly ["_test-namespace", "changelog-bitbucket-notes@v2", "changelog-bitbucket-release", "changelog-bitbucket-server-notes@v2", "changelog-bitbucket-server-release", "changelog-forgejo-notes@v2", "changelog-forgejo-release", "changelog-gitea-notes@v2", "changelog-gitea-release", "changelog-github-notes@v2", "changelog-github-release", "changelog-gitlab-notes@v2", "changelog-gitlab-release", "datasource-artifactory", "datasource-aws-machine-image", "datasource-aws-rds", "datasource-aws-eks-addon", "datasource-azure-bicep-resource", "datasource-azure-pipelines-tasks", "datasource-bazel", "datasource-bitbucket-tags", "datasource-bitbucket-server-tags", "datasource-bitrise", "datasource-buildpacks-registry", "datasource-cdnjs", "datasource-conan", "datasource-conda", "datasource-cpan", "datasource-crate-metadata", "datasource-crate", "datasource-deb", "datasource-deno", "datasource-docker-architecture", "datasource-docker-hub-cache", "datasource-docker-digest", "datasource-docker-hub-tags", "datasource-docker-imageconfig", "datasource-docker-labels", "datasource-docker-releases-v2", "datasource-docker-tags", "datasource-dotnet-version", "datasource-endoflife-date", "datasource-galaxy-collection", "datasource-galaxy", "datasource-git-refs", "datasource-git-tags", "datasource-git", "datasource-forgejo-releases", "datasource-forgejo-tags", "datasource-gitea-releases", "datasource-gitea-tags", "datasource-github-release-attachments", "datasource-gitlab-packages", "datasource-gitlab-releases", "datasource-gitlab-tags", "datasource-glasskube-packages", "datasource-go-direct", "datasource-go-proxy", "datasource-go", "datasource-golang-version", "datasource-gradle-version", "datasource-helm", "datasource-hermit", "datasource-hex", "datasource-hexpm-bob", "datasource-java-version", "datasource-jenkins-plugins", "datasource-jsr", "datasource-maven:cache-provider", "datasource-maven:postprocess-reject", "datasource-node-version", "datasource-npm:cache-provider", "datasource-nuget-v3", "datasource-orb", "datasource-packagist", "datasource-pod", "datasource-python-version", "datasource-repology", "datasource-rpm", "datasource-ruby-version", "datasource-rubygems", "datasource-sbt-package", "datasource-terraform-module", "datasource-terraform-provider", "datasource-terraform", "datasource-typst:cache-provider", "datasource-typst:releases", "datasource-unity3d", "datasource-unity3d-packages", "github-releases-datasource-v2", "github-tags-datasource-v2", "merge-confidence", "preset", "terraform-provider-hash", "url-sha256"];
 export type PackageCacheNamespace = (typeof packageCacheNamespaces)[number] | `datasource-releases-${string}`;
 export type CombinedKey = `datasource-mem:pkg-fetch:${PackageCacheNamespace}:${string}`;