@lblod/mu-auth-sudo 0.4.0 → 0.6.0-rc.0

package/README.md

@@ -1,5 +1,5 @@
 # mu-auth-sudo
-NPM package for a sparql client for mu.semte.ch that overrules access rights in queries through a mu-auth-sudo header.
+NPM package for a SPARQL client for mu.semte.ch that overrules access rights in queries through a mu-auth-sudo header.
 
 ## Usage
 ```
@@ -9,6 +9,26 @@ npm install @lblod/mu-auth-sudo
 Include the following in your code
 ```
 import { querySudo as query, updateSudo as update } from '@lblod/mu-auth-sudo';
+
+
+//Examples
+
+// To run a regular query
+
+const queryString = `SELECT * FROM { GRAPH ?g { ?s ?p ?o. } } LIMIT 1`;
+await query(queryString);
+
+// To pass extra headers
+
+const updateString = `INSERT DATA { GRAPH <http://foo> { <http://bar> <http://baz> <http://boom>. } }`;
+const extraHeaders = { 'mu-call-scope-id':  'http://foo/bar', 'other-info'; 'hello' };
+await update(updateString, extraHeaders);
+
+// With custom connection options (this should be exceptional, make sure you know what you're doing)
+
+const connectionOptions = { sparqlEndpoint: 'http://the.custom.endpoint/sparql', mayRetry: true };
+
+await update(updateString, extraHeaders, connectionOptions);
 ```
 
 ## Logging
@@ -21,3 +41,13 @@ The verbosity of logging can be configured as in the [javascript template](https
 - `DEBUG_AUTH_HEADERS`: Debugging of [mu-authorization](https://github.com/mu-semtech/mu-authorization) access-control related headers (default `true`)
 
 Following values are considered true: [`"true"`, `"TRUE"`, `"1"`].
+
+## Retrying
+You can tweak system-wide retry parameters. These should be considered internal, but tweaking them may help in extreme scenarios. Use with extreme caution.
+
+- `SUDO_QUERY_RETRY`: System-wide configuration to enable the retry-mechanism (default `'false'`).
+                        Warning: this overules eventual source-code specifications (i.e. `connectionOptions = { mayRetry: false }`), so make sure you know what you're doing.
+- `SUDO_QUERY_RETRY_MAX_ATTEMPTS`: Specfiy the number of max retry attempts (default: 5)
+- `SUDO_QUERY_RETRY_FOR_HTTP_STATUS_CODES`: Specify what returned HTTP status from the database are allowed for retry. (default: `''`). Overriding this list should be considered case by case.
+- `SUDO_QUERY_RETRY_FOR_CONNECTION_ERRORS`: Specify what connection errors are allowed for retry. (default: `'ECONNRESET,ETIMEDOUT,EAI_AGAIN'`)
+- `SUDO_QUERY_RETRY_TIMEOUT_INCREMENT_FACTOR`: Specify the factor applied to the timeout before the next attempt. Check implementation to see how it is calculated. (default: `'0.3'`)

package/dist/auth-sudo.js

@@ -21,9 +21,23 @@ var LOG_SPARQL_QUERIES = process.env.LOG_SPARQL_QUERIES != undefined ? _envVar2.
 var LOG_SPARQL_UPDATES = process.env.LOG_SPARQL_UPDATES != undefined ? _envVar2.default.get('LOG_SPARQL_UPDATES').asBool() : _envVar2.default.get('LOG_SPARQL_ALL').asBool();
 var DEBUG_AUTH_HEADERS = _envVar2.default.get('DEBUG_AUTH_HEADERS').asBool();
 
+// The following configuration options are considered optional, but may be overriden as a temporary workaround for issues. Thus, a last resort.
+var RETRY = _envVar2.default.get('SUDO_QUERY_RETRY').default('false').asBool();
+var RETRY_MAX_ATTEMPTS = _envVar2.default.get('SUDO_QUERY_RETRY_MAX_ATTEMPTS').default('5').asInt();
+var RETRY_FOR_HTTP_STATUS_CODES = _envVar2.default.get('SUDO_QUERY_RETRY_FOR_HTTP_STATUS_CODES').default('').asArray();
+var RETRY_FOR_CONNECTION_ERRORS = _envVar2.default.get('SUDO_QUERY_RETRY_FOR_CONNECTION_ERRORS').default('ECONNRESET,ETIMEDOUT,EAI_AGAIN').asArray();
+var RETRY_TIMEOUT_INCREMENT_FACTOR = _envVar2.default.get('SUDO_QUERY_RETRY_TIMEOUT_INCREMENT_FACTOR').default('0.3').asFloat();
+
 function sudoSparqlClient() {
   var extraHeaders = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-  var sparqlEndpoint = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : process.env.MU_SPARQL_ENDPOINT;
+  var connectionOptions = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+
+
+  var sparqlEndpoint = process.env.MU_SPARQL_ENDPOINT;
+
+  if (connectionOptions) {
+    sparqlEndpoint = connectionOptions.sparqlEndpoint || sparqlEndpoint;
+  }
 
   var options = {
     requestDefaults: {
@@ -72,42 +86,86 @@ function sudoSparqlClient() {
   return new _sparqlClient.SparqlClient(sparqlEndpoint, options);
 }
 
-function executeRawQuery(queryString) {
+async function executeRawQuery(queryString) {
   var extraHeaders = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
-  var sparqlEndpoint = arguments[2];
+  var connectionOptions = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
+  var attempt = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : 0;
 
-  return sudoSparqlClient(extraHeaders, sparqlEndpoint).query(queryString).executeRaw().then(function (response) {
-    function maybeParseJSON(body) {
-      // Catch invalid JSON
-      try {
-        return JSON.parse(body);
-      } catch (ex) {
-        return null;
-      }
-    }
 
+  if (LOG_SPARQL_QUERIES) {
+    console.log(queryString);
+  }
+
+  try {
+
+    var response = await sudoSparqlClient(extraHeaders, connectionOptions).query(queryString).executeRaw();
     return maybeParseJSON(response.body);
-  });
+  } catch (ex) {
+
+    if (mayRetry(ex, attempt, connectionOptions)) {
+
+      attempt += 1;
+
+      var sleepTime = nextAttemptTimeout(attempt);
+      console.log('Sleeping ' + sleepTime + ' ms before next attempt');
+      await new Promise(function (r) {
+        return setTimeout(r, sleepTime);
+      });
+
+      return await executeRawQuery(queryString, extraHeaders, connectionOptions, attempt);
+    } else throw ex;
+  }
 }
 
 function querySudo(queryString) {
   var extraHeaders = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
-  var sparqlEndpoint = arguments[2];
+  var connectionOptions = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
 
-  if (LOG_SPARQL_QUERIES) {
-    console.log(queryString);
-  }
-  return executeRawQuery(queryString, extraHeaders, sparqlEndpoint);
+  return executeRawQuery(queryString, extraHeaders, connectionOptions);
 }
 
 function updateSudo(queryString) {
   var extraHeaders = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
-  var sparqlEndpoint = arguments[2];
+  var connectionOptions = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
 
-  if (LOG_SPARQL_UPDATES) {
-    console.log(queryString);
+  return executeRawQuery(queryString, extraHeaders, connectionOptions);
+}
+
+function maybeParseJSON(body) {
+  // Catch invalid JSON
+  try {
+    return JSON.parse(body);
+  } catch (ex) {
+    return null;
+  }
+}
+
+function mayRetry(error, attempt) {
+  var connectionOptions = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
+
+
+  console.log('Checking retry allowed for error: ' + error + ' and attempt: ' + attempt);
+
+  var mayRetry = false;
+
+  if (!(RETRY || connectionOptions.mayRetry)) {
+    mayRetry = false;
+  } else if (attempt < RETRY_MAX_ATTEMPTS) {
+    if (error.code && RETRY_FOR_CONNECTION_ERRORS.includes(error.code)) {
+      mayRetry = true;
+    } else if (error.httpStatus && RETRY_FOR_HTTP_STATUS_CODES.includes('' + error.httpStatus)) {
+      mayRetry = true;
+    }
   }
-  return executeRawQuery(queryString, extraHeaders, sparqlEndpoint);
+
+  console.log('Retry allowed? ' + mayRetry);
+
+  return mayRetry;
+}
+
+function nextAttemptTimeout(attempt) {
+  //expected to be milliseconds
+  return Math.round(Math.exp(RETRY_TIMEOUT_INCREMENT_FACTOR * attempt + 10));
 }
 
 var _exports = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lblod/mu-auth-sudo",
-  "version": "0.4.0",
+  "version": "0.6.0-rc.0",
   "description": "this package provides an alternative sparql client for the mu-javascript-template that has sudo rights.",
   "main": "dist/auth-sudo.js",
   "scripts": {
@@ -33,8 +33,8 @@
   "homepage": "https://github.com/lblod/mu-auth-sudo#readme",
   "devDependencies": {
     "babel-cli": "^6.26.0",
+    "babel-plugin-add-module-exports": "^1.0.4",
     "babel-preset-env": "^1.7.0",
-    "babel-plugin-add-module-exports": "^1.0.0",
     "babel-preset-es2015": "^6.24.1",
     "babel-register": "^6.26.0"
   },