/* Any copyright is dedicated to the Public Domain.
http://creativecommons.org/publicdomain/zero/1.0/ */
"use strict";
/**
* Request 2x longer timeout for this test.
* There are lot of test cases in this file, but they are all of the same nature,
* and it makes the most sense to have them all in this single test file.
*/
requestLongerTimeout(2);
add_task(async function test_translated_div_element_and_visible_change() {
let hasVisibleChangeOccurred = false;
const { translate, htmlMatches, cleanup } = await createTranslationsDoc(
/* html */ `
This is a simple translation.
`,
{
mockedTranslatorPort: createMockedTranslatorPort(),
mockedReportVisibleChange: () => {
hasVisibleChangeOccurred = true;
},
}
);
translate();
await htmlMatches(
"A single element with a single text node is translated into uppercase.",
/* html */ `
THIS IS A SIMPLE TRANSLATION.
`
);
Assert.ok(hasVisibleChangeOccurred, "A visible change was reported.");
cleanup();
});
add_task(async function test_translated_textnode() {
const { translate, htmlMatches, cleanup } = await createTranslationsDoc(
"This is a simple text translation."
);
translate();
await htmlMatches(
"A Text node at the root is translated into all caps",
"THIS IS A SIMPLE TEXT TRANSLATION."
);
cleanup();
});
add_task(async function test_no_text_trees() {
const { translate, htmlMatches, cleanup } =
await createTranslationsDoc(/* html */ `
`);
translate();
await htmlMatches(
"Trees with no text are not affected",
/* html */ `
`
);
cleanup();
});
add_task(async function test_no_text_trees() {
const { translate, htmlMatches, cleanup } = await createTranslationsDoc("");
translate();
await htmlMatches("No text is still no text", "");
cleanup();
});
add_task(async function test_translated_title() {
const { cleanup, document, translate } =
await createTranslationsDoc(/* html */ `
This is an actual full page.
`);
translate();
const translatedTitle = "THIS IS AN ACTUAL FULL PAGE.";
await waitForCondition(() => document.title === translatedTitle);
cleanup();
});
add_task(async function test_translated_nested_elements() {
const { translate, htmlMatches, cleanup } =
await createTranslationsDoc(/* html */ `
`
);
cleanup();
});
/**
* Only translate elements with a matching "from" language.
*/
add_task(async function test_translated_language() {
const { translate, htmlMatches, cleanup } =
await createTranslationsDoc(/* html */ `
No lang property
Language matches
Language mismatch is ignored.
Language match with region.
Language mismatch with
nested elements.
`);
translate();
await htmlMatches(
"Language matching of elements behaves as expected.",
/* html */ `
NO LANG PROPERTY
LANGUAGE MATCHES
Language mismatch is ignored.
LANGUAGE MATCH WITH REGION.
Language mismatch with
nested elements.
`
);
cleanup();
});
/**
* Test elements that have been marked as ignored.
*/
add_task(async function test_ignored_translations() {
const { translate, htmlMatches, cleanup } =
await createTranslationsDoc(/* html */ `
This is translated.
This is not translated.
This is not translated.
This is not translated.
This is not translated.
This is not translated.
This is translated.
`);
translate();
await htmlMatches(
"Language matching of elements behaves as expected.",
/* html */ `
THIS IS TRANSLATED.
This is not translated.
This is not translated.
This is not translated.
This is not translated.
This is not translated.
THIS IS TRANSLATED.
`
);
cleanup();
});
/**
* Test excluded tags.
*/
add_task(async function test_excluded_tags() {
const { translate, htmlMatches, cleanup } =
await createTranslationsDoc(/* html */ `
This is translated.
This is ignored
`);
translate();
await htmlMatches(
"EXCLUDED_TAGS are not translated",
/* html */ `
THIS IS TRANSLATED.
This is ignored
`
);
cleanup();
});
add_task(async function test_comments() {
const { translate, htmlMatches, cleanup } =
await createTranslationsDoc(/* html */ `
This is translated.
`);
translate();
await htmlMatches(
"Comments do not affect things.",
/* html */ `
THIS IS TRANSLATED.
`
);
cleanup();
});
/**
* Test the batching behavior on what is sent in for a translation.
*/
add_task(async function test_translation_batching() {
const { translate, htmlMatches, cleanup } = await createTranslationsDoc(
/* html */ `
`
);
cleanup();
});
/**
* Test the inline/block behavior on what is sent in for a translation.
*/
add_task(async function test_translation_inline_styling() {
const { document, translate, htmlMatches, cleanup } =
await createTranslationsDoc(
/* html */ `
Bare text is sent in a batch.
Inline text is sent in a batch.
Display "block" overrides the inline designation.
`,
{ mockedTranslatorPort: createBatchedMockedTranslatorPort() }
);
info("Setting a span as display: block.");
const span = document.getElementById("spanAsBlock");
span.style.display = "block";
is(span.ownerGlobal.getComputedStyle(span).display, "block");
translate();
await htmlMatches(
"Span as a display: block",
/* html */ `
cccc cccc cc cccc cc c ccccc.
bbbbbb bbbb bb bbbb bb b
bbbbb
.
aaaaaaa "aaaaa" aaaaaaaaa aaa aaaaaa aaaaaaaaaaa.
`
);
cleanup();
});
/**
* Test what happens when there are many inline elements.
*/
add_task(async function test_many_inlines() {
const { translate, htmlMatches, cleanup } = await createTranslationsDoc(
/* html */ `
This is a
much longer
section that includes
many span elements
to test what happens
in cases like this.
aaaa aa a
aaaa aaaaaa
aaaaaaa aaaa aaaaaaaa
aaaa aaaa aaaaaaaa
aa aaaa aaaa aaaaaaa
aa aaaaa aaaa aaaa.
`
);
cleanup();
});
/**
* Test what happens when there are many inline elements.
*/
add_task(async function test_many_inlines() {
const { translate, htmlMatches, cleanup } = await createTranslationsDoc(
/* html */ `
`
);
cleanup();
});
/**
* Test a mix of inline text and block elements.
*/
add_task(async function test_presumed_inlines1() {
const { translate, htmlMatches, cleanup } = await createTranslationsDoc(
/* html */ `
Text node
Block element
`,
{ mockedTranslatorPort: createBatchedMockedTranslatorPort() }
);
translate();
await htmlMatches(
"Mixing a text node with block elements will send in two batches.",
/* html */ `
bbbb bbbb
aaaaa aaaaaaa
`
);
cleanup();
});
/**
* Test what happens when there are many inline elements.
*/
add_task(async function test_presumed_inlines2() {
const { translate, htmlMatches, cleanup } = await createTranslationsDoc(
/* html */ `
Text node
Inline
Block Element
`,
{ mockedTranslatorPort: createBatchedMockedTranslatorPort() }
);
translate();
await htmlMatches(
"A mix of inline and blocks will be sent in separately.",
/* html */ `
`,
{ mockedTranslatorPort: createBatchedMockedTranslatorPort() }
);
translate();
await htmlMatches(
"Conflicting inlines will be sent in as separate blocks if there are more block elements",
/* html */ `
eeee eeee
dddddd
ccccc ccccccc c
bbbbb bbbbbbb b
aaaaa aaaaaaa a
`
);
cleanup();
});
/**
* Test the display "none" properties properly subdivide in block elements.
*/
add_task(async function test_display_none() {
const { translate, htmlMatches, cleanup } = await createTranslationsDoc(
/* html */ `
This is some text.
It has inline elements
`,
{ mockedTranslatorPort: createBatchedMockedTranslatorPort() }
);
translate();
// Note: The bergamot translator does not translate style elements, while our fake
// translator does translate the inside of style elements. That is why in the assertion
// here the style element is blank rather than containing style.
await htmlMatches(
"Display none",
/* html */ `
aaaa aa aaaa aaaa.
aa aaa aaaaaa aaaaaaaa
`
);
cleanup();
});
/**
* Test the display "none" properties properly subdivide in block elements.
*
* TODO - See Bug 1885235
*
* This assertion is wrong, as our test suite doesn't properly compute the style for
* elements. The div with "display; none;" is still block, not "none".
*/
add_task(async function test_display_none_div() {
const { translate, htmlMatches, cleanup } = await createTranslationsDoc(
/* html */ `
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Quisque fermentum est ante, ut porttitor enim molestie et. Nam mattis ullamcorper justo a ultrices. Ut ac sodales lorem. Sed feugiat ultricies lacus. Proin dapibus sit amet nunc a ullamcorper. Donec leo purus, convallis quis urna non, semper pulvinar augue. Nulla placerat turpis arcu, sit amet imperdiet sapien tincidunt ut. Donec sit amet luctus lorem, sed consectetur lectus. Pellentesque est nisi, feugiat et ipsum quis, vestibulum blandit nulla.
Proin accumsan sapien ut nibh mattis tincidunt. Donec facilisis nibh sodales, mattis risus et, malesuada lorem. Nam suscipit lacinia venenatis. Praesent ac consectetur ante. Vestibulum pulvinar ut massa in viverra. Nunc tincidunt tortor nunc. Vivamus sit amet hendrerit mi. Aliquam posuere velit non ante facilisis euismod. In ullamcorper, lacus vel hendrerit tincidunt, dui justo iaculis nulla, sit amet tincidunt nisl magna et urna. Sed varius tincidunt ligula. Interdum et malesuada fames ac ante ipsum primis in faucibus. Nam sed gravida ligula. Donec tincidunt arcu eros, ac maximus magna auctor eu. Vivamus suscipit neque velit, in ullamcorper elit pulvinar et. Morbi auctor tempor risus, imperdiet placerat velit gravida vel. Duis ultricies accumsan libero quis molestie.
Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia curae; Etiam nec arcu dapibus enim vulputate vulputate aliquet a libero. Nam hendrerit pulvinar libero, eget posuere quam porta eu. Pellentesque dignissim justo eu leo accumsan, sit amet suscipit ante gravida. Vivamus eu faucibus orci. Quisque sagittis tortor eget orci venenatis porttitor. Quisque mollis ipsum a dignissim dignissim.
Aenean sagittis nisi lectus, non lacinia orci dapibus viverra. Donec diam lorem, tincidunt sed massa vel, vulputate tincidunt metus. In quam felis, egestas et faucibus faucibus, vestibulum quis tortor. Morbi odio mi, suscipit vitae leo in, consequat interdum augue. Quisque purus velit, dictum ac ante eget, volutpat dapibus ante. Suspendisse quis augue vitae velit elementum dictum nec aliquet nisl. Maecenas vestibulum quam augue, eu maximus urna blandit eu. Donec nunc risus, elementum id ligula nec, ultrices venenatis libero. Suspendisse ullamcorper ex ante, malesuada pulvinar sem placerat vel.
In hac habitasse platea dictumst. Duis vulputate tellus arcu, at posuere ligula viverra luctus. Fusce ultrices malesuada neque vitae vehicula. Aliquam blandit nisi sed nibh facilisis, non varius turpis venenatis. Vestibulum ut velit laoreet, sagittis leo ac, pharetra ex. Aenean mollis risus sed nibh auctor, et feugiat neque iaculis. Fusce fermentum libero metus, at consectetur massa euismod sed. Mauris ut metus sit amet leo porttitor mollis. Vivamus tincidunt lorem non purus suscipit sollicitudin. Maecenas ut tristique elit. Ut eu volutpat turpis. Suspendisse nec tristique augue. Nullam faucibus egestas volutpat. Sed tempor eros et mi ultrices, nec feugiat eros egestas.
`,
{ mockedTranslatorPort: createBatchedMockedTranslatorPort() }
);
translate();
await htmlMatches(
"Large chunks of text can be still sent in for translation in one big pass, " +
"this could be slow bad behavior for the user.",
/* html */ `
`
);
cleanup();
});
add_task(async function test_reordering() {
const { translate, htmlMatches, cleanup } = await createTranslationsDoc(
/* html */ `
B - This was first.
A - This was second.
C - This was third.
`,
{ mockedTranslatorPort: createdReorderingMockedTranslatorPort() }
);
translate();
await htmlMatches(
"Nodes can be re-ordered by the translator",
/* html */ `
A - THIS WAS SECOND.
B - THIS WAS FIRST.
C - THIS WAS THIRD.
`
);
cleanup();
});
add_task(async function test_reordering2() {
const { translate, htmlMatches, cleanup } = await createTranslationsDoc(
/* html */ `
B - This was first.
A - This was second.
C - This was third.
`,
{ mockedTranslatorPort: createdReorderingMockedTranslatorPort() }
);
translate();
// Note: ${" "} is used below to ensure that the whitespace is not stripped from
// the test.
await htmlMatches(
"Text nodes can be re-ordered.",
/* html */ `
A - THIS WAS SECOND.
B - THIS WAS FIRST.
${" "}
C - THIS WAS THIRD.
`
);
cleanup();
});
add_task(async function test_mutations() {
const { translate, htmlMatches, cleanup, document } =
await createTranslationsDoc(/* html */ `
This is a simple translation.
`);
translate();
await htmlMatches(
"It translates.",
/* html */ `
THIS IS A SIMPLE TRANSLATION.
`
);
info('Trigger the "childList" mutation.');
const div = document.createElement("div");
div.innerText = "This is an added node.";
document.body.appendChild(div);
await htmlMatches(
"The added node gets translated.",
/* html */ `
THIS IS A SIMPLE TRANSLATION.
THIS IS AN ADDED NODE.
`
);
info('Trigger the "characterData" mutation.');
document.querySelector("div").firstChild.nodeValue =
"This is a changed node.";
await htmlMatches(
"The changed node gets translated",
/* html */ `
THIS IS A CHANGED NODE.
THIS IS AN ADDED NODE.
`
);
cleanup();
});
add_task(async function test_svgs() {
const { translate, htmlMatches, cleanup } =
await createTranslationsDoc(/* html */ `
Text before is translated
Text after is translated
`);
translate();
await htmlMatches(
"SVG text gets translated, and style elements are left alone.",
/* html */ `
TEXT BEFORE IS TRANSLATED
TEXT AFTER IS TRANSLATED
`
);
await cleanup();
});
add_task(async function test_svgs_more() {
const { translate, htmlMatches, cleanup } =
await createTranslationsDoc(/* html */ `
`);
translate();
await htmlMatches(
"Foreign objects get translated",
/* html */ `
`
);
await cleanup();
});
add_task(async function test_standalone_svg_document() {
const svgSource = /* html */ `
`;
const { translate, htmlMatches, cleanup, document } =
await createTranslationsDoc(svgSource, { parserType: "image/svg+xml" });
translate();
await htmlMatches(
"Standalone SVG documents are translated.",
/* html */ `
`,
document
);
await cleanup();
});
add_task(async function test_tables() {
const { translate, htmlMatches, cleanup } =
await createTranslationsDoc(/* html */ `
Table header 1
Table header 2
Table data 1
Table data 2
`);
translate();
await htmlMatches(
"Tables are correctly translated.",
/* html */ `
TABLE HEADER 1
TABLE HEADER 2
TABLE DATA 1
TABLE DATA 2
`
);
cleanup();
});
add_task(async function test_option_values() {
const { translate, htmlMatches, cleanup } =
await createTranslationsDoc(/* html */ `
`);
translate();
await htmlMatches(
"Option values are not changed",
/* html */ `
`
);
cleanup();
});
add_task(async function test_option_values() {
const { document, translate, htmlMatches, cleanup } =
await createTranslationsDoc(/* html */ `
`);
const select = document.querySelector("select");
document.querySelector("select").addEventListener("change", () => {
ok(false, "The change event should not ever be fired.");
});
is(document.querySelector("select").value, "new", 'The "new" value selected');
translate();
await htmlMatches(
"Option values are not changed",
/* html */ `
`
);
is(
document.querySelector("select").value,
"new",
'After translation the "new" value is still selected'
);
is(
document.querySelector("select"),
select,
"The original select element is still present"
);
cleanup();
});
add_task(async function test_basic_attributes() {
const { translate, htmlMatches, cleanup } =
await createTranslationsDoc(/* html */ `
`);
translate();
await htmlMatches(
"Placeholders support added",
/* html */ `
`
);
cleanup();
});
add_task(async function test_html_lang_attribute() {
const { translate, document, cleanup } =
await createTranslationsDoc(/* html */ `
`);
translate();
await waitForCondition(() => document.documentElement.lang === "es");
cleanup();
});
add_task(async function test_attributes_with_innerhtml() {
const { translate, htmlMatches, cleanup } =
await createTranslationsDoc(/* html */ `
Simple translation.
`);
translate();
await htmlMatches(
"translation for title with innerHTML",
/* html */ `