launchdarkly-js-sdk-common 3.4.0-alpha.2 → 4.0.1

package/.circleci/config.yml

@@ -0,0 +1,22 @@
+version: 2
+jobs:
+  build:
+    docker:
+      - image: cimg/node:12.22
+    steps:
+      - checkout
+
+      - run: npm install
+      - run: npm run lint:all
+      - run:
+          command: npm test
+          environment:
+            JEST_JUNIT_OUTPUT: "reports/junit/js-test-results.xml"
+      - run: npm run check-typescript
+      - run:
+          name: dependency audit
+          command: ./scripts/better-audit.sh
+      - store_test_results:
+          path: reports/junit/
+      - store_artifacts:
+          path: reports/junit/

package/.eslintignore

@@ -0,0 +1,4 @@
+node_modules/
+coverage/
+dist/
+eventsource.js

package/.eslintrc.yaml

@@ -0,0 +1,104 @@
+---
+parser: babel-eslint
+root: true
+extends:
+  - prettier
+  - eslint:recommended # https://eslint.org/docs/rules/
+env:
+  es6: true
+  node: true
+plugins:
+  - babel
+  - prettier
+globals:
+  VERSION: true
+  describe: true
+  it: true
+  expect: true
+  jest: true
+  beforeAll: true
+  afterAll: true
+  beforeEach: true
+  afterEach: true
+  window: false # platform-agnostic code should *not* reference "window" or "document"
+  document: false
+rules:
+  # https://eslint.org/docs/rules/array-callback-return
+  array-callback-return: error
+
+  # https://eslint.org/docs/rules/arrow-body-style
+  arrow-body-style:
+    - error
+    - as-needed
+
+  # https://github.com/babel/eslint-plugin-babel
+  babel/semi: error
+
+  # Deprecations are required to turn enforce this
+  camelcase: warn
+
+  # https://eslint.org/docs/rules/curly
+  curly:
+    - error
+    - all
+
+  # https://eslint.org/docs/rules/eqeqeq
+  eqeqeq: error
+
+  # https://eslint.org/docs/rules/no-array-constructor
+  no-array-constructor: error
+
+  # https://eslint.org/docs/rules/no-eval
+  no-eval: error
+
+  # https://eslint.org/docs/rules/no-implicit-coercion
+  no-implicit-coercion:
+    - 'off'
+    - boolean: false
+      number: true
+      string: true
+      allow: []
+
+  # https://eslint.org/docs/rules/no-implied-eval
+  no-implied-eval: error
+
+  # https://eslint.org/docs/rules/no-nested-ternary
+  no-nested-ternary: error
+
+  # https://eslint.org/docs/rules/no-new-object
+  no-new-object: error
+
+  # https://eslint.org/docs/rules/no-new-wrappers
+  no-new-wrappers: error
+
+  # https://eslint.org/docs/rules/no-param-reassign
+  no-param-reassign:
+    - error
+    - props: true
+  
+  # https://eslint.org/docs/rules/no-return-assign
+  no-return-assign: error
+
+  # https://eslint.org/docs/rules/no-self-compare
+  no-self-compare: error
+
+  # https://eslint.org/docs/rules/no-use-before-define
+  no-use-before-define:
+    - error
+    - functions: false
+
+  # https://eslint.org/docs/rules/no-var
+  no-var: error
+
+  # https://eslint.org/docs/rules/prefer-arrow-callback
+  prefer-arrow-callback: error
+
+  # https://eslint.org/docs/rules/prefer-const
+  prefer-const: error
+
+  # https://github.com/prettier/eslint-plugin-prettier
+  prettier/prettier:
+    - error
+  
+  # https://eslint.org/docs/rules/radix
+  radix: error

