Merge pull request #141 from splitio/development

Release v1.8.3

Author: EmilianoSanchez

CHANGES.txt

@@ -1,3 +1,8 @@
+1.8.3 (May 16, 2023)
+ - Updated @splitsoftware/splitio package to version 10.22.5 that includes:
+      - Updated terminology on the SDKs codebase to be more aligned with current standard without causing a breaking change. The core change is the term split for feature flag on things like logs and IntelliSense comments.
+      - Updated some transitive dependencies for vulnerability fixes.
+
 1.8.2 (April 3, 2023)
  - Updated linter dependencies and rules. The deprecated TSLint package was replaced by ESLint.
  - Updated some transitive dependencies for vulnerability fixes.
@@ -30,7 +35,7 @@
       - Updated submitters logic, to avoid duplicating the post of impressions to Split cloud when the SDK is destroyed while its periodic post of impressions is running.
 
 1.5.0 (June 13, 2022)
- - Bugfixing - Fixed issue with useTreatments hooks, to return control treatments without evaluating splits when the SDK client is not ready or is destroyed, to avoid not ready impressions and warning log.
+ - Bugfixing - Fixed issue with useTreatments hooks, to return control treatments without evaluating feature flags when the SDK client is not ready or is destroyed, to avoid not ready impressions and warning log.
  - Updated @splitsoftware/splitio dependency to version 10.19.1, which includes:
       - Added `scheduler.telemetryRefreshRate` property to SDK configuration, and deprecated `scheduler.metricsRefreshRate` property.
       - Updated SDK telemetry storage, metrics and updater to be more effective and send less often.
@@ -74,15 +79,15 @@
 1.2.3 (February 8, 2021)
  - Updated React peer dependency range to include React@17.x.x.
  - Added `memoize-one` dependency for basic memoization utilities.
