add connectionString support. (#2)

Author: igalklebanov

README.md

@@ -61,11 +61,24 @@ interface Database {
   }
 }
 
+const db = new Kysely<Database>({
+  dialect: new PostgresJSDialect({
+    connectionString: 'postgres://admin@localhost:5434/test',
+    options: {
+      max: 10,
+    },
+    postgres,
+  }),
+})
+
+// or...
+
 const db = new Kysely<Database>({
   dialect: new PostgresJSDialect({
     options: {
       database: 'test',
       host: 'localhost',
+      max: 10,
       port: 5434,
       user: 'admin',
     },

package.json

@@ -44,6 +44,7 @@
     "@types/chai-as-promised": "^7.1.5",
     "@types/chai-subset": "^1.3.3",
     "@types/mocha": "^10.0.1",
+    "@types/mocha-each": "^2.0.0",
     "@types/node": "^18.15.11",
     "@typescript-eslint/eslint-plugin": "^5.57.1",
     "@typescript-eslint/parser": "^5.57.1",
@@ -57,6 +58,7 @@
     "eslint-plugin-prettier": "^4.2.1",
     "kysely": "^0.24.2",
     "mocha": "^10.2.0",
+    "mocha-each": "^2.0.1",
     "postgres": "^3.3.4",
     "prettier": "^2.8.7",
     "prettier-plugin-organize-imports": "^3.2.2",

pnpm-lock.yaml

@@ -3,7 +3,7 @@ import type {Sql} from 'postgres'
 
 import {PostgresJSDialectError} from './errors.js'
 import type {PostgresJSDialectConfig} from './types.js'
-import {freeze} from './utils.js'
+import {createPostgres, freeze} from './utils.js'
 
 export class PostgresJSConnection implements DatabaseConnection {
   readonly #config: PostgresJSDialectConfig
@@ -22,7 +22,7 @@ export class PostgresJSConnection implements DatabaseConnection {
 
     const {isolationLevel} = settings
 
-    this.#transaction = this.#config.postgres({...this.#config.options, max: 1})
+    this.#transaction = createPostgres({...this.#config, options: {...this.#config.options, max: 1}})
 
     const statement = `start transaction${isolationLevel ? ` ${isolationLevel}` : ''}`
 

src/connection.ts

@@ -3,15 +3,16 @@ import type {Sql} from 'postgres'
 
 import {PostgresJSConnection} from './connection.js'
 import type {PostgresJSDialectConfig} from './types.js'
-import {freeze} from './utils.js'
+import {createPostgres, freeze} from './utils.js'
 
 export class PostgresJSDriver implements Driver {
   readonly #config: PostgresJSDialectConfig
   readonly #sql: Sql
 
   constructor(config: PostgresJSDialectConfig) {
     this.#config = freeze({...config})
-    this.#sql = this.#config.postgres(this.#config.options)
+
+    this.#sql = createPostgres(this.#config)
   }
 
   async init(): Promise<void> {

src/driver.ts

@@ -1,7 +1,13 @@
 import type postgres from 'postgres'
 import type {Options} from 'postgres'
 
-export interface PostgresJSDialectConfig {
-  options: Options<any>
-  postgres: typeof postgres
-}
+export type PostgresJSDialectConfig =
+  | {
+      connectionString: string
+      options?: Options<any>
+      postgres: typeof postgres
+    }
+  | {
+      options: Options<any>
+      postgres: typeof postgres
+    }

src/types.ts

@@ -1,3 +1,13 @@
+import type {Sql} from 'postgres'
+
+import type {PostgresJSDialectConfig} from './types'
+
 export function freeze<T>(obj: T): Readonly<T> {
   return Object.freeze(obj)
 }
+
+export function createPostgres(config: PostgresJSDialectConfig): Sql {
+  return 'connectionString' in config
+    ? config.postgres(config.connectionString, config.options)
+    : config.postgres(config.options)
+}

src/utils.ts

@@ -1,11 +1,14 @@
 import {DeleteResult, InsertResult, UpdateResult, sql, type Kysely, type Transaction} from 'kysely'
 
 import {
+  CONFIGS,
   DEFAULT_DATA_SET,
   POOL_SIZE,
+  TestConfig,
   clearDatabase,
   destroyTest,
   expect,
+  forEach,
   initTest,
   insertDefaultDataSet,
   testSql,
@@ -14,11 +17,11 @@ import {
   type TestContext,
 } from './test-setup'
 
-describe('PostgresJSDialect', () => {
+forEach(CONFIGS).describe('PostgresJSDialect: %s', (config: TestConfig) => {
   let ctx: TestContext
 
   before(async function () {
-    ctx = await initTest(this)
+    ctx = await initTest(this, config.config)
   })
 
   beforeEach(async () => {

tests/nodejs/index.test.ts

@@ -16,6 +16,8 @@ import postgres from 'postgres'
 
 import {PostgresJSDialect} from '../../src'
 
+export {default as forEach} from 'mocha-each'
+
 chai.use(chaiSubset)
 
 export interface Person {
@@ -66,31 +68,56 @@ export const PLUGINS: KyselyPlugin[] = []
 
 export const POOL_SIZE = 20
 
-export const CONFIG: KyselyConfig = {
-  dialect: new PostgresJSDialect({
-    options: {
-      database: 'test',
-      host: 'localhost',
-      max: POOL_SIZE,
-      onnotice() {},
-      port: 5434,
-      user: 'admin',
+const DATABASE = 'test'
+const HOST = 'localhost'
+const PORT = 5434
+const USER = 'admin'
+
+export const CONFIGS: {config: KyselyConfig; toString: () => string}[] = [
+  {
+    config: {
+      dialect: new PostgresJSDialect({
+        connectionString: `postgres://${USER}@${HOST}:${PORT}/${DATABASE}`,
+        options: {
+          max: POOL_SIZE,
+          onnotice() {},
+        },
+        postgres,
+      }),
     },
-    postgres,
-  }),
-}
+    toString: () => 'connection-string',
+  },
+  {
+    config: {
+      dialect: new PostgresJSDialect({
+        options: {
+          database: DATABASE,
+          host: HOST,
+          max: POOL_SIZE,
+          onnotice() {},
+          port: PORT,
+          user: USER,
+        },
+        postgres,
+      }),
+    },
+    toString: () => 'options',
+  },
+]
+
+export type TestConfig = (typeof CONFIGS)[number]
 
-export async function initTest(ctx: Mocha.Context, log?: Logger): Promise<TestContext> {
+export async function initTest(ctx: Mocha.Context, config: KyselyConfig, log?: Logger): Promise<TestContext> {
   ctx.timeout(TEST_INIT_TIMEOUT)
 
   const db = await connect({
-    ...CONFIG,
+    ...config,
     log,
   })
 
   await createDatabase(db)
 
-  return {config: CONFIG, db}
+  return {config, db}
 }
 
 export async function destroyTest(ctx: TestContext): Promise<void> {