feat(mcm): add methods for multi cluster management (algolia#643)

Haroenv · web-flow · commit 31bfc5547dc7 · 2017-12-13T18:20:14.000+01:00
* feat(mcm): add methods for multi cluster management

Also have added the option to add `headers` to `_jsonRequest` and changed it into an object-accepting function for "future-proofing" it

* fix(mcm): mark as correct as read query

* chore(mcm): don't have unused parameters when only callback
diff --git a/src/AlgoliaSearch.js b/src/AlgoliaSearch.js
@@ -487,6 +487,159 @@ AlgoliaSearch.prototype.batch = function(operations, callback) {
   });
 };
 
+/**
+ * Assign or Move a userID to a cluster
+ *
+ * @param {string} data.userID The userID to assign to a new cluster
+ * @param {string} data.cluster The cluster to assign the user to
+ * @return {Promise|undefined} Returns a promise if no callback given
+ * @example
+ * client.assignUserID({ cluster: 'c1-test', userID: 'some-user' });
+ */
+AlgoliaSearch.prototype.assignUserID = function(data, callback) {
+  if (!data.userID || !data.cluster) {
+    throw new errors.AlgoliaSearchError('You have to provide both a userID and cluster', data);
+  }
+  return this._jsonRequest({
+    method: 'POST',
+    url: '/1/clusters/mapping',
+    hostType: 'write',
+    body: {cluster: data.cluster},
+    callback: callback,
+    headers: {
+      'X-Algolia-User-ID': data.userID
+    }
+  });
+};
+
+/**
+ * Get the top userIDs
+ *
+ * (the callback is the second argument)
+ *
+ * @return {Promise|undefined} Returns a promise if no callback given
+ * @example
+ * client.getTopUserID();
+ */
+AlgoliaSearch.prototype.getTopUserID = function(callback) {
+  return this._jsonRequest({
+    method: 'GET',
+    url: '/1/clusters/mapping/top',
+    hostType: 'read',
+    callback: callback
+  });
+};
+
+/**
+ * Get userID
+ *
+ * @param {string} data.userID The userID to get info about
+ * @return {Promise|undefined} Returns a promise if no callback given
+ * @example
+ * client.getUserID({ userID: 'some-user' });
+ */
+AlgoliaSearch.prototype.getUserID = function(data, callback) {
+  if (!data.userID) {
+    throw new errors.AlgoliaSearchError('You have to provide a userID', {debugData: data});
+  }
+  return this._jsonRequest({
+    method: 'GET',
+    url: '/1/clusters/mapping/' + data.userID,
+    hostType: 'read',
+    callback: callback
+  });
+};
+
+/**
+ * List all the clusters
+ *
+ * (the callback is the second argument)
+ *
+ * @return {Promise|undefined} Returns a promise if no callback given
+ * @example
+ * client.listClusters();
+ */
+AlgoliaSearch.prototype.listClusters = function(callback) {
+  return this._jsonRequest({
+    method: 'GET',
+    url: '/1/clusters',
+    hostType: 'read',
+    callback: callback
+  });
+};
+
+/**
+ * List the userIDs
+ *
+ * (the callback is the second argument)
+ *
+ * @param {string} data.hitsPerPage How many hits on every page
+ * @param {string} data.page The page to retrieve
+ * @return {Promise|undefined} Returns a promise if no callback given
+ * @example
+ * client.listClusters();
+ * client.listClusters({ page: 3, hitsPerPage: 30});
+ */
+AlgoliaSearch.prototype.listUserIDs = function(data, callback) {
+  return this._jsonRequest({
+    method: 'GET',
+    url: '/1/clusters/mapping',
+    body: data,
+    hostType: 'read',
+    callback: callback
+  });
+};
+
+/**
+ * Remove an userID
+ *
+ * @param {string} data.userID The userID to assign to a new cluster
+ * @return {Promise|undefined} Returns a promise if no callback given
+ * @example
+ * client.removeUserID({ userID: 'some-user' });
+ */
+AlgoliaSearch.prototype.removeUserID = function(data, callback) {
+  if (!data.userID) {
+    throw new errors.AlgoliaSearchError('You have to provide a userID', {debugData: data});
+  }
+  return this._jsonRequest({
+    method: 'DELETE',
+    url: '/1/clusters/mapping',
+    hostType: 'write',
+    callback: callback,
+    headers: {
+      'X-Algolia-User-ID': data.userID
+    }
+  });
+};
+
+/**
+ * Search for userIDs
+ *
+ * @param {string} data.cluster The cluster to target
+ * @param {string} data.query The query to execute
+ * @param {string} data.hitsPerPage How many hits on every page
+ * @param {string} data.page The page to retrieve
+ * @return {Promise|undefined} Returns a promise if no callback given
+ * @example
+ * client.searchUserIDs({ cluster: 'c1-test', query: 'some-user' });
+ * client.searchUserIDs({
+ *   cluster: "c1-test",
+ *   query: "some-user",
+ *   page: 3,
+ *   hitsPerPage: 2
+ * });
+ */
+AlgoliaSearch.prototype.searchUserIDs = function(data, callback) {
+  return this._jsonRequest({
+    method: 'POST',
+    url: '/1/clusters/mapping/search',
+    body: data,
+    hostType: 'read',
+    callback: callback
+  });
+};
+
 // environment specific methods
 AlgoliaSearch.prototype.destroy = notImplemented;
 AlgoliaSearch.prototype.enableRateLimitForward = notImplemented;
