Release 3.0.0

[3.0.0] - January 24, 2024

New Features

The 3.0.0 release introduces a new primary feature, Advanced Audience Targeting enabled through integration with Optimizely Data Platform (ODP) ( #229, #214, #213, #212, #208, #207, #206, #205, #201, #200, #199)

You can use ODP, a high-performance Customer Data Platform (CDP), 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 5+

This version includes the following changes:

• 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.

  • 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.

  • 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:

• Advanced Audience Targeting

• Client SDK Support

• Initialize React SDK

• Advanced Audience Targeting segment qualification methods

• Send Optimizely Data Platform data using Advanced Audience Targeting

Breaking Changes

• 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 16.

Changed

• Updated @optimizely/optimizely-sdk to version 5.0.0 (#230).
• Removed use of deprecated @optimizely/js-sdk-* packages.
• Minor version bumps to dependencies.

Bug Fixes

• Updated OptimizelyProvider to (#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.

Release 3.0.0-beta2

[3.0.0-beta2] - December 26, 2023

Bug fixes

• Tag release correctly during publishing
• Updated datafile variable in README
• AAT gap fill
• Rendering default OptimizelyVariation when not last
• OptimizelyVariation with default and variation props set

Release 3.0.0-beta

[3.0.0-beta] - September 22, 2023

New Features

The 3.0.0-beta release introduces a new primary feature, Advanced Audience Targeting enabled through integration with Optimizely Data Platform (ODP) (#214, #213, #212, #208, #207, #206, #205, #201, #200, #199)

You can use ODP, a high-performance Customer Data Platform (CDP), 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

• Client SDK Support

• Initialize React SDK

• Advanced Audience Targeting segment qualification methods

• Send Optimizely Data Platform data using Advanced Audience Targeting

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.

Release 2.9.2

[2.9.2] - March 13, 2023

Enhancements

• We updated our README.md and other non-functional code to reflect that this SDK supports both Optimizely Feature Experimentation and Optimizely Full Stack. (#190).

Release 2.9.1

[2.9.1] - July 20, 2022

Bug fixes

• Fixed Redundant activate calls in useExperiment hook for one scenario.

Release 2.9.0

[2.9.0] - June 15, 2022

Bug fixes

• addresses issues #152 and #134: Gracefully returns pessimistic default values when hooks fail instead of throwing an error.
• fixed issue #156 - Added children prop to make the SDK compatible with React 18(#158).
• Updates React SDK to use React 18 and fixed related typescript issues (#159).
• Replaces enzyme with react testing library to make unit tests work with React 18 (#159).

Release 2.8.1

[2.8.1] - March 7, 2022

Enhancements

• fixed issue #49: Return type of createInstance was OptimizelyReactSDKClient which is the implementation class. Changed it to the ReactSDKClient interface instead (#148).

• fixed issue #121:ActivateListenerPayload and TrackListenerPayload types were exported from @optimizely/optimizely-sdk but were missing from @optimizely/react-sdk exports. (#150).

Bug fixes

• Fixed issue #134 of the React SDK crashing when the internal Optimizely client returns as a null value. PR #149

Release 2.8.0

[2.8.0] - January 26, 2022

New Features

• Add a set of new APIs for overriding and managing user-level flag, experiment and delivery rule decisions. These methods can be used for QA and automated testing purposes. They are an extension of the ReactSDKClient interface (#133):
  • setForcedDecision
  • getForcedDecision
  • removeForcedDecision
  • removeAllForcedDecisions
• Updated useDecision hook to auto-update and reflect changes when forced decisions are set and removed (#133).
• For details, refer to our documentation pages: ReactSDKClient, Forced Decision methods and useDecision hook.

Bug fixes

• Fixed the SDK to render the correct decision on first render when initialized synchronously using a datafile (#125).
• Fixed the redundant re-rendering when SDK is initialized with both datafile and SDK key (#125).
• Updated @optimizely/js-sdk-logging to 0.3.1 (#140).

Release 2.7.1-alpha

[2.7.1-alpha] - October 1st, 2021

Bug fixes

• Fixed the SDK to render the correct decision on first render when initialized synchronously using a datafile (#125).
• Fixed the redundant re-rendering when SDK is initialized with both datafile and SDK key (#125).

Release 2.7.0

[2.7.0] - September 16th, 2021

Upgrade @optimizely/optimizely-sdk to 4.7.0:

• Added new public properties to OptimizelyConfig . See @optimizely/optimizely-sdk Release 4.7.0 for details
• Deprecated OptimizelyFeature.experimentsMap of OptimizelyConfig. See @optimizely/optimizely-sdk Release 4.7.0 for details
• For more information, refer to our documentation page: https://docs.developers.optimizely.com/full-stack/v4.0/docs/optimizelyconfig-react