summaryrefslogtreecommitdiff
path: root/tests/steamLaunchOptions.test.ts
blob: 93d37df52b77bc255d0370123b6a08082262acbd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
import assert from "node:assert/strict";
import test from "node:test";
import {
  cleanupPluginAssignments,
  cleanupPluginLaunchOptions,
  cleanupLegacyWrapper,
  hasWrapperLaunchIntegration,
  installWrapperIntegration,
  installWrapperLaunchOption,
  isLegacyWrapperToken,
  normalizeLaunchOptions,
  readSteamLaunchOptions,
  removeWrapperIntegration,
  removeWrapperLaunchOption,
} from "../src/utils/steamLaunchOptions.ts";

const wrapper = "~/.lsfg";

test("inserts one wrapper immediately before an existing command macro", () => {
  assert.deepEqual(installWrapperLaunchOption('gamemoderun %command% --profile "high quality"', wrapper), {
    options: 'gamemoderun ~/.lsfg %command% --profile "high quality"',
    commandTokenAdded: false,
  });
  assert.equal(hasWrapperLaunchIntegration(`gamemoderun ${wrapper} %command%`, wrapper), true);
  assert.deepEqual(installWrapperLaunchOption(`gamemoderun ${wrapper} %command%`, wrapper), {
    options: `gamemoderun ${wrapper} %command%`,
    commandTokenAdded: false,
  });
});

test("normalizes blank and argument-only shortcut fields", () => {
  assert.deepEqual(installWrapperLaunchOption("", wrapper), {
    options: `${wrapper} %command%`,
    commandTokenAdded: true,
  });
  assert.deepEqual(installWrapperLaunchOption("FOO=bar --windowed", wrapper), {
    options: `FOO=bar ${wrapper} %command% --windowed`,
    commandTokenAdded: true,
  });
  assert.throws(() => installWrapperLaunchOption("gamemoderun --windowed", wrapper), /refusing to guess/);
  assert.throws(() => installWrapperLaunchOption('"%command%"', wrapper), /refusing to guess/);
});

test("preserves assignments quoting suffixes and released wrapper cleanup", () => {
  const options = 'FOO="hello world" VK_INSTANCE_LAYERS="one:two" gamemoderun %command% --flag "two words"';
  assert.equal(
    installWrapperLaunchOption(options, wrapper).options,
    'FOO="hello world" VK_INSTANCE_LAYERS="one:two" gamemoderun ~/.lsfg %command% --flag "two words"',
  );
  assert.equal(removeWrapperLaunchOption(`${wrapper} %command% --arg "${wrapper}"`, wrapper, true), `--arg "${wrapper}"`);
  assert.equal(normalizeLaunchOptions("  FOO=bar   %COMMAND%  --flag "), "FOO=bar %COMMAND% --flag");
  for (const token of ["~/lsfg", "/home/deck/lsfg", "mako-run", "mako-launch"]) {
    assert.equal(cleanupLegacyWrapper(`FOO=bar ${token} %command% --arg "${token}"`), `FOO=bar %command% --arg "${token}"`);
  }
  assert.equal(isLegacyWrapperToken("/home/kurt/lsfg"), true);
  assert.equal(isLegacyWrapperToken("/opt/tools/lsfg"), false);
});

test("removes only managed assignments and preserves unrelated values", () => {
  assert.equal(
    cleanupPluginAssignments(
      'FOO="keep this" ENABLE_GAMESCOPE_WSI=0 DXVK_HDR=0 SteamDeck=0 DISABLE_VKBASALT=1 MESA_LOADER_DRIVER_OVERRIDE=zink DXVK_CONFIG="dxgi.syncInterval = 0; dxvk.maxFrameRate = 30" %command%',
    ),
    'FOO="keep this" DXVK_CONFIG="dxgi.syncInterval = 0" %command%',
  );
  assert.equal(cleanupPluginLaunchOptions(`DXVK_FRAME_RATE=30 ${wrapper} %command%`, wrapper), "%command%");
  assert.equal(
    cleanupPluginAssignments("PROTON_USE_WOW64=1 MANGOHUD=1 MANGOHUD_CONFIG=alpha %command%"),
    "PROTON_USE_WOW64=1 MANGOHUD=1 MANGOHUD_CONFIG=alpha %command%",
  );
});

test("uses launch options for Steam and MAKO-style Target wrapping for direct Flatpak", async () => {
  const previousWindow = (globalThis as Record<string, unknown>).window;
  const previousSteamClient = (globalThis as Record<string, unknown>).SteamClient;
  let appOptions = "FOO=bar %command%";
  let shortcutOptions = "--windowed";
  let shortcutTarget = '"flatpak"';
  const appWrites: string[] = [];
  const shortcutWrites: string[] = [];
  const targetWrites: string[] = [];
  const unregisters: number[] = [];
  const apps = {
    RegisterForAppDetails(appId: number, callback: (details: SteamAppDetails) => void) {
      callback(appId === 42
        ? { strLaunchOptions: appOptions, strShortcutLaunchOptions: "wrong-field" }
        : { strShortcutExe: shortcutTarget, strShortcutLaunchOptions: shortcutOptions, strLaunchOptions: "wrong-field" });
      return { unregister: () => unregisters.push(appId) };
    },
    SetAppLaunchOptions(appId: number, options: string) {
      assert.equal(appId, 42);
      appWrites.push(options);
      appOptions = options.replaceAll(" ", "  ");
    },
    SetShortcutLaunchOptions(appId: number, options: string) {
      assert.equal(appId, 43);
      shortcutWrites.push(options);
      shortcutOptions = options;
    },
    SetShortcutExe(appId: number, executable: string) {
      assert.equal(appId, 43);
      targetWrites.push(executable);
      shortcutTarget = executable;
    },
  };
  (globalThis as Record<string, unknown>).window = { setTimeout, clearTimeout };
  (globalThis as Record<string, unknown>).SteamClient = { Apps: apps };
  try {
    const normal = await readSteamLaunchOptions(42, false);
    assert.equal(normal.options, "FOO=bar %command%");
    const installed = await installWrapperIntegration(42, false, wrapper);
    assert.equal(installed.snapshot.options, `FOO=bar ${wrapper} %command%`.replaceAll(" ", "  "));
    assert.equal(installed.commandTokenAdded, false);
    assert.equal(appWrites.length, 1);

    const shortcut = await installWrapperIntegration(43, true, wrapper, false, true);
    assert.equal(shortcut.snapshot.target, '~/.lsfg "/usr/bin/flatpak"');
    assert.deepEqual(targetWrites, ['~/.lsfg "/usr/bin/flatpak"']);
    assert.equal(shortcut.snapshot.options, "--windowed");
    assert.deepEqual(shortcutWrites, []);

    const second = await installWrapperIntegration(43, true, wrapper, false, true);
    assert.equal(second.changed, false);
    assert.deepEqual(targetWrites, ['~/.lsfg "/usr/bin/flatpak"']);

    const restored = await removeWrapperIntegration(43, true, wrapper, false, true);
    assert.equal(restored.target, "/usr/bin/flatpak");
    assert.deepEqual(targetWrites, ['~/.lsfg "/usr/bin/flatpak"', "/usr/bin/flatpak"]);

    const cleaned = await removeWrapperIntegration(42, false, wrapper, installed.commandTokenAdded);
    assert.equal(cleaned.options, "FOO=bar %command%".replaceAll(" ", "  "));
    assert.ok(unregisters.includes(42));
    assert.ok(unregisters.includes(43));
  } finally {
    if (previousWindow === undefined) delete (globalThis as Record<string, unknown>).window;
    else (globalThis as Record<string, unknown>).window = previousWindow;
    if (previousSteamClient === undefined) delete (globalThis as Record<string, unknown>).SteamClient;
    else (globalThis as Record<string, unknown>).SteamClient = previousSteamClient;
  }
});

