@graffy/pg 0.15.5 → 0.15.8-alpha.1

package/cjs/test/setup.js

@@ -3,181 +3,223 @@
 var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault");
 
 exports.__esModule = true;
-exports.populate = populate;
+exports.setupPgServer = setupPgServer;
+exports.teardownPgServer = teardownPgServer;
+exports.resetTables = resetTables;
+exports.getPool = getPool;
+
+var _taggedTemplateLiteralLoose2 = _interopRequireDefault(require("@babel/runtime-corejs3/helpers/taggedTemplateLiteralLoose"));
 
 var _regenerator = _interopRequireDefault(require("@babel/runtime-corejs3/regenerator"));
 
-var _now = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-stable/date/now"));
+var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime-corejs3/helpers/asyncToGenerator"));
 
-var _taggedTemplateLiteralLoose2 = _interopRequireDefault(require("@babel/runtime-corejs3/helpers/taggedTemplateLiteralLoose"));
+var _promise = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-stable/promise"));
 
-var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime-corejs3/helpers/asyncToGenerator"));
+var _setTimeout2 = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-stable/set-timeout"));
+
+var _child_process = require("child_process");
 
-var _pg = _interopRequireDefault(require("pg"));
+var _util = require("util");
 
 var _sqlTemplateTag = _interopRequireDefault(require("sql-template-tag"));
 
-var _templateObject, _templateObject2, _templateObject3;
+var _pg = require("pg");
+
+var _templateObject, _templateObject2, _templateObject3, _templateObject4, _templateObject5;
+
+var connOptions = {
+  host: 'localhost',
+  port: 15432,
+  user: 'postgres',
+  password: 'graffy',
+  database: 'postgres'
+};
+var pool = null;
+var execFile = (0, _util.promisify)(_child_process.execFile);
+
+var sleep = function sleep(ms) {
+  return new _promise.default(function (res) {
+    return (0, _setTimeout2.default)(res, ms);
+  });
+};
+
+var isPgReady = /*#__PURE__*/function () {
+  var _ref = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
+    var client;
+    return _regenerator.default.wrap(function _callee$(_context) {
+      while (1) {
+        switch (_context.prev = _context.next) {
+          case 0:
+            _context.prev = 0;
+            client = new _pg.Client(connOptions);
+            _context.next = 4;
+            return client.connect();
+
+          case 4:
+            _context.next = 6;
+            return client.end();
 
-function populate() {
-  return _populate.apply(this, arguments);
-} // populate();
+          case 6:
+            return _context.abrupt("return", true);
 
+          case 9:
+            _context.prev = 9;
+            _context.t0 = _context["catch"](0);
+            return _context.abrupt("return", false);
 
-function _populate() {
-  _populate = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2() {
-    var pool, insert, _insert;
+          case 12:
+          case "end":
+            return _context.stop();
+        }
+      }
+    }, _callee, null, [[0, 9]]);
+  }));
 
