Merge pull request #284 from splitio/update_localstorage_clear

Update LocalStorage to clear storage if SDK key or filter criteria change

Author: EmilianoSanchez

CHANGES.txt

@@ -1,5 +1,5 @@
 1.12.1 (December 12, 2023)
- - Updated PluggableStorage for producer mode, to clear the storage if it was previously synchronized with a different SDK key (i.e., a different environment) or different Split Filter criteria.
+ - Updated PluggableStorage, for producer mode, and LocalStorage, for standalone mode, to clear the storage before initiating the synchronization process if it was previously synchronized with a different SDK key (i.e., a different environment) or different Split Filter criteria.
  - Bugfixing - Fixed an issue when tracking telemetry latencies for the new `getTreatmentsByFlagSet(s)` methods in Redis and Pluggable storages, which was causing the SDK to not track those stats.
 
 1.12.0 (December 4, 2023)

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@splitsoftware/splitio-commons",
-  "version": "1.12.0",
+  "version": "1.12.1",
   "description": "Split Javascript SDK common components",
   "main": "cjs/index.js",
   "module": "esm/index.js",

package.json

@@ -45,8 +45,4 @@ export class KeyBuilderCS extends KeyBuilder {
   isSplitsCacheKey(key: string) {
     return this.regexSplitsCacheKey.test(key);
   }
-
-  buildSplitsFilterQueryKey() {
-    return `${this.prefix}.splits.filterQuery`;
-  }
 }

src/storages/KeyBuilderCS.ts

@@ -1,18 +1,21 @@
-import { ISplit, ISplitFiltersValidation } from '../../dtos/types';
+import { ISplit } from '../../dtos/types';
 import { AbstractSplitsCacheSync, usesSegments } from '../AbstractSplitsCacheSync';
 import { isFiniteNumber, toNumber, isNaNNumber } from '../../utils/lang';
 import { KeyBuilderCS } from '../KeyBuilderCS';
 import { ILogger } from '../../logger/types';
 import { LOG_PREFIX } from './constants';
 import { ISet, _Set, setToArray } from '../../utils/lang/sets';
