feat: Akamai SDK example, rollup config, edgeKV logic (#128)

This PR includes the changes for releasing the initial version of the
SDK (alpha version).

We have decided to create two different SDKs. One for using the EdgeKV
feature store and one allowing the user send a specific feature store
they would like to use. We're doing this because Akamai is expecting a
file called `edgekv_token.js` but that file won't exists if the user
decides to specify their feature store. To avoid trying to dynamically
load the `edgekv_token.js` file, we have decided to split the SDK into
two different packages.

Akamai Updates:
- Added logic for retrieving flag data from EdgeKV
- Added tests for the Akamai classes
- Added rollup
- Added example

Author: dariushar

.github/workflows/akamai.yml renamed to .github/workflows/akamai-base.yml

@@ -1,4 +1,4 @@
-name: sdk/akamai
+name: sdk/akamai-base
 
 on:
   push:
@@ -20,5 +20,5 @@ jobs:
         name: Shared CI Steps
         uses: ./actions/ci
         with:
-          workspace_name: '@launchdarkly/akamai-edgeworker-sdk'
-          workspace_path: packages/sdk/akamai
+          workspace_name: '@launchdarkly/akamai-server-base-sdk'
+          workspace_path: packages/sdk/akamai-base

.github/workflows/akamai-edgekv.yml

@@ -0,0 +1,24 @@
+name: sdk/akamai-edgekv
+
+on:
+  push:
+    branches: [main]
+    paths-ignore:
+      - '**.md' #Do not need to run CI for markdown changes.
+  pull_request:
+    branches: [main]
+    paths-ignore:
+      - '**.md'
+
+jobs:
+  build-test-akamai-edgekv:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+      - id: shared
+        name: Shared CI Steps
+        uses: ./actions/ci
+        with:
+          workspace_name: '@launchdarkly/akamai-server-edgekv-sdk'
+          workspace_path: packages/sdk/akamai-edgekv

.github/workflows/akamai-edgeworker-sdk.yml

@@ -0,0 +1,27 @@
+name: shared/akamai-edgeworker-sdk
+
+on:
+  push:
+    branches: [main]
+    paths-ignore:
+      - '**.md' #Do not need to run CI for markdown changes.
+  pull_request:
+    branches: [main]
+    paths-ignore:
+      - '**.md'
+
+jobs:
+  build-test-akamai-edgeworker-sdk:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 16
+          registry-url: 'https://registry.npmjs.org'
+      - id: shared
+        name: Shared CI Steps
+        uses: ./actions/ci
+        with:
+          workspace_name: '@launchdarkly/akamai-edgeworker-sdk-common'
+          workspace_path: packages/shared/akamai-edgeworker-sdk

.github/workflows/manual-publish-docs.yml

@@ -10,10 +10,12 @@ on:
           - packages/shared/common
           - packages/shared/sdk-server
           - packages/shared/sdk-server-edge
+          - packages/shared/akamai-edgeworker-sdk
           - packages/sdk/cloudflare
           - packages/sdk/server-node
           - packages/sdk/vercel
-          - packages/sdk/akamai
+          - packages/sdk/akamai-base
+          - packages/sdk/akamai-edgekv
 name: Publish Documentation
 jobs:
   build-publish:

.github/workflows/manual-publish.yml

@@ -11,10 +11,12 @@ on:
           - packages/shared/common
           - packages/shared/sdk-server
           - packages/shared/sdk-server-edge
+          - packages/shared/akamai-edgeworker-sdk
           - packages/sdk/cloudflare
           - packages/sdk/server-node
           - packages/sdk/vercel
-          - packages/sdk/akamai
+          - packages/sdk/akamai-base
+          - packages/sdk/akamai-edgekv
       prerelease:
         description: 'Is this a prerelease. If so, then the latest tag will not be updated in npm.'
         type: boolean

.github/workflows/release-please.yml

@@ -11,10 +11,12 @@ jobs:
       package-common-released: ${{ steps.release.outputs['packages/shared/common--release_created'] }}
       package-sdk-server-released: ${{ steps.release.outputs['packages/shared/sdk-server--release_created'] }}
       package-sdk-server-edge-released: ${{ steps.release.outputs['packages/shared/sdk-server-edge--release_created'] }}
+      package-akamai-edgeworker-sdk-released: ${{ steps.release.outputs['packages/shared/akamai-edgeworker-sdk--release_created'] }}
       package-cloudflare-released: ${{ steps.release.outputs['packages/sdk/cloudflare--release_created'] }}
       package-server-node-released: ${{ steps.release.outputs['packages/sdk/server-node--release_created'] }}
       package-vercel-released: ${{ steps.release.outputs['packages/sdk/vercel--release_created'] }}
-      package-akamai-released: ${{ steps.release.outputs['packages/sdk/akamai--release_created'] }}
+      package-akamai-base-released: ${{ steps.release.outputs['packages/sdk/akamai-base--release_created'] }}
+      package-akamai-edgekv-released: ${{ steps.release.outputs['packages/sdk/akamai-edgekv--release_created'] }}
     steps:
       - uses: google-github-actions/release-please-action@v3
         id: release
@@ -83,6 +85,26 @@ jobs:
           workspace_path: packages/shared/sdk-server-edge
           aws_assume_role: ${{ vars.AWS_ROLE_ARN }}
 
+  release-akamai-edgeworker-sdk:
+    runs-on: ubuntu-latest
+    needs: ['release-please']
+    permissions:
+      id-token: write
+      contents: write
+    if: ${{ needs.release-please.outputs.package-akamai-edgeworker-sdk-released }}
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 16.x
+          registry-url: 'https://registry.npmjs.org'
+      - id: release-common
+        name: Full release of packages/shared/akamai-edgeworker-sdk
+        uses: ./actions/full-release
+        with:
+          workspace_path: packages/shared/akamai-edgeworker-sdk
+          aws_assume_role: ${{ vars.AWS_ROLE_ARN }}
+
   release-cloudflare:
     runs-on: ubuntu-latest
     needs: ['release-please']
@@ -122,7 +144,7 @@ jobs:
         with:
           workspace_path: packages/sdk/server-node
           aws_assume_role: ${{ vars.AWS_ROLE_ARN }}
-    
+
   release-vercel:
     runs-on: ubuntu-latest
     needs: ['release-please']
@@ -143,22 +165,42 @@ jobs:
           workspace_path: packages/sdk/vercel
           aws_assume_role: ${{ vars.AWS_ROLE_ARN }}
 
-  release-akamai:
+  release-akamai-base:
+    runs-on: ubuntu-latest
+    needs: ['release-please']
+    permissions:
+      id-token: write
+      contents: write
+    if: ${{ needs.release-please.outputs.package-akamai-base-released }}
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 16.x
+          registry-url: 'https://registry.npmjs.org'
+      - id: release-common
+        name: Full release of packages/sdk/akamai-base
+        uses: ./actions/full-release
+        with:
+          workspace_path: packages/sdk/akamai-base
+          aws_assume_role: ${{ vars.AWS_ROLE_ARN }}
+
+  release-akamai-edgekv:
     runs-on: ubuntu-latest
     needs: ['release-please']
     permissions:
       id-token: write
       contents: write
-    if: ${{ needs.release-please.outputs.package-akamai-released }}
+    if: ${{ needs.release-please.outputs.package-akamai-edgekv-released }}
     steps:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
         with:
           node-version: 16.x
           registry-url: 'https://registry.npmjs.org'
       - id: release-common
-        name: Full release of packages/sdk/akamai
+        name: Full release of packages/sdk/akamai-edgekv
         uses: ./actions/full-release
         with:
-          workspace_path: packages/sdk/akamai
+          workspace_path: packages/sdk/akamai-edgekv
           aws_assume_role: ${{ vars.AWS_ROLE_ARN }}

README.md

@@ -98,13 +98,13 @@ We encourage pull requests and other contributions from the community. Check out
 [sdk-vercel-dm-badge]: https://img.shields.io/npm/dm/@launchdarkly/vercel-server-sdk.svg?style=flat-square
 [sdk-vercel-dt-badge]: https://img.shields.io/npm/dt/@launchdarkly/vercel-server-sdk.svg?style=flat-square
 [package-sdk-vercel-issues]: https://github.com/launchdarkly/js-core/issues?q=is%3Aissue+is%3Aopen+label%3A%22package%3A+sdk%2Fvercel%22+
-[//]: # 'sdk/akamai'
-[sdk-akamai-ci-badge]: https://github.com/launchdarkly/js-core/actions/workflows/akamai.yml/badge.svg
-[sdk-akamai-ci]: https://github.com/launchdarkly/js-core/actions/workflows/akamai.yml
-[sdk-akamai-npm-badge]: https://img.shields.io/npm/v/@launchdarkly/akamai-edgeworker-sdk.svg?style=flat-square
-[sdk-akamai-npm-link]: https://www.npmjs.com/package/@launchdarkly/akamai-edgeworker-sdk
+[//]: # 'sdk/akamai-base'
+[sdk-akamai-ci-badge]: https://github.com/launchdarkly/js-core/actions/workflows/akamai-base.yml/badge.svg
+[sdk-akamai-ci]: https://github.com/launchdarkly/js-core/actions/workflows/akamai-base.yml
+[sdk-akamai-npm-badge]: https://img.shields.io/npm/v/@launchdarkly/akamai-server-base-sdk.svg?style=flat-square
+[sdk-akamai-npm-link]: https://www.npmjs.com/package/@launchdarkly/akamai-server-base-sdk
 [sdk-akamai-ghp-badge]: https://img.shields.io/static/v1?label=GitHub+Pages&message=API+reference&color=00add8
 [sdk-akamai-ghp-link]: https://launchdarkly.github.io/js-core/packages/sdk/akamai/docs/
-[sdk-akamai-dm-badge]: https://img.shields.io/npm/dm/@launchdarkly/akamai-edgeworker-sdk.svg?style=flat-square
-[sdk-akamai-dt-badge]: https://img.shields.io/npm/dt/@launchdarkly/akamai-edgeworker-sdk.svg?style=flat-square
-[package-sdk-akamai-issues]: https://github.com/launchdarkly/js-core/issues?q=is%3Aissue+is%3Aopen+label%3A%22package%3A+sdk%2Fakamai%22+
+[sdk-akamai-dm-badge]: https://img.shields.io/npm/dm/@launchdarkly/akamai-server-base-sdk.svg?style=flat-square
+[sdk-akamai-dt-badge]: https://img.shields.io/npm/dt/@launchdarkly/akamai-server-base-sdk.svg?style=flat-square
+[package-sdk-akamai-issues]: https://github.com/launchdarkly/js-core/issues?q=is%3Aissue+is%3Aopen+label%3A%22package%3A+sdk%2Fakamai-base%22+

package.json

@@ -4,11 +4,15 @@
     "packages/shared/common",
     "packages/shared/sdk-server",
     "packages/shared/sdk-server-edge",
+    "packages/shared/akamai-edgeworker-sdk",
     "packages/sdk/server-node",
     "packages/sdk/cloudflare",
     "packages/sdk/cloudflare/example",
     "packages/sdk/vercel",
-    "packages/sdk/akamai"
+    "packages/sdk/akamai-base",
+    "packages/sdk/akamai-base/example",
+    "packages/sdk/akamai-edgekv",
+    "packages/sdk/akamai-edgekv/example"
   ],
   "private": true,
   "scripts": {