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

Jump to bottom

Debug: capture and log routes (splits) #4294

Merged
merged 1 commit into from
Sep 20, 2024
Merged

Debug: capture and log routes (splits) #4294

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions scalafmt-core/shared/src/main/scala/org/scalafmt/config/FormatEvent.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ sealed abstract class FormatEvent

object FormatEvent {
case class CreateFormatOps(formatOps: FormatOps) extends FormatEvent
case class Routes(routes: IndexedSeq[Seq[Split]]) extends FormatEvent
case class VisitToken(formatToken: FormatToken) extends FormatEvent
case class Explored(n: Int, depth: Int, queueSize: Int) extends FormatEvent
case class Enqueue(split: Split) extends FormatEvent
Expand Down
1 change: 1 addition & 0 deletions scalafmt-core/shared/src/main/scala/org/scalafmt/internal/BestFirstSearch.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -320,6 +320,7 @@ private class BestFirstSearch private (range: Set[Range])(implicit
style.runner.event(FormatEvent.CompleteFormat(explored, state, visits, best))

def getBestPath: SearchResult = {
initStyle.runner.event(FormatEvent.Routes(routes))
val state = {
def run = shortestPath(State.start, topSourceTree.tokens.last)
val state = run
Expand Down
29 changes: 21 additions & 8 deletions scalafmt-tests/shared/src/test/scala/org/scalafmt/Debug.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
package org.scalafmt

import org.scalafmt.config.FormatEvent.CompleteFormat
import org.scalafmt.config.FormatEvent._
import org.scalafmt.internal.FormatOps
import org.scalafmt.internal.FormatWriter
import org.scalafmt.internal.Split
Expand All @@ -20,6 +20,7 @@ class Debug(val verbose: Boolean) {

val enqueuedSplits = mutable.Set.empty[Split]
var formatOps: FormatOps = _
var routes: IndexedSeq[Seq[Split]] = _
var completedEvent: Option[CompleteFormat] = None
var locations: FormatWriter#FormatLocations = _
val startTime = System.nanoTime()
Expand Down Expand Up @@ -52,7 +53,7 @@ class Debug(val verbose: Boolean) {
LoggerOps.logger.debug(sb.toString())
}

completedEvent.foreach(x => Debug.printCompletedEvent(x, formatOps))
completedEvent.foreach(x => Debug.printCompletedEvent(x, routes, formatOps))
}

}
Expand All @@ -63,10 +64,13 @@ object Debug {

def printCompletedEvent(
completedEvent: CompleteFormat,
routes: IndexedSeq[Seq[Split]],
formatOps: FormatOps,
): Unit = {
val toks = if (null == formatOps) null else formatOps.tokens.arr
if (null != toks) {
import LoggerOps._

if (null != completedEvent.visits) {
val sb = new StringBuilder()
sb.append("Visited ").append(completedEvent.totalExplored).append(":")
Expand All @@ -75,17 +79,26 @@ object Debug {
.append(toks(idx))
}
sb.append("\n")
LoggerOps.logger.debug(sb.toString())
logger.debug(sb.toString())
}

if (null != completedEvent.best) {
val sb = new StringBuilder()
sb.append("Best splits:")
completedEvent.best.values.toSeq.sortBy(_.depth).take(5).foreach {
state => sb.append("\n\t").append(LoggerOps.log(state))
state => sb.append("\n\t").append(log(state))
}
sb.append("\n")
LoggerOps.logger.debug(sb.toString())
logger.debug(sb.toString())
}

if (null ne routes) {
var tokidx = 0
while (tokidx < toks.length) {
logger.debug(s"FT: ${log2(toks(tokidx))}")
routes(tokidx).foreach(s => logger.debug(s"> S: ${log(s)}"))
tokidx += 1
}
}

val stack = new mutable.ListBuffer[String]
Expand All @@ -95,7 +108,7 @@ object Debug {
val prev = state.prev
val idx = prev.depth
val tok = toks(idx).left
val clean = "%-15s".format(LoggerOps.cleanup(tok).slice(0, 15))
val clean = "%-15s".format(cleanup(tok).slice(0, 15))
stack.prepend(
s"[$idx] ${posWidth.format(tok.end)}: $clean" +
s" ${state.split} ${prev.indentation} ${prev.column} [${state.cost}]",
Expand All @@ -105,8 +118,8 @@ object Debug {
val finalState = completedEvent.finalState
if (null != finalState) {
if (finalState ne State.start) iter(finalState)
stack.foreach(LoggerOps.logger.debug)
LoggerOps.logger.debug(s"Total cost: ${finalState.cost}")
stack.foreach(logger.debug)
logger.debug(s"Total cost: ${finalState.cost}")
}
}
}
Expand Down
4 changes: 2 additions & 2 deletions scalafmt-tests/shared/src/test/scala/org/scalafmt/util/HasTests.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@ trait HasTests extends FormatAssertions {
maxStateVisits = 150000,
eventCallback = {
case CreateFormatOps(ops) => dg.formatOps = ops
case explored: Explored if explored.n % 10000 == 0 =>
logger.elem(explored)
case Routes(routes) => dg.routes = routes
case explored: Explored if explored.n % 10000 == 0 => logger.elem(explored)
case Enqueue(split) => dg.enqueued(split)
case evt: CompleteFormat => dg.completed(evt)
case x: Written => dg.locations = x.formatLocations
Expand Down
Loading