+import { ISettings } from '../../types';
+import { getStorageHash } from '../KeyBuilder';
 
 /**
  * ISplitsCacheSync implementation that stores split definitions in browser LocalStorage.
  */
 export class SplitsCacheInLocal extends AbstractSplitsCacheSync {
 
   private readonly keys: KeyBuilderCS;
-  private readonly splitFiltersValidation: ISplitFiltersValidation;
+  private readonly log: ILogger;
+  private readonly storageHash: string;
   private readonly flagSetsFilter: string[];
   private hasSync?: boolean;
   private updateNewFilter?: boolean;
@@ -22,11 +25,12 @@ export class SplitsCacheInLocal extends AbstractSplitsCacheSync {
    * @param {number | undefined} expirationTimestamp
    * @param {ISplitFiltersValidation} splitFiltersValidation
    */
-  constructor(private readonly log: ILogger, keys: KeyBuilderCS, expirationTimestamp?: number, splitFiltersValidation: ISplitFiltersValidation = { queryString: null, groupedFilters: { bySet: [], byName: [], byPrefix: [] }, validFilters: [] }) {
+  constructor(settings: ISettings, keys: KeyBuilderCS, expirationTimestamp?: number) {
     super();
     this.keys = keys;
-    this.splitFiltersValidation = splitFiltersValidation;
-    this.flagSetsFilter = this.splitFiltersValidation.groupedFilters.bySet;
+    this.log = settings.log;
+    this.storageHash = getStorageHash(settings);
+    this.flagSetsFilter = settings.sync.__splitFiltersValidation.groupedFilters.bySet;
 
     this._checkExpiration(expirationTimestamp);
 
@@ -142,12 +146,10 @@ export class SplitsCacheInLocal extends AbstractSplitsCacheSync {
 
     // when using a new split query, we must update it at the store
     if (this.updateNewFilter) {
-      this.log.info(LOG_PREFIX + 'Split filter query was modified. Updating cache.');
-      const queryKey = this.keys.buildSplitsFilterQueryKey();
-      const queryString = this.splitFiltersValidation.queryString;
+      this.log.info(LOG_PREFIX + 'SDK key or feature flag filter criteria was modified. Updating cache');
+      const storageHashKey = this.keys.buildHashKey();
       try {
-        if (queryString) localStorage.setItem(queryKey, queryString);
-        else localStorage.removeItem(queryKey);
+        localStorage.setItem(storageHashKey, this.storageHash);
       } catch (e) {
         this.log.error(LOG_PREFIX + e);
       }
@@ -237,12 +239,12 @@ export class SplitsCacheInLocal extends AbstractSplitsCacheSync {
     }
   }
 
+  // @TODO eventually remove `_checkFilterQuery`. Cache should be cleared at the storage level, reusing same logic than PluggableStorage
   private _checkFilterQuery() {
-    const queryString = this.splitFiltersValidation.queryString;
-    const queryKey = this.keys.buildSplitsFilterQueryKey();
-    const currentQueryString = localStorage.getItem(queryKey);
+    const storageHashKey = this.keys.buildHashKey();
+    const storageHash = localStorage.getItem(storageHashKey);
 
-    if (currentQueryString !== queryString) {
+    if (storageHash !== this.storageHash) {
       try {
         // mark cache to update the new query filter on first successful splits fetch
         this.updateNewFilter = true;

src/storages/inLocalStorage/SplitsCacheInLocal.ts

@@ -1,12 +1,13 @@
 import { SplitsCacheInLocal } from '../SplitsCacheInLocal';
 import { KeyBuilderCS } from '../../KeyBuilderCS';
-import { loggerMock } from '../../../logger/__tests__/sdkLogger.mock';
 import { splitWithUserTT, splitWithAccountTT, splitWithAccountTTAndUsesSegments, something, somethingElse, featureFlagOne, featureFlagTwo, featureFlagThree, featureFlagWithEmptyFS, featureFlagWithoutFS } from '../../__tests__/testUtils';
 import { ISplit } from '../../../dtos/types';
 import { _Set } from '../../../utils/lang/sets';
+import { fullSettings } from '../../../utils/settingsValidation/__tests__/settings.mocks';
+
 
 test('SPLIT CACHE / LocalStorage', () => {
-  const cache = new SplitsCacheInLocal(loggerMock, new KeyBuilderCS('SPLITIO', 'user'));
+  const cache = new SplitsCacheInLocal(fullSettings, new KeyBuilderCS('SPLITIO', 'user'));
 
   cache.clear();
 
@@ -45,7 +46,7 @@ test('SPLIT CACHE / LocalStorage', () => {
 });
 
 test('SPLIT CACHE / LocalStorage / Get Keys', () => {
-  const cache = new SplitsCacheInLocal(loggerMock, new KeyBuilderCS('SPLITIO', 'user'));
+  const cache = new SplitsCacheInLocal(fullSettings, new KeyBuilderCS('SPLITIO', 'user'));
 
   cache.addSplit('lol1', something);
   cache.addSplit('lol2', somethingElse);
@@ -57,7 +58,7 @@ test('SPLIT CACHE / LocalStorage / Get Keys', () => {
 });
 
 test('SPLIT CACHE / LocalStorage / Add Splits', () => {
-  const cache = new SplitsCacheInLocal(loggerMock, new KeyBuilderCS('SPLITIO', 'user'));
+  const cache = new SplitsCacheInLocal(fullSettings, new KeyBuilderCS('SPLITIO', 'user'));
 
   cache.addSplits([
     ['lol1', something],
@@ -71,7 +72,7 @@ test('SPLIT CACHE / LocalStorage / Add Splits', () => {
 });
 
 test('SPLIT CACHE / LocalStorage / trafficTypeExists and ttcache tests', () => {
-  const cache = new SplitsCacheInLocal(loggerMock, new KeyBuilderCS('SPLITIO', 'user'));
+  const cache = new SplitsCacheInLocal(fullSettings, new KeyBuilderCS('SPLITIO', 'user'));
 
   cache.addSplits([ // loop of addSplit
     ['split1', splitWithUserTT],
@@ -109,7 +110,7 @@ test('SPLIT CACHE / LocalStorage / trafficTypeExists and ttcache tests', () => {
 });
 
 test('SPLIT CACHE / LocalStorage / killLocally', () => {
-  const cache = new SplitsCacheInLocal(loggerMock, new KeyBuilderCS('SPLITIO', 'user'));
+  const cache = new SplitsCacheInLocal(fullSettings, new KeyBuilderCS('SPLITIO', 'user'));
   cache.addSplit('lol1', something);
   cache.addSplit('lol2', somethingElse);
   const initialChangeNumber = cache.getChangeNumber();
@@ -141,7 +142,7 @@ test('SPLIT CACHE / LocalStorage / killLocally', () => {
 });
 
 test('SPLIT CACHE / LocalStorage / usesSegments', () => {
-  const cache = new SplitsCacheInLocal(loggerMock, new KeyBuilderCS('SPLITIO', 'user'));
+  const cache = new SplitsCacheInLocal(fullSettings, new KeyBuilderCS('SPLITIO', 'user'));
 
   expect(cache.usesSegments()).toBe(true); // true initially, until data is synchronized
   cache.setChangeNumber(1); // to indicate that data has been synced.
@@ -164,7 +165,15 @@ test('SPLIT CACHE / LocalStorage / usesSegments', () => {
 
 test('SPLIT CACHE / LocalStorage / flag set cache tests', () => {
   // @ts-ignore
-  const cache = new SplitsCacheInLocal(loggerMock, new KeyBuilderCS('SPLITIO', 'user'), undefined, { groupedFilters: { bySet: ['o', 'n', 'e', 'x'] } });
+  const cache = new SplitsCacheInLocal({
+    ...fullSettings,
+    sync: { // @ts-expect-error
+      __splitFiltersValidation: {
+        groupedFilters: { bySet: ['o', 'n', 'e', 'x'], byName: [], byPrefix: [] },
+        queryString: '&sets=e,n,o,x',
+      }
+    }
+  }, new KeyBuilderCS('SPLITIO', 'user'));
   const emptySet = new _Set([]);
 
   cache.addSplits([
@@ -204,7 +213,7 @@ test('SPLIT CACHE / LocalStorage / flag set cache tests', () => {
 
 // if FlagSets are not defined, it should store all FlagSets in memory.
 test('SPLIT CACHE / LocalStorage / flag set cache tests without filters', () => {
-  const cacheWithoutFilters = new SplitsCacheInLocal(loggerMock, new KeyBuilderCS('SPLITIO', 'user'));
+  const cacheWithoutFilters = new SplitsCacheInLocal(fullSettings, new KeyBuilderCS('SPLITIO', 'user'));
   const emptySet = new _Set([]);
 
   cacheWithoutFilters.addSplits([
@@ -221,9 +230,8 @@ test('SPLIT CACHE / LocalStorage / flag set cache tests without filters', () =>
   expect(cacheWithoutFilters.getNamesByFlagSets(['y'])).toEqual([emptySet]);
   expect(cacheWithoutFilters.getNamesByFlagSets(['o', 'n', 'e'])).toEqual([new _Set(['ff_one', 'ff_two']), new _Set(['ff_one']), new _Set(['ff_one', 'ff_three'])]);
 
-  // Validate that the cache is cleared when calling `clear` method
-  localStorage.setItem('something', 'something');
+  // Validate that the feature flag cache is cleared when calling `clear` method
   cacheWithoutFilters.clear();
-  expect(localStorage.length).toBe(1); // only 'something' should remain in localStorage
-  expect(localStorage.getItem(localStorage.key(0)!)).toBe('something');
+  expect(localStorage.length).toBe(1); // only 'SPLITIO.hash' should remain in localStorage
+  expect(localStorage.key(0)).toBe('SPLITIO.hash');
 });

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

@@ -41,7 +41,7 @@ export function InLocalStorage(options: InLocalStorageOptions = {}): IStorageSyn
     const keys = new KeyBuilderCS(prefix, matchingKey as string);
     const expirationTimestamp = Date.now() - DEFAULT_CACHE_EXPIRATION_IN_MILLIS;
 
-    const splits = new SplitsCacheInLocal(log, keys, expirationTimestamp, __splitFiltersValidation);
+    const splits = new SplitsCacheInLocal(settings, keys, expirationTimestamp);
     const segments = new MySegmentsCacheInLocal(log, keys);
 
     return {