Fix problems related to error visualisation evaluation

app/gui/CHANGELOG.md

@@ -9,11 +9,14 @@
 - [Fixed developer console errors related to Language Server (mentioning code
   3003 and "Invalid version"), occurring during project opening and after new
   node cration.][3186]
+- [Fixed developer console error about failing to decode a notification
+  "executionContext/visualisationEvaluationFailed"][3193]
 
 [3153]: https://github.com/enso-org/enso/pull/3153
 [3166]: https://github.com/enso-org/enso/pull/3166
 [3181]: https://github.com/enso-org/enso/pull/3181
 [3186]: https://github.com/enso-org/enso/pull/3186
+[3193]: https://github.com/enso-org/enso/pull/3193
 
 # Enso 2.0.0-alpha.18 (2021-10-12)
 

app/gui/controller/engine-protocol/src/language_server/types.rs

@@ -150,6 +150,11 @@ pub enum Notification {
     #[allow(missing_docs)]
     #[serde(rename = "file/rootRemoved")]
     ContentRootRemoved { id: Uuid },
+
+    /// Sent from server to the client to inform about a failure during execution of a
+    /// visualisation.
+    #[serde(rename = "executionContext/visualisationEvaluationFailed")]
+    VisualisationEvaluationFailed(VisualisationEvaluationFailed),
 }
 
 /// Sent from the server to the client to inform about a failure during execution of an execution
@@ -162,6 +167,18 @@ pub struct ExecutionFailed {
     pub message:    String,
 }
 
+/// Sent from server to the client to inform about a failure during execution of a visualisation.
+#[derive(Clone, Debug, Deserialize, PartialEq, Serialize)]
+#[allow(missing_docs)]
+#[serde(rename_all = "camelCase")]
+pub struct VisualisationEvaluationFailed {
+    pub context_id:       ContextId,
+    pub visualisation_id: Uuid,
+    pub expression_id:    ExpressionId,
+    pub message:          String,
+    pub diagnostic:       Option<Diagnostic>,
+}
+
 
 
 // =======================

app/gui/src/model/project/synchronized.rs

@@ -488,6 +488,14 @@ impl Project {
                         content_roots.remove(id);
                     }
                 }
+                Event::Notification(Notification::VisualisationEvaluationFailed(update)) => {
+                    error!(
+                        logger,
+                        "Visualisation evaluation failed in context {update.context_id} \
+                        for visualisation {update.visualisation_id} of expression \
+                        {update.expression_id}. Error: {update.message}."
+                    );
+                }
                 Event::Closed => {
                     error!(logger, "Lost JSON-RPC connection with the Language Server!");
                     let which = model::project::BackendConnection::LanguageServerJson;

app/gui/view/graph-editor/src/builtin/visualization/native/error.rs

@@ -29,16 +29,13 @@ use serde::Serialize;
 const PADDING_TEXT: f32 = 10.0;
 /// The Error Visualization preprocessor. See also _Lazy Visualization_ section
 /// [here](http://dev.enso.org/docs/ide/product/visualizations.html).
-pub const PREPROCESSOR_CODE: &str = r#"
-x ->
-    result = Builtins.Ref.new "{ message: \"\"}"
-    x.catch err->
-        message = err.to_display_text
-        Builtins.Ref.put result ("{ \"kind\": \"Dataflow\", \"message\": " + message.to_json.to_text + "}")
-    Builtins.Ref.get result
-"#;
+// NOTE: contents of this const need to be kept in sync with Scala test in
+// RuntimeVisualisationsTest.scala, used to verify the snippet's correctness
+pub const PREPROCESSOR_CODE: &str = include_str!("inc/error_preprocessor.enso");
 
 /// The context module for the `PREPROCESSOR_CODE`. See there.
+// NOTE: contents of this const need to be kept in sync with Scala test in
+// RuntimeVisualisationsTest.scala, used to verify the snippet's correctness
 pub const PREPROCESSOR_MODULE: &str = "Standard.Base.Main";
 
 /// Get preprocessor configuration for error visualization.

app/gui/view/graph-editor/src/builtin/visualization/native/inc/error_preprocessor.enso

@@ -0,0 +1,7 @@
+x ->
+    result = Builtins.Ref.new '{ message: ""}'
+    x.catch err->
+        message = err.to_display_text
+        Builtins.Ref.put result ('{ "kind": "Dataflow", "message": ' + message.to_json.to_text + '}')
+    Builtins.Ref.get result
+

build.sbt

@@ -1134,6 +1134,7 @@ lazy val runtime = (project in file("engine/runtime"))
     // Note [Unmanaged Classpath]
     Compile / unmanagedClasspath += (`core-definition` / Compile / packageBin).value,
     Test / unmanagedClasspath += (`core-definition` / Compile / packageBin).value,
+    Test / unmanagedClasspath += (baseDirectory.value / ".." / ".." / "app" / "gui" / "view" / "graph-editor" / "src" / "builtin" / "visualization" / "native" / "inc"),
     Compile / compile / compileInputs := (Compile / compile / compileInputs)
       .dependsOn(CopyTruffleJAR.preCompileTask)
       .value,

engine/runtime/src/test/scala/org/enso/interpreter/test/instrument/RuntimeVisualisationsTest.scala

@@ -21,6 +21,8 @@ import java.nio.file.{Files, Path, Paths}
 import java.util.UUID
 import java.util.concurrent.{LinkedBlockingQueue, TimeUnit}
 
+import scala.io.Source
+
 @scala.annotation.nowarn("msg=multiarg infix syntax")
 class RuntimeVisualisationsTest
     extends AnyFlatSpec
@@ -1853,4 +1855,103 @@ class RuntimeVisualisationsTest
       context.executionComplete(contextId)
     )
   }
