obsidian-testing-framework 0.1.8 → 0.2.0

package/lib/electron-singleton.d.ts

@@ -0,0 +1,2 @@
+import type { ElectronApplication } from "playwright";
+export declare function getOrCreateApp(obsidianPath: string, uriArg?: string): Promise<ElectronApplication>;

package/lib/electron-singleton.js

@@ -0,0 +1,17 @@
+import { _electron as electron } from "playwright";
+import { addConsoleListener } from "./internal-util";
+const singleton = {
+    app: null,
+};
+export async function getOrCreateApp(obsidianPath, uriArg) {
+    if (singleton.app) {
+        return singleton.app;
+    }
+    const app = await electron.launch({
+        timeout: 60000,
+        args: [obsidianPath, uriArg].filter((a) => !!a),
+    });
+    addConsoleListener(app);
+    singleton.app = app;
+    return app;
+}

package/lib/index.d.ts

@@ -1,8 +1,8 @@
 export interface ObsidianTestingConfig {
     vault?: string;
     obsidianPath?: string;
+    experimentalUseSingleton?: boolean;
 }
-export declare function getExe(obsidianPath?: string): string;
 export declare const test: import("vitest").TestAPI<{
     page: import("playwright-core").Page;
     obsidian: ObsidianTestingConfig;

package/lib/index.js

@@ -4,38 +4,8 @@ import path from "path";
 import { existsSync, mkdirSync, readFileSync, writeFileSync } from "fs";
 import { pageUtils, waitForIndexingComplete } from "./util.js";
 import { randomBytes } from "crypto";
-export function getExe(obsidianPath) {
-    checkToy();
-    if (obsidianPath) {
-        return path.join(obsidianPath, "Resources", "app.asar");
-    }
-    if (process.platform == "win32") {
-        const p = path.join(process.env.LOCALAPPDATA, "Obsidian", "Resources", "app.asar");
-        if (existsSync(p)) {
-            return p;
-        }
-    }
-    const possibleDirs = [
-        "/opt/Obsidian",
-        "/usr/lib/Obsidian",
-        "/opt/obsidian",
-        "/usr/lib/obsidian",
-        "/var/lib/flatpak/app/md.obsidian.Obsidian/current/active/files",
-        "/snap/obsidian/current",
-    ];
-    for (let i = 0; i < possibleDirs.length; i++) {
-        if (existsSync(possibleDirs[i])) {
-            // console.log(execSync(`ls -l ${possibleDirs[i]}`).toString());
-            return path.join(possibleDirs[i], "resources", "app.asar");
-        }
-    }
-    return "";
-}
-function checkToy() {
-    if (process.platform == "darwin") {
-        throw new Error("use a non-toy operating system, dumbass");
-    }
-}
+import { addConsoleListener, checkToy, getExe } from "./internal-util.js";
+import { getOrCreateApp } from "./electron-singleton.js";
 function generateVaultConfig(vault) {
     const vaultHash = randomBytes(8).toString("hex").toLocaleLowerCase();
     let configLocation;
@@ -66,13 +36,15 @@ function generateVaultConfig(vault) {
         return vaultHash;
     }
     else {
-        return Object.entries(json.vaults).find(a => a[1].path === vault)[0];
+        return Object.entries(json.vaults).find((a) => a[1].path === vault)[0];
     }
 }
 // @ts-ignore some error about a string type now having `undefined` as part of it's union
 export const test = base.extend({
     electronApp: [
-        async ({ obsidian: { obsidianPath } }, run) => {
+        async ({ obsidian }, run) => {
+            console.log("obsidian", obsidian);
+            const { obsidianPath = undefined, experimentalUseSingleton = false } = obsidian ?? {};
             const vault = inject("vault");
             process.env.ELECTRON_DISABLE_SECURITY_WARNINGS = "true";
             console.log("asar located at:", getExe(obsidianPath));
@@ -83,17 +55,20 @@ export const test = base.extend({
                     uriArg = `obsidian://open?vault=${encodeURIComponent(id)}`;
                 }
             }
-            const electronApp = await electron.launch({
-                timeout: 60000,
-                args: [getExe(obsidianPath), uriArg].filter((a) => !!a),
-            });
-            electronApp.on("console", async (msg) => {
-                console.log(...(await Promise.all(msg.args().map((a) => a.jsonValue()))));
-            });
+            const electronApp = experimentalUseSingleton
+                ? await getOrCreateApp(getExe(obsidianPath), !!uriArg ? uriArg : undefined)
+                : await electron.launch({
+                    timeout: 60000,
+                    args: [getExe(obsidianPath), uriArg].filter((a) => !!a),
+                });
+            addConsoleListener(electronApp);
             await electronApp.firstWindow();
             await run(electronApp);
-            await electronApp.close();
-        }, { auto: true }
+            if (!experimentalUseSingleton) {
+                await electronApp.close();
+            }
+        },
+        { auto: true },
     ],
     page: [
         async ({ electronApp }, run) => {
@@ -110,7 +85,7 @@ export const test = base.extend({
             for (let fn of Object.entries(pageUtils)) {
                 await page.exposeFunction(fn[0], fn[1]);
             }
-            page.on("pageerror", exc => {
+            page.on("pageerror", (exc) => {
                 console.error("EXCEPTION");
                 console.error(exc);
             });
@@ -118,6 +93,7 @@ export const test = base.extend({
                 console.log(...(await Promise.all(msg.args().map((a) => a.jsonValue()))));
             });
             await run(page);
-        }, { auto: true }
+        },
+        { auto: true },
     ],
 });

package/lib/internal-util.d.ts

@@ -0,0 +1,4 @@
+import { ElectronApplication } from "playwright";
+export declare function checkToy(): void;
+export declare function getExe(obsidianPath?: string): string;
+export declare function addConsoleListener(app: ElectronApplication): void;

package/lib/internal-util.js

@@ -0,0 +1,39 @@
+import path from "path";
+import { existsSync } from "fs";
+export function checkToy() {
+    if (process.platform == "darwin") {
+        throw new Error("use a non-toy operating system, dumbass");
+    }
+}
+export function getExe(obsidianPath) {
+    checkToy();
+    if (obsidianPath) {
+        return path.join(obsidianPath, "Resources", "app.asar");
+    }
+    if (process.platform == "win32") {
+        const p = path.join(process.env.LOCALAPPDATA, "Obsidian", "Resources", "app.asar");
+        if (existsSync(p)) {
+            return p;
+        }
+    }
+    const possibleDirs = [
+        "/opt/Obsidian",
+        "/usr/lib/Obsidian",
+        "/opt/obsidian",
+        "/usr/lib/obsidian",
+        "/var/lib/flatpak/app/md.obsidian.Obsidian/current/active/files",
+        "/snap/obsidian/current",
+    ];
+    for (let i = 0; i < possibleDirs.length; i++) {
+        if (existsSync(possibleDirs[i])) {
+            // console.log(execSync(`ls -l ${possibleDirs[i]}`).toString());
+            return path.join(possibleDirs[i], "resources", "app.asar");
+        }
+    }
+    return "";
+}
+export function addConsoleListener(app) {
+    app.on("console", async (msg) => {
+        console.log(...(await Promise.all(msg.args().map((a) => a.jsonValue()))));
+    });
+}

package/package.json

@@ -1,15 +1,16 @@
 {
   "name": "obsidian-testing-framework",
   "packageManager": "yarn@4.5.1",
+  "type": "module",
   "dependencies": {
     "@codemirror/language": "https://github.com/lishid/cm-language",
     "@codemirror/state": "^6.0.1",
     "@codemirror/view": "^6.0.1",
-    "@playwright/test": "^1.48.1",
+    "@playwright/test": "^1.58.2",
     "asar": "^3.2.0",
     "electron": "^33.0.2",
     "obsidian": "latest",
-    "playwright": "^1.48.1",
+    "playwright": "^1.58.2",
     "tmp": "^0.2.3",
     "typescript": "^5.6.3",
     "xvfb-maybe": "^0.2.1"
@@ -18,8 +19,13 @@
     "./lib",
     "../../README.md"
   ],
+  "exports": {
+    "./fixture": "./lib/fixtures.js",
+    "./util": "./lib/util.js",
+    ".": "./lib/index.js"
+  },
   "readme": "",
-  "version": "0.1.8",
+  "version": "0.2.0",
   "main": "./lib/index.js",
   "typings": "./lib/index.d.ts",
   "repository": {
@@ -29,11 +35,12 @@
   "scripts": {
     "build": "tsc",
     "lint": "tslint -c tslint.json src/**/*.ts",
-    "prepublishOnly": "pwsh -command 'rm README.md; cp ../../README.md . && rimraf lib && npm run build'"
+    "prepublishOnly": "pwsh -command 'rm README.md; cp ../../README.md . && rimraf lib && npm run build'",
+    "prepare": "yarn run build"
   },
   "devDependencies": {
     "@types/tmp": "^0",
     "rimraf": "^6.0.1",
-    "vitest": "^2.1.4"
+    "vitest": "^4.0.18"
   }
 }