@empiricalrun/playwright-utils 0.33.0 → 0.34.1

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @empiricalrun/playwright-utils
 
+## 0.34.1
+
+### Patch Changes
+
+- 510c376: fix: get or create behavior in postgres client
+
+## 0.34.0
+
+### Minor Changes
+
+- 88dd018: feat: proxy endpoint for neon db on dash
+
 ## 0.33.0
 
 ### Minor Changes

package/README.md

@@ -13,6 +13,8 @@ Playwright utils for test code repos of our customers
   - Captcha
 - [Email automation](./docs/email.md)
 - [Authentication](./docs/auth.md)
+- [KV Store](./docs/kv.md)
+- [Postgres](./docs/postgres.md)
 
 ## Development
 

package/dist/index.d.ts

@@ -5,4 +5,5 @@ export { baseConfig, chromeStablePath, devices } from "./config";
 export * from "./email";
 export * from "./kv";
 export * from "./playwright-extensions";
+export * from "./postgres";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,QAAQ,CAAC;AACvB,cAAc,eAAe,CAAC;AAC9B,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAC3C,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AACjE,cAAc,SAAS,CAAC;AACxB,cAAc,MAAM,CAAC;AACrB,cAAc,yBAAyB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,QAAQ,CAAC;AACvB,cAAc,eAAe,CAAC;AAC9B,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAC3C,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AACjE,cAAc,SAAS,CAAC;AACxB,cAAc,MAAM,CAAC;AACrB,cAAc,yBAAyB,CAAC;AACxC,cAAc,YAAY,CAAC"}

package/dist/index.js