package/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,37 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is this a support request?**
+This issue tracker is maintained by LaunchDarkly SDK developers and is intended for feedback on the SDK code. If you're not sure whether the problem you are having is specifically related to the SDK, or to the LaunchDarkly service overall, it may be more appropriate to contact the LaunchDarkly support team; they can help to investigate the problem and will consult the SDK team if necessary. You can submit a support request by going [here](https://support.launchdarkly.com/) and clicking "submit a request", or by emailing support@launchdarkly.com.
+
+Note that issues filed on this issue tracker are publicly accessible. Do not provide any private account information on your issues. If your problem is specific to your account, you should submit a support request as described above.
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To reproduce**
+Steps to reproduce the behavior.
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Logs**
+If applicable, add any log output related to your problem.
+
+**SDK version**
+The version of this SDK that you are using.
+
+**Language version, developer tools**
+For instance, Go 1.11 or Ruby 2.5.3. If you are using a language that requires a separate compiler, such as C, please include the name and version of the compiler too.
+
+**OS/platform**
+For instance, Ubuntu 16.04, Windows 10, or Android 4.0.3. If your code is running in a browser, please also include the browser type and version.
+
+**Additional context**
+Add any other context about the problem here.

package/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I would love to see the SDK [...does something new...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context about the feature request here.

package/.github/pull_request_template.md

@@ -0,0 +1,21 @@
+**Requirements**
+
+- [ ] I have added test coverage for new or changed functionality
+- [ ] I have followed the repository's [pull request submission guidelines](../blob/master/CONTRIBUTING.md#submitting-pull-requests)
+- [ ] I have validated my changes against all supported platform versions
+
+**Related issues**
+
+Provide links to any issues in this repository or elsewhere relating to this pull request.
+
+**Describe the solution you've provided**
+
+Provide a clear and concise description of what you expect to happen.
+
+**Describe alternatives you've considered**
+
+Provide a clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+
+Add any other context about the pull request here.

package/.ldrelease/config.yml

@@ -0,0 +1,24 @@
+version: 2
+
+repo:
+  public: js-sdk-common
+  private: js-sdk-common-private
+
+branches:
+  - name: master
+    description: 4.x
+  - name: 3.x
+
+publications:
+  - url: https://www.npmjs.com/package/launchdarkly-js-sdk-common
+    description: npm
+
+jobs:
+  - docker:
+      image: node:12-buster
+    template:
+      name: npm
+
+documentation:
+  gitHubPages: true
+  title: LaunchDarkly Javascript SDK Core Components

package/.prettierignore

@@ -0,0 +1 @@
+package.json

package/.prettierrc

@@ -0,0 +1,5 @@
+{
+   "trailingComma": "es5",
+   "singleQuote": true,
+   "printWidth": 120
+}

package/CHANGELOG.md

@@ -2,6 +2,30 @@
 
 All notable changes to the `launchdarkly-js-sdk-common` package will be documented in this file. Changes that affect the dependent SDKs such as `launchdarkly-js-client-sdk` should also be logged in those projects, in the next release that uses the updated version of this package. This project adheres to [Semantic Versioning](http://semver.org).
 
+## [4.0.1] - 2022-01-21
+### Changed:
+- This package is now published as a regular Node module. Previously, it was published as minified bundles created by Rollup. There was no need for this since Rollup is only needed for web code, and the `js-client-sdk` build already runs Rollup to embed the `js-sdk-common` code. Using Rollup caused the platform-dependent behavior of `uuid` to fail because the code for only one platform (browser or Node) was embedded.
+
+## [4.0.0] - 2022-01-14
+### Changed:
+- Updated `uuid` package to 8.x.
+- In TypeScript, the property `LDEvaluationDetail.reason` is now nullable, which correctly reflects the fact that evaluation reasons may not always be available.
+
+### Removed:
+- Removed the type `NonNullableLDEvaluationReason`, which was a side effect of the `LDEvaluationDetail.reason` being incorrectly defined before.
+- Removed all types, properties, and functions that were deprecated as of the last 3.x release.
+
+## [3.5.0] - 2022-01-14
+### Added:
+- New configurable logger factory `commonBasicLogger` and `BasicLoggerOptions`. The `commonBasicLogger` method is not intended to be exported directly in the SDKs, but wrapped to provide platform-specific behavior.
+
+### Fixed:
+- Any exceptions thrown by the platform-specific local storage implementation (for instance, if we are in a browser and `window.localstorage` is available but disabled) are now consistently caught, and will only be logged the first time to avoid repetitive logging.
+
+## [3.4.0] - 2021-10-15
+### Added:
+- Added LDOptionsBase.requestHeaderTransform allowing custom headers to be added to all requests.
+
 ## [3.3.4] - 2021-10-15
 ### Fixed:
 - Reverted change to `uuid` dependency while working on some compatibility issues.

package/CONTRIBUTING.md

@@ -0,0 +1,45 @@
+# Contributing to This Project
+
+The `launchdarkly-js-sdk-common` package provides core implementation components for several LaunchDarkly SDKs.
+
+## Submitting bug reports and feature requests
+
+Bug reports and feature requests, unless they are very specifically related to a piece of code in this project, should be filed in the individual SDK repositories instead. If you do have an issue specifically for this repository, the LaunchDarkly SDK team monitors the [issue tracker](https://github.com/launchdarkly/js-sdk-common/issues) and will respond to all newly filed issues within two business days.
+
+## Submitting pull requests
+
+We encourage pull requests and other contributions from the community. Before submitting pull requests, ensure that all temporary or unintended code is removed. Don't worry about adding reviewers to the pull request; the LaunchDarkly SDK team will add themselves. The SDK team will acknowledge all pull requests within two business days.
+
+## Build instructions
+
+### Prerequisites
+
+The project uses `npm`, which is bundled in all supported versions of Node.
+
+### Setup
+
+To install project dependencies, from the project root directory:
+
+```
+npm install
+```
+
+### Testing
+
+To run all unit tests:
+
+```
+npm test
+```
+
+To verify that the TypeScript declarations compile correctly (this involves compiling the file `test-types.ts`, so if you have changed any types or interfaces, you will want to update that code):
+
+```
+npm run check-typescript
+```
+
+### Coding guidelines
+
+This code is shared between several SDK projects: `js-client-sdk` which runs in browsers, `node-client-sdk` which runs in Node.js, and `electron-client-sdk` which uses it both in a Node environment and in a browser environment.
+
+Therefore, it should not have any JavaScript usages that work _only_ in a browser or _only_ in Node.js. All such things, if they depend on the runtime environment, must be accessed indirectly via the "platform" abstraction, where each SDK provides its own platform-specific callbacks for the `js-sdk-common` code to use. Or, if it's just a question of JavaScript syntax usages, use whatever will work in both browsers and Node (for instance, use only `require` and `module.exports`, not ES6 imports).

package/babel.config.js

@@ -0,0 +1,18 @@
+module.exports = {
+  presets: [
+    [
+      '@babel/env',
+      {
+        targets: ["last 2 versions", "ie >= 10"],
+      },
+    ],
+  ],
+  env: {
+    test: {
+      plugins: [
+        '@babel/plugin-transform-regenerator',
+        '@babel/plugin-transform-runtime',
+      ],
+    },
+  },
+};

package/docs/typedoc.js

@@ -0,0 +1,11 @@
+module.exports = {
+  out: '/tmp/project-releaser/project/docs/build/html',
+  exclude: [
+    '**/node_modules/**',
+    'test-types.ts'
+  ],
+  name: "LaunchDarkly Javascript SDK Core Components (4.0.1)",
+  readme: 'none',                // don't add a home page with a copy of README.md
+  entryPoints: "/tmp/project-releaser/project/typings.d.ts",
+  entryPointStrategy: "expand"
+};

package/jest.config.js

@@ -0,0 +1,15 @@
+const version = process.env.npm_package_version;
+
+module.exports = {
+  automock: false,
+  resetModules: true,
+  rootDir: 'src',
+  setupFiles: ['./jest.setup.js'],
+  testMatch: ['**/__tests__/**/*-test.js'],
+  transform: {
+    '^.+\\.js$': 'babel-jest',
+  },
+  globals: {
+    VERSION: version,
+  },
+};

package/package.json

@@ -1,23 +1,11 @@
 {
   "name": "launchdarkly-js-sdk-common",
-  "version": "3.4.0-alpha.2",
+  "version": "4.0.1",
   "description": "LaunchDarkly SDK for JavaScript - common code",
   "author": "LaunchDarkly <team@launchdarkly.com>",
   "license": "Apache-2.0",
-  "files": [
-    "ldclient-common.cjs.js",
-    "ldclient-common.cjs.js.map",
-    "ldclient-common.es.js",
-    "ldclient-common.es.js.map",
-    "ldclient-common.min.js",
-    "ldclient-common.min.js.map",
-    "typings.d.ts"
-  ],
   "types": "./typings.d.ts",
-  "main": "dist/ldclient-common.cjs.js",
-  "module": "dist/ldclient-common.es.js",
-  "unpkg": "dist/ldclient-common.min.js",
-  "jsdelivr": "dist/ldclient-common.min.js",
+  "main": "src/index.js",
   "scripts": {
     "lint": "eslint --format 'node_modules/eslint-formatter-pretty' --ignore-path .eslintignore",
     "lint:all": "eslint --format 'node_modules/eslint-formatter-pretty' --ignore-path .eslintignore src",
@@ -27,14 +15,8 @@
     "format:test": "npm run format:test:md && npm run format:test:js",
     "format:test:md": "prettier --parser markdown --ignore-path .prettierignore --list-different '*.md'",
     "format:test:js": "prettier --ignore-path .prettierignore --list-different 'src/**/*.js'",
-    "build": "cross-env NODE_ENV=development rollup -c rollup.config.js",
-    "build:min": "cross-env NODE_ENV=production rollup -c rollup.config.js",
     "test": "cross-env NODE_ENV=test jest",
-    "test:junit": "cross-env NODE_ENV=test jest --testResultsProcessor jest-junit",
-    "check-typescript": "node_modules/typescript/bin/tsc",
-    "clean": "rimraf dist/**",
-    "prepublishOnly": "npm run build:min",
-    "prepare": "npm run build"
+    "check-typescript": "node_modules/typescript/bin/tsc"
   },
   "devDependencies": {
     "@babel/cli": "^7.8.4",
@@ -43,7 +25,6 @@
     "@babel/plugin-transform-runtime": "^7.6.2",
     "@babel/preset-env": "^7.6.3",
     "@babel/runtime": "7.6.3",
-    "@rollup/plugin-node-resolve": "^6.0.0",
     "@rollup/plugin-replace": "^2.2.0",
     "babel-eslint": "^10.1.0",
     "babel-jest": "^25.1.0",
@@ -59,21 +40,14 @@
     "launchdarkly-js-test-helpers": "1.1.0",
     "prettier": "1.11.1",
     "readline-sync": "^1.4.9",
-    "rimraf": "^2.6.2",
-    "rollup": "^1.26.0",
-    "rollup-plugin-babel": "^4.3.3",
-    "rollup-plugin-commonjs": "^10.1.0",
-    "rollup-plugin-filesize": "^6.2.1",
-    "rollup-plugin-terser": "5.2.0",
-    "rollup-plugin-uglify": "6.0.4",
     "semver": "^5.5.0",
     "semver-compare": "^1.0.0",
-    "typescript": "^3.7.5"
+    "typescript": "~4.4.4"
   },
   "dependencies": {
     "base64-js": "^1.3.0",
     "fast-deep-equal": "^2.0.1",
-    "uuid": "^3.3.2"
+    "uuid": "^8.0.0"
   },
   "repository": {
     "type": "git",

package/scripts/better-audit.sh

@@ -0,0 +1,76 @@
+#!/bin/bash
+
+# This script processes the output of "npm audit" to make it more useful, as follows:
+# - For each flagged vulnerability, it looks at the "path" field and extracts both the flagged
+#   package (the last element in the path) and the topmost dependency that led to it (the first
+#   element in the path).
+# - It sorts these and eliminates duplicates.
+# - It then compares each of the topmost dependencies to package.json to see if it is from
+#   "dependencies", "peerDependencies", or "devDependencies". If it is either of the first two
+#   then this is a real runtime vulnerability, and must be fixed by updating the topmost
+#   dependency. If it is from devDependencies, then it can be safely fixed with "npm audit fix".
+
+set -e
+
+function readPackages() {
+  inCategory=$1
+  jq -r ".${inCategory} | keys | .[]" package.json 2>/dev/null || true
+}
+
+function isInList() {
+  item=$1
+  shift
+  for x in $@; do
+    if [ "$item" == "$x" ]; then
+      true
+      return
+    fi
+  done
+  false
+}
+
+dependencies=$(readPackages dependencies)
+devDependencies=$(readPackages devDependencies)
+peerDependencies=$(readPackages peerDependencies)
+
+function processItems() {
+  flaggedRuntime=0
+  flaggedDev=0
+  while read -r badPackage topLevelDep; do
+    echo -n "flagged package \"$badPackage\", referenced via \"$topLevelDep\" "
+    for category in dependencies peerDependencies devDependencies; do
+      if isInList $topLevelDep ${!category}; then
+        if [ "$category" == "devDependencies" ]; then
+          echo "-- from \"$category\""
+          flaggedDev=1
+        else
+          echo "-- from \"$category\" (RUNTIME) ***"
+          flaggedRuntime=1
+        fi
+        break
+      fi
+    done
+  done
+  echo
+  if [ "$flaggedRuntime" == "1" ]; then
+    echo "*** At least one runtime dependency was flagged. These must be fixed by updating package.json."
+    echo "Do not use 'npm audit fix'."
+    exit 1  # return an error, causing the build to fail
+  elif [ "$flaggedDev" == "1" ]; then
+    echo "Only development dependencies were flagged. You may safely run 'npm audit fix', which will"
+    echo "fix these by adding overrides to package-lock.json."
+  else
+    echo "Congratulations! No dependencies were flagged by 'npm audit'."
+  fi
+}
+
+echo "Running npm audit..."
+echo
+
+npm audit --json \
+  | grep '"path":' \
+  | sort | uniq \
+  | sed -n -e 's#.*"path": "\([^"]*\)".*#\1#p' \
+  | awk -F '>' '{ print $NF,$1 }' \
+  | sort | uniq \
+  | processItems

package/src/EventEmitter.js

@@ -0,0 +1,60 @@
+function EventEmitter(logger) {
+  const emitter = {};
+  const events = {};
+
+  const listeningTo = event => !!events[event];
+
+  emitter.on = function(event, handler, context) {
+    events[event] = events[event] || [];
+    events[event] = events[event].concat({
+      handler: handler,
+      context: context,
+    });
+  };
+
+  emitter.off = function(event, handler, context) {
+    if (!events[event]) {
+      return;
+    }
+    for (let i = 0; i < events[event].length; i++) {
+      if (events[event][i].handler === handler && events[event][i].context === context) {
+        events[event] = events[event].slice(0, i).concat(events[event].slice(i + 1));
+      }
+    }
+  };
+
+  emitter.emit = function(event) {
+    if (!events[event]) {
+      return;
+    }
+    // Copy the list of handlers before iterating, in case any handler adds or removes another handler.
+    // Any such changes should not affect what we do here-- we want to notify every handler that existed
+    // at the moment that the event was fired.
+    const copiedHandlers = events[event].slice(0);
+    for (let i = 0; i < copiedHandlers.length; i++) {
+      copiedHandlers[i].handler.apply(copiedHandlers[i].context, Array.prototype.slice.call(arguments, 1));
+    }
+  };
+
+  emitter.getEvents = function() {
+    return Object.keys(events);
+  };
+
+  emitter.getEventListenerCount = function(event) {
+    return events[event] ? events[event].length : 0;
+  };
+
+  emitter.maybeReportError = function(error) {
+    if (!error) {
+      return;
+    }
+    if (listeningTo('error')) {
+      this.emit('error', error);
+    } else {
+      (logger || console).error(error.message);
+    }
+  };
+  return emitter;
+}
+
+module.exports = EventEmitter;