Skip to content

Commit db57438

Browse files
authored
Prepare for 3.2.0 release (#282)
1 parent 038b14c commit db57438

File tree

6 files changed

+65
-5
lines changed

6 files changed

+65
-5
lines changed

packages/optimizely-sdk/CHANGELOG.MD

+60
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,66 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
77
## [Unreleased]
88
Changes that have landed but are not yet released.
99

10+
## [3.2.0] - May 30th, 2019
11+
12+
### New Features
13+
14+
- Added support for automatic datafile management ([#261](https://github.com/optimizely/javascript-sdk/pull/261)), ([#266](https://github.com/optimizely/javascript-sdk/pull/266)), ([#267](https://github.com/optimizely/javascript-sdk/pull/267)), ([#268](https://github.com/optimizely/javascript-sdk/pull/268)), ([#270](https://github.com/optimizely/javascript-sdk/pull/270)), ([#272](https://github.com/optimizely/javascript-sdk/pull/272))
15+
- To use automatic datafile management, include `sdkKey` as a string property in the options object you pass to `createInstance`.
16+
- 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.
17+
- Use the `onReady` method to wait until the download is complete and the SDK is ready to use.
18+
- Customize datafile management behavior by passing a `datafileOptions` object within the options you pass to `createInstance`.
19+
- 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.
20+
- 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.
21+
- Stop active downloads and cancel recurring downloads by calling the `close` method
22+
23+
#### Create an instance with datafile management enabled
24+
```js
25+
const optimizely = require('@optimizely/optimizely-sdk');
26+
const optimizelyClientInstance = optimizely.createInstance({
27+
sdkKey: '12345', // Provide the sdkKey of your desired environment here
28+
});
29+
```
30+
31+
#### Use `onReady` to wait until optimizelyClientInstance has a datafile
32+
```js
33+
const optimizely = require('@optimizely/optimizely-sdk');
34+
const optimizelyClientInstance = optimizely.createInstance({
35+
sdkKey: '12345',
36+
});
37+
optimizelyClientInstance.onReady().then(() => {
38+
// optimizelyClientInstance is ready to use, with datafile downloaded from the Optimizely CDN
39+
});
40+
```
41+
42+
#### Enable automatic updates, add notification listener for OPTIMIZELY_CONFIG_UPDATE notification type, and stop automatic updates
43+
```js
44+
const optimizely = require('@optimizely/optimizely-sdk');
45+
const optimizelyClientInstance = optimizely.createInstance({
46+
sdkKey: '12345',
47+
datafileOptions: {
48+
autoUpdate: true,
49+
updateInterval: 600000 // 10 minutes in milliseconds
50+
},
51+
});
52+
optimizelyClientInstance.notificationCenter.addNotificationListener(
53+
optimizely.enums.NOTIFICATION_TYPES.OPTIMIZELY_CONFIG_UPDATE,
54+
() => {
55+
// optimizelyClientInstance has updated its Optimizely config
56+
},
57+
);
58+
// Stop automatic updates - optimizelyClientInstance will use whatever datafile it currently has from now on
59+
optimizelyClientInstance.close();
60+
```
61+
62+
### Changed
63+
- 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](https://github.com/optimizely/javascript-sdk/pull/261)).
64+
- Update TypeScript definitions to account for new methods (`onReady`, `close`) and new properties on object accepted by createInstance (`datafileOptions`, `sdkKey`), ([#263](https://github.com/optimizely/javascript-sdk/pull/263)), ([#278](https://github.com/optimizely/javascript-sdk/pull/278))
65+
- Allow react-sdk to be passed in as `clientEngine` ([#279](https://github.com/optimizely/javascript-sdk/pull/279))
66+
67+
### Bug Fixes:
68+
- Add logging message for `optimizely.track()` ([#281](https://github.com/optimizely/javascript-sdk/pull/281))
69+
1070
## [3.2.0-beta] - May 16th, 2019
1171

1272
### Bug Fixes:

packages/optimizely-sdk/lib/index.browser.tests.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ describe('javascript-sdk', function() {
119119
optlyInstance.onReady().catch(function() {});
120120

121121
assert.instanceOf(optlyInstance, Optimizely);
122-
assert.equal(optlyInstance.clientVersion, '3.2.0-beta');
122+
assert.equal(optlyInstance.clientVersion, '3.2.0');
123123
});
124124

125125
it('should set the JavaScript client engine and version', function() {

packages/optimizely-sdk/lib/index.node.tests.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ describe('optimizelyFactory', function() {
9090
optlyInstance.onReady().catch(function() {});
9191

9292
assert.instanceOf(optlyInstance, Optimizely);
93-
assert.equal(optlyInstance.clientVersion, '3.2.0-beta');
93+
assert.equal(optlyInstance.clientVersion, '3.2.0');
9494
});
9595
});
9696
});

packages/optimizely-sdk/lib/utils/enums/index.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@ exports.CONTROL_ATTRIBUTES = {
155155
exports.JAVASCRIPT_CLIENT_ENGINE = 'javascript-sdk';
156156
exports.NODE_CLIENT_ENGINE = 'node-sdk';
157157
exports.REACT_CLIENT_ENGINE = 'react-sdk';
158-
exports.NODE_CLIENT_VERSION = '3.2.0-beta';
158+
exports.NODE_CLIENT_VERSION = '3.2.0';
159159

160160
exports.VALID_CLIENT_ENGINES = [
161161
exports.NODE_CLIENT_ENGINE,

packages/optimizely-sdk/package-lock.json

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/optimizely-sdk/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@optimizely/optimizely-sdk",
3-
"version": "3.2.0-beta",
3+
"version": "3.2.0",
44
"description": "JavaScript SDK for Optimizely X Full Stack",
55
"main": "lib/index.node.js",
66
"browser": "lib/index.browser.js",

0 commit comments

Comments
 (0)