prepare 5.10.0 release

.circleci/config.yml

@@ -1,25 +1,29 @@
 version: 2.1
 
+orbs:
+   win: circleci/windows@1.0.0
+
 workflows:
-  workflow:
+  build-and-test-all:
     jobs:
-      - build-and-test:
+      - build-test-linux:
           name: latest Node version
+          docker-image: circleci/node:latest
           run-lint: true
-      - build-and-test:
+      - build-test-linux:
           name: oldest supported Node version
           docker-image: circleci/node:6
           run-lint: false
+      - build-test-windows:
+          name: Windows
 
 jobs:
-  build-and-test:
+  build-test-linux:
     parameters:
       run-lint:
         type: boolean
-        default: false
       docker-image:
         type: string
-        default: circleci/node:latest
     docker:
       - image: <<parameters.docker-image>>
       - image: redis
@@ -43,3 +47,28 @@ jobs:
           path: reports/junit
       - store_artifacts:
           path: reports/junit
+
+  build-test-windows:
+    executor:
+      name: win/vs2019
+      shell: powershell.exe
+    steps:
+      - checkout
+      - run:
+          name: set up Redis
+          command: |
+            $ProgressPreference = "SilentlyContinue"  # prevents console errors from CircleCI host
+            iwr -outf redis.zip https://github.com/MicrosoftArchive/redis/releases/download/win-3.0.504/Redis-x64-3.0.504.zip
+            mkdir redis
+            Expand-Archive -Path redis.zip -DestinationPath redis
+      - run:
+          name: start Redis
+          command: |
+            cd redis
+            ./redis-server --service-install
+            ./redis-server --service-start
+            Start-Sleep -s 5
+            ./redis-cli ping
+      - run: node --version
+      - run: npm install
+      - run: npm test

configuration.js

@@ -25,6 +25,24 @@ module.exports = (function() {
     };
   };
 
+  const typesForPropertiesWithNoDefault = {
+    // Add a value here if we add a configuration property whose type cannot be determined by looking
+    // in baseDefaults (for instance, the default is null but if the value isn't null it should be a
+    // string). The allowable values are 'boolean', 'string', 'number', 'object', 'function', or
+    // 'factory' (the last one means it can be either a function or an object).
+    eventProcessor: 'object',
+    featureStore: 'object',
+    logger: 'object', // winston.Logger
+    proxyAgent: 'object',
+    proxyAuth: 'string',
+    proxyHost: 'string',
+    proxyPort: 'number',
+    proxyScheme: 'string',
+    tlsParams: 'object', // LDTLSOptions
+    updateProcessor: 'factory', // gets special handling in validation
+    userAgent: 'string'
+  };
+
   const deprecatedOptions = {
     base_uri: 'baseUri',
     stream_uri: 'streamUri',
@@ -58,7 +76,7 @@ module.exports = (function() {
     // This works differently from Object.assign() in that it will *not* override a default value
     // if the provided value is explicitly set to null.
     const ret = Object.assign({}, config);
-    Object.keys(defaults).forEach(function(name) {
+    Object.keys(defaults).forEach(name => {
       if (ret[name] === undefined || ret[name] === null) {
         ret[name] = defaults[name];
       }
@@ -70,6 +88,48 @@ module.exports = (function() {
     return uri.replace(/\/+$/, '');
   }
 
+  function validateTypesAndNames(config, defaultConfig) {
+    const typeDescForValue = value => {
+      if (value === null || value === undefined) {
+        return undefined;
+      }
+      if (Array.isArray(value)) {
+        return 'array';
+      }
+      const t = typeof(value);
+      if (t === 'boolean' || t === 'string' || t === 'number') {
+        return t;
+      }
+      return 'object';
+    };
+    Object.keys(config).forEach(name => {
+      const value = config[name];
+      if (value !== null && value !== undefined) {
+        const defaultValue = defaultConfig[name];
+        const typeDesc = typesForPropertiesWithNoDefault[name];
+        if (defaultValue === undefined && typeDesc === undefined) {
+          config.logger.warn(messages.unknownOption(name));
+        } else {
+          const expectedType = typeDesc || typeDescForValue(defaultValue);
+          const actualType = typeDescForValue(value);
+          if (actualType !== expectedType) {
+            if (expectedType == 'factory' && (typeof value === 'function' || typeof value === 'object')) {
+              // for some properties, we allow either a factory function or an instance
+              return;
+            }
+            if (expectedType === 'boolean') {
+              config[name] = !!value;
+              config.logger.warn(messages.wrongOptionTypeBoolean(name, actualType));
+            } else {
+              config.logger.warn(messages.wrongOptionType(name, expectedType, actualType));
+              config[name] = defaultConfig[name];
+            }
+          }
+        }
+      }
+    });
+  }
+
   function validate(options) {
     let config = Object.assign({}, options || {});
 
@@ -89,7 +149,10 @@ module.exports = (function() {
 
     checkDeprecatedOptions(config);
 
-    config = applyDefaults(config, defaults());
+    const defaultConfig = defaults();
+    config = applyDefaults(config, defaultConfig);
+
+    validateTypesAndNames(config, defaultConfig);
 
     config.baseUri = canonicalizeUri(config.baseUri);
     config.streamUri = canonicalizeUri(config.streamUri);
@@ -100,6 +163,7 @@ module.exports = (function() {
   }
 
   return {
-    validate: validate
+    validate: validate,
+    defaults: defaults
   };
 })();

index.d.ts

@@ -11,7 +11,7 @@
 
 declare module 'launchdarkly-node-server-sdk' {
   import { EventEmitter } from 'events';
-  import { ClientOpts } from 'redis';
+  import { ClientOpts, RedisClient } from 'redis';
 
   namespace errors {
     export const LDPollingError: ErrorConstructor;
@@ -52,6 +52,9 @@ declare module 'launchdarkly-node-server-sdk' {
    *   A string that should be prepended to all Redis keys used by the feature store.
    * @param logger
    *   A custom logger for warnings and errors, if you are not using the default logger.
+   * @param client
+   *   Pass this parameter if you already have a Redis client instance that you wish to reuse. In this case,
+   *   `redisOpts` will be ignored.
    *
    * @returns
    *   An object to put in the `featureStore` property for [[LDOptions]].
@@ -60,7 +63,8 @@ declare module 'launchdarkly-node-server-sdk' {
     redisOpts?: ClientOpts,
     cacheTTL?: number,
     prefix?: string,
-    logger?: LDLogger | object
+    logger?: LDLogger | object,
+    client?: RedisClient
   ): LDFeatureStore;
 
   /**

messages.js

@@ -10,3 +10,11 @@ exports.httpErrorMessage = (status, context, retryMessage) =>
     + ' - ' + (errors.isHttpErrorRecoverable(status) ? retryMessage : 'giving up permanently');
 
 exports.missingUserKeyNoEvent = () => 'User was unspecified or had no key; event will not be sent';
+
+exports.unknownOption = name => 'Ignoring unknown config option "' + name + '"';
+
+exports.wrongOptionType = (name, expectedType, actualType) =>
+  'Config option "' + name + '" should be of type ' + expectedType + ', got ' + actualType + ', using default value';
+
+exports.wrongOptionTypeBoolean = (name, actualType) =>
+  'Config option "' + name + '" should be a boolean, got ' + actualType + ', converting to boolean';