+  return function isPgReady() {
+    return _ref.apply(this, arguments);
+  };
+}();
+
+function setupPgServer() {
+  return _setupPgServer.apply(this, arguments);
+}
+
+function _setupPgServer() {
+  _setupPgServer = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2() {
     return _regenerator.default.wrap(function _callee2$(_context2) {
       while (1) {
         switch (_context2.prev = _context2.next) {
           case 0:
-            _insert = function _insert3() {
-              _insert = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(type, number, builder) {
-                var i, _ref, _ref$tags, tags, _ref$data, data, now;
-
-                return _regenerator.default.wrap(function _callee$(_context) {
-                  while (1) {
-                    switch (_context.prev = _context.next) {
-                      case 0:
-                        if (builder === void 0) {
-                          builder = function builder() {};
-                        }
-
-                        i = 0;
-
-                      case 2:
-                        if (!(i < number)) {
-                          _context.next = 10;
-                          break;
-                        }
-
-                        _ref = builder(i) || {}, _ref$tags = _ref.tags, tags = _ref$tags === void 0 ? {} : _ref$tags, _ref$data = _ref.data, data = _ref$data === void 0 ? {} : _ref$data;
-                        now = (0, _now.default)(); // console.log('Inserting ', type, i);
-
-                        _context.next = 7;
-                        return pool.query((0, _sqlTemplateTag.default)(_templateObject3 || (_templateObject3 = (0, _taggedTemplateLiteralLoose2.default)(["INSERT INTO \"users\" (\n        \"id\", \"tags\", \"data\", \"version\"\n      ) VALUES (\n        ", ",\n        ", ",\n        ", ",\n        ", "\n      );"])), type + i, tags, data, now));
-
-                      case 7:
-                        i++;
-                        _context.next = 2;
-                        break;
-
-                      case 10:
-                      case "end":
-                        return _context.stop();
-                    }
-                  }
-                }, _callee);
-              }));
-              return _insert.apply(this, arguments);
-            };
-
-            insert = function _insert2(_x, _x2, _x3) {
-              return _insert.apply(this, arguments);
-            };
-
-            // console.log('Creating tables');
-            pool = new _pg.default.Pool();
-            _context2.next = 5;
-            return pool.query((0, _sqlTemplateTag.default)(_templateObject || (_templateObject = (0, _taggedTemplateLiteralLoose2.default)(["\n    DROP TABLE IF EXISTS \"users\";\n  "]))));
-
-          case 5:
-            _context2.next = 7;
-            return pool.query((0, _sqlTemplateTag.default)(_templateObject2 || (_templateObject2 = (0, _taggedTemplateLiteralLoose2.default)(["\n    CREATE TABLE \"users\" (\n      \"id\" text PRIMARY KEY,\n      \"tags\" jsonb NOT NULL DEFAULT '{}',\n      \"data\" jsonb NOT NULL DEFAULT '{}',\n      \"version\" int8 NOT NULL DEFAULT NOW()\n    );\n  "]))));
+            _context2.prev = 0;
+            _context2.next = 3;
+            return execFile('docker', ['run', '-d', '--name', 'graffypg', '-p', connOptions.port + ":5432", '-e', "POSTGRES_PASSWORD=" + connOptions.password, 'postgres:alpine']);
 
-          case 7:
+          case 3:
             _context2.next = 9;
-            return insert('tenant', 3, function (_i) {
-              return {
-                data: {
-                  providers: {
-                    user: {
-                      type: 'db',
-                      table: 'users',
-                      columns: {
-                        id: {
-                          role: 'primary'
-                        },
-                        tags: {
-                          role: 'gin'
-                        },
-                        data: {
-                          role: 'default'
-                        },
-                        version: {
-                          role: 'version'
-                        }
-                      },
-                      links: {
-                        posts: {
-                          target: ['post'],
-                          back: ['author']
-                        }
-                      }
-                    },
-                    post: {
-                      type: 'db',
-                      table: 'posts',
-                      columns: {
-                        id: {
-                          role: 'primary'
-                        },
-                        tags: {
-                          role: 'gin'
-                        },
-                        data: {
-                          role: 'default'
-                        },
-                        version: {
-                          role: 'version'
-                        }
-                      },
-                      links: {
-                        author: {
-                          target: ['user']
-                        }
-                      }
-                    }
-                  }
-                }
-              };
-            });
+            break;
+
+          case 5:
+            _context2.prev = 5;
+            _context2.t0 = _context2["catch"](0);
+            // eslint-disable-next-line no-console
+            console.error('Could not start a test Postgres server using Docker.\n' + 'Possible reasons:\n' + '1. You might not have Docker installed.\n' + '2. The last test run might not have exited properly.\n' + '   Run yarn pg:clean to fix this.\n' + 'Docker might have printed a detailed error message above.');
+            throw _context2.t0;
 
           case 9:
             _context2.next = 11;
-            return insert('user', 5, function (i) {
-              return {
-                data: {
-                  i: i
-                }
-              };
-            });
+            return isPgReady(connOptions.port);
 
           case 11:
-            _context2.next = 13;
-            return insert('post', 5, function (i) {
-              return {
-                data: {
-                  i: i,
-                  author: 'user' + (4 - i)
-                },
-                tags: {
-                  author: 'user' + (4 - i)
-                }
-              };
-            });
-
-          case 13:
-            _context2.next = 15;
-            return pool.end();
+            if (_context2.sent) {
+              _context2.next = 16;
+              break;
+            }
 
-          case 15:
+            _context2.next = 14;
+            return sleep(200);
+
+          case 14:
+            _context2.next = 9;
+            break;
+
+          case 16:
+            // console.log('Postgres is up in', Date.now() - start, 'ms');
+            pool = new _pg.Pool(connOptions);
+
+          case 17:
           case "end":
             return _context2.stop();
         }
       }
-    }, _callee2);
+    }, _callee2, null, [[0, 5]]);
+  }));
+  return _setupPgServer.apply(this, arguments);
+}
+
+function teardownPgServer() {
+  return _teardownPgServer.apply(this, arguments);
+}
+
+function _teardownPgServer() {
+  _teardownPgServer = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3() {
+    return _regenerator.default.wrap(function _callee3$(_context3) {
+      while (1) {
+        switch (_context3.prev = _context3.next) {
+          case 0:
+            if (!pool) {
+              _context3.next = 4;
+              break;
+            }
+
+            _context3.next = 3;
+            return pool.end();
+
+          case 3:
+            pool = null;
+
+          case 4:
+            _context3.next = 6;
+            return execFile('docker', ['rm', '-f', 'graffypg']);
+
+          case 6:
+          case "end":
+            return _context3.stop();
+        }
+      }
+    }, _callee3);
   }));
-  return _populate.apply(this, arguments);
+  return _teardownPgServer.apply(this, arguments);
+}
+
+function resetTables() {
+  return _resetTables.apply(this, arguments);
+}
+
+function _resetTables() {
+  _resetTables = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee4() {
+    return _regenerator.default.wrap(function _callee4$(_context4) {
+      while (1) {
+        switch (_context4.prev = _context4.next) {
+          case 0:
+            if (pool) {
+              _context4.next = 2;
+              break;
+            }
+
+            throw Error('No pool; Did not setup PG or already torn down.');
+
+          case 2:
+            _context4.next = 4;
+            return pool.query((0, _sqlTemplateTag.default)(_templateObject || (_templateObject = (0, _taggedTemplateLiteralLoose2.default)(["\n    CREATE EXTENSION IF NOT EXISTS \"pgcrypto\"\n  "]))));
+
+          case 4:
+            _context4.next = 6;
+            return pool.query((0, _sqlTemplateTag.default)(_templateObject2 || (_templateObject2 = (0, _taggedTemplateLiteralLoose2.default)(["\n    DROP TABLE IF EXISTS \"users\";\n  "]))));
+
+          case 6:
+            _context4.next = 8;
+            return pool.query((0, _sqlTemplateTag.default)(_templateObject3 || (_templateObject3 = (0, _taggedTemplateLiteralLoose2.default)(["\n    CREATE UNLOGGED TABLE \"users\" (\n      \"id\" uuid DEFAULT gen_random_uuid() PRIMARY KEY,\n      \"name\" text,\n      \"settings\" jsonb,\n      \"email\" text UNIQUE,\n      \"version\" int8 NOT NULL\n    );\n  "]))));
+
+          case 8:
+            _context4.next = 10;
+            return pool.query((0, _sqlTemplateTag.default)(_templateObject4 || (_templateObject4 = (0, _taggedTemplateLiteralLoose2.default)(["\n    DROP TABLE IF EXISTS \"posts\";\n  "]))));
+
+          case 10:
+            _context4.next = 12;
+            return pool.query((0, _sqlTemplateTag.default)(_templateObject5 || (_templateObject5 = (0, _taggedTemplateLiteralLoose2.default)(["\n    CREATE UNLOGGED TABLE \"posts\" (\n      \"id\" uuid DEFAULT gen_random_uuid() PRIMARY KEY,\n      \"title\" text,\n      \"authorId\" text,\n      \"version\" int8 NOT NULL\n    );\n  "]))));
+
+          case 12:
+          case "end":
+            return _context4.stop();
+        }
+      }
+    }, _callee4);
+  }));
+  return _resetTables.apply(this, arguments);
+}
+
+function getPool() {
+  if (!pool) throw Error('No pool; Did not setup PG or already torn down.');
+  return pool;
 }

package/package.json

@@ -2,7 +2,7 @@
   "name": "@graffy/pg",
   "description": "The standard Postgres module for Graffy. Each instance this module mounts a Postgres table as a Graffy subtree.",
   "author": "aravind (https://github.com/aravindet)",
