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

Display sync changes in channel edit toolbar #4126

Merged
merged 5 commits into from
Jun 13, 2023

Conversation

rtibbles
Copy link
Member

@rtibbles rtibbles commented Jun 9, 2023

Summary

Description of the change(s) you made

  • Switches the Vuex plugin for monitoring unsynced changes to use a liveQuery rather than the Dexie Observable db.on('changes' in the hope of more reliability
  • Switches the final use of the Resource listeners to use a liveQuery to increase reliability of redirect on logout
  • Updates the SavingIndicator component to make it use the global state when no nodeIds prop is passed
  • Adds the SavingIndicator component to the channel edit toolbar

Manual verification steps performed

  1. Checked that the vuex state properly updated when there were unsynced changes
  2. Confirmed that the current beforeunload handler does properly alert if there are unsynced changes when closing the tab
  3. Opened a second tab and logged out in that, confirmed that both tabs redirected to the accounts page
  4. Made a change and quickly exited from the edit modal - confirmed that the SavingIndicator showed up properly

Screenshots (if applicable)

Sequential screenshots after an edit was made:

Screenshot from 2023-06-09 15-48-32

Screenshot from 2023-06-09 15-48-41

Screenshot from 2023-06-09 15-48-46

Does this introduce any tech-debt items?

This does currently mean that if no edit has been made in this browser session there is no indicator, but this seemed ok for now?


Reviewer guidance

How can a reviewer test these changes?

Are there any risky areas that deserve extra testing?

References

Fixes #4100

Comments


Contributor's Checklist

PR process:

  • If this is an important user-facing change, PR or related issue the CHANGELOG label been added to this PR. Note: items with this label will be added to the CHANGELOG at a later time
  • If this includes an internal dependency change, a link to the diff is provided
  • The docs label has been added if this introduces a change that needs to be updated in the user docs?
  • If any Python requirements have changed, the updated requirements.txt files also included in this PR
  • Opportunities for using Google Analytics here are noted
  • Migrations are safe for a large db

Studio-specifc:

  • All user-facing strings are translated properly
  • The notranslate class been added to elements that shouldn't be translated by Google Chrome's automatic translation feature (e.g. icons, user-generated text)
  • All UI components are LTR and RTL compliant
  • Views are organized into pages, components, and layouts directories as described in the docs
  • Users' storage used is recalculated properly on any changes to main tree files
  • If there new ways this uses user data that needs to be factored into our Privacy Policy, it has been noted.

Testing:

  • Code is clean and well-commented
  • Contributor has fully tested the PR manually
  • If there are any front-end changes, before/after screenshots are included
  • Critical user journeys are covered by Gherkin stories
  • Any new interactions have been added to the QA Sheet
  • Critical and brittle code paths are covered by unit tests

Reviewer's Checklist

This section is for reviewers to fill out.

  • Automated test coverage is satisfactory
  • PR is fully functional
  • PR has been tested for accessibility regressions
  • External dependency files were updated if necessary (yarn and pip)
  • Documentation is updated
  • Contributor is in AUTHORS.md

@rtibbles rtibbles added this to the Studio: next major release milestone Jun 9, 2023
@rtibbles rtibbles requested review from bjester and marcellamaki June 9, 2023 22:55
@rtibbles rtibbles changed the base branch from unstable to hotfixes June 13, 2023 23:08
Copy link
Member

@marcellamaki marcellamaki left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, once tests are updated and passing.

Per slack chat, the only small change to make will be not having the "saving" indicator display when the user is offline.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Alert to unsynced changes and ensure sync before closing the tab
2 participants