Merge pull request #827 from splitio/breaking_changes

Breaking changes

Author: EmilianoSanchez

.eslintrc

@@ -46,7 +46,7 @@
       ],
       "rules": {
         "no-restricted-syntax": ["error", "ForOfStatement", "ForInStatement", "ArrayPattern"],
-        "compat/compat": ["error", "defaults, ie 10, node 6"],
+        "compat/compat": ["error", "defaults, node >=14"],
         "no-throw-literal": "error",
         "import/no-default-export": "error",
         "import/no-self-import": "error"

.github/workflows/ci-cd.yml

@@ -58,7 +58,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/development' || github.ref == 'refs/heads/master') }}
+        if: ${{ github.event_name == 'push' && (github.ref == 'refs/heads/refactor_type_definitions' || github.ref == 'refs/heads/master') }}
         uses: actions/upload-artifact@v3
         with:
           name: assets
@@ -69,7 +69,7 @@ jobs:
     name: Upload assets
     runs-on: ubuntu-20.04
     needs: build
-    if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/development' }}
+    if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/refactor_type_definitions' }}
     strategy:
       matrix:
         environment:

CHANGES.txt

@@ -1,10 +1,13 @@
-11.0.0 (October XX, 2024)
+11.0.0 (November 1, 2024)
  - Added support for targeting rules based on large segments for browsers.
  - Added `factory.destroy()` method, which invokes the `destroy` method of all clients created by the factory.
  - Updated @splitsoftware/splitio-commons package to version 2.0.0 that includes major updates and updated some transitive dependencies for vulnerability fixes.
- - Bugfixing - Removed an overloaded `client` method in the `SplitIO.ISDK` interface that accepted a key and trafficType parameters. This interface corresponds to the SDK factory instance in NodeJS, which, unlike `SplitIO.IBrowserSDK` for the Browser, does not handle multiple client instances based on keys or traffic types.
+ - Renamed distribution folders from `/lib` to `/cjs` for CommonJS build, and `/es` to `/esm` for ECMAScript Modules build.
  - BREAKING CHANGES:
-    - Renamed distribution folders from `/lib` to `/cjs` for CommonJS build, and `/es` to `/esm` for EcmaScript Modules build.
+    - Dropped support for NodeJS v6. The SDK now requires NodeJS v14 or above.
+    - Removed internal ponyfills for the `Map` and `Set` global objects, dropping support for IE and other outdated browsers. The SDK now requires the runtime environment to support these features natively or provide a polyfill.
+    - Removed the deprecated `GOOGLE_ANALYTICS_TO_SPLIT` and `SPLIT_TO_GOOGLE_ANALYTICS` integrations. The `integrations` configuration option has been removed from the SDK factory configuration, along with the associated interfaces in the TypeScript definitions.
+    - Removed the `core.trafficType` configuration option (`SplitIO.IBrowserSettings['core']['trafficType]`) and the `trafficType` parameter from the SDK `client()` method in Browser (`SplitIO.IBrowserSDK['client']`). As a result, traffic types can no longer be bound to SDK clients, and the traffic type must be provided in the `track` method.
 
 10.28.0 (September 6, 2024)
  - Updated @splitsoftware/splitio-commons package to version 1.17.0 that includes minor updates:
@@ -515,7 +518,7 @@
  - Bugfixing - Return correct label when consulted Split is not found.
 
 9.1.1 (May 03, 2017)
- - Bugfixing - Fixed invalid behaviour when using native Fetch API and comparing statusText
+ - Bugfixing - Fixed invalid behavior when using native Fetch API and comparing statusText
   instead of resp.ok
 
 9.1.0 (April 21, 2017)

karma/e2e.gaIntegration.karma.conf.js

@@ -1,6 +1,6 @@
 {
   "name": "@splitsoftware/splitio",
-  "version": "10.28.1-rc.4",
+  "version": "11.0.0-rc.5",
   "description": "Split SDK",
   "files": [
     "README.md",
@@ -11,7 +11,6 @@
     "types",
     "esm",
     "src",
-    "scripts/ga-to-split-autorequire.js",
     "client",
     "server"
   ],
@@ -36,13 +35,10 @@
   "module": "esm/index.js",
   "types": "types",
   "engines": {
-    "npm": ">=3",
-    "node": ">=6"
+    "node": ">=14.0.0"
   },
   "dependencies": {
-    "@splitsoftware/splitio-commons": "1.17.1-rc.4",
-    "@types/google.analytics": "0.0.40",
-    "@types/ioredis": "^4.28.0",
+    "@splitsoftware/splitio-commons": "2.0.0-rc.6",
     "bloom-filters": "^3.0.0",
     "ioredis": "^4.28.0",
     "js-yaml": "^3.13.1",
@@ -91,7 +87,6 @@
     "postbuild-cjs": "cross-env NODE_ENV=cjs node scripts/copy.packages.json.js && ./scripts/build_cjs_replace_imports.sh",
     "build-umd": "rimraf umd && webpack --config webpack.dev.js --env branch=$BUILD_BRANCH && webpack --config webpack.prod.js --env branch=$BUILD_BRANCH && ./scripts/clean_umd_build.sh",
     "build:npm": "npm run build-cjs && npm run build-esm",
-    "build:ga-to-split-autorequire": "terser ./node_modules/@splitsoftware/splitio-commons/src/integrations/ga/autoRequire.js --mangle --output ./scripts/ga-to-split-autorequire.js && cp ./scripts/ga-to-split-autorequire.js umd/ga-to-split-autorequire.js",
     "build": "npm run build-cjs && npm run build-esm && npm run build-umd",
     "check": "npm run check:lint && npm run check:version",
     "check:lint": "eslint src",
@@ -104,7 +99,6 @@
     "test-browser-e2e-destroy": "cross-env NODE_ENV=test karma start karma/e2e.destroy.karma.conf.js",
     "test-browser-e2e-errorCatching": "cross-env NODE_ENV=test karma start karma/e2e.errorCatching.karma.conf.js",
     "test-browser-e2e-push": "cross-env NODE_ENV=test karma start karma/e2e.push.karma.conf.js",
-    "test-browser-e2e-gaIntegration": "cross-env NODE_ENV=test karma start karma/e2e.gaIntegration.karma.conf.js",
     "test-node": "npm run test-node-unit && npm run test-node-e2e",
     "test-node-unit": "cross-env NODE_ENV=test tape -r ./ts-node.register \"src/*/**/__tests__/**/!(browser).spec.js\" | tap-min",
     "test-node-e2e": "npm run test-node-e2e-online && npm run test-node-e2e-offline && npm run test-node-e2e-destroy && npm run test-node-e2e-errorCatching && npm run test-node-e2e-push && npm run test-node-e2e-redis",
@@ -114,9 +108,7 @@
     "test-node-e2e-errorCatching": "cross-env NODE_ENV=test tape -r ./ts-node.register src/__tests__/errorCatching/node.spec.js | tap-min",
     "test-node-e2e-push": "cross-env NODE_ENV=test tape -r ./ts-node.register src/__tests__/push/node.spec.js | tap-min",
     "test-node-e2e-redis": "cross-env NODE_ENV=test tape -r ./ts-node.register src/__tests__/consumer/node_redis.spec.js | tap-min",
-    "pretest-ts-decls": "npm run build-esm && npm run build-cjs && npm link",
-    "test-ts-decls": "./scripts/ts-tests.sh",
-    "posttest-ts-decls": "npm rm --location=global @splitsoftware/splitio && npm install",
+    "test-ts-decls": "tsc --build ts-tests",
     "test": "npm run test-node && npm run test-browser",
     "all": "npm run check && npm run build && npm run test-ts-decls && npm run test",
     "publish:rc": "npm run check && npm run build && npm publish --tag canary",

package-lock.json

@@ -111,7 +111,7 @@ export default async function telemetryBrowserSuite(fetchMock, t) {
         oM: 0, st: 'memory', aF: 1, rF: 0, sE: false,
         rR: { sp: 99999, ms: 60, im: 300, ev: 60, te: 1 } /* override featuresRefreshRate */,
         uO: { s: true, e: true, a: false, st: false, t: true } /* override sdk, events and telemetry URLs */,
-        iQ: 30000, eQ: 500, iM: 0, iL: false, hP: false, nR: 1 /* 1 non ready usage */, t: [], i: [], uC: 2 /* Default GRANTED */,
+        iQ: 30000, eQ: 500, iM: 0, iL: false, hP: false, nR: 1 /* 1 non ready usage */, t: [], uC: 2 /* Default GRANTED */,
         fsT: 0, fsI: 0
       }, 'metrics/config JSON payload should be the expected');
 

package.json

@@ -72,7 +72,7 @@ function mockSubmittersRequests(fetchMock, assert, impressionFeature, eventTypeI
 
 export default function userConsent(fetchMock, t) {
 
-  // Validate trackers, submitters and browser listener behaviour on different consent status transitions
+  // Validate trackers, submitters and browser listener behavior on different consent status transitions
   t.test(async (assert) => {
     const sendBeaconSpy = sinon.spy(window.navigator, 'sendBeacon');
     let expectedTrackedImpressions = 0;
@@ -97,7 +97,7 @@ export default function userConsent(fetchMock, t) {
       ], ['on', 'on', 'on', 'on', 'on', 'on', 'on', 'on'], 'evaluating on SDK ready');
       if (isTracking) expectedTrackedImpressions += 8;
 
-      // Trigger pagehide event to validate browser listener behaviour
+      // Trigger pagehide event to validate browser listener behavior
       // Beacon API is used only if user consent is GRANTED
       triggerPagehideEvent();
       if (factory.UserConsent.getStatus() === factory.UserConsent.Status.GRANTED) {
@@ -137,9 +137,9 @@ export default function userConsent(fetchMock, t) {
     assert.equal(trackedImpressions.length, expectedTrackedImpressions, 'Tracked impressions are the expected');
     sendBeaconSpy.restore();
     assert.end();
-  }, 'Validate trackers, submitters and browser listener behaviour on different consent status transitions');
+  }, 'Validate trackers, submitters and browser listener behavior on different consent status transitions');
 
-  // Validate submitter's behaviour with full queues and with events first push window
+  // Validate submitter's behavior with full queues and with events first push window
   t.test(async (assert) => {
     const config = {
       ...baseConfig,
@@ -182,6 +182,6 @@ export default function userConsent(fetchMock, t) {
     await client.destroy();
 
     assert.end();
-  }, 'Validate submitter\'s behaviour with full queues and with events first push window');
+  }, 'Validate submitter\'s behavior with full queues and with events first push window');
 
 }