Merge pull request #106 from splitio/update_localstorage_clear

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

Author: EmilianoSanchez

.github/workflows/ci-cd.yml

@@ -47,7 +47,7 @@ jobs:
         run: BUILD_BRANCH=$(echo "${GITHUB_REF#refs/heads/}") npm run build
 
       - name: Store assets
-        if: ${{ github.event_name == 'push' && (github.ref == 'refs/heads/SDKS-7797-flagsets_in_pluggable_storage' || github.ref == 'refs/heads/main') }}
+        if: ${{ github.event_name == 'push' && (github.ref == 'refs/heads/development' || github.ref == 'refs/heads/main') }}
         uses: actions/upload-artifact@v3
         with:
           name: assets
@@ -58,7 +58,7 @@ jobs:
     name: Upload assets
     runs-on: ubuntu-20.04
     needs: build
-    if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/SDKS-7797-flagsets_in_pluggable_storage' }}
+    if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/development' }}
     strategy:
       matrix:
         environment:

CHANGES.txt

@@ -1,6 +1,7 @@
-0.13.0 (December XX, 2023)
+0.13.0 (December 12, 2023)
  - Added support for Flag Sets in "consumer" and "partial consumer" modes (pluggable storage).
- - Updated @splitsoftware/splitio-commons package to version 1.12.0 that includes flag sets support for "consumer" and "partial consumer" modes, and other improvements.
+ - Updated SDK cache for browsers using localStorage, to clear cached feature flag definitions before initiating the synchronization process, if the cache was previously synchronized with a different SDK key (i.e., a different environment) or different Split Filter criteria.
+ - Updated @splitsoftware/splitio-commons package to version 1.12.1 that includes flag sets support for consumer modes, and other improvements.
  - Bugfixing - Fixed manager methods in consumer modes to return results in a promise when the SDK is not operational (not ready or destroyed).
 
 0.12.0 (November 3, 2023)

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@splitsoftware/splitio-browserjs",
-  "version": "0.13.0-rc.1",
+  "version": "0.13.0",
   "description": "Split SDK for JavaScript on Browser",
   "main": "cjs/index.js",
   "module": "esm/index.js",
@@ -64,7 +64,7 @@
   "bugs": "https://github.com/splitio/javascript-browser-client/issues",
   "homepage": "https://github.com/splitio/javascript-browser-client#readme",
   "dependencies": {
-    "@splitsoftware/splitio-commons": "1.12.0",
+    "@splitsoftware/splitio-commons": "1.12.1",
     "@types/google.analytics": "0.0.40",
     "unfetch": "^4.2.0"
   },

package.json

@@ -1,3 +1,4 @@
+import { getStorageHash } from '@splitsoftware/splitio-commons/src/storages/KeyBuilder';
 import splitChangesMock1 from '../mocks/splitchanges.since.-1.json';
 import splitKillMessage from '../mocks/message.SPLIT_KILL.1457552650000.json';
 import authPushEnabledNicolas from '../mocks/auth.pushEnabled.nicolas@split.io.json';
@@ -46,6 +47,7 @@ export function testSplitKillOnReadyFromCache(fetchMock, assert) {
 
   // prepare localstorage to allow SPLIT_KILL kill locally
   localStorage.clear();
+  localStorage.setItem('pushCornerCase.SPLITIO.hash', getStorageHash(settings));
   localStorage.setItem('pushCornerCase.SPLITIO.splits.till', 25);
   localStorage.setItem('pushCornerCase.SPLITIO.split.whitelist', JSON.stringify({
     'name': 'whitelist',