Skip to content

Commit

Permalink
Add tests to cover a problem with declareIcuTemplate message replac…
Browse files Browse the repository at this point in the history 
…ement.

PiperOrigin-RevId: 698863220
  • Loading branch information
@brad4d @copybara-github
brad4d authored and copybara-github committed Nov 21, 2024
1 parent a79b5ff commit 6935ae4
Show file tree
Hide file tree
Showing 2 changed files with 130 additions and 15 deletions.
71 changes: 69 additions & 2 deletions test/com/google/javascript/jscomp/JsMessageExtractorTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@

import com.google.common.base.Joiner;
import com.google.common.collect.ImmutableMap;
import com.google.javascript.jscomp.JsMessage.Part;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Iterator;
Expand All @@ -33,14 +34,44 @@
@RunWith(JUnit4.class)
public final class JsMessageExtractorTest {

// Generate IDs of the form `MEANING_PARTCOUNT[PARTCOUNT...]`
// PARTCOUNT = 'sN' for a string part with N == string length
// PARTCOUNT = 'pN' for a placeholder with N == length of the canonical placeholder name
public static final JsMessage.IdGenerator TEST_ID_GENERATOR =
new JsMessage.IdGenerator() {
@Override
public String generateId(String meaning, List<Part> messageParts) {
StringBuilder idBuilder = new StringBuilder();
idBuilder.append(meaning).append('_');
for (Part messagePart : messageParts) {
if (messagePart.isPlaceholder()) {
idBuilder.append('p').append(messagePart.getCanonicalPlaceholderName().length());
} else {
idBuilder.append('s').append(messagePart.getString().length());
}
}

return idBuilder.toString();
}
};

private Collection<JsMessage> extractMessages(String... js) {
return extractMessages(/* idGenerator= */ null, js);
}

private static Collection<JsMessage> extractMessages(
JsMessage.IdGenerator idGenerator, String[] js) {
String sourceCode = Joiner.on("\n").join(js);
return new JsMessageExtractor(null)
return new JsMessageExtractor(idGenerator)
.extractMessages(SourceFile.fromCode("testcode", sourceCode));
}

private JsMessage extractMessage(String... js) {
Collection<JsMessage> messages = extractMessages(js);
return extractMessage(/* idGenerator= */ null, js);
}

private JsMessage extractMessage(JsMessage.IdGenerator idGenerator, String... js) {
Collection<JsMessage> messages = extractMessages(/* idGenerator= */ idGenerator, js);
assertThat(messages).hasSize(1);
return messages.iterator().next();
}
Expand Down Expand Up @@ -120,6 +151,42 @@ public void testOriginalCodeAndExampleMaps() {
");"));
}

@Test
public void testOriginalCodeAndExampleMapsForDeclareIcuTemplate() {
// A message with placeholders and original code annotations.
assertEquals(
new JsMessage.Builder()
.setKey("MSG_WELCOME")
.appendStringPart("Hi ") // "s3" in the ID
.appendCanonicalPlaceholderReference("INTERPOLATION_0") // "p15" in the ID
.appendStringPart("! Welcome to ") // "s13" in the ID
.appendCanonicalPlaceholderReference("INTERPOLATION_1") // "p15" in the ID
.appendStringPart(".") // "s1" in the ID
.setPlaceholderNameToOriginalCodeMap(
ImmutableMap.of(
"INTERPOLATION_0", "foo.getUserName()",
"INTERPOLATION_1", "bar.getProductName()"))
.setPlaceholderNameToExampleMap(
ImmutableMap.of(
"INTERPOLATION_0", "Ginny Weasley",
"INTERPOLATION_1", "Google Muggle Finder"))
.setDesc("The welcome message.")
.setId("MSG_WELCOME_s3p15s13p15s1")
.build(),
extractMessage(
TEST_ID_GENERATOR,
"var MSG_WELCOME = declareIcuTemplate(",
" 'Hi {INTERPOLATION_0}! Welcome to {INTERPOLATION_1}.',",
" {",
" description: 'The welcome message.',",
" example: {",
" 'INTERPOLATION_0': 'Ginny Weasley',",
" 'INTERPOLATION_1': 'Google Muggle Finder',",
" },",
" },",
");"));
}

@Test
public void testExtractNewStyleMessage2() {
// A message with placeholders and meta data.
Expand Down
74 changes: 61 additions & 13 deletions test/com/google/javascript/jscomp/ReplaceMessagesTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,17 @@
import static com.google.javascript.jscomp.JsMessageVisitor.MESSAGE_TREE_MALFORMED;
import static com.google.javascript.rhino.testing.NodeSubject.assertNode;

import com.google.common.collect.ImmutableList;
import com.google.javascript.jscomp.JsMessage.Part;
import com.google.javascript.jscomp.JsMessage.PlaceholderReference;
import com.google.javascript.jscomp.JsMessage.StringPart;
import com.google.javascript.rhino.Node;
import com.google.javascript.rhino.Node.SideEffectFlags;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.junit.Before;
import org.junit.Ignore;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.JUnit4;
Expand All @@ -34,6 +40,27 @@
@RunWith(JUnit4.class)
public final class ReplaceMessagesTest extends CompilerTestCase {

// Generate IDs of the form `MEANING_PARTCOUNT[PARTCOUNT...]`
// PARTCOUNT = 'sN' for a string part with N == string length
// PARTCOUNT = 'pN' for a placeholder with N == length of the canonical placeholder name
public static final JsMessage.IdGenerator TEST_ID_GENERATOR =
new JsMessage.IdGenerator() {
@Override
public String generateId(String meaning, List<Part> messageParts) {
StringBuilder idBuilder = new StringBuilder();
idBuilder.append(meaning).append('_');
for (Part messagePart : messageParts) {
if (messagePart.isPlaceholder()) {
idBuilder.append('p').append(messagePart.getCanonicalPlaceholderName().length());
} else {
idBuilder.append('s').append(messagePart.getString().length());
}
}

return idBuilder.toString();
}
};

/** Indicates which part of the replacement we're currently testing */
enum TestMode {
// Test full replacement from `goog.getMsg()` to final message values.
Expand All @@ -57,7 +84,12 @@ enum TestMode {

// Messages returned from fake bundle, keyed by `JsMessage.id`.
private Map<String, JsMessage> messages;
// If `true` report errors for messages that are not found in the bundle.
private boolean strictReplacement;
// If `true` pass TEST_ID_GENERATOR in to ReplaceMessages via the fake bundle, so it will be
// used to calculate the message IDs from the meaning and parts instead of just using the message
// key as its id.
private boolean useTestIdGenerator;
private TestMode testMode = TestMode.FULL_REPLACE;

@Override
Expand Down Expand Up @@ -188,6 +220,7 @@ public void setUp() throws Exception {
super.setUp();
messages = new HashMap<>();
strictReplacement = false;
useTestIdGenerator = false;
enableTypeCheck();
replaceTypesWithColors();
enableTypeInfoValidation();
Expand Down Expand Up @@ -295,18 +328,28 @@ public void testReplaceExternalMessage() {
}

@Test
@Ignore // TODO(b/378574591): fix the bug this test exposes
public void testReplaceIcuTemplateMessageWithBundleAndJsPlaceholders() {
// Message in the bundle has a placeholder and is NOT in ICU selector format.
//
// (i.e. it does not start with "{WORD,").
//
// Here we want to make sure that messages created with declareIcuTemplate()
// get treated as ICU messages even without that distinguishing feature.
registerMessage(
getTestMessageBuilder("MSG_SHOW_EMAIL")
.appendStringPart("Retpoŝtadreso: ")
.appendCanonicalPlaceholderReference("EMAIL")
.build());
useTestIdGenerator = true;
strictReplacement = true;

String meaning = "MSG_SHOW_EMAIL";
Part originalStringPart = StringPart.create("Email: ");
Part originalPlaceholerPart = PlaceholderReference.createForCanonicalName("EMAIL");
String expectedMessageId =
TEST_ID_GENERATOR.generateId(
meaning, ImmutableList.of(originalStringPart, originalPlaceholerPart));

// Create and register the translation we expect to find in the message bundle
final JsMessage showEmailTranslatedMsg =
new JsMessage.Builder()
.setKey(meaning)
.setMeaning(meaning)
.appendStringPart("Retpoŝtadreso: ") // translated string
.appendPart(originalPlaceholerPart) // placeholder is the same as original
.setId(expectedMessageId) // message ID was calculated from the original
.build();
registerMessage(showEmailTranslatedMsg);

multiPhaseTest(
lines(
Expand All @@ -327,6 +370,12 @@ public void testReplaceIcuTemplateMessageWithBundleAndJsPlaceholders() {
lines(
"const {declareIcuTemplate} = goog.require('goog.i18n.messages');",
"",
// TODO(b/378574591): The information gathered here isn't enough to correctly generate
// the message ID for lookup. Since the "example" information is dropped, we won't
// know that we need to split the message text into parts, treating "EMAIL" as a
// placeholder. As a result, we calculate the message ID using just a single string
// part, so we get a different message ID than we got during extraction, and we
// won't be able to find the message.
"const MSG_SHOW_EMAIL =",
" __jscomp_define_msg__(",
" {",
Expand Down Expand Up @@ -2107,7 +2156,6 @@ private void registerMessage(JsMessage message) {
}

private class SimpleMessageBundle implements MessageBundle {

@Override
public JsMessage getMessage(String id) {
return messages.get(id);
Expand All @@ -2120,7 +2168,7 @@ public Iterable<JsMessage> getAllMessages() {

@Override
public JsMessage.IdGenerator idGenerator() {
return null;
return useTestIdGenerator ? TEST_ID_GENERATOR : null;
}
}
}

0 comments on commit 6935ae4

Please sign in to comment.