@optimizely/optimizely-sdk - npm Package Versions

[3.3.0-beta] - August 21th, 2019

New Features

• Added support for event batching via the event processor.
  • Events generated by methods like activate, track, and isFeatureEnabled will be held in a queue until the configured batch size is reached, or the configured flush interval has elapsed. Then, they will be combined into a request and sent to the event dispatcher.
  • To configure event batching, include the eventBatchSize and eventFlushInterval number properties in the object you pass to createInstance.
  • Event batching is enabled by default. eventBatchSize defaults to 10. eventFlushInterval defaults to 30000 in Node and 1000 in browsers.
• Added localStorage mitigation against lost events in the browser
  • When event requests are dispatched, they are written to localStorage, and when a response is received, they are removed from localStorage.
  • When the SDK is initialized for the first time in the browser, if any requests remain in localStorage, they will be sent, and removed from localStorage when a response is received.
• Updated the close method to return a Promise representing the process of closing the instance. When close is called, any events waiting to be sent as part of a batched event request will be immediately batched and sent to the event dispatcher.
  • If any such requests were sent to the event dispatcher, close returns a Promise that fulfills after the event dispatcher calls the response callback for each request. Otherwise, close returns an immediately-fulfilled Promise.
  • The Promise returned from close is fulfilled with a result object containing success (boolean) and reason (string, only when success is false) properties. In the result object, success is true if all events in the queue at the time close was called were combined into requests, sent to the event dispatcher, and the event dispatcher called the callbacks for each request. success is false if an unexpected error was encountered during the close process.
