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.

Sign up for GitHub

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

Jump to bottom

DataSync: Cancel all previous mutations upon new mutation of same key #41472

Open
wants to merge 12 commits into
base: trunk
Choose a base branch
from
Open

DataSync: Cancel all previous mutations upon new mutation of same key #41472

wants to merge 12 commits into from
+36 −15

Conversation

LiamSarsfield
Copy link
Contributor

@LiamSarsfield LiamSarsfield commented Jan 31, 2025 •
edited
Loading

Fixes #40642

Proposed changes:

  • Cancel all previous mutations upon new mutation of same key within react-data-sync-client

Other information:

  • Have you written new tests for your changes, if applicable?
  • Have you checked the E2E test CI results, and verified that your changes do not break them?
  • Have you tested your changes on WordPress.com, if applicable (if so, you'll see a generated comment below with a script to run)?

Jetpack product discussion

N/A

Does this pull request change what data or activity we track or use?

N/A

Testing instructions:

  1. Setup Boost (free version should be enough);
  2. Load the Boost UI;
  3. Throttle your network connection;
  4. Toggle some features quickly.

With changes: Features that are toggled quickly persist their new toggled status.
Without changes: Features that are toggled quickly have their toggle switched inadvertently.

See below demo for applied changes.

Screen.Recording.2025-01-31.at.17.02.09.mov

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jan 31, 2025 •
edited
Loading

Thank you for your PR!

When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:

  • ✅ Include a description of your PR changes.
  • ✅ Add a "[Status]" label (In Progress, Needs Team Review, ...).
  • ✅ Add a "[Type]" label (Bug, Enhancement, Janitorial, Task).
  • ✅ Add testing instructions.
  • ✅ Specify whether this PR includes any changes to data or privacy.
  • ✅ Add changelog entries to affected projects

This comment will be updated as you work on your PR and make changes. If you think that some of those checks are not needed for your PR, please explain why you think so. Thanks for cooperation 🤖

The e2e test report can be found here. Please note that it can take a few minutes after the e2e tests checks are complete for the report to be available.

Follow this PR Review Process:

  1. Ensure all required checks appearing at the bottom of this PR are passing.
  2. Choose a review path based on your changes:
    • A. Team Review: add the "[Status] Needs Team Review" label
      • For most changes, including minor cross-team impacts.
      • Example: Updating a team-specific component or a small change to a shared library.
    • B. Crew Review: add the "[Status] Needs Review" label
      • For significant changes to core functionality.
      • Example: Major updates to a shared library or complex features.
    • C. Both: Start with Team, then request Crew
      • For complex changes or when you need extra confidence.
      • Example: Refactor affecting multiple systems.
  3. Get at least one approval before merging.

Still unsure? Reach out in #jetpack-developers for guidance!

Boost plugin:

  • Next scheduled release: none scheduled.

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

@github-actions github-actions bot added the [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! label Jan 31, 2025
@LiamSarsfield LiamSarsfield added the [Type] Bug When a feature is broken and / or not performing as intended label Jan 31, 2025
@LiamSarsfield LiamSarsfield added this to the boost/next milestone Jan 31, 2025
@LiamSarsfield LiamSarsfield removed the [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! label Jan 31, 2025
@LiamSarsfield LiamSarsfield self-assigned this Jan 31, 2025
@LiamSarsfield LiamSarsfield added [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. and removed [Status] In Progress labels Jan 31, 2025
@github-actions github-actions bot removed the [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. label Jan 31, 2025
@LiamSarsfield
Refine how abortControllers are fetched
75fd196
@LiamSarsfield
Merge branch 'fix/react-data-sync-client/boost-settings-racing-condit…
8ef7f3f 
…ion' of github.com:Automattic/jetpack into fix/react-data-sync-client/boost-settings-racing-condition
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jan 31, 2025 •
edited
Loading

Code Coverage Summary

Coverage changed in 1 file.

File Coverage Δ% Δ Uncovered
projects/js-packages/react-data-sync-client/src/DataSyncHooks.ts 0/83 (0.00%) 0.00% 5 💔

Full summary · PHP report · JS report

@github-actions github-actions bot added the [Plugin] Boost A feature to speed up the site and improve performance. label Jan 31, 2025
@LiamSarsfield LiamSarsfield requested a review from a team January 31, 2025 17:16
@LiamSarsfield LiamSarsfield marked this pull request as ready for review January 31, 2025 17:17
@LiamSarsfield LiamSarsfield added [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. and removed [Status] In Progress labels Jan 31, 2025
haqadn
haqadn previously approved these changes Jan 31, 2025
View reviewed changes
Copy link
Contributor

@haqadn haqadn left a comment

Choose a reason for hiding this comment

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

Perfect! I am a bit unsure if we still need to useRef for the abort controller. If we do, LGTM.

projects/js-packages/react-data-sync-client/src/DataSyncHooks.ts Outdated
@@ -98,6 +99,14 @@ export function useDataSync<
const abortController = useRef< AbortController | null >( null );
Copy link
Contributor

Choose a reason for hiding this comment

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

Do we still need to use a ref now that it's part of the mutation state?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good point! After thinking about it further, we don't, and can fully leverage React Query for this instead. I've updated the PR to reflect this.

@haqadn haqadn changed the title Cancel all previous mutations upon new mutation of same key DataSync: Cancel all previous mutations upon new mutation of same key Jan 31, 2025
@dilirity dilirity added [Status] Needs Team Review and removed [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. labels Feb 4, 2025
@LiamSarsfield LiamSarsfield requested a review from haqadn February 4, 2025 14:25
LiamSarsfield
LiamSarsfield commented Feb 4, 2025
View reviewed changes
projects/js-packages/react-data-sync-client/src/DataSyncHooks.ts
queryClient.getMutationDefaults( queryKey )?.meta?.abortController as AbortController;
const getAbortController = () => {
const defaults = queryClient.getMutationDefaults( queryKey );
return defaults?.meta?.abortController instanceof AbortController
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Per discussion with @dilirity, this avoids unnecessary type casts. Thanks for pushing this!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@haqadn haqadn Awaiting requested review from haqadn

Assignees

@LiamSarsfield LiamSarsfield

Labels
[JS Package] React Data Sync Client [Plugin] Boost A feature to speed up the site and improve performance. RNA [Status] Needs Team Review [Type] Bug When a feature is broken and / or not performing as intended
Projects
None yet
Milestone
boost/next
Development

Successfully merging this pull request may close these issues.

Boost: Racing condition when toggling modules on a slow connection
3 participants
@LiamSarsfield @haqadn @dilirity