Initial commit.

Author: emadda

.gitignore

@@ -0,0 +1,3 @@
+dist
+node_modules
+.idea

LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2019 Enzo Madda <[email protected]>, sqlitempi.com
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package.json

@@ -0,0 +1,27 @@
+{
+    "name": "sqlite-mpi-client-js",
+    "version": "0.0.1",
+    "main": "dist/index.js",
+    "types": "dist/index.d.ts",
+    "author": "Enzo Madda",
+    "license": "MIT",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/sqlite-mpi/sqlite-mpi-client-js.git"
+    },
+    "scripts": {
+        "test": "jest"
+    },
+    "jest": {
+        "testRegex": "test/all/.*\\.js$"
+    },
+    "dependencies": {
+        "lodash": "^4.17.15",
+        "uuid": "^3.3.3"
+    },
+    "devDependencies": {
+        "jest": "^24.9.0",
+        "smpi-iop-node-ffi": "file:./../smpi-iop-node-ffi",
+        "typescript": "^3.7.2"
+    }
+}

sh/run-tests.sh

@@ -0,0 +1,10 @@
+
+# Note: `-t` allows filtering tests by name:
+# `jest test/all/params.js -t "bound"`
+
+# Issue: `jest` runtime has an issue running many tests at the same time that use the `ffi` NPM package.
+# Fix: run separately.
+jest test/all/basic;
+jest test/all/extensions.js;
+jest test/all/interleaving.js;
+jest test/all/params.js;

sh/watch-test.sh

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+#jest --watch #runs jest -o by default
+jest --watchAll #runs all tests
+
+# Runs tests with matching description:
+# jest -t "Param"

sh/watch.sh

@@ -0,0 +1,2 @@
+#!/usr/bin/env bash
+tsc --watch

sh/yarn-add-ffi.sh

@@ -0,0 +1,4 @@
+# After re-compiling the local FFI dylib during development, it needs to be removed and added to use the new binary:
+
+yarn remove smpi-iop-node-ffi;
+yarn add --dev file:./../smpi-iop-node-ffi;

src/classes/client.ts

@@ -0,0 +1,63 @@
+import {
+    toReqRes
+} from "./../lib/iop-to-reqres";
+
+import {
+    throwIfError,
+} from "./../lib-app/util";
+
+import {ReadTx, WriteTx} from "./tx";
+
+class Client {
+    rr = null;
+
+    constructor(iop) {
+        const rr = toReqRes(iop);
+
+        this.rr = throwIfError(rr);
+    }
+
+    newFileRef(absFile) {
+        return new FileRef(this.rr, absFile);
+    }
+}
+
+class FileRef {
+    rr = null;
+    absFile = null;
+
+    constructor(rr, absFile) {
+        this.rr = rr;
+        this.absFile = absFile;
+    }
+
+    async getReadTx() {
+        const {rr} = this;
+
+        const {tx_id} = await rr.send({
+            fn: "file/get_read_tx",
+            args: {
+                file: this.absFile
+            }
+        });
+
+        return new ReadTx(rr, tx_id);
+    }
+
+    async getWriteTx() {
+        const {rr} = this;
+
+        const {tx_id} = await rr.send({
+            fn: "file/get_write_tx",
+            args: {
+                file: this.absFile
+            }
+        });
+
+        return new WriteTx(rr, tx_id);
+    }
+}
+
+export {
+    Client
+}

src/classes/tx.ts

