[Form lib] Allow new "defaultValue" to be provided when resetting the…

[sebelga]

This PR adds a new defaultValue option that can be passed to the form.reset() handler.

// The form object can be accessed anywhere through context
const form = useFormContext();

const onSomeCallback = () => {
  // Any field different than "foo" will have its value reset to the
  // defaultValue defined on the FieldConfig object, and if none was provided to `""` (empty string)
  form.reset({ defaultValue: { foo: 'bar' } });
}

This should also help in fixing the first part of this comment #72849 (comment)

@alisonelizabeth @jloleysens

Fixes #74950

[elasticmachine]

Pinging @elastic/es-ui (Team:Elasticsearch UI)

[jloleysens]

This is really cool @sebelga . I think this gives consumers precise control of form values given any external or internal form change.

I tested with the following ingest node pipeline form changes:

patch

diff --git i/x-pack/plugins/ingest_pipelines/public/application/components/pipeline_processors_editor/components/manage_processor_form/processors/common_fields/processor_type_field.tsx w/x-pack/plugins/ingest_pipelines/public/application/components/pipeline_processors_editor/components/manage_processor_form/processors/common_fields/processor_type_field.tsx
index e4ad90f61af..133950896cc 100644
--- i/x-pack/plugins/ingest_pipelines/public/application/components/pipeline_processors_editor/components/manage_processor_form/processors/common_fields/processor_type_field.tsx
+++ w/x-pack/plugins/ingest_pipelines/public/application/components/pipeline_processors_editor/components/manage_processor_form/processors/common_fields/processor_type_field.tsx
@@ -14,6 +14,7 @@ import {
   FieldConfig,
   UseField,
   fieldValidators,
+  useFormContext,
 } from '../../../../../../../shared_imports';
 
 import { getProcessorDescriptor, mapProcessorTypeToDescriptor } from '../../../shared';
@@ -64,6 +65,7 @@ const typeConfig: FieldConfig<any, string> = {
 };
 
 export const ProcessorTypeField: FunctionComponent<Props> = ({ initialType }) => {
+  const form = useFormContext();
   return (
     <UseField<string> config={typeConfig} defaultValue={initialType} path="type">
       {(typeField) => {
@@ -123,7 +125,10 @@ export const ProcessorTypeField: FunctionComponent<Props> = ({ initialType }) =>
               onCreateOption={onCreateComboOption}
               onChange={(options: Array<EuiComboBoxOptionOption<string>>) => {
                 const [selection] = options;
-                typeField.setValue(selection?.value! ?? '');
+                const type = selection?.value! ?? '';
+                console.log('resetting form default value to', { type });
+                typeField.setValue(type);
+                form.reset({ defaultValue: { type } });
               }}
               noSuggestions={false}
               singleSelection={{

And was able to to get the desired behaviour of resetting the default values on type changes.

[sebelga]

Thanks for the review @jloleysens ! I had to fix a few test (great that they caught the regression on the mappings editor! 😊

I haven't tested but I don't think you need to set the value if you reset right after, as resetting sets the value on the field.

typeField.setValue(type); // You might not need to do that
form.reset({ defaultValue: { type } });

[kibanamachine]

💚 Build Succeeded

• continuous-integration/kibana-ci/pull-request
• Commit: d62f9a7

Build metrics

async chunks size

id	value	diff	baseline
indexManagement	1.5MB	+1.3KB	1.5MB

page load bundle size

id	value	diff	baseline
esUiShared	988.1KB	+940.0B	987.2KB

History

• 💔 Build #68799 failed a64f3a9
• 💔 Build #68764 failed 66a7ce3

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream