obsidian-integration-testing 4.3.0 → 5.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +51 -54
- package/dist/lib/cjs/global-setup-core.cjs +39 -12
- package/dist/lib/cjs/global-setup-core.d.cts +1 -1
- package/dist/lib/cjs/index.cjs +1 -4
- package/dist/lib/cjs/index.d.cts +2 -3
- package/dist/lib/cjs/kill-process-tree.cjs +57 -0
- package/dist/lib/cjs/kill-process-tree.d.cts +16 -0
- package/dist/lib/cjs/library.cjs +1 -1
- package/dist/lib/cjs/obsidian-config.cjs +11 -85
- package/dist/lib/cjs/obsidian-config.d.cts +12 -72
- package/dist/lib/cjs/obsidian-installer.cjs +180 -0
- package/dist/lib/cjs/obsidian-installer.d.cts +45 -0
- package/dist/lib/cjs/obsidian-instance.cjs +100 -0
- package/dist/lib/cjs/obsidian-instance.d.cts +55 -0
- package/dist/lib/cjs/obsidian-version-switch.cjs +105 -0
- package/dist/lib/cjs/obsidian-version-switch.d.cts +63 -0
- package/dist/lib/cjs/obsidian-version.cjs +85 -0
- package/dist/lib/cjs/obsidian-version.d.cts +111 -0
- package/dist/lib/cjs/setup-lock.cjs +158 -0
- package/dist/lib/cjs/setup-lock.d.cts +55 -0
- package/dist/lib/cjs/transport-desktop-cdp.cjs +121 -7
- package/dist/lib/cjs/transport-desktop-cdp.d.cts +75 -14
- package/dist/lib/cjs/transport-factory.cjs +63 -32
- package/dist/lib/cjs/transport-options.cjs +1 -1
- package/dist/lib/cjs/transport-options.d.cts +37 -14
- package/dist/lib/cjs/transport.cjs +1 -1
- package/dist/lib/cjs/transport.d.cts +1 -1
- package/dist/lib/cjs/vitest/global-setup.cjs +2 -2
- package/dist/lib/cjs/vitest/typings.d.cts +1 -1
- package/dist/lib/esm/global-setup-core.d.mts +1 -1
- package/dist/lib/esm/global-setup-core.mjs +39 -12
- package/dist/lib/esm/index.d.mts +2 -3
- package/dist/lib/esm/index.mjs +1 -3
- package/dist/lib/esm/kill-process-tree.d.mts +16 -0
- package/dist/lib/esm/kill-process-tree.mjs +23 -0
- package/dist/lib/esm/library.mjs +1 -1
- package/dist/lib/esm/obsidian-config.d.mts +12 -72
- package/dist/lib/esm/obsidian-config.mjs +10 -78
- package/dist/lib/esm/obsidian-installer.d.mts +45 -0
- package/dist/lib/esm/obsidian-installer.mjs +158 -0
- package/dist/lib/esm/obsidian-instance.d.mts +55 -0
- package/dist/lib/esm/obsidian-instance.mjs +75 -0
- package/dist/lib/esm/obsidian-version-switch.d.mts +63 -0
- package/dist/lib/esm/obsidian-version-switch.mjs +89 -0
- package/dist/lib/esm/obsidian-version.d.mts +111 -0
- package/dist/lib/esm/obsidian-version.mjs +55 -0
- package/dist/lib/esm/setup-lock.d.mts +55 -0
- package/dist/lib/esm/setup-lock.mjs +132 -0
- package/dist/lib/esm/transport-desktop-cdp.d.mts +75 -14
- package/dist/lib/esm/transport-desktop-cdp.mjs +125 -7
- package/dist/lib/esm/transport-factory.mjs +68 -28
- package/dist/lib/esm/transport-options.d.mts +37 -14
- package/dist/lib/esm/transport.d.mts +1 -1
- package/dist/lib/esm/vitest/global-setup.mjs +2 -2
- package/dist/lib/esm/vitest/typings.d.mts +1 -1
- package/dist/obsidian-integration-testing-5.0.0.tgz +0 -0
- package/package.json +16 -15
- package/dist/lib/cjs/transport-desktop-cli.cjs +0 -540
- package/dist/lib/cjs/transport-desktop-cli.d.cts +0 -154
- package/dist/lib/esm/transport-desktop-cli.d.mts +0 -154
- package/dist/lib/esm/transport-desktop-cli.mjs +0 -520
- package/dist/obsidian-integration-testing-4.3.0.tgz +0 -0
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
import { spawn } from "node:child_process";
|
|
2
|
+
import { createServer } from "node:net";
|
|
3
|
+
import { killProcessTree } from "./kill-process-tree.mjs";
|
|
4
|
+
import { log } from "./log.mjs";
|
|
5
|
+
const DEFAULT_CDP_HOST = "127.0.0.1";
|
|
6
|
+
const CDP_READY_POLL_INTERVAL_IN_MILLISECONDS = 1e3;
|
|
7
|
+
const CDP_READY_TIMEOUT_IN_MILLISECONDS = 6e4;
|
|
8
|
+
async function launchOwnedObsidianInstance(params) {
|
|
9
|
+
const cdpHost = params.cdpHost ?? DEFAULT_CDP_HOST;
|
|
10
|
+
const port = await pickFreePort();
|
|
11
|
+
const cdpUrl = `http://${cdpHost}:${String(port)}`;
|
|
12
|
+
log(`[obsidian-instance] Launching owned Obsidian: userData=${params.userDataDir}, cdpPort=${String(port)}`);
|
|
13
|
+
const child = spawn(
|
|
14
|
+
params.exePath,
|
|
15
|
+
[`--user-data-dir=${params.userDataDir}`, `--remote-debugging-port=${String(port)}`],
|
|
16
|
+
{ detached: true, stdio: "ignore" }
|
|
17
|
+
);
|
|
18
|
+
child.unref();
|
|
19
|
+
try {
|
|
20
|
+
await waitForCdpReady(cdpUrl);
|
|
21
|
+
log(`[obsidian-instance] Owned Obsidian is serving CDP at ${cdpUrl}.`);
|
|
22
|
+
return { cdpUrl, kill, port };
|
|
23
|
+
} catch (error) {
|
|
24
|
+
kill();
|
|
25
|
+
throw error;
|
|
26
|
+
}
|
|
27
|
+
function kill() {
|
|
28
|
+
killProcessTree(child);
|
|
29
|
+
}
|
|
30
|
+
}
|
|
31
|
+
function pickFreePort() {
|
|
32
|
+
return new Promise((resolve, reject) => {
|
|
33
|
+
const server = createServer();
|
|
34
|
+
server.once("error", reject);
|
|
35
|
+
server.listen(0, DEFAULT_CDP_HOST, () => {
|
|
36
|
+
const address = server.address();
|
|
37
|
+
if (address === null || typeof address === "string") {
|
|
38
|
+
server.close();
|
|
39
|
+
reject(new Error("Failed to determine a free port."));
|
|
40
|
+
return;
|
|
41
|
+
}
|
|
42
|
+
const { port } = address;
|
|
43
|
+
server.close(() => {
|
|
44
|
+
resolve(port);
|
|
45
|
+
});
|
|
46
|
+
});
|
|
47
|
+
});
|
|
48
|
+
}
|
|
49
|
+
function delay(ms) {
|
|
50
|
+
return new Promise((resolve) => {
|
|
51
|
+
setTimeout(resolve, ms);
|
|
52
|
+
});
|
|
53
|
+
}
|
|
54
|
+
async function waitForCdpReady(cdpUrl) {
|
|
55
|
+
const deadline = Date.now() + CDP_READY_TIMEOUT_IN_MILLISECONDS;
|
|
56
|
+
while (Date.now() < deadline) {
|
|
57
|
+
try {
|
|
58
|
+
const response = await fetch(`${cdpUrl}/json`);
|
|
59
|
+
const targets = await response.json();
|
|
60
|
+
if (targets.some((target) => target.type === "page")) {
|
|
61
|
+
return;
|
|
62
|
+
}
|
|
63
|
+
} catch {
|
|
64
|
+
}
|
|
65
|
+
await delay(CDP_READY_POLL_INTERVAL_IN_MILLISECONDS);
|
|
66
|
+
}
|
|
67
|
+
throw new Error(
|
|
68
|
+
`Owned Obsidian instance did not expose CDP at ${cdpUrl} within ${String(CDP_READY_TIMEOUT_IN_MILLISECONDS)}ms.`
|
|
69
|
+
);
|
|
70
|
+
}
|
|
71
|
+
export {
|
|
72
|
+
launchOwnedObsidianInstance,
|
|
73
|
+
pickFreePort
|
|
74
|
+
};
|
|
75
|
+
//# sourceMappingURL=data:application/json;base64,{
  "version": 3,
  "sources": ["../../../src/obsidian-instance.ts"],
  "sourcesContent": ["/**\n * @file\n *\n * Launches and manages a harness-owned, isolated Obsidian desktop instance.\n *\n * The instance runs against a dedicated `--user-data-dir` (so it never touches\n * the user's Obsidian config, registry, or running window) and exposes CDP on a\n * dedicated `--remote-debugging-port`. Because Electron's single-instance lock\n * is keyed to the user-data dir, the owned instance runs in parallel with the\n * user's own Obsidian. Confirmed by the Phase 0 spike (see the project plan).\n */\n\n/* v8 ignore start -- Integration-time process management covered by integration tests, not unit tests. */\n\nimport { spawn } from 'node:child_process';\nimport { createServer } from 'node:net';\n\nimport { killProcessTree } from './kill-process-tree.mjs';\nimport { log } from './log.mjs';\n\n/**\n * Parameters for {@link launchOwnedObsidianInstance}.\n */\nexport interface LaunchOwnedObsidianInstanceParams {\n  /**\n   * CDP host to bind/poll.\n   *\n   * @default `'127.0.0.1'`\n   */\n  readonly cdpHost?: string;\n\n  /** Absolute path to the Obsidian executable (shell) to launch. */\n  readonly exePath: string;\n\n  /** Absolute path to the isolated user-data dir to pass via `--user-data-dir`. */\n  readonly userDataDir: string;\n}\n\n/**\n * A running, harness-owned Obsidian instance.\n */\nexport interface OwnedObsidianInstance {\n  /** Base CDP URL, e.g. `http://127.0.0.1:51888`. */\n  readonly cdpUrl: string;\n\n  /** Kills the instance and its entire process tree. */\n  kill(): void;\n\n  /** The CDP remote-debugging port the instance was launched with. */\n  readonly port: number;\n}\n\nconst DEFAULT_CDP_HOST = '127.0.0.1';\nconst CDP_READY_POLL_INTERVAL_IN_MILLISECONDS = 1000;\nconst CDP_READY_TIMEOUT_IN_MILLISECONDS = 60000;\n\ninterface CdpTarget {\n  type: string;\n}\n\n/**\n * Launches an isolated, harness-owned Obsidian instance and waits until its CDP\n * endpoint is serving page targets.\n *\n * @param params - Launch parameters.\n * @returns The running owned instance.\n * @throws Error if CDP does not become reachable within the timeout.\n */\nexport async function launchOwnedObsidianInstance(\n  params: LaunchOwnedObsidianInstanceParams\n): Promise<OwnedObsidianInstance> {\n  const cdpHost = params.cdpHost ?? DEFAULT_CDP_HOST;\n  const port = await pickFreePort();\n  const cdpUrl = `http://${cdpHost}:${String(port)}`;\n\n  log(`[obsidian-instance] Launching owned Obsidian: userData=${params.userDataDir}, cdpPort=${String(port)}`);\n  const child = spawn(\n    params.exePath,\n    [`--user-data-dir=${params.userDataDir}`, `--remote-debugging-port=${String(port)}`],\n    { detached: true, stdio: 'ignore' }\n  );\n  child.unref();\n\n  try {\n    await waitForCdpReady(cdpUrl);\n    log(`[obsidian-instance] Owned Obsidian is serving CDP at ${cdpUrl}.`);\n    return { cdpUrl, kill, port };\n  } catch (error: unknown) {\n    kill();\n    throw error;\n  }\n\n  function kill(): void {\n    killProcessTree(child);\n  }\n}\n\n/**\n * Picks a free TCP port by binding to port `0` and reading the assigned port.\n *\n * There is a small time-of-check/time-of-use window between releasing the port\n * here and Obsidian binding it; in practice it is negligible for test runs.\n *\n * @returns A free TCP port.\n */\nexport function pickFreePort(): Promise<number> {\n  return new Promise((resolve, reject) => {\n    const server = createServer();\n    server.once('error', reject);\n    server.listen(0, DEFAULT_CDP_HOST, () => {\n      const address = server.address();\n      if (address === null || typeof address === 'string') {\n        server.close();\n        reject(new Error('Failed to determine a free port.'));\n        return;\n      }\n      const { port } = address;\n      server.close(() => {\n        resolve(port);\n      });\n    });\n  });\n}\n\n/**\n * Returns a promise that resolves after the given delay.\n *\n * @param ms - The delay in milliseconds.\n * @returns A promise that resolves after the delay.\n */\nfunction delay(ms: number): Promise<void> {\n  return new Promise((resolve) => {\n    setTimeout(resolve, ms);\n  });\n}\n\n/**\n * Polls the CDP `/json` endpoint until at least one page target appears.\n *\n * @param cdpUrl - The base CDP URL.\n */\nasync function waitForCdpReady(cdpUrl: string): Promise<void> {\n  const deadline = Date.now() + CDP_READY_TIMEOUT_IN_MILLISECONDS;\n  while (Date.now() < deadline) {\n    try {\n      const response = await fetch(`${cdpUrl}/json`);\n      const targets = await response.json() as CdpTarget[];\n      if (targets.some((target) => target.type === 'page')) {\n        return;\n      }\n    } catch {\n      // Endpoint not up yet \u2014 keep polling.\n    }\n    await delay(CDP_READY_POLL_INTERVAL_IN_MILLISECONDS);\n  }\n  throw new Error(\n    `Owned Obsidian instance did not expose CDP at ${cdpUrl} within ${String(CDP_READY_TIMEOUT_IN_MILLISECONDS)}ms.`\n  );\n}\n\n/* v8 ignore stop */\n"],
  "mappings": "AAcA,SAAS,aAAa;AACtB,SAAS,oBAAoB;AAE7B,SAAS,uBAAuB;AAChC,SAAS,WAAW;AAkCpB,MAAM,mBAAmB;AACzB,MAAM,0CAA0C;AAChD,MAAM,oCAAoC;AAc1C,eAAsB,4BACpB,QACgC;AAChC,QAAM,UAAU,OAAO,WAAW;AAClC,QAAM,OAAO,MAAM,aAAa;AAChC,QAAM,SAAS,UAAU,OAAO,IAAI,OAAO,IAAI,CAAC;AAEhD,MAAI,0DAA0D,OAAO,WAAW,aAAa,OAAO,IAAI,CAAC,EAAE;AAC3G,QAAM,QAAQ;AAAA,IACZ,OAAO;AAAA,IACP,CAAC,mBAAmB,OAAO,WAAW,IAAI,2BAA2B,OAAO,IAAI,CAAC,EAAE;AAAA,IACnF,EAAE,UAAU,MAAM,OAAO,SAAS;AAAA,EACpC;AACA,QAAM,MAAM;AAEZ,MAAI;AACF,UAAM,gBAAgB,MAAM;AAC5B,QAAI,wDAAwD,MAAM,GAAG;AACrE,WAAO,EAAE,QAAQ,MAAM,KAAK;AAAA,EAC9B,SAAS,OAAgB;AACvB,SAAK;AACL,UAAM;AAAA,EACR;AAEA,WAAS,OAAa;AACpB,oBAAgB,KAAK;AAAA,EACvB;AACF;AAUO,SAAS,eAAgC;AAC9C,SAAO,IAAI,QAAQ,CAAC,SAAS,WAAW;AACtC,UAAM,SAAS,aAAa;AAC5B,WAAO,KAAK,SAAS,MAAM;AAC3B,WAAO,OAAO,GAAG,kBAAkB,MAAM;AACvC,YAAM,UAAU,OAAO,QAAQ;AAC/B,UAAI,YAAY,QAAQ,OAAO,YAAY,UAAU;AACnD,eAAO,MAAM;AACb,eAAO,IAAI,MAAM,kCAAkC,CAAC;AACpD;AAAA,MACF;AACA,YAAM,EAAE,KAAK,IAAI;AACjB,aAAO,MAAM,MAAM;AACjB,gBAAQ,IAAI;AAAA,MACd,CAAC;AAAA,IACH,CAAC;AAAA,EACH,CAAC;AACH;AAQA,SAAS,MAAM,IAA2B;AACxC,SAAO,IAAI,QAAQ,CAAC,YAAY;AAC9B,eAAW,SAAS,EAAE;AAAA,EACxB,CAAC;AACH;AAOA,eAAe,gBAAgB,QAA+B;AAC5D,QAAM,WAAW,KAAK,IAAI,IAAI;AAC9B,SAAO,KAAK,IAAI,IAAI,UAAU;AAC5B,QAAI;AACF,YAAM,WAAW,MAAM,MAAM,GAAG,MAAM,OAAO;AAC7C,YAAM,UAAU,MAAM,SAAS,KAAK;AACpC,UAAI,QAAQ,KAAK,CAAC,WAAW,OAAO,SAAS,MAAM,GAAG;AACpD;AAAA,MACF;AAAA,IACF,QAAQ;AAAA,IAER;AACA,UAAM,MAAM,uCAAuC;AAAA,EACrD;AACA,QAAM,IAAI;AAAA,IACR,iDAAiD,MAAM,WAAW,OAAO,iCAAiC,CAAC;AAAA,EAC7G;AACF;",
  "names": []
}

