Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature request: Avoid trapping users in bad editor state due to change detection #191

Open
13 tasks
akphi opened this issue May 6, 2021 · 0 comments
Open
13 tasks
Labels
Component: Graph Manager Issues related to graph processing and management (including interaction with engine server) logic Component: SDLC Studio Core Team Opened by a member of the Studio core team Type: Feature Request
Milestone

Comments

@akphi
Copy link
Contributor

akphi commented May 6, 2021

There are a few problems with change detection right now that we should address to unblock users: i.e. to allow users to save their models in those case at least. In particular, we should do the followings:

TODOs

  • Allow change detection to be failed by hash computation error, right now we do nothing on hash error
  • CHECK Block normal syncing while change detection is running as this might cause SDLC to throw entity already exists/created error
  • Support hard-save functionality that will just save all entities (i.e. like model loader) without computing the entity changes
    • Add this button to local change panel
    • MAYBE If the quick-save call fails, show a dialog or something to prompt for disabling change detection
  • When there's a problem with change detection, disable it (turn if off).
    • Show this in status bar (refer to how VSCode shows ESLint disable)
    • Show some icon in local change panel
    • In this mode, syncing is replaced by hard-save and we should put a blocking modal to confirm user's intention, something along the line of: change detection is disabled, so we cannot identify the changes you made locally in order to optimize save, this save action may take a long time, so be patient.
    • Make sure if change detection is disabled, the refresh action, quick-save action on the panels are disabled too, and the diffs are not shown (also can show a warning placeholder in the panel to say change detection is not running)

Improvement

  • In case change detection is broken or reporting false positive, we can technically get the models from SDLC, and compare JSON-to-JSON with the entities being serialized from Studio graph to do a one-off change detection to help quick-save; this would be more efficient than hard-save but a little more complicated to implement so we will handle this later.
  • We should re-evaluate and check what this would mean for the standalone review page (there, if diff is not showing, we need to call comparison API from SDLC instead).
  • We should also re-evaluate what this would mean for conflict resolution: the fact that change detection is failable might means we need to block conflict resolution accept operation and modify SDLC API
@akphi akphi added the Type: Bug label May 6, 2021
@akphi akphi added Studio Core Team Opened by a member of the Studio core team Difficulty: Challenging labels Oct 29, 2021
@akphi akphi changed the title Bug: User can be trapped in bad editor state due to change detection Feature request: Help user to not be trapped in bad editor state due to change detection Nov 16, 2021
@akphi akphi changed the title Feature request: Help user to not be trapped in bad editor state due to change detection Feature request: Avoid trapping users in bad editor state due to change detection Nov 16, 2021
@akphi akphi added this to the On Deck milestone Nov 16, 2021
@akphi akphi modified the milestones: On Deck, 3.0.0 Nov 23, 2021
@akphi akphi modified the milestones: 3.0.0, 4.0.0 Jan 27, 2022
@MauricioUyaguari MauricioUyaguari modified the milestones: 4.0.0, On Deck Feb 9, 2022
@akphi akphi added the Component: Graph Manager Issues related to graph processing and management (including interaction with engine server) logic label Feb 28, 2022
@akphi akphi removed the help wanted label Oct 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Graph Manager Issues related to graph processing and management (including interaction with engine server) logic Component: SDLC Studio Core Team Opened by a member of the Studio core team Type: Feature Request
Projects
None yet
Development

No branches or pull requests

2 participants