feat: add postgres-js adapter

package.json

@@ -31,6 +31,7 @@
  "typeorm",
  "pg-promise",
  "pg-native",
+ "postgres-js",
  "unit test",
  "ut",
  "sql",
@@ -87,6 +88,7 @@
  "nyc": "^15.1.0",
  "pg": "^8.5.1",
  "pg-promise": "^10.8.7",
+ "postgres": "^3.4.4",
  "react": "^16.13.1",
  "react-dom": "^16.13.1",
  "react-hot-loader": "^4.12.21",
@@ -153,4 +155,4 @@
  "instrument": false,
  "sourceMap": false
  }
-}
+}

src/adapters/adapters.ts

@@ -241,6 +241,33 @@ export class Adapters implements LibAdapters {
  return db;
  }
 
+ createPostgresJs(queryLatency = 0) {
+ const that = this;
+
+ const queryDb = (query: string, queryLatency: number) => {
+ return {
+ async then(callback: any) {
+ await delay(queryLatency);
+ const result = that.db.public.query(query).rows;
+ callback(result);
+ }
+ };
+ }
+
+ const sql = function sql(strings: TemplateStringsArray, ...values: any[]) {
+ const sql = strings.reduce((prev, curr, i) => {
+ return prev + curr + (values[i] ?? '');
+ }, '');
+ return queryDb(sql, queryLatency);
+ }
+
+ sql.unsafe = function unsafe(query: string, args = [], options = {}) {
+ return queryDb(query, queryLatency); // discard args and options for now
+ }
+
+ return sql;
+ }
+
  createPgNative(queryLatency?: number) {
  queryLatency = queryLatency ?? 0;
  const prepared = new lru<string, string>({

src/interfaces.ts

@@ -205,6 +205,9 @@ export interface LibAdapters {
  /** Create a slonik pool bound to this db */
  createSlonik(queryLatency?: number): any;
 
+ /** Create a postgres-js mimic instance bound to this db */
+ createPostgresJs(queryLatency?: number): any;
+
  /** Create a pg-native instance bound to this db */
  createPgNative(queryLatency?: number): any;
 

src/tests/postgres-js-mimic.spec.ts

@@ -0,0 +1,62 @@
+import 'mocha';
+import 'chai';
+import { expect } from 'chai';
+import { newDb } from '../db';
+import postgres from 'postgres';
+
+// Spin up a real postgres instance with e.g., docker,
+// to compare the results of the fake postgres instance
+// with the real one.
+const realSQL = postgres({
+ host: 'localhost',
+ port: 5432,
+ database: 'postgres',
+ username: 'postgres',
+ password: 'password',
+})
+
+describe.only("PostgresJS smoketests", () => {
+ it("should use template correctly", async () => {
+ const mem = newDb();
+ const pg = mem.adapters.createPostgresJs();
+ const fake = await doSQLStuff(pg);
+
+ await realSQL`DROP TABLE IF EXISTS users`; // Clear table from any previous tests
+ const real = await doSQLStuff(realSQL);
+
+ expect(fake).to.deep.equal(real);
+ })
+
+
+ it("should use unsafe correctly", async () => {
+ const mem = newDb();
+ const pg = mem.adapters.createPostgresJs();
+ const fake = await doUnsafeStuff(pg);
+
+ await realSQL`DROP TABLE IF EXISTS users`;
+ const real = await doUnsafeStuff(realSQL);
+
+ expect(fake).to.deep.equal(real); // [ { id: 1, name: 'Alice' }]
+ });
+});
+
+async function doSQLStuff(sql: any) {
+ // Use the postgres-js tagged template literal to run SQL queries
+ await sql`
+ CREATE TABLE users (
+ id SERIAL PRIMARY KEY,
+ name TEXT NOT NULL
+ )`;
+ await sql`INSERT INTO users (name) VALUES ('Alice')`;
+ return await sql`SELECT * FROM users`;
+}
+
+async function doUnsafeStuff(sql: any) {
+ await sql.unsafe(`
+ CREATE TABLE users (
+ id SERIAL PRIMARY KEY,
+ name TEXT NOT NULL
+ )`)
+ await sql.unsafe(`INSERT INTO users (name) VALUES ('Alice')`);
+ return await sql.unsafe(`SELECT * FROM users`);
+}