Skip to content

Commit 6f0b6a4

Browse files
author
Tyler Brandt
authored
refactor(dist): update bundled files (#189)
## Summary **BREAKING**: Drop support for `window.optimizelyClient`, as presaged in the [CHANGELOG](https://github.com/optimizely/javascript-sdk/blob/master/packages/optimizely-sdk/CHANGELOG.MD#213---august-21-2018). - Pull in changes from 2.3.x, to ensure that both optimizely.browser.umd.js and optimizely.browser.umd.min.js are defined. - Refactor those changes to use webpack config/index.browser code instead of appending to the bundle after-the-fact. - Actually install `webpack` as a devDependency rather than always using latest In addition to fixing the issue from #187 in this branch, it simplifies the build script. ## Test plan Existing unit tests pass since the "node" API for index.browser.js wasn't changed. Created a test file called "dist/test.html" and loaded it in a browser (as well as an equivalent one that loads the min.js variant): ```html <!DOCTYPE html> <html> <head> <script src="/optimizely.browser.umd.js"></script> </head> <body> <h1>Hello</h1> <script> console.log('optimizelySdk', typeof optimizelySdk); console.log('optimizelyClient', typeof optimizelyClient); </script> </body> </html> ``` Ensured that it logged "object" for the first, and "undefined" for the second: ![screen shot 2018-11-14 at 3 50 30 pm](https://user-images.githubusercontent.com/1256483/48520564-ecdadb00-e825-11e8-8d97-18c8fe27985c.png) ## Issues - OASIS-3790
1 parent 2a47e5e commit 6f0b6a4

File tree

7 files changed

+3025
-2210
lines changed

7 files changed

+3025
-2210
lines changed

‎packages/optimizely-sdk/CHANGELOG.MD

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,16 @@ All notable changes to this project will be documented in this file.
44
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
55
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
66

7+
## [Unreleased]
8+
Changes that have landed but are not yet released.
9+
10+
### Breaking Changes
11+
12+
Drops `window.optimizelyClient` from the bundled build ([#189](https://github.com/optimizely/javascript-sdk/pull/189)).
13+
14+
### Fixes
15+
- fix(bundling): Publish the unminified UMD bundle along with the minified one. ([#187](https://github.com/optimizely/javascript-sdk/pull/187))
16+
717
## [3.0.0-rc] - November 6, 2018
818

919
This is the release candidate version of the 3.0 SDK:

‎packages/optimizely-sdk/README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,9 @@ See the Optimizely X Full Stack [developer documentation](http://developers.opti
3535
The package's entry point is a CommonJS module, which can be used directly in environments which support it (e.g., Node.js, or loaded in a browser via Browserify or RequireJS). Additionally, you can include a standalone bundle of the SDK in your web page by fetching it from [unpkg](https://unpkg.com/):
3636

3737
```html
38+
<script src="https://unpkg.com/@optimizely/optimizely-sdk/dist/optimizely.browser.umd.min.js"></script>
39+
40+
<!-- You can also use the unminified version if necessary -->
3841
<script src="https://unpkg.com/@optimizely/optimizely-sdk/dist/optimizely.browser.umd.js"></script>
3942
```
4043

@@ -120,4 +123,4 @@ To regenerate this, run the following command:
120123
npx license-checker --production --json | jq 'map_values({ licenses, publisher, repository }) | del(.[][] | nulls)'
121124
```
122125

123-
and remove the self (`@optimizely/optimizely-sdk`) entry.
126+
and remove the self (`@optimizely/optimizely-sdk`) entry.

‎packages/optimizely-sdk/karma.bs.conf.js

Lines changed: 19 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -10,17 +10,21 @@ module.exports = function(config) {
1010
//plugins
1111
plugins: ['karma-mocha', 'karma-webpack', require('karma-browserstack-launcher')],
1212

13+
webpack: {
14+
mode: 'production',
15+
},
16+
1317
//browserStack setup
1418
browserStack: {
1519
username: process.env.BROWSER_STACK_USERNAME,
1620
accessKey: process.env.BROWSER_STACK_ACCESS_KEY
1721
},
1822

1923
// to avoid DISCONNECTED messages when connecting to BrowserStack
20-
browserDisconnectTimeout : 10000, // default 2000
21-
browserDisconnectTolerance : 1, // default 0
22-
browserNoActivityTimeout : 4*60*1000, //default 10000
23-
captureTimeout : 4*60*1000, //default 60000
24+
browserDisconnectTimeout: 10000, // default 2000
25+
browserDisconnectTolerance: 1, // default 0
26+
browserNoActivityTimeout: 4 * 60 * 1000, //default 10000
27+
captureTimeout: 4 * 60 * 1000, //default 60000
2428

2529
// define browsers
2630
customLaunchers: {
@@ -37,7 +41,7 @@ module.exports = function(config) {
3741
os_version: '10',
3842
browser: 'edge',
3943
device: null,
40-
browser_version: "15.0"
44+
browser_version: '15.0'
4145
},
4246
bs_firefox_mac: {
4347
base: 'BrowserStack',
@@ -48,11 +52,11 @@ module.exports = function(config) {
4852
},
4953
bs_ie: {
5054
base: 'BrowserStack',
51-
os: "Windows",
52-
os_version: "7",
53-
browser: "ie",
55+
os: 'Windows',
56+
os_version: '7',
57+
browser: 'ie',
5458
device: null,
55-
browser_version: "10.0"
59+
browser_version: '10.0'
5660
},
5761
bs_iphone6: {
5862
base: 'BrowserStack',
@@ -69,11 +73,11 @@ module.exports = function(config) {
6973
},
7074
bs_safari: {
7175
base: 'BrowserStack',
72-
os: "OS X",
73-
os_version: "Mountain Lion",
74-
browser: "safari",
76+
os: 'OS X',
77+
os_version: 'Mountain Lion',
78+
browser: 'safari',
7579
device: null,
76-
browser_version: "6.2"
80+
browser_version: '6.2'
7781
}
7882
},
7983

@@ -131,5 +135,5 @@ module.exports = function(config) {
131135
// Concurrency level
132136
// how many browser should be started simultaneous
133137
concurrency: Infinity
134-
})
135-
}
138+
});
139+
};

0 commit comments

Comments
 (0)