chore(release): pull hotfix-release/3.39.0-SDK-2469 into main (#1873)

rudderlabs · Oct 3, 2024 · 3a181d7 · 3a181d7
2 parents 0ce61dd + cbf0833
commit 3a181d7
Show file tree

Hide file tree

Showing 24 changed files with 335 additions and 86 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@rudderstack/analytics-js-monorepo",
-  "version": "3.38.0",
+  "version": "3.39.0",
   "private": true,
   "description": "Monorepo for RudderStack Analytics JS SDK",
   "workspaces": [

diff --git a/packages/analytics-js-plugins/CHANGELOG.md b/packages/analytics-js-plugins/CHANGELOG.md
@@ -2,6 +2,12 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
+## [3.4.15](https://github.com/rudderlabs/rudder-sdk-js/compare/@rudderstack/[email protected]...@rudderstack/[email protected]) (2024-10-03)
+
+### Dependency Updates
+
+* `@rudderstack/analytics-js` updated to version `3.7.14`
+* `@rudderstack/analytics-js-cookies` updated to version `0.3.9`
 ## [3.4.14](https://github.com/rudderlabs/rudder-sdk-js/compare/@rudderstack/[email protected]...@rudderstack/[email protected]) (2024-09-27)
 
 ### Dependency Updates

diff --git a/packages/analytics-js-plugins/CHANGELOG_LATEST.md b/packages/analytics-js-plugins/CHANGELOG_LATEST.md
@@ -1,12 +1,6 @@
-## [3.4.14](https://github.com/rudderlabs/rudder-sdk-js/compare/@rudderstack/[email protected].13...@rudderstack/[email protected].14) (2024-09-27)
+## [3.4.15](https://github.com/rudderlabs/rudder-sdk-js/compare/@rudderstack/[email protected].14...@rudderstack/[email protected].15) (2024-10-03)
 
 ### Dependency Updates
 
-* `@rudderstack/analytics-js-common` updated to version `3.9.3`
-* `@rudderstack/analytics-js` updated to version `3.7.13`
-
-### Bug Fixes
-
-* filter non error type errors ([#1865](https://github.com/rudderlabs/rudder-sdk-js/issues/1865)) ([060f66c](https://github.com/rudderlabs/rudder-sdk-js/commit/060f66cbf33500d6e0ee47c788ed687f4f619a57))
-* upgrade all packages to latest to fix vulnerabilities ([#1867](https://github.com/rudderlabs/rudder-sdk-js/issues/1867)) ([389348c](https://github.com/rudderlabs/rudder-sdk-js/commit/389348cfa61f2111c5ac4f9e2bad5851a466484d))
-
+* `@rudderstack/analytics-js` updated to version `3.7.14`
+* `@rudderstack/analytics-js-cookies` updated to version `0.3.9`
diff --git a/packages/analytics-js-plugins/package.json b/packages/analytics-js-plugins/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@rudderstack/analytics-js-plugins",
-  "version": "3.4.14",
+  "version": "3.4.15",
   "private": true,
   "description": "RudderStack JavaScript SDK plugins",
   "main": "dist/npm/modern/cjs/index.cjs",

diff --git a/packages/analytics-js-plugins/project.json b/packages/analytics-js-plugins/project.json
@@ -51,9 +51,9 @@
     "github": {
       "executor": "@jscutlery/semver:github",
       "options": {
-        "tag": "@rudderstack/[email protected].14",
-        "title": "@rudderstack/[email protected].14",
-        "discussion-category": "@rudderstack/[email protected].14",
+        "tag": "@rudderstack/[email protected].15",
+        "title": "@rudderstack/[email protected].15",
+        "discussion-category": "@rudderstack/[email protected].15",
         "notesFile": "./packages/analytics-js-plugins/CHANGELOG_LATEST.md"
       }
     }

diff --git a/packages/analytics-js/CHANGELOG.md b/packages/analytics-js/CHANGELOG.md
@@ -2,6 +2,16 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
+## [3.7.15](https://github.com/rudderlabs/rudder-sdk-js/compare/@rudderstack/[email protected]...@rudderstack/[email protected]) (2024-10-03)
+
+### Dependency Updates
+
+* `@rudderstack/analytics-js-plugins` updated to version `3.4.15`
+
+### Bug Fixes
+
+* storage access error when cookies are blocked ([#1872](https://github.com/rudderlabs/rudder-sdk-js/issues/1872)) ([966dbc2](https://github.com/rudderlabs/rudder-sdk-js/commit/966dbc2996b0ee292a553058ef435154de73f42e))
+
 ## [3.7.14](https://github.com/rudderlabs/rudder-sdk-js/compare/@rudderstack/[email protected]...@rudderstack/[email protected]) (2024-09-27)
 
 ### Dependency Updates

diff --git a/packages/analytics-js/CHANGELOG_LATEST.md b/packages/analytics-js/CHANGELOG_LATEST.md
@@ -1,14 +1,10 @@
-## [3.7.14](https://github.com/rudderlabs/rudder-sdk-js/compare/@rudderstack/[email protected].13...@rudderstack/[email protected].14) (2024-09-27)
+## [3.7.15](https://github.com/rudderlabs/rudder-sdk-js/compare/@rudderstack/[email protected].14...@rudderstack/[email protected].15) (2024-10-03)
 
 ### Dependency Updates
 
-* `@rudderstack/analytics-js-cookies` updated to version `0.3.9`
-* `@rudderstack/analytics-js-common` updated to version `3.9.3`
-* `@rudderstack/analytics-js-plugins` updated to version `3.4.14`
+* `@rudderstack/analytics-js-plugins` updated to version `3.4.15`
 
 ### Bug Fixes
 
-* add explicit checking for setting user and group traits ([68b4293](https://github.com/rudderlabs/rudder-sdk-js/commit/68b4293a9817b3a113af5f4ad8bfcfcf1cc81e88))
-* auto session tracking ([#1856](https://github.com/rudderlabs/rudder-sdk-js/issues/1856)) ([fa7cce4](https://github.com/rudderlabs/rudder-sdk-js/commit/fa7cce494a4dce00f843ce5790ceccb0fa9ce95f))
-* upgrade all packages to latest to fix vulnerabilities ([#1867](https://github.com/rudderlabs/rudder-sdk-js/issues/1867)) ([389348c](https://github.com/rudderlabs/rudder-sdk-js/commit/389348cfa61f2111c5ac4f9e2bad5851a466484d))
+* storage access error when cookies are blocked ([#1872](https://github.com/rudderlabs/rudder-sdk-js/issues/1872)) ([966dbc2](https://github.com/rudderlabs/rudder-sdk-js/commit/966dbc2996b0ee292a553058ef435154de73f42e))
 
diff --git a/packages/analytics-js/__tests__/components/capabilitiesManager/detection/storage.test.ts b/packages/analytics-js/__tests__/components/capabilitiesManager/detection/storage.test.ts
@@ -1,3 +1,4 @@
+import type { ILogger } from '@rudderstack/analytics-js-common/types/Logger';
 import {
   isStorageQuotaExceeded,
   isStorageAvailable,
@@ -24,4 +25,78 @@ describe('Capabilities Detection - Storage', () => {
   it('should detect if memoryStorage is available', () => {
     expect(isStorageAvailable('memoryStorage', new InMemoryStorage())).toBeTruthy();
   });
+
+  it('should log a warning when storage is unavailable', () => {
+    const mockLogger = {
+      warn: jest.fn(),
+    } as ILogger;
+
+    // Store the original descriptor so we can restore it later
+    const originalLsDescriptor = Object.getOwnPropertyDescriptor(window, 'localStorage');
+    const originalSessionStorageDescriptor = Object.getOwnPropertyDescriptor(
+      window,
+      'sessionStorage',
+    );
+
+    // Mock using Object.defineProperty
+    Object.defineProperty(window, 'localStorage', {
+      get: jest.fn(),
+      set: jest.fn(),
+      configurable: true,
+    });
+
+    // Mock using Object.defineProperty
+    Object.defineProperty(window, 'sessionStorage', {
+      get: jest.fn(),
+      set: jest.fn(),
+      configurable: true,
+    });
+
+    isStorageAvailable('localStorage', undefined, mockLogger);
+    expect(mockLogger.warn).toHaveBeenCalledWith(
+      'CapabilitiesManager:: The "localStorage" storage type is unavailable.',
+      undefined,
+    );
+
+    isStorageAvailable('sessionStorage', undefined, mockLogger);
+    expect(mockLogger.warn).toHaveBeenCalledWith(
+      'CapabilitiesManager:: The "sessionStorage" storage type is unavailable.',
+      undefined,
+    );
+
+    // Restore the original document.cookie descriptor
+    Object.defineProperty(window, 'localStorage', originalLsDescriptor as PropertyDescriptor);
+    Object.defineProperty(
+      window,
+      'sessionStorage',
+      originalSessionStorageDescriptor as PropertyDescriptor,
+    );
+  });
+
+  it('should log a warning when the local storage is full', () => {
+    const mockLogger = {
+      warn: jest.fn(),
+    } as ILogger;
+
+    // Store the original descriptor so we can restore it later
+    const originalLsDescriptor = Object.getOwnPropertyDescriptor(window, 'localStorage');
+
+    // Mock using Object.defineProperty
+    Object.defineProperty(window, 'localStorage', {
+      get: jest.fn(() => {
+        throw new DOMException('StorageQuotaExceeded', 'QuotaExceededError');
+      }),
+      set: jest.fn(),
+      configurable: true,
+    });
+
+    isStorageAvailable('localStorage', undefined, mockLogger);
+    expect(mockLogger.warn).toHaveBeenCalledWith(
+      'CapabilitiesManager:: The "localStorage" storage type is full.',
+      new DOMException('StorageQuotaExceeded', 'QuotaExceededError'),
+    );
+
+    // Restore the original document.cookie descriptor
+    Object.defineProperty(window, 'localStorage', originalLsDescriptor as PropertyDescriptor);
+  });
 });
diff --git a/packages/analytics-js/__tests__/services/StoreManager/storages/sessionStorage.test.ts b/packages/analytics-js/__tests__/services/StoreManager/storages/sessionStorage.test.ts
@@ -28,4 +28,26 @@ describe('SessionStorage', () => {
     expect(engine.keys()).toStrictEqual([]);
     expect(engine.length).toStrictEqual(0);
   });
+
+  it('APIs should respond appropriate when session storage is not available', () => {
+    const sessionStorageEngine = getStorageEngine('sessionStorage');
+
+    sessionStorageEngine.store = undefined;
+
+    sessionStorageEngine.setItem('a', '1');
+    expect(sessionStorageEngine.length).toBe(0);
+    expect(sessionStorageEngine.getItem('a')).toBeNull();
+
+    sessionStorageEngine.removeItem('a');
+
+    expect(sessionStorageEngine.length).toBe(0);
+
+    // clear all entries
+    sessionStorageEngine.clear();
+    expect(sessionStorageEngine.length).toBe(0);
+
+    expect(sessionStorageEngine.key(0)).toBeNull();
+
+    expect(sessionStorageEngine.keys()).toEqual([]);
+  });
 });
diff --git a/packages/analytics-js/package.json b/packages/analytics-js/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@rudderstack/analytics-js",
-  "version": "3.7.14",
+  "version": "3.7.15",
   "description": "RudderStack JavaScript SDK",
   "main": "dist/npm/modern/cjs/index.cjs",
   "module": "dist/npm/modern/esm/index.mjs",

diff --git a/packages/analytics-js/project.json b/packages/analytics-js/project.json
@@ -59,9 +59,9 @@
     "github": {
       "executor": "@jscutlery/semver:github",
       "options": {
-        "tag": "@rudderstack/[email protected].14",
-        "title": "@rudderstack/[email protected].14",
-        "discussion-category": "@rudderstack/[email protected].14",
+        "tag": "@rudderstack/[email protected].15",
+        "title": "@rudderstack/[email protected].15",
+        "discussion-category": "@rudderstack/[email protected].15",
         "notesFile": "./packages/analytics-js/CHANGELOG_LATEST.md"
       }
     }

diff --git a/packages/analytics-js/src/components/capabilitiesManager/detection/storage.ts b/packages/analytics-js/src/components/capabilitiesManager/detection/storage.ts
@@ -33,6 +33,11 @@ const isStorageAvailable = (
   let storage;
   let testData;
 
+  const msgPrefix = STORAGE_UNAVAILABILITY_ERROR_PREFIX(CAPABILITIES_MANAGER, type);
+  let reason = 'unavailable';
+  let isAccessible = true;
+  let errObj;
+
   try {
     switch (type) {
       case MEMORY_STORAGE:
@@ -53,25 +58,29 @@ const isStorageAvailable = (
         return false;
     }
 
-    if (!storage) {
-      return false;
+    if (storage) {
+      storage.setItem(testData, 'true');
+      if (storage.getItem(testData)) {
+        storage.removeItem(testData);
+        return true;
+      }
     }
 
-    storage.setItem(testData, 'true');
-    if (storage.getItem(testData)) {
-      storage.removeItem(testData);
-      return true;
-    }
-    return false;
+    isAccessible = false;
   } catch (err) {
-    const msgPrefix = STORAGE_UNAVAILABILITY_ERROR_PREFIX(CAPABILITIES_MANAGER, type);
-    let reason = 'unavailable';
+    isAccessible = false;
+    errObj = err;
     if (isStorageQuotaExceeded(err)) {
       reason = 'full';
     }
-    logger?.warn(`${msgPrefix}${reason}.`, err);
-    return false;
   }
+
+  if (!isAccessible) {
+    logger?.warn(`${msgPrefix}${reason}.`, errObj);
+  }
+
+  // if we've have reached here, it means the storage is not available
+  return false;
 };
 
 export { isStorageQuotaExceeded, isStorageAvailable };
diff --git a/packages/analytics-js/src/services/StoreManager/storages/CookieStorage.ts b/packages/analytics-js/src/services/StoreManager/storages/CookieStorage.ts
@@ -37,7 +37,7 @@ class CookieStorage implements IStorage {
     if (options.sameDomainCookiesOnly) {
       delete this.options.domain;
     }
-    this.isSupportAvailable = isStorageAvailable(COOKIE_STORAGE, this, this.logger);
+    this.isSupportAvailable = isStorageAvailable(COOKIE_STORAGE, this);
     this.isEnabled = Boolean(this.options.enabled && this.isSupportAvailable);
     return this.options;
   }

diff --git a/packages/analytics-js/src/services/StoreManager/storages/LocalStorage.ts b/packages/analytics-js/src/services/StoreManager/storages/LocalStorage.ts
@@ -31,7 +31,7 @@ class LocalStorage implements IStorage {
 
   configure(options: Partial<ILocalStorageOptions>): ILocalStorageOptions {
     this.options = mergeDeepRight(this.options, options);
-    this.isSupportAvailable = isStorageAvailable(LOCAL_STORAGE, this, this.logger);
+    this.isSupportAvailable = isStorageAvailable(LOCAL_STORAGE);
     this.isEnabled = Boolean(this.options.enabled && this.isSupportAvailable);
     return this.options;
   }