@@ -0,0 +1,211 @@
+import _ from "lodash";
+
+/**
+ * @returns string `q` without params, `q_params` with.
+ */
+const getFn = (base, p) => {
+    if (hasParams(p)) {
+        return `${base}_params`
+    }
+    return base;
+};
+
+const hasParams = (p) => {
+    return _.isObject(p) || _.isArray(p)
+};
+
+const getParamKey = (p) => {
+    if (_.isPlainObject(p)) {
+        return "key_based";
+    }
+    if (_.isArray(p)) {
+        return "index_based";
+    }
+
+    // This function should only be called when `params` is valid.
+    throw Error("Invalid params");
+};
+
+const getRSet = async (rr, tx_id, base, q, p) => {
+    if (p !== null && !hasParams(p)) {
+        throw Error("Invalid type provided for params.");
+    }
+
+    const fn = `tx/${getFn(base, p)}`;
+
+    const args = {
+        tx_id,
+        q
+    };
+
+    if (hasParams(p)) {
+        args[getParamKey(p)] = p;
+    }
+
+    const rset = await rr.send({
+        fn,
+        args
+    });
+
+    return new RSet(rset);
+};
+
+class ReadTx {
+    rr = null;
+    txId = null;
+
+    constructor(rr, txId) {
+        this.rr = rr;
+        this.txId = txId;
+    }
+
+
+    async q(q, p = null) {
+        const {rr, txId: tx_id} = this;
+        return getRSet(rr, tx_id, "q", q, p);
+    }
+
+    async read(q, p = null) {
+        const {rr, txId: tx_id} = this;
+        return getRSet(rr, tx_id, "read", q, p);
+    }
+
+    async commit() {
+        const {rr, txId: tx_id} = this;
+
+        const rset = await rr.send({
+            fn: "tx/commit",
+            args: {
+                tx_id
+            }
+        });
+
+        return new RSet(rset);
+    }
+
+    async rollback() {
+        const {rr, txId: tx_id} = this;
+
+        const rset = await rr.send({
+            fn: "tx/rollback",
+            args: {
+                tx_id
+            }
+        });
+
+        return new RSet(rset);
+    }
+}
+
+
+class WriteTx {
+    rr = null;
+    txId = null;
+
+    constructor(rr, txId) {
+        this.rr = rr;
+        this.txId = txId;
+    }
+
+    async q(q, p = null) {
+        const {rr, txId: tx_id} = this;
+        return getRSet(rr, tx_id, "q", q, p);
+    }
+
+    async read(q, p = null) {
+        const {rr, txId: tx_id} = this;
+        return getRSet(rr, tx_id, "read", q, p);
+    }
+
+    async write(q, p = null) {
+        const {rr, txId: tx_id} = this;
+        return getRSet(rr, tx_id, "write", q, p);
+    }
+
+    async commit() {
+        const {rr, txId: tx_id} = this;
+
+        const rset = await rr.send({
+            fn: "tx/commit",
+            args: {
+                tx_id
+            }
+        });
+
+        return new RSet(rset);
+    }
+
+    async rollback() {
+        const {rr, txId: tx_id} = this;
+
+        const rset = await rr.send({
+            fn: "tx/rollback",
+            args: {
+                tx_id
+            }
+        });
+
+        return new RSet(rset);
+    }
+}
+
+
+class RSet {
+    res = null;
+    rows_cache = null;
+
+    constructor(res) {
+        // @todo/low deep freeze object.
+        this.res = res;
+    }
+
+    /**
+     * Allow JS destructuring syntax by using a getter.
+     * - E.g. `const {rows} = rset;`
+     * Only compute rows when requested.
+     */
+    get rows() {
+        if (this.rows_cache === null) {
+            // Convert `[[1,2,3]]` into `[{x: 1, y: 2, z: 3}]`.
+            const {col_names, rows: {data}} = this.res;
+            const keys = col_names.map(({name}) => name);
+            const o = [];
+
+            for (const r of data) {
+                const one = {};
+
+                for (const [i, v] of r.entries()) {
+                    one[keys[i]] = v;
+                }
+                o.push(one);
+            }
+            this.rows_cache = o;
+        }
+        return this.rows_cache;
+    }
+
+    get rowsAsArray() {
+        return this.res.rows.data;
+    }
+
+    get cols() {
+        return this.res.col_names.map(({name}) => name);
+    }
+
+    get colsOrigin() {
+        return this.res.col_names.map(({name_origin}) => name_origin);
+    }
+
+    get rowsChanged() {
+        const c = this.res.rows_changed;
+
+        // `null` when the query is not an insert, update or delete.
+        return c === null ? 0 : c;
+    }
+}
+
+export {
+    ReadTx,
+    WriteTx
+}
+

src/index.ts

@@ -0,0 +1,5 @@
+import {smpi} from "./smpi";
+
+export {
+    smpi,
+}