Add idempotency in requests (#482)

* Add idempotency in requests

* Drop getToken in lib/api.js

Author: ad-m

bin/generic/credential/password/add/index.js

@@ -2,6 +2,7 @@
 
 const Cli = require('lib/cli');
 const credentials = require('lib/credentials');
+const crypto = require('lib/crypto');
 
 const options = {
     name: {
@@ -40,7 +41,7 @@ module.exports = (resource) => Cli.createCommand('add', {
         let password = args.password;
 
         if (!password) {
-            password = await credentials.randomPassword();
+            password = await crypto.randomPassword();
             console.error(`The generated password is: ${password}`);
         }
 

lib/api.js

@@ -1,5 +1,5 @@
 'use strict';
-
+const crypto = require('./crypto');
 const superagent = require('superagent');
 const Cookie = require('cookie');
 const WebSocket = require('ws');
@@ -17,6 +17,7 @@ const API_SSH_PORT = process.env.API_SSH_PORT || 22;
 
 const API_URL = API_SECURE ? `https://${API_HOSTNAME}/v1` : `http://${API_HOSTNAME}/v1`;
 const WS_URL = API_SECURE ? `wss://${API_HOSTNAME}/ws` : `ws://${API_HOSTNAME}/ws`;
+const RETRY_IDEMPOTENT_COUNT = 3;
 
 const SSH_SERVER_HOST_KEY = '3e2aa423d42d7e8b14d50625512c8ac19db767ed';
 
@@ -246,14 +247,14 @@ const update = async (method, uri, body) => {
     if (verbose && !!body) {
         logger('verbose', 'body', JSON.stringify(body, null, 2));
     }
-
     const prefer_async = 'no-wait' in args && args['no-wait'];
     const prefer_value = prefer_async ? 'respond-async,wait=0' : `respond-async,wait=${60 * 60 * 24}`;
 
     const res = await api(method, uri)
         .send(body)
-        .set({ Prefer: prefer_value });
-
+        .set({ Prefer: prefer_value })
+        .set({ 'x-idempotency-key': await crypto.randomPassword()})
+        .retry(RETRY_IDEMPOTENT_COUNT);
     saveCookie(res);
     if (verbose) {
         logger('verbose', 'status', res.status);

lib/credentials.js

@@ -81,19 +81,11 @@ const getCredentialCreate = async (args, credential_types) => {
     return credential;
 };
 
-const randomPassword = (size = 15) => new Promise((resolve, reject) =>
-    crypto.randomBytes(size, function (err, buffer) {
-        if (err) {
-            reject(err);
-        }
-        resolve(buffer.toString('hex'));
-    })
-);
+
 
 module.exports = {
     getCredentialCreate,
     hashPassword,
-    randomPassword,
     password_types,
     types,
 };

lib/crypto.js

@@ -0,0 +1,16 @@
+'use strict';
+
+const crypto = require('crypto');
+
+const randomPassword = (size = 15) => new Promise((resolve, reject) =>
+    crypto.randomBytes(size, function (err, buffer) {
+        if (err) {
+            return reject(err);
+        }
+        return resolve(buffer.toString('hex'));
+    })
+);
+
+module.exports = {
+    randomPassword,
+};

lib/tests.js

@@ -1,5 +1,5 @@
 'use strict';
-const crypto = require('crypto');
+const crypto = require('./crypto');
 const { spawn } = require('child_process');
 const shell_quote = require('shell-quote');
 const os = require('os');
@@ -322,13 +322,6 @@ const resourceAccessCycle = (type, project, options = {}) => wrap(type, options,
     }
 });
 
-const getToken = () => new Promise((resolve, reject) => crypto.randomBytes(48, function (err, buffer) {
-    if (err) {
-        reject(err);
-    }
-    resolve(buffer.toString('hex'));
-}));
-
 const randomFileName = () => path.join(os.tmpdir(), `test-h1-cli-${now}-${Math.random()}`);
 
 const getRandomFile = (content = 'some-content') => {
@@ -379,7 +372,7 @@ const passwordLifeCycle = async (t, type, resource) => {
     const new_name = `renamed-${name}`;
 
     await run(`${type} credential list --${type} ${resource.name}`);
-    const secret = await getToken();
+    const secret = await crypto.getPassword();
     await run(`${type} credential password add --name ${name} --password ${secret} --${type} ${resource.name}`);
     const list = await run(`${type} credential password list --${getOption(type)} ${resource.name}`);
     t.true(list.some(p => p.name === name));
@@ -478,7 +471,7 @@ const logStreamProcess = async (t, type, resource, trigger) => {
     await delay(2000); // allows wss connection to start
     const ids = [];
     for (let i = 0; i <= 10; i++) {
-        const id_request = await getToken();
+        const id_request = await crypto.getPassword();
         await trigger(id_request);
         ids.push(id_request);
     }
@@ -546,7 +539,7 @@ module.exports = {
     // tests for environment
     requireSlaveProject,
     // requirements
-    getToken,
+    getToken: crypto.randomPassword, // back-ward compatibility
     getRandomFile,
     runProcess,
     randomFileName,