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

Prevent saving feature settings during a sync. #2823

Merged
merged 1 commit into from
Jun 20, 2022
Merged

Conversation

JakePT
Copy link
Contributor

@JakePT JakePT commented Jun 2, 2022

Description of the Change

Prevents the saving of feature settings while a sync is in progress. Previously settings could be saved during a sync if a tab or window with the Features page was already open before starting a sync.

When the user attempts to save settings during a sync an error message is displayed with a link to view the sync status.

Closes #2795

Alternate Designs

Normally when opening the Features page during a sync the page is disabled with an overlay. One approach could have been to display this overlay after the error is returned.

The problem with displaying an overlay for an error is that there wouldn't a great place to display an error message explaining what had happened. Additionally, if a user had made settings changes that they may not want to have to redo they may prefer to just wait for the sync to finish before pressing Save again. Another way around that could've been to begin periodically checking for the sync progress so that the overlay could be hidden once it had completed, but that would require a lot more engineering for very little gain. However something like that approach might be worth considering if there's ever a UI overhaul of the Features page.

Verification Process

  1. Open two tabs. One should be the Features page and the other should be the Sync page.
  2. In the Sync tab start a sync and then immediately pause it.
  3. On the Features page, attempt to save a Feature's settings. An error should appear with a link to the Sync page.
  4. On the Sync page resume the Sync and let it finish.
  5. Back on the Features page, without refreshing, save the feature's settings again. The process should complete with no error.

Checklist:

  • I have read the CONTRIBUTING document.
  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my change.
  • All new and existing tests passed.

Changelog Entry

Fixed - An issue where feature settings could be saved during a sync.

Credits

Props @JakePT

@JakePT JakePT self-assigned this Jun 2, 2022
@JakePT JakePT requested a review from felipeelia June 2, 2022 18:53
@JakePT JakePT added this to the 4.3.0 milestone Jun 2, 2022
@felipeelia felipeelia self-assigned this Jun 7, 2022
@felipeelia felipeelia modified the milestones: 4.3.0, 4.2.1 Jun 7, 2022
@felipeelia felipeelia merged commit 938b14d into develop Jun 20, 2022
@felipeelia felipeelia deleted the fix/2795 branch June 20, 2022 12:40
burhandodhy added a commit that referenced this pull request Jun 27, 2022
burhandodhy added a commit that referenced this pull request Jun 27, 2022
felipeelia added a commit that referenced this pull request Jul 1, 2022
Add E2E for Prevent saving feature settings during a sync #2823
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.

BUG: Users can modify settings during a sync if the Features or Settings page was already open
2 participants