Removed the migration logic for the old format of MySegments keys in LocalStorage introduced in JavaScript SDK v10.17.3

Author: EmilianoSanchez

CHANGES.txt

@@ -8,6 +8,7 @@
    - Removed support for MY_SEGMENTS_UPDATE and MY_SEGMENTS_UPDATE_V2 notification types, as they are replaced by MEMBERSHIPS_MS_UPDATE and MEMBERSHIPS_LS_UPDATE notification types.
    - Removed the deprecated `GOOGLE_ANALYTICS_TO_SPLIT` and `SPLIT_TO_GOOGLE_ANALYTICS` integrations.
    - Removed internal ponyfills for `Map`, `Set` and `Array.from` global objects, dropping support for IE and other outdated browsers. The SDK now requires the runtime environment to support these features natively or to provide a polyfill.
+   - Removed the migration logic for the old format of MySegments keys in LocalStorage introduced in JavaScript SDK v10.17.3.
 
 1.17.0 (September 6, 2024)
  - Added `sync.requestOptions.getHeaderOverrides` configuration option to enhance SDK HTTP request Headers for Authorization Frameworks.

src/storages/KeyBuilderCS.ts

@@ -4,7 +4,6 @@ import { KeyBuilder } from './KeyBuilder';
 export interface MySegmentsKeyBuilder {
   buildSegmentNameKey(segmentName: string): string;
   extractSegmentName(builtSegmentKeyName: string): string | undefined;
-  extractOldSegmentKey(builtSegmentKeyName: string): string | undefined;
   buildTillKey(): string;
 }
 
@@ -33,14 +32,6 @@ export class KeyBuilderCS extends KeyBuilder implements MySegmentsKeyBuilder {
       return builtSegmentKeyName.substr(prefix.length);
   }
 
-  // @BREAKING: The key used to start with the matching key instead of the prefix, this was changed on version 10.17.3
-  extractOldSegmentKey(builtSegmentKeyName: string) {
-    const prefix = `${this.matchingKey}.${this.prefix}.segment.`;
-
-    if (startsWith(builtSegmentKeyName, prefix))
-      return builtSegmentKeyName.substr(prefix.length);
-  }
-
   buildLastUpdatedKey() {
     return `${this.prefix}.splits.lastUpdated`;
   }
@@ -66,10 +57,6 @@ export function myLargeSegmentsKeyBuilder(prefix: string, matchingKey: string):
       if (startsWith(builtSegmentKeyName, p)) return builtSegmentKeyName.substr(p.length);
     },
 
-    extractOldSegmentKey() {
-      return undefined;
-    },
-
     buildTillKey() {
       return `${prefix}.${matchingKey}.largeSegments.till`;
     }

src/storages/inLocalStorage/MySegmentsCacheInLocal.ts

@@ -51,27 +51,7 @@ export class MySegmentsCacheInLocal extends AbstractSegmentsCacheSync {
     return Object.keys(localStorage).reduce((accum, key) => {
       let segmentName = this.keys.extractSegmentName(key);
 
-      if (segmentName) {
-        accum.push(segmentName);
-      } else {
-        // @TODO @BREAKING: This is only to clean up "old" keys. Remove this whole else code block
-        segmentName = this.keys.extractOldSegmentKey(key);
-
-        if (segmentName) { // this was an old segment key, let's clean up.
-          const newSegmentKey = this.keys.buildSegmentNameKey(segmentName);
-          try {
-            // If the new format key is not there, create it.
-            if (!localStorage.getItem(newSegmentKey)) {
-              localStorage.setItem(newSegmentKey, DEFINED);
-              // we are migrating a segment, let's track it.
-              accum.push(segmentName);
-            }
-            localStorage.removeItem(key); // we migrated the current key, let's delete it.
-          } catch (e) {
-            this.log.error(e);
-          }
-        }
-      }
+      if (segmentName) accum.push(segmentName);
 
       return accum;
     }, [] as string[]);

src/storages/inLocalStorage/__tests__/MySegmentsCacheInLocal.spec.ts

@@ -34,37 +34,3 @@ test('SEGMENT CACHE / in LocalStorage', () => {
   expect(localStorage.getItem('SPLITIO.user.largeSegment.mocked-segment-2')).toBe('1');
   expect(localStorage.getItem('SPLITIO.user.largeSegment.mocked-segment')).toBe(null);
 });
-
-// @BREAKING: REMOVE when removing this backwards compatibility.
-test('SEGMENT CACHE / in LocalStorage migration for mysegments keys', () => {
-
-  const keys = new KeyBuilderCS('LS_BC_test.SPLITIO', 'test_nico');
-  const cache = new MySegmentsCacheInLocal(loggerMock, keys);
-
-  const oldKey1 = 'test_nico.LS_BC_test.SPLITIO.segment.segment1';
-  const oldKey2 = 'test_nico.LS_BC_test.SPLITIO.segment.segment2';
-  const newKey1 = keys.buildSegmentNameKey('segment1');
-  const newKey2 = keys.buildSegmentNameKey('segment2');
-
-  cache.clear(); // cleanup before starting.
-
-  // Not adding a full suite for LS keys now, testing here
-  expect(oldKey1).toBe(`test_nico.${keys.prefix}.segment.segment1`);
-  expect('segment1').toBe(keys.extractOldSegmentKey(oldKey1));
-
-  // add two segments, one we don't want to send on reset, should only be cleared, other one will be migrated.
-  localStorage.setItem(oldKey1, '1');
-  localStorage.setItem(oldKey2, '1');
-  expect(localStorage.getItem(newKey1)).toBe(null); // control assertion
-
-  cache.resetSegments({ k: [{ n: 'segment1' }] });
-
-  expect(localStorage.getItem(newKey1)).toBe('1'); // The segment key for segment1, as is part of the new list, should be migrated.
-  expect(localStorage.getItem(newKey2)).toBe(null); // The segment key for segment2 should not be migrated.
-  expect(localStorage.getItem(oldKey1)).toBe(null); // Old keys are removed.
-  expect(localStorage.getItem(oldKey2)).toBe(null); // Old keys are removed.
-
-  cache.clear();
-  expect(cache.getRegisteredSegments()).toEqual([]);
-  expect(cache.getChangeNumber()).toBe(-1);
-});