adjust kql and rename to kuery

tomsonpl · tomsonpl · commit 6a127a9edc8d · 2023-08-22T12:46:56.000+02:00
diff --git a/x-pack/plugins/osquery/common/api/live_query/find_live_query_route.ts b/x-pack/plugins/osquery/common/api/live_query/find_live_query_route.ts
@@ -9,7 +9,7 @@ import * as t from 'io-ts';
 import { toNumberRt } from '@kbn/io-ts-utils';
 
 export const findLiveQueryRequestQuerySchema = t.type({
-  filterQuery: t.union([t.string, t.undefined]),
+  kuery: t.union([t.string, t.undefined]),
   page: t.union([toNumberRt, t.undefined]),
   pageSize: t.union([toNumberRt, t.undefined]),
   sort: t.union([t.string, t.undefined]),
diff --git a/x-pack/plugins/osquery/common/api/live_query/get_live_query_results_route.ts b/x-pack/plugins/osquery/common/api/live_query/get_live_query_results_route.ts
@@ -9,7 +9,7 @@ import * as t from 'io-ts';
 import { toNumberRt } from '@kbn/io-ts-utils';
 
 export const getLiveQueryResultsRequestQuerySchema = t.type({
-  filterQuery: t.union([t.string, t.undefined]),
+  kuery: t.union([t.string, t.undefined]),
   page: t.union([toNumberRt, t.undefined]),
   pageSize: t.union([toNumberRt, t.undefined]),
   sort: t.union([t.string, t.undefined]),
diff --git a/x-pack/plugins/osquery/common/search_strategy/osquery/index.ts b/x-pack/plugins/osquery/common/search_strategy/osquery/index.ts
@@ -34,7 +34,7 @@ export enum OsqueryQueries {
 export type FactoryQueryTypes = OsqueryQueries;
 
 export interface RequestBasicOptions extends IEsSearchRequest {
-  kql?: string;
+  kuery?: string;
   factoryQueryType?: FactoryQueryTypes;
   componentTemplateExists?: boolean;
 }
diff --git a/x-pack/plugins/osquery/cypress/e2e/all/cases.cy.ts b/x-pack/plugins/osquery/cypress/e2e/all/cases.cy.ts
@@ -22,7 +22,7 @@ describe('Add to Cases', () => {
     loadLiveQuery({
       agent_all: true,
       query: "SELECT * FROM os_version where name='Ubuntu';",
-      kql: '',
+      kuery: '',
     }).then((liveQuery) => {
       liveQueryId = liveQuery.action_id;
       liveQueryQuery = liveQuery.queries[0].query;
diff --git a/x-pack/plugins/osquery/cypress/tasks/api_fixtures.ts b/x-pack/plugins/osquery/cypress/tasks/api_fixtures.ts
@@ -121,7 +121,7 @@ export const loadLiveQuery = (
   payload = {
     agent_all: true,
     query: 'select * from uptime;',
-    kql: '',
+    kuery: '',
   }
 ) =>
   request<{
diff --git a/x-pack/plugins/osquery/public/action_results/use_action_results.ts b/x-pack/plugins/osquery/public/action_results/use_action_results.ts
@@ -38,7 +38,7 @@ export interface UseActionResults {
   direction: Direction;
   limit: number;
   sortField: string;
-  kql?: string;
+  kuery?: string;
   skip?: boolean;
   isLive?: boolean;
 }
@@ -50,7 +50,7 @@ export const useActionResults = ({
   direction,
   limit,
   sortField,
-  kql,
+  kuery,
   skip = false,
   isLive = false,
 }: UseActionResults) => {
@@ -65,7 +65,7 @@ export const useActionResults = ({
           {
             actionId,
             factoryQueryType: OsqueryQueries.actionResults,
-            kql,
+            kuery,
             pagination: generateTablePaginationOptions(activePage, limit),
             sort: {
               direction,
diff --git a/x-pack/plugins/osquery/public/actions/actions_table.tsx b/x-pack/plugins/osquery/public/actions/actions_table.tsx
@@ -62,7 +62,7 @@ const ActionsTableComponent = () => {
   const { data: actionsData } = useAllLiveQueries({
     activePage: pageIndex,
     limit: pageSize,
-    kql: 'user_id: *',
+    kuery: 'user_id: *',
   });
 
   const onTableChange = useCallback(({ page = {} }) => {
diff --git a/x-pack/plugins/osquery/public/actions/use_all_live_queries.ts b/x-pack/plugins/osquery/public/actions/use_all_live_queries.ts
@@ -20,7 +20,7 @@ export interface UseAllLiveQueriesConfig {
   direction?: Direction;
   limit?: number;
   sortField?: string;
-  kql?: string;
+  kuery?: string;
   skip?: boolean;
   alertId?: string;
 }
@@ -33,7 +33,7 @@ export const useAllLiveQueries = ({
   direction = Direction.desc,
   limit = 100,
   sortField = '@timestamp',
-  kql,
+  kuery,
   skip = false,
   alertId,
 }: UseAllLiveQueriesConfig) => {
@@ -51,7 +51,7 @@ export const useAllLiveQueries = ({
         {
           version: API_VERSIONS.public.v1,
           query: {
-            kql,
+            kuery,
             page: activePage,
             pageSize: limit,
             sort: sortField,
diff --git a/x-pack/plugins/osquery/public/actions/use_live_query_details.ts b/x-pack/plugins/osquery/public/actions/use_live_query_details.ts
@@ -17,7 +17,7 @@ import { useErrorToast } from '../common/hooks/use_error_toast';
 interface UseLiveQueryDetails {
   actionId?: string;
   isLive?: boolean;
-  kql?: string;
+  kuery?: string;
   skip?: boolean;
   queryIds?: string[];
 }
@@ -53,7 +53,7 @@ export interface LiveQueryDetailsItem {
 
 export const useLiveQueryDetails = ({
   actionId,
-  kql,
+  kuery,
   isLive = false,
   skip = false,
   queryIds, // enable finding out specific queries only, eg. in cases
@@ -62,7 +62,7 @@ export const useLiveQueryDetails = ({
   const setErrorToast = useErrorToast();
 
   return useQuery<{ data: LiveQueryDetailsItem }, Error, LiveQueryDetailsItem>(
-    ['liveQueries', { actionId, kql, queryIds }],
+    ['liveQueries', { actionId, kuery, queryIds }],
     () => http.get(`/api/osquery/live_queries/${actionId}`, { version: API_VERSIONS.public.v1 }),
     {
       enabled: !skip && !!actionId,
diff --git a/x-pack/plugins/osquery/public/agents/use_agent_groups.ts b/x-pack/plugins/osquery/public/agents/use_agent_groups.ts
@@ -40,7 +40,7 @@ export const useAgentGroups = () => {
       const responseData = await lastValueFrom(
         data.search.search<AgentsRequestOptions, AgentsStrategyResponse>(
           {
-            kql: `policy_id: ( ${policiesQuery} )`,
+            kuery: `policy_id: ( ${policiesQuery} )`,
             factoryQueryType: OsqueryQueries.agents,
             pagination: generateTablePaginationOptions(0, 9000),
             sort: {
diff --git a/x-pack/plugins/osquery/public/results/use_all_results.ts b/x-pack/plugins/osquery/public/results/use_all_results.ts
@@ -35,7 +35,7 @@ interface UseAllResults {
   activePage: number;
   limit: number;
   sort: Array<{ field: string; direction: Direction }>;
-  kql?: string;
+  kuery?: string;
   skip?: boolean;
   isLive?: boolean;
 }
@@ -45,7 +45,7 @@ export const useAllResults = ({
   activePage,
   limit,
   sort,
-  kql,
+  kuery,
   skip = false,
   isLive = false,
 }: UseAllResults) => {
@@ -60,7 +60,7 @@ export const useAllResults = ({
           {
             actionId,
             factoryQueryType: OsqueryQueries.results,
-            kql,
+            kuery,
             pagination: generateTablePaginationOptions(activePage, limit),
             sort,
           },
diff --git a/x-pack/plugins/osquery/server/routes/live_query/find_live_query_route.ts b/x-pack/plugins/osquery/server/routes/live_query/find_live_query_route.ts
@@ -52,7 +52,7 @@ export const findLiveQueryRoute = (router: IRouter<DataRequestHandlerContext>) =
             search.search<ActionsRequestOptions, ActionsStrategyResponse>(
               {
                 factoryQueryType: OsqueryQueries.actions,
-                kql: request.query.kql,
+                kuery: request.query.kuery,
                 pagination: generateTablePaginationOptions(
                   request.query.page ?? 0,
                   request.query.pageSize ?? 100
diff --git a/x-pack/plugins/osquery/server/routes/live_query/get_live_query_details_route.ts b/x-pack/plugins/osquery/server/routes/live_query/get_live_query_details_route.ts
@@ -61,7 +61,6 @@ export const getLiveQueryDetailsRoute = (router: IRouter<DataRequestHandlerConte
             search.search<ActionDetailsRequestOptions, ActionDetailsStrategyResponse>(
               {
                 actionId: request.params.id,
-                kql: request.query.kql,
                 factoryQueryType: OsqueryQueries.actionDetails,
               },
               { abortSignal, strategy: 'osquerySearchStrategy' }
diff --git a/x-pack/plugins/osquery/server/routes/live_query/get_live_query_results_route.ts b/x-pack/plugins/osquery/server/routes/live_query/get_live_query_results_route.ts
@@ -61,7 +61,7 @@ export const getLiveQueryResultsRoute = (router: IRouter<DataRequestHandlerConte
             search.search<ActionDetailsRequestOptions, ActionDetailsStrategyResponse>(
               {
                 actionId: request.params.id,
-                kql: request.query.kql,
+                kuery: request.query.kuery,
                 factoryQueryType: OsqueryQueries.actionDetails,
               },
               { abortSignal, strategy: 'osquerySearchStrategy' }
@@ -83,7 +83,7 @@ export const getLiveQueryResultsRoute = (router: IRouter<DataRequestHandlerConte
               {
                 actionId: request.params.actionId,
                 factoryQueryType: OsqueryQueries.results,
-                kql: request.query.kql,
+                kuery: request.query.kuery,
                 pagination: generateTablePaginationOptions(
                   request.query.page ?? 0,
                   request.query.pageSize ?? 100
diff --git a/x-pack/plugins/osquery/server/routes/live_query/utils.ts b/x-pack/plugins/osquery/server/routes/live_query/utils.ts
@@ -53,7 +53,7 @@ export const getActionResponses = (
       {
         actionId,
         factoryQueryType: OsqueryQueries.actionResults,
-        kql: '',
+        kuery: '',
         pagination: generateTablePaginationOptions(0, 1000),
         sort: {
           direction: Direction.desc,
diff --git a/x-pack/plugins/osquery/server/search_strategy/osquery/factory/actions/all/query.all_actions.dsl.ts b/x-pack/plugins/osquery/server/search_strategy/osquery/factory/actions/all/query.all_actions.dsl.ts
@@ -14,14 +14,14 @@ import { ACTIONS_INDEX } from '../../../../../../common/constants';
 import type { AgentsRequestOptions } from '../../../../../../common/search_strategy';
 
 export const buildActionsQuery = ({
-  kql = '',
+  kuery = '',
   sort,
   pagination: { cursorStart, querySize },
   componentTemplateExists,
 }: AgentsRequestOptions): ISearchRequestParams => {
   const {
     bool: { filter },
-  } = getQueryFilter({ filter: kql });
+  } = getQueryFilter({ filter: kuery });
 
   const dslQuery = {
     allow_no_indices: true,
diff --git a/x-pack/plugins/osquery/server/search_strategy/osquery/factory/actions/details/query.action_details.dsl.ts b/x-pack/plugins/osquery/server/search_strategy/osquery/factory/actions/details/query.action_details.dsl.ts
@@ -14,13 +14,13 @@ import type { ActionDetailsRequestOptions } from '../../../../../../common/searc
 
 export const buildActionDetailsQuery = ({
   actionId,
-  kql,
+  kuery,
   componentTemplateExists,
 }: ActionDetailsRequestOptions): ISearchRequestParams => {
   const actionIdQuery = `action_id: ${actionId}`;
   let filter = actionIdQuery;
-  if (!isEmpty(kql)) {
-    filter = filter + ` AND ${kql}`;
+  if (!isEmpty(kuery)) {
+    filter = filter + ` AND ${kuery}`;
   }
 
   const filterQuery = getQueryFilter({ filter });
diff --git a/x-pack/plugins/osquery/server/search_strategy/osquery/factory/actions/results/query.action_results.dsl.ts b/x-pack/plugins/osquery/server/search_strategy/osquery/factory/actions/results/query.action_results.dsl.ts
@@ -14,15 +14,15 @@ import { getQueryFilter } from '../../../../../utils/build_query';
 
 export const buildActionResultsQuery = ({
   actionId,
-  kql,
+  kuery,
   // pagination: { activePage, querySize },
   sort,
   componentTemplateExists,
 }: ActionResultsRequestOptions): ISearchRequestParams => {
   const actionIdQuery = `action_id: ${actionId}`;
   let filter = actionIdQuery;
-  if (!isEmpty(kql)) {
-    filter = filter + ` AND ${kql}`;
+  if (!isEmpty(kuery)) {
+    filter = filter + ` AND ${kuery}`;
   }
 
   const filterQuery = getQueryFilter({ filter });
diff --git a/x-pack/plugins/osquery/server/search_strategy/osquery/factory/agents/query.all_agents.dsl.ts b/x-pack/plugins/osquery/server/search_strategy/osquery/factory/agents/query.all_agents.dsl.ts
@@ -12,14 +12,14 @@ import { getQueryFilter } from '../../../../utils/build_query';
 import type { AgentsRequestOptions } from '../../../../../common/search_strategy';
 
 export const buildAgentsQuery = ({
-  kql,
+  kuery,
   pagination: { cursorStart, querySize },
   sort,
 }: AgentsRequestOptions): ISearchRequestParams => {
   const activeQuery = `active: true`;
   let filter = activeQuery;
-  if (!isEmpty(kql)) {
-    filter = activeQuery + ` AND ${kql}`;
+  if (!isEmpty(kuery)) {
+    filter = activeQuery + ` AND ${kuery}`;
   }
 
   const filterQuery = getQueryFilter({ filter });
diff --git a/x-pack/plugins/osquery/server/search_strategy/osquery/factory/results/query.all_results.dsl.ts b/x-pack/plugins/osquery/server/search_strategy/osquery/factory/results/query.all_results.dsl.ts
@@ -14,15 +14,15 @@ import type { ResultsRequestOptions } from '../../../../../common/search_strateg
 export const buildResultsQuery = ({
   actionId,
   agentId,
-  kql,
+  kuery,
   sort,
   pagination: { activePage, querySize },
 }: ResultsRequestOptions): ISearchRequestParams => {
   const actionIdQuery = `action_id: ${actionId}`;
   const agentQuery = agentId ? ` AND agent.id: ${agentId}` : '';
   let filter = actionIdQuery + agentQuery;
-  if (!isEmpty(kql)) {
-    filter = filter + ` AND ${kql}`;
+  if (!isEmpty(kuery)) {
+    filter = filter + ` AND ${kuery}`;
   }
 
   const filterQuery = getQueryFilter({ filter });
diff --git a/x-pack/plugins/osquery/server/search_strategy/osquery/index.ts b/x-pack/plugins/osquery/server/search_strategy/osquery/index.ts
@@ -41,7 +41,7 @@ export const osquerySearchStrategyProvider = <T extends FactoryQueryTypes>(
         mergeMap((exists) => {
           const strictRequest = {
             factoryQueryType: request.factoryQueryType,
-            kql: request.kql,
+            kuery: request.kuery,
             ...('pagination' in request ? { pagination: request.pagination } : {}),
             ...('sort' in request ? { sort: request.sort } : {}),
             ...('actionId' in request ? { actionId: request.actionId } : {}),

Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ export enum OsqueryQueries {`
`34`	`34`	`export type FactoryQueryTypes = OsqueryQueries;`
`35`	`35`
`36`	`36`	`export interface RequestBasicOptions extends IEsSearchRequest {`
`37`		`- kql?: string;`
	`37`	`+ kuery?: string;`
`38`	`38`	`factoryQueryType?: FactoryQueryTypes;`
`39`	`39`	`componentTemplateExists?: boolean;`
`40`	`40`	`}`
Original file line number	Diff line number	Diff line change
`@@ -121,7 +121,7 @@ export const loadLiveQuery = (`
`121`	`121`	`payload = {`
`122`	`122`	`agent_all: true,`
`123`	`123`	`query: 'select * from uptime;',`
`124`		`- kql: '',`
	`124`	`+ kuery: '',`
`125`	`125`	`}`
`126`	`126`	`) =>`
`127`	`127`	`request<{`
Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@ export const useAgentGroups = () => {`
`40`	`40`	`const responseData = await lastValueFrom(`
`41`	`41`	`data.search.search<AgentsRequestOptions, AgentsStrategyResponse>(`
`42`	`42`	`{`
`43`		- kql: `policy_id: ( ${policiesQuery} )`,
	`43`	+ kuery: `policy_id: ( ${policiesQuery} )`,
`44`	`44`	`factoryQueryType: OsqueryQueries.agents,`
`45`	`45`	`pagination: generateTablePaginationOptions(0, 9000),`
`46`	`46`	`sort: {`