feat: add initial SDK library boilerplate and basic svelte LD SDK #632
Conversation
nosnibor89
changed the title
|
Hello @nosnibor89, Thank you for the contribution. Those contract tests aren't relevant to client-side SDKs, but they should all work correctly (and do run in CI and passed for your PR). When developing locally running I won't be able to review this deeply this week, but hopefully I can next week. Thank you, |
| @@ -0,0 +1,244 @@ | |||
| import * as LDClient from 'launchdarkly-js-client-sdk'; | |||
There was a problem hiding this comment.
We will be releasing the new SDK soon, which comes from this repo and is in the 'browser' directory. It will be the @launchdarkly/js-client-sdk.
The interface is very similar though, so changes should be minimal.
There was a problem hiding this comment.
Nice! I'll take peak next week and see how I could use it. Thanks
There was a problem hiding this comment.
@launchdarkly/js-client-sdk If you use the same version number as is in the repo it will use the version from the workspace.
@launchdarkly/js-client-sdk/compat provide a compatibility interface to be mostly compatible with the old package.
| ".": { | ||
| "types": "./dist/index.d.ts", | ||
| "svelte": "./dist/index.js", | ||
| "default": "./dist/index.js" |
There was a problem hiding this comment.
Sounds like svelte doesn't support CJS? That makes things very pleasant.
packages/sdk/svelte/package.json
Outdated
| "test:unit-ui": "vitest --ui" | ||
| }, | ||
| "peerDependencies": { | ||
| "@launchdarkly/js-client-sdk-common": "^1.1.4", |
There was a problem hiding this comment.
This is an interesting mix.
launchdarkly-js-client-sdk doesn't use @launchdarkly/js-client-sdk-common
But the new one does, but theoretically we would only want to use one or the other.
| LDClient, | ||
| LDFlagSet, | ||
| LDFlagValue, | ||
| LDContext as NodeLDContext, |
There was a problem hiding this comment.
Maybe some non-node name. BrowserLDContext?
| * @param {string} flagKey - The key of the flag to watch. | ||
| * @returns {Readable<LDFlagsValue>} A readable store of the flag value. | ||
| */ | ||
| const watch = (flagKey: string): Readable<LDFlagsValue> => |
There was a problem hiding this comment.
I am not sure how it needs to be handled with Svelte, but when a flag is accessed we have to make sure an event is sent to launchdarkly. This is accomplished with a variation/variation detail call.
Part of the SDKs job is providing access to flags, but the other part is driving product features.
Flag insights and experimentation, for instance, require those events to function.
For react we use a Proxy: https://github.com/launchdarkly/react-client-sdk/blob/21c2402f6d591caf61764ba35263ff1e4cb18ae7/src/getFlagsProxy.ts#L61
Ideally though we would listen to specific flags.
| * @param {string} flagKey - The key of the flag to check. | ||
| * @returns {boolean} True if the flag is on, false otherwise. | ||
| */ | ||
| const isOn = (flagKey: string): boolean => { |
There was a problem hiding this comment.
So, we could have something like this that was useValue, but we wouldn't want a pure boolean result.
Ideally each flag access takes a default, and that default goes to variation, and then that can be included in events to drive product features. So ideally we would focus the interface on individual flag access.
On means something different though. Lets imagine a flag called backgroundColor, when it is on it serves 5% of users blue, and the rest yellow, but when it is off it serves white.
On/Off is part of the reason for an evaluation, but not derived from its value.
intial refactor to use new "@launchdarkly/js-client-sdk"
Requirements
yarn run contract-testsfailed for me even inmain)Related issues
No issue
Describe the solution you've provided
Introducing the new
@launchdarkly/svelte-client-sdkpackage. Some of the details included in this PR are2.1
LDProvidercomponent2.2
LDFlagcomponent2.3 Svelte-compatible LD instance (exposes API to work with feature flags)
Describe alternatives you've considered
I don't know what to write here.
Additional context
This is the first of a series of PRs. Some of the following PR should be about
@launchdarkly/svelte-client-sdk