test("AppImage and EmuDeck script shortcuts stay launch-option based", async () => {
  const previousWindow = (globalThis as Record<string, unknown>).window;
  const previousSteamClient = (globalThis as Record<string, unknown>).SteamClient;
  const cases = [
    {
      target: "env",
      options: 'DESKTOPINTEGRATION=1 "/home/deck/AppImages/dusk.appimage"',
      expected: 'DESKTOPINTEGRATION=1 ~/.lsfg %command% "/home/deck/AppImages/dusk.appimage"',
    },
    {
      target: '"/home/deck/Emulation/tools/launchers/retroarch.sh" -L core rom.z64',
      options: "",
      expected: "~/.lsfg %command%",
    },
  ];
  (globalThis as Record<string, unknown>).window = { setTimeout, clearTimeout };
  try {
    for (const [index, item] of cases.entries()) {
      let shortcutTarget = item.target;
      let shortcutOptions = item.options;
      const targetWrites: string[] = [];
      const shortcutWrites: string[] = [];
      (globalThis as Record<string, unknown>).SteamClient = {
        Apps: {
          RegisterForAppDetails(_appId: number, callback: (details: SteamAppDetails) => void) {
            callback({ strShortcutExe: shortcutTarget, strShortcutLaunchOptions: shortcutOptions });
            return { unregister() {} };
          },
          SetShortcutLaunchOptions(_appId: number, options: string) {
            shortcutWrites.push(options);
            shortcutOptions = options;
          },
          SetShortcutExe(_appId: number, executable: string) {
            targetWrites.push(executable);
            shortcutTarget = executable;
          },
        },
      };
      const installed = await installWrapperIntegration(100 + index, true, wrapper, false, false);
      assert.equal(installed.snapshot.target, item.target);
      assert.equal(installed.snapshot.options, item.expected);
      assert.deepEqual(targetWrites, []);
      assert.deepEqual(shortcutWrites, [item.expected]);
      const restored = await removeWrapperIntegration(100 + index, true, wrapper, installed.commandTokenAdded, false);
      assert.equal(restored.target, item.target);
      assert.equal(restored.options, item.options);
      assert.deepEqual(targetWrites, []);
    }
  } finally {
    if (previousWindow === undefined) delete (globalThis as Record<string, unknown>).window;
    else (globalThis as Record<string, unknown>).window = previousWindow;
    if (previousSteamClient === undefined) delete (globalThis as Record<string, unknown>).SteamClient;
    else (globalThis as Record<string, unknown>).SteamClient = previousSteamClient;
  }
});

test("direct Flatpak fails closed and rolls Target writes back", async () => {
  const previousWindow = (globalThis as Record<string, unknown>).window;
  const previousSteamClient = (globalThis as Record<string, unknown>).SteamClient;
  let shortcutTarget = "/usr/bin/flatpak";
  const targetWrites: string[] = [];
  (globalThis as Record<string, unknown>).window = { setTimeout, clearTimeout };
  (globalThis as Record<string, unknown>).SteamClient = {
    Apps: {
      RegisterForAppDetails(_appId: number, callback: (details: SteamAppDetails) => void) {
        callback({ strShortcutExe: shortcutTarget, strShortcutLaunchOptions: "" });
        return { unregister() {} };
      },
      SetShortcutExe(_appId: number, executable: string) {
        targetWrites.push(executable);
        shortcutTarget = executable;
        if (executable.startsWith(wrapper)) throw new Error("simulated Target write failure");
      },
    },
  };
  try {
    await assert.rejects(installWrapperIntegration(43, true, wrapper, false, true), /simulated Target write failure/);
    assert.equal(shortcutTarget, "/usr/bin/flatpak");
    assert.deepEqual(targetWrites, ['~/.lsfg "/usr/bin/flatpak"', "/usr/bin/flatpak"]);

    shortcutTarget = "garbage";
    await assert.rejects(installWrapperIntegration(43, true, wrapper, false, true), /supported direct Flatpak/);
  } finally {
    if (previousWindow === undefined) delete (globalThis as Record<string, unknown>).window;
    else (globalThis as Record<string, unknown>).window = previousWindow;
    if (previousSteamClient === undefined) delete (globalThis as Record<string, unknown>).SteamClient;
    else (globalThis as Record<string, unknown>).SteamClient = previousSteamClient;
  }
});