build: Add CI configuration. Rename 'node' to 'server-node'.

.eslintrc.js

@@ -2,18 +2,14 @@ module.exports = {
   env: {
     node: true,
   },
-  extends: [
-    'airbnb-base',
-    'airbnb-typescript/base'
-  ],
+  extends: ['airbnb-base', 'airbnb-typescript/base', 'prettier'],
   parser: '@typescript-eslint/parser',
   parserOptions: {
-    project: './tsconfig.eslint.json'
+    project: './tsconfig.eslint.json',
   },
-  plugins: [
-    '@typescript-eslint',
-  ],
-  ignorePatterns: ["**/dist/**"],
+  plugins: ['@typescript-eslint', 'prettier'],
+  ignorePatterns: ['**/dist/**'],
   rules: {
+    'prettier/prettier': ['error'],
   },
 };

.github/workflows/common.yml

@@ -0,0 +1,27 @@
+name: shared/common
+
+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-common:
+    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/js-sdk-common'
+          workspace_path: packages/shared/common

.github/workflows/lint-pr-title.yml

@@ -0,0 +1,17 @@
+name: Lint PR title
+
+on:
+  pull_request_target:
+    types:
+      - opened
+      - edited
+      - synchronize
+
+jobs:
+  main:
+    name: Verify the PR title matches conventional commit spec.
+    runs-on: ubuntu-latest
+    steps:
+      - uses: amannn/action-semantic-pull-request@v5
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/sdk-server.yml

@@ -0,0 +1,27 @@
+name: shared/sdk-server
+
+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-sdk-server:
+    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/js-server-sdk-common'
+          workspace_path: packages/shared/sdk-server

.github/workflows/server-node.yml

@@ -0,0 +1,38 @@
+name: sdk/server-node
+
+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-server-node:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        # Node versions to run on.
+        version: [16, 19]
+
+    env:
+      TEST_HARNESS_PARAMS: '--skip-from=./contract-tests/testharness-suppressions.txt'
+
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.version }}
+          registry-url: 'https://registry.npmjs.org'
+      - id: shared
+        name: Shared CI Steps
+        uses: ./actions/ci
+        with:
+          workspace_name: '@launchdarkly/node-server-sdk'
+          workspace_path: packages/sdk/server-node
+      - name: Contract Tests
+        run: yarn run contract-tests

.gitignore

