feat(insights): add getInsightsAnonymousUserToken helper (#2887)

package.json

@@ -139,15 +139,15 @@
     },
     {
       "path": "packages/react-instantsearch/dist/umd/Dom.min.js",
-      "maxSize": "33.5 kB"
+      "maxSize": "33.75 kB"
     },
     {
       "path": "packages/react-instantsearch-core/dist/umd/ReactInstantSearchCore.min.js",
       "maxSize": "25 kB"
     },
     {
       "path": "packages/react-instantsearch-dom/dist/umd/ReactInstantSearchDOM.min.js",
-      "maxSize": "36 kB"
+      "maxSize": "36.25 kB"
     },
     {
       "path": "packages/react-instantsearch-dom-maps/dist/umd/ReactInstantSearchDOMMaps.min.js",

packages/react-instantsearch-dom/src/core/__tests__/getInsightsAnonymousUserToken.ts

@@ -0,0 +1,37 @@
+import getInsightsAnonymousUserToken, {
+  ANONYMOUS_TOKEN_COOKIE_KEY,
+} from '../getInsightsAnonymousUserToken';
+
+const DAY = 86400000; /* 1 day in ms*/
+const DATE_TOMORROW = new Date(Date.now() + DAY).toUTCString();
+const DATE_YESTERDAY = new Date(Date.now() - DAY).toUTCString();
+
+const resetCookie = cookieKey => {
+  document.cookie = `${cookieKey}=;expires=Thu, 01-Jan-1970 00:00:01 GMT;`;
+};
+
+describe('getInsightsAnonymousUserToken', () => {
+  beforeEach(() => {
+    resetCookie(ANONYMOUS_TOKEN_COOKIE_KEY);
+  });
+
+  it('should return undefined when no cookies', () => {
+    expect(getInsightsAnonymousUserToken()).toBe(undefined);
+  });
+
+  it('should return undefined when cookie present but expired', () => {
+    document.cookie = `${ANONYMOUS_TOKEN_COOKIE_KEY}=anonymous-uuid;expires=${DATE_YESTERDAY};`;
+    expect(getInsightsAnonymousUserToken()).toBe(undefined);
+  });
+
+  it('should return the anonymous uuid when cookie present and valid', () => {
+    document.cookie = `${ANONYMOUS_TOKEN_COOKIE_KEY}=anonymous-uuid;expires=${DATE_TOMORROW};`;
+    expect(getInsightsAnonymousUserToken()).toBe('anonymous-uuid');
+  });
+
+  it('should return the anonymous uuid when other cookies are invalid', () => {
+    document.cookie = `${ANONYMOUS_TOKEN_COOKIE_KEY}=anonymous-uuid;expires=${DATE_TOMORROW};`;
+    document.cookie = `BAD_COOKIE=val%ue;expires=${DATE_TOMORROW};path=/`;
+    expect(getInsightsAnonymousUserToken()).toBe('anonymous-uuid');
+  });
+});

packages/react-instantsearch-dom/src/core/getInsightsAnonymousUserToken.ts

@@ -0,0 +1,20 @@
+export const ANONYMOUS_TOKEN_COOKIE_KEY = '_ALGOLIA';
+
+function getCookie(name: string): string | undefined {
+  const prefix = `${name}=`;
+  const cookies = document.cookie.split(';');
+  for (let i = 0; i < cookies.length; i++) {
+    let cookie = cookies[i];
+    while (cookie.charAt(0) === ' ') {
+      cookie = cookie.substring(1);
+    }
+    if (cookie.indexOf(prefix) === 0) {
+      return cookie.substring(prefix.length, cookie.length);
+    }
+  }
+  return undefined;
+}
+
+export default function getInsightsAnonymousUserToken(): string | undefined {
+  return getCookie(ANONYMOUS_TOKEN_COOKIE_KEY);
+}

packages/react-instantsearch-dom/src/index.js

@@ -72,3 +72,8 @@ export { createClassNames } from './core/utils';
 
 // voiceSearchHelper
 export { default as createVoiceSearchHelper } from './lib/voiceSearchHelper';
+
+// insights
+export {
+  default as getInsightsAnonymousUserToken,
+} from './core/getInsightsAnonymousUserToken';

packages/react-instantsearch/dom.js

@@ -26,3 +26,4 @@ export { Snippet } from 'react-instantsearch-dom';
 export { SortBy } from 'react-instantsearch-dom';
 export { Stats } from 'react-instantsearch-dom';
 export { ToggleRefinement } from 'react-instantsearch-dom';
+export { getInsightsAnonymousUserToken } from 'react-instantsearch-dom';