neptune-lambda-client 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Stefano Vozza
+
+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/README.md

@@ -0,0 +1,25 @@
+# neptune-lambda-client
+
+## Overview
+A very simple Gremlin client to robustly query AWS Neptune from AWS Lambda. The client will automatically
+reestablish a connection to the database if the web socket connection closes and will also automatically 
+retry (5 times) when it encounters `ConcurrentModificationException` and `ReadOnlyViolationException` errors.
+
+## Usage
+
+This client is instantiated with a factory function and exposes a single function called `query`. `query` accepts 
+a single argument, which is a function that use the Gremlin `g` object.
+
+```js
+const gremlinClient = require('neptune-lambda-client');
+
+const {query} = gremlinClient.create({
+    host: 'neptune-db-url',
+    port: '8182',
+    useIam: true
+});
+
+async function getNode(id) {
+    return query(async g => g.V(id).next().then(x => x.value));
+}
+```

package/index.js

@@ -0,0 +1,108 @@
+const aws4 = require('aws4');
+const gremlin = require('gremlin');
+const retry = require('async-retry');
+
+const traversal = gremlin.process.AnonymousTraversalSource.traversal;
+const {driver: {DriverRemoteConnection}} = gremlin;
+
+function createHeaders(host, port, path, options) {
+    if (!host || !port) {
+        throw new Error('Host and port are required');
+    }
+
+    const accessKeyId = options.accessKey || process.env.AWS_ACCESS_KEY_ID;
+    const secretAccessKey = options.secretKey || process.env.AWS_SECRET_ACCESS_KEY;
+    const sessionToken = options.sessionToken || process.env.AWS_SESSION_TOKEN;
+    const region = options.region || process.env.AWS_REGION;
+
+    if (!accessKeyId || !secretAccessKey || !region) {
+        throw new Error(
+            'AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY and AWS_REGION are required'
+        );
+    }
+
+    const sigOptions = {
+        host: `${host}:${port}`,
+        region,
+        path,
+        service: 'neptune-db',
+    };
+
+    return aws4.sign(sigOptions, {
+        accessKeyId, secretAccessKey, sessionToken,
+    }).headers;
+}
+
+module.exports = {
+    create: function(host, port, {useIam = true} = {useIam: true}) {
+        let conn = null;
+        let g = null;
+
+        const path = "/gremlin"
+        const url = `wss://${host}:${port}${path}`
+
+        const createRemoteConnection = () => {
+
+            const c = new DriverRemoteConnection(
+                url,
+                {
+                    mimeType: 'application/vnd.gremlin-v2.0+json',
+                    pingEnabled: false,
+                    headers: useIam ? createHeaders(host, port, path, {}) : {}
+                });
+
+            c._client._connection.on('log', message => {
+                console.info(`connection message - ${message}`);
+            });
+
+            c._client._connection.on('close', (code, message) => {
+                console.info(`close - ${code} ${message}`);
+                if (code == 1006){
+                    console.error('Connection closed prematurely');
+                    throw new Error('Connection closed prematurely');
+                }
+            });
+
+            return c;
+        };
+
+        const createGraphTraversalSource = conn => {
+            return traversal().withRemote(conn);
+        };
+
+        return {
+            query: async f => {
+                if (conn == null){
+                    console.info('Initializing connection')
+                    conn = createRemoteConnection();
+                    g = createGraphTraversalSource(conn);
+                }
+
+                return retry(async (bail, count) => {
+                    return f(g).catch(err => {
+                        if(count > 0) console.log('Retry attempt no: ' + count);
+                        if (err.message.startsWith('WebSocket is not open')){
+                            console.warn('Reopening connection');
+                            conn.close();
+                            conn = createRemoteConnection();
+                            g = createGraphTraversalSource(conn);
+                            throw err;
+                        } else if (err.message.includes('ConcurrentModificationException')){
+                            console.warn('Retrying query because of ConcurrentModificationException');
+                            throw err;
+                        } else if (err.message.includes('ReadOnlyViolationException')){
+                            console.warn('Retrying query because of ReadOnlyViolationException');
+                            throw err;
+                        } else {
+                            console.warn('Unrecoverable error: ' + err);
+                            return bail(err);
+                        }
+                    })
+                }, {
+                    factor: 1,
+                    retries: 5
+                });
+            }
+        }
+    }
+}

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "neptune-lambda-client",
+  "version": "1.0.0",
+  "description": "Gremlin client to robustly query AWS Neptune from AWS Lambda",
+  "main": "index.js",
+  "scripts": {
+    "test": "mocha"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/svozza/neptune-lambda-client.git"
+  },
+  "keywords": [
+    "aws",
+    "neptune",
+    "gremlin",
+    "graphdb",
+    "lambda"
+  ],
+  "author": "Stefano Vozza",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/svozza/neptune-lambda-client/issues"
+  },
+  "homepage": "https://github.com/svozza/neptune-lambda-client#readme",
+  "dependencies": {
+    "async-retry": "1.3.3",
+    "aws4": "1.11.0",
+    "gremlin": "3.5.2"
+  }
+}