chore: revert to offlineStorageEnabled and update StorageTypes

Author: jaissica12

src/batchUploader.ts

@@ -43,7 +43,7 @@ export class BatchUploader {
     batchingEnabled: boolean;
     private eventVault: SessionStorageVault<SDKEvent[]>;
     private batchVault: LocalStorageVault<Batch[]>;
-    private OfflineStorage: boolean = false;
+    private offlineStorageEnabled: boolean = false;
     private uploader: AsyncUploader;
     private lastASTEventTime: number = 0;
     private readonly AST_DEBOUNCE_MS: number = 1000; // 1 second debounce
@@ -72,11 +72,11 @@ export class BatchUploader {
 
         // Cache Offline Storage Availability boolean
         // so that we don't have to check it every time
-        this.OfflineStorage =
+        this.offlineStorageEnabled =
             this.isOfflineStorageAvailable() &&
-            !mpInstance._Store.getPrivacyFlag('Events');
+            !mpInstance._Store.getPrivacyFlag('OfflineEvents');
 
-        if (this.OfflineStorage) {
+        if (this.offlineStorageEnabled) {
             this.eventVault = new SessionStorageVault<SDKEvent[]>(
                 `${mpInstance._Store.storageName}-events`,
                 {
@@ -259,7 +259,7 @@ export class BatchUploader {
         const { verbose } = this.mpInstance.Logger;
 
         this.eventsQueuedForProcessing.push(event);
-        if (this.OfflineStorage && this.eventVault) {
+        if (this.offlineStorageEnabled && this.eventVault) {
             this.eventVault.store(this.eventsQueuedForProcessing);
         }
 
@@ -375,7 +375,7 @@ export class BatchUploader {
         const currentEvents: SDKEvent[] = this.eventsQueuedForProcessing;
 
         this.eventsQueuedForProcessing = [];
-        if (this.OfflineStorage && this.eventVault) {
+        if (this.offlineStorageEnabled && this.eventVault) {
             this.eventVault.store([]);
         }
 
@@ -389,7 +389,7 @@ export class BatchUploader {
         }
 
         // Top Load any older Batches from Offline Storage so they go out first
-        if (this.OfflineStorage && this.batchVault) {
+        if (this.offlineStorageEnabled && this.batchVault) {
             this.batchesQueuedForProcessing.unshift(
                 ...this.batchVault.retrieve()
             );
@@ -422,7 +422,7 @@ export class BatchUploader {
         }
 
         // Update Offline Storage with current state of batch queue
-        if (!useBeacon && this.OfflineStorage && this.batchVault) {
+        if (!useBeacon && this.offlineStorageEnabled && this.batchVault) {
             // Note: since beacon is "Fire and forget" it will empty `batchesThatDidNotUplod`
             // regardless of whether the batches were successfully uploaded or not. We should
             // therefore NOT overwrite Offline Storage when beacon returns, so that we can retry

src/constants.ts

@@ -219,13 +219,12 @@ export const HTTP_SERVER_ERROR = 500 as const;
 // Privacy dependency map for storage keys
 export type PrivacyControl = 'functional' | 'targeting';
 
-export type StorageTypes = 'SDKState' | 'Products' | 'Events' | 'Batches' | 'IdCache' | 'TimeOnSite';
+export type StorageTypes = 'SDKState' | 'Products' | 'OfflineEvents' | 'IdentityCache' | 'TimeOnSite';
 
 export const StoragePrivacyMap: Record<StorageTypes, PrivacyControl> = {
     SDKState: 'functional',
     Products: 'targeting',
-    Events: 'functional',
-    Batches: 'functional',
-    IdCache: 'functional',
+    OfflineEvents: 'functional',
+    IdentityCache: 'functional',
     TimeOnSite: 'targeting',
 };

test/jest/batchUploader.spec.ts

@@ -141,7 +141,7 @@ describe('BatchUploader', () => {
             mockMPInstance._Store.noFunctional = true;
 
             const uploader = new BatchUploader(mockMPInstance, 1000);
-            expect(uploader['OfflineStorage']).toBe(false);
+            expect(uploader['offlineStorageEnabled']).toBe(false);
 
             uploader.queueEvent({ EventDataType: 4 } as any);
             expect(sessionStorage.getItem('mprtcl-v4_abcdef-events')).toBeNull();
@@ -151,7 +151,7 @@ describe('BatchUploader', () => {
         it('should enable offline storage when noFunctional is default (false)', async () => {
             const uploader = new BatchUploader(mockMPInstance, 1000);
 
-            expect(uploader['OfflineStorage']).toBe(true);
+            expect(uploader['offlineStorageEnabled']).toBe(true);
 
             uploader.queueEvent({ EventDataType: 4 } as any);
             expect(sessionStorage.getItem('mprtcl-v4_abcdef-events')).not.toBeNull();