@@ -26,3 +26,4 @@ Object.defineProperty(exports, "devices", { enumerable: true, get: function () {
 __exportStar(require("./email"), exports);
 __exportStar(require("./kv"), exports);
 __exportStar(require("./playwright-extensions"), exports);
+__exportStar(require("./postgres"), exports);

package/dist/postgres.d.ts

@@ -0,0 +1,22 @@
+export type PostgresDatabase = {
+    projectId: string;
+    connectionUri: string;
+};
+type GetOptions = {
+    pgVersion?: number;
+};
+export declare class PostgresClient {
+    private client;
+    constructor();
+    get(name: string, options?: GetOptions): Promise<PostgresDatabase>;
+    private getConnectionUri;
+    delete(projectId: string): Promise<void>;
+    query<T = Record<string, unknown>>(connectionUri: string, sql: string): Promise<T[]>;
+    execute(connectionUri: string, sql: string): Promise<{
+        statement: string;
+        rowCount: number;
+    }[]>;
+    private parseStatements;
+}
+export {};
+//# sourceMappingURL=postgres.d.ts.map

package/dist/postgres.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"postgres.d.ts","sourceRoot":"","sources":["../src/postgres.ts"],"names":[],"mappings":"AAgDA,MAAM,MAAM,gBAAgB,GAAG;IAC7B,SAAS,EAAE,MAAM,CAAC;IAClB,aAAa,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF,KAAK,UAAU,GAAG;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,qBAAa,cAAc;IACzB,OAAO,CAAC,MAAM,CAAqB;;IAW7B,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,gBAAgB,CAAC;YAqD1D,gBAAgB;IAwBxB,MAAM,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAiBxC,KAAK,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACrC,aAAa,EAAE,MAAM,EACrB,GAAG,EAAE,MAAM,GACV,OAAO,CAAC,CAAC,EAAE,CAAC;IAWT,OAAO,CACX,aAAa,EAAE,MAAM,EACrB,GAAG,EAAE,MAAM,GACV,OAAO,CAAC;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IAsBrD,OAAO,CAAC,eAAe;CAsBxB"}

package/dist/postgres.js

@@ -0,0 +1,133 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PostgresClient = void 0;
+const dashboard_1 = require("@empiricalrun/test-gen/dashboard");
+const pg_1 = require("pg");
+class PostgresClient {
+    client;
+    constructor() {
+        if (!process.env.EMPIRICALRUN_API_KEY) {
+            throw new Error("EMPIRICALRUN_API_KEY environment variable is required");
+        }
+        this.client = new dashboard_1.DashboardAPIClient({
+            authType: "project-api-key",
+        });
+    }
+    async get(name, options) {
+        const listResponse = await this.client.request("/api/neon/proxy", {
+            method: "POST",
+            body: {
+                action: "list",
+            },
+        });
+        if (listResponse.error) {
+            throw new Error(`Postgres list failed: ${listResponse.error}`);
+        }
+        const existingProject = listResponse.data.projects.find((p) => p.name === name);
+        if (existingProject) {
+            const connectionUri = await this.getConnectionUri(existingProject.id);
+            return { projectId: existingProject.id, connectionUri };
+        }
+        const createResponse = await this.client.request("/api/neon/proxy", {
+            method: "POST",
+            body: {
+                action: "create",
+                payload: {
+                    name,
+                    pg_version: options?.pgVersion,
+                },
+            },
+        });
+        if (createResponse.error) {
+            throw new Error(`Postgres create failed: ${createResponse.error}`);
+        }
+        const projectId = createResponse.data.project.id;
+        const connectionUri = createResponse.data.connection_uris?.[0]?.connection_uri;
+        if (!connectionUri) {
+            throw new Error("No connection URI returned from Neon API");
+        }
+        return { projectId, connectionUri };
+    }
+    async getConnectionUri(projectId) {
+        const response = await this.client.request("/api/neon/proxy", {
+            method: "POST",
+            body: {
+                action: "getConnectionUri",
+                projectId,
+                payload: {
+                    databaseName: "neondb",
+                    roleName: "neondb_owner",
+                    pooled: false,
+                },
+            },
+        });
+        if (response.error) {
+            throw new Error(`Postgres getConnectionUri failed: ${response.error}`);
+        }
+        return response.data.uri;
+    }
+    async delete(projectId) {
+        const response = await this.client.request("/api/neon/proxy", {
+            method: "POST",
+            body: {
+                action: "delete",
+                projectId,
+            },
+        });
+        if (response.error) {
+            throw new Error(`Postgres delete failed: ${response.error}`);
+        }
+    }
+    async query(connectionUri, sql) {
+        const client = new pg_1.Client({ connectionString: connectionUri });
+        try {
+            await client.connect();
+            const result = await client.query(sql);
+            return result.rows;
+        }
+        finally {
+            await client.end();
+        }
+    }
+    async execute(connectionUri, sql) {
+        const client = new pg_1.Client({ connectionString: connectionUri });
+        const results = [];
+        try {
+            await client.connect();
+            const statements = this.parseStatements(sql);
+            for (const statement of statements) {
+                const result = await client.query(statement);
+                results.push({
+                    statement: statement.substring(0, 80),
+                    rowCount: result.rowCount ?? 0,
+                });
+            }
+            return results;
+        }
+        finally {
+            await client.end();
+        }
+    }
+    parseStatements(sql) {
+        const lines = sql.split("\n");
+        const cleanedLines = [];
+        for (const line of lines) {
+            const trimmed = line.trim();
+            if (trimmed && !trimmed.startsWith("--")) {
+                const commentIndex = line.indexOf("--");
+                if (commentIndex > 0) {
+                    cleanedLines.push(line.substring(0, commentIndex));
+                }
+                else {
+                    cleanedLines.push(line);
+                }
+            }
+        }
+        return cleanedLines
+            .join("\n")
+            .split(";")
+            .map((q) => q.trim())
+            .filter((q) => q.length > 0);
+    }
+}
+exports.PostgresClient = PostgresClient;

package/dist/test/index.d.ts

@@ -1,5 +1,6 @@
 import type { BrowserContext, BrowserContextOptions, expect, Page, PlaywrightTestArgs, PlaywrightTestOptions, PlaywrightWorkerArgs, PlaywrightWorkerOptions, TestType } from "@playwright/test";
 import { KVClient } from "../kv";
+import { PostgresClient } from "../postgres";
 import { injectLocatorHighlightScripts } from "./scripts";
 import { HighlighterOpts } from "./types";
 import { setVideoLabel } from "./video-labels";
@@ -14,6 +15,7 @@ declare const extendExpect: (expectInstance: typeof expect) => import("@playwrig
 type TestOptions = {
     page: Page;
     kv: KVClient;
+    postgres: PostgresClient;
     customContextPageProvider: (options?: BrowserContextOptions) => Promise<{
         context: BrowserContext;
         page: Page;

package/dist/test/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/test/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,cAAc,EACd,qBAAqB,EACrB,MAAM,EACN,IAAI,EACJ,kBAAkB,EAClB,qBAAqB,EACrB,oBAAoB,EACpB,uBAAuB,EACvB,QAAQ,EACT,MAAM,kBAAkB,CAAC;AAG1B,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAEjC,OAAO,EAAE,6BAA6B,EAAE,MAAM,WAAW,CAAC;AAC1D,OAAO,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAC1C,OAAO,EAA8B,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAE3E,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,cAAc,CAAC;QACvB,UAAU,QAAQ,CAAC,CAAC;YAClB,WAAW,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;SAC9C;KACF;CACF;AAED,QAAA,MAAM,YAAY,GAAa,gBAAgB,OAAO,MAAM,0CAG3D,CAAC;AAEF,KAAK,WAAW,GAAG;IACjB,IAAI,EAAE,IAAI,CAAC;IACX,EAAE,EAAE,QAAQ,CAAC;IACb,yBAAyB,EAAE,CACzB,OAAO,CAAC,EAAE,qBAAqB,KAC5B,OAAO,CAAC;QAAE,OAAO,EAAE,cAAc,CAAC;QAAC,IAAI,EAAE,IAAI,CAAA;KAAE,CAAC,CAAC;IACtD,UAAU,EAAE,IAAI,CAAC;CAClB,CAAC;AAYF,QAAA,MAAM,eAAe,GACnB,QAAQ,QAAQ,CACd,kBAAkB,GAAG,qBAAqB,EAC1C,oBAAoB,GAAG,uBAAuB,CAC/C,EACD,UAAS,eAAgC,uHAuG1C,CAAC;AAEF,OAAO,EACL,eAAe,EACf,YAAY,EACZ,6BAA6B,EAC7B,aAAa,GACd,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/test/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,cAAc,EACd,qBAAqB,EACrB,MAAM,EACN,IAAI,EACJ,kBAAkB,EAClB,qBAAqB,EACrB,oBAAoB,EACpB,uBAAuB,EACvB,QAAQ,EACT,MAAM,kBAAkB,CAAC;AAG1B,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AACjC,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAE7C,OAAO,EAAE,6BAA6B,EAAE,MAAM,WAAW,CAAC;AAC1D,OAAO,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAC1C,OAAO,EAA8B,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAE3E,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,cAAc,CAAC;QACvB,UAAU,QAAQ,CAAC,CAAC;YAClB,WAAW,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;SAC9C;KACF;CACF;AAED,QAAA,MAAM,YAAY,GAAa,gBAAgB,OAAO,MAAM,0CAG3D,CAAC;AAEF,KAAK,WAAW,GAAG;IACjB,IAAI,EAAE,IAAI,CAAC;IACX,EAAE,EAAE,QAAQ,CAAC;IACb,QAAQ,EAAE,cAAc,CAAC;IACzB,yBAAyB,EAAE,CACzB,OAAO,CAAC,EAAE,qBAAqB,KAC5B,OAAO,CAAC;QAAE,OAAO,EAAE,cAAc,CAAC;QAAC,IAAI,EAAE,IAAI,CAAA;KAAE,CAAC,CAAC;IACtD,UAAU,EAAE,IAAI,CAAC;CAClB,CAAC;AAYF,QAAA,MAAM,eAAe,GACnB,QAAQ,QAAQ,CACd,kBAAkB,GAAG,qBAAqB,EAC1C,oBAAoB,GAAG,uBAAuB,CAC/C,EACD,UAAS,eAAgC,uHA2G1C,CAAC;AAEF,OAAO,EACL,eAAe,EACf,YAAY,EACZ,6BAA6B,EAC7B,aAAa,GACd,CAAC"}

package/dist/test/index.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.setVideoLabel = exports.injectLocatorHighlightScripts = exports.extendExpect = exports.baseTestFixture = void 0;
 const path_1 = __importDefault(require("path"));
 const kv_1 = require("../kv");
+const postgres_1 = require("../postgres");
 const expect_1 = require("./expect");
 const scripts_1 = require("./scripts");
 Object.defineProperty(exports, "injectLocatorHighlightScripts", { enumerable: true, get: function () { return scripts_1.injectLocatorHighlightScripts; } });
@@ -53,6 +54,10 @@ const baseTestFixture = function (testFn, options = defaultOptions) {
             const client = new kv_1.KVClient();
             await use(client);
         },
+        postgres: async ({}, use) => {
+            const client = new postgres_1.PostgresClient();
+            await use(client);
+        },
         customContextPageProvider: async ({ browser }, use, testInfo) => {
             const contexts = [];
             async function createContext(contextOptions = {}) {

package/docs/postgres.md

@@ -0,0 +1,78 @@
+# Postgres
+
+A PostgreSQL client for creating and managing temporary Neon databases in tests.
+
+## Fixture usage
+
+```ts
+test("example", async ({ page, postgres }) => {
+  // Get or create a database (cached via KV for 1 hour by default)
+  const { connectionUri } = await postgres.get("my-test-db");
+
+  // Run queries
+  const users = await postgres.query<{ id: number; name: string }>(
+    connectionUri,
+    "SELECT * FROM users",
+  );
+
+  // Execute multiple SQL statements
+  await postgres.execute(
+    connectionUri,
+    `
+    CREATE TABLE users (id SERIAL PRIMARY KEY, name TEXT);
+    INSERT INTO users (name) VALUES ('Alice');
+  `,
+  );
+
+  // Delete when done (optional - TTL will auto-expire)
+  await postgres.delete("my-test-db");
+});
+```
+
+## Standalone usage
+
+```ts
+import { PostgresClient } from "@empiricalrun/playwright-utils";
+
+const postgres = new PostgresClient();
+
+// Get or create a database
+const { projectId, connectionUri } = await postgres.get("my-db", {
+  pgVersion: 15,
+  ttl: 7200, // 2 hours
+});
+
+// Run a query
+const rows = await postgres.query(connectionUri, "SELECT NOW()");
+
+// Delete when done
+await postgres.delete("my-db");
+```
+
+## API
+
+### `postgres.get(name, options?)`
+
+Gets an existing database or creates a new one. Uses KV store to cache the connection.
+
+- `name` - Unique identifier for the database
+- `options.pgVersion` - PostgreSQL version (default: 15)
+- `options.ttl` - Cache TTL in seconds (default: 3600)
+
+Returns `{ projectId, connectionUri }`.
+
+### `postgres.delete(name)`
+
+Deletes the database and removes it from cache.
+
+### `postgres.query(connectionUri, sql)`
+
+Runs a SQL query and returns rows.
+
+### `postgres.execute(connectionUri, sql)`
+
+Executes multiple SQL statements separated by `;`.
+
+## Requirements
+
+- `EMPIRICALRUN_API_KEY` environment variable must be set

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@empiricalrun/playwright-utils",
-  "version": "0.33.0",
+  "version": "0.34.1",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -30,12 +30,14 @@
     "@types/node": "^20.14.9",
     "@types/serve-handler": "^6.1.4",
     "@types/adm-zip": "^0.5.7",
+    "@types/pg": "^8.11.6",
     "playwright-core": "1.53.2",
     "serve-handler": "^6.1.6",
     "@empiricalrun/shared-types": "0.12.0"
   },
   "dependencies": {
     "@babel/code-frame": "^7.24.7",
+    "pg": "^8.13.1",
     "adm-zip": "^0.5.16",
     "async-retry": "^1.3.3",
     "authenticator": "^1.1.5",

package/tsconfig.tsbuildinfo

@@ -1 +1 @@
-{"root":["./src/email.ts","./src/index.ts","./src/kv.ts","./src/logger.ts","./src/mailosaur-client.ts","./src/playwright-extensions.ts","./src/auth/google.ts","./src/auth/index.ts","./src/auth/types.ts","./src/captcha/index.ts","./src/captcha/vision.ts","./src/config/index.ts","./src/config/devices/types.ts","./src/overlay-tests/cache.spec.ts","./src/overlay-tests/click.spec.ts","./src/overlay-tests/fixtures.ts","./src/overlay-tests/patch.spec.ts","./src/reporter/empirical-reporter.ts","./src/reporter/uploader.ts","./src/reporter/util.ts","./src/test/constants.ts","./src/test/expect.ts","./src/test/index.ts","./src/test/types.ts","./src/test/video-labels.ts","./src/test/scripts/agent-capabilities.ts","./src/test/scripts/index.ts","./src/test/scripts/locator-highlights.ts","./src/test/scripts/locator-vision.ts","./src/test/scripts/mouse-pointer.ts","./src/test/scripts/types.ts","./src/test/scripts/pw-locator-patch/dismiss-overlays/cache.ts","./src/test/scripts/pw-locator-patch/dismiss-overlays/index.ts","./src/test/scripts/pw-locator-patch/dismiss-overlays/prompt.ts","./src/test/scripts/pw-locator-patch/dismiss-overlays/types.ts","./src/test/scripts/pw-locator-patch/dismiss-overlays/utils.ts","./src/test/scripts/pw-locator-patch/highlight/click.ts","./src/test/scripts/pw-locator-patch/highlight/expect.ts","./src/test/scripts/pw-locator-patch/highlight/hover.ts","./src/test/scripts/pw-locator-patch/highlight/inner-text.ts","./src/test/scripts/pw-locator-patch/highlight/input-value.ts","./src/test/scripts/pw-locator-patch/highlight/is-checked.ts","./src/test/scripts/pw-locator-patch/highlight/is-disabled.ts","./src/test/scripts/pw-locator-patch/highlight/is-editable.ts","./src/test/scripts/pw-locator-patch/highlight/text-content.ts","./src/test/scripts/pw-locator-patch/utils/index.ts","./src/test/scripts/pw-locator-patch/vision/query.ts"],"version":"5.8.3"}
+{"root":["./src/email.ts","./src/index.ts","./src/kv.ts","./src/logger.ts","./src/mailosaur-client.ts","./src/playwright-extensions.ts","./src/postgres.ts","./src/auth/google.ts","./src/auth/index.ts","./src/auth/types.ts","./src/captcha/index.ts","./src/captcha/vision.ts","./src/config/index.ts","./src/config/devices/types.ts","./src/overlay-tests/cache.spec.ts","./src/overlay-tests/click.spec.ts","./src/overlay-tests/fixtures.ts","./src/overlay-tests/patch.spec.ts","./src/reporter/empirical-reporter.ts","./src/reporter/uploader.ts","./src/reporter/util.ts","./src/test/constants.ts","./src/test/expect.ts","./src/test/index.ts","./src/test/types.ts","./src/test/video-labels.ts","./src/test/scripts/agent-capabilities.ts","./src/test/scripts/index.ts","./src/test/scripts/locator-highlights.ts","./src/test/scripts/locator-vision.ts","./src/test/scripts/mouse-pointer.ts","./src/test/scripts/types.ts","./src/test/scripts/pw-locator-patch/dismiss-overlays/cache.ts","./src/test/scripts/pw-locator-patch/dismiss-overlays/index.ts","./src/test/scripts/pw-locator-patch/dismiss-overlays/prompt.ts","./src/test/scripts/pw-locator-patch/dismiss-overlays/types.ts","./src/test/scripts/pw-locator-patch/dismiss-overlays/utils.ts","./src/test/scripts/pw-locator-patch/highlight/click.ts","./src/test/scripts/pw-locator-patch/highlight/expect.ts","./src/test/scripts/pw-locator-patch/highlight/hover.ts","./src/test/scripts/pw-locator-patch/highlight/inner-text.ts","./src/test/scripts/pw-locator-patch/highlight/input-value.ts","./src/test/scripts/pw-locator-patch/highlight/is-checked.ts","./src/test/scripts/pw-locator-patch/highlight/is-disabled.ts","./src/test/scripts/pw-locator-patch/highlight/is-editable.ts","./src/test/scripts/pw-locator-patch/highlight/text-content.ts","./src/test/scripts/pw-locator-patch/utils/index.ts","./src/test/scripts/pw-locator-patch/vision/query.ts"],"version":"5.8.3"}