-  "version": "0.15.5",
+  "version": "0.15.8-alpha.1",
   "main": "./cjs/index.js",
   "types": "./types/index.d.ts",
   "repository": {
@@ -12,11 +12,10 @@
   "license": "Apache-2.0",
   "dependencies": {
     "@babel/runtime-corejs3": "^7.15.3",
-    "@graffy/common": "0.15.5",
-    "debug": "^4.3.2",
-    "@graffy/testing": "0.15.5",
-    "@graffy/stream": "0.15.5",
     "pg": "^8.7.1",
-    "sql-template-tag": "^4.0.0"
+    "@graffy/common": "0.15.8-alpha.1",
+    "debug": "^4.3.2",
+    "sql-template-tag": "^4.0.0",
+    "@graffy/testing": "0.15.8-alpha.1"
   }
 }

package/types/Db.d.ts

@@ -0,0 +1,9 @@
+export default class Db {
+    constructor(connection: any);
+    client: any;
+    query(sql: any): Promise<any>;
+    readSql(sql: any): Promise<any>;
+    writeSql(sql: any): Promise<any>;
+    read(rootQuery: any, tableOptions: any): Promise<any>;
+    write(rootChange: any, tableOptions: any): Promise<any[]>;
+}

package/types/index.d.ts

@@ -1,2 +1,7 @@
-declare function _default(opts?: {}): (store: any) => void;
-export default _default;
+export function pg({ table, idCol, verCol, links, connection }: {
+    table?: string;
+    idCol?: string;
+    verCol?: string;
+    links?: object;
+    connection?: any;
+}): (store: any) => void;

package/types/link/index.d.ts

@@ -1,6 +1,3 @@
 export function linkResult(objects: any, query: any, { links: linkSpecs }: {
     links: any;
 }): any[];
-export function linkChange(object: any, { links: linkSpecs }: {
-    links: any;
-}): any;

package/types/sql/clauses.d.ts

@@ -0,0 +1,8 @@
+export const nowTimestamp: import("sql-template-tag").Sql;
+export function getJsonBuildObject(variadic: any): import("sql-template-tag").Sql;
+export function getSelectCols(table: any): import("sql-template-tag").Sql;
+export function getInsert(row: any, options: any): {
+    cols: import("sql-template-tag").Sql;
+    vals: import("sql-template-tag").Sql;
+};
+export function getUpdates(row: any, options: any): import("sql-template-tag").Sql;

package/types/sql/getArgSql.d.ts

@@ -1,20 +1,19 @@
-export default function getArgSql({ $first, $last, $after, $before, $since, $until, $cursor: _, ...rest }: {
-    [x: string]: any;
-    $first: any;
-    $last: any;
-    $after: any;
-    $before: any;
-    $since: any;
-    $until: any;
-    $cursor: any;
-}, options: any): {
-    attrs: import("sql-template-tag").Sql;
-    where: any[];
+/**
+  Uses the args object (typically passed in the $key attribute)
+
+  @param {object} args
+  @param {object} options
+
+  @typedef { import('sql-template-tag').Sql } Sql
+  @return {{ meta: Sql, where: Sql[], order?: Sql, limit: number }}
+*/
+export default function getArgSql({ $first, $last, $after, $before, $since, $until, $all, $cursor: _, ...rest }: object, options: object): {
+    meta: Sql;
+    where: Sql[];
+    order?: Sql;
     limit: number;
-    order?: undefined;
-} | {
-    attrs: import("sql-template-tag").Sql;
-    where: any[];
-    order: import("sql-template-tag").Sql;
-    limit: any;
 };
+/**
+ * Uses the args object (typically passed in the $key attribute)
+ */
+export type Sql = import('sql-template-tag').Sql;

package/types/sql/getMeta.d.ts

@@ -0,0 +1,4 @@
+export function getIdMeta({ idCol }: {
+    idCol: any;
+}): import("sql-template-tag").Sql;
+export function getArgMeta(key: any, prefix: any, idCol: any): import("sql-template-tag").Sql;

package/types/sql/select.d.ts

@@ -1,7 +1,2 @@
-export function selectByArgs(args: any, options: any, { forUpdate }?: {
-    forUpdate: any;
-}): import("sql-template-tag").Sql;
-export function selectByIds(ids: any, options: any, { forUpdate }?: {
-    forUpdate: any;
-}): import("sql-template-tag").Sql;
-export function selectUpdatedSince(version: any, options: any): import("sql-template-tag").Sql;
+export function selectByArgs(args: any, options: any): import("sql-template-tag").Sql;
+export function selectByIds(ids: any, options: any): import("sql-template-tag").Sql;