search

bitcointranscripts / transcription-review-front-end

https://review.btctranscripts.com
3 stars 7 forks source link

editor suggested upgrades #196

Open kouloumos opened 11 months ago

kouloumos commented 11 months ago

I observed two instances of weird behavior with the state of the data in the Editor:

  1. When I click "Restore Original" I would expect every field to go back to its original content, but this is not the case. Categories and Directory are not resetting.
  2. If I make a change to a field and then leave the Editor, although the change will be saved (there is auto-save on every metadata change) the very first time that I will come back to the Editor, I will see the previous state (the one before the change). If I refresh the page, I will get the correct up-to-date state.
BalogunofAfrica commented 9 months ago

Hi @kouloumos

  1. For directory, there is no "original" state we can restore to. The closest we can do is restore to the last saved state.
  2. I tried to reproduce but couldn't. Can you walk me through how you got this?

Here's a draft for the fixes: https://github.com/bitcointranscripts/transcription-review-front-end/pull/238

kouloumos commented 4 months ago

This is still an issue, although it's kind of different now that we are using GitHub as the source of truth for the state of the transcript/edit.

Update on observations

  1. When I click "Restore Original" categories are still not resetting. Directories has since been removed.

  2. If I make a change to a field and then leave the Editor, although the change will be saved (there is auto-save on every metadata change) the very first time that I will come back to the Editor, I will see the previous state (the one before the change). If I refresh the page, I will get the correct up-to-date state.

This is still an issue, I think it has to do with concurrency. It only occurs if you change a metadata field (e.g add/remove speaker) and then you quickly refresh the page. I think we can ignore it for now.

  1. When I click "Restore Original" , everything resets (except of the categories), but the change is not actually reflected on the commits on the review-branch - meaning that the change back to the original state is not saved automatically after "Restore Original". Because all the metadata changes are saved automatically, not saving automatically this change to the metadata (after resetting) doesn't feel intuitive based on current functionality. On the other hand, Saves to the transcript are not saved automatically (you have to press the Save button), therefore this creates a weird situation. A solution could be to have two different "Restore Original" options, one for metadata and one for the transcript.

Possible solution

I believe that all of those issues will be resolved if we change the way we are handling/showcasing-to-the-user the current state of Saved Changes. But as we are already thinking about a different editing experience (https://github.com/bitcointranscripts/transcription-review-front-end/issues/280) it doesn't make sense to work on this right now.