fix(bundling): Publish the unminified UMD bundle along with the minified one #187

mikeproeng37 · 2018-11-14T21:41:52Z

Summary

We need to build and publish the unminified bundle to NPM as we publicly refer to it in our docs.

This is the output of cleaning the local /dist directory and building manually with npm run build-browser-umd:

Hash: 1e3850c525529035af49
Version: webpack 2.7.0
Time: 1222ms
                        Asset     Size  Chunks             Chunk Names
optimizely.browser.umd.min.js  82.8 kB       0  [emitted]  main
   [1] ./lib/utils/enums/index.js 11.8 kB {0} [built]
   [3] ./~/sprintf-js/src/sprintf.js 8.67 kB {0} [built]
   [4] ./lib/utils/fns/index.js 1.21 kB {0} [built]
  [44] ./lib/utils/config_validator/index.js 2.95 kB {0} [built]
  [74] ./lib/optimizely/index.js 28.7 kB {0} [built]
  [75] ./lib/plugins/error_handler/index.js 809 bytes {0} [built]
  [76] ./lib/plugins/event_dispatcher/index.browser.js 2.42 kB {0} [built]
  [77] ./lib/plugins/logger/index.js 4.09 kB {0} [built]
  [84] ./lib/index.browser.js 2.78 kB {0} [built]
  [85] ./lib/optimizely/project_config_schema.js 7.02 kB {0} [built]
  [87] ./lib/utils/event_tags_validator/index.js 1.29 kB {0} [built]
  [88] ./lib/utils/string_value_validator/index.js 864 bytes {0} [built]
  [89] ./lib/utils/user_profile_service_validator/index.js 2.14 kB {0} [built]
 [190] ./~/lodash/forEach.js 1.35 kB {0} [built]
 [193] ./~/lodash/isEmpty.js 2 kB {0} [built]
    + 194 hidden modules
Hash: 41332d833233093fb3ac
Version: webpack 2.7.0
Time: 458ms
                    Asset    Size  Chunks                    Chunk Names
optimizely.browser.umd.js  319 kB       0  [emitted]  [big]  main
   [1] ./lib/utils/enums/index.js 11.8 kB {0} [built]
   [3] ./~/sprintf-js/src/sprintf.js 8.67 kB {0} [built]
   [4] ./lib/utils/fns/index.js 1.21 kB {0} [built]
  [44] ./lib/utils/config_validator/index.js 2.95 kB {0} [built]
  [74] ./lib/optimizely/index.js 28.7 kB {0} [built]
  [75] ./lib/plugins/error_handler/index.js 809 bytes {0} [built]
  [76] ./lib/plugins/event_dispatcher/index.browser.js 2.42 kB {0} [built]
  [77] ./lib/plugins/logger/index.js 4.09 kB {0} [built]
  [84] ./lib/index.browser.js 2.78 kB {0} [built]
  [85] ./lib/optimizely/project_config_schema.js 7.02 kB {0} [built]
  [87] ./lib/utils/event_tags_validator/index.js 1.29 kB {0} [built]
  [88] ./lib/utils/string_value_validator/index.js 864 bytes {0} [built]
  [89] ./lib/utils/user_profile_service_validator/index.js 2.14 kB {0} [built]
 [190] ./~/lodash/forEach.js 1.35 kB {0} [built]
 [193] ./~/lodash/isEmpty.js 2 kB {0} [built]
    + 194 hidden modules
total 792
-rw-r--r--  1 mng  staff  319465 Nov 14 13:49 optimizely.browser.umd.js
-rw-r--r--  1 mng  staff   83743 Nov 14 13:49 optimizely.browser.umd.min.js

Testing

Manually loaded both min and unminified files in the browser and verified that window.optimizelySdk and window.optimizelyClient are accessible.

…ed one.

tylerbrandt · 2018-11-14T21:42:52Z

packages/optimizely-sdk/README.md

