Adding globalSession to maintain the global_paypal storage (#228)

* Adding globalSession to maintain the global_paypal storage

* Improving error handling capability on globalSession

Author: gusveloso

src/globalSession.js

@@ -0,0 +1,53 @@
+/* @flow */
+
+import { getStorage, type Storage } from "@krakenjs/belter/src";
+import { ZalgoPromise } from "@krakenjs/zalgo-promise/src";
+
+import { getVersion } from "./global";
+import { getLogger } from "./logger";
+
+const GLOBAL_SESSION_ID_KEY = "globalSessionID";
+
+export function getGlobalSessionName(): string {
+  let version = getVersion();
+  if (!version) {
+    getLogger().warn("global_session_no_sdk_version");
+    version = "unknown";
+  }
+  const sdkVersion = String(version).replace(/[\W]+/g, "_");
+  return `paypal_global_${sdkVersion}`;
+}
+
+function getGlobalSessionStorage(): Storage {
+  return getStorage({ name: getGlobalSessionName() });
+}
+
+function getGlobalStorageState<T>(handler: (storage: Object) => T): T {
+  return getGlobalSessionStorage().getState(handler);
+}
+
+export function getGlobalSessionID(): string | void {
+  const globalSessionID = getGlobalStorageState((state) => {
+    if (
+      !state ||
+      typeof state !== "object" ||
+      !state.hasOwnProperty(GLOBAL_SESSION_ID_KEY)
+    ) {
+      getLogger().warn("global_session_not_found");
+      return undefined;
+    }
+    return ZalgoPromise.resolve(state[GLOBAL_SESSION_ID_KEY]);
+  });
+  return globalSessionID?.value;
+}
+
+export function setGlobalSessionID(sessionID: string): void {
+  getGlobalSessionStorage().getState((state) => {
+    if (!state || typeof state !== "object") {
+      getLogger().warn("global_session_no_storage_state_found");
+      state = {};
+    }
+    state[GLOBAL_SESSION_ID_KEY] = sessionID;
+    return ZalgoPromise.resolve();
+  });
+}

src/globalSession.test.js

@@ -0,0 +1,113 @@
+/* @flow */
+import { describe, it, afterEach, expect, vi } from "vitest";
+
+import {
+  getGlobalSessionName,
+  getGlobalSessionID,
+  setGlobalSessionID,
+} from "./globalSession";
+
+let storageState = {};
+
+vi.mock("@krakenjs/belter/src", async () => {
+  const actual = await vi.importActual("@krakenjs/belter/src");
+  return {
+    ...actual,
+    getStorage: vi.fn(() => ({
+      getState: (handler) => handler(storageState),
+      setState: (newState) => {
+        storageState = { ...storageState, ...newState };
+      },
+    })),
+  };
+});
+
+vi.mock("./global", () => ({
+  getVersion: vi.fn(() => "5.0.500"),
+}));
+
+describe("globalSession", () => {
+  afterEach(() => {
+    vi.clearAllMocks();
+  });
+
+  it("should generate the correct global session storage name", () => {
+    const expectedName = "paypal_global_5_0_500";
+
+    const name = getGlobalSessionName();
+
+    expect(name).toBe(expectedName);
+  });
+
+  it("should return undefined if globalSessionID is not set", () => {
+    const globalSessionID = getGlobalSessionID();
+
+    expect(globalSessionID).toBeUndefined();
+  });
+
+  it("should set and get the globalSessionID", () => {
+    const testID = "uid_123456";
+    setGlobalSessionID(testID);
+
+    const globalSessionID = getGlobalSessionID();
+
+    expect(globalSessionID).toBe(testID);
+  });
+
+  it("should overwrite the globalSessionID if set multiple times", () => {
+    const firstID = "uid_first";
+    const secondID = "uid_second";
+
+    setGlobalSessionID(firstID);
+    setGlobalSessionID(secondID);
+    const globalSessionID = getGlobalSessionID();
+
+    expect(globalSessionID).toBe(secondID);
+  });
+
+  it("should handle setting globalSessionID to an empty string", () => {
+    const emptyID = "";
+
+    setGlobalSessionID(emptyID);
+    const globalSessionID = getGlobalSessionID();
+
+    expect(globalSessionID).toBe(emptyID);
+  });
+
+  it("should return undefined if state is not an object", () => {
+    storageState = null;
+    const globalSessionID = getGlobalSessionID();
+    expect(globalSessionID).toBeUndefined();
+  });
+
+  it("should warn if state is not an object when setting globalSessionID", async () => {
+    const logger = await import("./logger");
+    storageState = null;
+    const warnSpy = vi.spyOn(logger, "getLogger").mockReturnValue({
+      warn: vi.fn(),
+    });
+
+    setGlobalSessionID("uid_error");
+
+    expect(warnSpy().warn).toHaveBeenCalledWith(
+      "global_session_no_storage_state_found"
+    );
+  });
+
+  it("should warn if version is not defined", async () => {
+    const logger = await import("./logger");
+    const { getVersion } = await import("./global");
+    // $FlowFixMe
+    getVersion.mockImplementation(() => undefined);
+
+    const warnSpy = vi.spyOn(logger, "getLogger").mockReturnValue({
+      warn: vi.fn(),
+    });
+
+    getGlobalSessionName();
+
+    expect(warnSpy().warn).toHaveBeenCalledWith(
+      "global_session_no_sdk_version"
+    );
+  });
+});

src/index.js

@@ -17,4 +17,5 @@ export * from "./graphql";
 export * from "./domains";
 export * from "./tracking";
 export * from "./utils";
+export * from "./globalSession";
 export { buildDPoPHeaders } from "./dpop";