feat: Add Fastly Edge SDK #723

ldhenry · 2025-01-03T15:55:24Z

Requirements

I have added test coverage for new or changed functionality
I have followed the repository's pull request submission guidelines
I have validated my changes against all supported platform versions

Describe the solution you've provided

This PR adds a new Fastly Compute SDK. This SDK must be used in conjunction with our upcoming Fastly KV integration. The SDK is essentially the same as the other edge integrations (Akamai, Cloudflare, Vercel), with the following changes:

node:events is not compatible with Fastly's runtime. As a result, we cannot use @launchdarkly/sdk-server-edge. Instead, I copied the contents of @launchdarkly/sdk-server-edge into the fastly package and replaced createCallbacks.ts with an empty implementation.
Enabled sendEvents by default.
Added a new optional eventsBackendName option. A Fastly Backend configured to https://events.launchdarkly.com is required for sending events. The default value is launchdarkly. This option is passed to Fastly's customized fetch().

I added an example app that demonstrates using the SDK to evaluate a feature flag edge to control the static image served.

I published an alpha version to npm here.

github-actions · 2025-01-03T15:56:51Z

@launchdarkly/js-sdk-common size report
This is the brotli compressed size of the ESM build.
Size: 19014 bytes
Size limit: 21000

github-actions · 2025-01-03T15:57:06Z

@launchdarkly/js-client-sdk size report
This is the brotli compressed size of the ESM build.
Size: 19814 bytes
Size limit: 21000

github-actions · 2025-01-03T15:57:09Z

@launchdarkly/js-client-sdk-common size report
This is the brotli compressed size of the ESM build.
Size: 15354 bytes
Size limit: 20000

ldhenry · 2025-01-03T18:00:36Z

packages/sdk/fastly/__tests__/api/LDClient.test.ts

@@ -0,0 +1,46 @@
+import { internal } from '@launchdarkly/js-server-sdk-common';


All tests in this directory were copied over from @launchdarkly/sdk-server-edge

ldhenry · 2025-01-03T18:01:01Z

packages/sdk/fastly/__tests__/createBasicPlatform.ts

@@ -0,0 +1,59 @@
+import { PlatformData, SdkData } from '@launchdarkly/js-server-sdk-common';


This was copied from @launchdarkly/sdk-server-edge

mmrj · 2025-01-03T18:04:00Z

(docs ticket is at DOCS-973 and currently scheduled for week of 1/6)

ldhenry · 2025-01-03T18:02:27Z

packages/sdk/fastly/__tests__/createPlatformInfo.test.ts

