Bug 1907863: Update quick start actions to handle concurrent state updates

[rohitkrai03]

Fixes: https://issues.redhat.com/browse/ODC-5233
Fixes: https://issues.redhat.com/browse/ODC-5236
Fixes: https://issues.redhat.com/browse/ODC-5268

Analysis / Root cause: While moving from local storage to use settings the quick start state was moved from redux to top level context using context provider extension. The quick start state is very complex and require concurrent update to the state for each user action, that is why there were multiple calls to setState((state) => newState) which resulted in each call working with the older and stale state. this resulted in none of the quick start actions working correctly.

Solution Description: There were two possible solutions for the above problem -

1. Use redux or useReducer for managing state of quick start. The problem with this approach is that the initialState of the reducer needs to be async coming from user settings. One way to solve this was to have a separate action just to initialize the state asynchronously but not sure if this is a widely accepted pattern for doing such things.
2. Convert existing state update callbacks to mimic user actions and handle all concurrent updates together.

Went ahead with the second approach for now as that required less changes to the current code.

Screen shots / Gifs for design review:

Browser conformance:

• Chrome
• Firefox
• Safari
• Edge

[rohitkrai03]

/cc @sahil143 @invincibleJai

[openshift-ci-robot]

@rohitkrai03: This pull request references Bugzilla bug 1907863, which is valid. The bug has been moved to the POST state. The bug has been updated to refer to the pull request using the external bug tracker.

3 validation(s) were run on this bug

• bug is open, matching expected state (open)
• bug target release (4.7.0) matches configured target release for branch (4.7.0)
• bug is in the state NEW, which is one of the valid states (NEW, ASSIGNED, ON_DEV, POST, POST)

In response to this:

Bug 1907863: Update quick start actions to handle concurrent state updates

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[sahil143]

@rohitkrai03 can we add the sync true to AllQuickStartStates only. This will be helpful if the Quickstarts are open in two different browser tabs.

[rohitkrai03]

@sahil143 Added sync true for all quick start states.

[sahil143]

The back button on the quick start is not working

[rohitkrai03]

The back button on the quick start is not working

@sahil143 Fixed.

[sahil143]

@rohitkrai03 I'm seeing a weird mismatch in the state. Not sure if it's to do with quick start state updates or the userSettings hook itself
The state is correct on the card(completed) in both tabs but once it is opened the state changes to InProgress

[rohitkrai03]

@rohitkrai03 I'm seeing a weird mismatch in the state. Not sure if it's to do with quick start state updates or the userSettings hook itself
The state is correct on the card(completed) in both tabs but once it is opened the state changes to InProgress

That's actually because Start the tour button sets the status to In progress as well. I think if user starts a completed tour again, the status should be updated to In progress. We can confirm this behaviour with UX if needed.

[sahil143]

That's actually because Start the tour button sets the status to In progress as well. I think if user starts a completed tour again, the status should be updated to In progress. We can confirm this behaviour with UX if needed.

Ah Okay! That makes sense

[sahil143]

/lgtm

verified changes locally. works as expected

[openshift-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: rohitkrai03, sahil143

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• frontend/OWNERS [rohitkrai03]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[rohitkrai03]

/retest

[openshift-bot]

/retest

Please review the full test history for this PR and help us cut down flakes.

[rohitkrai03]

/retest

[openshift-ci-robot]

@rohitkrai03: All pull requests linked via external trackers have merged:

• openshift/console#7553

Bugzilla bug 1907863 has been moved to the MODIFIED state.

In response to this:

Bug 1907863: Update quick start actions to handle concurrent state updates

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.