diff --git a/src/AlgoliaSearchCore.js b/src/AlgoliaSearchCore.js
@@ -199,9 +199,16 @@ AlgoliaSearchCore.prototype._jsonRequest = function(initialOpts) {
     initialOpts.body.requests !== undefined) // client.search()
   ) {
     initialOpts.body.apiKey = this.apiKey;
-    headers = this._computeRequestHeaders(additionalUA, false);
+    headers = this._computeRequestHeaders({
+      additionalUA: additionalUA,
+      withApiKey: false,
+      headers: initialOpts.headers
+    });
   } else {
-    headers = this._computeRequestHeaders(additionalUA);
+    headers = this._computeRequestHeaders({
+      additionalUA: additionalUA,
+      headers: initialOpts.headers
+    });
   }
 
   if (initialOpts.body !== undefined) {
@@ -258,7 +265,10 @@ AlgoliaSearchCore.prototype._jsonRequest = function(initialOpts) {
         reqOpts.body = safeJSONStringify(reqOpts.jsonBody);
       }
       // re-compute headers, they could be omitting the API KEY
-      headers = client._computeRequestHeaders(additionalUA);
+      headers = client._computeRequestHeaders({
+        additionalUA: additionalUA,
+        headers: initialOpts.headers
+      });
 
       reqOpts.timeouts = client._getTimeoutsForRequest(initialOpts.hostType);
       client._setHostIndexByType(0, initialOpts.hostType);
@@ -474,11 +484,18 @@ AlgoliaSearchCore.prototype._getSearchParams = function(args, params) {
   return params;
 };
 
-AlgoliaSearchCore.prototype._computeRequestHeaders = function(additionalUA, withAPIKey) {
+/**
+ * Compute the headers for a request
+ *
+ * @param [string] options.additionalUA semi-colon separated string with other user agents to add
+ * @param [boolean=true] options.withAPIKey Send the api key as a header
+ * @param [Object] options.headers Extra headers to send
+ */
+AlgoliaSearchCore.prototype._computeRequestHeaders = function(options) {
   var forEach = require('foreach');
 
-  var ua = additionalUA ?
-    this._ua + ';' + additionalUA :
+  var ua = options.additionalUA ?
+    this._ua + ';' + options.additionalUA :
     this._ua;
 
   var requestHeaders = {
@@ -490,7 +507,7 @@ AlgoliaSearchCore.prototype._computeRequestHeaders = function(additionalUA, with
   // but in some situations, the API KEY will be too long (big secured API keys)
   // so if the request is a POST and the KEY is very long, we will be asked to not put
   // it into headers but in the JSON body
-  if (withAPIKey !== false) {
+  if (options.withAPIKey !== false) {
     requestHeaders['x-algolia-api-key'] = this.apiKey;
   }
 
@@ -506,6 +523,12 @@ AlgoliaSearchCore.prototype._computeRequestHeaders = function(additionalUA, with
     requestHeaders[key] = value;
   });
 
+  if (options.headers) {
+    forEach(options.headers, function addToRequestHeaders(value, key) {
+      requestHeaders[key] = value;
+    });
+  }
+
   return requestHeaders;
 };
 
diff --git a/test/spec/common/client/interface.js b/test/spec/common/client/interface.js
@@ -24,6 +24,7 @@ test('AlgoliaSearch client API spec', function(t) {
     'addQueryInBatch',
     'addUserKey',
     'addUserKeyWithValidity',
+    'assignUserID',
     'batch',
     'clearCache',
     'copyIndex',
@@ -34,13 +35,19 @@ test('AlgoliaSearch client API spec', function(t) {
     'getExtraHeader',
     'getLogs',
     'getTimeouts',
+    'getTopUserID',
+    'getUserID',
     'getUserKeyACL',
     'initIndex',
     'listApiKeys',
+    'listClusters',
     'listIndexes',
+    'listUserIDs',
     'listUserKeys',
     'moveIndex',
+    'removeUserID',
     'search',
+    'searchUserIDs',
     'sendQueriesBatch',
     'setExtraHeader',
     'setRequestTimeout',
diff --git a/test/spec/common/client/test-cases/assignUserID.js b/test/spec/common/client/test-cases/assignUserID.js
@@ -0,0 +1,15 @@
+'use strict';
+
+module.exports = [{
+  testName: 'client.assignUserID({userID, cluster}, cb)',
+  object: 'client',
+  methodName: 'assignUserID',
+  callArguments: [{userID: 'hi', cluster: 'the big one'}],
+  action: 'write',
+  expectedRequest: {
+    method: 'POST',
+    body: {cluster: 'the big one'},
+    URL: {pathname: '/1/clusters/mapping'},
+    headers: {'x-algolia-user-id': 'hi'}
+  }
+}];
diff --git a/test/spec/common/client/test-cases/getTopUserID.js b/test/spec/common/client/test-cases/getTopUserID.js
@@ -0,0 +1,13 @@
+'use strict';
+
+module.exports = [{
+  testName: 'client.getTopUserID(cb)',
+  object: 'client',
+  methodName: 'getTopUserID',
+  callArguments: [],
+  action: 'read',
+  expectedRequest: {
+    method: 'GET',
+    URL: {pathname: '/1/clusters/mapping/top'}
+  }
+}];
diff --git a/test/spec/common/client/test-cases/getUserID.js b/test/spec/common/client/test-cases/getUserID.js
@@ -0,0 +1,13 @@
+'use strict';
+
+module.exports = [{
+  testName: 'client.getUserID({ userID }, cb)',
+  object: 'client',
+  methodName: 'getUserID',
+  callArguments: [{userID: 'cool-user'}],
+  action: 'read',
+  expectedRequest: {
+    method: 'GET',
+    URL: {pathname: '/1/clusters/mapping/cool-user'}
+  }
+}];
diff --git a/test/spec/common/client/test-cases/listClusters.js b/test/spec/common/client/test-cases/listClusters.js
@@ -0,0 +1,13 @@
+'use strict';
+
+module.exports = [{
+  testName: 'client.listClusters(cb)',
+  object: 'client',
+  methodName: 'listClusters',
+  callArguments: [],
+  action: 'read',
+  expectedRequest: {
+    method: 'GET',
+    URL: {pathname: '/1/clusters'}
+  }
+}];
diff --git a/test/spec/common/client/test-cases/listUserIDs.js b/test/spec/common/client/test-cases/listUserIDs.js
@@ -0,0 +1,36 @@
+'use strict';
+
+module.exports = [{
+  testName: 'client.listUserIDs(undefined, cb)',
+  object: 'client',
+  methodName: 'listUserIDs',
+  callArguments: [undefined],
+  action: 'read',
+  expectedRequest: {
+    method: 'GET',
+    body: undefined,
+    URL: {pathname: '/1/clusters/mapping'}
+  }
+}, {
+  testName: 'client.listUserIDs({page}, cb)',
+  object: 'client',
+  methodName: 'listUserIDs',
+  callArguments: [{page: 5}],
+  action: 'read',
+  expectedRequest: {
+    method: 'GET',
+    body: {page: 5},
+    URL: {pathname: '/1/clusters/mapping'}
+  }
+}, {
+  testName: 'client.listUserIDs({page, hitsPerPage}, cb)',
+  object: 'client',
+  methodName: 'listUserIDs',
+  callArguments: [{page: 5, hitsPerPage: 3}],
+  action: 'read',
+  expectedRequest: {
+    method: 'GET',
+    body: {page: 5, hitsPerPage: 3},
+    URL: {pathname: '/1/clusters/mapping'}
+  }
+}];
diff --git a/test/spec/common/client/test-cases/removeUserID.js b/test/spec/common/client/test-cases/removeUserID.js
@@ -0,0 +1,15 @@
+'use strict';
+
+module.exports = [{
+  testName: 'client.removeUserID({userID, cluster}, cb)',
+  object: 'client',
+  methodName: 'removeUserID',
+  callArguments: [{userID: 'hi'}],
+  action: 'write',
+  expectedRequest: {
+    method: 'DELETE',
+    body: undefined,
+    URL: {pathname: '/1/clusters/mapping'},
+    headers: {'x-algolia-user-id': 'hi'}
+  }
+}];
diff --git a/test/spec/common/client/test-cases/searchUserIDs.js b/test/spec/common/client/test-cases/searchUserIDs.js
