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

List of breaking 2.0 changes #799

Open
5 tasks
toddbaert opened this issue Jan 31, 2024 · 3 comments
Open
5 tasks

List of breaking 2.0 changes #799

toddbaert opened this issue Jan 31, 2024 · 3 comments

Comments

@toddbaert
Copy link
Member

toddbaert commented Jan 31, 2024

Please use this issue to compile a list of small breaking changes for 2.0. These should not require much to absorb should generally be small typing/naming changes.

List so far:

  • fix: remove export of OpenFeatureClient #794
  • make it impossible to return an error resolution from providers (force them to throw if something goes wrong)
  • removing setProviderAndWait and make setProvider async
  • consider renaming Client interface to something less likely to clash (I'm not sure about this one, but @luizgribeiro wanted to consider it)
  • CommonEventDetails props should all be readonly
@luizgribeiro
Copy link
Contributor

consider renaming Client interface to something less likely to clash (I'm not sure about this one, but @luizgribeiro wanted to consider it)

Giving some context on this, I was working on a project that already had an SFTP dependency that had a exported Client.
The idea here is not to be a breaking change, but provide an alias to OF Client (maybe OFClient) in order to prevent this kind of clash. It wouldn't be necessary to deprecate Client though.

@beeme1mr
Copy link
Member

beeme1mr commented Mar 6, 2024

Giving some context on this, I was working on a project that already had an SFTP dependency that had a exported Client.
The idea here is not to be a breaking change, but provide an alias to OF Client (maybe OFClient) in order to prevent this kind of clash. It wouldn't be necessary to deprecate Client though.

That sounds like a good idea to me. A ton of libraries export clients and it can even cause issues when IDEs import from the wrong one if you're not careful.

@lukas-reining
Copy link
Member

I a meeting we decided to not do the 2.0 release yet.
The crossed out points will be considered as non breaking and done before a 2.0 release.

github-merge-queue bot pushed a commit that referenced this issue May 2, 2024
… readonly (#918)

<!-- Please use this template for your pull request. -->
<!-- Please use the sections that you need and delete other sections -->

## This PR
<!-- add the description of the PR here -->

Removes OpenFeatureClient class from exports and makes event details
readonly as described here:
#799

Signed-off-by: Lukas Reining <[email protected]>
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

No branches or pull requests

4 participants