Skip to content

Commit

Permalink
[FSSDK-8579] chore: prepare for release 4.0.0 (#536)
Browse files Browse the repository at this point in the history
  • Loading branch information
jaeopt committed Jan 16, 2024
1 parent e59c595 commit 3afa432
Show file tree
Hide file tree
Showing 2 changed files with 57 additions and 2 deletions.
57 changes: 56 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,68 @@
# Optimizely Java X SDK Changelog

## [4.0.0]
January 16th, 2024

### New Features
The 4.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) (
[#474](https://github.com/optimizely/java-sdk/pull/474),
[#481](https://github.com/optimizely/java-sdk/pull/481),
[#482](https://github.com/optimizely/java-sdk/pull/482),
[#483](https://github.com/optimizely/java-sdk/pull/483),
[#484](https://github.com/optimizely/java-sdk/pull/484),
[#485](https://github.com/optimizely/java-sdk/pull/485),
[#487](https://github.com/optimizely/java-sdk/pull/487),
[#489](https://github.com/optimizely/java-sdk/pull/489),
[#490](https://github.com/optimizely/java-sdk/pull/490),
[#494](https://github.com/optimizely/java-sdk/pull/494)
).

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 Optimizely Customer Success Manager.

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.

For details, refer to our documentation pages:
- [Advanced Audience Targeting](https://docs.developers.optimizely.com/feature-experimentation/docs/optimizely-data-platform-advanced-audience-targeting)
- [Server SDK Support](https://docs.developers.optimizely.com/feature-experimentation/v1.0/docs/advanced-audience-targeting-for-server-side-sdks)
- [Initialize Java SDK](https://docs.developers.optimizely.com/feature-experimentation/docs/initialize-sdk-java)
- [OptimizelyUserContext Java SDK](https://docs.developers.optimizely.com/feature-experimentation/docs/optimizelyusercontext-java)
- [Advanced Audience Targeting segment qualification methods](https://docs.developers.optimizely.com/feature-experimentation/docs/advanced-audience-targeting-segment-qualification-methods-java)
- [Send Optimizely Data Platform data using Advanced Audience Targeting](https://docs.developers.optimizely.com/feature-experimentation/docs/send-odp-data-using-advanced-audience-targeting-java)

### Breaking Changes
- `OdpManager` in the SDK is enabled by default, if initialized using OptimizelyFactory. Unless an ODP account is integrated into the Optimizely projects, most `OdpManager` functions will be ignored. If needed, ODP features can be disabled by initializing `OptimizelyClient` without passing `OdpManager`.
- `ProjectConfigManager` interface has been changed to add 2 more methods `getCachedConfig()` and `getSDKKey()`. Custom ProjectConfigManager should implement these new methods. See `PollingProjectConfigManager` for reference. This change is required to support ODPManager updated on datafile download ([#501](https://github.com/optimizely/java-sdk/pull/501)).

### Fixes
- Fix thread leak from httpClient in HttpProjectConfigManager ([#530](https://github.com/optimizely/java-sdk/pull/530)).
- Fix issue when vuid is passed as userid for `AsyncGetQualifiedSegments` ([#527](https://github.com/optimizely/java-sdk/pull/527)).
- Fix to support arbitrary client names to be included in logx and odp events ([#524](https://github.com/optimizely/java-sdk/pull/524)).
- Add evict timeout to logx connections ([#518](https://github.com/optimizely/java-sdk/pull/518)).

### Functionality Enhancements
- Update Github Issue Templates ([#531](https://github.com/optimizely/java-sdk/pull/531))



## [4.0.0-beta2]
August 28th, 2023

### Fixes
- Fix thread leak from httpClient in HttpProjectConfigManager ([#530](https://github.com/optimizely/java-sdk/pull/530)).
- Fix issue when vuid is passed as userid for `AsyncGetQualifiedSegments` ([#527](https://github.com/optimizely/java-sdk/pull/527)).
- Fix to support arbitrary client names to be included in logx and odp events ([#524](https://github.com/optimizely/java-sdk/pull/524)).
- Add evict timeout to logx connections ([#518](https://github.com/optimizely/java-sdk/pull/518)).

### Functionality Enhancements
- Update Github Issue Templates ([#531](https://github.com/optimizely/java-sdk/pull/531))
Expand Down
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright 2016, Optimizely
Copyright 2016-2024, Optimizely, Inc. and contributors

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand Down

0 comments on commit 3afa432

Please sign in to comment.