Adding polyfills #114

rorticus · 2017-09-11T11:30:33Z

Type: feature

The following has been addressed in the PR:

There is a related issue
All code matches the style guide
Unit or Functional tests are included in the PR

Description:

Polyfills (pepjs and intersection-observer) are now loaded in main.

An AMD loader configuration mixin is now provided to make loading polyfills easier. It injects a global function that you call to mix in the polyfill/dojo2 loader configuration with your existing configuration:

shimAmdDependencies({
    baseUrl: '/',
    packages: [ ... ]
});

The intern config for shim has been updated to support this configuration utility (and all loader config has been removed).

Resolves #106

rorticus · 2017-09-11T11:32:08Z

src/main.ts

+import './Symbol';
+import has from '@dojo/has/has';
+
+if (has('host-browser')) {


@kitsonk I couldn't just use the !has() string here because pepjs and intersection-observer error if loaded from node (they expect a browser). I can add the has checks before the require statements if you want?

Let's talk about this, because while TypeScript allows it, we don't want to have a require() in the code... We may need to use a dynamic import('pepjs'); instead of the require.

rorticus · 2017-09-11T11:32:53Z

src/support/tslib.ts

+
+import 'tslib';
+
+global.__values = function (o: any) {


We need to override the typescript __values function because it doesn't handle multibyte strings properly. This will let us use for...of with multibyte strings.

rorticus · 2017-09-11T11:34:18Z

tests/loader.ts

@@ -0,0 +1,16 @@
+intern.registerLoader((options) => {


Providing our own loader lets us configure and call our shimAmdDependencies method rather than including all the configuration in the intern config. It probably makes sense to have this loader (or something like it) available for other packages to use. Thoughts?

rorticus · 2017-09-11T11:56:00Z

tests/loader.ts

+	return intern.loadScript('node_modules/@dojo/loader/loader.js')
+		.then(() => intern.loadScript('./_build/src/util/amd.js'))
+		.then(() => {
+			(<any> require).config(shimAmdDependencies({


I tried adding the typings to require. As soon as I import @dojo/interfaces/loader, the file turns into an actual module instead of just a plain function and the whole thing breaks down in agony.

(require as any) and in a test case, the lack of typings is fine, though it would be good to put a comment in the code as to why you are casting.

rorticus · 2017-10-10T13:34:05Z

CI failures from typedoc

rorticus · 2017-10-10T14:36:46Z

Talked to @kitsonk and @matt-gadd , we agreed that we need to,

Separate out the browser polyfills into another module, like @dojo/shim/browser. This would ONLY load the polyfills.
Change the conditional require statements into the regular pragma stuff
Load JSDOM when running shim tests (https://github.com/dojo/test-extras/blob/master/src/support/loadJsdom.ts)

If JSDOM doesn't solve the problem ,leave out the DOM polyfills for right now.

rorticus · 2017-10-10T18:37:16Z

@kitsonk @matt-gadd Made the changes we talked about!

Added browsers module for browsers to import
Removed polyfills from @dojo/shim/main
Added more tests

kitsonk · 2017-10-11T20:44:26Z

I believe I am correct in assuming that this will require our tests and build to import '@dojo/shim'; as standard practice?

kitsonk

We should really update the README with details of these changes as they are fairly significant. Other than that, and a nit, looks 💯

kitsonk · 2017-10-11T20:46:57Z

tests/loader.ts

+	return intern.loadScript('node_modules/@dojo/loader/loader.js')
+		.then(() => intern.loadScript('./_build/src/util/amd.js'))
+		.then(() => {
+			(<any> require).config(shimAmdDependencies({


(require as any) and in a test case, the lack of typings is fine, though it would be good to put a comment in the code as to why you are casting.

rorticus · 2017-10-12T11:56:20Z

@kitsonk , I'll go ahead and update the README with some friendly words. You're correct about needing to import '@dojo/shim'.

rorticus · 2017-11-03T12:35:31Z

Added a dependency on dojo/grunt-dojo2#169 .

rorticus · 2017-11-10T14:19:54Z

PRs for after this is released,

rorticus requested review from kitsonk, matt-gadd and mwistrand September 11, 2017 11:30

rorticus commented Sep 11, 2017

View reviewed changes

rorticus force-pushed the issue-106 branch from d06b96b to 3e72e05 Compare September 11, 2017 11:51

rorticus changed the title ~~Issue 106~~ Adding polyfills Sep 11, 2017

rorticus requested a review from pottedmeat September 11, 2017 11:55

rorticus commented Sep 11, 2017

View reviewed changes

dylans added this to the 2017.09 milestone Sep 25, 2017

dylans modified the milestones: 2017.09, 2017.10 Oct 10, 2017

rorticus requested a review from agubler October 10, 2017 13:33

rorticus force-pushed the issue-106 branch from cbc27b5 to 4e3f79c Compare October 10, 2017 17:16

matt-gadd approved these changes Oct 11, 2017

View reviewed changes

kitsonk added beta4 breaking-change labels Oct 11, 2017

kitsonk reviewed Oct 11, 2017

View reviewed changes

kitsonk approved these changes Oct 13, 2017

View reviewed changes

rorticus force-pushed the issue-106 branch from a43d0f6 to a98800f Compare October 19, 2017 11:31

kitsonk modified the milestones: 2017.10, beta.4 Oct 30, 2017

rorticus added 2 commits November 1, 2017 07:44

Turning on importHelpers

6ea7452

Adding polyfills, issue dojo#106

54680c0

rorticus added 11 commits November 1, 2017 07:44

Refactoring based on discussion

18a9e0c

Adding intersection observer polyfill and functional tests

db657dd

Turning off typedoc

6b1b181

Adding tests for amd shim

5569817

Fixing test..

ac1e676

Adding import helpers back in

c83e17e

Updated README

40cd52d

Add blurb about browser module

292570a

README updates

eaccc3e

Updates for intern4

eb59c71

Intern 4 updates

b8cbccb

rorticus force-pushed the issue-106 branch from a98800f to b8cbccb Compare November 1, 2017 11:48

rorticus added 2 commits November 1, 2017 09:23

Fixing AMD tests

47c3a79

Adding downlevel iteration

717c758

kitsonk approved these changes Nov 1, 2017

View reviewed changes

Fix for iteration problem on windows

2ebc60c

matt-gadd approved these changes Nov 2, 2017

View reviewed changes

kitsonk approved these changes Nov 2, 2017

View reviewed changes

rorticus force-pushed the issue-106 branch from 99703ae to 2ebc60c Compare November 3, 2017 13:27

This was referenced Nov 6, 2017

Shim helpers dojo/core#365

Merged

Updating to use helpers from shim dojo/loader#149

Closed

Updating to use loader from grunt-dojo2 dojo/has#59

Closed

Using loader from grunt-dojo2 and tslib from shim dojo/i18n#103

Merged

Patching tslib __values for webpack builds

2d3cd74

This was referenced Nov 7, 2017

Updating to use intern loader from grunt-dojo2 and tslib/polyfills fr… dojo/widget-core#752

Merged

Importing ts helpers from shim, using intern loader from grunt-dojo2 dojo/widgets#369

Merged

rorticus merged commit f2594e2 into dojo:master Nov 10, 2017

rorticus mentioned this pull request Nov 10, 2017

Use of downlevelIteration #109

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adding polyfills #114

Adding polyfills #114

rorticus commented Sep 11, 2017 •

edited

Loading

rorticus Sep 11, 2017

kitsonk Sep 13, 2017

rorticus Sep 11, 2017

rorticus Sep 11, 2017 •

edited

Loading

rorticus Sep 11, 2017

kitsonk Oct 11, 2017

rorticus commented Oct 10, 2017

rorticus commented Oct 10, 2017 •

edited

Loading

rorticus commented Oct 10, 2017

kitsonk commented Oct 11, 2017

kitsonk left a comment

kitsonk Oct 11, 2017

rorticus commented Oct 12, 2017

rorticus commented Nov 3, 2017

rorticus commented Nov 10, 2017

Adding polyfills #114

Adding polyfills #114

Conversation

rorticus commented Sep 11, 2017 • edited Loading

rorticus Sep 11, 2017

Choose a reason for hiding this comment

kitsonk Sep 13, 2017

Choose a reason for hiding this comment

rorticus Sep 11, 2017

Choose a reason for hiding this comment

rorticus Sep 11, 2017 • edited Loading

Choose a reason for hiding this comment

rorticus Sep 11, 2017

Choose a reason for hiding this comment

kitsonk Oct 11, 2017

Choose a reason for hiding this comment

rorticus commented Oct 10, 2017

rorticus commented Oct 10, 2017 • edited Loading

rorticus commented Oct 10, 2017

kitsonk commented Oct 11, 2017

kitsonk left a comment

Choose a reason for hiding this comment

kitsonk Oct 11, 2017

Choose a reason for hiding this comment

rorticus commented Oct 12, 2017

rorticus commented Nov 3, 2017

rorticus commented Nov 10, 2017

rorticus commented Sep 11, 2017 •

edited

Loading

rorticus Sep 11, 2017 •

edited

Loading

rorticus commented Oct 10, 2017 •

edited

Loading