65995b238a
Included a library from the ColdBox Open Source team. More detail here if needed. https://forgebox.io/view/unleashsdk I cheated on the grammar. Grammarly helps me out there.
11 KiB
| title |
|---|
| SDK overview |
In order to connect your application to Unleash you will need a client SDK (software developer kit) for your programming language and an API token. The SDK will handle connecting to the Unleash server instance and retrieving feature toggles based on your configuration. All versions of Unleash (OSS, Pro, and Enterprise) use the same client SDKs.
Unleash provides official client SDKs for a number of programming language. Additionally, our community have developed and contributed SDKs for other languages. So if you can't find your favorite language in the list of official SDKs, check out the list of clients written by our fantastic community.
Official SDKs
Server-side SDKs:
Server-side clients run on your server and communicate directly with your Unleash instance. We provide these official clients:
Client-side SDKs
Client-side SDKs can connect to the Unleash Proxy or to the Unleash front-end API, but not to the regular Unleash client API.
- Android SDK
- Flutter Proxy SDK
- iOS Proxy SDK
- Javascript SDK
- React Proxy SDK
- Svelte Proxy SDK
- Vue Proxy SDK
Server-side SDK compatibility table
The below table shows what features the various server-side SDKs support. Note that certain features make sense only for some clients due to how the programming language works or due to how the client works.
Legend:
- ✅: Implemented
- ⭕: Not yet implemented, but we're looking into it
- ❌: Not implemented, not planned
- N/A: Not applicable to this SDK
:::note
If you see an item marked with a ❌ that you would find useful, feel free to reach out to us (on Slack, for instance) with your use case. It may not be something we can prioritize right now, but if you'd like to contribute it back to the community, we'd love to help you build it.
:::
| Capability | Java | Node.js | Go | Python | Ruby | .NET | PHP | Rust |
|---|---|---|---|---|---|---|---|---|
| Category: Initialization | ||||||||
| Async initialization | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ | ✅ |
| Can block until synchronized | ✅ | ✅ | ✅ | ⭕ | ⭕ | ✅ | ✅ | ⭕ |
| Default refresh interval | 10s | 15s | 15s | 15s | 15s | 30s | 30s | 15s |
| Default metrics interval | 60s | 60s | 60s | 60s | 60s | 60s | 30s | 15s |
| Context provider | ✅ | N/A | N/A | N/A | N/A | ✅ | ✅ | N/A |
| Global fallback function | ✅ | ✅ | ✅ | ✅ | ❌ | ❌ | ❌ | ❌ |
Toggle Query: namePrefix |
✅ | ✅ | ❌ | ❌ | ❌ | ❌ | ✅ | ❌ |
Toggle Query: tags |
✅ | ✅ | ❌ | ❌ | ❌ | ❌ | ✅ | ❌ |
Toggle Query: project_name |
✅ | ✅ | ✅ | ✅ | ✅ | ✅ | N/A | ⭕ |
| Category: Custom Headers | ||||||||
| static | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ⭕ |
| function | ✅ | ✅ | ⭕ | ✅ | ✅ (4.3) | ✅ | ✅ | ⭕ |
| Category: Built-in strategies | ||||||||
| Standard | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| Gradual rollout | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| Gradual rollout: custom stickiness | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ⭕ |
| UserID | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| IP | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| IP: CIDR syntax | ✅ | ✅ | ✅ | ✅ | ✅ | ⭕ | ✅ | ✅ |
| Hostname | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| Category: Custom strategies | ||||||||
| Basic support | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| Category: Strategy constraints | ||||||||
Basic support (IN, NOT_IN operators) |
✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| Advanced support (Semver, date, numeric and extended string operators) (introduced in) | ✅ (5.1) | ✅ (3.12) | ✅ (3.3) | ✅ (5.1) | ✅ (4.2) | ✅ (2.1) | ✅ (1.3.1) | ⭕ |
| Category: Unleash Context | ||||||||
Static fields (environment, appName) |
✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| Defined fields | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| Custom properties | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
Category: isEnabled |
||||||||
| Can take context | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| Override fallback value | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| Fallback function | ✅ | ✅ | ✅ | ✅ | ✅ | ⭕ | ⭕ | ⭕ |
| Category: Variants | ||||||||
| Basic support | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| Custom fallback variant | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ⭕ |
| Custom weight | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ⭕ |
| Custom stickiness (beta) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ⭕ |
| Category: Local backup | ||||||||
| File based backup | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ⭕ |
| Category: Usage metrics | ||||||||
| Can disable metrics | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| Client registration | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| Basic usage metrics (yes/no) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| Impression data | ⭕ | ✅ | ⭕ | ✅ | ⭕ | ⭕ | ✅ | ⭕ |
| Category: Bootstrap (beta) | ||||||||
| Bootstrap from file | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ⭕ |
| Custom Bootstrap implementation | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ⭕ |
Community SDKs ❤️
Here's some of the fantastic work our community has done to make Unleash work in even more contexts. If you still can't find your favorite language, let us know and we'd love to help you create the client for it!
- Angular - TypeScript (angular-unleash-proxy-client by Karelics)
- Angular - TypeScript (ngx-unleash-proxy-client)
- Clojure (AppsFlyer/clojure-unleash)
- C++ (aruizs/unleash-client-cpp)
- ColdBox - CFML (coldbox-modules/unleashsdk)
- Dart (uekoetter.dev/unleash-client-dart)
- Elixir (afontaine/unleash_ex)
- Haskell (finn-no/unleash-client-haskell)
- Kotlin (silvercar/unleash-client-kotlin)
- Laravel - PHP (mikefrancis/laravel-unleash)
- NestJS - Node.js (pmb0/nestjs-unleash)
- PHP (minds/unleash-client-php)
- PHP - Symfony (Stogon/unleash-bundle)
- React Native / Expo (nunogois/proxy-client-react-native)
- Solid (nunogois/proxy-client-solid)
- ...your implementation for your favorite language.
Implement your own SDK
If you can't find an SDK that fits your need, you can also develop your own SDK. To make implementation easier, check out these resources:
- Unleash Client Specifications - Used by all official SDKs to make sure they behave correctly across different language implementations. This lets us verify that a gradual rollout to 10% of the users would affect the same users regardless of which SDK you're using.
- Client SDK overview - A brief, overall guide of the Unleash Architecture and important aspects of the SDK role in it all.
Working offline
Once they have been initialized, all Unleash clients will continue to work perfectly well without an internet connection or in the event that the Unleash Server has an outage.
Because the SDKs and the Unleash Proxy cache their feature toggle states locally and only communicate with the Unleash server (in the case of the server-side SDKs and the Proxy) or the Proxy (in the case of front-end SDKs) at predetermined intervals, a broken connection only means that they won't get any new updates.
Unless the SDK supports bootstrapping, it will need to connect to Unleash at startup to get its initial feature toggle data set. If the SDK doesn't have a feature toggle data set available, all toggles will fall back to evaluating as disabled or as the specified default value (in SDKs that support that).
Bootstrapping
By default, all SDKs reach out to the Unleash Server at startup to fetch their toggle configuration. Additionally, some of the server-side SDKs and the Proxy (see the above compatibility table) also support bootstrapping, which allows them to get their toggle configuration from a file, the environment, or other local resources. These SDKs can work without any network connection whatsoever.
Bootstrapping is also supported by the following front-end client SDKs: