feat: Adding akamai SDK (#121)

dariushar · web-flow · commit bf37f3d8ac49 · 2023-05-24T17:18:39.000-05:00
Setting up the basic structure for the Akamai SDK.
- Created basic test
- Created basic init function that returns Hello World
- Modeled structure after the Cloudflare directory
diff --git a/.github/workflows/akamai.yml b/.github/workflows/akamai.yml
@@ -0,0 +1,24 @@
+name: sdk/akamai
+
+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:
+    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-sdk'
+          workspace_path: packages/sdk/akamai
diff --git a/.github/workflows/manual-publish-docs.yml b/.github/workflows/manual-publish-docs.yml
@@ -13,6 +13,7 @@ on:
           - packages/sdk/cloudflare
           - packages/sdk/server-node
           - packages/sdk/vercel
+          - packages/sdk/akamai
 name: Publish Documentation
 jobs:
   build-publish:
diff --git a/.github/workflows/manual-publish.yml b/.github/workflows/manual-publish.yml
@@ -14,6 +14,7 @@ on:
           - packages/sdk/cloudflare
           - packages/sdk/server-node
           - packages/sdk/vercel
+          - packages/sdk/akamai
       prerelease:
         description: 'Is this a prerelease. If so, then the latest tag will not be updated in npm.'
         type: boolean
diff --git a/.github/workflows/release-please.yml b/.github/workflows/release-please.yml
@@ -14,6 +14,7 @@ jobs:
       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'] }}
     steps:
       - uses: google-github-actions/release-please-action@v3
         id: release
@@ -141,3 +142,23 @@ jobs:
         with:
           workspace_path: packages/sdk/vercel
           aws_assume_role: ${{ vars.AWS_ROLE_ARN }}
+
+  release-akamai:
+    runs-on: ubuntu-latest
+    needs: ['release-please']
+    permissions:
+      id-token: write
+      contents: write
+    if: ${{ needs.release-please.outputs.package-akamai-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
+        uses: ./actions/full-release
+        with:
+          workspace_path: packages/sdk/akamai
+          aws_assume_role: ${{ vars.AWS_ROLE_ARN }}
diff --git a/README.md b/README.md
@@ -10,6 +10,7 @@ This includes shared libraries, used by SDKs and other tools, as well as SDKs.
 | [@launchdarkly/cloudflare-server-sdk](packages/sdk/cloudflare/README.md) | [![NPM][sdk-cloudflare-npm-badge]][sdk-cloudflare-npm-link]   | [Cloudflare][package-sdk-cloudflare-issues]      | [![Actions Status][sdk-cloudflare-ci-badge]][sdk-cloudflare-ci]   |
 | [@launchdarkly/node-server-sdk](packages/sdk/server-node/README.md)      | [![NPM][sdk-server-node-npm-badge]][sdk-server-node-npm-link] | [Node.js Server][package-sdk-server-node-issues] | [![Actions Status][sdk-server-node-ci-badge]][sdk-server-node-ci] |
 | [@launchdarkly/vercel-server-sdk](packages/sdk/vercel/README.md)         | [![NPM][sdk-vercel-npm-badge]][sdk-vercel-npm-link]           | [Vercel][package-sdk-vercel-issues]              | [![Actions Status][sdk-vercel-ci-badge]][sdk-vercel-ci]           |
+| [@launchdarkly/akamai-server-sdk](packages/sdk/akamai/README.md)         | [![NPM][sdk-akamai-npm-badge]][sdk-akamai-npm-link]           | [Akamai][package-sdk-akamai-issues]              | [![Actions Status][sdk-akamai-ci-badge]][sdk-akamai-ci]           |
 
 | Shared packages                                                                      | npm                                                                       | issues                                                      | tests                                                                           |
 | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------- | ----------------------------------------------------------- | ------------------------------------------------------------------------------- |
@@ -97,3 +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-server-sdk.svg?style=flat-square
+[sdk-akamai-npm-link]: https://www.npmjs.com/package/@launchdarkly/akamai-server-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-server-sdk.svg?style=flat-square
+[sdk-akamai-dt-badge]: https://img.shields.io/npm/dt/@launchdarkly/akamai-server-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+
diff --git a/package.json b/package.json
@@ -8,7 +8,9 @@
     "packages/sdk/cloudflare",
     "packages/sdk/cloudflare/example",
     "packages/sdk/vercel",
-    "packages/sdk/example-vercel"
+    "packages/sdk/example-vercel",
+    "packages/sdk/akamai",
+    "packages/sdk/example-akamai"
   ],
   "private": true,
   "scripts": {
diff --git a/packages/sdk/akamai/CHANGELOG.md b/packages/sdk/akamai/CHANGELOG.md
@@ -0,0 +1,3 @@
+# Changelog
+
+All notable changes to the LaunchDarkly SDK for Akamai Workers will be documented in this file. This project adheres to [Semantic Versioning](https://semver.org).
diff --git a/packages/sdk/akamai/LICENSE b/packages/sdk/akamai/LICENSE
@@ -0,0 +1,13 @@
+Copyright 2023 Catamorphic, Co.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
diff --git a/packages/sdk/akamai/README.md b/packages/sdk/akamai/README.md
@@ -0,0 +1,61 @@
+# LaunchDarkly Akamai SDK
+
+[![NPM][sdk-akamai-npm-badge]][sdk-akamai-npm-link]
+[![Actions Status][sdk-akamai-ci-badge]][sdk-akamai-ci]
+[![Documentation][sdk-akamai-ghp-badge]][sdk-akamai-ghp-link]
+[![NPM][sdk-akamai-dm-badge]][sdk-akamai-npm-link]
+[![NPM][sdk-akamai-dt-badge]][sdk-akamai-npm-link]
+
+The LaunchDarkly Akamai SDK is designed primarily for use in Akamai Edgeworkers. It follows the server-side LaunchDarkly model for multi-user contexts. It is not intended for use in desktop and embedded systems applications.
+
+For more information, see the [complete reference guide for this SDK](https://docs.launchdarkly.com/sdk/server-side/akamai).
+
+## Install
+
+```shell
+npm i @launchdarkly/akamai-server-sdk
+```
+
+Then turn on the Node.js compatibility flag in your `wrangler.toml`. This allows the SDK to use `node:events`:
+
+```toml
+compatibility_flags = [ "nodejs_compat" ]
+```
+
+## Quickstart
+
+
+See the full [example app](https://github.com/launchdarkly/js-core/tree/main/packages/sdk/akamai/example).
+
+## Developing this SDK
+
+```shell
+# at js-core repo root
+yarn && yarn build && cd packages/sdk/akamai
+
+# run tests
+yarn test
+```
+
+## 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](https://docs.launchdarkly.com/sdk) for a complete list.
+- Explore LaunchDarkly
+  - [launchdarkly.com](https://www.launchdarkly.com/ 'LaunchDarkly Main Website') for more information
+  - [docs.launchdarkly.com](https://docs.launchdarkly.com/ 'LaunchDarkly Documentation') for our documentation and SDK reference guides
+  - [apidocs.launchdarkly.com](https://apidocs.launchdarkly.com/ 'LaunchDarkly API Documentation') for our API documentation
+  - [blog.launchdarkly.com](https://blog.launchdarkly.com/ 'LaunchDarkly Blog Documentation') for the latest product updates
+
+[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-server-sdk.svg?style=flat-square
+[sdk-akamai-npm-link]: https://www.npmjs.com/package/@launchdarkly/akamai-server-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-server-sdk.svg?style=flat-square
+[sdk-akamai-dt-badge]: https://img.shields.io/npm/dt/@launchdarkly/akamai-server-sdk.svg?style=flat-square
diff --git a/packages/sdk/akamai/jest.config.json b/packages/sdk/akamai/jest.config.json
@@ -0,0 +1,9 @@
+{
+  "transform": { "^.+\\.ts?$": "ts-jest" },
+  "testMatch": ["**/*.test.ts?(x)"],
+  "testPathIgnorePatterns": ["node_modules", "example", "dist"],
+  "modulePathIgnorePatterns": ["dist"],
+  "testEnvironment": "node",
+  "moduleFileExtensions": ["ts", "tsx", "js", "jsx", "json", "node"],
+  "collectCoverageFrom": ["src/**/*.ts"]
+}
diff --git a/packages/sdk/akamai/package.json b/packages/sdk/akamai/package.json
@@ -0,0 +1,59 @@
+{
+  "name": "@launchdarkly/akamai-server-sdk",
+  "version": "0.0.1",
+  "description": "Akamai LaunchDarkly SDK",
+  "homepage": "https://github.com/launchdarkly/js-core/tree/main/packages/sdk/akamai",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/launchdarkly/js-core.git"
+  },
+  "license": "Apache-2.0",
+  "packageManager": "yarn@3.4.1",
+  "keywords": [
+    "launchdarkly",
+    "akamai",
+    "edge",
+    "worker"
+  ],
+  "type": "module",
+  "exports": {
+    "require": "./dist/cjs/src/index.js",
+    "import": "./dist/esm/src/index.js"
+  },
+  "main": "./dist/cjs/src/index.js",
+  "types": "./dist/cjs/src/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "doc": "../../../scripts/build-doc.sh .",
+    "build": "../../../scripts/build-package.sh",
+    "clean": "rimraf dist",
+    "tsw": "yarn tsc --watch",
+    "start": "rimraf dist && yarn tsw",
+    "lint": "eslint . --ext .ts",
+    "prettier": "prettier --write '**/*.@(js|ts|tsx|json|css)' --ignore-path ../../../.prettierignore",
+    "test": "NODE_OPTIONS=\"--experimental-vm-modules --no-warnings\" jest --ci --runInBand",
+    "coverage": "yarn test --coverage",
+    "check": "yarn prettier && yarn lint && yarn build && yarn test && yarn doc"
+  },
+  "dependencies": {},
+  "devDependencies": {
+    "@types/jest": "^29.5.1",
+    "@typescript-eslint/eslint-plugin": "^5.57.0",
+    "@typescript-eslint/parser": "^5.57.0",
+    "eslint": "^8.37.0",
+    "eslint-config-airbnb-base": "^15.0.0",
+    "eslint-config-airbnb-typescript": "^17.0.0",
+    "eslint-config-prettier": "^8.8.0",
+    "eslint-plugin-import": "^2.27.5",
+    "eslint-plugin-prettier": "^4.2.1",
+    "jest": "^29.5.0",
+    "launchdarkly-js-test-helpers": "^2.2.0",
+    "prettier": "^2.8.7",
+    "rimraf": "^5.0.0",
+    "ts-jest": "^29.1.0",
+    "typedoc": "0.24.7",
+    "typescript": "^5.0.4"
+  }
+}
diff --git a/packages/sdk/akamai/src/index.test.ts b/packages/sdk/akamai/src/index.test.ts
@@ -0,0 +1,8 @@
+import init from './index';
+
+describe('init', () => {
+  test('hello world', async () => {
+    const response = init();
+    expect(response).toEqual('Hello World');
+  });
+});
diff --git a/packages/sdk/akamai/src/index.ts b/packages/sdk/akamai/src/index.ts
@@ -0,0 +1,14 @@
+/**
+ * This is the API reference for the Akamai LaunchDarkly SDK.
+ *
+ * In typical usage, you will call {@link init} once at startup time to obtain an instance of
+ * {@link LDClient}, which provides access to all of the SDK's functionality.
+ *
+ * For more information, see the SDK reference guide.
+ *
+ * @packageDocumentation
+ */
+
+const init = () => 'Hello World';
+
+export default init;
diff --git a/packages/sdk/akamai/tsconfig.eslint.json b/packages/sdk/akamai/tsconfig.eslint.json
@@ -0,0 +1,5 @@
+{
+  "extends": "./tsconfig.json",
+  "include": ["/**/*.ts"],
+  "exclude": ["node_modules"]
+}
diff --git a/packages/sdk/akamai/tsconfig.json b/packages/sdk/akamai/tsconfig.json
@@ -0,0 +1,22 @@
+{
+  "compilerOptions": {
+    // Uses "." so it can load package.json.
+    "rootDir": ".",
+    "outDir": "dist",
+    "target": "es6",
+    "lib": ["es6"],
+    "module": "commonjs",
+    "strict": true,
+    "noImplicitOverride": true,
+    "allowSyntheticDefaultImports": true,
+    "sourceMap": true,
+    "declaration": true,
+    "declarationMap": true, // enables importers to jump to source
+    "resolveJsonModule": true,
+    "stripInternal": true,
+    "moduleResolution": "node",
+    "types": ["jest", "node"],
+    "skipLibCheck": true
+  },
+  "exclude": ["**/*.test.ts", "dist", "node_modules", "__tests__", "example"]
+}
diff --git a/packages/sdk/akamai/tsconfig.ref.json b/packages/sdk/akamai/tsconfig.ref.json
@@ -0,0 +1,7 @@
+{
+  "extends": "./tsconfig.json",
+  "include": ["src/**/*", "package.json", "src/**/testData.json"],
+  "compilerOptions": {
+    "composite": true
+  }
+}
diff --git a/tsconfig.json b/tsconfig.json
@@ -21,6 +21,9 @@
     },
     {
       "path": "./packages/sdk/vercel/tsconfig.ref.json"
+    },
+    {
+      "path": "./packages/sdk/akamai/tsconfig.ref.json"
     }
   ]
 }

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# Changelog`
	`2`	`+`
	`3`	`+All notable changes to the LaunchDarkly SDK for Akamai Workers will be documented in this file. This project adheres to [Semantic Versioning](https://semver.org).`