From 0a776982280072be509c2253ed33f8aef82843f7 Mon Sep 17 00:00:00 2001 From: brndn Date: Tue, 14 Jun 2016 12:05:01 -0700 Subject: [PATCH] Add pass to extract ES6 class definitions out of non-simple contexts. Currently, JSCompiler only transpiles ES6 classes that appear as declarations or simple assignments in the original source code. Classes in other contexts are rejected as compilation errors. There's no deep reason for this restriction. JSCompiler should accept ES6 classes anywhere they can appear according to the grammar of the language. This CL adds a pass that runs before the main Es6ToEs3Converter pass. It replaces class definitions in complex contexts: ``` f(class{ /* ... */}); ``` with an immediately preceding alias: ------------- Created by MOE: https://github.com/google/moe MOE_MIGRATED_REVID=124866181 --- .../javascript/jscomp/ES6ModuleLoader.java | 27 +++-- .../javascript/jscomp/Es6ExtractClasses.java | 104 ++++++++++++++++++ .../jscomp/ExpressionDecomposer.java | 2 + .../jscomp/TranspilationPasses.java | 10 ++ .../jscomp/Es6ExtractClassesTest.java | 89 +++++++++++++++ .../jscomp/ExpressionDecomposerTest.java | 86 ++++++++++++--- 6 files changed, 294 insertions(+), 24 deletions(-) create mode 100644 src/com/google/javascript/jscomp/Es6ExtractClasses.java create mode 100644 test/com/google/javascript/jscomp/Es6ExtractClassesTest.java diff --git a/src/com/google/javascript/jscomp/ES6ModuleLoader.java b/src/com/google/javascript/jscomp/ES6ModuleLoader.java index 8025d6f3b9c..673fae01f01 100644 --- a/src/com/google/javascript/jscomp/ES6ModuleLoader.java +++ b/src/com/google/javascript/jscomp/ES6ModuleLoader.java @@ -188,21 +188,28 @@ static boolean isAbsoluteIdentifier(String name) { return name.startsWith(MODULE_SLASH); } + /** + * Turns a filename into a JS identifier that can be used in rewritten code. + * Removes leading ./, replaces / with $, removes trailing .js + * and replaces - with _. + */ + public static String toJSIdentifier(URI filename) { + return stripJsExtension(filename.toString()) + .replaceAll("^\\." + Pattern.quote(MODULE_SLASH), "") + .replace(MODULE_SLASH, "$") + .replace('\\', '$') + .replace('-', '_') + .replace(':', '_') + .replace('.', '_') + .replace("%20", "_"); + } + /** * Turns a filename into a JS identifier that is used for moduleNames in * rewritten code. Removes leading ./, replaces / with $, removes trailing .js * and replaces - with _. All moduleNames get a "module$" prefix. */ public static String toModuleName(URI filename) { - String moduleName = - stripJsExtension(filename.toString()) - .replaceAll("^\\." + Pattern.quote(MODULE_SLASH), "") - .replace(MODULE_SLASH, "$") - .replace('\\', '$') - .replace('-', '_') - .replace(':', '_') - .replace('.', '_') - .replace("%20", "_"); - return "module$" + moduleName; + return "module$" + toJSIdentifier(filename); } } diff --git a/src/com/google/javascript/jscomp/Es6ExtractClasses.java b/src/com/google/javascript/jscomp/Es6ExtractClasses.java new file mode 100644 index 00000000000..f63af0fcf20 --- /dev/null +++ b/src/com/google/javascript/jscomp/Es6ExtractClasses.java @@ -0,0 +1,104 @@ +/* + * Copyright 2016 The Closure Compiler Authors. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.google.javascript.jscomp; + +import com.google.javascript.jscomp.ExpressionDecomposer.DecompositionType; +import com.google.javascript.rhino.IR; +import com.google.javascript.rhino.Node; +import com.google.javascript.rhino.Token; + +import java.util.HashSet; +import java.util.Set; + +/** + * Extracts ES6 classes defined in function calls to local constants. + *

+ * Example: + * Before: foo(class { constructor() {} }); + * After: + * + * const $jscomp$classdecl$var0 = class { constructor() {} }; + * foo($jscomp$classdecl$var0); + * + *

