Add worksheet cancellation test

Author: Duhemm

language-server/test/dotty/tools/languageserver/WorksheetTest.scala

@@ -184,4 +184,12 @@ class WorksheetTest {
      .symbol("Baz", (m5 to m6).symInfo("Baz", SymbolKind.Class))
   }
 
+  @Test def worksheetCancel(): Unit = {
+    ws"""${m1}val foo = 1
+         val bar = 2
+         while (true) {}
+         val baz = 3""".withSource
+      .cancelEvaluation(m1, afterMs = 5000)
+  }
+
 }

language-server/test/dotty/tools/languageserver/util/CodeTester.scala

@@ -117,9 +117,30 @@ class CodeTester(sources: List[SourceWithPositions], actions: List[Action]) {
   def symbol(query: String, symbols: SymInfo*): this.type =
     doAction(new CodeSymbol(query, symbols))
 
+  /**
+   * Triggers evaluation of the worksheet specified by `marker`, verifies that the results of
+   * evaluation match `expected.
+   *
+   * @param marker   A marker a identifies the worksheet to evaluate.
+   * @param expected The expected output.
+   *
+   * @see dotty.tools.languageserver.util.actions.WorksheetEvaluate
+   */
   def evaluate(marker: CodeMarker, expected: String*): this.type =
     doAction(new WorksheetEvaluate(marker, expected))
 
+  /**
+   * Triggers evaluation of the worksheet specified by `marker`, then verifies that execution can be
+   * cancelled after `afterMs` milliseconds.
+   *
+   * @param marker   A marker that identifier the worksheet to evaluate.
+   * @param afterMs  The delay in milliseconds before cancelling execution.
+   *
+   * @see dotty.tools.languageserver.util.actions.WorksheetCancel
+   */
+  def cancelEvaluation(marker: CodeMarker, afterMs: Long): this.type =
+    doAction(new WorksheetCancel(marker, afterMs))
+
   private def doAction(action: Action): this.type = {
     try {
       action.execute()(testServer, testServer.client, positions)

language-server/test/dotty/tools/languageserver/util/actions/WorksheetAction.scala

@@ -0,0 +1,31 @@
+package dotty.tools.languageserver.util.actions
+
+import dotty.tools.languageserver.util.embedded.CodeMarker
+
+import org.eclipse.lsp4j.{DidSaveTextDocumentParams, MessageParams, MessageType}
+
+abstract class WorksheetAction extends Action {
+
+  def triggerEvaluation(marker: CodeMarker): Exec[Unit] = {
+    val file = marker.toTextDocumentIdentifier
+    server.didSave(new DidSaveTextDocumentParams(file))
+  }
+
+  def triggerCancellation(marker: CodeMarker): Exec[Unit] = {
+    val file = {
+      val file = marker.toTextDocumentIdentifier
+      file.setUri(file.getUri.replaceFirst("file:", "cancel:"))
+      file
+    }
+    server.didSave(new DidSaveTextDocumentParams(file))
+  }
+
+  def getLogs(marker: CodeMarker): Exec[List[String]] = {
+    def matches(params: MessageParams): Boolean =
+      params.getType == MessageType.Info && params.getMessage.startsWith(marker.file.uri)
+    client.log.get.collect {
+      case params: MessageParams if matches(params) =>
+        params.getMessage.substring(marker.file.uri.length).trim
+    }
+  }
+}

language-server/test/dotty/tools/languageserver/util/actions/WorksheetCancel.scala

@@ -0,0 +1,30 @@
+package dotty.tools.languageserver.util.actions
+
+import dotty.tools.languageserver.util.PositionContext
+import dotty.tools.languageserver.util.embedded.CodeMarker
+
+import org.junit.Assert.{assertEquals, fail}
+
+class WorksheetCancel(marker: CodeMarker, afterMs: Long) extends WorksheetAction {
+
+  private final val cancellationTimeoutMs = 10 * 1000
+
+  override def execute(): Exec[Unit] = {
+    triggerEvaluation(marker)
+    Thread.sleep(afterMs)
+    triggerCancellation(marker)
+
+    val timeAtCancellation = System.currentTimeMillis()
+    while (!getLogs(marker).contains("FINISHED")) {
+      if (System.currentTimeMillis() - timeAtCancellation > cancellationTimeoutMs) {
+        fail(s"Couldn't cancel worksheet evaluation after ${cancellationTimeoutMs} ms.")
+      }
+      Thread.sleep(100)
+    }
+
+    client.log.clear()
+  }
+
+  override def show: PositionContext.PosCtx[String] =
+    s"WorksheetCancel(${marker.file}, ${afterMs})"
+}

language-server/test/dotty/tools/languageserver/util/actions/WorksheetEvaluate.scala

@@ -1,32 +1,29 @@
 package dotty.tools.languageserver.util.actions
 
-import dotty.tools.languageserver.util.{PositionContext}
+import dotty.tools.languageserver.util.PositionContext
 import dotty.tools.languageserver.util.embedded.CodeMarker
 
-import org.eclipse.lsp4j.{DidSaveTextDocumentParams, MessageParams, MessageType}
+import org.junit.Assert.{assertEquals, fail}
 
-import org.junit.Assert.assertEquals
+class WorksheetEvaluate(marker: CodeMarker, expected: Seq[String]) extends WorksheetAction {
 
-class WorksheetEvaluate(marker: CodeMarker, expected: Seq[String]) extends Action {
-  override def execute(): Exec[Unit] = {
-    val file = marker.toTextDocumentIdentifier
-    server.didSave(new DidSaveTextDocumentParams(file))
+  private final val evaluationTimeoutMs = 30 * 1000
 
-    while (!getLogs(marker).contains("FINISHED")) Thread.sleep(100)
+  override def execute(): Exec[Unit] = {
+    triggerEvaluation(marker)
+
+    val timeAtEvaluation = System.currentTimeMillis()
+    while (!getLogs(marker).contains("FINISHED")) {
+      if (System.currentTimeMillis() - timeAtEvaluation > evaluationTimeoutMs) {
+        fail(s"Evaluation didn't finish after ${evaluationTimeoutMs} ms.")
+      }
+      Thread.sleep(100)
+    }
 
     assertEquals(expected, getLogs(marker).init)
     client.log.clear()
   }
 
   override def show: PositionContext.PosCtx[String] =
     s"WorksheetEvaluate(${marker.file}, ${expected})"
-
-  private def getLogs(marker: CodeMarker): Exec[List[String]] = {
-    def matches(params: MessageParams): Boolean =
-      params.getType == MessageType.Info && params.getMessage.startsWith(marker.file.uri)
-    client.log.get.collect {
-      case params: MessageParams if matches(params) =>
-        params.getMessage.substring(marker.file.uri.length).trim
-    }
-  }
 }