Design the Execution Management Functionality

[iamrecursion]

Summary

In addition to the standard language server functionality that we aim to provide over time (compile-time diagnostics, auto-completion, and so on), the nature of Enso and its visual environment means that we need to

Value

This functionality is the main building block for letting the GUI get updates on watched portions of the program.

Specification

• Work carefully to design the exact messages needed to support the following functionality. These messages may be able to be performed on top of executeCommand, or may require custom protocol extensions. This is not yet known:
  • Execution of a function with provided arguments.
  • Execution of a function from a given call site (stack position and code position).
  • Attach an execution listener to an arbitrary code span.
  • Detach an execution listener by ID.
  • Implement heartbeat messages for execution listeners. If a heartbeat response isn't received before some time-out, the language server should detach the listener.
  • Force cache invalidation for arbitrary code spans.
  • Attach an automatic execution request.
  • Detach an automatic execution request.
  • Redirect stdout/stdin/stderr to and from the IDE, and exactly how this should work.
• For each of the above messages, ensure that they are specified in the design document.

Acceptance Criteria & Test Cases

• We have a coherent design for how this portion of the integration is going to work.