Skip to content

ACM-20347-difficult-to-edit-yaml #189

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

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 24 additions & 4 deletions src/Wizard.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ import { ShowValidationProvider, useSetShowValidation, useShowValidation } from
import { StepHasInputsProvider } from './contexts/StepHasInputsProvider'
import { StepShowValidationProvider, useSetStepShowValidation, useStepShowValidation } from './contexts/StepShowValidationProvider'
import { StepValidationProvider, useStepHasValidationError } from './contexts/StepValidationProvider'
import { useHasValidationError, ValidationProvider } from './contexts/ValidationProvider'
import { useHasValidationError, useEditorValidationStatus, ValidationProvider, EditorValidationStatus } from './contexts/ValidationProvider'
import { Step } from './Step'

export interface WizardProps {
Expand Down Expand Up @@ -229,6 +229,7 @@ function MyFooter(props: {
const setShowValidation = useSetShowValidation()
const showWizardValidation = useShowValidation()
const wizardHasValidationError = useHasValidationError()
const { editorValidationStatus } = useEditorValidationStatus()

const firstStep = props.steps[0]
const lastStep = props.steps[props.steps.length - 1]
Expand All @@ -255,17 +256,36 @@ function MyFooter(props: {
}
}, [lastStep.name, setShowValidation, wizardContext.activeStep.name])

const { fixValidationErrorsMsg, submitText, submittingText, cancelButtonText, backButtonText, nextButtonText } = useStringContext()
const {
fixValidationErrorsMsg,
fixEditorValidationErrorsMsg,
waitforEditorValidationErrorsMsg,
submitText,
submittingText,
cancelButtonText,
backButtonText,
nextButtonText,
} = useStringContext()

if (wizardContext.activeStep.name === lastStep.name) {
return (
<div className="pf-v5-u-box-shadow-sm-top">
{editorValidationStatus === EditorValidationStatus.failure && showWizardValidation && (
<Alert title={fixEditorValidationErrorsMsg} isInline variant="danger" />
)}
{wizardHasValidationError && showWizardValidation && <Alert title={fixValidationErrorsMsg} isInline variant="danger" />}
{editorValidationStatus === EditorValidationStatus.pending && showWizardValidation && (
<Alert title={waitforEditorValidationErrorsMsg} isInline variant="warning" />
)}
{submitError && <Alert title={submitError} isInline variant="danger" />}
<WizardFooter>
<Button
onClick={onSubmitClick}
isDisabled={(wizardHasValidationError && showWizardValidation) || submitting}
isDisabled={
((wizardHasValidationError || editorValidationStatus !== EditorValidationStatus.success) &&
showWizardValidation) ||
submitting
}
isLoading={submitting}
type="submit"
>
Expand Down Expand Up @@ -324,7 +344,7 @@ function RenderHiddenSteps(props: { stepComponents: ReactElement[] }) {
function WizardDrawer(props: { yamlEditor?: () => ReactNode }) {
const [yamlEditor] = useState(props.yamlEditor ?? undefined)
return (
<DrawerPanelContent isResizable={true} defaultSize="800px" style={{ backgroundColor: 'rgb(21, 21, 21)' }}>
<DrawerPanelContent isResizable={true} defaultSize="600px">
{yamlEditor}
</DrawerPanelContent>
)
Expand Down
4 changes: 4 additions & 0 deletions src/contexts/StringContext.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ export interface WizardStrings {
cancelButtonText: string
nextButtonText: string
fixValidationErrorsMsg: string
fixEditorValidationErrorsMsg: string
waitforEditorValidationErrorsMsg: string
submitText: string
submittingText: string
moreInfo: string
Expand Down Expand Up @@ -53,6 +55,8 @@ export const defaultStrings: WizardStrings = {
cancelButtonText: 'Cancel',
nextButtonText: 'Next',
fixValidationErrorsMsg: 'Please fix validation errors',
fixEditorValidationErrorsMsg: 'Please fix editor syntax errors',
waitforEditorValidationErrorsMsg: 'Please wait for editor syntax check',
submitText: 'Submit',
submittingText: 'Submitting',
moreInfo: 'More info',
Expand Down
25 changes: 22 additions & 3 deletions src/contexts/ValidationProvider.tsx
Original file line number Diff line number Diff line change
@@ -1,5 +1,20 @@
import { createContext, ReactNode, useCallback, useContext, useLayoutEffect, useState } from 'react'

export enum EditorValidationStatus {
success = 'success',
pending = 'pending',
failure = 'failure',
}

export const EditorValidationStatusContext = createContext<{
editorValidationStatus: EditorValidationStatus
setEditorValidationStatus: (status: EditorValidationStatus) => void
}>({
editorValidationStatus: EditorValidationStatus.success,
setEditorValidationStatus: () => void 0,
})
export const useEditorValidationStatus = () => useContext(EditorValidationStatusContext)

const SetHasValidationErrorContext = createContext<() => void>(() => null)
SetHasValidationErrorContext.displayName = 'SetHasValidationErrorContext'
export const useSetHasValidationError = () => useContext(SetHasValidationErrorContext)
Expand All @@ -13,6 +28,8 @@ ValidateContext.displayName = 'ValidateContext'
export const useValidate = () => useContext(ValidateContext)

export function ValidationProvider(props: { children: ReactNode }) {
const [editorValidationStatus, setEditorValidationStatus] = useState<EditorValidationStatus>(EditorValidationStatus.success)

const [hasValidationError, setHasValidationErrorState] = useState(false)
const [previousHasValidationError, setPreviousHasValidationError] = useState(false)
const setHasValidationError = useCallback(() => {
Expand Down Expand Up @@ -47,9 +64,11 @@ export function ValidationProvider(props: { children: ReactNode }) {

return (
<ValidateContext.Provider value={validate}>
<SetHasValidationErrorContext.Provider value={setHasValidationError}>
<HasValidationErrorContext.Provider value={hasValidationError}>{props.children}</HasValidationErrorContext.Provider>
</SetHasValidationErrorContext.Provider>
<EditorValidationStatusContext.Provider value={{ editorValidationStatus, setEditorValidationStatus }}>
<SetHasValidationErrorContext.Provider value={setHasValidationError}>
<HasValidationErrorContext.Provider value={hasValidationError}>{props.children}</HasValidationErrorContext.Provider>
</SetHasValidationErrorContext.Provider>
</EditorValidationStatusContext.Provider>
</ValidateContext.Provider>
)
}
8 changes: 7 additions & 1 deletion src/inputs/WizKeyValue.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -96,11 +96,17 @@ export function WizKeyValue(props: KeyValueProps) {
{pairs.map((pair, index) => {
return (
<Fragment key={index}>
<TextInput id={`key-${index + 1}`} value={pair.key} onChange={(_event, value) => onKeyChange(index, value)} />
<TextInput
id={`key-${index + 1}`}
value={pair.key}
spellCheck="false"
onChange={(_event, value) => onKeyChange(index, value)}
/>
<span>=</span>
<TextInput
id={`value-${index + 1}`}
value={pair.value}
spellCheck="false"
onChange={(_event, value) => onValueChange(index, value)}
/>
<Button variant="plain" aria-label={removeItemAriaLabel} onClick={() => onDeleteKey(index)}>
Expand Down
1 change: 1 addition & 0 deletions src/inputs/WizStringsInput.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -173,6 +173,7 @@ export function StringsMapInput(props: StringsMapInputProps) {
<PFTextInput
id={`${id}-${index + 1}`}
value={pair}
spellCheck="false"
onChange={(_event, value) => onKeyChange(index, value)}
required
/>
Expand Down
1 change: 1 addition & 0 deletions src/inputs/WizTextInput.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ export function WizTextInput(props: WizTextInputProps) {
onChange={onChange}
type={!props.secret || showSecrets ? 'text' : 'password'}
isDisabled={disabled}
spellCheck="false"
readOnlyVariant={props.readonly ? 'default' : undefined}
/>
</InputGroupItem>
Expand Down