[DTPPSDK-1319]Add getExperimentation() (#163)

* pass experimentation to url params

* change the param format for experimentation params

* modify getExperimentation function

* use const

* add a test for getExperimentation()

* add null test

* Add empty value test

* add types

* update Experimentation type

* Revert "update Experimentation type"

This reverts commit e5b1c42.

.eslintrc.js

@@ -24,5 +24,6 @@ module.exports = {
 
     // Experiment Variable
     __DISABLE_SET_COOKIE__: true,
+    __EXPERIMENTATION__: true,
   },
 };

src/declarations.js

@@ -33,3 +33,7 @@ declare var __FUNDING_ELIGIBILITY__: FundingEligibilityType;
 
 // Experiment Variable
 declare var __DISABLE_SET_COOKIE__: boolean;
+declare var __EXPERIMENTATION__: {|
+  __EXPERIENCE__?: string,
+  __TREATMENT__?: string,
+|};

src/global.js

@@ -9,6 +9,8 @@ import {
 } from "@paypal/sdk-constants/src";
 import { isDevice } from "@krakenjs/belter/src";
 
+import type { Experimentation } from "./types";
+
 export function getSDKHost(): string {
   return __SDK_HOST__;
 }
@@ -119,3 +121,20 @@ export function getDisableSetCookie(): boolean {
 
   return false;
 }
+
+export function getExperimentation(): Experimentation | null {
+  if (typeof __EXPERIMENTATION__ !== "undefined") {
+    if (__EXPERIMENTATION__) {
+      const experimation: Experimentation = {};
+      if (__EXPERIMENTATION__.__EXPERIENCE__) {
+        experimation.experience = __EXPERIMENTATION__.__EXPERIENCE__;
+      }
+      if (__EXPERIMENTATION__.__TREATMENT__) {
+        experimation.treatment = __EXPERIMENTATION__.__TREATMENT__;
+      }
+      return experimation;
+    }
+  }
+
+  return null;
+}

src/types.js

@@ -3,3 +3,21 @@
 export const _TYPES = true;
 
 export * from "@paypal/sdk-constants/src/types";
+
+export type Experimentation = {
+  experience?: string,
+  treatment?: string,
+  // Workaround for exact type. Works as expected
+  // when dealing with objects that can be empty.
+  // eslint-disable-next-line flowtype/no-weak-types
+  [any]: empty,
+};
+
+export type GetExperimentation = {
+  __EXPERIENCE__?: string,
+  __TREATMENT__?: string,
+  // Workaround for exact type. Works as expected
+  // when dealing with objects that can be empty.
+  // eslint-disable-next-line flowtype/no-weak-types
+  [any]: empty,
+};

test/client/global.js

@@ -21,6 +21,7 @@ import {
   getVersion,
   getCorrelationID,
   getPlatform,
+  getExperimentation,
 } from "../../src";
 
 describe(`globals cases`, () => {
@@ -307,4 +308,52 @@ describe(`globals cases`, () => {
       );
     }
   });
+
+  it("should successfully get experimation value", () => {
+    window.__EXPERIMENTATION__ = {
+      __EXPERIENCE__: "1234, 4321",
+      __TREATMENT__: "8765,7890",
+    };
+    const expectedResult = {
+      experience: "1234, 4321",
+      treatment: "8765,7890",
+    };
+    const result = getExperimentation();
+
+    if (JSON.stringify(result) !== JSON.stringify(expectedResult)) {
+      throw new Error(
+        `Expected experimation to be ${JSON.stringify(
+          expectedResult
+        )}, got ${JSON.stringify(result)}`
+      );
+    }
+  });
+
+  it("should get experimation null value", () => {
+    window.__EXPERIMENTATION__ = null;
+    const expectedResult = null;
+    const result = getExperimentation();
+
+    if (result !== expectedResult) {
+      throw new Error(
+        `Expected experimation to be ${String(expectedResult)}, got ${String(
+          result
+        )}`
+      );
+    }
+  });
+
+  it("should get experimation empty value", () => {
+    window.__EXPERIMENTATION__ = {};
+    const expectedResult = {};
+    const result = getExperimentation();
+
+    if (JSON.stringify(result) !== JSON.stringify(expectedResult)) {
+      throw new Error(
+        `Expected experimation to be ${JSON.stringify(
+          expectedResult
+        )}, got ${JSON.stringify(result)}`
+      );
+    }
+  });
 });

test/globals.js

@@ -1,8 +1,10 @@
 /* @flow */
+import type { GetExperimentation } from "../src/types";
 
 type TestGlobals = {|
   [string]: string | number | boolean | (() => string | (() => number)),
   __COMPONENTS__: $ReadOnlyArray<string>,
+  __EXPERIMENTATION__: GetExperimentation,
 |};
 
 export const sdkClientTestGlobals: TestGlobals = {
@@ -20,4 +22,8 @@ export const sdkClientTestGlobals: TestGlobals = {
   __PAYPAL_API_DOMAIN__: "mock://sandbox.paypal.com",
   __COMPONENTS__: ["buttons"],
   __DISABLE_SET_COOKIE__: true,
+  __EXPERIMENTATION__: {
+    __EXPERIENCE__: "1122",
+    __TREATMENT__: "1234",
+  },
 };