From 2ac5cc2d0840bad2329d14d421a9406a9645c8b4 Mon Sep 17 00:00:00 2001 From: Mike Chu <104384559+mikechu-optimizely@users.noreply.github.com> Date: Fri, 22 Sep 2023 15:11:05 -0400 Subject: [PATCH] [FSSDK-9494] 3.0.0-beta release preparation (#215) * Bump version number * Update CHANGELOG * Change CRLF to LF * Remove Node based info --------- Co-authored-by: Mike Chu --- CHANGELOG.md | 54 ++++++++++++++++++++++++++++++++++++++++++++++ package.json | 2 +- src/client.spec.ts | 2 +- src/client.ts | 2 +- 4 files changed, 57 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 89693672..eb49e5e1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,60 @@ All notable changes to this project will be documented in this file. 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). +# [3.0.0-beta] - September 22, 2023 + +### New Features + +The 3.0.0-beta 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. + ## [2.9.2] - March 13, 2023 ### Enhancements diff --git a/package.json b/package.json index 9f4f0bf9..54f3257d 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@optimizely/react-sdk", - "version": "2.9.2", + "version": "3.0.0-beta", "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 676808c5..759fe2e1 100644 --- a/src/client.spec.ts +++ b/src/client.spec.ts @@ -122,7 +122,7 @@ describe('ReactSDKClient', () => { expect(createInstanceSpy).toBeCalledWith({ ...config, clientEngine: 'react-sdk', - clientVersion: '2.9.2', + clientVersion: '3.0.0-beta', }); }); diff --git a/src/client.ts b/src/client.ts index 812b022b..33107de8 100644 --- a/src/client.ts +++ b/src/client.ts @@ -42,7 +42,7 @@ export interface OnReadyResult extends ResolveResult { } const REACT_SDK_CLIENT_ENGINE = 'react-sdk'; -const REACT_SDK_CLIENT_VERSION = '2.9.2'; +const REACT_SDK_CLIENT_VERSION = '3.0.0-beta'; const default_user: UserInfo = { id: null,