Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

prepare 3.0.0 release #264

Merged
merged 621 commits into from
Dec 7, 2022
Merged

prepare 3.0.0 release #264

merged 621 commits into from
Dec 7, 2022

Conversation

LaunchDarklyReleaseBot
Copy link
Contributor

[3.0.0] - 2022-12-07

The latest version of this SDK supports LaunchDarkly's new custom contexts feature. Contexts are an evolution of a previously-existing concept, "users." Contexts let you create targeting rules for feature flags based on a variety of different information, including attributes pertaining to users, organizations, devices, and more. You can even combine contexts to create "multi-contexts."

This feature is only available to members of LaunchDarkly's Early Access Program (EAP). If you're in the EAP, you can use contexts by updating your SDK to the latest version and, if applicable, updating your Relay Proxy. Outdated SDK versions do not support contexts, and will cause unpredictable flag evaluation behavior.

If you are not in the EAP, only use single contexts of kind "user", or continue to use the user type if available. If you try to create contexts, the context will be sent to LaunchDarkly, but any data not related to the user object will be ignored.

For detailed information about this version, please refer to the list below. For information on how to upgrade from the previous version, please read the migration guide.

Added:

  • The types LDContext, LDSingleKindContext, and LDMultiKindContext define the new "context" model.
  • All SDK methods that took an LDUser parameter now take an LDContext. LDUser is now a subset of LDContext, so existing code based on users will still work.

Changed (breaking changes from 3.x):

  • There is no longer such a thing as a secondary meta-attribute that affects percentage rollouts. If you set an attribute with that name in LDContext, it will simply be a custom attribute like any other.
  • Evaluations now treat the anonymous attribute as a simple boolean, with no distinction between a false state and an undefined state.
  • LDClient.getUser has been replaced with LDClient.getContext.
  • privateAttributeNames has been replaced with privateAttributes in LDOptions. Private attributes now allow using attribute references.

Changed (behavioral changes):

  • Analytics event data now uses a new JSON schema due to differences between the context model and the old user model.

Removed:

  • Removed all types, fields, and methods that were deprecated as of the most recent 3.x release.
  • Removed the secondary meta-attribute in LDUser.
  • The alias method no longer exists because alias events are not needed in the new context model.
  • The autoAliasingOptOut and inlineUsersInEvents options no longer exist because they are not relevant in the new context model.

Deprecated:

  • The LDUser object has been deprecated. Support for LDUser is maintained to simplify the upgrade process, but it is recommended to use LDContext in the shape of either LDSingleKindContext or LDMultiKindContext.

bwoskow-ld and others added 30 commits May 31, 2019 10:26
fix goals query logic for Electron, also fix handling of invalid content type
polyfill is available and has published that it supports setting the
method used for the stream. When this is the case, the platform
publishes that it supports using REPORT with EventSource and will
provide the polyfill implementation if the SDK attempts a EventSource
connection with the method set to REPORT.
fix stream reconnect logic and add stream connection logging
fix and simplify how the logger object is passed around
make it so eventUrlTransformer actually does something
kinyoklion and others added 26 commits April 26, 2022 16:07
Co-authored-by: Yusinto Ngadiman <[email protected]>
* Replaced getUser with getContext

* Remove contextKind

* Update GoalManager.js

Co-authored-by: Yusinto Ngadiman <[email protected]>
* Switch to 5.0 of the SDK common.

* Use a combination of dependencies that is compatible. (#269)

* Update to prerelease package. (#276)

* Update release config to use node 14.

* Update typedoc and make associated documentation changes. (#275) (#277)

* Update to pre-release common 5.0.0-alpha.2

* Update typings.d.ts (#278)

Co-authored-by: Yusinto Ngadiman <[email protected]>

* Update to js-sdk-common 5.0.0-alpha.3

* [sc-177790] Replaced getUser with getContext (#279)

* Replaced getUser with getContext

* Remove contextKind

* Update GoalManager.js

Co-authored-by: Yusinto Ngadiman <[email protected]>

* Update GoalManager.js

Co-authored-by: Ryan Lamb <[email protected]>
Co-authored-by: Yusinto Ngadiman <[email protected]>
Co-authored-by: Yusinto Ngadiman <[email protected]>
@LaunchDarklyReleaseBot LaunchDarklyReleaseBot merged commit 7548768 into main Dec 7, 2022
@LaunchDarklyReleaseBot LaunchDarklyReleaseBot deleted the release-3.0.0 branch December 7, 2022 17:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.