|
| 1 | +/* |
| 2 | + * Copyright OpenSearch Contributors |
| 3 | + * SPDX-License-Identifier: Apache-2.0 |
| 4 | + */ |
| 5 | + |
| 6 | +import React, { ReactNode, useEffect, useState } from 'react'; |
| 7 | +import { Field, FieldProps, getIn, useFormikContext } from 'formik'; |
| 8 | +import { isEmpty } from 'lodash'; |
| 9 | +import { |
| 10 | + EuiCodeEditor, |
| 11 | + EuiCompressedFormRow, |
| 12 | + EuiLink, |
| 13 | + EuiText, |
| 14 | +} from '@elastic/eui'; |
| 15 | +import { |
| 16 | + customStringifySingleLine, |
| 17 | + WorkflowFormValues, |
| 18 | +} from '../../../../../common'; |
| 19 | +import { camelCaseToTitleString } from '../../../../utils'; |
| 20 | + |
| 21 | +interface JsonLinesFieldProps { |
| 22 | + fieldPath: string; // the full path in string-form to the field (e.g., 'ingest.enrich.processors.text_embedding_processor.inputField') |
| 23 | + validate?: boolean; |
| 24 | + label?: string; |
| 25 | + helpLink?: string; |
| 26 | + helpText?: string | ReactNode; |
| 27 | + editorHeight?: string; |
| 28 | + readOnly?: boolean; |
| 29 | +} |
| 30 | + |
| 31 | +/** |
| 32 | + * An input field for a component where users input data in JSON Lines format. |
| 33 | + * https://jsonlines.org/ |
| 34 | + */ |
| 35 | +export function JsonLinesField(props: JsonLinesFieldProps) { |
| 36 | + const validate = props.validate ?? true; |
| 37 | + |
| 38 | + const { errors, touched, values } = useFormikContext<WorkflowFormValues>(); |
| 39 | + |
| 40 | + // temp input state. only format when users click out of the code editor |
| 41 | + const [jsonStr, setJsonStr] = useState<string>('{}'); |
| 42 | + const [customErrMsg, setCustomErrMsg] = useState<string | undefined>( |
| 43 | + undefined |
| 44 | + ); |
| 45 | + |
| 46 | + // initializing the text to be the stringified form value |
| 47 | + useEffect(() => { |
| 48 | + if (props.fieldPath && values) { |
| 49 | + const formValue = getIn(values, props.fieldPath) as string; |
| 50 | + if (formValue) { |
| 51 | + setJsonStr(formValue); |
| 52 | + } |
| 53 | + } |
| 54 | + }, [props.fieldPath, values]); |
| 55 | + |
| 56 | + return ( |
| 57 | + <Field name={props.fieldPath}> |
| 58 | + {({ field, form }: FieldProps) => { |
| 59 | + return ( |
| 60 | + <EuiCompressedFormRow |
| 61 | + fullWidth={true} |
| 62 | + key={props.fieldPath} |
| 63 | + label={props.label || camelCaseToTitleString(field.name)} |
| 64 | + labelAppend={ |
| 65 | + props.helpLink ? ( |
| 66 | + <EuiText size="xs"> |
| 67 | + <EuiLink href={props.helpLink} target="_blank"> |
| 68 | + Learn more |
| 69 | + </EuiLink> |
| 70 | + </EuiText> |
| 71 | + ) : undefined |
| 72 | + } |
| 73 | + helpText={props.helpText || undefined} |
| 74 | + error={ |
| 75 | + validate ? ( |
| 76 | + <> |
| 77 | + {customErrMsg?.split('\n')?.map((errMsg, idx) => { |
| 78 | + return ( |
| 79 | + <EuiText key={idx} color="danger" size="s"> |
| 80 | + {errMsg} |
| 81 | + </EuiText> |
| 82 | + ); |
| 83 | + })} |
| 84 | + </> |
| 85 | + ) : undefined |
| 86 | + } |
| 87 | + isInvalid={ |
| 88 | + validate |
| 89 | + ? getIn(errors, field.name) && getIn(touched, field.name) |
| 90 | + : false |
| 91 | + } |
| 92 | + > |
| 93 | + <EuiCodeEditor |
| 94 | + mode="hjson" |
| 95 | + theme="textmate" |
| 96 | + width="100%" |
| 97 | + height={props.editorHeight || '15vh'} |
| 98 | + value={jsonStr} |
| 99 | + onChange={(input) => { |
| 100 | + setJsonStr(input); |
| 101 | + form.setFieldValue(field.name, input); |
| 102 | + setCustomErrMsg(undefined); |
| 103 | + }} |
| 104 | + onBlur={() => { |
| 105 | + form.setFieldTouched(field.name); |
| 106 | + let finalJsonStr = ''; |
| 107 | + let errs = [] as string[]; |
| 108 | + try { |
| 109 | + const lines = jsonStr?.split('\n'); |
| 110 | + lines.forEach((line: string, idx) => { |
| 111 | + if (line.trim() !== '') { |
| 112 | + let parsedLine = {}; |
| 113 | + try { |
| 114 | + parsedLine = JSON.parse(line); |
| 115 | + } catch (error) { |
| 116 | + errs.push( |
| 117 | + getFormattedErrorMsg(error as Error, idx + 1) |
| 118 | + ); |
| 119 | + } |
| 120 | + if (!isEmpty(parsedLine)) { |
| 121 | + finalJsonStr += |
| 122 | + customStringifySingleLine(JSON.parse(line)) + '\n'; |
| 123 | + } |
| 124 | + } |
| 125 | + }); |
| 126 | + // remove trailing newline |
| 127 | + if (finalJsonStr !== '') { |
| 128 | + finalJsonStr = finalJsonStr.slice(0, -1); |
| 129 | + } |
| 130 | + |
| 131 | + if (errs?.length > 0) { |
| 132 | + setCustomErrMsg(getFormattedErrorMsgList(errs)); |
| 133 | + } else { |
| 134 | + form.setFieldValue(field.name, finalJsonStr); |
| 135 | + setCustomErrMsg(undefined); |
| 136 | + } |
| 137 | + } catch (error) {} |
| 138 | + }} |
| 139 | + readOnly={props.readOnly || false} |
| 140 | + setOptions={{ |
| 141 | + fontSize: '14px', |
| 142 | + useWorker: false, |
| 143 | + highlightActiveLine: !props.readOnly, |
| 144 | + highlightSelectedWord: !props.readOnly, |
| 145 | + highlightGutterLine: !props.readOnly, |
| 146 | + wrap: true, |
| 147 | + }} |
| 148 | + aria-label="Code Editor" |
| 149 | + /> |
| 150 | + </EuiCompressedFormRow> |
| 151 | + ); |
| 152 | + }} |
| 153 | + </Field> |
| 154 | + ); |
| 155 | +} |
| 156 | + |
| 157 | +// Parse out the useful information from an error triggered during JSON parsing failure |
| 158 | +function getFormattedErrorMsg(error: Error, idx: number): string { |
| 159 | + return `Error on line ${idx}: ${getIn(error, 'message', 'Invalid JSON') |
| 160 | + .replace(/^(.*?)\s+in JSON.*/, '$1') |
| 161 | + .replace(/^(.*?)\s+after JSON.*/, '$1')}`; |
| 162 | +} |
| 163 | + |
| 164 | +// Verbosely display a few error messages, list the count of remaining ones. |
| 165 | +function getFormattedErrorMsgList(errors: string[]): string { |
| 166 | + let finalMsg = ''; |
| 167 | + const verboseErrors = errors.slice(0, 3); |
| 168 | + const nonVerboseErrorCount = errors.length - 3; |
| 169 | + verboseErrors.forEach((error) => { |
| 170 | + finalMsg += error + '\n'; |
| 171 | + }); |
| 172 | + if (nonVerboseErrorCount > 0) { |
| 173 | + finalMsg += `${nonVerboseErrorCount} more error${ |
| 174 | + nonVerboseErrorCount > 1 ? 's' : '' |
| 175 | + }`; |
| 176 | + } else if (finalMsg !== '') { |
| 177 | + // remove trailing newline |
| 178 | + finalMsg = finalMsg.slice(0, -1); |
| 179 | + } |
| 180 | + return finalMsg; |
| 181 | +} |
0 commit comments