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

Handle updates from IndexedDB in Vuex #3600

Merged
merged 5 commits into from
Sep 7, 2022

Conversation

bjester
Copy link
Member

@bjester bjester commented Sep 2, 2022

Summary

Description of the change(s) you made

  • Adds Vuex mutations that handle Dexie change events coming from IndexedDB updates
  • Adds insurance to include contentnode table when applying changes
  • Fixes issues with saving and overwriting of learnerManaged and completion criteria in the edit modal

Manual verification steps performed

  1. For each affected Vuex plugin, make associated changes that would trigger updates to the IndexedDB
  2. Ensure that data is not overwritten

Screenshots (if applicable)

Does this introduce any tech-debt items?


Reviewer guidance

How can a reviewer test these changes?

Are there any risky areas that deserve extra testing?

  • Making edits to all the new metadata
  • Making edits to completion criteria
  • Making edits to a channel's content defaults

References

Fixes #3511

Comments

There appears to be an issue with categories, that I avoided because of it being a potential rabbit hole. When you select a top level category, then a child, the child category doesn't always immediately become selected. Clicking it again selects it, but this could cause some user aggravation.


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 self-requested a review September 6, 2022 16:56
Copy link
Member

@rtibbles rtibbles left a comment

Choose a reason for hiding this comment

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

This definitely fixes the issue flagged, but I think we will need some follow up work as noted on the categories:
Editor 1:
Screenshot from 2022-09-06 10-23-07

Editor 2:
Screenshot from 2022-09-06 10-23-13

I was also able to induce inconsistencies in the completion criteria as well:
Editor 1:
Screenshot from 2022-09-06 10-24-09

Editor 2:
Screenshot from 2022-09-06 10-24-17

@@ -110,16 +109,15 @@ export default function IndexedDBPlugin(db, listeners = []) {

db.on('changes', function(changes) {
changes.forEach(function(change) {
// Don't invoke listeners if their client originated the change
if (CLIENTID !== change.source) {
Copy link
Member

Choose a reason for hiding this comment

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

I think this might make the CLIENTID as a transaction source superfluous, but I'd have to double check.

@bjester bjester merged commit 9d98086 into learningequality:unstable Sep 7, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Unstable - The selected chips disappear on their own
2 participants