Skip to content

[SPARK-13755] Escape quotes in SQL plan visualization node labels #11587

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

Closed
wants to merge 3 commits into from
Closed

[SPARK-13755] Escape quotes in SQL plan visualization node labels #11587

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3ac22fe
Escape quotes in graphviz labels.
JoshRosen Mar 8, 2016
531adb7
Switch to StringEscapeUtils.escapeJava
JoshRosen Mar 8, 2016
8bf1ba2
Avoid double-escaping.
JoshRosen Mar 8, 2016
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
14 changes: 7 additions & 7 deletions sql/core/src/main/scala/org/apache/spark/sql/execution/ui/SparkPlanGraph.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ import java.util.concurrent.atomic.AtomicLong

import scala.collection.mutable

import org.apache.commons.lang3.StringEscapeUtils

import org.apache.spark.sql.execution.SparkPlanInfo
import org.apache.spark.sql.execution.metric.SQLMetrics

Expand Down Expand Up @@ -136,16 +138,14 @@ private[ui] class SparkPlanGraphNode(
}

if (values.nonEmpty) {
// If there are metrics, display each entry in a separate line. We should use an escaped
// "\n" here to follow the dot syntax.
//
// If there are metrics, display each entry in a separate line.
// Note: whitespace between two "\n"s is to create an empty line between the name of
// SparkPlan and metrics. If removing it, it won't display the empty line in UI.
builder ++= "\\n \\n"
builder ++= values.mkString("\\n")
builder ++= "\n \n"
builder ++= values.mkString("\n")
}

s""" $id [label="${builder.toString()}"];"""
s""" $id [label="${StringEscapeUtils.escapeJava(builder.toString())}"];"""
}
}

Expand All @@ -162,7 +162,7 @@ private[ui] class SparkPlanGraphCluster(
override def makeDotNode(metricsValue: Map[Long, String]): String = {
s"""
| subgraph cluster${id} {
| label=${name};
| label="${StringEscapeUtils.escapeJava(name)}";
| ${nodes.map(_.makeDotNode(metricsValue)).mkString(" \n")}
| }
""".stripMargin
Expand Down