+ * This must be done before {@link Es6ToEs3Converter}, because that pass only handles classes + * that are declarations or simple assignments. + * @see Es6ToEs3Converter#visitClass(Node, Node) + */ +public final class Es6ExtractClasses + extends NodeTraversal.AbstractPostOrderCallback implements HotSwapCompilerPass { + + private static final String CLASS_DECL_VAR = "$classdecl$var"; + + private final AbstractCompiler compiler; + private final ExpressionDecomposer expressionDecomposer; + private int classDeclVarCounter = 0; + + Es6ExtractClasses(AbstractCompiler compiler) { + this.compiler = compiler; + Set consts = new HashSet<>(); + this.expressionDecomposer = new ExpressionDecomposer( + compiler, + compiler.getUniqueNameIdSupplier(), + consts, + Scope.createGlobalScope(new Node(Token.SCRIPT))); + } + + @Override + public void process(Node externs, Node root) { + NodeTraversal.traverseRootsEs6(compiler, this, externs, root); + } + + @Override + public void hotSwapScript(Node scriptRoot, Node originalRoot) { + NodeTraversal.traverseEs6(compiler, scriptRoot, this); + } + + @Override + public void visit(NodeTraversal t, Node n, Node parent) { + if (n.isClass() && shouldExtractClass(n, parent)) { + extractClass(n, parent); + } + } + + private boolean shouldExtractClass(Node classNode, Node parent) { + if (NodeUtil.isClassDeclaration(classNode) + || parent.isName() + || (parent.isAssign() && parent.getParent().isExprResult())) { + // No need to extract. Handled directly by Es6ToEs3Converter.ClassDeclarationMetadata#create. + return false; + } + // Don't extract the class if it's not safe to do so. For example, + // var c = maybeTrue() && class extends someSideEffect() {}; + // TODO(brndn): it is possible to be less conservative. If the classNode is DECOMPOSABLE, + // we could use the expression decomposer to move it out of the way. + return expressionDecomposer.canExposeExpression(classNode) == DecompositionType.MOVABLE; + } + + private void extractClass(Node classNode, Node parent) { + String name = ES6ModuleLoader.toJSIdentifier( + ES6ModuleLoader.createUri(classNode.getStaticSourceFile().getName())) + + CLASS_DECL_VAR + + (classDeclVarCounter++); + Node statement = NodeUtil.getEnclosingStatement(parent); + parent.replaceChild(classNode, IR.name(name)); + Node classDeclaration = IR.constNode(IR.name(name), classNode) + .useSourceInfoIfMissingFromForTree(classNode); + statement.getParent().addChildBefore(classDeclaration, statement); + compiler.reportCodeChange(); + } +} diff --git a/src/com/google/javascript/jscomp/ExpressionDecomposer.java b/src/com/google/javascript/jscomp/ExpressionDecomposer.java index ba95920b2e8..f5ef34f264e 100644 --- a/src/com/google/javascript/jscomp/ExpressionDecomposer.java +++ b/src/com/google/javascript/jscomp/ExpressionDecomposer.java @@ -672,6 +672,8 @@ static Node findExpressionRoot(Node subExpression) { case RETURN: case THROW: case VAR: + case CONST: + case LET: Preconditions.checkState(child == parent.getFirstChild()); return parent; // Any of these indicate an unsupported expression: diff --git a/src/com/google/javascript/jscomp/TranspilationPasses.java b/src/com/google/javascript/jscomp/TranspilationPasses.java index 3694a843ca9..f2ec1048925 100644 --- a/src/com/google/javascript/jscomp/TranspilationPasses.java +++ b/src/com/google/javascript/jscomp/TranspilationPasses.java @@ -50,12 +50,22 @@ public static void addEs6EarlyPasses(List passes) { */ public static void addEs6LatePasses(List passes) { passes.add(es6ConvertSuper); + passes.add(es6ExtractClasses); passes.add(convertEs6ToEs3); passes.add(rewriteBlockScopedDeclaration); passes.add(rewriteGenerators); passes.add(rewritePolyfills); } + + static final HotSwapPassFactory es6ExtractClasses = + new HotSwapPassFactory("Es6ExtractClasses", true) { + @Override + protected HotSwapCompilerPass create(AbstractCompiler compiler) { + return new Es6ExtractClasses(compiler); + } + }; + static final HotSwapPassFactory es6RewriteDestructuring = new HotSwapPassFactory("Es6RewriteDestructuring", true) { @Override diff --git a/test/com/google/javascript/jscomp/Es6ExtractClassesTest.java b/test/com/google/javascript/jscomp/Es6ExtractClassesTest.java new file mode 100644 index 00000000000..67c92b0d4eb --- /dev/null +++ b/test/com/google/javascript/jscomp/Es6ExtractClassesTest.java @@ -0,0 +1,89 @@ +/* + * Copyright 2016 The Closure Compiler Authors. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.google.javascript.jscomp; + +import com.google.javascript.jscomp.CompilerOptions.LanguageMode; + +public final class Es6ExtractClassesTest extends CompilerTestCase { + + @Override + protected CompilerPass getProcessor(Compiler compiler) { + return new Es6ExtractClasses(compiler); + } + + @Override + protected void setUp() { + setAcceptedLanguage(LanguageMode.ECMASCRIPT6); + disableTypeCheck(); + runTypeCheckAfterProcessing = true; + } + + public void testExtractionFromCall() { + test( + "f(class{});", + LINE_JOINER.join( + "const testcode$classdecl$var0 = class {};", "f(testcode$classdecl$var0);")); + } + + public void testConstAssignment() { + test( + "var foo = bar(class {});", + LINE_JOINER.join( + "const testcode$classdecl$var0 = class {};", + "var foo = bar(testcode$classdecl$var0);")); + } + + public void testLetAssignment() { + test( + "let foo = bar(class {});", + LINE_JOINER.join( + "const testcode$classdecl$var0 = class {};", + "let foo = bar(testcode$classdecl$var0);")); + } + + public void testVarAssignment() { + test( + "var foo = bar(class {});", + LINE_JOINER.join( + "const testcode$classdecl$var0 = class {};", + "var foo = bar(testcode$classdecl$var0);")); + } + + public void testConditionalBlocksExtractionFromCall() { + testSame("maybeTrue() && f(class{});"); + } + + public void testExtractionFromArrayLiteral() { + test( + "var c = [class C {}];", + LINE_JOINER.join( + "const testcode$classdecl$var0 = class C {};", "var c = [testcode$classdecl$var0];")); + } + + public void testConditionalBlocksExtractionFromArrayLiteral() { + testSame("var c = maybeTrue() && [class {}]"); + } + + public void testTernaryOperatorBlocksExtraction() { + testSame("var c = maybeTrue() ? class A {} : class B {}"); + } + + public void testClassesHandledByEs6ToEs3Converter() { + testSame("class C{}"); + testSame("var c = class {};"); + } +} diff --git a/test/com/google/javascript/jscomp/ExpressionDecomposerTest.java b/test/com/google/javascript/jscomp/ExpressionDecomposerTest.java index 247aee4302a..5547b16c4e3 100644 --- a/test/com/google/javascript/jscomp/ExpressionDecomposerTest.java +++ b/test/com/google/javascript/jscomp/ExpressionDecomposerTest.java @@ -69,6 +69,10 @@ public void testCanExposeExpression2() { DecompositionType.MOVABLE, "x = foo()", "foo"); helperCanExposeExpression( DecompositionType.MOVABLE, "var x = foo()", "foo"); + helperCanExposeExpression( + DecompositionType.MOVABLE, "const x = foo()", "foo"); + helperCanExposeExpression( + DecompositionType.MOVABLE, "let x = foo()", "foo"); helperCanExposeExpression( DecompositionType.MOVABLE, "if(foo()){}", "foo"); helperCanExposeExpression( @@ -98,6 +102,10 @@ public void testCanExposeExpression3() { DecompositionType.DECOMPOSABLE, "x = 1 || foo()", "foo"); helperCanExposeExpression( DecompositionType.DECOMPOSABLE, "var x = 1 ? foo() : 0", "foo"); + helperCanExposeExpression( + DecompositionType.DECOMPOSABLE, "const x = 1 ? foo() : 0", "foo"); + helperCanExposeExpression( + DecompositionType.DECOMPOSABLE, "let x = 1 ? foo() : 0", "foo"); helperCanExposeExpression( DecompositionType.DECOMPOSABLE, "goo() && foo()", "foo"); @@ -107,6 +115,10 @@ public void testCanExposeExpression3() { DecompositionType.DECOMPOSABLE, "x += goo() && foo()", "foo"); helperCanExposeExpression( DecompositionType.DECOMPOSABLE, "var x = goo() && foo()", "foo"); + helperCanExposeExpression( + DecompositionType.DECOMPOSABLE, "const x = goo() && foo()", "foo"); + helperCanExposeExpression( + DecompositionType.DECOMPOSABLE, "let x = goo() && foo()", "foo"); helperCanExposeExpression( DecompositionType.DECOMPOSABLE, "if(goo() && foo()){}", "foo"); helperCanExposeExpression( @@ -213,48 +225,62 @@ public void testMoveExpression3() { } public void testMoveExpression4() { + helperMoveExpression( + "const x = foo()", + "foo", + "var result$$0 = foo(); const x = result$$0;"); + } + + public void testMoveExpression5() { + helperMoveExpression( + "let x = foo()", + "foo", + "var result$$0 = foo(); let x = result$$0;"); + } + + public void testMoveExpression6() { helperMoveExpression( "if(foo()){}", "foo", "var result$$0 = foo(); if (result$$0);"); } - public void testMoveExpression5() { + public void testMoveExpression7() { helperMoveExpression( "switch(foo()){}", "foo", "var result$$0 = foo(); switch(result$$0){}"); } - public void testMoveExpression6() { + public void testMoveExpression8() { helperMoveExpression( "switch(1 + foo()){}", "foo", "var result$$0 = foo(); switch(1 + result$$0){}"); } - public void testMoveExpression7() { + public void testMoveExpression9() { helperMoveExpression( "function f(){ return foo();}", "foo", "function f(){ var result$$0 = foo(); return result$$0;}"); } - public void testMoveExpression8() { + public void testMoveExpression10() { helperMoveExpression( "x = foo() && 1", "foo", "var result$$0 = foo(); x = result$$0 && 1"); } - public void testMoveExpression9() { + public void testMoveExpression11() { helperMoveExpression( "x = foo() || 1", "foo", "var result$$0 = foo(); x = result$$0 || 1"); } - public void testMoveExpression10() { + public void testMoveExpression12() { helperMoveExpression( "x = foo() ? 0 : 1", "foo", @@ -286,20 +312,36 @@ public void testExposeExpression3() { } public void testExposeExpression4() { + helperExposeExpression( + "const x = 1 ? foo() : 0", + "foo", + "var temp$$0;" + + " if (1) temp$$0 = foo(); else temp$$0 = 0;const x = temp$$0;"); + } + + public void testExposeExpression5() { + helperExposeExpression( + "let x = 1 ? foo() : 0", + "foo", + "var temp$$0;" + + " if (1) temp$$0 = foo(); else temp$$0 = 0;let x = temp$$0;"); + } + + public void testExposeExpression6() { helperExposeExpression( "goo() && foo()", "foo", "if (goo()) foo();"); } - public void testExposeExpression5() { + public void testExposeExpression7() { helperExposeExpression( "x = goo() && foo()", "foo", "var temp$$0; if (temp$$0 = goo()) temp$$0 = foo(); x = temp$$0;"); } - public void testExposeExpression6() { + public void testExposeExpression8() { helperExposeExpression( "var x = 1 + (goo() && foo())", "foo", @@ -307,7 +349,23 @@ public void testExposeExpression6() { "var x = 1 + temp$$0;"); } - public void testExposeExpression7() { + public void testExposeExpression9() { + helperExposeExpression( + "const x = 1 + (goo() && foo())", + "foo", + "var temp$$0; if (temp$$0 = goo()) temp$$0 = foo();" + + "const x = 1 + temp$$0;"); + } + + public void testExposeExpression10() { + helperExposeExpression( + "let x = 1 + (goo() && foo())", + "foo", + "var temp$$0; if (temp$$0 = goo()) temp$$0 = foo();" + + "let x = 1 + temp$$0;"); + } + + public void testExposeExpression11() { helperExposeExpression( "if(goo() && foo());", "foo", @@ -316,7 +374,7 @@ public void testExposeExpression7() { "if(temp$$0);"); } - public void testExposeExpression8() { + public void testExposeExpression12() { helperExposeExpression( "switch(goo() && foo()){}", "foo", @@ -325,7 +383,7 @@ public void testExposeExpression8() { "switch(temp$$0){}"); } - public void testExposeExpression9() { + public void testExposeExpression13() { helperExposeExpression( "switch(1 + goo() + foo()){}", "foo", @@ -333,7 +391,7 @@ public void testExposeExpression9() { "switch(temp_const$$0 + foo()){}"); } - public void testExposeExpression10() { + public void testExposeExpression14() { helperExposeExpression( "function f(){ return goo() && foo();}", "foo", @@ -343,7 +401,7 @@ public void testExposeExpression10() { "}"); } - public void testExposeExpression11() { + public void testExposeExpression15() { // TODO(johnlenz): We really want a constant marking pass. // The value "goo" should be constant, but it isn't known to be so. helperExposeExpression( @@ -356,7 +414,7 @@ public void testExposeExpression11() { "if (temp_const$$1(1, temp_const$$0, temp$$2));"); } - public void testExposeExpression12() { + public void testExposeExpression16() { helperExposeExpression( "throw bar() && foo();", "foo",