+    const platformData = createPlatformInfo();
+
+    expect(platformData.platformData()).toEqual({
+      name: 'Fastly Edge',


I'm thinking about changing this to Fastly Compute based on Fastly's branding here. What do you think, @kinyoklion?

That works for me.

ldhenry · 2025-01-03T18:04:18Z

packages/sdk/fastly/package.json

+    "dist"
+  ],
+  "scripts": {
+    "build": "tsup && ../../../scripts/replace-version.sh .",


@kinyoklion, let me know if there is a better way to get the version in src.createPlatformInfo.ts

Yes, there is a better way.

"packages/sdk/cloudflare": { "extra-files": [ { "type": "json", "path": "jsr.json", "jsonpath": "$.version" }, { "type": "json", "path": "example/package.json", "jsonpath": "$.dependencies['@launchdarkly/cloudflare-server-sdk']" }, "src/createPlatformInfo.ts" ] },

Here we can see how to not use "workspace" in the example project (so customers can use it outside the repo), as well as update the createPlatformInfo file.

ldhenry · 2025-01-03T18:06:33Z

packages/sdk/fastly/src/api/EdgeFeatureStore.ts

@@ -0,0 +1,116 @@
+import type {


This was copied from @launchdarkly/sdk-server-edge

ldhenry · 2025-01-03T18:06:40Z

packages/sdk/fastly/src/api/LDClient.ts

@@ -0,0 +1,24 @@
+import { Info, internal, LDClientImpl, LDOptions } from '@launchdarkly/js-server-sdk-common';


This was copied from @launchdarkly/sdk-server-edge

ldhenry · 2025-01-03T18:07:05Z

packages/sdk/fastly/src/api/createCallbacks.ts

@@ -0,0 +1,9 @@
+const createCallbacks = () => ({


This is the new empty implementation to get around the lack of node:events

So I think we can make a task, not blocking this, which removes the dependency from the common package.

That would then allow for the eventually removal of most of the code for this package.

ldhenry · 2025-01-03T18:07:22Z

packages/sdk/fastly/src/api/createOptions.ts

@@ -0,0 +1,17 @@
+import { BasicLogger, LDOptions } from '@launchdarkly/js-server-sdk-common';


This was copied from @launchdarkly/sdk-server-edge

ldhenry · 2025-01-03T18:09:11Z

packages/sdk/fastly/src/index.ts

+    sdkKey,
+    createPlatformInfo(),
+    finalOptions,
+    eventsBackendName || DEFAULT_EVENTS_BACKEND_NAME,


I chose to pass eventsBackendName as a new parameter instead of changing the options type used by LDClient. Let me know if you think this is the wrong approach.

The LDClient implementation is your implementation, so it could take the fastly options without any modification to the base options. You would just need to move how you destructure it.

That said I am indifferent to it being its own parameter.

ldhenry · 2025-01-03T18:09:25Z

packages/sdk/fastly/src/platform/crypto/cryptoJSHasher.ts

@@ -0,0 +1,49 @@
+import CryptoJS from 'crypto-js';


Everything in this directory was copied from @launchdarkly/sdk-server-edge

Do we know if we need crypto-js, or does fastly compute have its own suitable alternatives?

ldhenry · 2025-01-03T18:11:18Z

packages/sdk/fastly/src/platform/requests.ts

+
+  fetch(url: string, options: Options = {}): Promise<Response> {
+    // @ts-ignore
+    return fetch(url, { ...options, backend: this.eventsBackend });


This is the main differentiator between the other edge SDKs. We are required to pass a fastly-specific backend parameter.

kinyoklion

I've not looked through everything yet, but I did do an initial pass with a few items. Sorry for the delay.

kinyoklion · 2025-01-15T17:13:33Z

.sdk_metadata.json

@@ -28,6 +28,15 @@
        "tag-prefix": "cloudflare-server-sdk-"
      }
    },
+    "Fastly": {


I am not sure about this key being capitalized.

kinyoklion · 2025-01-15T17:14:44Z

packages/sdk/fastly/__tests__/createPlatformInfo.test.ts

+    const platformData = createPlatformInfo();
+
+    expect(platformData.platformData()).toEqual({
+      name: 'Fastly Edge',


That works for me.

kinyoklion · 2025-01-15T17:17:13Z

packages/sdk/fastly/src/api/createCallbacks.ts

@@ -0,0 +1,9 @@
+const createCallbacks = () => ({


So I think we can make a task, not blocking this, which removes the dependency from the common package.

That would then allow for the eventually removal of most of the code for this package.

kinyoklion · 2025-01-15T17:19:53Z

packages/sdk/fastly/src/index.ts

+    sdkKey,
+    createPlatformInfo(),
+    finalOptions,
+    eventsBackendName || DEFAULT_EVENTS_BACKEND_NAME,


The LDClient implementation is your implementation, so it could take the fastly options without any modification to the base options. You would just need to move how you destructure it.

That said I am indifferent to it being its own parameter.

kinyoklion · 2025-01-15T17:24:03Z

packages/sdk/fastly/src/platform/crypto/cryptoJSHasher.ts

@@ -0,0 +1,49 @@
+import CryptoJS from 'crypto-js';


Do we know if we need crypto-js, or does fastly compute have its own suitable alternatives?

kinyoklion · 2025-01-15T17:27:36Z

packages/sdk/fastly/example/package.json

+  },
+  "dependencies": {
+    "@fastly/js-compute": "^3.28.0",
+    "@launchdarkly/fastly-server-sdk": "workspace:^"


We may want to consider using the version number here and having release-please update it. That makes it more like a real example.

"extra-files": [ { "type": "json", "path": "example/package.json", "jsonpath": "$.dependencies['@launchdarkly/cloudflare-server-sdk']" }, ... ]

For example then the user can copy it out of the repo and it should work. The yarn workspace will link it locally during development.

ldhenry · 2025-01-17T22:50:50Z

I've not looked through everything yet, but I did do an initial pass with a few items. Sorry for the delay.

No problem and I appreciate your feedback. I'll take another pass next week.

ldhenry added 3 commits December 13, 2024 15:51

Start on Fastly SDK

00ecc9a

polyfill node:events in fastly sdk instead of example

809e1cd

Add tests and cleanup

0914d82

ldhenry added 8 commits January 3, 2025 16:03

Fix test and revert change to sdk-server-edge

be7aa07

Add CI

40f05ab

Add crypto-js types

77485da

fix typedoc

aff265d

Add fastly to release-please

7d47d12

Prep for alpha release

cfddcdc

Merge main

6079a15

Prep for 0.0.1 release

f9b9561

ldhenry marked this pull request as ready for review January 3, 2025 17:58

ldhenry requested a review from a team as a code owner January 3, 2025 17:58

ldhenry requested a review from kinyoklion January 3, 2025 17:58

Update homepage url

7fd2d96

ldhenry commented Jan 3, 2025

View reviewed changes

kinyoklion requested changes Jan 15, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Add Fastly Edge SDK #723

feat: Add Fastly Edge SDK #723

ldhenry commented Jan 3, 2025 •

edited

Loading

github-actions bot commented Jan 3, 2025

github-actions bot commented Jan 3, 2025

github-actions bot commented Jan 3, 2025

ldhenry Jan 3, 2025

ldhenry Jan 3, 2025

mmrj commented Jan 3, 2025

ldhenry Jan 3, 2025

kinyoklion Jan 15, 2025

ldhenry Jan 3, 2025

kinyoklion Jan 17, 2025

ldhenry Jan 3, 2025

ldhenry Jan 3, 2025

ldhenry Jan 3, 2025

kinyoklion Jan 15, 2025

ldhenry Jan 3, 2025

ldhenry Jan 3, 2025

kinyoklion Jan 15, 2025

ldhenry Jan 3, 2025

kinyoklion Jan 15, 2025

ldhenry Jan 3, 2025

kinyoklion left a comment

kinyoklion Jan 15, 2025

kinyoklion Jan 15, 2025

kinyoklion Jan 15, 2025

kinyoklion Jan 15, 2025

kinyoklion Jan 15, 2025

kinyoklion Jan 15, 2025

kinyoklion Jan 15, 2025

ldhenry commented Jan 17, 2025

		@@ -0,0 +1,46 @@
		import { internal } from '@launchdarkly/js-server-sdk-common';

		@@ -0,0 +1,59 @@
		import { PlatformData, SdkData } from '@launchdarkly/js-server-sdk-common';

		@@ -0,0 +1,24 @@
		import { Info, internal, LDClientImpl, LDOptions } from '@launchdarkly/js-server-sdk-common';

		@@ -0,0 +1,17 @@
		import { BasicLogger, LDOptions } from '@launchdarkly/js-server-sdk-common';

feat: Add Fastly Edge SDK #723

Are you sure you want to change the base?

feat: Add Fastly Edge SDK #723

Conversation

ldhenry commented Jan 3, 2025 • edited Loading

github-actions bot commented Jan 3, 2025

github-actions bot commented Jan 3, 2025

github-actions bot commented Jan 3, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mmrj commented Jan 3, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kinyoklion left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ldhenry commented Jan 17, 2025

ldhenry commented Jan 3, 2025 •

edited

Loading