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

Bug 1908296: Fix pipeline builder form yaml switcher validation issue #7565

Conversation

karthikjeeyar
Copy link
Contributor

Fixes:
https://issues.redhat.com/browse/ODC-5249

Analysis / Root cause:

In pipeline builder page, pasting the yaml file on the yaml section and switching back to form view fails to enable the create button. Formik validation is not occurring against the immediate change in form values while switch back to form view.

Solution Description:

Add a force validation to get correct error state while switching to form view.

Screen shots / Gifs for design review:
submit-button-enabled

Unit test coverage report:
No UI changes

Test Setup:

  1. Goto pipeline builder page, switch to yaml section
  2. Paste a valid pipeline yaml from the clipboard
  3. Switch back to form view (create button should be enabled)

Browser conformance:

  • Chrome
  • Firefox
  • Safari
  • Edge

@karthikjeeyar karthikjeeyar changed the title Fix pipeline builder form yaml switcher validation issue Bug 1908296: Fix pipeline builder form yaml switcher validation issue Dec 16, 2020
@openshift-ci-robot openshift-ci-robot added the bugzilla/severity-medium Referenced Bugzilla bug's severity is medium for the branch this PR is targeting. label Dec 16, 2020
@openshift-ci-robot
Copy link
Contributor

@karthikjeeyar: This pull request references Bugzilla bug 1908296, 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 1908296: Fix pipeline builder form yaml switcher validation issue

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.

@openshift-ci-robot openshift-ci-robot added the bugzilla/valid-bug Indicates that a referenced Bugzilla bug is valid for the branch this PR is targeting. label Dec 16, 2020
@karthikjeeyar
Copy link
Contributor Author

/kind bug

@openshift-ci-robot openshift-ci-robot added the kind/bug Categorizes issue or PR as related to a bug. label Dec 16, 2020
@divyanshiGupta
Copy link
Contributor

divyanshiGupta commented Dec 18, 2020

@karthikjeeyar did you find out why the form is not getting properly validated? Is it a formik issue?
Your solution is working but it is a hack and we use SyncedEditorField at other places also but we dont see this issue there.

@rohitkrai03 do you have an idea about it?

Comment on lines +60 to +66
React.useEffect(() => {
if (values.editorType === EditorType.Form) {
// Force validation against the new data that was adjusted in the YAML
// Formik isn't properly handling the immediate state of the form values during the cycle of the editorType
setTimeout(() => validateForm(), 0);
}
}, [values.editorType, validateForm]);
Copy link
Contributor

Choose a reason for hiding this comment

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

Why not use useFormikValidationFix hook here? It does a similar hack.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I tried using this hook, but unfortunately it doesn't work. with pipeline builder form component, validation happens before the task is preselected, so the above code is to validate the form right after all the new changes are in place, thus setTimeout is used.

Copy link
Contributor

@rohitkrai03 rohitkrai03 left a comment

Choose a reason for hiding this comment

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

/lgtm
/approve

@openshift-ci-robot openshift-ci-robot added the lgtm Indicates that a PR is ready to be merged. label Jan 12, 2021
@openshift-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

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

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:

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

@openshift-ci-robot openshift-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jan 12, 2021
@rohitkrai03
Copy link
Contributor

/retest

@openshift-merge-robot openshift-merge-robot merged commit 3bd3f7b into openshift:master Jan 12, 2021
@openshift-ci-robot
Copy link
Contributor

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

Bugzilla bug 1908296 has been moved to the MODIFIED state.

In response to this:

Bug 1908296: Fix pipeline builder form yaml switcher validation issue

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.

@spadgett spadgett added this to the v4.7 milestone Jan 12, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. bugzilla/severity-medium Referenced Bugzilla bug's severity is medium for the branch this PR is targeting. bugzilla/valid-bug Indicates that a referenced Bugzilla bug is valid for the branch this PR is targeting. kind/bug Categorizes issue or PR as related to a bug. lgtm Indicates that a PR is ready to be merged.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants