Merge pull request #59 from AddSearch/sc-9487/add-method-to-intercept-api-request

[sc-9487] add setApiRequestInterceptor

Author: haoAddsearch

README.md

@@ -408,11 +408,30 @@ client.setThrottleTime(500);
 ```
 
 #### Set API hostname
+`option` is an object with the following properties, all of which are optional. If `option` is not defined, host name will be applied for all requests.
+- **searchApiRequestOnly**: If true, the new host name is only applied for searchApi requests (default: false)
+- **statsApiRequestOnly**: If true, the new host name is only applied for statsApi requests (default: false)
 ```js
 // Set API hostname (e.g. for dedicated environments)
 client.setApiHostname('api.addsearch.com');
 ```
 
+#### Set API request interceptor
+`configurationObject` contains 2 keys: <string>`url` and <object>`headers`. Modify the `configurationObject` before it is sent.
+
+`option` is an object with the following properties, all of which are optional. If `option` is not defined, the interceptor will be used for all requests.
+- **searchApiRequestOnly**: If true, the interceptor is only used for searchApi requests (default: false)
+- **statsApiRequestOnly**: If true, the interceptor is only used for statsApi requests (default: false)
+
+```js
+function callback(configurationObject) {
+  configurationObject.headers['X-Api-Key'] = 'YOUR API KEY';
+  return configurationObject;
+}
+client.setApiRequestInterceptor(callback, option);
+```
+
+
 ## Indexing API
 With the Indexing API, you can fetch, create, update, and delete single documents or
 batches of documents.

dist/addsearch-js-client.min.js

@@ -1,6 +1,6 @@
 {
   "name": "addsearch-js-client",
-  "version": "0.8.9",
+  "version": "0.8.10",
   "description": "AddSearch API JavaScript client",
   "main": "index.js",
   "jsdelivr": "./dist/addsearch-js-client.min.js",

package.json

@@ -0,0 +1,25 @@
+'use strict';
+
+const axios = require('axios').default;
+const apiInstance = axios.create();
+const statsInstance = axios.create();
+
+const setRequestInterceptor = (callback, requestType) => {
+  const axiosInstance = requestType === 'searchApi' ? apiInstance : statsInstance;
+  axiosInstance.interceptors.request.use( (config) => {
+    const updatedConfig = callback({
+      url: config.url,
+      headers: config.headers
+    });
+    config = {...config, ...updatedConfig};
+    return config;
+  }, function (error) {
+    return Promise.reject(error);
+  });
+};
+
+module.exports = {
+  apiInstance,
+  statsInstance,
+  setRequestInterceptor
+};

src/api.js

@@ -1,7 +1,7 @@
 'use strict';
 
 require('es6-promise').polyfill();
-const axios = require('axios').default;
+const apiInstance = require('./api').apiInstance;
 
 /**
  * Fetch search results of search suggestions from the Addsearch API
@@ -174,7 +174,7 @@ var executeApiFetch = function(apiHostname, sitekey, type, settings, cb, fuzzyRe
     'https://' + apiHostname + '/v1/' + apiPath + '/' + sitekey + '?configurationKey=' + recommendOptions.configurationKey + qs :
     'https://' + apiHostname + '/v1/' + apiPath + '/' + sitekey + '?term=' + kw + qs;
 
-  axios.get(api)
+  apiInstance.get(api)
     .then(function(response) {
       var json = response.data;
       // Search again with fuzzy=true if no hits

src/apifetch.js

@@ -7,6 +7,7 @@ var Settings = require('./settings');
 var util = require('./util');
 var throttle = require('./throttle');
 var cookie = require('./cookie');
+var setRequestInterceptor = require('./api').setRequestInterceptor;
 
 var API_HOSTNAME = 'api.addsearch.com';
 var USER_TOKEN_COOKIE_NAME = 'addsearchUserToken';
@@ -15,6 +16,7 @@ var client = function(sitekey, privatekey) {
   this.sitekey = sitekey;
   this.privatekey = privatekey;
   this.apiHostname = API_HOSTNAME;
+  this.statsApiHostname = API_HOSTNAME;
   this.settings = new Settings();
   this.sessionId = ('a-' + (Math.random() * 100000000)).substring(0, 10);
   this.userTokenInPersonalization = cookie.getCookie(USER_TOKEN_COOKIE_NAME) || util.generateUUID();
@@ -173,7 +175,14 @@ var client = function(sitekey, privatekey) {
   /**
    * Public functions
    */
-  this.setApiHostname = function(hostname) {this.apiHostname = hostname;}
+  this.setApiHostname = function(hostname, conf) {
+    if (!conf || !conf.statsApiRequestOnly) {
+      this.apiHostname = hostname;
+    }
+    if (!conf || !conf.searchApiRequestOnly) {
+      this.statsApiHostname = hostname;
+    }
+  }
   this.getSettings = function() {return this.settings.getSettings();}
   this.setLanguage = function(lang) {this.settings.setLanguage(lang);}
   this.setCategoryFilters = function(categories) {this.settings.setCategoryFilters(categories);}
@@ -227,7 +236,7 @@ var client = function(sitekey, privatekey) {
         numberOfResults: data.numberOfResults,
         tag: this.getSettings().analyticsTag
       };
-      sendStats(this.apiHostname, this.sitekey, payload);
+      sendStats(this.statsApiHostname, this.sitekey, payload, this.settings.getSettings().statsRequestIntercepted);
     }
 
     else if (type === 'click') {
@@ -239,7 +248,7 @@ var client = function(sitekey, privatekey) {
         position: data.position,
         tag: this.getSettings().analyticsTag
       };
-      sendStats(this.apiHostname, this.sitekey, payload);
+      sendStats(this.statsApiHostname, this.sitekey, payload, this.settings.getSettings().statsRequestIntercepted);
     }
 
     else {
@@ -269,6 +278,32 @@ var client = function(sitekey, privatekey) {
     isAddSearchCookieConsented = !!isEnabled;
   };
 
+  /*
+   * API interceptor
+   */
+  this.setApiRequestInterceptor = function(callback, option = {}) {
+    if (typeof callback !== 'function') {
+      window.console.error('API interceptor must be a function');
+      return;
+    }
+
+    const { searchApiRequestOnly = false, statsApiRequestOnly = false } = option;
+
+    if (!searchApiRequestOnly && !statsApiRequestOnly) {
+      setRequestInterceptor(callback, 'searchApi');
+      setRequestInterceptor(callback, 'statsApi');
+      this.settings.setStatsRequestIntercepted(true);
+    } else {
+      if (searchApiRequestOnly)  {
+        setRequestInterceptor(callback, 'searchApi');
+      }
+      if (statsApiRequestOnly)  {
+        setRequestInterceptor(callback, 'statsApi');
+        this.settings.setStatsRequestIntercepted(true);
+      }
+    }
+  };
+
 
   // Deprecated
   this.searchResultClicked = function(documentId, position) {

src/index.js

@@ -22,7 +22,8 @@ var settings = function() {
     },
     searchOperator: null,
     enableLogicalOperators: false,
-    cacheResponseTime: null
+    cacheResponseTime: null,
+    statsRequestIntercepted: false,
   };
 
   this.getSettings = function() {
@@ -232,6 +233,10 @@ var settings = function() {
     }
     this.settings.searchOperator = operator;
   }
+
+  this.setStatsRequestIntercepted = function(isIntercepted) {
+    this.settings.statsRequestIntercepted = isIntercepted;
+  };
 }
 
 module.exports = settings;

src/settings.js

@@ -1,23 +1,23 @@
 'use strict';
 
 require('es6-promise').polyfill();
-const axios = require('axios').default;
+const statsInstance = require('./api').statsInstance;
 
-var sendStats = function(apiHostname, sitekey, payload) {
+var sendStats = function(apiHostname, sitekey, payload, statsRequestIntercepted) {
 
   // Beacon in browsers
-  if (typeof window !== 'undefined' && window.navigator && window.navigator.sendBeacon) {
+  if (typeof window !== 'undefined' && window.navigator && window.navigator.sendBeacon && !statsRequestIntercepted) {
     navigator.sendBeacon('https://' + apiHostname + '/v1/stats/' + sitekey + '/', JSON.stringify(payload));
   }
 
   // POST in node
   else {
-    axios.post('https://' + apiHostname + '/v1/stats/' + sitekey + '/', payload, {
+    statsInstance.post('https://' + apiHostname + '/v1/stats/' + sitekey + '/', payload, {
       headers: {
         'Content-Type': 'text/plain',
       }
     });
   }
 };
 
-module.exports = sendStats;
+module.exports = sendStats;

src/stats.js

@@ -1,8 +1,8 @@
 var assert = require('assert');
 var apifetch = require('../src/apifetch');
 var MockAdapter = require("axios-mock-adapter");
-const axios = require('axios').default;
-var mock = new MockAdapter(axios);
+var apiInstance = require('../src/api').apiInstance;
+var mock = new MockAdapter(apiInstance);
 
 mock.onAny().reply(200, { response: 200 });