@@ -4,6 +4,15 @@ dist/
 node_modules/
 **/*.tsbuildinfo
 coverage/
-tmp/
-**/docs
+**/tmp_test/
+docs/
+.pnp.*
+.yarn/*
+.dev*
+.vscode/launch.json
+.idea
+!.yarn/plugins
+!.yarn/releases
+!.yarn/sdks
+!.yarn/versions
 yarn-error.log

.prettierrc

@@ -0,0 +1,4 @@
+{
+  "singleQuote": true,
+  "printWidth": 100
+}

.yarnrc.yml

@@ -0,0 +1,7 @@
+nodeLinker: node-modules
+
+plugins:
+  - path: .yarn/plugins/@yarnpkg/plugin-workspace-tools.cjs
+    spec: '@yarnpkg/plugin-workspace-tools'
+
+yarnPath: .yarn/releases/yarn-3.4.1.cjs

README.md

@@ -5,14 +5,14 @@ This includes shared libraries, used by SDKs and other tools, as well as SDKs.
 
 ## Packages
 
-| SDK Packages                                                               | npm                          | issues                           | tests                          
-| ---------------------------------------------------------------------------| -----------------------------| -------------------------------- | -------------------------------
-| [@launchdarkly/node-server-sdk](packages/sdk/node/README.md)               | [![NPM Package][TODO]][TODO] | [![Client Issues][TODO]][TODO]   | [![Actions Status][TODO]][TODO]
+| SDK Packages                                                 | npm                          | issues                         | tests                                                                   |
+| ------------------------------------------------------------ | ---------------------------- | ------------------------------ | ----------------------------------------------------------------------- |
+| [@launchdarkly/node-server-sdk](packages/sdk/node/README.md) | [![NPM Package][TODO]][TODO] | [![Client Issues][TODO]][TODO] | [![Actions Status][sdk-server-node-ci-badge]][sdk-server-node-ci-badge] |
 
-| Shared Packages                                                            | npm                          | issues                           | tests                          
-| ---------------------------------------------------------------------------| -----------------------------| -------------------------------- | -------------------------------
-| [@launchdarkly/js-sdk-common](packages/shared/common/README.md)            | [![NPM Package][TODO]][TODO] | [![Common][TODO]][TODO]          | [![Actions Status][TODO]][TODO]
-| [@launchdarkly/js-server-sdk-common](packages/shared/sdk-server/README.md) | [![NPM Package][TODO]][TODO] | [![Common Server][TODO]][TODO]   | [![Actions Status][TODO]][TODO]
+| Shared Packages                                                            | npm                          | issues                         | tests                                                                 |
+| -------------------------------------------------------------------------- | ---------------------------- | ------------------------------ | --------------------------------------------------------------------- |
+| [@launchdarkly/js-sdk-common](packages/shared/common/README.md)            | [![NPM Package][TODO]][TODO] | [![Common][TODO]][TODO]        | [![Actions Status][shared-common-ci-badge]][shared-common-ci]         |
+| [@launchdarkly/js-server-sdk-common](packages/shared/sdk-server/README.md) | [![NPM Package][TODO]][TODO] | [![Common Server][TODO]][TODO] | [![Actions Status][shared-sdk-server-ci-badge]][shared-sdk-server-ci] |
 
 ## Organization
 
@@ -38,14 +38,21 @@ We encourage pull requests and other contributions from the community. Check out
 
 ## 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. Check out [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
+- 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. Check out [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
+
+[shared-common-ci-badge]: https://github.com/launchdarkly/js-core/actions/workflows/common.yml/badge.svg
+[shared-common-ci]: https://github.com/launchdarkly/js-core/actions/workflows/common.yml
+[shared-sdk-server-ci-badge]: https://github.com/launchdarkly/js-core/actions/workflows/sdk-server.yml/badge.svg
+[shared-sdk-server-ci]: https://github.com/launchdarkly/js-core/actions/workflows/sdk-server.yml
+[sdk-server-node-ci-badge]: https://github.com/launchdarkly/js-core/actions/workflows/server-node.yml/badge.svg
+[sdk-server-node-ci]: https://github.com/launchdarkly/js-core/actions/workflows/server-node.yml

actions/ci/action.yml

@@ -0,0 +1,43 @@
+# This is a composite to allow sharing these steps into other workflows.
+# It isn't a shared workflow, because then it isn't convenient to add
+# additional package specific steps.
+name: Shared CI Workflow
+inputs:
+  # Some commands work on the package name (yarn commands), other require the path (typedoc),
+  # so we supply both.
+  workspace_name:
+    required: true
+    type: string
+  workspace_path:
+    required: true
+    type: string
+
+runs:
+  using: composite
+  steps:
+    - name: Setup Yarn
+      shell: bash
+      run: yarn set version 3.4.1
+
+    - name: Install Dependencies
+      shell: bash
+      # Install only the dependencies requires for the specific workspace.
+      run: yarn workspaces focus ${{ inputs.workspace_name }}
+
+    - name: Build
+      shell: bash
+      # This will build the package and its dependencies.
+      run: yarn workspaces foreach -ptR --from '${{ inputs.workspace_name }}' run build
+
+    - name: Lint
+      shell: bash
+      run: yarn workspace ${{ inputs.workspace_name }} lint
+
+    - name: Test
+      shell: bash
+      # Run just the tests for the targeted package.
+      run: yarn workspace ${{ inputs.workspace_name }} test
+
+    - name: Build Docs
+      shell: bash
+      run: ./scripts/build-doc.sh ${{ inputs.workspace_path }}

contract-tests/log.js

@@ -5,15 +5,15 @@ function Log(tag) {
     console.log(new Date().toISOString() + ` [${tag}] ${level}: ${message}`);
   }
   return {
-    info: message => doLog('info', message),
-    error: message => doLog('error', message),
+    info: (message) => doLog('info', message),
+    error: (message) => doLog('error', message),
   };
 }
 
 function sdkLogger(tag) {
   return ld.basicLogger({
     level: 'debug',
-    destination: line => {
+    destination: (line) => {
       console.log(new Date().toISOString() + ` [${tag}.sdk] ${line}`);
     },
   });

contract-tests/package.json

@@ -10,6 +10,6 @@
   "dependencies": {
     "body-parser": "^1.19.0",
     "express": "^4.17.1",
-    "node-server-sdk": "file:../packages/sdk/node"
+    "node-server-sdk": "file:../packages/sdk/server-node"
   }
 }

contract-tests/sdkClientEntity.js

@@ -8,12 +8,13 @@ function makeSdkConfig(options, tag) {
   const cf = {
     logger: sdkLogger(tag),
   };
-  const maybeTime = seconds => (seconds === undefined || seconds === null ? undefined : seconds / 1000);
+  const maybeTime = (seconds) =>
+    seconds === undefined || seconds === null ? undefined : seconds / 1000;
   if (options.streaming) {
     cf.streamUri = options.streaming.baseUri;
     cf.streamInitialReconnectDelay = maybeTime(options.streaming.initialRetryDelayMs);
   }
-  if(options.polling) {
+  if (options.polling) {
     cf.stream = false;
     cf.baseUri = options.polling.baseUri;
     cf.pollInterface = options.polling.pollIntervalMs / 1000;
@@ -41,15 +42,19 @@ async function newSdkClientEntity(options) {
 
   log.info('Creating client with configuration: ' + JSON.stringify(options.configuration));
   const timeout =
-    options.configuration.startWaitTimeMs !== null && options.configuration.startWaitTimeMs !== undefined
+    options.configuration.startWaitTimeMs !== null &&
+    options.configuration.startWaitTimeMs !== undefined
       ? options.configuration.startWaitTimeMs
       : 5000;
   const client = ld.init(
     options.configuration.credential || 'unknown-sdk-key',
     makeSdkConfig(options.configuration, options.tag)
   );
   try {
-    await Promise.race([client.waitForInitialization(), new Promise(resolve => setTimeout(resolve, timeout))]);
+    await Promise.race([
+      client.waitForInitialization(),
+      new Promise((resolve) => setTimeout(resolve, timeout)),
+    ]);
   } catch (_) {
     // if waitForInitialization() rejects, the client failed to initialize, see next line
   }
@@ -63,7 +68,7 @@ async function newSdkClientEntity(options) {
     log.info('Test ended');
   };
 
-  c.doCommand = async params => {
+  c.doCommand = async (params) => {
     log.info('Received command: ' + params.command);
     switch (params.command) {
       case 'evaluate': {

jest.config.js

@@ -1,11 +1,11 @@
 module.exports = {
-  transform: {'^.+\\.ts?$': 'ts-jest'},
-  testMatch: ["**/__tests__/**/*test.ts?(x)"],
+  transform: { '^.+\\.ts?$': 'ts-jest' },
+  testMatch: ['**/__tests__/**/*test.ts?(x)'],
   testEnvironment: 'node',
   moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx', 'json', 'node'],
   collectCoverageFrom: [
-    "packages/sdk/node/src/**/*.ts",
-    "packages/shared/common/src/**/*.ts",
-    "packages/shared/sdk-server/src/**/*.ts"
-  ]
+    'packages/sdk/server-node/src/**/*.ts',
+    'packages/shared/common/src/**/*.ts',
+    'packages/shared/sdk-server/src/**/*.ts',
+  ],
 };

