Add doctest circle indicator on editor (Looking for early feedback)

[Sleepful]

After running doctests inside livebook, add a circle inside the editor to indicate the iex> prompts that succeeded or failed after evaluation.

Example:

Currently lacking some details but I tried to illustrate the main idea before turning it into a functional implementation. I want to get some approval on what I intend to do before moving into coding it properly. Do tell me if any of the commented code looks like it is in the wrong place. I also left a question in one of the comments.

[Sleepful]

this would be the line which initiates the signal that should arrive at the editor to indicate doctest line numbers

[Sleepful]

a little lost here. It looks like session_live does get the :add_cell_evaluation_output operation from this function. Where does that happen?

[Sleepful]

this would send an update to the cell_editor_component in order to update its data-doctest-results attribute, that's how the editor will know to update doctest decorations

[Sleepful]

not sure why/what is the function of io_proxy.ex but I am following the same pattern for delivering messages as :livebook_put_output, which goes through this module

[jonatanklosko]

Hey @Sleepful, thanks for the PR and sorry for the late feedback!

I would start with this flow:

1. When doctests finish send a special output {:doctests_result, result}, where result includes information about each doctest line number and status. Let's keep the regular output we send currently as is for now.

2. We render the result as live component, which does push_event("doctests_result:#{cell_id}", ...) and we use it to update the editor on the client, similarly to

   livebook/assets/js/hooks/cell.js

   Lines 239 to 244 in 3298755

   	this.handleEvent(
   	`evaluation_finished:${this.props.cellId}`,
   	({ code_error }) => {
   	liveEditor.setCodeErrorMarker(code_error);
   	}
   	);

   For now the component can render empty body, but I think we will use it to render grouped tests results (Group doctests output #1526).

3. Theoretically there can be multiple modules with doctests in a cell, so we need to clear the decorations only on new evaluation. To do that we can add a clause in SessionLive for handle_action(socket, {:start_evaluation, cell, section}) and do a push_event to that cell to clear the decorations.

@josevalim if you have any concerns with this flow let me know :)

Also, note to self: it's fine to change Runtime messaging around doctests at any point, because both the sending and receiving side is in Livebook (and not in Kino).

[Sleepful]

@jonatanklosko no worries on delay. Your explanation is crystal clear, thanks for that! I will delay a little bit on the delivery, I hope that's okay, so just FYI I will have an update with code in approximately 2 weeks. TTYL 😁

[jonatanklosko]

@Sleepful sure, there's definitely no rush!

[Sleepful]

I did not mean to close it, oops 😅
I will open a new one though!

[Sleepful]

@jonatanklosko one question, does push_event arrive at the client in the right order every time?

My concern might be unfounded, but suppose push_event("start_evaluation:#{cell_id}" arrives after push_event("doctest_result:#{cell_id}" for some odd reason, it would be a bug.

Typical HTTP request issue, but we are using LiveView so probably a non-issue.

[jonatanklosko]

@Sleepful the events arrive at the same order as they are sent from the server. On a technical side, events go via the same websocket connection :)