feat(core): sends a custom User Agent

Author: Alexandre Stanislawski

lib/InstantSearch.js

@@ -8,6 +8,7 @@ let union = require('lodash/array/union');
 let EventEmitter = require('events').EventEmitter;
 
 let urlSyncWidget = require('./url-sync');
+let version = require('./version');
 
 function defaultCreateURL() { return '#'; }
 
@@ -19,9 +20,14 @@ function defaultCreateURL() { return '#'; }
  * @param  {string} [options.numberLocale] The locale used to display numbers.
  * @param  {string} [options.searchParameters] Initial search configuration.
  * @param  {string} [options.urlSync] Url synchronization configuration.
- * @param  {string} [options.urlSync.trackedParameters] Parameters that will be synchronized in the URL. By default, it will track the query, all the refinable attribute (facets and numeric filters), the index and the page.
- * @param  {string} [options.urlSync.useHash] If set to true, the url will be hash based. Otherwise, it'll use the query parameters using the modern history API.
- * @param  {string} [options.urlSync.threshold] Time in ms after which a new state is created in the browser history. The default value is 700.
+ * @param  {string} [options.urlSync.trackedParameters] Parameters that will
+ * be synchronized in the URL. By default, it will track the query, all the
+ * refinable attribute (facets and numeric filters), the index and the page.
+ * @param  {string} [options.urlSync.useHash] If set to true, the url will be
+ * hash based. Otherwise, it'll use the query parameters using the modern
+ * history API.
+ * @param  {string} [options.urlSync.threshold] Time in ms after which a new
+ * state is created in the browser history. The default value is 700.
  * @return {Object} the instantsearch instance
  */
 class InstantSearch extends EventEmitter {
@@ -45,6 +51,7 @@ Usage: instantsearch({
     }
 
     let client = algoliasearch(appId, apiKey);
+    client.addAlgoliaAgent('instantsearch.js ' + version);
 
     this.client = client;
     this.helper = null;
@@ -62,7 +69,8 @@ Usage: instantsearch({
    * Add a widget
    * @param  {Object} [widget] The widget to add
    * @param  {function} [widget.render] Called after each search response has been received
-   * @param  {function} [widget.getConfiguration] Let the widget update the configuration of the search with new parameters
+   * @param  {function} [widget.getConfiguration] Let the widget update the configuration
+   * of the search with new parameters
    * @param  {function} [widget.init] Called once before the first search
    * @return {Object} the added widget
    */

lib/__tests__/InstantSearch-test.js

@@ -23,7 +23,7 @@ describe('InstantSearch lifecycle', () => {
   let search;
 
   beforeEach(() => {
-    client = {algolia: 'client'};
+    client = {algolia: 'client', addAlgoliaAgent: () => {}};
     helper = new EventEmitter();
 
     helper.search = sinon.spy();