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 the eventsUri option to allow for sending events to a custom endpoint.
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: 19871 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: 15371 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)

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

packages/sdk/fastly/package.json

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 mostly copied from @launchdarkly/sdk-server-edge

packages/sdk/fastly/src/index.ts

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?

It seems like they have explicitly tested crypto-js as noted here. With that being said, I'll do a test to see if we can get away without it.

I did some digging and it looks like Fastly exposes SimpleCrypto. I started to implement our Hasher with this but hit a roadblock because SimpleCrypto's digest function returns a promise.

I'll stick with crypto-js for now unless you are aware of a workaround.

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.

.sdk_metadata.json

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

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.

packages/sdk/fastly/src/index.ts

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?

packages/sdk/fastly/example/package.json

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 · 2025-02-10T15:11:26Z

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

+    const client = new LDClient('client-side-id', createBasicPlatform().info, {
+      sendEvents: true,
+      eventsBackendName: 'launchdarkly',
+      eventsUri: 'https://custom-base-uri.launchdarkly.com',


I added the option to set a custom eventsUri. baseUri doesn't really make sense for these integrations so I also added logic to set baseUri to eventsUri if eventsUri is specified in order to pass the validation in sdk-server-common.

ldhenry · 2025-02-10T15:24:50Z

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

+
+export const defaultOptions: LDOptions = {
+  stream: false,
+  sendEvents: true,


Unlike our other Edge SDKs, this will send events by default.

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

ldhenry added 6 commits February 10, 2025 10:45

merge main

ce436a2

Add jsr.json and pin version in example

3717d13

Change name in platformInfo

e96311c

lowercase in .sdk_metadata

9c7c966

Add eslint config

91819c9

Add remaining eslint configs

584eef5

ldhenry added 9 commits February 10, 2025 11:24

Add more eslint helpers

08cb672

Add @trivago/prettier-plugin-sort-imports

53891b1

Downgrade @typescript-eslint version

1fb5431

Add ts-jest

9c6d3dd

Add @types/jest

ed6764e

Bump dependencies

4282427

Bump example version

a422de4

Clean up LDClient implementation and add eventsUri option

6271e7c

Bump @fastly/cli

dff0e69

ldhenry commented Feb 10, 2025

View reviewed changes

ldhenry added 2 commits February 10, 2025 15:17

Use release-please to set version

7c1bc03

Fix test

2eef68d

ldhenry commented Feb 10, 2025

View reviewed changes

ldhenry added 2 commits February 10, 2025 15:28

Remove the need for ts-ignore

b41b07b

Add newline to tsconfig.json

dda0ce5

ldhenry requested a review from kinyoklion February 10, 2025 15:34

ldhenry added 4 commits February 19, 2025 11:18

Swap photos with PD versions

389c52e

Reformat photo credits

a73b761

merge main

0111854

Add link to free Fastly account

3a67b2b

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 •

edited

Loading

github-actions bot commented Jan 3, 2025 •

edited

Loading

ldhenry Jan 3, 2025

ldhenry Jan 3, 2025

mmrj commented Jan 3, 2025

ldhenry Jan 3, 2025

ldhenry Jan 3, 2025

ldhenry Jan 3, 2025

kinyoklion Jan 15, 2025

ldhenry Jan 3, 2025 •

edited

Loading

ldhenry Jan 3, 2025

kinyoklion Jan 15, 2025

ldhenry Feb 10, 2025

ldhenry Feb 10, 2025

ldhenry Jan 3, 2025

kinyoklion left a comment

kinyoklion Jan 15, 2025

kinyoklion Jan 15, 2025

ldhenry commented Jan 17, 2025

ldhenry Feb 10, 2025

ldhenry Feb 10, 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 • edited Loading

github-actions bot commented Jan 3, 2025 • edited Loading

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

ldhenry Jan 3, 2025 • edited Loading

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

ldhenry commented Jan 17, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ldhenry commented Jan 3, 2025 •

edited

Loading

github-actions bot commented Jan 3, 2025 •

edited

Loading

github-actions bot commented Jan 3, 2025 •

edited

Loading

ldhenry Jan 3, 2025 •

edited

Loading