Simplify UIUtils.headerSparkPage signature.

Marcelo Vanzin · Marcelo Vanzin · commit 4412fc6fd34c · 2014-08-08T14:49:29.000-07:00
Also some other cleanup.
diff --git a/core/src/main/scala/org/apache/spark/deploy/master/Master.scala b/core/src/main/scala/org/apache/spark/deploy/master/Master.scala
@@ -697,7 +697,7 @@ private[spark] class Master(
       appIdToUI(app.id) = ui
       webUi.attachSparkUI(ui)
       // Application UI is successfully rebuilt, so link the Master UI to it
-      app.desc.appUiUrl = ui.getBasePath()
+      app.desc.appUiUrl = ui.getBasePath
       true
     } catch {
       case e: Exception =>
diff --git a/core/src/main/scala/org/apache/spark/ui/SparkUI.scala b/core/src/main/scala/org/apache/spark/ui/SparkUI.scala
@@ -76,7 +76,7 @@ private[spark] class SparkUI(
     }
   }
 
-  def getAppName() = appName
+  def getAppName = appName
 
   /** Set the app name for this UI. */
   def setAppName(name: String) {
@@ -105,7 +105,7 @@ private[spark] class SparkUI(
 private[spark] abstract class SparkUITab(parent: SparkUI, prefix: String)
   extends WebUITab(parent, prefix) {
 
-  def getAppName(): String = parent.getAppName()
+  def appName: String = parent.getAppName
 
 }
 
diff --git a/core/src/main/scala/org/apache/spark/ui/UIUtils.scala b/core/src/main/scala/org/apache/spark/ui/UIUtils.scala
@@ -163,17 +163,15 @@ private[spark] object UIUtils extends Logging {
 
   /** Returns a spark page with correctly formatted headers */
   def headerSparkPage(
-      content: => Seq[Node],
-      basePath: String,
-      appName: String,
       title: String,
-      tabs: Seq[WebUITab],
-      activeTab: WebUITab,
+      content: => Seq[Node],
+      activeTab: SparkUITab,
       refreshInterval: Option[Int] = None): Seq[Node] = {
 
-    val header = tabs.map { tab =>
+    val appName = activeTab.appName
+    val header = activeTab.headerTabs.map { tab =>
       <li class={if (tab == activeTab) "active" else ""}>
-        <a href={prependBaseUri(basePath, "/" + tab.prefix)}>{tab.name}</a>
+        <a href={prependBaseUri(activeTab.basePath, "/" + tab.prefix)}>{tab.name}</a>
       </li>
     }
 
diff --git a/core/src/main/scala/org/apache/spark/ui/WebUI.scala b/core/src/main/scala/org/apache/spark/ui/WebUI.scala
@@ -50,7 +50,7 @@ private[spark] abstract class WebUI(
   protected val publicHostName = Option(System.getenv("SPARK_PUBLIC_DNS")).getOrElse(localHostName)
   private val className = Utils.getFormattedClassName(this)
 
-  def getBasePath(): String = basePath
+  def getBasePath: String = basePath
   def getTabs: Seq[WebUITab] = tabs.toSeq
   def getHandlers: Seq[ServletContextHandler] = handlers.toSeq
   def getSecurityManager: SecurityManager = securityManager
@@ -137,7 +137,7 @@ private[spark] abstract class WebUITab(parent: WebUI, val prefix: String) {
   /** Get a list of header tabs from the parent UI. */
   def headerTabs: Seq[WebUITab] = parent.getTabs
 
-  def getBasePath(): String = parent.getBasePath()
+  def basePath: String = parent.getBasePath
 }
 
 
diff --git a/core/src/main/scala/org/apache/spark/ui/env/EnvironmentPage.scala b/core/src/main/scala/org/apache/spark/ui/env/EnvironmentPage.scala
@@ -43,8 +43,7 @@ private[ui] class EnvironmentPage(parent: EnvironmentTab) extends WebUIPage("")
         <h4>Classpath Entries</h4> {classpathEntriesTable}
       </span>
 
-    UIUtils.headerSparkPage(content, parent.getBasePath(), parent.getAppName(), "Environment",
-      parent.headerTabs, parent)
+    UIUtils.headerSparkPage("Environment", content, parent)
   }
 
   private def propertyHeader = Seq("Name", "Value")
diff --git a/core/src/main/scala/org/apache/spark/ui/exec/ExecutorsPage.scala b/core/src/main/scala/org/apache/spark/ui/exec/ExecutorsPage.scala
@@ -99,8 +99,7 @@ private[ui] class ExecutorsPage(parent: ExecutorsTab) extends WebUIPage("") {
         </div>
       </div>;
 
-    UIUtils.headerSparkPage(content, parent.getBasePath(), parent.getAppName(),
-      "Executors (" + execInfo.size + ")", parent.headerTabs, parent)
+    UIUtils.headerSparkPage("Executors (" + execInfo.size + ")", content, parent)
   }
 
   /** Render an HTML row representing an executor */
diff --git a/core/src/main/scala/org/apache/spark/ui/jobs/JobProgressPage.scala b/core/src/main/scala/org/apache/spark/ui/jobs/JobProgressPage.scala
@@ -92,8 +92,7 @@ private[ui] class JobProgressPage(parent: JobProgressTab) extends WebUIPage("")
         <h4 id ="failed">Failed Stages ({failedStages.size})</h4> ++
         failedStagesTable.toNodeSeq
 
-      UIUtils.headerSparkPage(content, parent.getBasePath(), parent.getAppName(),
-        "Spark Stages", parent.headerTabs, parent)
+      UIUtils.headerSparkPage("Spark Stages", content, parent)
     }
   }
 }
diff --git a/core/src/main/scala/org/apache/spark/ui/jobs/PoolPage.scala b/core/src/main/scala/org/apache/spark/ui/jobs/PoolPage.scala
@@ -49,8 +49,7 @@ private[ui] class PoolPage(parent: JobProgressTab) extends WebUIPage("pool") {
         <h4>Summary </h4> ++ poolTable.toNodeSeq ++
         <h4>{activeStages.size} Active Stages</h4> ++ activeStagesTable.toNodeSeq
 
-      UIUtils.headerSparkPage(content, parent.getBasePath(), parent.getAppName(),
-        "Fair Scheduler Pool: " + poolName, parent.headerTabs, parent)
+      UIUtils.headerSparkPage("Fair Scheduler Pool: " + poolName, content, parent)
     }
   }
 }
