-
Notifications
You must be signed in to change notification settings - Fork 3.8k
/
ServiceForm.tsx
274 lines (241 loc) · 9.79 KB
/
ServiceForm.tsx
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
import { Formik, getIn, setIn, useFormikContext } from "formik";
import { JSONSchema7 } from "json-schema";
import React, { useCallback, useEffect, useMemo, useState } from "react";
import { useDeepCompareEffect, useToggle } from "react-use";
import { FormChangeTracker } from "components/FormChangeTracker";
import { ConnectorDefinition, ConnectorDefinitionSpecification } from "core/domain/connector";
import { isDestinationDefinitionSpecification } from "core/domain/connector/destination";
import { isSourceDefinition, isSourceDefinitionSpecification } from "core/domain/connector/source";
import { FormBaseItem, FormComponentOverrideProps } from "core/form/types";
import { useFormChangeTrackerService, useUniqueFormId } from "hooks/services/FormChangeTracker";
import { isDefined } from "utils/common";
import RequestConnectorModal from "views/Connector/RequestConnectorModal";
import { CheckConnectionRead } from "../../../core/request/AirbyteClient";
import { useDocumentationPanelContext } from "../ConnectorDocumentationLayout/DocumentationPanelContext";
import { ConnectorNameControl } from "./components/Controls/ConnectorNameControl";
import { ConnectorServiceTypeControl } from "./components/Controls/ConnectorServiceTypeControl";
import { FormRoot } from "./FormRoot";
import { ServiceFormContextProvider, useServiceForm } from "./serviceFormContext";
import { ServiceFormValues } from "./types";
import {
useBuildForm,
useBuildInitialSchema,
useBuildUiWidgetsContext,
useConstructValidationSchema,
usePatchFormik,
} from "./useBuildForm";
const FormikPatch: React.FC = () => {
usePatchFormik();
return null;
};
/***
* This function sets all initial const values in the form to current values
* @param schema
* @constructor
*/
const PatchInitialValuesWithWidgetConfig: React.FC<{
schema: JSONSchema7;
initialValues: ServiceFormValues;
}> = ({ schema, initialValues }) => {
const { widgetsInfo } = useServiceForm();
const { setFieldValue } = useFormikContext<ServiceFormValues>();
useDeepCompareEffect(() => {
const widgetsInfoEntries = Object.entries(widgetsInfo);
// set all const fields to form field values, so we could send form
const patchedConstValues = widgetsInfoEntries
.filter(([_, value]) => isDefined(value.const))
.reduce((acc, [key, value]) => setIn(acc, key, value.const), initialValues);
// set default fields as current values, so values could be populated correctly
// fix for https://github.com/airbytehq/airbyte/issues/6791
const patchedDefaultValues = widgetsInfoEntries
.filter(([key, value]) => isDefined(value.default) && !isDefined(getIn(patchedConstValues, key)))
.reduce((acc, [key, value]) => setIn(acc, key, value.default), patchedConstValues);
if (patchedDefaultValues?.connectionConfiguration) {
setFieldValue("connectionConfiguration", patchedDefaultValues.connectionConfiguration);
}
// eslint-disable-next-line react-hooks/exhaustive-deps
}, [schema]);
return null;
};
/**
* A component that will observe whenever the serviceType (selected connector)
* changes and set the name of the connector to match the connector definition name.
*/
const SetDefaultName: React.FC = () => {
const { setFieldValue } = useFormikContext();
const { selectedService } = useServiceForm();
useEffect(() => {
if (!selectedService) {
return;
}
const timeout = setTimeout(() => {
// We need to push this out one execution slot, so the form isn't still in its
// initialization status and won't react to this call but would just take the initialValues instead.
setFieldValue("name", selectedService.name);
});
return () => clearTimeout(timeout);
// eslint-disable-next-line react-hooks/exhaustive-deps
}, [selectedService]);
return null;
};
export interface ServiceFormProps {
formType: "source" | "destination";
availableServices: ConnectorDefinition[];
selectedConnectorDefinitionSpecification?: ConnectorDefinitionSpecification;
onServiceSelect?: (id: string) => void;
onSubmit: (values: ServiceFormValues) => void;
isLoading?: boolean;
isEditMode?: boolean;
formValues?: Partial<ServiceFormValues>;
hasSuccess?: boolean;
fetchingConnectorError?: Error | null;
errorMessage?: React.ReactNode;
successMessage?: React.ReactNode;
isTestConnectionInProgress?: boolean;
onStopTesting?: () => void;
testConnector?: (v?: ServiceFormValues) => Promise<CheckConnectionRead>;
}
const ServiceForm: React.FC<ServiceFormProps> = (props) => {
const formId = useUniqueFormId();
const { clearFormChange } = useFormChangeTrackerService();
const [isOpenRequestModal, toggleOpenRequestModal] = useToggle(false);
const [initialRequestName, setInitialRequestName] = useState<string>();
const {
formType,
formValues,
onSubmit,
isLoading,
isTestConnectionInProgress,
onStopTesting,
testConnector,
selectedConnectorDefinitionSpecification,
availableServices,
} = props;
const specifications = useBuildInitialSchema(selectedConnectorDefinitionSpecification);
const jsonSchema: JSONSchema7 = useMemo(
() => ({
type: "object",
properties: {
serviceType: { type: "string" },
...(selectedConnectorDefinitionSpecification ? { name: { type: "string" } } : {}),
...Object.fromEntries(
Object.entries({
connectionConfiguration: isLoading ? null : specifications,
}).filter(([, v]) => !!v)
),
},
required: ["name", "serviceType"],
}),
[isLoading, selectedConnectorDefinitionSpecification, specifications]
);
const { formFields, initialValues } = useBuildForm(jsonSchema, formValues);
const { setDocumentationUrl, setDocumentationPanelOpen } = useDocumentationPanelContext();
useEffect(() => {
if (!selectedConnectorDefinitionSpecification) {
return;
}
const selectedServiceDefinition = availableServices.find((service) => {
if (isSourceDefinition(service)) {
const serviceDefinitionId = service.sourceDefinitionId;
return (
isSourceDefinitionSpecification(selectedConnectorDefinitionSpecification) &&
serviceDefinitionId === selectedConnectorDefinitionSpecification.sourceDefinitionId
);
}
const serviceDefinitionId = service.destinationDefinitionId;
return (
isDestinationDefinitionSpecification(selectedConnectorDefinitionSpecification) &&
serviceDefinitionId === selectedConnectorDefinitionSpecification.destinationDefinitionId
);
});
setDocumentationUrl(selectedServiceDefinition?.documentationUrl ?? "");
setDocumentationPanelOpen(true);
}, [availableServices, selectedConnectorDefinitionSpecification, setDocumentationPanelOpen, setDocumentationUrl]);
const uiOverrides = useMemo(
() => ({
name: {
component: (property: FormBaseItem, componentProps: FormComponentOverrideProps) => (
<ConnectorNameControl property={property} formType={formType} {...componentProps} />
),
},
serviceType: {
component: (property: FormBaseItem, componentProps: FormComponentOverrideProps) => (
<ConnectorServiceTypeControl
property={property}
formType={formType}
onChangeServiceType={props.onServiceSelect}
availableServices={props.availableServices}
isEditMode={props.isEditMode}
onOpenRequestConnectorModal={(name) => {
setInitialRequestName(name);
toggleOpenRequestModal();
}}
{...componentProps}
/>
),
},
}),
[formType, props.onServiceSelect, props.availableServices, props.isEditMode, toggleOpenRequestModal]
);
const { uiWidgetsInfo, setUiWidgetsInfo } = useBuildUiWidgetsContext(formFields, initialValues, uiOverrides);
const validationSchema = useConstructValidationSchema(jsonSchema, uiWidgetsInfo);
const getValues = useCallback(
(values: ServiceFormValues) =>
validationSchema.cast(values, {
stripUnknown: true,
}),
[validationSchema]
);
const onFormSubmit = useCallback(
async (values: ServiceFormValues) => {
const valuesToSend = getValues(values);
await onSubmit(valuesToSend);
clearFormChange(formId);
},
[clearFormChange, formId, getValues, onSubmit]
);
return (
<Formik
validateOnBlur
validateOnChange
initialValues={initialValues}
validationSchema={validationSchema}
onSubmit={onFormSubmit}
enableReinitialize
>
{({ dirty }) => (
<ServiceFormContextProvider
widgetsInfo={uiWidgetsInfo}
getValues={getValues}
setUiWidgetsInfo={setUiWidgetsInfo}
formType={formType}
selectedConnector={selectedConnectorDefinitionSpecification}
availableServices={props.availableServices}
isEditMode={props.isEditMode}
isLoadingSchema={props.isLoading}
>
{!props.isEditMode && <SetDefaultName />}
<FormikPatch />
<FormChangeTracker changed={dirty} formId={formId} />
<PatchInitialValuesWithWidgetConfig schema={jsonSchema} initialValues={initialValues} />
<FormRoot
{...props}
errorMessage={props.errorMessage}
isTestConnectionInProgress={isTestConnectionInProgress}
onStopTestingConnector={onStopTesting ? () => onStopTesting() : undefined}
onRetest={testConnector ? async () => await testConnector() : undefined}
formFields={formFields}
/>
{isOpenRequestModal && (
<RequestConnectorModal
connectorType={formType}
initialName={initialRequestName}
onClose={toggleOpenRequestModal}
/>
)}
</ServiceFormContextProvider>
)}
</Formik>
);
};
export { ServiceForm };