Fix client on pages that define a variable called global
#3385
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Modules which assume the existence of a global variable called "global" (which exists in Node) are wrapped by Browserify during the build which normally results in "global" being aliased to "self" or "window" in a browser environment. If code on the page into which H is loaded defines a global variable called "global" however, that gets used instead and this can break such modules. In the case of https://www.civilsprep.com, "global" is a reference to a DOM node for example. This commit fixes the issue by only aliasing "global" (as seen by the module using it) to either "window" or "self" and not to any existing variable called "global". Fixes #2723
[BUG] Annotator.Util undefined on pages that define a variable called 
Current coverage is 74.03%
@@ master #3385 diff @@
==========================================
Files 131 131
Lines 4732 4732
Methods 0 0
Messages 0 0
Branches 559 559
==========================================
Hits 3503 3503
+ Misses 1152 1149 -3
- Partials 77 80 +3
|
|
LGTM. Tested it on the page and injecting the client works as expected now 👍 |
robertknight
added a commit
to hypothesis/client
that referenced
this pull request
Mar 10, 2017
Fix client failing to load on pages that define `self` to be something other than `window`. When AnnotatorJS is bundled by browserify, it is first processed by browserify-shim* which adds references to a variable called 'global', which exists in Node but not the browser. Browserify then processes the result and assigns `global` to the value of the first variable from ['global', 'self', 'window'] which is already defined. hypothesis/h#3385 fixed the problem when the page defines a variable called 'global' that is not an alias for 'window' by reducing this list to ['self', 'window']. This still leaves pages that define 'self'. This commit fixes the problem by always making `global` (within CommonJS modules) always be assigned the value of `window`. * browserify-shim deals with the fact that AnnotatorJS 1.2.x is not a CommonJS module and exports its entry point as `window.Annotator`.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Modules which assume the existence of a global variable called "global"
(which exists in Node) are wrapped by Browserify during the build which
normally results in "global" being aliased to "self" or "window" in a
browser environment.
If code on the page into which H is loaded defines a global variable
called "global" however, that gets used instead and this can break such
modules. In the case of https://www.civilsprep.com, "global" is a
reference to a DOM node for example.
This commit fixes the issue by only aliasing "global" (as seen by the
module using it) to either "window" or "self" and not to any existing
variable called "global".
Fixes #2723