Dev.del/feat studio g2p error feedback component #463
Conversation
|
Review changes with Changed Files
|
joanise
requested review from
deltork,
dhdaines,
marctessier,
roedoejet and
sergeleger
and removed request for
deltork and
sergeleger
|
|
If we do not click on the "x" to close an / acknowledge error toast message.... If you correct the error and create a new one in the text and re-click to go to next step... The new Error will be display BUT the original error that was corrected will re-get displayed. |
|
Ok, I was speaking with Eric. After 30 second it does time out and will not re-display the same corrected message. I like how we display the error page on the main page... Where we now have time to analyze the message. Also how the "error" is being highlighted make it much easier to my in the text. |
|
Not having time to read and deal with the error message was one of the bigger problems with the old setup. I really like how this shows you where in the text the problems are, that's the key to a useful error message (even if the message itself doesn't necessarily make sense, at least you know where to look...) |
There was a problem hiding this comment.
I haven't reviewed the actual code, but as discussed in the meeting, I think this fix (which is a fantastic idea) really deserves to update our text area with something more editable (e.g. Quill or ProseMirror or something like that). Having an alternate text box with the errors introduces a bit of UI clutter and I think will result in a more confusing UX. I realize this is more work to introduce a different text area, but in this case, I think it's worth it. Great initiative on this work though, I expect there will be a lot of re-usability with this PR.
UPDATE, TO DECIDE:
Nov. 27 2025 we decided to use some sort of in-place error highlighting. We have three possible solutions in order of preference:
- Overlay a highlight layer behind the textarea. We like this option because it means we keep our current textarea and don't introduce dependencies.
<div class="wrapper">
<pre id="highlightLayer"></pre>
<textarea id="ta"></textarea>
</div>
- Use a contenteditable div. If the overlay doesn't work, we should do this because it doesn't introduce dependencies.
- Use a rich text editor like ngx-editor. This is a last resort because of the dependency bloat.
|
Here's the Gemini generated example of an overlay solution ( These are the words in the dictionary:
|
|
To expand on my initial comment yesterday; quick fixes to improve the error message of the toast:
|
PR Goal?
Error messages due to g2p processing errors and not shown in a way that is realistic for users to handle. The goal of this PR is to propose a functional mock up of what such error highlighting could look like, to start a team discussion on what we want to implement as a solution.
Fixes?
First pass at fixing the fact that people need to contact us whenever the studio-web fails for them, and pretty much only a RAS team member is able to identify what typo caused the failure.
Related to ReadAlongs/Studio#27 which I was starting to solve by deleting words with empty g2p output, only to figure out in discussion with Del that that is actually a really bad idea. Instead, we came up with this plan to show the errors clearly.
Feedback sought?
Do you like the general approach of showing the errors, highlighted in a bright box like this?
If so, let's discuss in more detail how it should actually be rendered -- this PR is a first draft of the concept.
Priority?
Medium high because this is a recurring problem.
Tests added?
No. way too early for this! Let's talk about it first.
How to test?
Warning: The PR preview won't work!
Locally fetch and checkout:
dev.ej/partial-xml-in-422-assembledev.del/feat-studio-g2p-error-feedback-componentSpin up the servers locally:
And try this input text:
On clicking "Go to the next step", you will see:
Confidence?
Medium:
Version change?
This will require a version change of both Studio-Web and Studio, because rendering this text here required adding it to the 422 HTTPException generated by the
/assembleendpoint. We can't bump Studio first, though, because the current S-Web with the updated Studio gives us even uglier toasts in the case of g2p errors.So the order has to be:
dev.ej/partial-xml-in-422-assemblein Studio and create release 1.3.0 (current is 1.2.1)