launchdarkly/cloudflare-edge-sdk

LaunchDarkly Server-side SDK for Cloudflare Workers

LaunchDarkly Edge SDK for Cloudflare

Important note

As mentioned in the repository changelog, the cloudflare-edge-sdk project has been renamed to cloudflare-server-sdk. All future releases will be made from the new repository. Please consider upgrading and filing potential requests in that repository's issue tracker.

v1.x readme

This library supports using Cloudflare Workers KV to replace the default in-memory feature store of the LaunchDarkly Node.js SDK.

For more information, see the SDK features guide.

Quick setup

1. Install this package with npm:

   npm install launchdarkly-cloudflare-edge-sdk --save
   

2. Require the package:

   const { init } = require('launchdarkly-cloudflare-edge-sdk');

3. When configuring your SDK client, initialize with the Cloudflare KV namespace:

   const client = init(KV_NAMESPACE, 'YOUR CLIENT-SIDE SDK KEY');

About LaunchDarkly

• LaunchDarkly is a continuous delivery platform that provides feature flags as a service and allows developers to iterate quickly and safely. We allow you to easily flag your features and manage them from the LaunchDarkly dashboard. With LaunchDarkly, you can:
  • Roll out a new feature to a subset of your users (like a group of users who opt-in to a beta tester group), gathering feedback and bug reports from real-world use cases.
  • Gradually roll out a feature to an increasing percentage of users, and track the effect that the feature has on key metrics (for instance, how likely is a user to complete a purchase if they have feature A versus feature B?).
  • Turn off a feature that you realize is causing performance problems in production, without needing to re-deploy, or even restart the application with a changed configuration file.
  • Grant access to certain features based on user attributes, like payment plan (eg: users on the ‘gold’ plan get access to more features than users in the ‘silver’ plan). Disable parts of your application to facilitate maintenance, without taking everything offline.
• LaunchDarkly provides feature flag SDKs for a wide variety of languages and technologies. Read our documentation for a complete list.
• Explore LaunchDarkly
  • launchdarkly.com for more information
  • docs.launchdarkly.com for our documentation and SDK reference guides
  • apidocs.launchdarkly.com for our API documentation
  • blog.launchdarkly.com for the latest product updates

cloudflare-edge-sdk's Issues

Not working on Cloudflare Workers...

"edge-sdk" imply to me that you can run this lib on the edge, which means, no node dependencies...
When running on Cloudflare workers this lib fails to a fair amount of dependencies to crypto and os

ES Modules support

Describe the solution you'd like
Would be great if this SDK could support and document how to use it with Module workers.

Incorrect TypeScript module definition

Describe the bug

It appears that the type definitions for this module are incorrect. When I import this module I get the following message:

If I open up the type definition file and remove /client from the end of the module declaration it works fine.

Before:

After:

TypeScript's language server is now happy:

To reproduce

See above.

Expected behavior

The module declaration matches the exported JavaScript source.

SDK version

^0.1.0

Language version, developer tools

Node 14.8.1

cloudflare-edge-sdk docs/usage do not work, as written, with latest version of wrangler

Describe the bug
When the CloudFlare worker code executes, several issues arise:

• Wrangler complains of node builtIns usage. The CLI recommends adding the following to the wrangler.toml:

node_compat = true

• After adding the above config, the code is able to build successfully, but a new runtime exception is thrown for these lines:

const ldClient = init(LD_KV_NAME, LD_CLIENT_SIDE_ID)
await ldClient.waitForInitialization()

exception

Uncaught TypeError: globalThis.XMLHttpRequest is not a constructor

To reproduce

1. Follow steps outline in this Launchdarkly article with the latest version of wrangler
2. npx wrangler dev

Expected behavior

1. The LD Client should be able to initialize
2. The LD Client should not require opting out of wrangler's default build
3. IF a separate build is required as a stop-gap, it should be clearly documented for the latest version of wrangler

Logs
If applicable, add any log output related to your problem.

SDK version

  "dependencies": {
    "launchdarkly-cloudflare-edge-sdk": "^1.0.0"
  },
  "devDependencies": {
    "@types/node": "^18.8.5",
    "typescript": "^4.8.4",
    "wrangler": "2.1.11"
  }