[RAM][Maintenance Window] Fix maintenance window FE types and transfo…

…rms (elastic#173888) ## Summary Resolves: elastic#172529 Fix up some odd types for the maintenance window frontend. Consolidates some response transforms. ### Checklist - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios --------- Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
CoenWarmer · Feb 15, 2024 · b17559e · b17559e
1 parent 96b3be5
commit b17559e
Show file tree

Hide file tree

Showing 28 changed files with 184 additions and 233 deletions.
diff --git a/x-pack/plugins/alerting/public/hooks/use_archive_maintenance_window.test.tsx b/x-pack/plugins/alerting/public/hooks/use_archive_maintenance_window.test.tsx
@@ -7,7 +7,6 @@
 import { act, renderHook } from '@testing-library/react-hooks/dom';
 import { waitFor } from '@testing-library/react';
 
-import { MaintenanceWindow } from '../pages/maintenance_windows/types';
 import { AppMockRenderer, createAppMockRenderer } from '../lib/test_utils';
 import { useArchiveMaintenanceWindow } from './use_archive_maintenance_window';
 
@@ -37,7 +36,7 @@ const { archiveMaintenanceWindow } = jest.requireMock(
   '../services/maintenance_windows_api/archive'
 );
 
-const maintenanceWindow: MaintenanceWindow = {
+const maintenanceWindow = {
   title: 'archive',
   duration: 1,
   rRule: {

diff --git a/x-pack/plugins/alerting/public/hooks/use_create_maintenance_window.test.tsx b/x-pack/plugins/alerting/public/hooks/use_create_maintenance_window.test.tsx
@@ -7,7 +7,6 @@
 import { act, renderHook } from '@testing-library/react-hooks/dom';
 import { waitFor } from '@testing-library/react';
 
-import { MaintenanceWindow } from '../pages/maintenance_windows/types';
 import { AppMockRenderer, createAppMockRenderer } from '../lib/test_utils';
 import { useCreateMaintenanceWindow } from './use_create_maintenance_window';
 
@@ -35,7 +34,7 @@ jest.mock('../services/maintenance_windows_api/create', () => ({
 
 const { createMaintenanceWindow } = jest.requireMock('../services/maintenance_windows_api/create');
 
-const maintenanceWindow: MaintenanceWindow = {
+const maintenanceWindow = {
   title: 'test',
   duration: 1,
   rRule: {

diff --git a/x-pack/plugins/alerting/public/hooks/use_create_maintenance_window.ts b/x-pack/plugins/alerting/public/hooks/use_create_maintenance_window.ts
@@ -11,8 +11,7 @@ import type { IHttpFetchError } from '@kbn/core-http-browser';
 import type { KibanaServerError } from '@kbn/kibana-utils-plugin/public';
 
 import { useKibana } from '../utils/kibana_react';
-import { MaintenanceWindow } from '../pages/maintenance_windows/types';
-import { createMaintenanceWindow } from '../services/maintenance_windows_api/create';
+import { createMaintenanceWindow, CreateParams } from '../services/maintenance_windows_api/create';
 
 interface UseCreateMaintenanceWindowProps {
   onError?: (error: IHttpFetchError<KibanaServerError>) => void;
@@ -26,8 +25,8 @@ export function useCreateMaintenanceWindow(props?: UseCreateMaintenanceWindowPro
     notifications: { toasts },
   } = useKibana().services;
 
-  const mutationFn = (maintenanceWindow: MaintenanceWindow) => {
-    return createMaintenanceWindow({ http, maintenanceWindow });
+  const mutationFn = (createParams: CreateParams) => {
+    return createMaintenanceWindow({ http, createParams });
   };
 
   return useMutation(mutationFn, {

diff --git a/x-pack/plugins/alerting/public/hooks/use_finish_and_archive_maintenance_window.test.tsx b/x-pack/plugins/alerting/public/hooks/use_finish_and_archive_maintenance_window.test.tsx
@@ -7,7 +7,6 @@
 import { act, renderHook } from '@testing-library/react-hooks/dom';
 import { waitFor } from '@testing-library/react';
 
-import { MaintenanceWindow } from '../pages/maintenance_windows/types';
 import { AppMockRenderer, createAppMockRenderer } from '../lib/test_utils';
 import { useFinishAndArchiveMaintenanceWindow } from './use_finish_and_archive_maintenance_window';
 
@@ -41,7 +40,7 @@ const { archiveMaintenanceWindow } = jest.requireMock(
   '../services/maintenance_windows_api/archive'
 );
 
-const maintenanceWindow: MaintenanceWindow = {
+const maintenanceWindow = {
   title: 'test',
   duration: 1,
   rRule: {

diff --git a/x-pack/plugins/alerting/public/hooks/use_finish_maintenance_window.test.tsx b/x-pack/plugins/alerting/public/hooks/use_finish_maintenance_window.test.tsx
@@ -7,7 +7,6 @@
 import { act, renderHook } from '@testing-library/react-hooks/dom';
 import { waitFor } from '@testing-library/react';
 
-import { MaintenanceWindow } from '../pages/maintenance_windows/types';
 import { AppMockRenderer, createAppMockRenderer } from '../lib/test_utils';
 import { useFinishMaintenanceWindow } from './use_finish_maintenance_window';
 
@@ -35,7 +34,7 @@ jest.mock('../services/maintenance_windows_api/finish', () => ({
 
 const { finishMaintenanceWindow } = jest.requireMock('../services/maintenance_windows_api/finish');
 
-const maintenanceWindow: MaintenanceWindow = {
+const maintenanceWindow = {
   title: 'cancel',
   duration: 1,
   rRule: {

diff --git a/x-pack/plugins/alerting/public/hooks/use_update_maintenance_window.test.tsx b/x-pack/plugins/alerting/public/hooks/use_update_maintenance_window.test.tsx
@@ -7,7 +7,6 @@
 import { act, renderHook } from '@testing-library/react-hooks/dom';
 import { waitFor } from '@testing-library/react';
 
-import { MaintenanceWindow } from '../pages/maintenance_windows/types';
 import { AppMockRenderer, createAppMockRenderer } from '../lib/test_utils';
 import { useUpdateMaintenanceWindow } from './use_update_maintenance_window';
 
@@ -35,7 +34,7 @@ jest.mock('../services/maintenance_windows_api/update', () => ({
 
 const { updateMaintenanceWindow } = jest.requireMock('../services/maintenance_windows_api/update');
 
-const maintenanceWindow: MaintenanceWindow = {
+const updateParams = {
   title: 'updated',
   duration: 1,
   rRule: {
@@ -51,7 +50,7 @@ describe('useUpdateMaintenanceWindow', () => {
     jest.clearAllMocks();
 
     appMockRenderer = createAppMockRenderer();
-    updateMaintenanceWindow.mockResolvedValue(maintenanceWindow);
+    updateMaintenanceWindow.mockResolvedValue(updateParams);
   });
 
   it('should call onSuccess if api succeeds', async () => {
@@ -60,7 +59,7 @@ describe('useUpdateMaintenanceWindow', () => {
     });
 
     await act(async () => {
-      await result.current.mutate({ maintenanceWindowId: '123', maintenanceWindow });
+      await result.current.mutate({ maintenanceWindowId: '123', updateParams });
     });
     await waitFor(() =>
       expect(mockAddSuccess).toBeCalledWith("Updated maintenance window 'updated'")
@@ -75,7 +74,7 @@ describe('useUpdateMaintenanceWindow', () => {
     });
 
     await act(async () => {
-      await result.current.mutate({ maintenanceWindowId: '123', maintenanceWindow });
+      await result.current.mutate({ maintenanceWindowId: '123', updateParams });
     });
 
     await waitFor(() =>

diff --git a/x-pack/plugins/alerting/public/hooks/use_update_maintenance_window.ts b/x-pack/plugins/alerting/public/hooks/use_update_maintenance_window.ts
@@ -9,10 +9,10 @@ import { i18n } from '@kbn/i18n';
 import { useMutation } from '@tanstack/react-query';
 import type { IHttpFetchError } from '@kbn/core-http-browser';
 import type { KibanaServerError } from '@kbn/kibana-utils-plugin/public';
+import type { MaintenanceWindow } from '../../common';
 
 import { useKibana } from '../utils/kibana_react';
-import { MaintenanceWindow } from '../pages/maintenance_windows/types';
-import { updateMaintenanceWindow } from '../services/maintenance_windows_api/update';
+import { updateMaintenanceWindow, UpdateParams } from '../services/maintenance_windows_api/update';
 
 interface UseUpdateMaintenanceWindowProps {
   onError?: (error: IHttpFetchError<KibanaServerError>) => void;
@@ -28,12 +28,12 @@ export function useUpdateMaintenanceWindow(props?: UseUpdateMaintenanceWindowPro
 
   const mutationFn = ({
     maintenanceWindowId,
-    maintenanceWindow,
+    updateParams,
   }: {
     maintenanceWindowId: string;
-    maintenanceWindow: MaintenanceWindow;
+    updateParams: UpdateParams;
   }) => {
-    return updateMaintenanceWindow({ http, maintenanceWindowId, maintenanceWindow });
+    return updateMaintenanceWindow({ http, maintenanceWindowId, updateParams });
   };
 
   return useMutation(mutationFn, {

diff --git a/.../alerting/public/pages/maintenance_windows/components/create_maintenance_windows_form.tsx b/.../alerting/public/pages/maintenance_windows/components/create_maintenance_windows_form.tsx
@@ -162,7 +162,10 @@ export const CreateMaintenanceWindowForm = React.memo<CreateMaintenanceWindowFor
       };
 
       if (isEditMode) {
-        updateMaintenanceWindow({ maintenanceWindowId, maintenanceWindow }, { onSuccess });
+        updateMaintenanceWindow(
+          { maintenanceWindowId, updateParams: maintenanceWindow },
+          { onSuccess }
+        );
       } else {
         createMaintenanceWindow(maintenanceWindow, { onSuccess });
       }

diff --git a/...ns/alerting/public/pages/maintenance_windows/components/maintenance_windows_list.test.tsx b/...ns/alerting/public/pages/maintenance_windows/components/maintenance_windows_list.test.tsx
@@ -10,16 +10,14 @@ import moment from 'moment';
 import { fireEvent, waitFor } from '@testing-library/react';
 import { AppMockRenderer, createAppMockRenderer } from '../../../lib/test_utils';
 import { MaintenanceWindowsList } from './maintenance_windows_list';
-import { MaintenanceWindowFindResponse } from '../types';
-import { MaintenanceWindowStatus } from '../../../../common';
+import { MaintenanceWindowStatus, MaintenanceWindow } from '../../../../common';
 
 describe('MaintenanceWindowsList', () => {
   const date = moment('2023-04-05').toISOString();
   const endDate = moment('2023-04-05').add(1, 'month').toISOString();
-  const items: MaintenanceWindowFindResponse[] = [
+  const items: MaintenanceWindow[] = [
     {
       id: '1',
-      total: 100,
       title: 'Host maintenance',
       enabled: true,
       duration: 1,
@@ -36,7 +34,6 @@ describe('MaintenanceWindowsList', () => {
     },
     {
       id: '2',
-      total: 0,
       title: 'Server outage west coast',
       enabled: true,
       duration: 1,
@@ -53,7 +50,6 @@ describe('MaintenanceWindowsList', () => {
     },
     {
       id: '4',
-      total: 1000,
       title: 'Monthly maintenance window',
       enabled: true,
       duration: 1,
@@ -70,7 +66,6 @@ describe('MaintenanceWindowsList', () => {
     },
     {
       id: '5',
-      total: 200,
       title: 'Monthly maintenance window',
       enabled: true,
       duration: 1,

diff --git a/...plugins/alerting/public/pages/maintenance_windows/components/maintenance_windows_list.tsx b/...plugins/alerting/public/pages/maintenance_windows/components/maintenance_windows_list.tsx
@@ -18,12 +18,16 @@ import {
   EuiButton,
 } from '@elastic/eui';
 import { css } from '@emotion/react';
-import { MaintenanceWindowFindResponse, SortDirection } from '../types';
+import { SortDirection } from '../types';
 import * as i18n from '../translations';
 import { useEditMaintenanceWindowsNavigation } from '../../../hooks/use_navigation';
 import { STATUS_DISPLAY, STATUS_SORT } from '../constants';
 import { UpcomingEventsPopover } from './upcoming_events_popover';
-import { MaintenanceWindowStatus, MAINTENANCE_WINDOW_DATE_FORMAT } from '../../../../common';
+import {
+  MaintenanceWindowStatus,
+  MAINTENANCE_WINDOW_DATE_FORMAT,
+  MaintenanceWindow,
+} from '../../../../common';
 import { StatusFilter } from './status_filter';
 import { TableActionsPopover } from './table_actions_popover';
 import { useFinishMaintenanceWindow } from '../../../hooks/use_finish_maintenance_window';
@@ -32,12 +36,12 @@ import { useFinishAndArchiveMaintenanceWindow } from '../../../hooks/use_finish_
 
 interface MaintenanceWindowsListProps {
   loading: boolean;
-  items: MaintenanceWindowFindResponse[];
+  items: MaintenanceWindow[];
   readOnly: boolean;
   refreshData: () => void;
 }
 
-const COLUMNS: Array<EuiBasicTableColumn<MaintenanceWindowFindResponse>> = [
+const COLUMNS: Array<EuiBasicTableColumn<MaintenanceWindow>> = [
   {
     field: 'title',
     name: i18n.NAME,
@@ -58,7 +62,7 @@ const COLUMNS: Array<EuiBasicTableColumn<MaintenanceWindowFindResponse>> = [
     field: 'eventStartTime',
     name: i18n.TABLE_START_TIME,
     dataType: 'date',
-    render: (startDate: string, item: MaintenanceWindowFindResponse) => {
+    render: (startDate: string, item: MaintenanceWindow) => {
       return (
         <EuiFlexGroup responsive={false} alignItems="center">
           <EuiFlexItem grow={false}>
@@ -89,7 +93,7 @@ const sorting = {
   },
 };
 
-const rowProps = (item: MaintenanceWindowFindResponse) => ({
+const rowProps = (item: MaintenanceWindow) => ({
   className: item.status,
   'data-test-subj': 'list-item',
 });
@@ -148,7 +152,7 @@ export const MaintenanceWindowsList = React.memo<MaintenanceWindowsListProps>(
       `;
     }, [euiTheme.colors.highlight]);
 
-    const actions: Array<EuiBasicTableColumn<MaintenanceWindowFindResponse>> = useMemo(
+    const actions: Array<EuiBasicTableColumn<MaintenanceWindow>> = useMemo(
       () => [
         {
           name: '',

diff --git a/...ins/alerting/public/pages/maintenance_windows/components/upcoming_events_popover.test.tsx b/...ins/alerting/public/pages/maintenance_windows/components/upcoming_events_popover.test.tsx
@@ -49,7 +49,6 @@ describe('rule_actions_popover', () => {
           updatedAt: '2023-04-14T14:58:58.997Z',
           eventStartTime: '2023-04-21T14:58:40.243Z',
           eventEndTime: '2023-04-21T14:58:40.243Z',
-          total: 1000,
         }}
       />
     );

diff --git a/.../plugins/alerting/public/pages/maintenance_windows/components/upcoming_events_popover.tsx b/.../plugins/alerting/public/pages/maintenance_windows/components/upcoming_events_popover.tsx
@@ -21,14 +21,13 @@ import {
   formatDate,
 } from '@elastic/eui';
 import * as i18n from '../translations';
-import { MAINTENANCE_WINDOW_DATE_FORMAT } from '../../../../common';
+import { MAINTENANCE_WINDOW_DATE_FORMAT, MaintenanceWindow } from '../../../../common';
 import { recurringSummary } from '../helpers/recurring_summary';
 import { getPresets } from '../helpers/get_presets';
-import { MaintenanceWindowFindResponse } from '../types';
 import { convertFromMaintenanceWindowToForm } from '../helpers/convert_from_maintenance_window_to_form';
 
 interface UpcomingEventsPopoverProps {
-  maintenanceWindowFindResponse: MaintenanceWindowFindResponse;
+  maintenanceWindowFindResponse: MaintenanceWindow;
 }
 
 export const UpcomingEventsPopover: React.FC<UpcomingEventsPopoverProps> = React.memo(