Add support for recommended mod dependencies (#946)

This commit is contained in:
Cooldude2606 authored and GitHub committed 2026-07-18 21:57:50 +01:00
1 parent 5758cd94b6
commit 198ea76674
4 files changed
+119 -21

No files matched your search

+28 -10
View File
@@ -675,6 +675,7 @@ export default class ControlConnection extends BaseConnection {
type ModPortalModType = InstanceType<typeof lib.ModPortalGetAllRequest.Response>["mods"][number]; type ModPortalModType = InstanceType<typeof lib.ModPortalGetAllRequest.Response>["mods"][number];
type ModPortalReleaseType = NonNullable<ModPortalModType["releases"]>[number]; type ModPortalReleaseType = NonNullable<ModPortalModType["releases"]>[number];
const dependencyRequirements = new Map<string, lib.ModVersionRange>(); const dependencyRequirements = new Map<string, lib.ModVersionRange>();
const recommendedRequirements = new Map<string, lib.ModVersionRange>();
const optionalRequirements = new Map<string, lib.ModVersionRange>(); const optionalRequirements = new Map<string, lib.ModVersionRange>();
const candidateReleases = new Map<string, lib.ModInfo>(); const candidateReleases = new Map<string, lib.ModInfo>();
const errors = new Map<string, lib.ModDependencyResolveErrors>(); const errors = new Map<string, lib.ModDependencyResolveErrors>();
@@ -739,16 +740,32 @@ export default class ControlConnection extends BaseConnection {
continue; continue;
} }
// Get the current version range (optionals are tracked in case they become required) // Get the current version range (dependencies can be promoted to a stricter requirement)
let versionRange = dependencyRequirements.get(mod.name); const versionRange =
if (!versionRange) { dependencyRequirements.get(mod.name)
versionRange = optionalRequirements.get(mod.name) ?? new lib.ModVersionRange(); ?? recommendedRequirements.get(mod.name)
if (mod.required) { ?? optionalRequirements.get(mod.name)
dependencyRequirements.set(mod.name, versionRange); ?? new lib.ModVersionRange();
if (mod.required) {
// Add to required, remove from recommended and optional
dependencyRequirements.set(mod.name, versionRange);
recommendedRequirements.delete(mod.name);
optionalRequirements.delete(mod.name);
} else if (mod.recommended) {
// If not required, add to recommended and remove from optional
if (!dependencyRequirements.has(mod.name)) {
recommendedRequirements.set(mod.name, versionRange);
optionalRequirements.delete(mod.name); optionalRequirements.delete(mod.name);
} else {
optionalRequirements.set(mod.name, versionRange);
} }
} else if (
!dependencyRequirements.has(mod.name)
&& !recommendedRequirements.has(mod.name)
) {
// If not required or recommended, add to optional
optionalRequirements.set(mod.name, versionRange);
} }
// Update the version range if needed // Update the version range if needed
@@ -757,6 +774,7 @@ export default class ControlConnection extends BaseConnection {
if (!versionRange.valid) { if (!versionRange.valid) {
candidateReleases.delete(mod.name); candidateReleases.delete(mod.name);
errors.set(mod.name, "unsatisfiable"); errors.set(mod.name, "unsatisfiable");
continue;
} }
} }
@@ -804,9 +822,9 @@ export default class ControlConnection extends BaseConnection {
} }
} }
// Remove incompatible dependencies if they aren't required by others // Remove incompatible and unsatisfiable dependencies if they aren't required by others
for (const [modName, error] of errors) { for (const [modName, error] of errors) {
if (error === "incompatible" && !dependencyRequirements.has(modName)) { if (!dependencyRequirements.has(modName) && (error === "incompatible" || error === "unsatisfiable")) {
errors.delete(modName); errors.delete(modName);
} }
} }
+7 -1
View File
@@ -14,7 +14,7 @@ import {
} from "./version"; } from "./version";
type ModDependencyType = "incompatible" | "optional" | "hidden" | "unordered" | "required"; type ModDependencyType = "incompatible" | "optional" | "hidden" | "unordered" | "required" | "recommended";
export type ModDependencyUnsatisfiedReason = "incompatible" | "missing_dependency" | "wrong_version"; export type ModDependencyUnsatisfiedReason = "incompatible" | "missing_dependency" | "wrong_version";
const UnsatisfiedSeverity: Record<ModDependencyUnsatisfiedReason, number> = { const UnsatisfiedSeverity: Record<ModDependencyUnsatisfiedReason, number> = {
@@ -39,6 +39,8 @@ export class ModDependency {
return "hidden"; return "hidden";
case "~": case "~":
return "unordered"; return "unordered";
case "+":
return "recommended";
case "": case "":
return "required"; return "required";
default: default:
@@ -86,6 +88,10 @@ export class ModDependency {
return this.type === "incompatible"; return this.type === "incompatible";
} }
get recommended() {
return this.type === "recommended";
}
get required() { get required() {
return this.type === "unordered" || this.type === "required"; return this.type === "unordered" || this.type === "required";
} }
+22 -6
View File
@@ -217,23 +217,29 @@ describe("lib/data/ModInfo", function() {
const dependency = new ModDependency("! my-mod"); const dependency = new ModDependency("! my-mod");
assert.equal(dependency.isSatisfied(mods), false); assert.equal(dependency.isSatisfied(mods), false);
}); });
it("should pass for optional / hidden being missing", function() { it("should pass for optional / hidden / recommended being missing", function() {
const dependencyOptional = new ModDependency("? not-present"); const dependencyOptional = new ModDependency("? not-present");
assert.equal(dependencyOptional.isSatisfied(mods), true); assert.equal(dependencyOptional.isSatisfied(mods), true);
const dependencyHidden = new ModDependency("(?) not-present"); const dependencyHidden = new ModDependency("(?) not-present");
assert.equal(dependencyHidden.isSatisfied(mods), true); assert.equal(dependencyHidden.isSatisfied(mods), true);
const dependencyRecommended = new ModDependency("+ not-present");
assert.equal(dependencyRecommended.isSatisfied(mods), true);
}); });
it("should pass for optional / hidden being present", function() { it("should pass for optional / hidden / recommended being present", function() {
const dependencyOptional = new ModDependency("? my-mod"); const dependencyOptional = new ModDependency("? my-mod");
assert.equal(dependencyOptional.isSatisfied(mods), true); assert.equal(dependencyOptional.isSatisfied(mods), true);
const dependencyHidden = new ModDependency("(?) my-mod"); const dependencyHidden = new ModDependency("(?) my-mod");
assert.equal(dependencyHidden.isSatisfied(mods), true); assert.equal(dependencyHidden.isSatisfied(mods), true);
const dependencyRecommended = new ModDependency("+ my-mod");
assert.equal(dependencyRecommended.isSatisfied(mods), true);
}); });
it("should fail for optional / hidden being present but wrong version", function() { it("should fail for optional / hidden / recommended being present but wrong version", function() {
const dependencyOptional = new ModDependency("? my-mod > 2.0.0"); const dependencyOptional = new ModDependency("? my-mod > 2.0.0");
assert.equal(dependencyOptional.isSatisfied(mods), false); assert.equal(dependencyOptional.isSatisfied(mods), false);
const dependencyHidden = new ModDependency("(?) my-mod > 2.0.0"); const dependencyHidden = new ModDependency("(?) my-mod > 2.0.0");
assert.equal(dependencyHidden.isSatisfied(mods), false); assert.equal(dependencyHidden.isSatisfied(mods), false);
const dependencyRecommended = new ModDependency("+ my-mod > 2.0.0");
assert.equal(dependencyRecommended.isSatisfied(mods), false);
}); });
it("should pass for unordered / required being present", function() { it("should pass for unordered / required being present", function() {
const dependencyOptional = new ModDependency("~ my-mod"); const dependencyOptional = new ModDependency("~ my-mod");
@@ -258,19 +264,29 @@ describe("lib/data/ModInfo", function() {
it("should return true iff the type is incompatible", function() { it("should return true iff the type is incompatible", function() {
const dependencyIncompatible = new ModDependency("! my-mod"); const dependencyIncompatible = new ModDependency("! my-mod");
assert.equal(dependencyIncompatible.incompatible, true); assert.equal(dependencyIncompatible.incompatible, true);
for (const test of ["my-mod", "? my-mod", "(?) my-mod", "~ my-mod"]) { for (const test of ["my-mod", "? my-mod", "(?) my-mod", "~ my-mod", "+ my-mod"]) {
const dependency = new ModDependency(test); const dependency = new ModDependency(test);
assert.equal(dependency.incompatible, false, test); assert.equal(dependency.incompatible, false, test);
} }
}); });
}); });
describe("recommended", function() {
it("should return true iff the type is recommended", function() {
const dependencyIncompatible = new ModDependency("+ my-mod");
assert.equal(dependencyIncompatible.recommended, true);
for (const test of ["my-mod", "? my-mod", "(?) my-mod", "~ my-mod", "! my-mod"]) {
const dependency = new ModDependency(test);
assert.equal(dependency.recommended, false, test);
}
});
});
describe("required", function() { describe("required", function() {
it("should return true iff the dependency is required", function() { it("should return true iff the dependency is required", function() {
for (const test of ["my-mod", "~ my-mod"]) { for (const test of ["my-mod", "~ my-mod"]) {
const dependency = new ModDependency(test); const dependency = new ModDependency(test);
assert.equal(dependency.required, true, test); assert.equal(dependency.required, true, test);
} }
for (const test of ["! my-mod", "? my-mod", "(?) my-mod"]) { for (const test of ["! my-mod", "? my-mod", "(?) my-mod", "+ my-mod"]) {
const dependency = new ModDependency(test); const dependency = new ModDependency(test);
assert.equal(dependency.required, false, test); assert.equal(dependency.required, false, test);
} }
@@ -282,7 +298,7 @@ describe("lib/data/ModInfo", function() {
const dependency = new ModDependency(test); const dependency = new ModDependency(test);
assert.equal(dependency.optional, true, test); assert.equal(dependency.optional, true, test);
} }
for (const test of ["! my-mod", "my-mod", "~ my-mod"]) { for (const test of ["! my-mod", "my-mod", "~ my-mod", "+ my-mod"]) {
const dependency = new ModDependency(test); const dependency = new ModDependency(test);
assert.equal(dependency.optional, false, test); assert.equal(dependency.optional, false, test);
} }
+62 -4
View File
@@ -187,14 +187,16 @@ describe("messages/mod", function() {
}); });
}); });
describe("handle", function() { describe("handle", function() {
const factorioVersions = ["1.0", "1.1", "2.0"]; const factorioVersions = ["1.0", "1.1", "2.0", "2.1"];
it("resolves dependencies", async function() { it("resolves dependencies", async function() {
for (const factorioVersion of factorioVersions) { for (const factorioVersion of factorioVersions) {
setPortalModRelease("root", "1.0.0", factorioVersion, ["foo", "bar < 2.0.0", "? baz"]); setPortalModRelease("root", "1.0.0", factorioVersion, ["foo", "bar < 2.0.0", "? baz", "+ qux"]);
setPortalModRelease("foo", "1.0.0", factorioVersion, ["foo-dep"]); setPortalModRelease("foo", "1.0.0", factorioVersion, ["foo-dep"]);
setPortalModRelease("foo-dep", "1.0.0", factorioVersion, []); setPortalModRelease("foo-dep", "1.0.0", factorioVersion, []);
setPortalModRelease("bar", "1.0.0", factorioVersion, []); setPortalModRelease("bar", "1.0.0", factorioVersion, []);
setPortalModRelease("baz", "1.0.0", factorioVersion, []); setPortalModRelease("baz", "1.0.0", factorioVersion, []);
setPortalModRelease("qux", "1.0.0", factorioVersion, ["qux-dep"]);
setPortalModRelease("qux-dep", "1.0.0", factorioVersion, []);
setPortalModRelease("root-2", "1.0.0", factorioVersion, ["foo", "bar-2"]); setPortalModRelease("root-2", "1.0.0", factorioVersion, ["foo", "bar-2"]);
setPortalModRelease("bar-2", "1.0.0", factorioVersion, []); setPortalModRelease("bar-2", "1.0.0", factorioVersion, []);
@@ -213,7 +215,7 @@ describe("messages/mod", function() {
const depIds = new Set(result.dependencies.map(mod => mod.id)); const depIds = new Set(result.dependencies.map(mod => mod.id));
assert.deepEqual(depIds, new Set([ assert.deepEqual(depIds, new Set([
"root_1.0.0", "foo_1.0.0", "foo-dep_1.0.0", "bar_1.0.0", "root_1.0.0", "foo_1.0.0", "foo-dep_1.0.0", "bar_1.0.0",
"root-2_1.0.0", "bar-2_1.0.0", "root-2_1.0.0", "bar-2_1.0.0", "qux_1.0.0", "qux-dep_1.0.0",
])); ]));
} }
}); });
@@ -307,6 +309,24 @@ describe("messages/mod", function() {
assert.deepEqual(depIds, new Set(["root_1.0.0", "foo_1.0.0"])); assert.deepEqual(depIds, new Set(["root_1.0.0", "foo_1.0.0"]));
} }
}); });
it("ignores missing optional dependencies", async function() {
for (const factorioVersion of factorioVersions) {
setPortalModRelease("root", "1.0.0", factorioVersion, ["? foo"]);
const result = await controlConnection.handleModDependencyResolveRequest(
new lib.ModDependencyResolveRequest([new ModDependency("root")], factorioVersion),
);
assert.deepEqual(result.errors, new Map([
["base", "notFound"],
]));
const depIds = new Set(result.dependencies.map(mod => mod.id));
assert.deepEqual(depIds, new Set([
"root_1.0.0",
]));
}
});
it("does not ignore optional dependencies when required by another", async function() { it("does not ignore optional dependencies when required by another", async function() {
for (const factorioVersion of factorioVersions) { for (const factorioVersion of factorioVersions) {
setPortalModRelease("root", "1.0.0", factorioVersion, ["foo", "? baz"]); setPortalModRelease("root", "1.0.0", factorioVersion, ["foo", "? baz"]);
@@ -325,6 +345,44 @@ describe("messages/mod", function() {
assert.deepEqual(depIds, new Set(["root_1.0.0", "foo_1.0.0", "baz_1.0.0"])); assert.deepEqual(depIds, new Set(["root_1.0.0", "foo_1.0.0", "baz_1.0.0"]));
} }
}); });
it("ignores missing recommended dependencies", async function() {
for (const factorioVersion of factorioVersions) {
setPortalModRelease("root", "1.0.0", factorioVersion, ["+ foo"]);
const result = await controlConnection.handleModDependencyResolveRequest(
new lib.ModDependencyResolveRequest([new ModDependency("root")], factorioVersion),
);
assert.deepEqual(result.errors, new Map([
["base", "notFound"],
]));
const depIds = new Set(result.dependencies.map(mod => mod.id));
assert.deepEqual(depIds, new Set([
"root_1.0.0",
]));
}
});
it("does not ignore recommended dependencies when required by another", async function() {
for (const factorioVersion of factorioVersions) {
setPortalModRelease("root", "1.0.0", factorioVersion, ["+ baz", "foo"]);
setPortalModRelease("foo", "1.0.0", factorioVersion, ["baz"]);
setPortalModRelease("baz", "1.0.0", factorioVersion, []);
const result = await controlConnection.handleModDependencyResolveRequest(
new lib.ModDependencyResolveRequest([new ModDependency("root")], factorioVersion),
);
assert.deepEqual(result.errors, new Map([
["base", "notFound"],
]));
const depIds = new Set(result.dependencies.map(mod => mod.id));
assert.deepEqual(depIds, new Set([
"root_1.0.0", "foo_1.0.0", "baz_1.0.0",
]));
}
});
it("prefers the locally installed version if matching", async function() { it("prefers the locally installed version if matching", async function() {
controller.modStore.addMod(lib.ModInfo.fromJSON({ name: "foo", version: "1.0.0" })); controller.modStore.addMod(lib.ModInfo.fromJSON({ name: "foo", version: "1.0.0" }));
for (const factorioVersion of factorioVersions) { for (const factorioVersion of factorioVersions) {
@@ -426,7 +484,7 @@ describe("messages/mod", function() {
"pyalienlife", "pyalienlifegraphics", "pyalienlifegraphics2", "pyalienlifegraphics3", "pyalienlife", "pyalienlifegraphics", "pyalienlifegraphics2", "pyalienlifegraphics3",
"pycoalprocessing", "pycoalprocessinggraphics", "pyfusionenergy", "pyfusionenergygraphics", "pycoalprocessing", "pycoalprocessinggraphics", "pyfusionenergy", "pyfusionenergygraphics",
"pypetroleumhandling", "pypetroleumhandlinggraphics", "pyrawores", "pyraworesgraphics", "pypetroleumhandling", "pypetroleumhandlinggraphics", "pyrawores", "pyraworesgraphics",
"pyhightech", "pyhightechgraphics", "pyindustry", "pyindustrygraphics", "pyhightech", "pyhightechgraphics", "pyindustry", "pyindustrygraphics", "enable-all-feature-flags",
])); ]));
}); });
}); });