docs: Nest SDK #750

luizgribeiro · 2024-01-10T01:07:08Z

This PR

Adds docs to the NestJS SDK.

Notes

I think we're probably reaching a stable point for the NestJS SDK.
It would be great to have some feedback on the docs before it.

Follow-up Tasks

Blog post & announcement regarding the new SDK (maybe?)

Signed-off-by: Luiz Ribeiro <[email protected]>

packages/nest/README.md

packages/nest/src/open-feature.module.ts

Co-authored-by: Michael Beemer <[email protected]> Signed-off-by: Luiz Guilherme Ribeiro <[email protected]>

packages/nest/README.md

packages/nest/src/evaluation-context-interceptor.ts

packages/nest/src/open-feature.module.ts

toddbaert · 2024-01-12T20:27:19Z

packages/nest/README.md

    @FeatureClient() private defaultClient: Client,
-    @FeatureClient({ name: 'differentServer' }) private namedClient: Client,
-  ) {
-  }
+    @FeatureClient({ name: 'differentProvider' }) private namedClient: Client,


I think we should rename this to OpenFeatureClient before we remove the experimental. I think just FeatureClient is a bit disjointed, since we have tended to either add the entire "OpenFeature" prefix, or leave it off. I think OpenFeatureClient would be best, because the client inteface is called Client so it won't clash, and it's consistent with the equivalent in react (</OpenFeatureProvider>).

It has been OpenFeatureClient before, but OpenFeatureClient is used for the implementation of the Client and it is also exported from the Server SDK.

We could remove the export of OpenFeatureClient from the Web SDK, as no one should use and import this directly anyways I would say. I have seen it several times that this type was used instead of Client in projects.
If we remove this I would be happy calling the interface OpenFeatureClienthere. What do you think @toddbaert?

What do you think @toddbaert?

Sorry for the late reply - if we can remove that export, I'm fine with it! It's an improvement.

Hey @toddbaert, removing this should be considered a breaking change I would say.
I am not sure how we want to continue on this then. What do you think?

hmm, well, if I understand correctly, it would be technically breaking, but I think it could be argued it was a misuse. All our doc recommends using the interface.

