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

Migrate deprecated Wizard component to PF5 and fix Wizard's focus issue #1428

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

sgratch
Copy link
Collaborator

@sgratch sgratch commented Jan 6, 2025

References:
https://issues.redhat.com/browse/MTV-1051
https://issues.redhat.com/browse/MTV-1863

  1. Migrate the deprecated Wizard component to PF5 - see https://v5-archive.patternfly.org/components/wizard/react-deprecated
  2. When moving between steps in plan's wizard, set the initial focus to the top of the step's page.
  3. When clicking the Cancel button within the wizard, instead of always navigating to history.goBack(),
    the following happens now:
    If the wizard is triggered by the provider - vms tab => cancel will navigate back to the provider - vms tab
    If the wizard is triggered by the plans list page => cancel will navigate back to the plans list page
    If the wizard is triggered by entering the wizard url directly => cancel will navigate back to the plans list page.

Screencasts

Before

Screencast.from.2025-01-06.18-33-35.webm

After

Screencast.from.2025-01-06.18-38-54.webm

@sgratch sgratch added bug Categorizes issue or PR as related to a bug. enhancement Categorizes issue or PR as related to a new feature. labels Jan 6, 2025
@sgratch sgratch added this to the 2.8.0 milestone Jan 6, 2025
@sgratch sgratch requested a review from yaacov January 6, 2025 16:22
shouldFocusContent
title={title}
startIndex={startAtStep}
onClose={() => history.goBack()}
Copy link
Collaborator

Choose a reason for hiding this comment

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

this can be a bit problematic sometimes, for example if someone enter directly to wizard URL, onclose will send out of the app - consider navigate to a list page

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I fixed it as follows:
If the wizard is triggered by the provider - vms tab => cancel will navigate back to the provider - vms tab
If the wizard is triggered by the plans list page => cancel will navigate back to the plans list page
If the wizard is triggered by entering the wizard url directly => cancel will navigate back to the plans list page.

This is another bug fix, so added that to main comment as well.

Comment on lines 103 to 106
Object.values(state?.validation || []).some(
(validation) => validation === 'error',
) ||
state?.validation?.planName === 'default',
Copy link
Collaborator

Choose a reason for hiding this comment

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

seems like state.validation can be object or array?

also consider extracting it to a isDsiabled func

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

validation is an object property within the CreateVmMigrationPageState interface, this huge state object is very complicated to track and debug as is so I prefer to leave it and not extract it to a local env.

But I extract it to separate funcs to make it more readable.

@sgratch sgratch force-pushed the Migrate-deprecated-wizard-to-pf5-and-fix-focus-bug branch from 02a2181 to 9bfc03d Compare January 9, 2025 20:32
References: https://issues.redhat.com/browse/MTV-1051
	    https://issues.redhat.com/browse/MTV-1863

1. Migrate the deprecated Wizard component to PF5 - see https://v5-archive.patternfly.org/components/wizard/react-deprecated
2. When moving between steps in plan wizard, set the initial focus to the top of the step's page.

Signed-off-by: Sharon Gratch <[email protected]>
@sgratch sgratch force-pushed the Migrate-deprecated-wizard-to-pf5-and-fix-focus-bug branch from 9bfc03d to c2c63c6 Compare January 9, 2025 20:55
Copy link

sonarqubecloud bot commented Jan 9, 2025

@sgratch sgratch requested a review from metalice January 9, 2025 21:04
@codecov-commenter
Copy link

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 36.20%. Comparing base (13484d0) to head (c2c63c6).
Report is 180 commits behind head on main.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1428      +/-   ##
==========================================
- Coverage   36.81%   36.20%   -0.62%     
==========================================
  Files         158      159       +1     
  Lines        2548     2580      +32     
  Branches      599      606       +7     
==========================================
- Hits          938      934       -4     
- Misses       1428     1464      +36     
  Partials      182      182              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Categorizes issue or PR as related to a bug. enhancement Categorizes issue or PR as related to a new feature.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants