Skip to content
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.

Sign up for GitHub

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

Roll forward vulcanization change (#3582) with check for link import outside head #3722

Closed
wants to merge 2 commits into from
Closed

Roll forward vulcanization change (#3582) with check for link import outside head #3722

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d6e89ca
Revert "Reverts Vulcanization printer changes (#3663)"
caisq Jun 9, 2020
2c58b7c
Add check for mid-doc link importing
caisq Jun 9, 2020
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
125 changes: 122 additions & 3 deletions tensorboard/java/org/tensorflow/tensorboard/vulcanize/Vulcanize.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,13 +74,14 @@
import org.jsoup.nodes.Comment;
import org.jsoup.nodes.DataNode;
import org.jsoup.nodes.Document;
import org.jsoup.nodes.DocumentType;
import org.jsoup.nodes.Element;
import org.jsoup.nodes.Html5Printer;
import org.jsoup.nodes.Node;
import org.jsoup.nodes.TextNode;
import org.jsoup.parser.Parser;
import org.jsoup.parser.Tag;
import org.jsoup.select.Elements;
import org.jsoup.select.NodeVisitor;

/** Simple one-off solution for TensorBoard vulcanization. */
public final class Vulcanize {
Expand Down Expand Up @@ -182,10 +183,14 @@ public static void main(String[] args)
}

boolean shouldExtractJs = !jsPath.isEmpty();
// Write an empty file for shasum when all scripts are extracted out.
createFile(
jsOutput, shouldExtractJs ? extractAndTransformJavaScript(document, jsPath) : "");
// Write an empty file for shasum when all scripts are extracted out.
createFile(output, Html5Printer.stringify(document));
Document normalizedDocument = getFlattenedHTML5Document(document);
// Prevent from correcting the DOM structure and messing up the whitespace
// in the template.
normalizedDocument.outputSettings().prettyPrint(false);
createFile(output, normalizedDocument.toString());
}

private static void createFile(Path filePath, String content) throws IOException {
Expand Down Expand Up @@ -778,6 +783,120 @@ private static String extractAndTransformJavaScript(Document document, Webpath j
return scriptContent;
}

private static void cloneChildrenWithoutWhitespace(Element src, Element dest) {
List<Node> toMove = new ArrayList<Node>();
for (Node node : src.childNodes()) {
if (node instanceof TextNode && ((TextNode) node).isBlank()) {
continue;
}
toMove.add(node);
}
for (int i = 0; i < toMove.size(); i++) {
Node node = toMove.get(i);
dest.appendChild(node.clone());
}
}

/**
* When we inline the HTML based on `<link rel="import">` in `transform`, we
* replace the link element with parsed document. This makes us have nested
* documents and jsoup's Node.outerHtml (or Node.toString) are incapable of
* properly outputting that. Here, we flatten the document by combining all
* elements in `<head>` and `<body>` of nested document in one `<head>` and
* `<body>`.
*
* It also prepends <!doctype html> since TensorBoard requires that the
* document is HTML.
*
* NOTE: it makes side-effect to the input `document`.
*
* Examples:
* // Input
* <#root> <!-- document -->
* <html>
* <head>
* <#root>
* <html>
* <head>
* <script></script>
* <#root><html><body>welcome </body></html></#root>
* </head>
* <body>foo</body></html>
* </#root></head>
* <body><span>bar</span></body>
* </html>
* </html>
* // Output
* <#root> <!-- document -->
* <!doctype html>
* <html>
* <head><script></script></head>
* <body>welcome foo<span>bar</span></body>
* </html>
* </html>
**/
private static Document getFlattenedHTML5Document(Document document) {
Document flatDoc = new Document("/");

flatDoc.appendChild(new DocumentType("html", "", "", ""));

// Transfer comment nodes from the `document` level. They are important
// license comments
for (Node node : document.childNodes()) {
if (node instanceof Comment) {
flatDoc.appendChild(node.clone());
}
}

// Create `<html>`, `<head>` and `<body>`.
flatDoc.normalise();

document.traverse(new FlatDocumentCopier(flatDoc));

for (Element subdoc : flatDoc.getElementsByTag("#root")) {
if (subdoc != flatDoc) {
throw new RuntimeException(
"Nested doc (e.g., <link> importing outside the head of a a document) " +
"is not supported.");
}
}

return flatDoc;
}

private static class FlatDocumentCopier implements NodeVisitor {
private Element destHead;
private Element destBody;

public FlatDocumentCopier(Document dest) {
destHead = dest.head();
destBody = dest.body();
}

@Override
public void head(Node node, int depth) {
// Copy childNodes from `head` into the dest doc's head without
// modification if the node is not a `document` (or a `<#root>` element)
// in which case we want to traverse further and only copy the childNodes
// in its `body` and `head` elements.
if (node.parentNode() != null && node.parentNode().nodeName().equals("head")
&& !(node instanceof Document)) {
destHead.appendChild(node.clone());
}

if (node.nodeName().equals("body")) {
cloneChildrenWithoutWhitespace((Element) node, destBody);
// No need to further traverse the `body`. Skip by removing the nodes.
((Element) node).empty();
}
}

@Override
public void tail(Node node, int depth) {
// Copying is done during the `head`. No need to do any work.
}
}

private static final class JsPrintlessErrorManager extends BasicErrorManager {

@Override
Expand Down