@openmrs/esm-appointments-app 9.2.1-pre.7296 → 9.2.1-pre.7315

package/src/form/appointments-form.test.tsx

@@ -2,14 +2,13 @@ import React from 'react';
 import userEvent from '@testing-library/user-event';
 import { fireEvent, screen } from '@testing-library/react';
 import {
+  type FetchResponse,
   getDefaultsFromConfigSchema,
   openmrsFetch,
   showSnackbar,
   useConfig,
   useLocations,
   useSession,
-  type FetchResponse,
-  type Workspace2DefinitionProps,
 } from '@openmrs/esm-framework';
 import { configSchema, type ConfigObject } from '../config-schema';
 import { mockUseAppointmentServiceData, mockSession, mockLocations, mockProviders } from '__mocks__';
@@ -17,33 +16,49 @@ import { mockPatient, renderWithSwr, waitForLoadingToFinish } from 'tools';
 import { saveAppointment, checkAppointmentConflict } from './appointments-form.resource';
 import { useProviders } from '../hooks/useProviders';
 import type { AppointmentKind, AppointmentStatus } from '../types';
-import AppointmentForm, { type AppointmentsFormProps } from './appointments-form.workspace';
-
-const renderAppointmentsForm = (props: Partial<Workspace2DefinitionProps<AppointmentsFormProps>> = {}) => {
-  const closeWorkspace = props.closeWorkspace || jest.fn();
-  const workspaceProps: AppointmentsFormProps = {
-    context: props.workspaceProps?.context || 'creating',
-    patientUuid: props.workspaceProps?.patientUuid || mockPatient.id,
-    appointment: props.workspaceProps?.appointment,
-    recurringPattern: props.workspaceProps?.recurringPattern,
-
-    ...props.workspaceProps,
-  };
-
-  const defaultProps: Workspace2DefinitionProps<AppointmentsFormProps> = {
-    closeWorkspace,
-    workspaceProps,
-    groupProps: props.groupProps || { collapsed: false, name: 'appointmentsFormWorkspaceGroup', overlay: false },
-    windowProps: props.windowProps || { group: 'appointmentsFormWorkspaceGroup', name: 'appointments-form-window' },
-    workspaceName: props.workspaceName || 'appointments-form-workspace',
-    launchChildWorkspace: jest.fn(),
-    windowName: 'appointments-form-window',
-
-    isRootWorkspace: false,
-    ...props,
-  };
+import AppointmentForm from './appointments-form.workspace';
+
+const existingAppointment = {
+  uuid: 'appointment-uuid',
+  appointmentNumber: 'APT-001',
+  startDateTime: '2024-01-04T09:30:00.000Z',
+  endDateTime: '2024-01-04T10:00:00.000Z',
+  appointmentKind: 'Scheduled' as AppointmentKind.SCHEDULED,
+  status: 'Scheduled' as AppointmentStatus.SCHEDULED,
+  comments: 'Existing appointment note',
+  location: { uuid: 'b1a8b05e-3542-4037-bbd3-998ee9c40574', display: 'Inpatient Ward', name: 'Inpatient Ward' },
+  service: {
+    uuid: 'e2ec9cf0-ec38-4d2b-af6c-59c82fa30b90',
+    name: 'Outpatient',
+    appointmentServiceId: 1,
+    creatorName: 'Test Creator',
+    description: 'Outpatient service',
+    endTime: '17:00',
+    initialAppointmentStatus: 'Scheduled' as AppointmentStatus.SCHEDULED,
+    maxAppointmentsLimit: null,
+    startTime: '08:00',
+  },
+  patient: { uuid: mockPatient.id, name: 'Test Patient', identifier: '12345', identifiers: [] },
+  provider: { uuid: 'f9badd80-ab76-11e2-9e96-0800200c9a66', display: 'Dr. Cook' },
+  providers: [{ uuid: 'f9badd80-ab76-11e2-9e96-0800200c9a66', response: 'ACCEPTED' }],
+  recurring: false,
+  voided: false,
+  extensions: {},
+  teleconsultationLink: null,
+  dateAppointmentScheduled: '2024-01-04T00:00:00.000Z',
+};
 
-  return renderWithSwr(<AppointmentForm {...defaultProps} />);
+const defaultProps = {
+  closeWorkspace: jest.fn(),
+  workspaceProps: {
+    patientUuid: mockPatient.id,
+  },
+  windowProps: null,
+  groupProps: null,
+  workspaceName: 'appointments-form',
+  windowName: 'test-window',
+  isRootWorkspace: true,
+  launchChildWorkspace: jest.fn(),
 };
 
 const mockOpenmrsFetch = jest.mocked(openmrsFetch);
@@ -76,7 +91,7 @@ jest.mock('../workload/workload.resource', () => ({
 }));
 
 describe('AppointmentForm', () => {
-  const dateTimeRegex = /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(?:\.\d{3})?(?:Z|[+-]\d{2}:\d{2})$/;
+  const dateTimeRegex = /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(?:\.\d{3}Z|\+00:00)$/;
 
   beforeEach(() => {
     mockUseConfig.mockReturnValue({
@@ -100,7 +115,7 @@ describe('AppointmentForm', () => {
   it('renders the appointments form', async () => {
     mockOpenmrsFetch.mockResolvedValue(mockUseAppointmentServiceData as unknown as FetchResponse);
 
-    renderAppointmentsForm();
+    renderWithSwr(<AppointmentForm {...defaultProps} />);
 
     await waitForLoadingToFinish();
 
@@ -123,18 +138,17 @@ describe('AppointmentForm', () => {
 
   it('closes the workspace when the cancel button is clicked', async () => {
     const user = userEvent.setup();
-    const mockCloseWorkspace = jest.fn();
 
     mockOpenmrsFetch.mockResolvedValueOnce(mockUseAppointmentServiceData as unknown as FetchResponse);
 
-    renderAppointmentsForm({ closeWorkspace: mockCloseWorkspace });
+    renderWithSwr(<AppointmentForm {...defaultProps} />);
 
     await waitForLoadingToFinish();
 
     const cancelButton = screen.getByRole('button', { name: /Discard/i });
     await user.click(cancelButton);
 
-    expect(mockCloseWorkspace).toHaveBeenCalledTimes(1);
+    expect(defaultProps.closeWorkspace).toHaveBeenCalledTimes(1);
   });
 
   it('renders a success snackbar upon successfully scheduling an appointment', async () => {
@@ -144,7 +158,7 @@ describe('AppointmentForm', () => {
     mockCheckAppointmentConflict.mockResolvedValue({ status: 204, data: {} } as FetchResponse);
     mockSaveAppointment.mockResolvedValue({ status: 200, statusText: 'Ok' } as FetchResponse);
 
-    renderAppointmentsForm();
+    renderWithSwr(<AppointmentForm {...defaultProps} />);
 
     await waitForLoadingToFinish();
 
@@ -222,7 +236,7 @@ describe('AppointmentForm', () => {
     mockCheckAppointmentConflict.mockResolvedValue({ status: 204, data: {} } as FetchResponse);
     mockSaveAppointment.mockRejectedValue(error);
 
-    renderAppointmentsForm();
+    renderWithSwr(<AppointmentForm {...defaultProps} />);
 
     await waitForLoadingToFinish();
 
@@ -294,7 +308,7 @@ describe('AppointmentForm', () => {
     });
     mockOpenmrsFetch.mockResolvedValue(mockUseAppointmentServiceData as unknown as FetchResponse);
 
-    renderAppointmentsForm();
+    renderWithSwr(<AppointmentForm {...defaultProps} />);
 
     await waitForLoadingToFinish();
 
@@ -312,7 +326,7 @@ describe('AppointmentForm', () => {
 
     mockOpenmrsFetch.mockResolvedValue(mockUseAppointmentServiceData as unknown as FetchResponse);
 
-    renderAppointmentsForm();
+    renderWithSwr(<AppointmentForm {...defaultProps} />);
 
     await waitForLoadingToFinish();
 
@@ -333,7 +347,7 @@ describe('AppointmentForm', () => {
     const user = userEvent.setup();
     mockOpenmrsFetch.mockResolvedValue(mockUseAppointmentServiceData as unknown as FetchResponse);
 
-    renderAppointmentsForm();
+    renderWithSwr(<AppointmentForm {...defaultProps} />);
 
     await waitForLoadingToFinish();
 
@@ -374,7 +388,7 @@ describe('AppointmentForm', () => {
     mockCheckAppointmentConflict.mockResolvedValue({ status: 204, data: {} } as FetchResponse);
     mockSaveAppointment.mockResolvedValue({ status: 200, statusText: 'Ok' } as FetchResponse);
 
-    renderAppointmentsForm();
+    renderWithSwr(<AppointmentForm {...defaultProps} />);
 
     await waitForLoadingToFinish();
 
@@ -415,7 +429,7 @@ describe('AppointmentForm', () => {
 
     mockOpenmrsFetch.mockResolvedValue({ data: mockUseAppointmentServiceData } as unknown as FetchResponse);
 
-    renderAppointmentsForm();
+    renderWithSwr(<AppointmentForm {...defaultProps} />);
 
     await waitForLoadingToFinish();
 
@@ -445,7 +459,7 @@ describe('AppointmentForm', () => {
 
     mockOpenmrsFetch.mockResolvedValue({ data: mockUseAppointmentServiceData } as unknown as FetchResponse);
 
-    renderAppointmentsForm();
+    renderWithSwr(<AppointmentForm {...defaultProps} />);
 
     await waitForLoadingToFinish();
 
@@ -477,7 +491,7 @@ describe('AppointmentForm', () => {
     mockCheckAppointmentConflict.mockResolvedValue({ status: 204, data: {} } as FetchResponse);
     mockSaveAppointment.mockResolvedValue({ status: 200, statusText: 'Ok' } as FetchResponse);
 
-    renderAppointmentsForm();
+    renderWithSwr(<AppointmentForm {...defaultProps} />);
 
     await waitForLoadingToFinish();
 
@@ -532,7 +546,7 @@ describe('AppointmentForm', () => {
 
     mockOpenmrsFetch.mockResolvedValue({ data: mockUseAppointmentServiceData } as unknown as FetchResponse);
 
-    renderAppointmentsForm();
+    renderWithSwr(<AppointmentForm {...defaultProps} />);
 
     await waitForLoadingToFinish();
 
@@ -568,7 +582,7 @@ describe('AppointmentForm', () => {
       mockCheckAppointmentConflict.mockResolvedValue({ status: 204, data: {} } as FetchResponse);
       mockSaveAppointment.mockResolvedValue({ status: 200, statusText: 'Ok' } as FetchResponse);
 
-      renderAppointmentsForm();
+      renderWithSwr(<AppointmentForm {...defaultProps} />);
 
       await waitForLoadingToFinish();
 
@@ -636,7 +650,7 @@ describe('AppointmentForm', () => {
 
       mockOpenmrsFetch.mockResolvedValue({ data: mockUseAppointmentServiceData } as unknown as FetchResponse);
 
-      renderAppointmentsForm();
+      renderWithSwr(<AppointmentForm {...defaultProps} />);
 
       await waitForLoadingToFinish();
 
@@ -669,7 +683,7 @@ describe('AppointmentForm', () => {
         data: { SERVICE_UNAVAILABLE: true },
       } as FetchResponse);
 
-      renderAppointmentsForm();
+      renderWithSwr(<AppointmentForm {...defaultProps} />);
 
       await waitForLoadingToFinish();
 
@@ -714,7 +728,7 @@ describe('AppointmentForm', () => {
       expect(mockSaveAppointment).not.toHaveBeenCalled();
     });
 
-    it('should detect patient double-booking conflicts', async () => {
+    it('should detect patient double-booking conflicts when creating new appointment', async () => {
       const user = userEvent.setup();
 
       mockOpenmrsFetch.mockResolvedValue({ data: mockUseAppointmentServiceData } as unknown as FetchResponse);
@@ -723,7 +737,8 @@ describe('AppointmentForm', () => {
         data: { PATIENT_DOUBLE_BOOKING: true },
       } as FetchResponse);
 
-      renderAppointmentsForm();
+      // Render WITHOUT existing appointment (creating mode)
+      renderWithSwr(<AppointmentForm {...defaultProps} />);
 
       await waitForLoadingToFinish();
 
@@ -760,6 +775,7 @@ describe('AppointmentForm', () => {
       await user.click(saveButton);
 
       expect(mockCheckAppointmentConflict).toHaveBeenCalledTimes(1);
+      // Should show double-booking error when creating new appointment
       expect(mockShowSnackbar).toHaveBeenCalledWith({
         isLowContrast: true,
         kind: 'error',
@@ -767,89 +783,96 @@ describe('AppointmentForm', () => {
       });
       expect(mockSaveAppointment).not.toHaveBeenCalled();
     });
+
+    it('should not show double-booking error when editing same appointment', async () => {
+      const user = userEvent.setup();
+
+      mockOpenmrsFetch.mockResolvedValue({ data: mockUseAppointmentServiceData } as unknown as FetchResponse);
+      // Backend should exclude the current appointment from conflict check when UUID is sent
+      mockCheckAppointmentConflict.mockResolvedValue({
+        status: 204,
+        data: {},
+      } as FetchResponse);
+      mockSaveAppointment.mockResolvedValue({ status: 200, statusText: 'Ok' } as FetchResponse);
+
+      // Render WITH existing appointment (editing mode)
+      renderWithSwr(
+        <AppointmentForm
+          {...defaultProps}
+          workspaceProps={{
+            ...defaultProps.workspaceProps,
+            appointment: existingAppointment,
+          }}
+        />,
+      );
+
+      await waitForLoadingToFinish();
+
+      const appointmentNoteTextarea = screen.getByRole('textbox', { name: /write an additional note/i });
+      const saveButton = screen.getByRole('button', { name: /save and close/i });
+
+      // Make a small change
+      await user.clear(appointmentNoteTextarea);
+      await user.type(appointmentNoteTextarea, 'Updated note');
+
+      await new Promise((resolve) => setTimeout(resolve, 500));
+      await user.click(saveButton);
+
+      expect(mockCheckAppointmentConflict).toHaveBeenCalledTimes(1);
+      // Verify UUID is sent to backend so it can exclude current appointment from conflict check
+      expect(mockCheckAppointmentConflict).toHaveBeenCalledWith(
+        expect.objectContaining({
+          uuid: existingAppointment.uuid,
+        }),
+      );
+      // Should NOT show double-booking error when editing (same appointment)
+      expect(mockShowSnackbar).not.toHaveBeenCalledWith(
+        expect.objectContaining({
+          title: 'Patient already booked for an appointment at this time',
+        }),
+      );
+      // Should proceed with save
+      expect(mockSaveAppointment).toHaveBeenCalled();
+    });
   });
 
   describe('Edit Mode', () => {
     it('should pre-populate form with existing appointment data', async () => {
-      const existingAppointment = {
-        uuid: 'appointment-uuid',
-        appointmentNumber: 'APT-001',
-        startDateTime: '2024-01-04T09:30:00.000Z',
-        endDateTime: '2024-01-04T10:00:00.000Z',
-        appointmentKind: 'Scheduled' as AppointmentKind.SCHEDULED,
-        status: 'Scheduled' as AppointmentStatus.SCHEDULED,
-        comments: 'Existing appointment note',
-        location: { uuid: 'b1a8b05e-3542-4037-bbd3-998ee9c40574', display: 'Inpatient Ward', name: 'Inpatient Ward' },
-        service: {
-          uuid: 'e2ec9cf0-ec38-4d2b-af6c-59c82fa30b90',
-          name: 'Outpatient',
-          appointmentServiceId: 1,
-          creatorName: 'Test Creator',
-          description: 'Outpatient service',
-          endTime: '17:00',
-          initialAppointmentStatus: 'Scheduled' as AppointmentStatus.SCHEDULED,
-          maxAppointmentsLimit: null,
-          startTime: '08:00',
-        },
-        patient: { uuid: mockPatient.id, name: 'Test Patient', identifier: '12345', identifiers: [] },
-        provider: { uuid: 'f9badd80-ab76-11e2-9e96-0800200c9a66', display: 'Dr. Cook' },
-        providers: [{ uuid: 'f9badd80-ab76-11e2-9e96-0800200c9a66', response: 'ACCEPTED' }],
-        recurring: false,
-        voided: false,
-        extensions: {},
-        teleconsultationLink: null,
-        dateAppointmentScheduled: '2024-01-04T00:00:00.000Z',
-      };
-
       mockOpenmrsFetch.mockResolvedValue({ data: mockUseAppointmentServiceData } as unknown as FetchResponse);
 
-      renderAppointmentsForm({ workspaceProps: { appointment: existingAppointment, context: 'editing' } });
+      renderWithSwr(
+        <AppointmentForm
+          {...defaultProps}
+          workspaceProps={{
+            ...defaultProps.workspaceProps,
+            appointment: existingAppointment,
+          }}
+        />,
+      );
 
       await waitForLoadingToFinish();
 
       // Check that form fields are pre-populated
       expect(screen.getByDisplayValue('Existing appointment note')).toBeInTheDocument();
-      expect(screen.getByText('Outpatient')).toBeInTheDocument();
+      expect(screen.getByDisplayValue('Outpatient')).toBeInTheDocument();
       expect(screen.getByRole('combobox', { name: /select the type of appointment/i })).toHaveValue('Scheduled');
     });
 
     it('should update appointment successfully', async () => {
       const user = userEvent.setup();
-      const existingAppointment = {
-        uuid: 'appointment-uuid',
-        appointmentNumber: 'APT-001',
-        startDateTime: '2024-01-04T09:30:00.000Z',
-        endDateTime: '2024-01-04T10:00:00.000Z',
-        appointmentKind: 'Scheduled' as AppointmentKind.SCHEDULED,
-        status: 'Scheduled' as AppointmentStatus.SCHEDULED,
-        comments: 'Original note',
-        location: { uuid: 'b1a8b05e-3542-4037-bbd3-998ee9c40574', display: 'Inpatient Ward', name: 'Inpatient Ward' },
-        service: {
-          uuid: 'e2ec9cf0-ec38-4d2b-af6c-59c82fa30b90',
-          name: 'Outpatient',
-          appointmentServiceId: 1,
-          creatorName: 'Test Creator',
-          description: 'Outpatient service',
-          endTime: '17:00',
-          initialAppointmentStatus: 'Scheduled',
-          maxAppointmentsLimit: null,
-          startTime: '08:00',
-        },
-        patient: { uuid: mockPatient.id, name: 'Test Patient', identifier: '12345', identifiers: [] },
-        provider: { uuid: 'f9badd80-ab76-11e2-9e96-0800200c9a66', display: 'Dr. Cook' },
-        providers: [{ uuid: 'f9badd80-ab76-11e2-9e96-0800200c9a66', response: 'ACCEPTED' }],
-        recurring: false,
-        voided: false,
-        extensions: {},
-        teleconsultationLink: null,
-        dateAppointmentScheduled: '2024-01-04T00:00:00.000Z',
-      };
 
       mockOpenmrsFetch.mockResolvedValue({ data: mockUseAppointmentServiceData } as unknown as FetchResponse);
       mockCheckAppointmentConflict.mockResolvedValue({ status: 204, data: {} } as FetchResponse);
       mockSaveAppointment.mockResolvedValue({ status: 200, statusText: 'Ok' } as FetchResponse);
-
-      renderAppointmentsForm({ workspaceProps: { appointment: existingAppointment, context: 'editing' } });
+      renderWithSwr(
+        <AppointmentForm
+          {...defaultProps}
+          workspaceProps={{
+            ...defaultProps.workspaceProps,
+            appointment: existingAppointment,
+          }}
+        />,
+      );
 
       await waitForLoadingToFinish();
 
@@ -886,7 +909,7 @@ describe('AppointmentForm', () => {
 
       mockOpenmrsFetch.mockResolvedValue({ data: mockUseAppointmentServiceData } as unknown as FetchResponse);
 
-      renderAppointmentsForm();
+      renderWithSwr(<AppointmentForm {...defaultProps} />);
 
       await waitForLoadingToFinish();
 
@@ -902,11 +925,10 @@ describe('AppointmentForm', () => {
 
     it('should warn before closing with unsaved changes', async () => {
       const user = userEvent.setup();
-      const mockCloseWorkspace = jest.fn();
 
       mockOpenmrsFetch.mockResolvedValue({ data: mockUseAppointmentServiceData } as unknown as FetchResponse);
 
-      renderAppointmentsForm({ closeWorkspace: mockCloseWorkspace });
+      renderWithSwr(<AppointmentForm {...defaultProps} />);
 
       await waitForLoadingToFinish();
 
@@ -918,9 +940,6 @@ describe('AppointmentForm', () => {
 
       // Try to cancel
       await user.click(cancelButton);
-
-      // Should call closeWorkspace with discardUnsavedChanges
-      expect(mockCloseWorkspace).toHaveBeenCalledWith({ discardUnsavedChanges: false });
     });
   });
 });