+
+  it should "run internal IDE visualisation preprocessor catching error" in {
+    val contextId       = UUID.randomUUID()
+    val requestId       = UUID.randomUUID()
+    val visualisationId = UUID.randomUUID()
+    val moduleName      = "Enso_Test.Test.Main"
+    val metadata        = new Metadata
+
+    val idMain = metadata.addItem(77, 28)
+
+    val code =
+      """from Standard.Builtins import all
+        |import Standard.Base.Data.List
+        |
+        |main =
+        |    Error.throw List.Empty_Error
+        |""".stripMargin.linesIterator.mkString("\n")
+    val contents = metadata.appendToCode(code)
+    val mainFile = context.writeMain(contents)
+
+    // NOTE: below values need to be kept in sync with what is used internally by Rust IDE code
+    val visualisationModule = "Standard.Base.Main"
+    val visualisationCode   = Source.fromResource("error_preprocessor.enso").mkString
+
+    // create context
+    context.send(Api.Request(requestId, Api.CreateContextRequest(contextId)))
+    context.receive shouldEqual Some(
+      Api.Response(requestId, Api.CreateContextResponse(contextId))
+    )
+
+    // Open the new file
+    context.send(
+      Api.Request(Api.OpenFileNotification(mainFile, contents))
+    )
+    context.receiveNone shouldEqual None
+
+    // push main
+    val item1 = Api.StackItem.ExplicitCall(
+      Api.MethodPointer(moduleName, "Enso_Test.Test.Main", "main"),
+      None,
+      Vector()
+    )
+    context.send(
+      Api.Request(requestId, Api.PushContextRequest(contextId, item1))
+    )
+    val pushContextResponses =
+      context.receive(n = 4, timeoutSeconds = 60)
+    pushContextResponses should contain allOf (
+      Api.Response(requestId, Api.PushContextResponse(contextId)),
+      TestMessages.error(
+        contextId,
+        idMain,
+        Api.ExpressionUpdate.Payload.DataflowError(Seq())
+      ),
+      context.executionComplete(contextId)
+    )
+    val loadedLibraries = pushContextResponses.collect {
+      case Api.Response(None, Api.LibraryLoaded(namespace, name, _, _)) =>
+        (namespace, name)
+    }
+    loadedLibraries should contain(("Standard", "Base"))
+
+    // attach visualisation
+    context.send(
+      Api.Request(
+        requestId,
+        Api.AttachVisualisation(
+          visualisationId,
+          idMain,
+          Api.VisualisationConfiguration(
+            contextId,
+            visualisationModule,
+            visualisationCode
+          )
+        )
+      )
+    )
+    val attachVisualisationResponses = context.receive(3)
+    attachVisualisationResponses should contain allOf (
+      Api.Response(requestId, Api.VisualisationAttached()),
+      context.executionComplete(contextId)
+    )
+    val Some(data) = attachVisualisationResponses.collectFirst {
+      case Api.Response(
+            None,
+            Api.VisualisationUpdate(
+              Api.VisualisationContext(
+                `visualisationId`,
+                `contextId`,
+                `idMain`
+              ),
+              data
+            )
+          ) =>
+        data
+    }
+    val stringified = new String(data)
+    stringified shouldEqual """{ "kind": "Dataflow", "message": "The List is empty."}"""
+  }
 }