Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,10 +1,17 @@
import { describe, expect, it } from "vitest";
import { beforeEach, describe, expect, it, vi } from "vitest";

import { log } from "../../logging";
import { parseExtensionInfo } from "./extensionInfo";

vi.mock("../../logging", () => ({ log: vi.fn() }));

describe("parseExtensionInfo", () => {
const base = { name: "Cyberpunk 2077 Vortex Support", version: "0.13.0" };

beforeEach(() => {
vi.mocked(log).mockClear();
});

it("reads the mod id written at install", () => {
expect(parseExtensionInfo({ ...base, modId: 196 }).modId).toBe(196);
});
Expand All @@ -16,4 +23,57 @@ describe("parseExtensionInfo", () => {
it("ignores an unusable mod id instead of failing to load the extension", () => {
expect(parseExtensionInfo({ ...base, modId: "196" }).modId).toBeUndefined();
});

describe("contributes", () => {
const valid = {
games: { cyberpunk2077: { nexusGameId: 3333, name: "Cyberpunk 2077" } },
gameEnhancements: [{ gameUid: "ABC-123" }],
};

it("stays in legacy mode without contributes, without a warning", () => {
expect(parseExtensionInfo(base).contributes).toBeUndefined();
expect(log).not.toHaveBeenCalled();
});

it("puts a valid contributes on the info, with lowercase uids", () => {
const info = parseExtensionInfo({ ...base, contributes: valid });
expect(info.contributes?.games?.["cyberpunk2077" as never]).toMatchObject({
nexusGameId: 3333,
});
expect(info.contributes?.gameEnhancements).toEqual([{ gameUid: "abc-123" }]);
expect(log).not.toHaveBeenCalled();
});

it("falls back to legacy mode with a warning on an invalid contributes", () => {
const info = parseExtensionInfo({
...base,
id: "cyberpunk-support",
contributes: { gameEnhancements: [{ gameUid: "abc", nexusGameId: 1 }] },
});
expect(info.name).toBe(base.name);
expect(info.contributes).toBeUndefined();
expect(log).toHaveBeenCalledTimes(1);
expect(log).toHaveBeenCalledWith(
"warn",
expect.any(String),
expect.objectContaining({ extension: "cyberpunk-support" }),
);
});

it("treats a non-object contributes as invalid instead of rejecting", () => {
const info = parseExtensionInfo({ ...base, contributes: null });
expect(info.contributes).toBeUndefined();
expect(log).toHaveBeenCalledTimes(1);
});

it("accepts unknown keys inside contributes", () => {
const info = parseExtensionInfo({
...base,
contributes: { ...valid, somethingNew: true },
});
expect(info.contributes).toBeDefined();
expect(info.contributes).not.toHaveProperty("somethingNew");
expect(log).not.toHaveBeenCalled();
});
});
});
18 changes: 18 additions & 0 deletions src/renderer/src/extensions/extension_manager/extensionInfo.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@ import { z } from "zod";

import type { ExtensionInfo } from "@/types/extensions";

import { log } from "../../logging";
import { ContributesSchema } from "./contributes";

const schema = z.looseObject({
name: z.string(),
author: z.string().optional(),
Expand All @@ -11,6 +14,8 @@ const schema = z.looseObject({
namespace: z.string().optional(),
// an unusable value leaves the extension unlinked rather than unloadable
modId: z.number().int().positive().optional().catch(undefined),
// validated separately, an invalid value must not make the extension unloadable
contributes: z.unknown().optional(),
});

export function parseExtensionInfo(data: unknown): ExtensionInfo {
Expand All @@ -26,5 +31,18 @@ export function parseExtensionInfo(data: unknown): ExtensionInfo {
modId: parsed.modId,
};

if (parsed.contributes !== undefined) {
const contributes = ContributesSchema.safeParse(parsed.contributes);
if (contributes.success) {
result.contributes = contributes.data;
} else {
// never reject the extension, it runs in legacy mode
log("warn", "invalid contributes in extension info.json, loading in legacy mode", {
extension: parsed.id ?? parsed.name,
issues: z.prettifyError(contributes.error),
});
}
}

return result;
}
8 changes: 8 additions & 0 deletions src/renderer/src/types/extensions.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import type { NexusGameDomain, NexusGameId } from "@vortex/shared";

import type { Contributes } from "../extensions/extension_manager/contributes";
import type { IExtensionContext, IReducerSpec } from "./IExtensionContext";
import type { IExtensionLoadFailure, IExtensionState } from "./IState";

Expand Down Expand Up @@ -43,6 +44,13 @@ export interface ExtensionInfo {
/** Namespace for localization support. */
namespace?: string;

/**
* What the extension declares it contributes. Set means the extension is in
* manifest mode, unset means legacy mode (no `contributes` in info.json, or
* one that failed validation).
*/
contributes?: Contributes;

/** @deprecated not read from info.json anymore */
type?: ExtensionType;
/** @deprecated not read from info.json anymore */
Expand Down