|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @file
|
|
3
|
+
*
|
|
4
|
+
* Integration-time helpers for provisioning a specific Obsidian **asar** (the
|
|
5
|
+
* app code) into an isolated user-data dir.
|
|
6
|
+
*
|
|
7
|
+
* Obsidian's bootstrap loads the highest of (its shell's bundled
|
|
8
|
+
* `resources/obsidian.asar`, the `obsidian-<version>.asar` files in the
|
|
9
|
+
* user-data dir). So placing an asar here only takes effect when its version is
|
|
10
|
+
* **>= the shell's bundled version** (upgrade-only — confirmed by the Phase 0
|
|
11
|
+
* spike). Running an older version requires pinning the installer/shell instead
|
|
12
|
+
* (see `obsidian-installer.ts`).
|
|
13
|
+
*/
|
|
14
|
+
import type { DesktopReleasesManifest } from './obsidian-version.mjs';
|
|
15
|
+
/**
|
|
16
|
+
* A discovered `obsidian-<version>.asar` file.
|
|
17
|
+
*/
|
|
18
|
+
export interface DiscoveredAsar {
|
|
19
|
+
/** Absolute path to the asar file. */
|
|
20
|
+
readonly path: string;
|
|
21
|
+
/** The `x.y.z` version parsed from the file name. */
|
|
22
|
+
readonly version: string;
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* Copies an asar file into a user-data dir under its canonical
|
|
26
|
+
* `obsidian-<version>.asar` name.
|
|
27
|
+
*
|
|
28
|
+
* @param asarPath - Source asar path.
|
|
29
|
+
* @param version - The asar's version (used for the destination file name).
|
|
30
|
+
* @param userDataDir - Destination user-data dir.
|
|
31
|
+
*/
|
|
32
|
+
export declare function copyAsarIntoUserData(asarPath: string, version: string, userDataDir: string): void;
|
|
33
|
+
/**
|
|
34
|
+
* Ensures the asar for a concrete version is present in the local cache,
|
|
35
|
+
* downloading and decompressing it if necessary.
|
|
36
|
+
*
|
|
37
|
+
* @param version - A concrete `x.y.z` version.
|
|
38
|
+
* @returns The absolute path to the cached asar.
|
|
39
|
+
* @throws Error if the download fails.
|
|
40
|
+
*/
|
|
41
|
+
export declare function ensureAsarCached(version: string): Promise<string>;
|
|
42
|
+
/**
|
|
43
|
+
* Fetches and parses Obsidian's desktop releases manifest.
|
|
44
|
+
*
|
|
45
|
+
* @returns The parsed manifest.
|
|
46
|
+
* @throws Error if the manifest cannot be fetched.
|
|
47
|
+
*/
|
|
48
|
+
export declare function fetchDesktopReleasesManifest(): Promise<DesktopReleasesManifest>;
|
|
49
|
+
/**
|
|
50
|
+
* Finds the newest `obsidian-<version>.asar` in a directory.
|
|
51
|
+
*
|
|
52
|
+
* @param dir - The directory to scan (e.g. the user's Obsidian config dir).
|
|
53
|
+
* @returns The newest discovered asar, or `undefined` if none / the dir is unreadable.
|
|
54
|
+
*/
|
|
55
|
+
export declare function findNewestAsar(dir: string): DiscoveredAsar | undefined;
|
|
56
|
+
/**
|
|
57
|
+
* Resolves a version specifier (explicit or channel alias) to a concrete
|
|
58
|
+
* `x.y.z` version, fetching the manifest only when a channel alias is used.
|
|
59
|
+
*
|
|
60
|
+
* @param spec - The version specifier.
|
|
61
|
+
* @returns The concrete version.
|
|
62
|
+
*/
|
|
63
|
+
export declare function resolveConcreteVersion(spec: string): Promise<string>;
|
|
@@ -0,0 +1,89 @@
|
|
|
1
|
+
import {
|
|
2
|
+
copyFileSync,
|
|
3
|
+
existsSync,
|
|
4
|
+
mkdirSync,
|
|
5
|
+
readdirSync,
|
|
6
|
+
writeFileSync
|
|
7
|
+
} from "node:fs";
|
|
8
|
+
import { tmpdir } from "node:os";
|
|
9
|
+
import { join } from "node:path";
|
|
10
|
+
import { gunzipSync } from "node:zlib";
|
|
11
|
+
import { log } from "./log.mjs";
|
|
12
|
+
import {
|
|
13
|
+
compareVersions,
|
|
14
|
+
DESKTOP_RELEASES_MANIFEST_URL,
|
|
15
|
+
getVersionAsarFileName,
|
|
16
|
+
parseVersionSpec,
|
|
17
|
+
resolveVersionFromManifest
|
|
18
|
+
} from "./obsidian-version.mjs";
|
|
19
|
+
const DOWNLOAD_USER_AGENT = "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.183 Safari/537.36";
|
|
20
|
+
const CACHE_ROOT = join(tmpdir(), "obsidian-integration-testing");
|
|
21
|
+
const ASAR_CACHE_DIR = join(CACHE_ROOT, "asar-cache");
|
|
22
|
+
const ASAR_FILE_PATTERN = /^obsidian-(?<version>\d+\.\d+\.\d+)\.asar$/;
|
|
23
|
+
function copyAsarIntoUserData(asarPath, version, userDataDir) {
|
|
24
|
+
mkdirSync(userDataDir, { recursive: true });
|
|
25
|
+
const dest = join(userDataDir, getVersionAsarFileName(version));
|
|
26
|
+
copyFileSync(asarPath, dest);
|
|
27
|
+
log(`[version-switch] Provisioned ${getVersionAsarFileName(version)} into ${userDataDir}.`);
|
|
28
|
+
}
|
|
29
|
+
async function ensureAsarCached(version) {
|
|
30
|
+
mkdirSync(ASAR_CACHE_DIR, { recursive: true });
|
|
31
|
+
const cachedPath = join(ASAR_CACHE_DIR, getVersionAsarFileName(version));
|
|
32
|
+
if (existsSync(cachedPath)) {
|
|
33
|
+
log(`[version-switch] Using cached asar for ${version}.`);
|
|
34
|
+
return cachedPath;
|
|
35
|
+
}
|
|
36
|
+
const url = `https://releases.obsidian.md/release/${getVersionAsarFileName(version)}.gz`;
|
|
37
|
+
log(`[version-switch] Downloading asar ${version} from ${url} ...`);
|
|
38
|
+
const response = await fetch(url, { headers: { "User-Agent": DOWNLOAD_USER_AGENT } });
|
|
39
|
+
if (!response.ok) {
|
|
40
|
+
throw new Error(`Failed to download Obsidian asar ${version}: HTTP ${String(response.status)} from ${url}`);
|
|
41
|
+
}
|
|
42
|
+
const gz = Buffer.from(await response.arrayBuffer());
|
|
43
|
+
writeFileSync(cachedPath, gunzipSync(gz));
|
|
44
|
+
log(`[version-switch] Cached asar ${version} (${String(gz.length)} bytes compressed) -> ${cachedPath}`);
|
|
45
|
+
return cachedPath;
|
|
46
|
+
}
|
|
47
|
+
async function fetchDesktopReleasesManifest() {
|
|
48
|
+
const response = await fetch(DESKTOP_RELEASES_MANIFEST_URL);
|
|
49
|
+
if (!response.ok) {
|
|
50
|
+
throw new Error(`Failed to fetch desktop releases manifest: HTTP ${String(response.status)}`);
|
|
51
|
+
}
|
|
52
|
+
return await response.json();
|
|
53
|
+
}
|
|
54
|
+
function findNewestAsar(dir) {
|
|
55
|
+
let entries;
|
|
56
|
+
try {
|
|
57
|
+
entries = readdirSync(dir);
|
|
58
|
+
} catch {
|
|
59
|
+
return void 0;
|
|
60
|
+
}
|
|
61
|
+
let newest;
|
|
62
|
+
for (const entry of entries) {
|
|
63
|
+
const match = ASAR_FILE_PATTERN.exec(entry);
|
|
64
|
+
if (!match) {
|
|
65
|
+
continue;
|
|
66
|
+
}
|
|
67
|
+
const version = match.groups?.["version"] ?? "";
|
|
68
|
+
if (!newest || compareVersions(version, newest.version) > 0) {
|
|
69
|
+
newest = { path: join(dir, entry), version };
|
|
70
|
+
}
|
|
71
|
+
}
|
|
72
|
+
return newest;
|
|
73
|
+
}
|
|
74
|
+
async function resolveConcreteVersion(spec) {
|
|
75
|
+
const parsed = parseVersionSpec(spec);
|
|
76
|
+
if (parsed.kind === "explicit") {
|
|
77
|
+
return parsed.version;
|
|
78
|
+
}
|
|
79
|
+
const manifest = await fetchDesktopReleasesManifest();
|
|
80
|
+
return resolveVersionFromManifest(manifest, parsed.channel);
|
|
81
|
+
}
|
|
82
|
+
export {
|
|
83
|
+
copyAsarIntoUserData,
|
|
84
|
+
ensureAsarCached,
|
|
85
|
+
fetchDesktopReleasesManifest,
|
|
86
|
+
findNewestAsar,
|
|
87
|
+
resolveConcreteVersion
|
|
88
|
+
};
|
|
89
|
+
//# sourceMappingURL=data:application/json;base64,{
  "version": 3,
  "sources": ["../../../src/obsidian-version-switch.ts"],
  "sourcesContent": ["/**\n * @file\n *\n * Integration-time helpers for provisioning a specific Obsidian **asar** (the\n * app code) into an isolated user-data dir.\n *\n * Obsidian's bootstrap loads the highest of (its shell's bundled\n * `resources/obsidian.asar`, the `obsidian-<version>.asar` files in the\n * user-data dir). So placing an asar here only takes effect when its version is\n * **>= the shell's bundled version** (upgrade-only \u2014 confirmed by the Phase 0\n * spike). Running an older version requires pinning the installer/shell instead\n * (see `obsidian-installer.ts`).\n */\n\n/* v8 ignore start -- Integration-time download/filesystem glue covered by integration tests, not unit tests. */\n\nimport {\n  copyFileSync,\n  existsSync,\n  mkdirSync,\n  readdirSync,\n  writeFileSync\n} from 'node:fs';\nimport { tmpdir } from 'node:os';\nimport { join } from 'node:path';\nimport { gunzipSync } from 'node:zlib';\n\nimport type { DesktopReleasesManifest } from './obsidian-version.mjs';\n\nimport { log } from './log.mjs';\nimport {\n  compareVersions,\n  DESKTOP_RELEASES_MANIFEST_URL,\n  getVersionAsarFileName,\n  parseVersionSpec,\n  resolveVersionFromManifest\n} from './obsidian-version.mjs';\n\n/**\n * Browser User-Agent required to fetch asar packages from\n * `releases.obsidian.md` (the endpoint is Cloudflare-gated against non-browser\n * clients). Matches the UA documented in the obsidian-versions repo.\n */\nconst DOWNLOAD_USER_AGENT = 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.183 Safari/537.36';\n\nconst CACHE_ROOT = join(tmpdir(), 'obsidian-integration-testing');\nconst ASAR_CACHE_DIR = join(CACHE_ROOT, 'asar-cache');\nconst ASAR_FILE_PATTERN = /^obsidian-(?<version>\\d+\\.\\d+\\.\\d+)\\.asar$/;\n\n/**\n * A discovered `obsidian-<version>.asar` file.\n */\nexport interface DiscoveredAsar {\n  /** Absolute path to the asar file. */\n  readonly path: string;\n\n  /** The `x.y.z` version parsed from the file name. */\n  readonly version: string;\n}\n\n/**\n * Copies an asar file into a user-data dir under its canonical\n * `obsidian-<version>.asar` name.\n *\n * @param asarPath - Source asar path.\n * @param version - The asar's version (used for the destination file name).\n * @param userDataDir - Destination user-data dir.\n */\nexport function copyAsarIntoUserData(asarPath: string, version: string, userDataDir: string): void {\n  mkdirSync(userDataDir, { recursive: true });\n  const dest = join(userDataDir, getVersionAsarFileName(version));\n  copyFileSync(asarPath, dest);\n  log(`[version-switch] Provisioned ${getVersionAsarFileName(version)} into ${userDataDir}.`);\n}\n\n/**\n * Ensures the asar for a concrete version is present in the local cache,\n * downloading and decompressing it if necessary.\n *\n * @param version - A concrete `x.y.z` version.\n * @returns The absolute path to the cached asar.\n * @throws Error if the download fails.\n */\nexport async function ensureAsarCached(version: string): Promise<string> {\n  mkdirSync(ASAR_CACHE_DIR, { recursive: true });\n  const cachedPath = join(ASAR_CACHE_DIR, getVersionAsarFileName(version));\n  if (existsSync(cachedPath)) {\n    log(`[version-switch] Using cached asar for ${version}.`);\n    return cachedPath;\n  }\n\n  const url = `https://releases.obsidian.md/release/${getVersionAsarFileName(version)}.gz`;\n  log(`[version-switch] Downloading asar ${version} from ${url} ...`);\n  const response = await fetch(url, { headers: { 'User-Agent': DOWNLOAD_USER_AGENT } });\n  if (!response.ok) {\n    throw new Error(`Failed to download Obsidian asar ${version}: HTTP ${String(response.status)} from ${url}`);\n  }\n\n  const gz = Buffer.from(await response.arrayBuffer());\n  writeFileSync(cachedPath, gunzipSync(gz));\n  log(`[version-switch] Cached asar ${version} (${String(gz.length)} bytes compressed) -> ${cachedPath}`);\n  return cachedPath;\n}\n\n/**\n * Fetches and parses Obsidian's desktop releases manifest.\n *\n * @returns The parsed manifest.\n * @throws Error if the manifest cannot be fetched.\n */\nexport async function fetchDesktopReleasesManifest(): Promise<DesktopReleasesManifest> {\n  const response = await fetch(DESKTOP_RELEASES_MANIFEST_URL);\n  if (!response.ok) {\n    throw new Error(`Failed to fetch desktop releases manifest: HTTP ${String(response.status)}`);\n  }\n  return await response.json() as DesktopReleasesManifest;\n}\n\n/**\n * Finds the newest `obsidian-<version>.asar` in a directory.\n *\n * @param dir - The directory to scan (e.g. the user's Obsidian config dir).\n * @returns The newest discovered asar, or `undefined` if none / the dir is unreadable.\n */\nexport function findNewestAsar(dir: string): DiscoveredAsar | undefined {\n  let entries: string[];\n  try {\n    entries = readdirSync(dir);\n  } catch {\n    return undefined;\n  }\n\n  let newest: DiscoveredAsar | undefined;\n  for (const entry of entries) {\n    const match = ASAR_FILE_PATTERN.exec(entry);\n    if (!match) {\n      continue;\n    }\n    const version = match.groups?.['version'] ?? '';\n    if (!newest || compareVersions(version, newest.version) > 0) {\n      newest = { path: join(dir, entry), version };\n    }\n  }\n  return newest;\n}\n\n/**\n * Resolves a version specifier (explicit or channel alias) to a concrete\n * `x.y.z` version, fetching the manifest only when a channel alias is used.\n *\n * @param spec - The version specifier.\n * @returns The concrete version.\n */\nexport async function resolveConcreteVersion(spec: string): Promise<string> {\n  const parsed = parseVersionSpec(spec);\n  if (parsed.kind === 'explicit') {\n    return parsed.version;\n  }\n  const manifest = await fetchDesktopReleasesManifest();\n  return resolveVersionFromManifest(manifest, parsed.channel);\n}\n\n/* v8 ignore stop */\n"],
  "mappings": "AAgBA;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AACP,SAAS,cAAc;AACvB,SAAS,YAAY;AACrB,SAAS,kBAAkB;AAI3B,SAAS,WAAW;AACpB;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AAOP,MAAM,sBAAsB;AAE5B,MAAM,aAAa,KAAK,OAAO,GAAG,8BAA8B;AAChE,MAAM,iBAAiB,KAAK,YAAY,YAAY;AACpD,MAAM,oBAAoB;AAqBnB,SAAS,qBAAqB,UAAkB,SAAiB,aAA2B;AACjG,YAAU,aAAa,EAAE,WAAW,KAAK,CAAC;AAC1C,QAAM,OAAO,KAAK,aAAa,uBAAuB,OAAO,CAAC;AAC9D,eAAa,UAAU,IAAI;AAC3B,MAAI,gCAAgC,uBAAuB,OAAO,CAAC,SAAS,WAAW,GAAG;AAC5F;AAUA,eAAsB,iBAAiB,SAAkC;AACvE,YAAU,gBAAgB,EAAE,WAAW,KAAK,CAAC;AAC7C,QAAM,aAAa,KAAK,gBAAgB,uBAAuB,OAAO,CAAC;AACvE,MAAI,WAAW,UAAU,GAAG;AAC1B,QAAI,0CAA0C,OAAO,GAAG;AACxD,WAAO;AAAA,EACT;AAEA,QAAM,MAAM,wCAAwC,uBAAuB,OAAO,CAAC;AACnF,MAAI,qCAAqC,OAAO,SAAS,GAAG,MAAM;AAClE,QAAM,WAAW,MAAM,MAAM,KAAK,EAAE,SAAS,EAAE,cAAc,oBAAoB,EAAE,CAAC;AACpF,MAAI,CAAC,SAAS,IAAI;AAChB,UAAM,IAAI,MAAM,oCAAoC,OAAO,UAAU,OAAO,SAAS,MAAM,CAAC,SAAS,GAAG,EAAE;AAAA,EAC5G;AAEA,QAAM,KAAK,OAAO,KAAK,MAAM,SAAS,YAAY,CAAC;AACnD,gBAAc,YAAY,WAAW,EAAE,CAAC;AACxC,MAAI,gCAAgC,OAAO,KAAK,OAAO,GAAG,MAAM,CAAC,yBAAyB,UAAU,EAAE;AACtG,SAAO;AACT;AAQA,eAAsB,+BAAiE;AACrF,QAAM,WAAW,MAAM,MAAM,6BAA6B;AAC1D,MAAI,CAAC,SAAS,IAAI;AAChB,UAAM,IAAI,MAAM,mDAAmD,OAAO,SAAS,MAAM,CAAC,EAAE;AAAA,EAC9F;AACA,SAAO,MAAM,SAAS,KAAK;AAC7B;AAQO,SAAS,eAAe,KAAyC;AACtE,MAAI;AACJ,MAAI;AACF,cAAU,YAAY,GAAG;AAAA,EAC3B,QAAQ;AACN,WAAO;AAAA,EACT;AAEA,MAAI;AACJ,aAAW,SAAS,SAAS;AAC3B,UAAM,QAAQ,kBAAkB,KAAK,KAAK;AAC1C,QAAI,CAAC,OAAO;AACV;AAAA,IACF;AACA,UAAM,UAAU,MAAM,SAAS,SAAS,KAAK;AAC7C,QAAI,CAAC,UAAU,gBAAgB,SAAS,OAAO,OAAO,IAAI,GAAG;AAC3D,eAAS,EAAE,MAAM,KAAK,KAAK,KAAK,GAAG,QAAQ;AAAA,IAC7C;AAAA,EACF;AACA,SAAO;AACT;AASA,eAAsB,uBAAuB,MAA+B;AAC1E,QAAM,SAAS,iBAAiB,IAAI;AACpC,MAAI,OAAO,SAAS,YAAY;AAC9B,WAAO,OAAO;AAAA,EAChB;AACA,QAAM,WAAW,MAAM,6BAA6B;AACpD,SAAO,2BAA2B,UAAU,OAAO,OAAO;AAC5D;",
  "names": []
}

