add rule changes history fetching logic

Author: maximpn

x-pack/solutions/security/plugins/security_solution/public/detection_engine/rule_management/api/api.ts

@@ -54,9 +54,11 @@ import type {
   GetRuleManagementFiltersResponse,
   ImportRulesResponse,
   BulkManualRuleFillGaps,
+  RuleChangesHistoryResponse,
 } from '../../../../common/api/detection_engine/rule_management';
 import {
   BulkActionTypeEnum,
+  RULE_HISTORY_URL,
   RULE_MANAGEMENT_COVERAGE_OVERVIEW_URL,
   RULE_MANAGEMENT_FILTERS_URL,
   RULE_MANAGEMENT_RULES_URL_SEARCH,
@@ -81,6 +83,7 @@ import type {
   CreateRulesProps,
   ExportDocumentsProps,
   FetchCoverageOverviewProps,
+  FetchRuleHistoryProps,
   FetchRuleProps,
   FetchRuleSnoozingProps,
   FetchSearchRulesProps,
@@ -316,6 +319,32 @@ export const fetchRuleById = async ({ id, signal }: FetchRuleProps): Promise<Rul
     signal,
   });
 
+/**
+ * Fetch the change history for a Rule.
+ *
+ * @param ruleId Rule SO id (not `rule_id`)
+ * @param page 1-based page number
+ * @param perPage items per page
+ * @param signal to cancel request
+ *
+ * @returns Promise<RuleChangesHistoryResponse>
+ */
+export const fetchRuleChangeHistoryById = async ({
+  ruleId,
+  page,
+  perPage,
+  signal,
+}: FetchRuleHistoryProps): Promise<RuleChangesHistoryResponse> =>
+  KibanaServices.get().http.fetch<RuleChangesHistoryResponse>(
+    RULE_HISTORY_URL.replace('{ruleId}', encodeURIComponent(ruleId)),
+    {
+      method: 'GET',
+      version: '1',
+      query: { page, per_page: perPage },
+      signal,
+    }
+  );
+
 /**
  * Fetch rule snooze settings for each provided ruleId
  *

x-pack/solutions/security/plugins/security_solution/public/detection_engine/rule_management/api/hooks/use_change_history.ts

@@ -0,0 +1,55 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+import type { UseQueryOptions } from '@kbn/react-query';
+import { useQuery } from '@kbn/react-query';
+import type { RuleChangesHistoryResponse } from '../../../../../common/api/detection_engine/rule_management';
+import { RULE_HISTORY_URL } from '../../../../../common/api/detection_engine/rule_management';
+import { useAppToasts } from '../../../../common/hooks/use_app_toasts';
+import { fetchRuleChangeHistoryById } from '../api';
+import { DEFAULT_QUERY_OPTIONS } from './constants';
+import * as i18n from './translations';
+
+const RULE_CHANGE_HISTORY_QUERY_KEY = ['GET', RULE_HISTORY_URL];
+
+export interface UseChangeHistoryArgs {
+  ruleId: string;
+  page: number;
+  perPage: number;
+}
+
+/**
+ * A wrapper around useQuery that fetches the change history for a rule.
+ *
+ * @param queryArgs - rule id and pagination
+ * @param queryOptions - react-query options
+ * @returns useQuery result
+ */
+export const useChangeHistory = (
+  queryArgs: UseChangeHistoryArgs,
+  queryOptions?: UseQueryOptions<
+    RuleChangesHistoryResponse,
+    Error,
+    RuleChangesHistoryResponse,
+    [...string[], UseChangeHistoryArgs]
+  >
+) => {
+  const { addError } = useAppToasts();
+
+  return useQuery(
+    [...RULE_CHANGE_HISTORY_QUERY_KEY, queryArgs],
+    ({ signal }) => fetchRuleChangeHistoryById({ signal, ...queryArgs }),
+    {
+      ...DEFAULT_QUERY_OPTIONS,
+      staleTime: 0,
+      ...queryOptions,
+      onError: (error) => {
+        addError(error, { title: i18n.HISTORY_FETCH_ERROR });
+      },
+    }
+  );
+};

x-pack/solutions/security/plugins/security_solution/public/detection_engine/rule_management/logic/types.ts

@@ -143,6 +143,13 @@ export interface FetchRuleProps {
   signal?: AbortSignal;
 }
 
+export interface FetchRuleHistoryProps {
+  ruleId: string;
+  page: number;
+  perPage: number;
+  signal?: AbortSignal;
+}
+
 export interface FetchRuleSnoozingProps {
   ids: string[];
   signal?: AbortSignal;

x-pack/solutions/security/plugins/security_solution/public/rules/routes.tsx

@@ -114,8 +114,8 @@ const getRulesSubRoutes = (
     ? [
         {
           path: endpointExceptionsTabEnabled
-            ? `/rules/id/:detailName/:tabName(${RuleDetailTabs.overview}|${RuleDetailTabs.alerts}|${RuleDetailTabs.exceptions}|${RuleDetailTabs.endpointExceptions}|${RuleDetailTabs.executionResults})`
-            : `/rules/id/:detailName/:tabName(${RuleDetailTabs.overview}|${RuleDetailTabs.alerts}|${RuleDetailTabs.exceptions}|${RuleDetailTabs.executionResults})`,
+            ? `/rules/id/:detailName/:tabName(${RuleDetailTabs.overview}|${RuleDetailTabs.alerts}|${RuleDetailTabs.exceptions}|${RuleDetailTabs.endpointExceptions}|${RuleDetailTabs.executionResults}|${RuleDetailTabs.history})`
+            : `/rules/id/:detailName/:tabName(${RuleDetailTabs.overview}|${RuleDetailTabs.alerts}|${RuleDetailTabs.exceptions}|${RuleDetailTabs.executionResults}|${RuleDetailTabs.history})`,
           main: RuleDetailsTabGuard,
           exact: true,
         },