Test that poolQueryViaFetch is inhibited by connect listener, and dri…

…ver fix to ensure it is
neondatabase · Dec 19, 2024 · 288e45d · 288e45d
1 parent 0da9b27
commit 288e45d
Show file tree

Hide file tree

Showing 11 changed files with 206 additions and 176 deletions.
diff --git a/dist/dts/_extracted.d.ts b/dist/dts/_extracted.d.ts
@@ -444,6 +444,7 @@ export declare class Pool extends Pool_2 {
     Client: typeof Client;
     hasFetchUnsupportedListeners: boolean;
     on(event: 'error' | 'connect' | 'acquire' | 'release' | 'remove', listener: any): this;
+    addListener: (event: "error" | "connect" | "acquire" | "release" | "remove", listener: any) => this;
     query(config?: any, values?: any, cb?: any): any;
 }
 

diff --git a/dist/dts/_extracted.d.ts.orig b/dist/dts/_extracted.d.ts.orig
@@ -444,6 +444,7 @@ export declare class Pool extends Pool_2 {
     Client: typeof Client;
     hasFetchUnsupportedListeners: boolean;
     on(event: 'error' | 'connect' | 'acquire' | 'release' | 'remove', listener: any): this;
+    addListener: (event: "error" | "connect" | "acquire" | "release" | "remove", listener: any) => this;
     query(config?: any, values?: any, cb?: any): any;
 }
 

diff --git a/dist/dts/export/index.d.ts b/dist/dts/export/index.d.ts
@@ -43,6 +43,7 @@ declare class NeonPool extends Pool {
     Client: typeof NeonClient;
     hasFetchUnsupportedListeners: boolean;
     on(event: 'error' | 'connect' | 'acquire' | 'release' | 'remove', listener: any): this;
+    addListener: (event: "error" | "connect" | "acquire" | "release" | "remove", listener: any) => this;
     query(config?: any, values?: any, cb?: any): any;
 }
 export { Socket as neonConfig, NeonPool as Pool, NeonClient as Client, neon, NeonDbError, };

diff --git a/dist/jsr/index.d.ts b/dist/jsr/index.d.ts
@@ -446,6 +446,7 @@ export declare class Pool extends Pool_2 {
     Client: typeof Client;
     hasFetchUnsupportedListeners: boolean;
     on(event: 'error' | 'connect' | 'acquire' | 'release' | 'remove', listener: any): this;
+    addListener: (event: "error" | "connect" | "acquire" | "release" | "remove", listener: any) => this;
     query(config?: any, values?: any, cb?: any): any;
 }
 

diff --git a/dist/jsr/index.js b/dist/jsr/index.js
diff --git a/dist/npm/index.d.mts b/dist/npm/index.d.mts
@@ -446,6 +446,7 @@ export declare class Pool extends Pool_2 {
     Client: typeof Client;
     hasFetchUnsupportedListeners: boolean;
     on(event: 'error' | 'connect' | 'acquire' | 'release' | 'remove', listener: any): this;
+    addListener: (event: "error" | "connect" | "acquire" | "release" | "remove", listener: any) => this;
     query(config?: any, values?: any, cb?: any): any;
 }
 

diff --git a/dist/npm/index.d.ts b/dist/npm/index.d.ts
@@ -446,6 +446,7 @@ export declare class Pool extends Pool_2 {
     Client: typeof Client;
     hasFetchUnsupportedListeners: boolean;
     on(event: 'error' | 'connect' | 'acquire' | 'release' | 'remove', listener: any): this;
+    addListener: (event: "error" | "connect" | "acquire" | "release" | "remove", listener: any) => this;
     query(config?: any, values?: any, cb?: any): any;
 }
 

diff --git a/dist/npm/index.js b/dist/npm/index.js
diff --git a/dist/npm/index.mjs b/dist/npm/index.mjs
diff --git a/export/index.ts b/export/index.ts
@@ -313,6 +313,8 @@ class NeonPool extends Pool {
     return super.on(event as any, listener);
   }
 
+  addListener = this.on;
+
   // @ts-ignore -- is it even possible to make TS happy with these overloaded function types?
   query(config?: any, values?: any, cb?: any) {
     if (

diff --git a/tests/ws.test.ts b/tests/ws.test.ts
@@ -1,4 +1,4 @@
-import { expect, test, beforeAll } from 'vitest';
+import { expect, test, beforeAll, vi } from 'vitest';
 import { Pool as PgPool } from 'pg';
 import * as subtls from 'subtls';
 import { sampleQueries } from './sampleQueries';
@@ -78,7 +78,29 @@ test('pool.query() with poolQueryViaFetch', async () => {
   }
 });
 
-// TODO: poolQueryViaFetch with contra-indications
+test('pool.query() with poolQueryViaFetch but also a listener that prevents fetch', async () => {
+  neonConfig.poolQueryViaFetch = true;
+
+  // use a new Pool because we know it will have to connect a new client
+  const customPool = new WsPool({ connectionString: DB_URL });
+
+  try {
+    const fn = vi.fn();
+    const connectListener = () => {
+      customPool.removeListener('connect', connectListener);
+      fn();
+    };
+    customPool.addListener('connect', connectListener);
+
+    const wsResult = await customPool.query('SELECT $1::int AS one', [1]);
+    expect(wsResult.rows).toStrictEqual([{ one: 1 }]);
+    expect(wsResult).not.toHaveProperty('viaNeonFetch');
+    expect(fn).toHaveBeenCalledOnce();
+  } finally {
+    neonConfig.poolQueryViaFetch = false;
+    customPool.end();
+  }
+});
 
 test('client.query()', async () => {
   const client = new WsClient(DB_URL);