|
|
@@ -0,0 +1,111 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @file
|
|
3
|
+
*
|
|
4
|
+
* Pure helpers for resolving Obsidian desktop version specifiers.
|
|
5
|
+
*
|
|
6
|
+
* A version specifier is either an explicit `x.y.z` string or one of the
|
|
7
|
+
* channel aliases {@link PUBLIC_LATEST} / {@link CATALYST_LATEST}, which resolve
|
|
8
|
+
* against Obsidian's published desktop releases manifest.
|
|
9
|
+
*
|
|
10
|
+
* The network call that fetches the manifest lives in the integration-time
|
|
11
|
+
* version-switch module; everything here is pure and unit-tested.
|
|
12
|
+
*/
|
|
13
|
+
/**
|
|
14
|
+
* Version specifier alias resolving to the latest **public** desktop release
|
|
15
|
+
* (the manifest's `latestVersion`).
|
|
16
|
+
*/
|
|
17
|
+
export declare const PUBLIC_LATEST = "public-latest";
|
|
18
|
+
/**
|
|
19
|
+
* Version specifier alias resolving to the latest **catalyst** (early access /
|
|
20
|
+
* insider) desktop release (the manifest's `beta.latestVersion`).
|
|
21
|
+
*/
|
|
22
|
+
export declare const CATALYST_LATEST = "catalyst-latest";
|
|
23
|
+
/**
|
|
24
|
+
* URL of Obsidian's desktop releases manifest (raw JSON).
|
|
25
|
+
*/
|
|
26
|
+
export declare const DESKTOP_RELEASES_MANIFEST_URL = "https://raw.githubusercontent.com/obsidianmd/obsidian-releases/master/desktop-releases.json";
|
|
27
|
+
/**
|
|
28
|
+
* A version specifier resolved against a release channel.
|
|
29
|
+
*/
|
|
30
|
+
export interface ChannelVersionSpec {
|
|
31
|
+
/** The channel to resolve against the manifest. */
|
|
32
|
+
readonly channel: ReleaseChannel;
|
|
33
|
+
/** Discriminant. */
|
|
34
|
+
readonly kind: 'channel';
|
|
35
|
+
}
|
|
36
|
+
/**
|
|
37
|
+
* The `beta` (catalyst) entry of {@link DesktopReleasesManifest}.
|
|
38
|
+
*/
|
|
39
|
+
export interface DesktopReleasesBeta {
|
|
40
|
+
/** The latest catalyst version, e.g. `'1.13.1'`. */
|
|
41
|
+
readonly latestVersion: string;
|
|
42
|
+
}
|
|
43
|
+
/**
|
|
44
|
+
* The subset of Obsidian's `desktop-releases.json` this library reads.
|
|
45
|
+
*/
|
|
46
|
+
export interface DesktopReleasesManifest {
|
|
47
|
+
/**
|
|
48
|
+
* The latest catalyst (early access / insider) release, when present.
|
|
49
|
+
*/
|
|
50
|
+
readonly beta?: DesktopReleasesBeta;
|
|
51
|
+
/**
|
|
52
|
+
* The latest public (stable) version, e.g. `'1.12.7'`.
|
|
53
|
+
*/
|
|
54
|
+
readonly latestVersion: string;
|
|
55
|
+
}
|
|
56
|
+
/**
|
|
57
|
+
* A version specifier naming a concrete `x.y.z` version.
|
|
58
|
+
*/
|
|
59
|
+
export interface ExplicitVersionSpec {
|
|
60
|
+
/** Discriminant. */
|
|
61
|
+
readonly kind: 'explicit';
|
|
62
|
+
/** The concrete `x.y.z` version. */
|
|
63
|
+
readonly version: string;
|
|
64
|
+
}
|
|
65
|
+
/**
|
|
66
|
+
* A release channel resolved from a channel-alias specifier.
|
|
67
|
+
*
|
|
68
|
+
* - `public` — the latest stable release.
|
|
69
|
+
* - `catalyst` — the latest early access / insider release.
|
|
70
|
+
*/
|
|
71
|
+
export type ReleaseChannel = 'catalyst' | 'public';
|
|
72
|
+
/**
|
|
73
|
+
* The parsed form of a version specifier.
|
|
74
|
+
*
|
|
75
|
+
* - `explicit` — a concrete `x.y.z` version.
|
|
76
|
+
* - `channel` — a channel alias to be resolved against the manifest.
|
|
77
|
+
*/
|
|
78
|
+
export type VersionSpec = ChannelVersionSpec | ExplicitVersionSpec;
|
|
79
|
+
/**
|
|
80
|
+
* Compares two `x.y.z` version strings numerically, segment by segment.
|
|
81
|
+
*
|
|
82
|
+
* @param a - The first version.
|
|
83
|
+
* @param b - The second version.
|
|
84
|
+
* @returns A negative number if `a < b`, `0` if equal, a positive number if `a > b`.
|
|
85
|
+
*/
|
|
86
|
+
export declare function compareVersions(a: string, b: string): number;
|
|
87
|
+
/**
|
|
88
|
+
* Returns the user-data asar file name for a given version, matching the name
|
|
89
|
+
* Obsidian itself uses when it downloads an update (`obsidian-<version>.asar`).
|
|
90
|
+
*
|
|
91
|
+
* @param version - A concrete `x.y.z` version.
|
|
92
|
+
* @returns The asar file name.
|
|
93
|
+
*/
|
|
94
|
+
export declare function getVersionAsarFileName(version: string): string;
|
|
95
|
+
/**
|
|
96
|
+
* Parses a version specifier into either an explicit version or a channel alias.
|
|
97
|
+
*
|
|
98
|
+
* @param spec - The specifier: an `x.y.z` string, {@link PUBLIC_LATEST}, or {@link CATALYST_LATEST}.
|
|
99
|
+
* @returns The parsed {@link VersionSpec}.
|
|
100
|
+
* @throws Error if the specifier is neither a valid `x.y.z` version nor a known alias.
|
|
101
|
+
*/
|
|
102
|
+
export declare function parseVersionSpec(spec: string): VersionSpec;
|
|
103
|
+
/**
|
|
104
|
+
* Resolves a channel to a concrete version using a desktop releases manifest.
|
|
105
|
+
*
|
|
106
|
+
* @param manifest - The parsed manifest.
|
|
107
|
+
* @param channel - The channel to resolve.
|
|
108
|
+
* @returns The concrete `x.y.z` version for the channel.
|
|
109
|
+
* @throws Error if the catalyst channel is requested but the manifest has no `beta` entry.
|
|
110
|
+
*/
|
|
111
|
+
export declare function resolveVersionFromManifest(manifest: DesktopReleasesManifest, channel: ReleaseChannel): string;
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
const PUBLIC_LATEST = "public-latest";
|
|
2
|
+
const CATALYST_LATEST = "catalyst-latest";
|
|
3
|
+
const DESKTOP_RELEASES_MANIFEST_URL = "https://raw.githubusercontent.com/obsidianmd/obsidian-releases/master/desktop-releases.json";
|
|
4
|
+
const EXPLICIT_VERSION_PATTERN = /^\d+\.\d+\.\d+$/;
|
|
5
|
+
const VERSION_SEGMENT_COUNT = 3;
|
|
6
|
+
function compareVersions(a, b) {
|
|
7
|
+
const aSegments = parseVersionSegments(a);
|
|
8
|
+
const bSegments = parseVersionSegments(b);
|
|
9
|
+
for (let i = 0; i < VERSION_SEGMENT_COUNT; i++) {
|
|
10
|
+
const diff = (aSegments[i] ?? 0) - (bSegments[i] ?? 0);
|
|
11
|
+
if (diff !== 0) {
|
|
12
|
+
return diff;
|
|
13
|
+
}
|
|
14
|
+
}
|
|
15
|
+
return 0;
|
|
16
|
+
}
|
|
17
|
+
function getVersionAsarFileName(version) {
|
|
18
|
+
return `obsidian-${version}.asar`;
|
|
19
|
+
}
|
|
20
|
+
function parseVersionSpec(spec) {
|
|
21
|
+
if (spec === PUBLIC_LATEST) {
|
|
22
|
+
return { channel: "public", kind: "channel" };
|
|
23
|
+
}
|
|
24
|
+
if (spec === CATALYST_LATEST) {
|
|
25
|
+
return { channel: "catalyst", kind: "channel" };
|
|
26
|
+
}
|
|
27
|
+
if (EXPLICIT_VERSION_PATTERN.test(spec)) {
|
|
28
|
+
return { kind: "explicit", version: spec };
|
|
29
|
+
}
|
|
30
|
+
throw new Error(
|
|
31
|
+
`Invalid Obsidian version "${spec}". Expected an "x.y.z" version, "${PUBLIC_LATEST}", or "${CATALYST_LATEST}".`
|
|
32
|
+
);
|
|
33
|
+
}
|
|
34
|
+
function resolveVersionFromManifest(manifest, channel) {
|
|
35
|
+
if (channel === "public") {
|
|
36
|
+
return manifest.latestVersion;
|
|
37
|
+
}
|
|
38
|
+
if (!manifest.beta) {
|
|
39
|
+
throw new Error("Desktop releases manifest has no catalyst (beta) release.");
|
|
40
|
+
}
|
|
41
|
+
return manifest.beta.latestVersion;
|
|
42
|
+
}
|
|
43
|
+
function parseVersionSegments(version) {
|
|
44
|
+
return version.split(".").map((segment) => Number.parseInt(segment, 10));
|
|
45
|
+
}
|
|
46
|
+
export {
|
|
47
|
+
CATALYST_LATEST,
|
|
48
|
+
DESKTOP_RELEASES_MANIFEST_URL,
|
|
49
|
+
PUBLIC_LATEST,
|
|
50
|
+
compareVersions,
|
|
51
|
+
getVersionAsarFileName,
|
|
52
|
+
parseVersionSpec,
|
|
53
|
+
resolveVersionFromManifest
|
|
54
|
+
};
|
|
55
|
+
//# sourceMappingURL=data:application/json;base64,{
  "version": 3,
  "sources": ["../../../src/obsidian-version.ts"],
  "sourcesContent": ["/**\n * @file\n *\n * Pure helpers for resolving Obsidian desktop version specifiers.\n *\n * A version specifier is either an explicit `x.y.z` string or one of the\n * channel aliases {@link PUBLIC_LATEST} / {@link CATALYST_LATEST}, which resolve\n * against Obsidian's published desktop releases manifest.\n *\n * The network call that fetches the manifest lives in the integration-time\n * version-switch module; everything here is pure and unit-tested.\n */\n\n/**\n * Version specifier alias resolving to the latest **public** desktop release\n * (the manifest's `latestVersion`).\n */\nexport const PUBLIC_LATEST = 'public-latest';\n\n/**\n * Version specifier alias resolving to the latest **catalyst** (early access /\n * insider) desktop release (the manifest's `beta.latestVersion`).\n */\nexport const CATALYST_LATEST = 'catalyst-latest';\n\n/**\n * URL of Obsidian's desktop releases manifest (raw JSON).\n */\nexport const DESKTOP_RELEASES_MANIFEST_URL = 'https://raw.githubusercontent.com/obsidianmd/obsidian-releases/master/desktop-releases.json';\n\nconst EXPLICIT_VERSION_PATTERN = /^\\d+\\.\\d+\\.\\d+$/;\nconst VERSION_SEGMENT_COUNT = 3;\n\n/**\n * A version specifier resolved against a release channel.\n */\nexport interface ChannelVersionSpec {\n  /** The channel to resolve against the manifest. */\n  readonly channel: ReleaseChannel;\n\n  /** Discriminant. */\n  readonly kind: 'channel';\n}\n\n/**\n * The `beta` (catalyst) entry of {@link DesktopReleasesManifest}.\n */\nexport interface DesktopReleasesBeta {\n  /** The latest catalyst version, e.g. `'1.13.1'`. */\n  readonly latestVersion: string;\n}\n\n/**\n * The subset of Obsidian's `desktop-releases.json` this library reads.\n */\nexport interface DesktopReleasesManifest {\n  /**\n   * The latest catalyst (early access / insider) release, when present.\n   */\n  readonly beta?: DesktopReleasesBeta;\n\n  /**\n   * The latest public (stable) version, e.g. `'1.12.7'`.\n   */\n  readonly latestVersion: string;\n}\n\n/**\n * A version specifier naming a concrete `x.y.z` version.\n */\nexport interface ExplicitVersionSpec {\n  /** Discriminant. */\n  readonly kind: 'explicit';\n\n  /** The concrete `x.y.z` version. */\n  readonly version: string;\n}\n\n/**\n * A release channel resolved from a channel-alias specifier.\n *\n * - `public` \u2014 the latest stable release.\n * - `catalyst` \u2014 the latest early access / insider release.\n */\nexport type ReleaseChannel = 'catalyst' | 'public';\n\n/**\n * The parsed form of a version specifier.\n *\n * - `explicit` \u2014 a concrete `x.y.z` version.\n * - `channel` \u2014 a channel alias to be resolved against the manifest.\n */\nexport type VersionSpec = ChannelVersionSpec | ExplicitVersionSpec;\n\n/**\n * Compares two `x.y.z` version strings numerically, segment by segment.\n *\n * @param a - The first version.\n * @param b - The second version.\n * @returns A negative number if `a < b`, `0` if equal, a positive number if `a > b`.\n */\nexport function compareVersions(a: string, b: string): number {\n  const aSegments = parseVersionSegments(a);\n  const bSegments = parseVersionSegments(b);\n\n  for (let i = 0; i < VERSION_SEGMENT_COUNT; i++) {\n    const diff = (aSegments[i] ?? 0) - (bSegments[i] ?? 0);\n    if (diff !== 0) {\n      return diff;\n    }\n  }\n\n  return 0;\n}\n\n/**\n * Returns the user-data asar file name for a given version, matching the name\n * Obsidian itself uses when it downloads an update (`obsidian-<version>.asar`).\n *\n * @param version - A concrete `x.y.z` version.\n * @returns The asar file name.\n */\nexport function getVersionAsarFileName(version: string): string {\n  return `obsidian-${version}.asar`;\n}\n\n/**\n * Parses a version specifier into either an explicit version or a channel alias.\n *\n * @param spec - The specifier: an `x.y.z` string, {@link PUBLIC_LATEST}, or {@link CATALYST_LATEST}.\n * @returns The parsed {@link VersionSpec}.\n * @throws Error if the specifier is neither a valid `x.y.z` version nor a known alias.\n */\nexport function parseVersionSpec(spec: string): VersionSpec {\n  if (spec === PUBLIC_LATEST) {\n    return { channel: 'public', kind: 'channel' };\n  }\n\n  if (spec === CATALYST_LATEST) {\n    return { channel: 'catalyst', kind: 'channel' };\n  }\n\n  if (EXPLICIT_VERSION_PATTERN.test(spec)) {\n    return { kind: 'explicit', version: spec };\n  }\n\n  throw new Error(\n    `Invalid Obsidian version \"${spec}\". Expected an \"x.y.z\" version, \"${PUBLIC_LATEST}\", or \"${CATALYST_LATEST}\".`\n  );\n}\n\n/**\n * Resolves a channel to a concrete version using a desktop releases manifest.\n *\n * @param manifest - The parsed manifest.\n * @param channel - The channel to resolve.\n * @returns The concrete `x.y.z` version for the channel.\n * @throws Error if the catalyst channel is requested but the manifest has no `beta` entry.\n */\nexport function resolveVersionFromManifest(manifest: DesktopReleasesManifest, channel: ReleaseChannel): string {\n  if (channel === 'public') {\n    return manifest.latestVersion;\n  }\n\n  if (!manifest.beta) {\n    throw new Error('Desktop releases manifest has no catalyst (beta) release.');\n  }\n\n  return manifest.beta.latestVersion;\n}\n\n/**\n * Splits an `x.y.z` version into its numeric segments.\n *\n * @param version - The version string.\n * @returns The numeric segments.\n */\nfunction parseVersionSegments(version: string): number[] {\n  return version.split('.').map((segment) => Number.parseInt(segment, 10));\n}\n"],
  "mappings": "AAiBO,MAAM,gBAAgB;AAMtB,MAAM,kBAAkB;AAKxB,MAAM,gCAAgC;AAE7C,MAAM,2BAA2B;AACjC,MAAM,wBAAwB;AAsEvB,SAAS,gBAAgB,GAAW,GAAmB;AAC5D,QAAM,YAAY,qBAAqB,CAAC;AACxC,QAAM,YAAY,qBAAqB,CAAC;AAExC,WAAS,IAAI,GAAG,IAAI,uBAAuB,KAAK;AAC9C,UAAM,QAAQ,UAAU,CAAC,KAAK,MAAM,UAAU,CAAC,KAAK;AACpD,QAAI,SAAS,GAAG;AACd,aAAO;AAAA,IACT;AAAA,EACF;AAEA,SAAO;AACT;AASO,SAAS,uBAAuB,SAAyB;AAC9D,SAAO,YAAY,OAAO;AAC5B;AASO,SAAS,iBAAiB,MAA2B;AAC1D,MAAI,SAAS,eAAe;AAC1B,WAAO,EAAE,SAAS,UAAU,MAAM,UAAU;AAAA,EAC9C;AAEA,MAAI,SAAS,iBAAiB;AAC5B,WAAO,EAAE,SAAS,YAAY,MAAM,UAAU;AAAA,EAChD;AAEA,MAAI,yBAAyB,KAAK,IAAI,GAAG;AACvC,WAAO,EAAE,MAAM,YAAY,SAAS,KAAK;AAAA,EAC3C;AAEA,QAAM,IAAI;AAAA,IACR,6BAA6B,IAAI,oCAAoC,aAAa,UAAU,eAAe;AAAA,EAC7G;AACF;AAUO,SAAS,2BAA2B,UAAmC,SAAiC;AAC7G,MAAI,YAAY,UAAU;AACxB,WAAO,SAAS;AAAA,EAClB;AAEA,MAAI,CAAC,SAAS,MAAM;AAClB,UAAM,IAAI,MAAM,2DAA2D;AAAA,EAC7E;AAEA,SAAO,SAAS,KAAK;AACvB;AAQA,SAAS,qBAAqB,SAA2B;AACvD,SAAO,QAAQ,MAAM,GAAG,EAAE,IAAI,CAAC,YAAY,OAAO,SAAS,SAAS,EAAE,CAAC;AACzE;",
  "names": []
}

