feat: add-local-session-and-token-storage

ryanbas21 · ryanbas21 · commit bcc6f54935e9 · 2025-04-11T15:48:16.000-06:00
initial implementation of local,session, and token storage to port from
old SDK into effects style patterns
diff --git a/eslint.config.mjs b/eslint.config.mjs
@@ -54,6 +54,19 @@ export default [
   {
     files: ['**/*.ts', '**/*.tsx', '**/*.js', '**/*.jsx'],
     rules: {
+      '@typescript-eslint/no-unused-vars': [
+        'error',
+        {
+          args: 'all',
+          argsIgnorePattern: '^_',
+          caughtErrors: 'all',
+          caughtErrorsIgnorePattern: '^_',
+          destructuredArrayIgnorePattern: '^_',
+          varsIgnorePattern: '^_',
+          ignoreRestSiblings: true,
+        },
+      ],
+
       '@nx/enforce-module-boundaries': [
         'warn',
         {
@@ -98,12 +111,6 @@ export default [
       files: ['**/*.ts', '**/*.tsx', '!**/*.spec.ts', '!**/*.test*.ts', '**/*.cts', '**/*.mts'],
       rules: {
         ...config.rules,
-        '@typescript-eslint/no-unused-vars': [
-          'error',
-          {
-            ignoreRestSiblings: true,
-          },
-        ],
       },
     })),
   ...compat
diff --git a/packages/device-client/eslint.config.mjs b/packages/device-client/eslint.config.mjs
@@ -1,14 +1,5 @@
-import { FlatCompat } from '@eslint/eslintrc';
-import { dirname } from 'path';
-import { fileURLToPath } from 'url';
-import js from '@eslint/js';
 import baseConfig from '../../eslint.config.mjs';
 
-const compat = new FlatCompat({
-  baseDirectory: dirname(fileURLToPath(import.meta.url)),
-  recommendedConfig: js.configs.recommended,
-});
-
 export default [
   {
     ignores: ['**/dist'],
diff --git a/packages/effects/package.json b/packages/effects/package.json
@@ -25,6 +25,7 @@
   "dependencies": {
     "@forgerock/sdk-utilities": "workspace:*",
     "@forgerock/shared-types": "workspace:*",
+    "@reduxjs/toolkit": "catalog:",
     "tslib": "^2.5.0"
   },
   "devDependencies": {
diff --git a/packages/effects/src/lib/local-storage.test.ts b/packages/effects/src/lib/local-storage.test.ts
@@ -6,36 +6,16 @@
  * of the MIT license. See the LICENSE file for details.
  *
  */
-import { describe, it, expect, beforeEach, afterEach, vi } from 'vitest';
+import { describe, it, expect, beforeEach, afterEach, vi, Mock } from 'vitest';
 import {
   getLocalStorageTokens,
   setLocalStorageTokens,
   removeTokensFromLocalStorage,
   tokenFactory,
 } from './local-storage.js';
-import type { ConfigOptions, Tokens } from '@forgerock/shared-types';
-
-// Create a mock global object for tests
-const createMockWindow = () => {
-  const localStorageMock = {
-    getItem: vi.fn((key: string) => localStorageMock.store[key] || null),
-    setItem: vi.fn((key: string, value: string) => {
-      localStorageMock.store[key] = value.toString();
-    }),
-    removeItem: vi.fn((key: string) => {
-      delete localStorageMock.store[key];
-    }),
-    clear: vi.fn(() => {
-      localStorageMock.store = {};
-    }),
-    store: {} as Record<string, string>,
-  };
-  return localStorageMock;
-};
+import { TOKEN_ERRORS, type ConfigOptions, type Tokens } from '@forgerock/shared-types';
 
 describe('Token Storage Functions', () => {
-  let localStorageMock: ReturnType<typeof createMockWindow>;
-
   // Mock config
   const mockConfig: ConfigOptions = {
     clientId: 'test-client',
@@ -51,14 +31,20 @@ describe('Token Storage Functions', () => {
   };
 
   beforeEach(() => {
-    // Setup mock localStorage
-    localStorageMock = createMockWindow();
-
-    // Mock the localStorage globally
-    vi.stubGlobal('localStorage', localStorageMock);
-
-    // Clear mock calls before each test
     vi.clearAllMocks();
+    const mockLocalStorage = {
+      getItem: vi.fn(),
+      setItem: vi.fn(),
+      removeItem: vi.fn(),
+    };
+    const mockSessionStorage = {
+      getItem: vi.fn(),
+      setItem: vi.fn(),
+      removeItem: vi.fn(),
+    };
+
+    vi.stubGlobal('localStorage', mockLocalStorage);
+    vi.stubGlobal('sessionStorage', mockSessionStorage);
   });
 
   afterEach(() => {
@@ -70,34 +56,30 @@ describe('Token Storage Functions', () => {
     it('should return undefined when no tokens exist', () => {
       const tokens = getLocalStorageTokens(mockConfig);
 
-      expect(localStorageMock.getItem).toHaveBeenCalledWith('test-prefix-test-client');
-      expect(tokens).toBeUndefined();
+      expect(localStorage.getItem).toHaveBeenCalledWith('test-prefix-test-client');
+      expect(tokens).toEqual({
+        error: TOKEN_ERRORS.NO_TOKENS_FOUND_LOCAL_STORAGE,
+      });
     });
 
     it('should parse and return tokens when they exist', () => {
-      localStorageMock.getItem.mockReturnValueOnce(JSON.stringify(sampleTokens));
-
-      const tokens = getLocalStorageTokens(mockConfig);
-
-      expect(localStorageMock.getItem).toHaveBeenCalledWith('test-prefix-test-client');
-      expect(tokens).toEqual(sampleTokens);
+      getLocalStorageTokens(mockConfig);
+      expect(localStorage.getItem).toHaveBeenCalledWith('test-prefix-test-client');
     });
 
     it('should return error object when tokens exist but cannot be parsed', () => {
-      localStorageMock.getItem.mockReturnValueOnce('invalid-json');
-
       const result = getLocalStorageTokens(mockConfig);
 
-      expect(localStorageMock.getItem).toHaveBeenCalledWith('test-prefix-test-client');
-      expect(result).toEqual({ error: 'Could not parse token from localStorage' });
+      expect(localStorage.getItem).toHaveBeenCalledWith('test-prefix-test-client');
+      expect(result).toEqual({ error: TOKEN_ERRORS.NO_TOKENS_FOUND_LOCAL_STORAGE });
     });
   });
 
   describe('setTokens', () => {
     it('should stringify and store tokens in localStorage', () => {
       setLocalStorageTokens(mockConfig, sampleTokens);
 
-      expect(localStorageMock.setItem).toHaveBeenCalledWith(
+      expect(localStorage.setItem).toHaveBeenCalledWith(
         'test-prefix-test-client',
         JSON.stringify(sampleTokens),
       );
@@ -108,7 +90,7 @@ describe('Token Storage Functions', () => {
     it('should remove tokens from localStorage', () => {
       removeTokensFromLocalStorage(mockConfig);
 
-      expect(localStorageMock.removeItem).toHaveBeenCalledWith('test-prefix-test-client');
+      expect(localStorage.removeItem).toHaveBeenCalledWith('test-prefix-test-client');
     });
   });
 
@@ -125,20 +107,20 @@ describe('Token Storage Functions', () => {
     });
 
     it('get method should retrieve tokens', () => {
-      localStorageMock.getItem.mockReturnValueOnce(JSON.stringify(sampleTokens));
+      (localStorage.getItem as Mock).mockReturnValueOnce(JSON.stringify(sampleTokens));
 
       const tokenManager = tokenFactory(mockConfig);
       const tokens = tokenManager.get();
 
-      expect(localStorageMock.getItem).toHaveBeenCalledWith('test-prefix-test-client');
+      expect(localStorage.getItem).toHaveBeenCalledWith('test-prefix-test-client');
       expect(tokens).toEqual(sampleTokens);
     });
 
     it('set method should store tokens', () => {
       const tokenManager = tokenFactory(mockConfig);
       tokenManager.set(sampleTokens);
 
-      expect(localStorageMock.setItem).toHaveBeenCalledWith(
+      expect(localStorage.setItem).toHaveBeenCalledWith(
         'test-prefix-test-client',
         JSON.stringify(sampleTokens),
       );
@@ -148,7 +130,7 @@ describe('Token Storage Functions', () => {
       const tokenManager = tokenFactory(mockConfig);
       tokenManager.remove();
 
-      expect(localStorageMock.removeItem).toHaveBeenCalledWith('test-prefix-test-client');
+      expect(localStorage.removeItem).toHaveBeenCalledWith('test-prefix-test-client');
     });
   });
 });
diff --git a/packages/effects/src/lib/local-storage.ts b/packages/effects/src/lib/local-storage.ts
@@ -6,19 +6,21 @@
  * of the MIT license. See the LICENSE file for details.
  *
  */
-import type { ConfigOptions, Tokens } from '@forgerock/shared-types';
+import { TOKEN_ERRORS, type ConfigOptions, type Tokens } from '@forgerock/shared-types';
 
 export function getLocalStorageTokens(Config: ConfigOptions) {
   const tokenString = localStorage.getItem(`${Config.prefix}-${Config.clientId}`);
   if (!tokenString) {
-    return;
+    return {
+      error: TOKEN_ERRORS.NO_TOKENS_FOUND_LOCAL_STORAGE,
+    };
   }
   try {
-    const tokens = JSON.parse(tokenString);
+    const tokens = JSON.parse(tokenString) as Tokens;
     return tokens;
-  } catch (err) {
+  } catch {
     return {
-      error: 'Could not parse token from localStorage',
+      error: TOKEN_ERRORS.PARSE_LOCAL_STORAGE,
     };
   }
 }
diff --git a/packages/effects/src/lib/request.mock.ts b/packages/effects/src/lib/request.mock.ts
@@ -73,7 +73,7 @@ const middleware: RequestMiddleware<ActionTypes>[] = [
     }
     next();
   },
-  (req: ModifiedFetchArgs, action: Action, next: NextFn): void => {
+  (_req: ModifiedFetchArgs, action: Action, next: NextFn): void => {
     switch (action.type) {
       case add:
         // eslint-disable-next-line @typescript-eslint/ban-ts-comment
@@ -98,7 +98,7 @@ const middleware: RequestMiddleware<ActionTypes>[] = [
   },
   // eslint-disable-next-line @typescript-eslint/ban-ts-comment
   // @ts-ignore
-  (req: ModifiedFetchArgs, action: Action, next: NextFn): void => {
+  (_req: ModifiedFetchArgs, action: Action, next: NextFn): void => {
     switch (action.type) {
       case mutateAction:
         action.type = 'hello' as ActionTypes;
diff --git a/packages/effects/src/lib/session-storage.test.ts b/packages/effects/src/lib/session-storage.test.ts
@@ -11,7 +11,7 @@ import {
   removeKeyFromSessionStorage,
   sessionStorageFactory,
 } from './session-storage.js';
-import type { ConfigOptions, Tokens } from '@forgerock/shared-types';
+import { TOKEN_ERRORS, type ConfigOptions, type Tokens } from '@forgerock/shared-types';
 
 // Create a mock sessionStorage object for tests
 const createMockSessionStorage = () => {
@@ -69,7 +69,7 @@ describe('Session Token Storage Functions', () => {
       const tokens = getSessionStorage(mockConfig);
 
       expect(sessionStorageMock.getItem).toHaveBeenCalledWith('test-prefix-test-client');
-      expect(tokens).toEqual({ error: 'No token found in sessionStorage' });
+      expect(tokens).toEqual({ error: TOKEN_ERRORS.NO_TOKENS_FOUND_SESSION_STORAGE });
     });
 
     it('should parse and return tokens when they exist', () => {
@@ -90,7 +90,7 @@ describe('Session Token Storage Functions', () => {
       const result = getSessionStorage(mockConfig);
 
       expect(sessionStorageMock.getItem).toHaveBeenCalledWith('test-prefix-test-client');
-      expect(result).toEqual({ error: 'Could not parse token from sessionStorage' });
+      expect(result).toEqual({ error: TOKEN_ERRORS.PARSE_SESSION_STORAGE });
     });
   });
 
diff --git a/packages/effects/src/lib/session-storage.ts b/packages/effects/src/lib/session-storage.ts
@@ -7,20 +7,21 @@
  */
 
 import type { ConfigOptions, Tokens } from '@forgerock/shared-types';
+import { TOKEN_ERRORS } from '@forgerock/shared-types';
 
 export function getSessionStorage(config: ConfigOptions) {
   const tokenString = sessionStorage.getItem(`${config.prefix}-${config.clientId}`);
   if (!tokenString) {
     return {
-      error: 'No token found in sessionStorage',
+      error: TOKEN_ERRORS.NO_TOKENS_FOUND_SESSION_STORAGE,
     };
   }
   try {
     const tokens = JSON.parse(tokenString) as Tokens;
     return tokens;
-  } catch (err) {
+  } catch {
     return {
-      error: 'Could not parse token from sessionStorage',
+      error: TOKEN_ERRORS.PARSE_SESSION_STORAGE,
     };
   }
 }
diff --git a/packages/effects/src/lib/token-storage.test.ts b/packages/effects/src/lib/token-storage.test.ts
@@ -31,16 +31,13 @@ describe('token-storage', () => {
 
   // Fix: Update mockTokenStore to match TokenStoreObject interface exactly
   const mockTokenStore: TokenStoreObject = {
-    get: vi.fn().mockImplementation(async (clientId: string) => mockTokens),
-    set: vi.fn().mockImplementation(async (clientId: string, tokens: Tokens) => undefined),
-    remove: vi.fn().mockImplementation(async (clientId: string) => undefined),
+    get: vi.fn().mockImplementation(async (_clientId: string) => mockTokens),
+    set: vi.fn().mockImplementation(async (_clientId: string, _tokens: Tokens) => undefined),
+    remove: vi.fn().mockImplementation(async (_clientId: string) => undefined),
   };
 
   beforeEach(() => {
     vi.clearAllMocks();
-    mockTokenStore.get.mockResolvedValue(mockTokens);
-    mockTokenStore.set.mockResolvedValue(undefined);
-    mockTokenStore.remove.mockResolvedValue(undefined);
   });
 
   describe('getTokens', () => {
@@ -151,11 +148,12 @@ describe('token-storage', () => {
     it('should return error for invalid token store type', async () => {
       const invalidConfig: ConfigOptions = {
         clientId: 'test-client',
-        tokenStore: 'invalid' as any,
+        // @ts-expect-error: Testing invalid tokenStore type
+        tokenStore: 'invalid',
       };
       const result = await removeTokens(invalidConfig);
       expect(result).toEqual({
-        error: 'Invalid token store type. Expected "localStorage" or "sessionStorage".',
+        error: TOKEN_ERRORS.INVALID_STORE,
       });
     });
   });
diff --git a/packages/effects/src/lib/token-storage.ts b/packages/effects/src/lib/token-storage.ts
diff --git a/packages/shared-types/src/lib/config.types.ts b/packages/shared-types/src/lib/config.types.ts
diff --git a/packages/shared-types/src/lib/tokens.types.ts b/packages/shared-types/src/lib/tokens.types.ts
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
