/* * Copyright 2009 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 static com.google.common.truth.Truth.assertThat; import static com.google.javascript.jscomp.ReplaceIdGenerators.INVALID_GENERATOR_PARAMETER; import com.google.common.collect.ImmutableMap; import org.junit.Before; import org.junit.Test; import org.junit.runner.RunWith; import org.junit.runners.JUnit4; /** * Tests for {@link ReplaceIdGenerators}. * */ @RunWith(JUnit4.class) public final class ReplaceIdGeneratorsTest extends CompilerTestCase { private boolean generatePseudoNames = false; private ReplaceIdGenerators lastPass = null; private String previousMappings = null; @Override protected CompilerPass getProcessor(final Compiler compiler) { RenamingMap idTestMap = new RenamingMap() { private final ImmutableMap map = ImmutableMap.of( "foo", ":foo:", "bar", ":bar:"); @Override public String get(String value) { String replacement = map.get(value); return replacement != null ? replacement : "unknown:" + value; } }; RenamingMap gen = new UniqueRenamingToken(); lastPass = new ReplaceIdGenerators( compiler, new ImmutableMap.Builder() .put("goog.events.getUniqueId", gen) .put("goog.place.getUniqueId", gen) .put("id", idTestMap) .put("get.id", idTestMap) .build(), generatePseudoNames, previousMappings, null /* xidHashFunction */); return lastPass; } @Override @Before public void setUp() throws Exception { super.setUp(); generatePseudoNames = false; previousMappings = null; } @Test public void testBackwardCompat() { testWithPseudo("foo.bar = goog.events.getUniqueId('foo_bar')", "foo.bar = 'a'", "foo.bar = 'foo_bar$0'"); } @Test public void testSerialization1() { testMap( lines( "var x = goog.events.getUniqueId('xxx');", "var y = goog.events.getUniqueId('yyy');"), lines( "var x = 'a';", "var y = 'b';"), lines( "[goog.events.getUniqueId]", "", "a:testcode:1:32", "b:testcode:2:32", "", "")); } @Test public void testSerialization2() { testMap( lines( "/** @consistentIdGenerator */", "id = function() {};", "f1 = id('f1');", "f1 = id('f1')"), lines( "/** @consistentIdGenerator */", "id = function() {};", "f1 = 'a';", "f1 = 'a'"), lines( "[id]", "", "a:f1", "", "")); } @Test public void testReusePreviousSerialization1() { previousMappings = lines( "[goog.events.getUniqueId]", "", "previous1:testcode:1:32", "previous2:testcode:2:32", "", "[goog.place.getUniqueId]", "", ""); testMap("var x = goog.events.getUniqueId('xxx');\n" + "var y = goog.events.getUniqueId('yyy');\n", "var x = 'previous1';\n" + "var y = 'previous2';\n", "[goog.events.getUniqueId]\n" + "\n" + "previous1:testcode:1:32\n" + "previous2:testcode:2:32\n" + "\n"); } @Test public void testReusePreviousSerialization2() { previousMappings = "[goog.events.getUniqueId]\n" + "\n" + "a:testcode:1:32\n" + "b:testcode:2:32\n" + "\n" + "[goog.place.getUniqueId]\n" + "\n" + "\n"; testMap( "var x = goog.events.getUniqueId('xxx');\n" + "\n" + // new line to change location "var y = goog.events.getUniqueId('yyy');\n", "var x = 'a';\n" + "var y = 'c';\n", "[goog.events.getUniqueId]\n" + "\n" + "a:testcode:1:32\n" + "c:testcode:3:32\n" + "\n"); } @Test public void testReusePreviousSerializationConsistent1() { previousMappings = "[id]\n" + "\n" + "a:f1\n" + "\n"; testMap( lines( "/** @consistentIdGenerator */ id = function() {};", "f1 = id('f1');", "f1 = id('f1')"), lines( "/** @consistentIdGenerator */ id = function() {};", "f1 = 'a';", "f1 = 'a'"), "[id]\n" + "\n" + "a:f1\n" + "\n"); } @Test public void testSimple() { testWithPseudo( lines( "/** @idGenerator */ foo.getUniqueId = function() {};", "foo.bar = foo.getUniqueId('foo_bar')"), lines( "/** @idGenerator */ foo.getUniqueId = function() {};", "foo.bar = 'a'"), lines( "/** @idGenerator */ foo.getUniqueId = function() {};", "foo.bar = 'foo_bar$0'")); testWithPseudo( lines( "/** @idGenerator */ goog.events.getUniqueId = function() {};", "foo1 = goog.events.getUniqueId('foo1');", "foo1 = goog.events.getUniqueId('foo1');"), lines( "/** @idGenerator */ goog.events.getUniqueId = function() {};", "foo1 = 'a';", "foo1 = 'b';"), lines( "/** @idGenerator */ goog.events.getUniqueId = function() {};", "foo1 = 'foo1$0';", "foo1 = 'foo1$1';")); } @Test public void testObjectLit() { testWithPseudo( lines( "/** @idGenerator */ goog.id = function() {};", "things = goog.id({foo1: 'test', 'foo bar': 'test'})"), lines( "/** @idGenerator */ goog.id = function() {};", "things = {'a': 'test', 'b': 'test'}"), lines( "/** @idGenerator */ goog.id = function() {};", "things = {'foo1$0': 'test', 'foo bar$1': 'test'}")); } @Test public void testObjectLit_mapped() { testNonPseudoSupportingGenerator( lines( "/** @idGenerator {mapped} */ id = function() {};", "things = id({foo: 'test', 'bar': 'test'})"), lines( "/** @idGenerator {mapped} */ id = function() {};", "things = {':foo:': 'test', ':bar:': 'test'}")); } @Test public void testObjectLit_xid() { testNonPseudoSupportingGenerator( lines( "/** @idGenerator {xid} */ xid.object = function() {};", "things = xid.object({foo: 'test', 'value': 'test'})"), lines( "/** @idGenerator {xid} */ xid.object = function() {};", "things = {'QB6rXc': 'test', 'b6Lt6c': 'test'}")); } @Test public void testObjectLit_empty() { testWithPseudo( "/** @idGenerator */ goog.id = function() {}; things = goog.id({})", "/** @idGenerator */ goog.id = function() {}; things = {}", "/** @idGenerator */ goog.id = function() {}; things = {}"); } @Test public void testObjectLit_function() { testWithPseudo( lines( "/** @idGenerator */ goog.id = function() {};", "things = goog.id({foo: function() {}})"), lines( "/** @idGenerator */ goog.id = function() {};", "things = {'a': function() {}}"), lines( "/** @idGenerator */ goog.id = function() {};", "things = {'foo$0': function() {}}")); testWithPseudo( lines( "/** @idGenerator */ goog.id = function() {};", "things = goog.id({foo: function*() {}})"), lines( "/** @idGenerator */ goog.id = function() {};", "things = {'a': function*() {}}"), lines( "/** @idGenerator */ goog.id = function() {};", "things = {'foo$0': function*() {}}")); } @Test public void testObjectLit_ES6() { testError(lines( "/** @idGenerator */", "goog.id = function() {};", "things = goog.id({fooX() {}})"), ReplaceIdGenerators.SHORTHAND_FUNCTION_NOT_SUPPORTED_IN_ID_GEN); testError(lines( "/** @idGenerator */", "goog.id = function() {};", "things = goog.id({['fooX']: 'test'})"), ReplaceIdGenerators.COMPUTED_PROP_NOT_SUPPORTED_IN_ID_GEN); } @Test public void testClass() { testSame( externs(""), srcs( lines( "/** @idGenerator */", "goog.id = function() {};", "things = goog.id(class fooBar{})")), warning(ReplaceIdGenerators.INVALID_GENERATOR_PARAMETER)); } @Test public void testSimpleConsistent() { testWithPseudo( "/** @consistentIdGenerator */ id = function() {}; foo.bar = id('foo_bar')", "/** @consistentIdGenerator */ id = function() {}; foo.bar = 'a'", "/** @consistentIdGenerator */ id = function() {}; foo.bar = 'foo_bar$0'"); testWithPseudo( "/** @consistentIdGenerator */ id = function() {}; f1 = id('f1'); f1 = id('f1')", "/** @consistentIdGenerator */ id = function() {}; f1 = 'a'; f1 = 'a'", "/** @consistentIdGenerator */ id = function() {}; f1 = 'f1$0'; f1 = 'f1$0'"); testWithPseudo( lines( "/** @consistentIdGenerator */ id = function() {};", "f1 = id('f1');", "f1 = id('f1');", "f1 = id('f1')"), lines( "/** @consistentIdGenerator */ id = function() {};", "f1 = 'a';", "f1 = 'a';", "f1 = 'a'"), lines( "/** @consistentIdGenerator */ id = function() {};", "f1 = 'f1$0';", "f1 = 'f1$0';", "f1 = 'f1$0'")); } @Test public void testSimpleStable() { testNonPseudoSupportingGenerator( "/** @stableIdGenerator */ id = function() {};" + "foo.bar = id('foo_bar')", "/** @stableIdGenerator */ id = function() {};" + "foo.bar = '125lGg'"); testNonPseudoSupportingGenerator( "/** @stableIdGenerator */ id = function() {};" + "f1 = id('f1');" + "f1 = id('f1')", "/** @stableIdGenerator */ id = function() {};" + "f1 = 'AAAMiw';" + "f1 = 'AAAMiw'"); } @Test public void testSimpleXid() { testNonPseudoSupportingGenerator( lines("/** @idGenerator {xid} */ id = function() {};", "foo.bar = id('foo')"), lines("/** @idGenerator {xid} */ id = function() {};", "foo.bar = 'QB6rXc'")); testNonPseudoSupportingGenerator( lines( "/** @idGenerator {xid} */ id = function() {};", "f1 = id('foo');", "f1 = id('foo')"), lines( "/** @idGenerator {xid} */ id = function() {};", "f1 = 'QB6rXc';", "f1 = 'QB6rXc'")); } @Test public void testVar() { testWithPseudo( lines( "/** @consistentIdGenerator */ var id = function() {};", "foo.bar = id('foo_bar')"), lines("/** @consistentIdGenerator */ var id = function() {};", "foo.bar = 'a'"), lines( "/** @consistentIdGenerator */ var id = function() {};", "foo.bar = 'foo_bar$0'")); testNonPseudoSupportingGenerator( lines( "/** @stableIdGenerator */ var id = function() {};", "foo.bar = id('foo_bar')"), lines( "/** @stableIdGenerator */ var id = function() {};", "foo.bar = '125lGg'")); } @Test public void testLet() { testWithPseudo( lines( "/** @consistentIdGenerator */ let id = function() {};", "foo.bar = id('foo_bar')"), lines("/** @consistentIdGenerator */ let id = function() {};", "foo.bar = 'a'"), lines( "/** @consistentIdGenerator */ let id = function() {};", "foo.bar = 'foo_bar$0'")); testNonPseudoSupportingGenerator( "/** @stableIdGenerator */ let id = function() {};" + "foo.bar = id('foo_bar')", "/** @stableIdGenerator */ let id = function() {};" + "foo.bar = '125lGg'"); } @Test public void testConst() { testWithPseudo( lines( "/** @consistentIdGenerator */ const id = function() {};", "foo.bar = id('foo_bar')"), lines( "/** @consistentIdGenerator */ const id = function() {};", "foo.bar = 'a'"), lines( "/** @consistentIdGenerator */ const id = function() {};", "foo.bar = 'foo_bar$0'")); testNonPseudoSupportingGenerator( lines( "/** @stableIdGenerator */ const id = function() {};", "foo.bar = id('foo_bar')"), lines( "/** @stableIdGenerator */ const id = function() {};", "foo.bar = '125lGg'")); } @Test public void testInObjLit() { testWithPseudo( lines( "/** @consistentIdGenerator */ get.id = function() {};", "foo.bar = {a: get.id('foo_bar')}"), lines( "/** @consistentIdGenerator */ get.id = function() {};", "foo.bar = {a: 'a'}"), lines( "/** @consistentIdGenerator */ get.id = function() {};", "foo.bar = {a: 'foo_bar$0'}")); testNonPseudoSupportingGenerator( lines( "/** @stableIdGenerator */ get.id = function() {};", "foo.bar = {a: get.id('foo_bar')}"), lines( "/** @stableIdGenerator */ get.id = function() {};", "foo.bar = {a: '125lGg'}")); testNonPseudoSupportingGenerator( lines( "/** @idGenerator {xid} */ get.id = function() {};", "foo.bar = {a: get.id('foo')}"), lines( "/** @idGenerator {xid} */ get.id = function() {};", "foo.bar = {a: 'QB6rXc'}")); } @Test public void testInObjLit_mapped() { testWithPseudo( lines( "/** @idGenerator {mapped}*/ id = function() {};", "foo.bar = {a: id('foo')}"), lines( "/** @idGenerator {mapped}*/ id = function() {};", "foo.bar = {a: ':foo:'}"), lines( "/** @idGenerator {mapped}*/ id = function() {};", "foo.bar = {a: ':foo:'}")); } @Test public void testMapped() { testWithPseudo( lines("/** @idGenerator {mapped}*/ id = function() {};", "foo.bar = id('foo');"), lines("/** @idGenerator {mapped}*/ id = function() {};", "foo.bar = ':foo:';"), lines("/** @idGenerator {mapped}*/ id = function() {};", "foo.bar = ':foo:';")); } @Test public void testMappedMap() { testMap( lines( "/** @idGenerator {mapped}*/ id = function() {};", "foo.bar = id('foo');", "foo.bar = id('foo');"), lines( "/** @idGenerator {mapped}*/id = function() {};", "foo.bar = ':foo:';", "foo.bar = ':foo:';"), lines("[id]", "", ":foo::foo", "", "")); } @Test public void testMapped2() { testWithPseudo( lines( "/** @idGenerator {mapped}*/ id = function() {};", "foo.bar = function() { return id('foo'); };"), lines( "/** @idGenerator {mapped}*/ id = function() {};", "foo.bar = function() { return ':foo:'; };"), lines( "/** @idGenerator {mapped}*/ id = function() {};", "foo.bar = function() { return ':foo:'; };")); } @Test public void testTwoGenerators() { testWithPseudo( lines( "/** @idGenerator */ var id1 = function() {};", "/** @idGenerator */ var id2 = function() {};", "f1 = id1('1');", "f2 = id1('1');", "f3 = id2('1');", "f4 = id2('1');"), lines( "/** @idGenerator */ var id1 = function() {};", "/** @idGenerator */ var id2 = function() {};", "f1 = 'a';", "f2 = 'b';", "f3 = 'a';", "f4 = 'b';"), lines( "/** @idGenerator */ var id1 = function() {};", "/** @idGenerator */ var id2 = function() {};", "f1 = '1$0';", "f2 = '1$1';", "f3 = '1$0';", "f4 = '1$1';")); } @Test public void testMixedGenerators() { testWithPseudo( lines( "/** @idGenerator */ var id1 = function() {};", "/** @consistentIdGenerator */ var id2 = function() {};", "/** @stableIdGenerator */ var id3 = function() {};", "f1 = id1('1');", "f2 = id1('1');", "f3 = id2('1');", "f4 = id2('1');", "f5 = id3('1');", "f6 = id3('1');"), lines( "/** @idGenerator */ var id1 = function() {};", "/** @consistentIdGenerator */ var id2 = function() {};", "/** @stableIdGenerator */ var id3 = function() {};", "f1 = 'a';", "f2 = 'b';", "f3 = 'a';", "f4 = 'a';", "f5 = 'AAAAMQ';", "f6 = 'AAAAMQ';"), lines( "/** @idGenerator */ var id1 = function() {};", "/** @consistentIdGenerator */ var id2 = function() {};", "/** @stableIdGenerator */ var id3 = function() {};", "f1 = '1$0';", "f2 = '1$1';", "f3 = '1$0';", "f4 = '1$0';", "f5 = 'AAAAMQ';", "f6 = 'AAAAMQ';")); } @Test public void testNonLiteralParam1() { testSame("/** @idGenerator */ var id = function() {}; " + "var x = 'foo';" + "id(x);", ReplaceIdGenerators.INVALID_GENERATOR_PARAMETER); } @Test public void testNonLiteralParam2() { testSame("/** @idGenerator */ var id = function() {}; " + "id('foo' + 'bar');", ReplaceIdGenerators.INVALID_GENERATOR_PARAMETER); } @Test public void testLocalCall() { testError("/** @idGenerator */ var id = function() {}; " + "function Foo() { id('foo'); }", ReplaceIdGenerators.NON_GLOBAL_ID_GENERATOR_CALL); } @Test public void testConditionalCall() { testError( lines( "/** @idGenerator */", "var id = function() {}; ", "while(0){ id('foo');}"), ReplaceIdGenerators.CONDITIONAL_ID_GENERATOR_CALL); testError( lines("/** @idGenerator */", "var id = function() {}; ", "for(;;){ id('foo');}"), ReplaceIdGenerators.CONDITIONAL_ID_GENERATOR_CALL); testError("/** @idGenerator */ var id = function() {}; " + "if(x) id('foo');", ReplaceIdGenerators.CONDITIONAL_ID_GENERATOR_CALL); testWithPseudo( lines( "/** @consistentIdGenerator */ var id = function() {};", "function fb() {foo.bar = id('foo_bar')}"), lines( "/** @consistentIdGenerator */ var id = function() {};", "function fb() {foo.bar = 'a'}"), lines( "/** @consistentIdGenerator */ var id = function() {};", "function fb() {foo.bar = 'foo_bar$0'}")); testNonPseudoSupportingGenerator( lines( "/** @stableIdGenerator */ var id = function() {};", "function fb() {foo.bar = id('foo_bar')}"), lines( "/** @stableIdGenerator */ var id = function() {};", "function fb() {foo.bar = '125lGg'}")); testError( lines( "/** @idGenerator */", "var id = function() {}; ", "for(x of [1, 2, 3]){ id('foo');}"), ReplaceIdGenerators.CONDITIONAL_ID_GENERATOR_CALL); } @Test public void testConflictingIdGenerator() { testError("/** @idGenerator \n @consistentIdGenerator \n*/" + "var id = function() {}; ", ReplaceIdGenerators.CONFLICTING_GENERATOR_TYPE); testError("/** @stableIdGenerator \n @idGenerator \n*/" + "var id = function() {}; ", ReplaceIdGenerators.CONFLICTING_GENERATOR_TYPE); testError("/** @stableIdGenerator \n " + "@consistentIdGenerator \n*/" + "var id = function() {}; ", ReplaceIdGenerators.CONFLICTING_GENERATOR_TYPE); testWithPseudo( lines( "/** @consistentIdGenerator */ var id = function() {};", "if (x) {foo.bar = id('foo_bar')}"), lines( "/** @consistentIdGenerator */ var id = function() {};", "if (x) {foo.bar = 'a'}"), lines( "/** @consistentIdGenerator */ var id = function() {};", "if (x) {foo.bar = 'foo_bar$0'}")); } @Test public void testUnknownMapping() { testSame(lines( "/** @idGenerator {mapped} */", "var unknownId = function() {};", "function Foo() { unknownId('foo'); }"), ReplaceIdGenerators.MISSING_NAME_MAP_FOR_GENERATOR); } @Test public void testBadGenerator1() { testSame("/** @idGenerator */ id = function() {};" + "foo.bar = id()", INVALID_GENERATOR_PARAMETER); } @Test public void testBadGenerator2() { testSame("/** @consistentIdGenerator */ id = function() {};" + "foo.bar = id()", INVALID_GENERATOR_PARAMETER); } private void testMap(String code, String expected, String expectedMap) { test(code, expected); assertThat(lastPass.getSerializedIdMappings()).isEqualTo(expectedMap); } private void testWithPseudo(String code, String expected, String expectedPseudo) { generatePseudoNames = false; test(code, expected); generatePseudoNames = true; test(code, expectedPseudo); } private void testNonPseudoSupportingGenerator(String code, String expected) { generatePseudoNames = false; test(code, expected); generatePseudoNames = true; test(code, expected); } }