|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @file
|
|
3
|
+
*
|
|
4
|
+
* Cross-process advisory lock that serializes whole integration-test runs.
|
|
5
|
+
*
|
|
6
|
+
* Two test runs that drive the same shared resources corrupt each other: on
|
|
7
|
+
* desktop they share the single local Obsidian instance, its `obsidian.json`
|
|
8
|
+
* registry, and the CDP port; on Android they share the emulator and the Appium
|
|
9
|
+
* server. One run's setup/teardown kills or reconfigures the instance the other
|
|
10
|
+
* run is mid-eval on (observed as `ECONNREFUSED` or "vault not open"), so both
|
|
11
|
+
* runs fail.
|
|
12
|
+
*
|
|
13
|
+
* This lock makes the second run **wait** for the first to finish instead of
|
|
14
|
+
* running concurrently. It is held for the entire run: acquired at the start of
|
|
15
|
+
* the core setup and released by the core teardown (and by the process cleanup
|
|
16
|
+
* handlers). The lock is a sentinel file in a shared temp directory, carrying
|
|
17
|
+
* the holder's PID so a run that crashed without releasing leaves a lock that
|
|
18
|
+
* the next run detects as stale and steals.
|
|
19
|
+
*/
|
|
20
|
+
/**
|
|
21
|
+
* Parameters for {@link acquireSetupLock}.
|
|
22
|
+
*/
|
|
23
|
+
export interface AcquireSetupLockParams {
|
|
24
|
+
/** Short transport label for log messages (e.g. `"obsidian-cli"`). */
|
|
25
|
+
readonly label: string;
|
|
26
|
+
/**
|
|
27
|
+
* Logical scope the lock serializes within. Runs that share resources must
|
|
28
|
+
* use the same scope (e.g. `"desktop"` for the CLI/CDP transports, `"android"`
|
|
29
|
+
* for the Appium transport).
|
|
30
|
+
*/
|
|
31
|
+
readonly scope: string;
|
|
32
|
+
/**
|
|
33
|
+
* Maximum time to wait for a competing run to release the lock before giving
|
|
34
|
+
* up and throwing.
|
|
35
|
+
*
|
|
36
|
+
* @default 1 hour
|
|
37
|
+
*/
|
|
38
|
+
readonly timeoutInMilliseconds?: number | undefined;
|
|
39
|
+
}
|
|
40
|
+
/**
|
|
41
|
+
* A held setup lock. Release it once the run's teardown is complete.
|
|
42
|
+
*/
|
|
43
|
+
export interface SetupLock {
|
|
44
|
+
/** Releases the lock. Safe to call more than once. */
|
|
45
|
+
release(): void;
|
|
46
|
+
}
|
|
47
|
+
/**
|
|
48
|
+
* Acquires the cross-process setup lock for the given scope, waiting until any
|
|
49
|
+
* competing run releases it (or its lock is detected as stale).
|
|
50
|
+
*
|
|
51
|
+
* @param params - The lock parameters.
|
|
52
|
+
* @returns A handle whose {@link SetupLock.release} frees the lock.
|
|
53
|
+
* @throws If the lock cannot be acquired within `timeoutInMilliseconds`.
|
|
54
|
+
*/
|
|
55
|
+
export declare function acquireSetupLock(params: AcquireSetupLockParams): Promise<SetupLock>;
|