diff --git a/core/src/main/scala/org/apache/spark/ui/jobs/PoolTable.scala b/core/src/main/scala/org/apache/spark/ui/jobs/PoolTable.scala
@@ -59,7 +59,7 @@ private[ui] class PoolTable(pools: Seq[Schedulable], parent: JobProgressTab) {
       case None => 0
     }
     val href = "%s/stages/pool?poolname=%s"
-      .format(UIUtils.prependBaseUri(parent.getBasePath()), p.name)
+      .format(UIUtils.prependBaseUri(parent.basePath), p.name)
     <tr>
       <td>
         <a href={href}>{p.name}</a>
diff --git a/core/src/main/scala/org/apache/spark/ui/jobs/StagePage.scala b/core/src/main/scala/org/apache/spark/ui/jobs/StagePage.scala
@@ -42,8 +42,7 @@ private[ui] class StagePage(parent: JobProgressTab) extends WebUIPage("stage") {
             <h4>Summary Metrics</h4> No tasks have started yet
             <h4>Tasks</h4> No tasks have started yet
           </div>
-        return UIUtils.headerSparkPage(content, parent.getBasePath(), parent.getAppName(),
-          "Details for Stage %s".format(stageId), parent.headerTabs, parent)
+        return UIUtils.headerSparkPage("Details for Stage %s".format(stageId), content, parent)
       }
 
       val stageData = stageDataOption.get
