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.

Sign up for GitHub

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

[8.5] [Osquery] Fix ResponseActions form logic (#142612) #142643

Merged
merged 2 commits into from
Oct 4, 2022
Merged

[8.5] [Osquery] Fix ResponseActions form logic (#142612) #142643

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ef98618
[Osquery] Fix ResponseActions form logic (#142612)
patrykkopycinski Oct 4, 2022
f2b9617
Merge branch '8.5' into backport/8.5/pr-142612
patrykkopycinski Oct 4, 2022
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
138 changes: 54 additions & 84 deletions x-pack/plugins/osquery/public/shared_components/osquery_response_action_type/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,11 @@ import React, { forwardRef, useCallback, useEffect, useMemo, useState } from 're
import { EuiSpacer } from '@elastic/eui';
import uuid from 'uuid';
import { useForm as useHookForm, FormProvider } from 'react-hook-form';
import { get, isEmpty, map } from 'lodash';
import useEffectOnce from 'react-use/lib/useEffectOnce';
import { get, isEmpty, map, omit } from 'lodash';

import type { ECSMapping } from '@kbn/osquery-io-ts-types';
import { QueryPackSelectable } from '../../live_queries/form/query_pack_selectable';
import { useFormContext } from '../../shared_imports';
import { useFormContext, useFormData } from '../../shared_imports';
import type { ArrayItem } from '../../shared_imports';
import { useKibana } from '../../common/lib/kibana';
import { LiveQueryQueryField } from '../../live_queries/form/live_query_query_field';
Expand Down Expand Up @@ -50,19 +49,25 @@ const OsqueryResponseActionParamsFormComponent = forwardRef<
ResponseActionValidatorRef,
OsqueryResponseActionsParamsFormProps
>(({ item }, ref) => {
const { updateFieldValues } = useFormContext();
const [data] = useFormData({ watch: [item.path] });
const { params: defaultParams } = get(data, item.path);
const uniqueId = useMemo(() => uuid.v4(), []);
const hooksForm = useHookForm<OsqueryResponseActionsParamsFormFields>({
defaultValues: {
ecs_mapping: {},
id: uniqueId,
},
defaultValues: defaultParams
? {
...omit(defaultParams, ['ecsMapping', 'packId']),
ecs_mapping: defaultParams.ecsMapping ?? {},
packId: [defaultParams.packId] ?? [],
}
: {
ecs_mapping: {},
id: uniqueId,
},
});

const { watch, setValue, register, clearErrors, formState, handleSubmit } = hooksForm;
const { watch, register, formState, handleSubmit, reset } = hooksForm;
const { errors, isValid } = formState;
const context = useFormContext();
const data = context.getFormData();
const { params: defaultParams } = get(data, item.path);

const watchedValues = watch();
const { data: packData } = usePack({
Expand All @@ -72,51 +77,37 @@ const OsqueryResponseActionParamsFormComponent = forwardRef<
const [queryType, setQueryType] = useState<string>(
!isEmpty(defaultParams?.queries) ? 'pack' : 'query'
);
const onSubmit = useCallback(async () => {
try {
if (queryType === 'pack') {
context.updateFieldValues({
[item.path]: {
actionTypeId: OSQUERY_TYPE,
params: {
id: watchedValues.id,
packId: watchedValues?.packId?.length ? watchedValues?.packId[0] : undefined,
queries: packData
? map(packData.queries, (query, queryId: string) => ({
...query,
id: queryId,
}))
: watchedValues.queries,
},
},
});
} else {
context.updateFieldValues({
[item.path]: {
actionTypeId: OSQUERY_TYPE,
params: {
id: watchedValues.id,
savedQueryId: watchedValues.savedQueryId,
query: watchedValues.query,
ecsMapping: watchedValues.ecs_mapping,
},
},
});
}
// eslint-disable-next-line no-empty
} catch (e) {}
}, [
context,
item.path,
packData,
queryType,
watchedValues.ecs_mapping,
watchedValues.id,
watchedValues?.packId,
watchedValues.queries,
watchedValues.query,
watchedValues.savedQueryId,
]);
const onSubmit = useCallback(
async (formData) => {
updateFieldValues({
[item.path]:
queryType === 'pack'
? {
actionTypeId: OSQUERY_TYPE,
params: {
id: formData.id,
packId: formData?.packId?.length ? formData?.packId[0] : undefined,
queries: packData
? map(packData.queries, (query, queryId: string) => ({
...query,
id: queryId,
}))
: formData.queries,
},
}
: {
actionTypeId: OSQUERY_TYPE,
params: {
id: formData.id,
savedQueryId: formData.savedQueryId,
query: formData.query,
ecsMapping: formData.ecs_mapping,
},
},
});
},
[updateFieldValues, item.path, packData, queryType]
);

useEffect(() => {
// @ts-expect-error update types
Expand All @@ -135,41 +126,20 @@ const OsqueryResponseActionParamsFormComponent = forwardRef<
register('id');
}, [register]);

const permissions = useKibana().services.application.capabilities.osquery;

useEffectOnce(() => {
if (defaultParams && defaultParams.id) {
const { packId, ecsMapping, ...restParams } = defaultParams;
// TODO change map into forEach, and type defaultParams
map(restParams, (value, key: keyof OsqueryResponseActionsParamsFormFields) => {
if (!isEmpty(value)) {
setValue(key, value);
}
});

if (!isEmpty(ecsMapping)) {
setValue('ecs_mapping', ecsMapping);
}
useEffect(() => {
const subscription = watch(() => handleSubmit(onSubmit)());

if (!isEmpty(packId)) {
setValue('packId', [packId]);
}
}
});
return () => subscription.unsubscribe();
}, [handleSubmit, onSubmit, watch]);

const resetFormFields = useCallback(() => {
setValue('packId', []);
setValue('savedQueryId', '');
setValue('query', '');
setValue('ecs_mapping', {});
clearErrors();
}, [clearErrors, setValue]);
const permissions = useKibana().services.application.capabilities.osquery;

const canRunPacks = useMemo(
() =>
!!((permissions.runSavedQueries || permissions.writeLiveQueries) && permissions.readPacks),
[permissions]
);

const canRunSingleQuery = useMemo(
() =>
!!(
Expand All @@ -196,7 +166,7 @@ const OsqueryResponseActionParamsFormComponent = forwardRef<
setQueryType={setQueryType}
canRunPacks={canRunPacks}
canRunSingleQuery={canRunSingleQuery}
resetFormFields={resetFormFields}
resetFormFields={reset}
/>
<EuiSpacer size="m" />
{queryType === 'query' && <LiveQueryQueryField />}
Expand Down