Skip to content

Refactor frontend-only fields and defensiveness#3641

Merged
rtibbles merged 2 commits intolearningequality:unstablefrom
bjester:defensive-syncs
Sep 19, 2022
Merged

Refactor frontend-only fields and defensiveness#3641
rtibbles merged 2 commits intolearningequality:unstablefrom
bjester:defensive-syncs

Conversation

@bjester
Copy link
Copy Markdown
Member

@bjester bjester commented Sep 14, 2022

Summary

Description of the change(s) you made

  • As shown in the screenshot below, the frontend was creating change events and syncing them for fields that only have meaning on the frontend
  • This PR adds defensive checks at several levels to prevent syncing of fields that are only used on the frontend

Screenshot from 2022-09-13 15-02-37

Manual verification steps performed

  1. Open the developer console for tracking syncs
  2. Copy an exercise resource
  3. Open the new copy for editing, but don't edit anything
  4. Verify you don't see any frontend fields, like isNew or __last_fetch, being synced to the backend

Are there any risky areas that deserve extra testing?

  • Exercise / assessment editing

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

@bjester bjester marked this pull request as ready for review September 19, 2022 18:07
@bjester bjester requested a review from rtibbles September 19, 2022 18:07
Copy link
Copy Markdown
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.

All code changes make sense on read through, doing manual testing now.

Copy link
Copy Markdown
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.

Manually tested both new node creation and question creation, I did not see any superfluous/erroneous syncing events, and syncs of actual edits all seemed to go as they should.

@rtibbles rtibbles merged commit eae5b0c into learningequality:unstable Sep 19, 2022
@bjester bjester mentioned this pull request Oct 17, 2022
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.

2 participants