• Added non-typed getFeatureVariable method (#298) as a more idiomatic approach to getting values of feature variables.
  • Typed getFeatureVariable methods will still be available for use.

[3.2.2] - August 20th, 2019

Bug fixes

• Dont use pendingEventsDispatcher with user defined eventDispatcher (#289) Note: This was supposed to be released in 3.2.1 but did not make it into the release.
• Updated lodash dependency to ^4.17.11 to address security vulnerabilities (#296)

[3.2.1] - July 1st, 2019

Changed

• Updated lodash dependency to ^4.17.11 to address security vulnerabilities (#296)

[3.2.0] - May 30th, 2019

New Features

• Added support for automatic datafile management (#261), (#266), (#267), (#268), (#270), (#272)

  • To use automatic datafile management, include sdkKey as a string property in the options object you pass to createInstance.
  • When sdkKey is provided, the SDK instance will download the datafile associated with that sdkKey immediately upon construction. When the download completes, the SDK instance will update itself to use the downloaded datafile.
  • Use the onReady method to wait until the download is complete and the SDK is ready to use.
  • Customize datafile management behavior by passing a datafileOptions object within the options you pass to createInstance.
    • Enable automatic updates by passing autoUpdate: true. Periodically (on the provided update interval), the SDK instance will download the datafile and update itself. Use this to ensure that the SDK instance is using a fresh datafile reflecting changes recently made to your experiment or feature configuration.
  • Add a notification listener for the OPTIMIZELY_CONFIG_UPDATE notification type to be notified when an instance updates its Optimizely config after obtaining a new datafile.
  • Stop active downloads and cancel recurring downloads by calling the close method

  Create an instance with datafile management enabled

  const optimizely = require('@optimizely/optimizely-sdk');
  const optimizelyClientInstance = optimizely.createInstance({
    sdkKey: '12345', // Provide the sdkKey of your desired environment here
  });
  

  Use onReady to wait until optimizelyClientInstance has a datafile

  const optimizely = require('@optimizely/optimizely-sdk');
  const optimizelyClientInstance = optimizely.createInstance({
    sdkKey: '12345',
  });
  optimizelyClientInstance.onReady().then(() => {
    // optimizelyClientInstance is ready to use, with datafile downloaded from the Optimizely CDN
  });
  

  Enable automatic updates, add notification listener for OPTIMIZELY_CONFIG_UPDATE notification type, and stop automatic updates

  const optimizely = require('@optimizely/optimizely-sdk');
  const optimizelyClientInstance = optimizely.createInstance({
    sdkKey: '12345',
    datafileOptions: {
      autoUpdate: true,
      updateInterval: 600000, // 10 minutes in milliseconds
    },
  });
  optimizelyClientInstance.notificationCenter.addNotificationListener(
    optimizely.enums.NOTIFICATION_TYPES.OPTIMIZELY_CONFIG_UPDATE,
    () => {
      // optimizelyClientInstance has updated its Optimizely config
    }
  );
  // Stop automatic updates - optimizelyClientInstance will use whatever datafile it currently has from now on
  optimizelyClientInstance.close();
  

Changed

• Forced variation logic has been moved from the project config module to the decision service. Prefixes for forced-variation-related log messages will reflect this change (#261).
• Update TypeScript definitions to account for new methods (onReady, close) and new properties on object accepted by createInstance (datafileOptions, sdkKey), (#263), (#278)
• Allow react-sdk to be passed in as clientEngine (#279)

Bug Fixes:

• Add logging message for optimizely.track() (#281)

[3.2.0-beta] - May 16th, 2019

Bug Fixes:

• Clear timeout created in onReady call for timeout promise as soon as project config manager's ready promise fulfills

New Features

• Added 60 second timeout for all datafile requests

Changed

• Updated datafile request polling behavior:
  • Start update interval timer immediately after request
  • When update interval timer fires during request, wait until request completes, then immediately start next request
• Update TypeScript definitions to account for new methods (onReady, close) and new properties on object accepted by createInstance (datafileOptions, sdkKey)

[3.2.0-alpha] - April 26nd, 2019

New Features

• Added support for automatic datafile management
  • To use automatic datafile management, include sdkKey as a string property in the options object you pass to createInstance.
  • When sdkKey is provided, the SDK instance will download the datafile associated with that sdkKey immediately upon construction. When the download completes, the SDK instance will update itself to use the downloaded datafile.
  • Use the onReady method to wait until the download is complete and the SDK is ready to use.
  • Customize datafile management behavior by passing a datafileOptions object within the options you pass to createInstance.
    • Enable automatic updates by passing autoUpdate: true. Periodically (on the provided update interval), the SDK instance will download the datafile and update itself. Use this to ensure that the SDK instance is using a fresh datafile reflecting changes recently made to your experiment or feature configuration.
  • Add a notification listener for the OPTIMIZELY_CONFIG_UPDATE notification type to be notified when an instance updates its Optimizely config after obtaining a new datafile.
  • Stop active downloads and cancel pending downloads by calling the close method

Create an instance with datafile management enabled

const optimizely = require('@optimizely/optimizely-sdk');
const optimizelyClientInstance = optimizely.createInstance({
  sdkKey: '12345', // Provide the sdkKey of your desired environment here
});

Use onReady to wait until optimizelyClientInstance has a datafile

const optimizely = require('@optimizely/optimizely-sdk');
const optimizelyClientInstance = optimizely.createInstance({
  sdkKey: '12345',
});
optimizelyClientInstance.onReady().then(() => {
  // optimizelyClientInstance is ready to use, with datafile downloaded from the Optimizely CDN
});

Enable automatic updates, add notification listener for OPTIMIZELY_CONFIG_UPDATE notification type, and stop automatic updates

const optimizely = require('@optimizely/optimizely-sdk');
const optimizelyClientInstance = optimizely.createInstance({
  sdkKey: '12345',
  datafileOptions: {
    autoUpdate: true,
    updateInterval: 600000, // 10 minutes in milliseconds
  },
});
optimizelyClientInstance.notificationCenter.addNotificationListener(
  optimizely.enums.NOTIFICATION_TYPES.OPTIMIZELY_CONFIG_UPDATE,
  () => {
    // optimizelyClientInstance has updated its Optimizely config
  }
);
// Stop automatic updates - optimizelyClientInstance will use whatever datafile it currently has from now on
optimizelyClientInstance.close();

Changed

• Forced variation logic has been moved from the project config module to the decision service. Prefixes for forced-variation-related log messages will reflect this change.

[3.1.0] - April 22nd, 2019

New Features:

• Introduced Decision notification listener to be able to record:
  • Variation assignments for users activated in an experiment.
  • Feature access for users.
  • Feature variable value for users.

Changed

• New APIs for setting logger and logLevel on the optimizelySDK singleton (#232)
• logger and logLevel are now set globally for all instances of Optimizely. If you were passing different loggers to individual instances of Optimizely, logging behavior may now be different.

Setting a ConsoleLogger

var optimizelySDK = require('@optimizely/optimizely-sdk');

// logger and logLevel are now set on the optimizelySDK singleton
optimizelySDK.setLogger(optimizelySDK.logging.createLogger());

// valid levels: 'DEBUG', 'INFO', 'WARN', 'ERROR'
optimizelySDK.setLogLevel('WARN');
// enums can also be used
optimizelySDK.setLogLevel(optimizelySDK.enums.LOG_LEVEL.ERROR);

Disable logging

var optimizelySDK = require('@optimizely/optimizely-sdk');

optimizelySDK.setLogger(null);

Bug Fixes

• Feature variable APIs now return default variable value when featureEnabled property is false. (#249)

Deprecated

• Activate notification listener is deprecated as of this release. Recommendation is to use the new Decision notification listener. Activate notification listener will be removed in the next major release.

[3.1.0-beta1] - March 5th, 2019

Changed

• New APIs for setting logger and logLevel on the optimizelySDK singleton (#232)
• logger and logLevel are now set globally for all instances of Optimizely. If you were passing different loggers to individual instances of Optimizely, logging behavior may now be different.

Setting a ConsoleLogger

var optimizelySDK = require('@optimizely/optimizely-sdk');

// logger and logLevel are now set on the optimizelySDK singleton
optimizelySDK.setLogger(optimizelySDK.logging.createLogger());

// valid levels: 'DEBUG', 'INFO', 'WARN', 'ERROR'
optimizelySDK.setLogLevel('WARN');
// enums can also be used
optimizelySDK.setLogLevel(optimizely.enums.LOG_LEVEL.ERROR);

Disable logging

var optimizelySDK = require('@optimizely/optimizely-sdk');

optimizelySDK.setLogger(null);

[3.0.1] - February 21, 2019

Changed

• Expose default loggers, errorHandlers, eventDispatcher and enums on top level require.
• createLogger and createNoOpLogger are available as methods on optimizelySdk.logging
• Added optimizelySdk.errorHandler
• Added optimizelySdk.eventDispatcher
• Added optimizelySdk.enums

[3.0.0] - February 13, 2019

The 3.0 release improves event tracking and supports additional audience targeting functionality.

New Features:

• Event tracking (#207):
  • The track method now dispatches its conversion event unconditionally, without first determining whether the user is targeted by a known experiment that uses the event. This may increase outbound network traffic.
  • In Optimizely results, conversion events sent by 3.0 SDKs don't explicitly name the experiments and variations that are currently targeted to the user. Instead, conversions are automatically attributed to variations that the user has previously seen, as long as those variations were served via 3.0 SDKs or by other clients capable of automatic attribution, and as long as our backend actually received the impression events for those variations.
  • Altogether, this allows you to track conversion events and attribute them to variations even when you don't know all of a user's attribute values, and even if the user's attribute values or the experiment's configuration have changed such that the user is no longer affected by the experiment. As a result, you may observe an increase in the conversion rate for previously-instrumented events. If that is undesirable, you can reset the results of previously-running experiments after upgrading to the 3.0 SDK.
  • This will also allow you to attribute events to variations from other Optimizely projects in your account, even though those experiments don't appear in the same datafile.
  • Note that for results segmentation in Optimizely results, the user attribute values from one event are automatically applied to all other events in the same session, as long as the events in question were actually received by our backend. This behavior was already in place and is not affected by the 3.0 release.
• Support for all types of attribute values, not just strings (#174, #204).
  • All values are passed through to notification listeners.
  • Strings, booleans, and valid numbers are passed to the event dispatcher and can be used for Optimizely results segmentation. A valid number is a finite number in the inclusive range [-2⁵³, 2⁵³].
  • Strings, booleans, and valid numbers are relevant for audience conditions.
• Support for additional matchers in audience conditions (#174):
  • An exists matcher that passes if the user has a non-null value for the targeted user attribute and fails otherwise.
  • A substring matcher that resolves if the user has a string value for the targeted attribute.
  • gt (greater than) and lt (less than) matchers that resolve if the user has a valid number value for the targeted attribute. A valid number is a finite number in the inclusive range [-2⁵³, 2⁵³].
  • The original (exact) matcher can now be used to target booleans and valid numbers, not just strings.
• Support for A/B tests, feature tests, and feature rollouts whose audiences are combined using "and" and "not" operators, not just the "or" operator (#175)
• Updated Pull Request template and commit message guidelines (#183).
• Support for sticky bucketing. You can pass an $opt_experiment_bucket_map attribute to ensure that the user gets a specific variation (#179).
• Support for bucketing IDs when evaluating feature rollouts, not just when evaluating A/B tests and feature tests (#200).
• TypeScript declarations (#199).

Breaking Changes:

• Conversion events sent by 3.0 SDKs don't explicitly name the experiments and variations that are currently targeted to the user, so these events are unattributed in raw events data export. You must use the new results export to determine the variations to which events have been attributed.
• Previously, notification listeners were only given string-valued user attributes because only strings could be passed into various method calls. That is no longer the case. You may pass non-string attribute values, and if you do, you must update your notification listeners to be able to receive whatever values you pass in (#174, #204).
• Drops window.optimizelyClient from the bundled build. Now, window.optimizelySdk can be used instead. (#189).

Bug Fixes:

• Experiments and features can no longer activate when a negatively targeted attribute has a missing, null, or malformed value (#174).
  • Audience conditions (except for the new exists matcher) no longer resolve to false when they fail to find an legitimate value for the targeted user attribute. The result remains null (unknown). Therefore, an audience that negates such a condition (using the "not" operator) can no longer resolve to true unless there is an unrelated branch in the condition tree that itself resolves to true.
• setForcedVariation now treats an empty variation key as invalid and does not reset the variation (#185).
• You can now specify 0 as the revenue or value for a conversion event when using the track method. Previously, 0 was withheld and would not appear in your data export (#213).
• The existence of a feature test in an experimentation group no longer causes A/B tests in the same group to activate the same feature (#194).