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

Update publish logic with edge case #4580

Merged

Conversation

akolson
Copy link
Member

@akolson akolson commented May 29, 2024

Summary

Description of the change(s) you made

This PR enhances the remote publish logic to safeguard against accidental overwrites of the changes and published statuses in IndexedDB, particularly in scenarios where multiple users are editing the same resource. It ensures that one user's publish action does not inadvertently overwrite another user's unpublished changes.

Manual verification steps performed

  1. Log in to Studio using two separate user sessions (e.g., one in incognito mode and the other in a normal browser).
  2. Make changes to the same content in both user sessions.
  3. Publish the changes in one session.
  4. In the other session, monitor the syncing changes. To test this thoroughly, you can throttle the browsers connection to offline mode and then restore it to confirm that changes remain intact before and after connectivity is restored.
  5. Inspect the CONTENTNODE and CHANGES_TABLE in IndexedDB to verify that the syncing has no effect on changes.

Does this introduce any tech-debt items?


Reviewer guidance

How can a reviewer test these changes?

  • See manual verification steps above

References

Fixes #4138

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

@akolson akolson requested review from bjester and rtibbles May 31, 2024 21:24
@akolson akolson marked this pull request as ready for review May 31, 2024 21:26
@rtibbles rtibbles self-assigned this Jun 4, 2024
return db
.table(TABLE_NAMES.CONTENTNODE)
.where({ channel_id: change.channel_id })
.and(node => {
const unpublishedNodeIds = db[TABLE_NAMES.CHANGES_TABLE]
.where({ table: TABLE_NAMES.CONTENTNODE })
Copy link
Member

Choose a reason for hiding this comment

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

It didn't occur to me before, but couldn't we just add an additional where condition here so this becomes:

.where({ table: TABLE_NAMES.CONTENTNODE, key: node.id })
.limit(1)
.toArray();

return unpublishedNodeIds.length === 0;

Copy link
Member Author

Choose a reason for hiding this comment

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

Oh yeah more cleaner!

.limit(1)
.toArray();
return unpublishedNodeIds.length === 0;
})
Copy link
Member Author

Choose a reason for hiding this comment

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

@rtibbles, we should be good now, I think?

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 so!

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.

Code looks good, will do a quick manual test locally to confirm.

.limit(1)
.toArray();
return unpublishedNodeIds.length === 0;
})
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 so!

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.

The manual test checks out, this is good to go! Beautiful stuff.

@rtibbles rtibbles merged commit 0fd5644 into learningequality:unstable Jun 18, 2024
13 checks passed
@akolson akolson mentioned this pull request Aug 13, 2024
@akolson akolson mentioned this pull request Oct 1, 2024
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.

Applying remote publish change could mark nodes as unchanged
2 participants