feat(UserAgent): add user agent string (#100)

* feat(UserAgent): add user agent string

* fix: remove vanilla from UA string

Co-Authored-By: tkrugg <tkrugg@users.noreply.github.com>

* feedback: remove destructuring

Author: tkrugg

lib/__tests__/_sendEvent.test.ts

@@ -1,9 +1,14 @@
 import AlgoliaInsights from "../insights";
 import * as url from "url";
+import * as querystring from "querystring";
+
+jest.mock("../../package.json", () => ({
+  version: "1.0.1"
+}));
 
 const credentials = {
-  apiKey: "test",
-  appId: "test"
+  apiKey: "testKey",
+  appId: "testId"
 };
 
 describe("sendEvent", () => {
@@ -54,6 +59,20 @@ describe("sendEvent", () => {
         ]
       });
     });
+    it("should include X-Algolia-* query parameters", () => {
+      (AlgoliaInsights as any).sendEvent("click", {
+        eventName: "my-event",
+        index: "my-index",
+        objectIDs: ["1"]
+      });
+      const requestUrl = XMLHttpRequest.open.mock.calls[0][1];
+      const { query } = url.parse(requestUrl);
+      expect(querystring.parse(query)).toEqual({
+        "X-Algolia-API-Key": "testKey",
+        "X-Algolia-Agent": "Algolia insights for JavaScript (1.0.1)",
+        "X-Algolia-Application-Id": "testId"
+      });
+    });
   });
 
   describe("with sendBeacon", () => {
@@ -100,6 +119,20 @@ describe("sendEvent", () => {
         ]
       });
     });
+    it("should include X-Algolia-* query parameters", () => {
+      (AlgoliaInsights as any).sendEvent("click", {
+        eventName: "my-event",
+        index: "my-index",
+        objectIDs: ["1"]
+      });
+      const requestUrl = sendBeacon.mock.calls[0][0];
+      const { query } = url.parse(requestUrl);
+      expect(querystring.parse(query)).toEqual({
+        "X-Algolia-API-Key": "testKey",
+        "X-Algolia-Agent": "Algolia insights for JavaScript (1.0.1)",
+        "X-Algolia-Application-Id": "testId"
+      });
+    });
   });
 
   describe("init", () => {
@@ -277,6 +310,7 @@ describe("sendEvent", () => {
       });
     });
   });
+
   describe("filters", () => {
     it("should pass over provided filters", () => {
       (AlgoliaInsights as any).sendEvent("click", {

lib/_sendEvent.ts

@@ -1,4 +1,5 @@
 import { isNumber, isUndefined, isString, isFunction } from "./utils/index";
+import { version } from "../package.json";
 
 export type InsightsEventType = "click" | "conversion" | "view";
 export type InsightsEvent = {
@@ -16,6 +17,9 @@ export type InsightsEvent = {
   filters?: string[];
 };
 
+const USER_AGENT = encodeURIComponent(
+  `Algolia insights for JavaScript (${version})`
+);
 /**
  *  Sends data to endpoint
  * @param eventType InsightsEventType
@@ -104,9 +108,7 @@ export function sendEvent(
     throw new Error("expected either `objectIDs` or `filters` to be provided");
   }
 
-  bulkSendEvent(this._appId, this._apiKey, this._endpointOrigin, [
-    event
-  ]);
+  bulkSendEvent(this._appId, this._apiKey, this._endpointOrigin, [event]);
 }
 
 function bulkSendEvent(
@@ -116,7 +118,7 @@ function bulkSendEvent(
   events: InsightsEvent[]
 ) {
   // Auth query
-  const reportingURL = `${endpointOrigin}/1/events?X-Algolia-Application-Id=${appId}&X-Algolia-API-Key=${apiKey}`;
+  const reportingURL = `${endpointOrigin}/1/events?X-Algolia-Application-Id=${appId}&X-Algolia-API-Key=${apiKey}&X-Algolia-Agent=${USER_AGENT}`;
 
   // Detect navigator support
   const supportsNavigator = navigator && isFunction(navigator.sendBeacon);