Release v1.3.0

.github/workflows/ci.yml

@@ -23,7 +23,7 @@ jobs:
       - name: Set up nodejs
         uses: actions/setup-node@v2
         with:
-          node-version: 'lts/*'
+          node-version: '14'
           cache: 'npm'
 
       - name: npm CI

.github/workflows/update-license-year.yml

@@ -0,0 +1,49 @@
+name: Update License Year
+
+on:
+  schedule:
+    - cron: "0 3 1 1 *" # 03:00 AM on January 1
+  push:
+    branches:
+      - main
+      - master
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+
+      - name: Set Current year
+        run: "echo CURRENT=$(date +%Y) >> $GITHUB_ENV"
+
+      - name: Set Previous Year
+        run: "echo PREVIOUS=$(($CURRENT-1)) >> $GITHUB_ENV"
+
+      - name: Update LICENSE
+        uses: jacobtomlinson/gha-find-replace@v2
+        with:
+          find: ${{ env.PREVIOUS }}
+          replace: ${{ env.CURRENT }}
+          include: "LICENSE"
+          regex: false
+
+      - name: Commit files
+        run: |
+          git config user.name 'github-actions[bot]'
+          git config user.email 'github-actions[bot]@users.noreply.github.com'
+          git commit -m "Updated License Year" -a
+
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v3
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          title: Update License Year
+          branch: update-license

CHANGES.txt