package.json

@@ -3,7 +3,7 @@
   "workspaces": [
     "packages/shared/common",
     "packages/shared/sdk-server",
-    "packages/sdk/node"
+    "packages/sdk/server-node"
   ],
   "private": true,
   "scripts": {
@@ -13,19 +13,25 @@
     "build:doc": "./scripts/build-doc.sh $1",
     "lint": "npx eslint . --ext .ts",
     "lint:fix": "yarn run lint -- --fix",
-    "test": "jest",
+    "test": "npx jest",
     "coverage": "npm run test -- --coverage",
     "contract-test-service": "npm --prefix contract-tests install && npm --prefix contract-tests start",
     "contract-test-harness": "curl -s https://raw.githubusercontent.com/launchdarkly/sdk-test-harness/master/downloader/run.sh \\ | VERSION=v2 PARAMS=\"-url http://localhost:8000 -debug -stop-service-at-end $TEST_HARNESS_PARAMS\" sh",
-    "contract-tests": "npm run contract-test-service & npm run contract-test-harness"
+    "contract-tests": "npm run contract-test-service & npm run contract-test-harness",
+    "prettier": "npx prettier --write \"**/*.{js,ts,tsx,json,yaml,yml,md}\" --loglevel warn"
   },
   "devDependencies": {
     "@typescript-eslint/eslint-plugin": "^5.22.0",
     "@typescript-eslint/parser": "^5.22.0",
     "eslint": "^8.14.0",
     "eslint-config-airbnb-base": "^15.0.0",
     "eslint-config-airbnb-typescript": "^17.0.0",
+    "eslint-config-prettier": "^8.7.0",
     "eslint-plugin-import": "^2.26.0",
-    "typedoc": "0.23.26"
-  }
+    "eslint-plugin-prettier": "^4.2.1",
+    "prettier": "^2.8.4",
+    "typedoc": "0.23.26",
+    "typescript": "^4.6.3"
+  },
+  "packageManager": "yarn@3.4.1"
 }