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

Social: Fix parallel social connections requests mixing up UI state #38408

Merged

Conversation

manzoorwanijk
Copy link
Member

Replaces #38367

On slower connections there is a scenario which could happen that messes up the connection state:

  • On page load the test_connections call fires, but takes 10-15 seconds to complete
  • In the meantime the user adds/removes a connection, changing the state
  • If the addition/remove of connection finishes faster, the test_connections call will mess up the state when it finishes, it will either remove the new connection from the UI, or add back the removed one.

Proposed changes:

  • Use AbortController in wp.apiFetch to cancel the existing test connections request if a connection creation/updation/deletion request is fired. The test connection request is fired again after the request finishes.
  • Make the test connections request wait if a connection creation/updation/deletion request is already in progress

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

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

Testing instructions:

  • Goto post editor

Case 1: Connections test request is not fired until an in-flight connection creation/updation/deletion request is in progress

  • To simulate a slow connection creation request, add sleep( 10 ); on line 591 in packages/publicize/src/class-rest-controller.php
  • Open the connections management modal
  • Connect an account and wait on the confirmation screen
  • Open the Network panel in the browser dev tools and clear all the previous requests
  • Confirm the connection and quickly switch to a different tab and then switch back to the editor tab
  • Confirm that the test connections request is not fired until the connection creation request finishes
  • Confirm the same with updating/globalizing and deleting a connection requests

Case 12: Connections test request is cancelled when a new connection creation/updation/deletion request is fired.

  • To simulate a slow connections test request, add this on line 272 in packages/publicize/src/class-publicize.php
    if ( ! empty( $args['test_connections'] ) ) {
    	sleep( 10 );
    }
  • Now add a connection again and wait on the confirmation screen
  • Switch to a different tab and then switch back to the editor tab
  • See the connection test request getting fired
  • Quickly click on Confirm to add the connection
  • Confirm that the in-flight test connection request gets canceled
  • Wait for the connection creation request to finish
  • Confirm that the test connection request now gets fired after the connection creation request finishes
Screen.Recording.2024-07-18.at.4.17.28.PM.mov

Copy link
Contributor

github-actions bot commented Jul 18, 2024

Are you an Automattician? Please test your changes on all WordPress.com environments to help mitigate accidental explosions.

  • To test on WoA, go to the Plugins menu on a WordPress.com Simple site. Click on the "Upload" button and follow the upgrade flow to be able to upload, install, and activate the Jetpack Beta plugin. Once the plugin is active, go to Jetpack > Jetpack Beta, select your plugin, and enable the fix/parallel-social-connections-requests-mixing-up branch.

  • To test on Simple, run the following command on your sandbox:

    bin/jetpack-downloader test jetpack fix/parallel-social-connections-requests-mixing-up
    

Interested in more tips and information?

  • In your local development environment, use the jetpack rsync command to sync your changes to a WoA dev blog.
  • Read more about our development workflow here: PCYsg-eg0-p2
  • Figure out when your changes will be shipped to customers here: PCYsg-eg5-p2

Copy link
Contributor

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 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.


Once your PR is ready for review, check one last time that all required checks appearing at the bottom of this PR are passing or skipped.
Then, add the "[Status] Needs Team Review" label and ask someone from your team review the code. Once reviewed, it can then be merged.
If you need an extra review from someone familiar with the codebase, you can update the labels from "[Status] Needs Team Review" to "[Status] Needs Review", and in that case Jetpack Approvers will do a final review of your PR.

@manzoorwanijk manzoorwanijk requested a review from a team July 18, 2024 10:51
Copy link
Contributor

@gmjuhasz gmjuhasz left a comment

Choose a reason for hiding this comment

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

This works as described

@manzoorwanijk manzoorwanijk merged commit 228835b into trunk Jul 19, 2024
58 checks passed
@manzoorwanijk manzoorwanijk deleted the fix/parallel-social-connections-requests-mixing-up branch July 19, 2024 09:54
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