@@ -36,6 +36,9 @@ The package's entry point is a CommonJS module, which can be used directly in en

 ```html
 <script src="https://unpkg.com/@optimizely/optimizely-sdk/dist/optimizely.browser.umd.js"></script>


Drop this? There is no reason for anyone to ever use the unminified version this way.

Hmm this has actually been requested before: #57

At least, we should lead with the minified version

tylerbrandt · 2018-11-14T21:43:41Z

packages/optimizely-sdk/scripts/build_browser_umd.sh

@@ -26,3 +26,28 @@ Object.defineProperty(window, 'optimizelyClient', {
 });
 EOF

+# Builds the unminified bundle
+npx webpack lib/index.browser.js dist/optimizely.browser.umd.js \
+  --define process.env.NODE_ENV="production" \


shouldn't it be "development"? I don't get how "production" would produce an unminified bundle.

minification is specified with a different flag: --optimize-minimize. I still think this should be a prod, yet unminified bundle since it might be used in production

@mikeng13 explained: -p is equivalent to this config plus --optimize-minimize, so this is just ensuring that only the --optimize-minimize part is skipped.

tylerbrandt · 2018-11-14T21:48:08Z

Can you include the output of this command in the PR summary?

rm -rf dist && npm run build-browser-umd && ls -l dist

tylerbrandt · 2018-11-14T21:51:00Z

packages/optimizely-sdk/scripts/build_browser_umd.sh

+  --output-library="$BUNDLE_NAME"
+
+# Append some backwards-compatibility code to the bundle
+cat - >> dist/optimizely.browser.umd.min.js <<EOF


This should be .umd.js right?

Oops, yeah thanks for catching

tylerbrandt

Update CHANGELOG (unreleased section) and we should be good to go

tylerbrandt · 2018-11-14T21:59:18Z

packages/optimizely-sdk/README.md

@@ -36,6 +36,9 @@ The package's entry point is a CommonJS module, which can be used directly in en

 ```html
 <script src="https://unpkg.com/@optimizely/optimizely-sdk/dist/optimizely.browser.umd.js"></script>


At least, we should lead with the minified version

tylerbrandt · 2018-11-14T22:05:43Z

## 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

fix(bundling): Publish the unminified UMDbundle along with the minifi…

9232627

…ed one.

mikeproeng37 requested review from tylerbrandt and mjc1283 November 14, 2018 21:41

tylerbrandt reviewed Nov 14, 2018

View reviewed changes

mikeproeng37 changed the title ~~fix(bundling): Publish the unminified UMDbundle along with the minified one~~ fix(bundling): Publish the unminified UMD bundle along with the minified one Nov 14, 2018

fix: Append compat code to the unminified bundle.

6dc22da

tylerbrandt approved these changes Nov 14, 2018

View reviewed changes

chore: Add unreleased entry to changelog.

2458d46

mikeproeng37 merged commit 240f7ed into 2.3.x Nov 14, 2018

mikeproeng37 mentioned this pull request Nov 14, 2018

chore: Prepare for 2.3.1 release. #188

Merged

tylerbrandt mentioned this pull request Nov 14, 2018

refactor(dist): update bundled files #189

Merged

mikeproeng37 deleted the mng/fix-umd-bundle branch December 14, 2018 20:06

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix(bundling): Publish the unminified UMD bundle along with the minified one #187

fix(bundling): Publish the unminified UMD bundle along with the minified one #187

Uh oh!

mikeproeng37 commented Nov 14, 2018 •

edited

Loading

Uh oh!

tylerbrandt Nov 14, 2018

Uh oh!

mikeproeng37 Nov 14, 2018

Uh oh!

tylerbrandt Nov 14, 2018

Uh oh!

tylerbrandt Nov 14, 2018

Uh oh!

mikeproeng37 Nov 14, 2018

Uh oh!

tylerbrandt Nov 14, 2018

Uh oh!

tylerbrandt commented Nov 14, 2018

Uh oh!

tylerbrandt Nov 14, 2018

Uh oh!

mikeproeng37 Nov 14, 2018

Uh oh!

tylerbrandt left a comment

Uh oh!

tylerbrandt Nov 14, 2018

Uh oh!

tylerbrandt commented Nov 14, 2018

Uh oh!

Uh oh!

		@@ -36,6 +36,9 @@ The package's entry point is a CommonJS module, which can be used directly in en

		```html
		<script src="https://unpkg.com/@optimizely/optimizely-sdk/dist/optimizely.browser.umd.js"></script>

fix(bundling): Publish the unminified UMD bundle along with the minified one #187

fix(bundling): Publish the unminified UMD bundle along with the minified one #187

Uh oh!

Conversation

mikeproeng37 commented Nov 14, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Testing

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tylerbrandt commented Nov 14, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tylerbrandt left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tylerbrandt commented Nov 14, 2018

Uh oh!

Uh oh!

mikeproeng37 commented Nov 14, 2018 •

edited

Loading