Skip to content

deconflict referenced globals #1092

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 11, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@
"eslint-plugin-import": "^2.2.0",
"estree-walker": "^0.5.1",
"glob": "^7.1.1",
"is-reference": "^1.1.0",
"jsdom": "^11.1.0",
"locate-character": "^2.0.0",
"magic-string": "^0.22.3",
Expand Down
9 changes: 7 additions & 2 deletions src/generators/Generator.ts
Original file line number Diff line number Diff line change
Expand Up @@ -410,11 +410,16 @@ export default class Generator {
const indentationLevel = getIndentationLevel(source, js.content.body[0].start);
const indentExclusionRanges = getIndentExclusionRanges(js.content);

const scope = annotateWithScopes(js.content);
const { scope, globals } = annotateWithScopes(js.content);

scope.declarations.forEach(name => {
this.userVars.add(name);
});

globals.forEach(name => {
this.userVars.add(name);
});

const body = js.content.body.slice(); // slice, because we're going to be mutating the original

// imports need to be hoisted out of the IIFE
Expand Down Expand Up @@ -666,7 +671,7 @@ export default class Generator {
isEventHandler: boolean
) => {
this.addSourcemapLocations(node); // TODO this involves an additional walk — can we roll it in somewhere else?
let scope = annotateWithScopes(node);
let { scope } = annotateWithScopes(node);

const dependencies: Set<string> = new Set();

Expand Down
2 changes: 1 addition & 1 deletion src/generators/dom/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -407,7 +407,7 @@ export default function dom(
const code = new MagicString(str);
const expression = parseExpressionAt(str, 0);

let scope = annotateWithScopes(expression);
let { scope } = annotateWithScopes(expression);

walk(expression, {
enter(node: Node, parent: Node) {
Expand Down
10 changes: 8 additions & 2 deletions src/utils/annotateWithScopes.ts
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
import { walk } from 'estree-walker';
import isReference from 'is-reference';
import { Node } from '../interfaces';

export default function annotateWithScopes(expression: Node) {
const globals = new Set();
let scope = new Scope(null, false);

walk(expression, {
enter(node: Node) {
enter(node: Node, parent: Node) {
if (/Function/.test(node.type)) {
if (node.type === 'FunctionDeclaration') {
scope.declarations.add(node.id.name);
Expand All @@ -25,6 +27,10 @@ export default function annotateWithScopes(expression: Node) {
node._scope = scope = new Scope(scope, true);
} else if (/(Function|Class|Variable)Declaration/.test(node.type)) {
scope.addDeclaration(node);
} else if (isReference(node, parent)) {
if (!scope.has(node.name)) {
globals.add(node.name);
}
}
},

Expand All @@ -35,7 +41,7 @@ export default function annotateWithScopes(expression: Node) {
},
});

return scope;
return { scope, globals };
}

export class Scope {
Expand Down
221 changes: 221 additions & 0 deletions test/js/samples/deconflict-globals/expected-bundle.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,221 @@
function noop() {}

function assign(target) {
var k,
source,
i = 1,
len = arguments.length;
for (; i < len; i++) {
source = arguments[i];
for (k in source) target[k] = source[k];
}

return target;
}

function blankObject() {
return Object.create(null);
}

function destroy(detach) {
this.destroy = noop;
this.fire('destroy');
this.set = this.get = noop;

if (detach !== false) this._fragment.u();
this._fragment.d();
this._fragment = this._state = null;
}

function differs(a, b) {
return a !== b || ((a && typeof a === 'object') || typeof a === 'function');
}

function dispatchObservers(component, group, changed, newState, oldState) {
for (var key in group) {
if (!changed[key]) continue;

var newValue = newState[key];
var oldValue = oldState[key];

var callbacks = group[key];
if (!callbacks) continue;

for (var i = 0; i < callbacks.length; i += 1) {
var callback = callbacks[i];
if (callback.__calling) continue;

callback.__calling = true;
callback.call(component, newValue, oldValue);
callback.__calling = false;
}
}
}

function fire(eventName, data) {
var handlers =
eventName in this._handlers && this._handlers[eventName].slice();
if (!handlers) return;

for (var i = 0; i < handlers.length; i += 1) {
handlers[i].call(this, data);
}
}

function get(key) {
return key ? this._state[key] : this._state;
}

function init(component, options) {
component._observers = { pre: blankObject(), post: blankObject() };
component._handlers = blankObject();
component._bind = options._bind;

component.options = options;
component.root = options.root || component;
component.store = component.root.store || options.store;
}

function observe(key, callback, options) {
var group = options && options.defer
? this._observers.post
: this._observers.pre;

(group[key] || (group[key] = [])).push(callback);

if (!options || options.init !== false) {
callback.__calling = true;
callback.call(this, this._state[key]);
callback.__calling = false;
}

return {
cancel: function() {
var index = group[key].indexOf(callback);
if (~index) group[key].splice(index, 1);
}
};
}

function on(eventName, handler) {
if (eventName === 'teardown') return this.on('destroy', handler);

var handlers = this._handlers[eventName] || (this._handlers[eventName] = []);
handlers.push(handler);

return {
cancel: function() {
var index = handlers.indexOf(handler);
if (~index) handlers.splice(index, 1);
}
};
}

function set(newState) {
this._set(assign({}, newState));
if (this.root._lock) return;
this.root._lock = true;
callAll(this.root._beforecreate);
callAll(this.root._oncreate);
callAll(this.root._aftercreate);
this.root._lock = false;
}

function _set(newState) {
var oldState = this._state,
changed = {},
dirty = false;

for (var key in newState) {
if (differs(newState[key], oldState[key])) changed[key] = dirty = true;
}
if (!dirty) return;

this._state = assign({}, oldState, newState);
this._recompute(changed, this._state);
if (this._bind) this._bind(changed, this._state);

if (this._fragment) {
dispatchObservers(this, this._observers.pre, changed, this._state, oldState);
this._fragment.p(changed, this._state);
dispatchObservers(this, this._observers.post, changed, this._state, oldState);
}
}

function callAll(fns) {
while (fns && fns.length) fns.pop()();
}

function _mount(target, anchor) {
this._fragment.m(target, anchor);
}

function _unmount() {
if (this._fragment) this._fragment.u();
}

var proto = {
destroy: destroy,
get: get,
fire: fire,
observe: observe,
on: on,
set: set,
teardown: destroy,
_recompute: noop,
_set: _set,
_mount: _mount,
_unmount: _unmount
};

/* generated by Svelte vX.Y.Z */
function data_1() {
return {
foo: 'bar'
};
}

function oncreate() {
alert(JSON.stringify(data()));
}

function create_main_fragment(state, component) {

return {
c: noop,

m: noop,

p: noop,

u: noop,

d: noop
};
}

function SvelteComponent(options) {
init(this, options);
this._state = assign(data_1(), options.data);

var _oncreate = oncreate.bind(this);

if (!options.root) {
this._oncreate = [_oncreate];
} else {
this.root._oncreate.push(_oncreate);
}

this._fragment = create_main_fragment(this._state, this);

if (options.target) {
this._fragment.c();
this._fragment.m(options.target, options.anchor || null);

callAll(this._oncreate);
}
}

assign(SvelteComponent.prototype, proto);

export default SvelteComponent;
52 changes: 52 additions & 0 deletions test/js/samples/deconflict-globals/expected.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
/* generated by Svelte vX.Y.Z */
import { assign, callAll, init, noop, proto } from "svelte/shared.js";

function data_1() {
return {
foo: 'bar'
};
}

function oncreate() {
alert(JSON.stringify(data()));
};

function create_main_fragment(state, component) {

return {
c: noop,

m: noop,

p: noop,

u: noop,

d: noop
};
}

function SvelteComponent(options) {
init(this, options);
this._state = assign(data_1(), options.data);

var _oncreate = oncreate.bind(this);

if (!options.root) {
this._oncreate = [_oncreate];
} else {
this.root._oncreate.push(_oncreate);
}

this._fragment = create_main_fragment(this._state, this);

if (options.target) {
this._fragment.c();
this._fragment.m(options.target, options.anchor || null);

callAll(this._oncreate);
}
}

assign(SvelteComponent.prototype, proto);
export default SvelteComponent;
11 changes: 11 additions & 0 deletions test/js/samples/deconflict-globals/input.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<script>
export default {
data: () => ({
foo: 'bar'
}),

oncreate() {
alert(JSON.stringify(data()));
}
};
</script>
10 changes: 10 additions & 0 deletions yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@
# yarn lockfile v1


"@types/[email protected]":
version "0.0.38"
resolved "https://registry.yarnpkg.com/@types/estree/-/estree-0.0.38.tgz#c1be40aa933723c608820a99a373a16d215a1ca2"

"@types/mocha@^2.2.41":
version "2.2.44"
resolved "https://registry.yarnpkg.com/@types/mocha/-/mocha-2.2.44.tgz#1d4a798e53f35212fd5ad4d04050620171cd5b5e"
Expand Down Expand Up @@ -1635,6 +1639,12 @@ is-property@^1.0.0:
version "1.0.2"
resolved "https://registry.yarnpkg.com/is-property/-/is-property-1.0.2.tgz#57fe1c4e48474edd65b09911f26b1cd4095dda84"

is-reference@^1.1.0:
version "1.1.0"
resolved "https://registry.yarnpkg.com/is-reference/-/is-reference-1.1.0.tgz#50e6ef3f64c361e2c53c0416cdc9420037f2685b"
dependencies:
"@types/estree" "0.0.38"

is-resolvable@^1.0.0:
version "1.0.0"
resolved "https://registry.yarnpkg.com/is-resolvable/-/is-resolvable-1.0.0.tgz#8df57c61ea2e3c501408d100fb013cf8d6e0cc62"
Expand Down