@@ -225,8 +224,7 @@ private[ui] class StagePage(parent: JobProgressTab) extends WebUIPage("stage") {
         maybeAccumulableTable ++
         <h4>Tasks</h4> ++ taskTable
 
-      UIUtils.headerSparkPage(content, parent.getBasePath(), parent.getAppName(),
-        "Details for Stage %d".format(stageId), parent.headerTabs, parent)
+      UIUtils.headerSparkPage("Details for Stage %d".format(stageId), content, parent)
     }
   }
 
diff --git a/core/src/main/scala/org/apache/spark/ui/jobs/StageTable.scala b/core/src/main/scala/org/apache/spark/ui/jobs/StageTable.scala
@@ -88,7 +88,7 @@ private[ui] class StageTableBase(
     // scalastyle:off
     val killLink = if (killEnabled) {
       val killLinkUri = "%s/stages/stage/kill?id=%s&terminate=true"
-        .format(UIUtils.prependBaseUri(parent.getBasePath()), s.stageId)
+        .format(UIUtils.prependBaseUri(parent.basePath), s.stageId)
       val confirm = "return window.confirm('Are you sure you want to kill stage %s ?');"
         .format(s.stageId)
       <span class="kill-link">
@@ -98,7 +98,7 @@ private[ui] class StageTableBase(
     // scalastyle:on
 
     val nameLinkUri ="%s/stages/stage?id=%s"
-      .format(UIUtils.prependBaseUri(parent.getBasePath()), s.stageId)
+      .format(UIUtils.prependBaseUri(parent.basePath), s.stageId)
     val nameLink = <a href={nameLinkUri}>{s.name}</a>
 
     val cachedRddInfos = s.rddInfos.filter(_.numCachedPartitions > 0)
@@ -112,7 +112,7 @@ private[ui] class StageTableBase(
           Text("RDD: ") ++
           // scalastyle:off
           cachedRddInfos.map { i =>
-            <a href={"%s/storage/rdd?id=%d".format(UIUtils.prependBaseUri(parent.getBasePath()), i.id)}>{i.name}</a>
+            <a href={"%s/storage/rdd?id=%d".format(UIUtils.prependBaseUri(parent.basePath), i.id)}>{i.name}</a>
           }
           // scalastyle:on
         }}
@@ -158,7 +158,7 @@ private[ui] class StageTableBase(
     {if (isFairScheduler) {
       <td>
         <a href={"%s/stages/pool?poolname=%s"
-          .format(UIUtils.prependBaseUri(parent.getBasePath()), stageData.schedulingPool)}>
+          .format(UIUtils.prependBaseUri(parent.basePath), stageData.schedulingPool)}>
           {stageData.schedulingPool}
         </a>
       </td>
diff --git a/core/src/main/scala/org/apache/spark/ui/storage/RDDPage.scala b/core/src/main/scala/org/apache/spark/ui/storage/RDDPage.scala
@@ -34,8 +34,7 @@ private[ui] class RDDPage(parent: StorageTab) extends WebUIPage("rdd") {
     val storageStatusList = listener.storageStatusList
     val rddInfo = listener.rddInfoList.find(_.id == rddId).getOrElse {
       // Rather than crashing, render an "RDD Not Found" page
-      return UIUtils.headerSparkPage(Seq[Node](), parent.getBasePath(), parent.getAppName(),
-        "RDD Not Found", parent.headerTabs, parent)
+      return UIUtils.headerSparkPage("RDD Not Found", Seq[Node](), parent)
     }
 
     // Worker table
@@ -94,8 +93,7 @@ private[ui] class RDDPage(parent: StorageTab) extends WebUIPage("rdd") {
         </div>
       </div>;
 
-    UIUtils.headerSparkPage(content, parent.getBasePath(), parent.getAppName(),
-      "RDD Storage Info for " + rddInfo.name, parent.headerTabs, parent)
+    UIUtils.headerSparkPage("RDD Storage Info for " + rddInfo.name, content, parent)
   }
 
   /** Header fields for the worker table */
diff --git a/core/src/main/scala/org/apache/spark/ui/storage/StoragePage.scala b/core/src/main/scala/org/apache/spark/ui/storage/StoragePage.scala
@@ -32,8 +32,7 @@ private[ui] class StoragePage(parent: StorageTab) extends WebUIPage("") {
   def render(request: HttpServletRequest): Seq[Node] = {
     val rdds = listener.rddInfoList
     val content = UIUtils.listingTable(rddHeader, rddRow, rdds)
-    UIUtils.headerSparkPage(content, parent.getBasePath(), parent.getAppName(), "Storage ",
-      parent.headerTabs, parent)
+    UIUtils.headerSparkPage("Storage", content, parent)
   }
 
   /** Header fields for the RDD table */
@@ -51,7 +50,7 @@ private[ui] class StoragePage(parent: StorageTab) extends WebUIPage("") {
     // scalastyle:off
     <tr>
       <td>
-        <a href={"%s/storage/rdd?id=%s".format(UIUtils.prependBaseUri(parent.getBasePath()), rdd.id)}>
+        <a href={"%s/storage/rdd?id=%s".format(UIUtils.prependBaseUri(parent.basePath), rdd.id)}>
           {rdd.name}
         </a>
       </td>
diff --git a/streaming/src/main/scala/org/apache/spark/streaming/ui/StreamingPage.scala b/streaming/src/main/scala/org/apache/spark/streaming/ui/StreamingPage.scala
@@ -42,8 +42,7 @@ private[ui] class StreamingPage(parent: StreamingTab)
       <h4>Statistics over last {listener.retainedCompletedBatches.size} processed batches</h4> ++
       generateReceiverStats() ++
       generateBatchStatsTable()
-    UIUtils.headerSparkPage(content, parent.getBasePath(), parent.getAppName(), "Streaming",
-      parent.headerTabs, parent, Some(5000))
+    UIUtils.headerSparkPage("Streaming", content, parent, Some(5000))
   }
 
   /** Generate basic stats of the streaming program */

Original file line number	Diff line number	Diff line change
`@@ -76,7 +76,7 @@ private[spark] class SparkUI(`
`76`	`76`	`}`
`77`	`77`	`}`
`78`	`78`
`79`		`- def getAppName() = appName`
	`79`	`+ def getAppName = appName`
`80`	`80`
`81`	`81`	`/** Set the app name for this UI. */`
`82`	`82`	`def setAppName(name: String) {`
`@@ -105,7 +105,7 @@ private[spark] class SparkUI(`
`105`	`105`	`private[spark] abstract class SparkUITab(parent: SparkUI, prefix: String)`
`106`	`106`	`extends WebUITab(parent, prefix) {`
`107`	`107`
`108`		`- def getAppName(): String = parent.getAppName()`
	`108`	`+ def appName: String = parent.getAppName`
`109`	`109`
`110`	`110`	`}`
`111`	`111`
Original file line number	Diff line number	Diff line change
`@@ -43,8 +43,7 @@ private[ui] class EnvironmentPage(parent: EnvironmentTab) extends WebUIPage("")`
`43`	`43`	`<h4>Classpath Entries</h4> {classpathEntriesTable}`
`44`	`44`	`</span>`
`45`	`45`
`46`		`- UIUtils.headerSparkPage(content, parent.getBasePath(), parent.getAppName(), "Environment",`
`47`		`- parent.headerTabs, parent)`
	`46`	`+ UIUtils.headerSparkPage("Environment", content, parent)`
`48`	`47`	`}`
`49`	`48`
`50`	`49`	`private def propertyHeader = Seq("Name", "Value")`
Original file line number	Diff line number	Diff line change
`@@ -99,8 +99,7 @@ private[ui] class ExecutorsPage(parent: ExecutorsTab) extends WebUIPage("") {`
`99`	`99`	`</div>`
`100`	`100`	`</div>;`
`101`	`101`
`102`		`- UIUtils.headerSparkPage(content, parent.getBasePath(), parent.getAppName(),`
`103`		`- "Executors (" + execInfo.size + ")", parent.headerTabs, parent)`
	`102`	`+ UIUtils.headerSparkPage("Executors (" + execInfo.size + ")", content, parent)`
`104`	`103`	`}`
`105`	`104`
`106`	`105`	`/** Render an HTML row representing an executor */`
Original file line number	Diff line number	Diff line change
`@@ -92,8 +92,7 @@ private[ui] class JobProgressPage(parent: JobProgressTab) extends WebUIPage("")`
`92`	`92`	`<h4 id ="failed">Failed Stages ({failedStages.size})</h4> ++`
`93`	`93`	`failedStagesTable.toNodeSeq`
`94`	`94`
`95`		`- UIUtils.headerSparkPage(content, parent.getBasePath(), parent.getAppName(),`
`96`		`- "Spark Stages", parent.headerTabs, parent)`
	`95`	`+ UIUtils.headerSparkPage("Spark Stages", content, parent)`
`97`	`96`	`}`
`98`	`97`	`}`
`99`	`98`	`}`
Original file line number	Diff line number	Diff line change
`@@ -49,8 +49,7 @@ private[ui] class PoolPage(parent: JobProgressTab) extends WebUIPage("pool") {`
`49`	`49`	`<h4>Summary </h4> ++ poolTable.toNodeSeq ++`
`50`	`50`	`<h4>{activeStages.size} Active Stages</h4> ++ activeStagesTable.toNodeSeq`
`51`	`51`
`52`		`- UIUtils.headerSparkPage(content, parent.getBasePath(), parent.getAppName(),`
`53`		`- "Fair Scheduler Pool: " + poolName, parent.headerTabs, parent)`
	`52`	`+ UIUtils.headerSparkPage("Fair Scheduler Pool: " + poolName, content, parent)`
`54`	`53`	`}`
`55`	`54`	`}`
`56`	`55`	`}`
Original file line number	Diff line number	Diff line change
`@@ -59,7 +59,7 @@ private[ui] class PoolTable(pools: Seq[Schedulable], parent: JobProgressTab) {`
`59`	`59`	`case None => 0`
`60`	`60`	`}`
`61`	`61`	`val href = "%s/stages/pool?poolname=%s"`
`62`		`- .format(UIUtils.prependBaseUri(parent.getBasePath()), p.name)`
	`62`	`+ .format(UIUtils.prependBaseUri(parent.basePath), p.name)`
`63`	`63`	`<tr>`
`64`	`64`	`<td>`
`65`	`65`	`<a href={href}>{p.name}</a>`
Original file line number	Diff line number	Diff line change
`@@ -42,8 +42,7 @@ private[ui] class StagePage(parent: JobProgressTab) extends WebUIPage("stage") {`
`42`	`42`	`<h4>Summary Metrics</h4> No tasks have started yet`
`43`	`43`	`<h4>Tasks</h4> No tasks have started yet`
`44`	`44`	`</div>`
`45`		`- return UIUtils.headerSparkPage(content, parent.getBasePath(), parent.getAppName(),`
`46`		`- "Details for Stage %s".format(stageId), parent.headerTabs, parent)`
	`45`	`+ return UIUtils.headerSparkPage("Details for Stage %s".format(stageId), content, parent)`
`47`	`46`	`}`
`48`	`47`
`49`	`48`	`val stageData = stageDataOption.get`
`@@ -225,8 +224,7 @@ private[ui] class StagePage(parent: JobProgressTab) extends WebUIPage("stage") {`
`225`	`224`	`maybeAccumulableTable ++`
`226`	`225`	`<h4>Tasks</h4> ++ taskTable`
`227`	`226`
`228`		`- UIUtils.headerSparkPage(content, parent.getBasePath(), parent.getAppName(),`
`229`		`- "Details for Stage %d".format(stageId), parent.headerTabs, parent)`
	`227`	`+ UIUtils.headerSparkPage("Details for Stage %d".format(stageId), content, parent)`
`230`	`228`	`}`
`231`	`229`	`}`
`232`	`230`