From b778be66626939e1046287e33ab52bd9f9778cd9 Mon Sep 17 00:00:00 2001 From: Mike Chu Date: Wed, 24 Jan 2024 15:36:08 +0000 Subject: [PATCH 1/4] build: bump SDK version --- package.json | 2 +- src/client.spec.ts | 2 +- src/client.ts | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/package.json b/package.json index 2b99ece..d1378b3 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@optimizely/react-sdk", - "version": "3.0.0-beta2", + "version": "3.0.0", "description": "React SDK for Optimizely Feature Experimentation, Optimizely Full Stack (legacy), and Optimizely Rollouts", "homepage": "https://github.com/optimizely/react-sdk", "repository": "https://github.com/optimizely/react-sdk", diff --git a/src/client.spec.ts b/src/client.spec.ts index 99fbb86..b1a79c9 100644 --- a/src/client.spec.ts +++ b/src/client.spec.ts @@ -123,7 +123,7 @@ describe('ReactSDKClient', () => { expect(createInstanceSpy).toBeCalledWith({ ...config, clientEngine: 'react-sdk', - clientVersion: '3.0.0-beta2', + clientVersion: '3.0.0', }); }); diff --git a/src/client.ts b/src/client.ts index a109029..5e7dc70 100644 --- a/src/client.ts +++ b/src/client.ts @@ -43,7 +43,7 @@ export interface OnReadyResult extends ResolveResult { } const REACT_SDK_CLIENT_ENGINE = 'react-sdk'; -const REACT_SDK_CLIENT_VERSION = '3.0.0-beta2'; +const REACT_SDK_CLIENT_VERSION = '3.0.0'; export const DefaultUser: UserInfo = { id: null, From 839d3e668a9cb75ab197deb2c2a157d7c4b9f5e0 Mon Sep 17 00:00:00 2001 From: Mike Chu Date: Wed, 24 Jan 2024 15:42:12 +0000 Subject: [PATCH 2/4] docs: update changelog --- CHANGELOG.md | 58 ++++++++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 54 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index a09a054..c2f4d92 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,9 +1,59 @@ # Changelog -All notable changes to this project will be documented in this file. +## [3.0.0] - January 24, 2024 -The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) -and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html). +### New Features + +The 3.0.0 release introduces a new primary feature, [Advanced Audience Targeting]( https://docs.developers.optimizely.com/feature-experimentation/docs/optimizely-data-platform-advanced-audience-targeting) enabled through integration with [Optimizely Data Platform (ODP)](https://docs.developers.optimizely.com/optimizely-data-platform/docs) (#214, #213, #212, #208, #207, #206, #205, #201, #200, #199) + +You can use ODP, a high-performance [Customer Data Platform (CDP)]( https://www.optimizely.com/optimization-glossary/customer-data-platform/), to easily create complex real-time segments (RTS) using first-party and 50+ third-party data sources out of the box. You can create custom schemas that support the user attributes important for your business, and stitch together user behavior done on different devices to better understand and target your customers for personalized user experiences. ODP can be used as a single source of truth for these segments in any Optimizely or 3rd party tool. + +With ODP accounts integrated into Optimizely projects, you can build audiences using segments pre-defined in ODP. The SDK will fetch the segments for given users and make decisions using the segments. For access to ODP audience targeting in your Feature Experimentation account, please contact your Customer Success Manager. + +This release leverages the Optimizely JavaScript SDK beta5+ + +This version includes the following changes: + +- New API added to `OptimizelyUserContext`: + + - `fetchQualifiedSegments()`: this API will retrieve user segments from the ODP server. The fetched segments will be used for audience evaluation. The fetched data will be stored in the local cache to avoid repeated network delays. + + - When an `OptimizelyUserContext` is created, the SDK will automatically send an identify request to the ODP server to facilitate observing user activities. + +- New APIs added to `OptimizelyClient`: + + - `sendOdpEvent()`: customers can build/send arbitrary ODP events that will bind user identifiers and data to user profiles in ODP. + + - `createUserContext()` with anonymous user IDs: user-contexts can be created without a userId. The SDK will create and use a persistent `VUID` specific to a device when userId is not provided. + +For details, refer to our documentation pages: + +- [Advanced Audience Targeting](https://docs.developers.optimizely.com/feature-experimentation/docs/optimizely-data-platform-advanced-audience-targeting) + +- [Client SDK Support](https://docs.developers.optimizely.com/feature-experimentation/v1.0/docs/advanced-audience-targeting-for-client-side-sdks) + +- [Initialize React SDK](https://docs.developers.optimizely.com/feature-experimentation/docs/initialize-sdk-react) + +- [Advanced Audience Targeting segment qualification methods](https://docs.developers.optimizely.com/feature-experimentation/docs/advanced-audience-targeting-segment-qualification-methods-react) + +- [Send Optimizely Data Platform data using Advanced Audience Targeting](https://docs.developers.optimizely.com/feature-experimentation/docs/send-odp-data-using-advanced-audience-targeting-react) + +### Breaking Changes +- `OdpManager` in the SDK is enabled by default. Unless an ODP account is integrated into the Optimizely projects, most `OdpManager` functions will be ignored. If needed, `OdpManager` can be disabled when `OptimizelyClient` is instantiated. +- Updated `murmurhash` dependency to version `2.0.1`. +- Updated `uuid` dependency to version `8.3.2`. +- Dropped support for the following browser versions. + - All versions of Microsoft Internet Explorer. + - Chrome versions earlier than `102.0`. + - Microsoft Edge versions earlier than `84.0`. + - Firefox versions earlier than `91.0`. + - Opera versions earlier than `76.0`. + - Safari versions earlier than `13.0`. +- Dropped support for Node JS versions earlier than `14`. + +### Changed +- Updated `createUserContext`'s `userId` parameter to be optional due to the Browser variation's use of the new `vuid` field ([#229](https://github.com/optimizely/react-sdk/pull/229)) +- Updated `@optimizely/optimizely-sdk` to version `5.0.0` ([#230](https://github.com/optimizely/react-sdk/pull/230)) ## [3.0.0-beta2] - December 26, 2023 @@ -65,7 +115,7 @@ For details, refer to our documentation pages: - Safari versions earlier than `13.0`. - Dropped support for Node JS versions earlier than `14`. -## Changed +### Changed - Updated `createUserContext`'s `userId` parameter to be optional due to the Browser variation's use of the new `vuid` field. ## [2.9.2] - March 13, 2023 From 39e9b009f0185586d327566051b248be7b181bad Mon Sep 17 00:00:00 2001 From: Mike Chu Date: Wed, 24 Jan 2024 19:34:59 +0000 Subject: [PATCH 3/4] docs: changelog corrections --- CHANGELOG.md | 34 ++++++++++++++++++---------------- 1 file changed, 18 insertions(+), 16 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index c2f4d92..0a22393 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,27 +4,35 @@ ### New Features -The 3.0.0 release introduces a new primary feature, [Advanced Audience Targeting]( https://docs.developers.optimizely.com/feature-experimentation/docs/optimizely-data-platform-advanced-audience-targeting) enabled through integration with [Optimizely Data Platform (ODP)](https://docs.developers.optimizely.com/optimizely-data-platform/docs) (#214, #213, #212, #208, #207, #206, #205, #201, #200, #199) +The 3.0.0 release introduces a new primary feature, [Advanced Audience Targeting]( https://docs.developers.optimizely.com/feature-experimentation/docs/optimizely-data-platform-advanced-audience-targeting) enabled through integration with [Optimizely Data Platform (ODP)](https://docs.developers.optimizely.com/optimizely-data-platform/docs) ( + [#214](https://github.com/optimizely/react-sdk/pull/214), + [#213](https://github.com/optimizely/react-sdk/pull/213), + [#212](https://github.com/optimizely/react-sdk/pull/212), + [#208](https://github.com/optimizely/react-sdk/pull/208), + [#207](https://github.com/optimizely/react-sdk/pull/207), + [#206](https://github.com/optimizely/react-sdk/pull/206), + [#205](https://github.com/optimizely/react-sdk/pull/205), + [#201](https://github.com/optimizely/react-sdk/pull/201), + [#200](https://github.com/optimizely/react-sdk/pull/200), + [#199](https://github.com/optimizely/react-sdk/pull/199)) You can use ODP, a high-performance [Customer Data Platform (CDP)]( https://www.optimizely.com/optimization-glossary/customer-data-platform/), to easily create complex real-time segments (RTS) using first-party and 50+ third-party data sources out of the box. You can create custom schemas that support the user attributes important for your business, and stitch together user behavior done on different devices to better understand and target your customers for personalized user experiences. ODP can be used as a single source of truth for these segments in any Optimizely or 3rd party tool. With ODP accounts integrated into Optimizely projects, you can build audiences using segments pre-defined in ODP. The SDK will fetch the segments for given users and make decisions using the segments. For access to ODP audience targeting in your Feature Experimentation account, please contact your Customer Success Manager. -This release leverages the Optimizely JavaScript SDK beta5+ +This release leverages the Optimizely JavaScript SDK 5+ This version includes the following changes: -- New API added to `OptimizelyUserContext`: +- New APIs added to `ReactSDKClient`: - `fetchQualifiedSegments()`: this API will retrieve user segments from the ODP server. The fetched segments will be used for audience evaluation. The fetched data will be stored in the local cache to avoid repeated network delays. - - When an `OptimizelyUserContext` is created, the SDK will automatically send an identify request to the ODP server to facilitate observing user activities. + - `getUserContext()`: get the current `OptimizelyUserContext` object in use at the React SDK level. -- New APIs added to `OptimizelyClient`: - - - `sendOdpEvent()`: customers can build/send arbitrary ODP events that will bind user identifiers and data to user profiles in ODP. - - - `createUserContext()` with anonymous user IDs: user-contexts can be created without a userId. The SDK will create and use a persistent `VUID` specific to a device when userId is not provided. + - `getVuid()`: provides access to the anonymous client-side visitor ID (VUID) generated by the JS SDK. This ID is used to identify unique visitors in Optimizely Results in the absence of a standard user ID. + + - `sendOdpEvent()`: customers can build/send arbitrary ODP events that will bind user identifiers and data to user profiles in ODP. For details, refer to our documentation pages: @@ -39,9 +47,6 @@ For details, refer to our documentation pages: - [Send Optimizely Data Platform data using Advanced Audience Targeting](https://docs.developers.optimizely.com/feature-experimentation/docs/send-odp-data-using-advanced-audience-targeting-react) ### Breaking Changes -- `OdpManager` in the SDK is enabled by default. Unless an ODP account is integrated into the Optimizely projects, most `OdpManager` functions will be ignored. If needed, `OdpManager` can be disabled when `OptimizelyClient` is instantiated. -- Updated `murmurhash` dependency to version `2.0.1`. -- Updated `uuid` dependency to version `8.3.2`. - Dropped support for the following browser versions. - All versions of Microsoft Internet Explorer. - Chrome versions earlier than `102.0`. @@ -49,7 +54,7 @@ For details, refer to our documentation pages: - Firefox versions earlier than `91.0`. - Opera versions earlier than `76.0`. - Safari versions earlier than `13.0`. -- Dropped support for Node JS versions earlier than `14`. +- Dropped support for Node JS versions earlier than `16`. ### Changed - Updated `createUserContext`'s `userId` parameter to be optional due to the Browser variation's use of the new `vuid` field ([#229](https://github.com/optimizely/react-sdk/pull/229)) @@ -103,9 +108,6 @@ For details, refer to our documentation pages: - [Send Optimizely Data Platform data using Advanced Audience Targeting](https://docs.developers.optimizely.com/feature-experimentation/docs/send-odp-data-using-advanced-audience-targeting-react) ### Breaking Changes -- `ODPManager` in the SDK is enabled by default. Unless an ODP account is integrated into the Optimizely projects, most `ODPManager` functions will be ignored. If needed, `ODPManager` can be disabled when `OptimizelyClient` is instantiated. -- Updated `murmurhash` dependency to version `2.0.1`. -- Updated `uuid` dependency to version `8.3.2`. - Dropped support for the following browser versions. - All versions of Microsoft Internet Explorer. - Chrome versions earlier than `102.0`. From d3fda3ef10076dec5675e1abc7b768d6095da409 Mon Sep 17 00:00:00 2001 From: Mike Chu Date: Wed, 24 Jan 2024 19:49:23 +0000 Subject: [PATCH 4/4] docs: add bug fixes + formatting --- CHANGELOG.md | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 0a22393..7c2ef67 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,7 @@ ### New Features The 3.0.0 release introduces a new primary feature, [Advanced Audience Targeting]( https://docs.developers.optimizely.com/feature-experimentation/docs/optimizely-data-platform-advanced-audience-targeting) enabled through integration with [Optimizely Data Platform (ODP)](https://docs.developers.optimizely.com/optimizely-data-platform/docs) ( + [#229](https://github.com/optimizely/react-sdk/pull/229), [#214](https://github.com/optimizely/react-sdk/pull/214), [#213](https://github.com/optimizely/react-sdk/pull/213), [#212](https://github.com/optimizely/react-sdk/pull/212), @@ -29,8 +30,8 @@ This version includes the following changes: - `fetchQualifiedSegments()`: this API will retrieve user segments from the ODP server. The fetched segments will be used for audience evaluation. The fetched data will be stored in the local cache to avoid repeated network delays. - `getUserContext()`: get the current `OptimizelyUserContext` object in use at the React SDK level. - - - `getVuid()`: provides access to the anonymous client-side visitor ID (VUID) generated by the JS SDK. This ID is used to identify unique visitors in Optimizely Results in the absence of a standard user ID. + + - `getVuid()`: provides access to the anonymous client-side visitor ID (VUID) generated by the JS SDK. This ID is used to identify unique visitors in Optimizely Results in the absence of a standard user ID. - `sendOdpEvent()`: customers can build/send arbitrary ODP events that will bind user identifiers and data to user profiles in ODP. @@ -57,8 +58,15 @@ For details, refer to our documentation pages: - Dropped support for Node JS versions earlier than `16`. ### Changed -- Updated `createUserContext`'s `userId` parameter to be optional due to the Browser variation's use of the new `vuid` field ([#229](https://github.com/optimizely/react-sdk/pull/229)) -- Updated `@optimizely/optimizely-sdk` to version `5.0.0` ([#230](https://github.com/optimizely/react-sdk/pull/230)) +- Updated `@optimizely/optimizely-sdk` to version `5.0.0` ([#230](https://github.com/optimizely/react-sdk/pull/230)). +- Removed use of deprecated `@optimizely/js-sdk-*` packages. +- Minor version bumps to dependencies. + +### Bug Fixes +- Updated `OptimizelyProvider` to ([#229](https://github.com/optimizely/react-sdk/pull/229)) + - correctly adhere to optional `userId?` and `user?` interface fields, using the `DefaultUser` to signal to client-side contexts to use the new `vuid` identifier. + - correctly use of the correct React lifecyle methods. + ## [3.0.0-beta2] - December 26, 2023