From c4d6efe5afd91ac53c2111d1330891407273a3ee Mon Sep 17 00:00:00 2001 From: Eugene Yokota Date: Thu, 4 Apr 2019 22:48:40 -0400 Subject: [PATCH] move super shell rendering to logger Fixes #4583 Ref https://github.com/sbt/util/pull/196 --- main/src/main/scala/sbt/EvaluateTask.scala | 6 +- .../sbt/internal/AbstractTaskProgress.scala | 4 +- .../main/scala/sbt/internal/LogManager.scala | 10 +++ .../scala/sbt/internal/TaskProgress.scala | 73 ++++++------------- 4 files changed, 41 insertions(+), 52 deletions(-) diff --git a/main/src/main/scala/sbt/EvaluateTask.scala b/main/src/main/scala/sbt/EvaluateTask.scala index a6fab3b55..d0db3a307 100644 --- a/main/src/main/scala/sbt/EvaluateTask.scala +++ b/main/src/main/scala/sbt/EvaluateTask.scala @@ -170,7 +170,11 @@ object EvaluateTask { Some(sharedTraceEvent) } else None - def taskProgress: ExecuteProgress[Task] = new TaskProgress() + def taskProgress: ExecuteProgress[Task] = { + val appender = MainAppender.defaultScreen(StandardMain.console) + val log = LogManager.progressLogger(appender) + new TaskProgress(log) + } // sbt-pgp calls this @deprecated("No longer used", "1.3.0") diff --git a/main/src/main/scala/sbt/internal/AbstractTaskProgress.scala b/main/src/main/scala/sbt/internal/AbstractTaskProgress.scala index 0565a57c0..082c18419 100644 --- a/main/src/main/scala/sbt/internal/AbstractTaskProgress.scala +++ b/main/src/main/scala/sbt/internal/AbstractTaskProgress.scala @@ -75,7 +75,7 @@ object AbstractTaskExecuteProgress { def durationNanos: Long = endNanos - startNanos def startMicros: Long = (startNanos.toDouble / 1000).toLong def durationMicros: Long = (durationNanos.toDouble / 1000).toLong - def currentElapsedSeconds: Long = - ((System.nanoTime() - startNanos).toDouble / 1000000000L).toLong + def currentElapsedMicros: Long = + ((System.nanoTime() - startNanos).toDouble / 1000).toLong } } diff --git a/main/src/main/scala/sbt/internal/LogManager.scala b/main/src/main/scala/sbt/internal/LogManager.scala index 09a1d407e..12678337f 100644 --- a/main/src/main/scala/sbt/internal/LogManager.scala +++ b/main/src/main/scala/sbt/internal/LogManager.scala @@ -246,6 +246,16 @@ object LogManager { s1 } + def progressLogger(appender: Appender): ManagedLogger = { + val log = LogExchange.logger("progress", None, None) + LogExchange.unbindLoggerAppenders("progress") + LogExchange.bindLoggerAppenders( + "progress", + List(appender -> Level.Info) + ) + log + } + // This is the default implementation for the relay appender val defaultRelay: Unit => Appender = _ => defaultRelayImpl diff --git a/main/src/main/scala/sbt/internal/TaskProgress.scala b/main/src/main/scala/sbt/internal/TaskProgress.scala index 438e1f287..c9d931743 100644 --- a/main/src/main/scala/sbt/internal/TaskProgress.scala +++ b/main/src/main/scala/sbt/internal/TaskProgress.scala @@ -8,15 +8,24 @@ package sbt package internal -import sbt.internal.util.{ RMap, ConsoleOut, ConsoleAppender, LogOption, JLine } +import sbt.internal.util.{ + RMap, + ConsoleOut, + ConsoleAppender, + LogOption, + JLine, + ManagedLogger, + ProgressEvent, + ProgressItem +} +import sbt.util.Level import scala.concurrent.{ blocking, Future, ExecutionContext } import java.util.concurrent.atomic.{ AtomicBoolean, AtomicInteger } -import TaskProgress._ /** * implements task progress display on the shell. */ -private[sbt] final class TaskProgress +private[sbt] final class TaskProgress(log: ManagedLogger) extends AbstractTaskExecuteProgress with ExecuteProgress[Task] { private[this] val isReady = new AtomicBoolean(false) @@ -55,72 +64,38 @@ private[sbt] final class TaskProgress private[this] val console = ConsoleOut.systemOut override def afterAllCompleted(results: RMap[Task, Result]): Unit = { + // send an empty progress report to clear out the previous report + val event = ProgressEvent("Info", Vector(), Some(lastTaskCount.get), None, None) + import sbt.internal.util.codec.JsonProtocol._ + log.logEvent(Level.Info, event) isAllCompleted.set(true) - // completionReport() } private[this] val skipReportTasks = Set("run", "bgRun", "fgRun", "scala", "console", "consoleProject") private[this] def report(): Unit = console.lockObject.synchronized { - val currentTasks = activeTasks.toList + val currentTasks = activeTasks.toVector val ltc = lastTaskCount.get val currentTasksCount = currentTasks.size def report0(): Unit = { - console.print(s"$CursorDown1") - currentTasks foreach { task => - val elapsed = timings.get(task).currentElapsedSeconds - console.println(s"$DeleteLine | => ${taskName(task)} ${elapsed}s") - } - if (ltc > currentTasksCount) deleteConsoleLines(ltc - currentTasksCount) - else () - console.print(cursorUp(math.max(currentTasksCount, ltc) + 1)) + val event = ProgressEvent("Info", currentTasks map { task => + val elapsed = timings.get(task).currentElapsedMicros + ProgressItem(taskName(task), elapsed) + }, Some(ltc), None, None) + import sbt.internal.util.codec.JsonProtocol._ + log.logEvent(Level.Info, event) } if (containsSkipTasks(currentTasks)) () else report0() lastTaskCount.set(currentTasksCount) } - // todo: use logger instead of console - // private[this] def completionReport(): Unit = console.lockObject.synchronized { - // val completedTasks = timings.asScala.toList - // val notableTasks = completedTasks - // .filter({ - // case (_, time: Long) => time >= 1000000000L * 10L - // }) - // .sortBy({ - // case (_, time: Long) => -time - // }) - // .take(5) - // def report0(): Unit = { - // console.print(s"$CursorDown1") - // console.println(s"$DeleteLine notable completed tasks:") - // notableTasks foreach { - // case (task, time) => - // val elapsed = time / 1000000000L - // console.println(s"$DeleteLine | => ${taskName(task)} ${elapsed}s") - // } - // } - // if (containsSkipTasks(notableTasks) || notableTasks.isEmpty) () - // else report0() - // } - - private[this] def containsSkipTasks(tasks: List[Task[_]]): Boolean = + private[this] def containsSkipTasks(tasks: Vector[Task[_]]): Boolean = tasks .map(t => taskName(t)) .exists(n => skipReportTasks.exists(m => n.endsWith("/ " + m))) - - private[this] def deleteConsoleLines(n: Int): Unit = { - (1 to n) foreach { _ => - console.println(DeleteLine) - } - } } private[sbt] object TaskProgress { - final val DeleteLine = "\u001B[2K" - def cursorUp(n: Int): String = s"\u001B[${n}A" - def cursorDown(n: Int): String = s"\u001B[${n}B" - final val CursorDown1 = cursorDown(1) - def isEnabled: Boolean = ConsoleAppender.formatEnabledInEnv && sys.props .get("sbt.supershell")