- - Bugfixing - Optimizing splits evaluation via memoization in order to remove `shouldComponentUpdate` method of `SplitTreatments` component and avoid stopping render propagation (issue #42).
+ - Bugfixing - Optimizing feature flags evaluation via memoization in order to remove `shouldComponentUpdate` method of `SplitTreatments` component and avoid stopping render propagation (issue #42).
 
 1.2.2 (December 15, 2020)
  - Updated @splitsoftware/splitio dependency to version 10.15.2.
- - Updated internal validation to avoid errors when passing an invalid list of split names to `SplitTreatments` component and `useTreatments` hook.
+ - Updated internal validation to avoid errors when passing an invalid list of feature flag names to `SplitTreatments` component and `useTreatments` hook.
  - Updated node-fetch and init dev dependencies for vulnerability fixes
 
 1.2.1 (Oct 7, 2020)
- - Updated @splitsoftware/splitio dependency to version 10.15.0, which uses the optimized impressions sending and supports filtering the splits to be synced. Learn more in our javascript-client changelog or documentation.
+ - Updated @splitsoftware/splitio dependency to version 10.15.0, which uses the optimized impressions sending and supports filtering the feature flags to be synced. Learn more in our javascript-client changelog or documentation.
  - Updated some NPM dependencies mostly for vulnerability fixes.
 
 1.2.0 (July 23, 2020)

README.md

@@ -3,7 +3,7 @@
 [![npm version](https://badge.fury.io/js/%40splitsoftware%2Fsplitio-react.svg)](https://badge.fury.io/js/%40splitsoftware%2Fsplitio-react) [![Build Status](https://github.com/splitio/react-client/actions/workflows/ci-cd.yml/badge.svg)](https://github.com/splitio/react-client/actions/workflows/ci-cd.yml)
 
 ## Overview
-This SDK is designed to work with Split, the platform for controlled rollouts, which serves features to your users via a Split feature flag to manage your complete customer experience.
+This SDK is designed to work with Split, the platform for controlled rollouts, which serves features to your users via feature flag to manage your complete customer experience.
 
 [![Twitter Follow](https://img.shields.io/twitter/follow/splitsoftware.svg?style=social&label=Follow&maxAge=1529000)](https://twitter.com/intent/follow?screen_name=splitsoftware)
 
@@ -25,7 +25,7 @@ import { SplitFactory, SplitTreatments } from '@splitsoftware/splitio-react';
 // Define your config object
 const CONFIG = {
   core: {
-    authorizationKey: 'YOUR_BROWSER_API_KEY',
+    authorizationKey: 'YOUR_SDK_KEY',
     key: 'CUSTOMER_ID'
   }
 };
@@ -34,15 +34,15 @@ function MyReactComponent() {
   return (
     /* Use SplitFactory to instantiate the SDK and makes it available to nested components */
     <SplitFactory config={CONFIG} >
-      {/* Evaluate splits with SplitTreatments component */}
-      <SplitTreatments names={['SPLIT_NAME']} >
-        {({ treatments: { SPLIT_NAME }, isReady }) => {
+      {/* Evaluate feature flags with SplitTreatments component */}
+      <SplitTreatments names={['FEATURE_FLAG_NAME']} >
+        {({ treatments: { FEATURE_FLAG_NAME }, isReady }) => {
           // Check SDK readiness using isReady prop
           if (!isReady)
             return <div>Loading SDK ...</div>;
-          if (SPLIT_NAME.treatment === 'on') {
+          if (FEATURE_FLAG_NAME.treatment === 'on') {
             // return JSX for on treatment
-          } else if (SPLIT_NAME.treatment === 'off') {
+          } else if (FEATURE_FLAG_NAME.treatment === 'off') {
             // return JSX for off treatment
           } else {
             // return JSX for control treatment
@@ -76,6 +76,7 @@ Split has built and maintains SDKs for:
 
 * .NET [Github](https://github.com/splitio/dotnet-client) [Docs](https://help.split.io/hc/en-us/articles/360020240172--NET-SDK)
 * Android [Github](https://github.com/splitio/android-client) [Docs](https://help.split.io/hc/en-us/articles/360020343291-Android-SDK)
+* Angular [Github](https://github.com/splitio/angular-sdk-plugin) [Docs](https://help.split.io/hc/en-us/articles/6495326064397-Angular-utilities)
 * GO [Github](https://github.com/splitio/go-client) [Docs](https://help.split.io/hc/en-us/articles/360020093652-Go-SDK)
 * iOS [Github](https://github.com/splitio/ios-client) [Docs](https://help.split.io/hc/en-us/articles/360020401491-iOS-SDK)
 * Java [Github](https://github.com/splitio/java-client) [Docs](https://help.split.io/hc/en-us/articles/360020405151-Java-SDK)

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@splitsoftware/splitio-react",
-  "version": "1.8.2",
+  "version": "1.8.3",
   "description": "A React library to easily integrate and use Split JS SDK",
   "main": "lib/index.js",
   "module": "es/index.js",
@@ -62,7 +62,7 @@
   },
   "homepage": "https://github.com/splitio/react-client#readme",
   "dependencies": {
-    "@splitsoftware/splitio": "10.22.4",
+    "@splitsoftware/splitio": "10.22.5",
     "memoize-one": "^5.1.1",
     "shallowequal": "^1.1.0"
   },

package.json

@@ -13,12 +13,12 @@ function argsAreEqual(newArgs: any[], lastArgs: any[]): boolean {
     shallowEqual(newArgs[4], lastArgs[4]); // client attributes
 }
 
-function evaluateSplits(client: SplitIO.IBrowserClient, lastUpdate: number, names: SplitIO.SplitNames, attributes?: SplitIO.Attributes, _clientAttributes?: SplitIO.Attributes) {
+function evaluateFeatureFlags(client: SplitIO.IBrowserClient, lastUpdate: number, names: SplitIO.SplitNames, attributes?: SplitIO.Attributes, _clientAttributes?: SplitIO.Attributes) {
   return client.getTreatmentsWithConfig(names, attributes);
 }
 
 /**
- * SplitTreatments accepts a list of split names and optional attributes. It access the client at SplitContext to
+ * SplitTreatments accepts a list of feature flag names and optional attributes. It access the client at SplitContext to
  * call 'client.getTreatmentsWithConfig()' method, and passes the returned treatments to a child as a function.
  *
  * @see {@link https://help.split.io/hc/en-us/articles/360020448791-JavaScript-SDK#get-treatments-with-configurations}
@@ -28,8 +28,8 @@ class SplitTreatments extends React.Component<ISplitTreatmentsProps> {
   private logWarning?: boolean;
 
   // Attaching a memoized `client.getTreatmentsWithConfig` function to the component instance, to avoid duplicated impressions because
-  // the function result is the same given the same `client` instance, `lastUpdate` timestamp, and list of split `names` and `attributes`.
-  private evaluateSplits = memoizeOne(evaluateSplits, argsAreEqual);
+  // the function result is the same given the same `client` instance, `lastUpdate` timestamp, and list of feature flag `names` and `attributes`.
+  private evaluateFeatureFlags = memoizeOne(evaluateFeatureFlags, argsAreEqual);
 
   render() {
     const { names, children, attributes } = this.props;
@@ -43,7 +43,7 @@ class SplitTreatments extends React.Component<ISplitTreatmentsProps> {
           if (client && isOperational) {
             // Cloning `client.getAttributes` result for memoization, because it returns the same reference unless `client.clearAttributes` is called.
             // Caveat: same issue happens with `names` and `attributes` props if the user follows the bad practice of mutating the object instead of providing a new one.
-            treatments = this.evaluateSplits(client, lastUpdate, names, attributes, { ...client.getAttributes() });
+            treatments = this.evaluateFeatureFlags(client, lastUpdate, names, attributes, { ...client.getAttributes() });
           } else {
             treatments = getControlTreatmentsWithConfig(names);
             if (!client) { this.logWarning = true; }