@@ -1,3 +1,17 @@
+1.3.0 (April 6, 2022)
+ - Added user consent feature to allow delaying or disabling the data tracking from SDK until user consent is explicitly granted or declined. Read more in our docs.
+ - Added `scheduler.impressionsQueueSize` property to SDK configuration to limit the amount of impressions tracked in memory. Read more in our docs.
+ - Added support to accept TLS configuration options to the Redis storage in NodeJS. Read more in our docs.
+ - Updated format for MySegments keys in LocalStorage, keeping backwards compatibility (issue https://github.com/splitio/javascript-client/issues/638).
+ - Updated some modules due to general polishing and refactors, including updates in some log messages.
+ - Updated some dependencies for vulnerability fixes.
+ - Bugfixing - Updated internal isObject utility function, to avoid unexpected behaviors on frameworks and libraries that uses multiple VM contexts, like NuxtJS dev server.
+ - Bugfixing - Fixed validation of `core.key` SDK configuration param, to parse it into a string and log a warning when passing a number (Related to issue https://github.com/splitio/react-native-client/issues/19).
+ - Bugfixing - Fixed validation of `sync.impressionsMode` SDK configuration param, to avoid an exception on SplitFactory instantiation when passing a non-string value.
+ - Bugfixing - Fixed an issue with `connectionTimeout` options params of Redis storage, that was being ignored and not passed down to the underlying ioredis client.
+ - Bugfixing - Fixed streaming synchronization issue with multiple clients.
+ - Bugfixing - Fixed issue with internal Map ponyfill that results in logger not working properly on IE11 browser.
+
 1.2.0 (January 19, 2022)
  - Added support to SDK clients on browser to optionally bind attributes to the client, keeping these loaded within the SDK along with the user ID, for easier usage when requesting flag.
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@splitsoftware/splitio-commons",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "description": "Split Javascript SDK common components",
   "main": "cjs/index.js",
   "module": "esm/index.js",
@@ -20,8 +20,8 @@
     "check:lint": "eslint src --ext .js,.ts",
     "check:types": "tsc --noEmit",
     "build": "npm run build:cjs && npm run build:esm",
-    "build:esm": "rimraf esm && tsc -m es2015 --outDir esm -d true --declarationDir types --importHelpers",
-    "build:cjs": "rimraf cjs && tsc -m CommonJS --outDir cjs --importHelpers",
+    "build:esm": "rimraf esm && tsc -m es2015 --outDir esm -d true --declarationDir types",
+    "build:cjs": "rimraf cjs && tsc -m CommonJS --outDir cjs",
     "test": "jest",
     "test:coverage": "jest --coverage",
     "publish:rc": "npm run check && npm run test && npm run build && npm publish --tag rc",
@@ -44,7 +44,7 @@
   "bugs": "https://github.com/splitio/javascript-commons/issues",
   "homepage": "https://github.com/splitio/javascript-commons#readme",
   "dependencies": {
-    "tslib": "^2.1.0"
+    "tslib": "^2.3.1"
   },
   "devDependencies": {
     "@types/google.analytics": "0.0.40",
@@ -58,17 +58,17 @@
     "eslint": "^7.32.0",
     "eslint-plugin-compat": "3.7.0",
     "eslint-plugin-import": "^2.25.3",
-    "fetch-mock": "^9.10.7",
+    "fetch-mock": "^9.11.0",
     "ioredis": "^4.28.0",
     "jest": "^27.2.3",
     "jest-localstorage-mock": "^2.4.3",
     "js-yaml": "^3.14.0",
     "lodash": "^4.17.21",
-    "node-fetch": "^2.6.1",
+    "node-fetch": "^2.6.7",
     "redis-server": "1.2.2",
     "rimraf": "^3.0.2",
     "ts-jest": "^27.0.5",
-    "typescript": "^4.0.2"
+    "typescript": "4.4.4"
   },
   "sideEffects": false
 }

src/__tests__/testUtils/fetchMock.ts

@@ -1,6 +1,7 @@
-import { sandbox } from 'fetch-mock';
+// http://www.wheresrhys.co.uk/fetch-mock/#usageinstallation
+import fetchMockLib from 'fetch-mock';
 
-const fetchMock = sandbox();
+const fetchMock = fetchMockLib.sandbox();
 
 // config the fetch mock to chain routes (appends the new route to the list of routes)
 fetchMock.config.overwriteRoutes = false;

src/consent/__tests__/sdkUserConsent.spec.ts

@@ -0,0 +1,45 @@
+import { createUserConsentAPI } from '../sdkUserConsent';
+import { syncTaskFactory } from '../../sync/__tests__/syncTask.mock';
+import { fullSettings } from '../../utils/settingsValidation/__tests__/settings.mocks';
+
+test('createUserConsentAPI', () => {
+  const settings = { ...fullSettings, userConsent: 'UNKNOWN' };
+  const syncManager = { submitter: syncTaskFactory() };
+  const storage = {
+    events: { clear: jest.fn() },
+    impressions: { clear: jest.fn() }
+  };
+
+  // @ts-ignore
+  const props = createUserConsentAPI({ settings, syncManager, storage });
+
+  // getUserConsent returns settings.userConsent
+  expect(props.getStatus()).toBe(settings.userConsent);
+  expect(props.getStatus()).toBe(props.Status.UNKNOWN);
+
+  // setting user consent to 'GRANTED'
+  expect(props.setStatus(true)).toBe(true);
+  expect(props.setStatus(true)).toBe(true); // calling again has no affect
+  expect(syncManager.submitter.start).toBeCalledTimes(1); // submitter resumed
+  expect(syncManager.submitter.stop).toBeCalledTimes(0);
+  expect(props.getStatus()).toBe(props.Status.GRANTED);
+
+  // setting user consent to 'DECLINED'
+  expect(props.setStatus(false)).toBe(true);
+  expect(props.setStatus(false)).toBe(true); // calling again has no affect
+  expect(syncManager.submitter.start).toBeCalledTimes(1);
+  expect(syncManager.submitter.stop).toBeCalledTimes(1); // submitter paused
+  expect(props.getStatus()).toBe(props.Status.DECLINED);
+  expect(storage.events.clear).toBeCalledTimes(1); // storage tracked data dropped
+  expect(storage.impressions.clear).toBeCalledTimes(1);
+
+  // Invalid values have no effect
+  expect(props.setStatus('DECLINED')).toBe(false); // strings are not valid
+  expect(props.setStatus('GRANTED')).toBe(false);
+  expect(props.setStatus(undefined)).toBe(false);
+  expect(props.setStatus({})).toBe(false);
+
+  expect(syncManager.submitter.start).toBeCalledTimes(1);
+  expect(syncManager.submitter.stop).toBeCalledTimes(1);
+  expect(props.getStatus()).toBe(props.Status.DECLINED);
+});

src/consent/index.ts

@@ -0,0 +1,8 @@
+import { ISettings } from '../types';
+import { CONSENT_GRANTED } from '../utils/constants';
+
+export function isConsentGranted(settings: ISettings) {
+  const userConsent = settings.userConsent;
+  // undefined userConsent is handled as granted (default)
+  return !userConsent || userConsent === CONSENT_GRANTED;
+}