If we want to be really strict, we could consider it a break and include it with some others I have in mind in a 2.0.0 (meaning to ask you guys about this soon... there's a small list of breaking improvements I think might be worth considering)...

packages/nest/README.md

toddbaert

I think you should add a release version tag like this example for auto-inclusion of this SDK in docs.

You can also add a features table like this. The odd situation with this SDK and the React SDK (which I'm working on) is that they get some features "inhereted" from the associated parent SDK - so we may want to indicate that with some new symbol in the table. Any idas? @luizgribeiro @lukas-reining ?

We also don't have to settle everything in this PR. I will happily come back and add these little enhancements for doc inclusions later.

We could also "hide" the features tables entirely for these "integration-level" SDKs, since they have unique feature-sets related to their framework... we could consider some SDKs "language-sdks", and some "framework-sdks" and they could behave differently in the docs. cc @beeme1mr

Co-authored-by: Lukas Reining <[email protected]> Signed-off-by: Luiz Guilherme Ribeiro <[email protected]>

luizgribeiro · 2024-01-16T00:57:25Z

We could also "hide" the features tables entirely for these "integration-level" SDKs, since they have unique feature-sets related to their framework... we could consider some SDKs "language-sdks", and some "framework-sdks" and they could behave differently in the docs. cc

@toddbaert, what do you think about using something like a SDK label to make the difference between language/runtime level SDKs and framework level SDKs? We're facing this in JS right now, but will probably be a valid point in other languages and frameworks as well

Signed-off-by: Luiz Ribeiro <[email protected]>

packages/nest/README.md

packages/nest/src/evaluation-context-interceptor.ts

Signed-off-by: Lukas Reining <[email protected]>

lukas-reining · 2024-01-22T22:50:40Z

You can also add a features table like this. The odd situation with this SDK and the React SDK (which I'm working on) is that they get some features "inhereted" from the associated parent SDK - so we may want to indicate that with some new symbol in the table. Any idas? @luizgribeiro @lukas-reining ?

@toddbaert yes, maybe we could give this a Framework integration semantic. For the feature tables, I think we could maybe leave it out, as the (at least my) assumption is that the base SDK will always provide the feature set that is salwys available and these Integration SDKs are just gonna make life better and maybe even add additional specific features. What do you think?

lukas-reining · 2024-01-22T22:51:14Z

I think you should add a release version tag like this example for auto-inclusion of this SDK in docs.

This is good, @luizgribeiro could you add this?

Signed-off-by: Luiz Ribeiro <[email protected]>

Co-authored-by: Lukas Reining <[email protected]> Signed-off-by: Luiz Guilherme Ribeiro <[email protected]>

…-sdk into docs/NextSDK

Signed-off-by: Luiz Ribeiro <[email protected]>

luizgribeiro · 2024-01-23T00:46:56Z

I've tried to come up with a nice feature table but it ended up pretty repetitive from what we already have from the server-sdk, so I decided to remove it.

In this framework integration we could use something like a "compatibility table" instead of a feature table.
By doing this it would be possible to express which features from the OF base SDK are already covered and which are not or wip.

beeme1mr · 2024-01-23T01:30:26Z

@toddbaert and I were talking about something similar for the react SDK. We'll just need to come up with a pattern for these framework specific SDKs.

packages/nest/README.md

Signed-off-by: Luiz Ribeiro <[email protected]>

…-sdk into docs/NextSDK

packages/nest/README.md

beeme1mr · 2024-01-24T00:56:42Z

Awesome job @luizgribeiro and @lukas-reining.

Co-authored-by: Michael Beemer <[email protected]> Signed-off-by: Luiz Guilherme Ribeiro <[email protected]>

packages/nest/README.md

Signed-off-by: Lukas Reining <[email protected]>

lukas-reining

This looks really good now @luizgribeiro!
I will merge it and we can refine more details later if needed.

🤖 I have created a release *beep* *boop* --- ## [0.0.5-experimental](nestjs-sdk-v0.0.4-experimental...nestjs-sdk-v0.0.5-experimental) (2024-01-31) ### ✨ New Features * adds ErrorOptions to Error constructor ([#765](#765)) ([2f59a9f](2f59a9f)) ### 🐛 Bug Fixes * **nest:** add peer deps for nestjs-core and rxjs 9 ([#784](#784)) ([a452bdd](a452bdd)) * removed duped core types ([#800](#800)) ([7cc1e09](7cc1e09)) ### 📚 Documentation * Nest SDK ([#750](#750)) ([a21634d](a21634d)) * update nestjs readme examples ([#787](#787)) ([c6a357a](c6a357a)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). Signed-off-by: OpenFeature Bot <[email protected]>

@toddbaert

## This PR As discussed here #750 (comment), we should not export `OpenFeatureClient` from the server and web SDK. The type used outside the SDK should be `Client`, which is also used in the public APIs like `OpenFeatureApi`. The question is, if we should mark this as breaking. Technically it will break code that imports `OpenFeatureClient` instead of `Client`, but as @toddbaert said code using it could also be seen as "used wrong" while being technically fine. I am still leaning towards marking it as breaking, to be sure we are not breaking something that is technically fine, just because it is unintended use. But I could also live with non-beaking. --------- Signed-off-by: Lukas Reining <[email protected]>

## This PR  As discussed here [#750](#750 (comment)), renames `@FeatureClient` to `@OpenFeatureClient` which is possible since we merged #918. Signed-off-by: Lukas Reining <[email protected]>

luizgribeiro added 2 commits January 8, 2024 22:16

docs: add quick start

4dd59c4

Signed-off-by: Luiz Ribeiro <[email protected]>

chore: add jsdocs

d837440

Signed-off-by: Luiz Ribeiro <[email protected]>

luizgribeiro requested a review from a team as a code owner January 10, 2024 01:07

luizgribeiro changed the title ~~Docs/next sdk~~ docs: Next SDK Jan 10, 2024

beeme1mr reviewed Jan 10, 2024

View reviewed changes

weyert changed the title ~~docs: Next SDK~~ docs: Nest SDK Jan 10, 2024

luizgribeiro and others added 3 commits January 10, 2024 09:32

Update packages/nest/README.md

cad673a

Co-authored-by: Michael Beemer <[email protected]> Signed-off-by: Luiz Guilherme Ribeiro <[email protected]>

Update packages/nest/src/open-feature.module.ts

88bf4f7

Co-authored-by: Michael Beemer <[email protected]> Signed-off-by: Luiz Guilherme Ribeiro <[email protected]>

Update packages/nest/README.md

04e92b7

Co-authored-by: Michael Beemer <[email protected]> Signed-off-by: Luiz Guilherme Ribeiro <[email protected]>

beeme1mr requested review from weyert, toddbaert and lukas-reining January 11, 2024 03:01

beeme1mr reviewed Jan 11, 2024

View reviewed changes

packages/nest/README.md Outdated Show resolved Hide resolved

lukas-reining reviewed Jan 11, 2024

View reviewed changes

toddbaert reviewed Jan 12, 2024

View reviewed changes

packages/nest/README.md Outdated Show resolved Hide resolved

toddbaert reviewed Jan 12, 2024

View reviewed changes

luizgribeiro and others added 3 commits January 15, 2024 21:34

Update packages/nest/README.md

f0c9afe

Co-authored-by: Lukas Reining <[email protected]> Signed-off-by: Luiz Guilherme Ribeiro <[email protected]>

Update packages/nest/README.md

c527bc9

Co-authored-by: Lukas Reining <[email protected]> Signed-off-by: Luiz Guilherme Ribeiro <[email protected]>

Update packages/nest/src/evaluation-context-interceptor.ts

9f1b5f6

Co-authored-by: Lukas Reining <[email protected]> Signed-off-by: Luiz Guilherme Ribeiro <[email protected]>

docs: fix minor issues

3de4dff

Signed-off-by: Luiz Ribeiro <[email protected]>

lukas-reining reviewed Jan 22, 2024

View reviewed changes

packages/nest/README.md Outdated Show resolved Hide resolved

lukas-reining reviewed Jan 22, 2024

View reviewed changes

packages/nest/README.md Outdated Show resolved Hide resolved

lukas-reining reviewed Jan 22, 2024

View reviewed changes

packages/nest/README.md Outdated Show resolved Hide resolved

lukas-reining reviewed Jan 22, 2024

View reviewed changes

packages/nest/src/evaluation-context-interceptor.ts Outdated Show resolved Hide resolved

Update packages/nest/src/evaluation-context-interceptor.ts

de8aa97

Signed-off-by: Lukas Reining <[email protected]>

docs: specify peer deps

87f1b51

Signed-off-by: Luiz Ribeiro <[email protected]>

luizgribeiro and others added 7 commits January 22, 2024 21:03

Update packages/nest/README.md

1f932e6

Co-authored-by: Lukas Reining <[email protected]> Signed-off-by: Luiz Guilherme Ribeiro <[email protected]>

Update packages/nest/README.md

3564be5

Co-authored-by: Lukas Reining <[email protected]> Signed-off-by: Luiz Guilherme Ribeiro <[email protected]>

Update packages/nest/README.md

4035c25

Co-authored-by: Lukas Reining <[email protected]> Signed-off-by: Luiz Guilherme Ribeiro <[email protected]>

Merge branch 'docs/NextSDK' of github.com:luizgribeiro/openfeature-js…

d7801d3

…-sdk into docs/NextSDK

docs: add badge

3c33c06

Signed-off-by: Luiz Ribeiro <[email protected]>

docs: change badge order and remove line breaks

988853b

Signed-off-by: Luiz Ribeiro <[email protected]>

Merge branch 'main' into docs/NextSDK

73547b4

lukas-reining reviewed Jan 23, 2024

View reviewed changes

packages/nest/README.md Outdated Show resolved Hide resolved

luizgribeiro added 2 commits January 23, 2024 21:01

docs: add missing peer deps

c759819

Signed-off-by: Luiz Ribeiro <[email protected]>

Merge branch 'docs/NextSDK' of github.com:luizgribeiro/openfeature-js…

6d62232

…-sdk into docs/NextSDK

beeme1mr approved these changes Jan 24, 2024

View reviewed changes

packages/nest/README.md Outdated Show resolved Hide resolved

packages/nest/README.md Outdated Show resolved Hide resolved

packages/nest/README.md Outdated Show resolved Hide resolved

luizgribeiro and others added 3 commits January 23, 2024 21:58

Update packages/nest/README.md

49072d6

Co-authored-by: Michael Beemer <[email protected]> Signed-off-by: Luiz Guilherme Ribeiro <[email protected]>

Update packages/nest/README.md

8948eda

Co-authored-by: Michael Beemer <[email protected]> Signed-off-by: Luiz Guilherme Ribeiro <[email protected]>

Update packages/nest/README.md

82ede1e

Co-authored-by: Michael Beemer <[email protected]> Signed-off-by: Luiz Guilherme Ribeiro <[email protected]>

lukas-reining reviewed Jan 24, 2024

View reviewed changes

packages/nest/README.md Outdated Show resolved Hide resolved

Update packages/nest/README.md

529178b

Signed-off-by: Lukas Reining <[email protected]>

lukas-reining approved these changes Jan 24, 2024

View reviewed changes

lukas-reining enabled auto-merge January 24, 2024 08:50

lukas-reining added this pull request to the merge queue Jan 24, 2024

Merged via the queue into open-feature:main with commit a21634d Jan 24, 2024
7 checks passed

openfeaturebot mentioned this pull request Jan 24, 2024

chore(main): release nestjs-sdk 0.0.5-experimental #772

Merged

lukas-reining mentioned this pull request Jan 27, 2024

fix: remove export of OpenFeatureClient #794

Merged

lukas-reining mentioned this pull request May 17, 2024

feat!: rename FeatureClient decorator to OpenFeatureClient #949

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: Nest SDK #750

docs: Nest SDK #750

luizgribeiro commented Jan 10, 2024

toddbaert Jan 12, 2024

lukas-reining Jan 14, 2024 •

edited

Loading

lukas-reining Jan 18, 2024

toddbaert Jan 19, 2024 •

edited

Loading

lukas-reining Jan 22, 2024

toddbaert Jan 25, 2024

toddbaert left a comment •

edited

Loading

luizgribeiro commented Jan 16, 2024

lukas-reining commented Jan 22, 2024

lukas-reining commented Jan 22, 2024

luizgribeiro commented Jan 23, 2024

beeme1mr commented Jan 23, 2024

beeme1mr commented Jan 24, 2024

lukas-reining left a comment

docs: Nest SDK #750

docs: Nest SDK #750

Conversation

luizgribeiro commented Jan 10, 2024

This PR

Notes

Follow-up Tasks

toddbaert Jan 12, 2024

Choose a reason for hiding this comment

lukas-reining Jan 14, 2024 • edited Loading

Choose a reason for hiding this comment

lukas-reining Jan 18, 2024

Choose a reason for hiding this comment

toddbaert Jan 19, 2024 • edited Loading

Choose a reason for hiding this comment

lukas-reining Jan 22, 2024

Choose a reason for hiding this comment

toddbaert Jan 25, 2024

Choose a reason for hiding this comment

toddbaert left a comment • edited Loading

Choose a reason for hiding this comment

luizgribeiro commented Jan 16, 2024

lukas-reining commented Jan 22, 2024

lukas-reining commented Jan 22, 2024

luizgribeiro commented Jan 23, 2024

beeme1mr commented Jan 23, 2024

beeme1mr commented Jan 24, 2024

lukas-reining left a comment

Choose a reason for hiding this comment

lukas-reining Jan 14, 2024 •

edited

Loading

toddbaert Jan 19, 2024 •

edited

Loading

toddbaert left a comment •

edited

Loading