Add local storage utils (#972)

Add utils for getting, setting, and clearing local storage values

Author: adhityamamallan

src/utils/local-storage/__tests__/clear-local-storage-value.test.ts

@@ -0,0 +1,15 @@
+import clearLocalStorageValue from '../clear-local-storage-value';
+
+describe(clearLocalStorageValue, () => {
+  beforeEach(() => {
+    jest.restoreAllMocks();
+  });
+
+  it('should call localStorage.removeItem with the provided key', () => {
+    const removeItemSpy = jest.spyOn(Storage.prototype, 'removeItem');
+
+    clearLocalStorageValue('test-key');
+
+    expect(removeItemSpy).toHaveBeenCalledWith('test-key');
+  });
+});

src/utils/local-storage/__tests__/get-local-storage-value.test.ts

@@ -0,0 +1,55 @@
+import { z } from 'zod';
+
+import getLocalStorageValue from '../get-local-storage-value';
+
+const testSchema = z.string().startsWith('test-');
+
+describe('getLocalStorageValue', () => {
+  beforeEach(() => {
+    jest.restoreAllMocks();
+  });
+
+  it('should return the value from localStorage.getItem', () => {
+    const mockValue = 'test-value';
+    jest.spyOn(Storage.prototype, 'getItem').mockReturnValue(mockValue);
+
+    const result = getLocalStorageValue('test-key', testSchema);
+
+    expect(result).toBe(mockValue);
+  });
+
+  it('should return null when localStorage.getItem returns null', () => {
+    jest.spyOn(Storage.prototype, 'getItem').mockReturnValue(null);
+
+    const result = getLocalStorageValue('test-key', testSchema);
+
+    expect(result).toBeNull();
+  });
+
+  it('should return null if the value in localStorage does not match the schema', () => {
+    const mockValue = 'invalid-value';
+    jest.spyOn(Storage.prototype, 'getItem').mockReturnValue(mockValue);
+
+    const result = getLocalStorageValue('test-key', testSchema);
+
+    expect(result).toBeNull();
+  });
+
+  it('should return plain string when a schema is not provided', () => {
+    const mockValue = 'mock-value';
+    jest.spyOn(Storage.prototype, 'getItem').mockReturnValue(mockValue);
+
+    const result = getLocalStorageValue('test-key');
+
+    expect(result).toBe('mock-value');
+  });
+
+  it('should return empty string when localStorage.getItem returns empty string', () => {
+    const mockValue = '';
+    jest.spyOn(Storage.prototype, 'getItem').mockReturnValue(mockValue);
+
+    const result = getLocalStorageValue('test-key');
+
+    expect(result).toBe('');
+  });
+});

src/utils/local-storage/__tests__/set-local-storage-value.test.ts

@@ -0,0 +1,34 @@
+import logger from '../../logger';
+import setLocalStorageValue from '../set-local-storage-value';
+
+jest.mock('@/utils/logger', () => ({
+  warn: jest.fn(),
+}));
+
+describe(setLocalStorageValue.name, () => {
+  beforeEach(() => {
+    jest.restoreAllMocks();
+  });
+
+  it('should call localStorage.setItem with the provided key and value', () => {
+    const setItemSpy = jest.spyOn(Storage.prototype, 'setItem');
+
+    setLocalStorageValue('test-key', 'test-value');
+
+    expect(setItemSpy).toHaveBeenCalledWith('test-key', 'test-value');
+  });
+
+  it('should handle localStorage.setItem errors gracefully', () => {
+    const mockError = new Error('Storage quota exceeded');
+    jest.spyOn(Storage.prototype, 'setItem').mockImplementation(() => {
+      throw mockError;
+    });
+
+    setLocalStorageValue('test-key', 'test-value');
+
+    expect(logger.warn).toHaveBeenCalledWith(
+      { key: 'test-key', error: mockError, value: 'test-value' },
+      'Failed to save value to local storage'
+    );
+  });
+});

src/utils/local-storage/clear-local-storage-value.ts

@@ -0,0 +1,11 @@
+import logger from '../logger';
+
+export default function clearLocalStorageValue(key: string) {
+  if (typeof window === 'undefined') return;
+
+  try {
+    return localStorage.removeItem(key);
+  } catch (error) {
+    logger.warn({ key, error }, 'Failed to clear value from local storage');
+  }
+}

src/utils/local-storage/get-local-storage-value.ts

@@ -0,0 +1,23 @@
+import { type z } from 'zod';
+
+import logger from '../logger';
+
+export default function getLocalStorageValue<
+  S extends z.ZodTypeAny = z.ZodString,
+>(key: string, schema?: S): z.infer<S> | null {
+  if (typeof window === 'undefined') return null;
+
+  try {
+    const localStorageVal = localStorage.getItem(key);
+    if (localStorageVal === null) return null;
+
+    if (schema) {
+      return schema.parse(localStorageVal);
+    }
+
+    return localStorageVal;
+  } catch (error) {
+    logger.warn({ key, error }, 'Failed to get value from local storage');
+    return null;
+  }
+}

src/utils/local-storage/index.ts

@@ -0,0 +1,3 @@
+export { default as getLocalStorageValue } from './get-local-storage-value';
+export { default as setLocalStorageValue } from './set-local-storage-value';
+export { default as clearLocalStorageValue } from './clear-local-storage-value';

src/utils/local-storage/set-local-storage-value.ts

@@ -0,0 +1,11 @@
+import logger from '../logger';
+
+export default function setLocalStorageValue(key: string, value: string) {
+  if (typeof window === 'undefined') return;
+
+  try {
+    localStorage.setItem(key, value);
+  } catch (error) {
+    logger.warn({ key, error, value }, 'Failed to save value to local storage');
+  }
+}