@ampath/esm-reports-app 1.0.0-next.7 → 1.0.0-next.71

package/src/registers/moh-240/moh-240.component.test.tsx

@@ -0,0 +1,166 @@
+import React from 'react';
+import { render, screen, waitFor, within } from '@testing-library/react';
+import userEvent from '@testing-library/user-event';
+import { MemoryRouter } from 'react-router-dom';
+
+import Moh240LabRegister from './moh-240.component';
+import { MOH_240_HEADERS, MOH_240_SUB_HEADERS } from '../../reports/moh-240/moh-240.columns';
+import { downloadCsv } from '../../common/report-register';
+import { getMoh706PatientList } from '../../resources/moh-706.resource';
+
+jest.mock('../../common/report-register', () => ({
+  ...jest.requireActual('../../common/report-register'),
+  downloadCsv: jest.fn(),
+}));
+
+jest.mock('../../resources/moh-706.resource', () => ({
+  getMoh706PatientList: jest.fn(),
+}));
+
+jest.mock('@openmrs/esm-framework', () => ({
+  useSession: () => ({ sessionLocation: { uuid: 'loc-uuid', display: 'Test Facility' } }),
+  openmrsFetch: jest.fn().mockResolvedValue({ ok: false }),
+  showSnackbar: jest.fn(),
+}));
+
+/* The filter bar is Carbon-heavy and its period picking is not what this page
+   is about, so it is stood in by a button that generates a fixed period. The
+   restore-from-URL hook stays real, as it is part of the page's behaviour. */
+jest.mock('../../common/report-filters', () => {
+  const actual = jest.requireActual('../../common/report-filters');
+  return {
+    ...actual,
+    ReportFiltersComponent: ({
+      onGenerate,
+    }: {
+      onGenerate: (period: { startDate: string; endDate: string; label?: string }) => void;
+    }) => (
+      <button onClick={() => onGenerate({ startDate: '2026-10-01', endDate: '2026-10-02', label: 'period' })}>
+        generate
+      </button>
+    ),
+  };
+});
+
+/** A row carrying every register field, so a missing column shows as a blank cell */
+const aRow = (overrides: Record<string, unknown> = {}) => {
+  const row: Record<string, any> = {};
+  MOH_240_HEADERS.forEach(({ key }, index) => {
+    row[key] = `${key}-${index}`;
+  });
+  return { ...row, ...overrides };
+};
+
+const renderRegister = () =>
+  render(
+    <MemoryRouter>
+      <Moh240LabRegister />
+    </MemoryRouter>,
+  );
+
+/** The register table itself: the page also holds the masthead and page
+    summary tables, so the queries are scoped to it rather than to the page */
+const registerTable = (container: HTMLElement) => {
+  const table = container.querySelector('table.table');
+  expect(table).not.toBeNull();
+  return table as HTMLTableElement;
+};
+
+const page = (results: Array<Record<string, unknown>>, total = results.length) => ({
+  results,
+  total,
+  isTotalExact: true,
+});
+
+describe('Moh240LabRegister', () => {
+  beforeEach(() => {
+    jest.mocked(downloadCsv).mockClear();
+    jest.mocked(getMoh706PatientList).mockReset();
+  });
+
+  it('asks for the register to be generated before showing anything', () => {
+    renderRegister();
+
+    expect(screen.getByText('No report generated yet')).toBeInTheDocument();
+    expect(getMoh706PatientList).not.toHaveBeenCalled();
+  });
+
+  it('renders the printed register under its own columns (A-AA) once generated', async () => {
+    jest
+      .mocked(getMoh706PatientList)
+      .mockResolvedValue(page([aRow({ date: '01/10/2026', full_name: 'Jane Akinyi' }), aRow()]));
+
+    const { container } = renderRegister();
+    await userEvent.click(screen.getByRole('button', { name: 'generate' }));
+
+    await waitFor(() => expect(screen.getByText('2 records')).toBeInTheDocument());
+
+    /* the whole register asked for, not a drill-down's indicator subset */
+    expect(getMoh706PatientList).toHaveBeenCalledWith(
+      expect.objectContaining({ locationUuids: 'loc-uuid', startDate: '2026-10-01', endDate: '2026-10-02' }),
+    );
+
+    const table = within(registerTable(container));
+    const headerRows = within(table.getAllByRole('rowgroup')[0]).getAllByRole('row');
+    expect(
+      headerRows.map((row) =>
+        within(row)
+          .getAllByRole('columnheader')
+          .map((cell) => cell.textContent),
+      ),
+    ).toEqual([MOH_240_HEADERS.map(({ header }) => header), [...MOH_240_SUB_HEADERS]]);
+
+    const firstRow = within(table.getAllByRole('rowgroup')[1]).getAllByRole('row')[0];
+    const cells = within(firstRow)
+      .getAllByRole('cell')
+      .map((cell) => cell.textContent);
+    expect(cells[0]).toBe('01/10/2026');
+    expect(cells[4]).toBe('Jane Akinyi');
+  });
+
+  it('exports every page as the form\u2019s columns with the letter row beneath', async () => {
+    jest
+      .mocked(getMoh706PatientList)
+      .mockImplementation(({ startIndex }: any) =>
+        Promise.resolve(page([aRow({ lab_no: '001234' })], startIndex === 0 ? 2 : 2)),
+      );
+
+    renderRegister();
+    await userEvent.click(screen.getByRole('button', { name: 'generate' }));
+    await waitFor(() => expect(screen.getByRole('button', { name: /Export CSV/ })).toBeInTheDocument());
+
+    await userEvent.click(screen.getByRole('button', { name: /Export CSV/ }));
+
+    await waitFor(() => expect(jest.mocked(downloadCsv)).toHaveBeenCalledTimes(1));
+    const [csv, filename] = jest.mocked(downloadCsv).mock.calls[0];
+    const lines = (csv as string).split('\r\n');
+    expect(lines[0]).toBe(MOH_240_HEADERS.map(({ header }) => header).join(','));
+    expect(lines[1]).toBe(MOH_240_SUB_HEADERS.join(','));
+    /* identifier columns survive Excel as text */
+    expect(lines[2]).toContain('="001234"');
+    expect(filename).toBe('laboratory-lab-register-moh-240-2026-10-01-2026-10-02.csv');
+  });
+
+  it('pagers past the first page when the period holds more rows than one page', async () => {
+    jest.mocked(getMoh706PatientList).mockResolvedValue(
+      page(
+        Array.from({ length: 50 }, () => aRow()),
+        120,
+      ),
+    );
+
+    renderRegister();
+    await userEvent.click(screen.getByRole('button', { name: 'generate' }));
+
+    await waitFor(() => expect(screen.getByText(/120 items/)).toBeInTheDocument());
+  });
+
+  it('falls back to the placeholder when the register cannot be fetched', async () => {
+    jest.mocked(getMoh706PatientList).mockRejectedValue(new Error('etl down'));
+
+    renderRegister();
+    await userEvent.click(screen.getByRole('button', { name: 'generate' }));
+
+    await waitFor(() => expect(screen.getByText('No report generated yet')).toBeInTheDocument());
+  });
+});

package/src/registers/moh-240/moh-240.component.tsx

@@ -0,0 +1,164 @@
+import React, { useState } from 'react';
+import { Button, Layer, Pagination } from '@carbon/react';
+import { Document, Download } from '@carbon/react/icons';
+import { useSession } from '@openmrs/esm-framework';
+
+import { ReportFiltersComponent, type ReportPeriod, useRestorePeriod } from '../../common/report-filters';
+import { showReportError } from '../../common/report-error';
+import { ReportPlaceholder, useGeneratedLocation } from '../../common/report-placeholder';
+import { ReportSkeleton } from '../../common/report-skeleton';
+import { columnsToCsv, downloadCsv, usePatientList } from '../../common/report-register';
+import { getMoh706PatientList } from '../../resources/moh-706.resource';
+import { MOH_240_SUB_HEADERS, moh240Columns } from '../../reports/moh-240/moh-240.columns';
+import MOH240Header from '../../reports/moh-240/moh-240-header.component';
+import sheetStyles from '../../reports/moh-240/moh-240.scss';
+import Moh240PageSummary from '../../reports/moh-240/sub-reports/page-summary.component';
+import Moh240Register from '../../reports/moh-240/sub-reports/moh-240-register.component';
+import styles from './moh-240-register.scss';
+
+/** The register's own columns (A-AA). No drill-down indicator runs here, so the
+    results column reads the row's translated `results` field. */
+const columns = moh240Columns('');
+
+/**
+ * Laboratory (LAB) Register MOH 240, opened from the landing page's Registers
+ * tab. It shares the reports' filter bar and serves the same printed register
+ * -- masthead, columns A-AA and the page summary -- that the MOH 505 and
+ * MOH 706 drill-downs open, but over the laboratory's whole workload for the
+ * period rather than one indicator's rows.
+ */
+const Moh240LabRegister: React.FC = () => {
+  const [period, setPeriod] = useState<{ startDate: string; endDate: string }>({ startDate: '', endDate: '' });
+  const [isExporting, setIsExporting] = useState(false);
+  /* A fetch that failed leaves the page on the placeholder rather than showing
+     an empty register, so the two are told apart here. */
+  const [hasError, setHasError] = useState(false);
+
+  const session = useSession();
+  const locationUuids = session?.sessionLocation?.uuid ?? '';
+  /* Only a register for the current location counts */
+  const { isForCurrentLocation, hasLocationChanged, markGenerated } = useGeneratedLocation('moh240RegisterLocation');
+  const isGenerated = Boolean(period.startDate && period.endDate) && isForCurrentLocation && !hasError;
+
+  const { rows, total, isTotalExact, isLoading, page, pageSize, onPageChange, fetchAll } = usePatientList(
+    ({ startIndex, limit }) => {
+      /* Nothing is fetched before a period is chosen: the mount-time load and
+         an unset session land here rather than querying the endpoint's defaults. */
+      if (!period.startDate || !period.endDate) {
+        return Promise.resolve({ results: [], total: 0, isTotalExact: true });
+      }
+
+      return getMoh706PatientList({
+        locationUuids,
+        startDate: period.startDate,
+        endDate: period.endDate,
+        startIndex,
+        limit,
+      }).then(
+        (result) => {
+          setHasError(false);
+          return result;
+        },
+        (error) => {
+          setHasError(true);
+          throw error;
+        },
+      );
+    },
+    [locationUuids, period.startDate, period.endDate],
+  );
+
+  const generate = ({ startDate, endDate }: ReportPeriod) => {
+    setHasError(false);
+    setPeriod({ startDate, endDate });
+    markGenerated(locationUuids);
+  };
+
+  useRestorePeriod(generate);
+
+  /* Exports every page, not the one on screen: with pagination the DOM only
+     holds one page, and the file must match the printed form column for column. */
+  const exportCsv = async () => {
+    setIsExporting(true);
+
+    try {
+      const all = await fetchAll();
+      const slug = ['laboratory-lab-register-moh-240', period.startDate, period.endDate]
+        .filter(Boolean)
+        .join('-')
+        .toLowerCase();
+      downloadCsv(columnsToCsv(all, columns, { subHeaderRow: MOH_240_SUB_HEADERS }), `${slug}.csv`);
+    } catch (error) {
+      showReportError('the register export', error);
+    } finally {
+      setIsExporting(false);
+    }
+  };
+
+  return (
+    <>
+      <ReportFiltersComponent
+        reportName="Laboratory (LAB) Register MOH 240"
+        mode="both"
+        onGenerate={generate}
+        isLoading={isLoading}
+        isReportGenerated={isGenerated}
+        generatedPeriod={period}
+        defaultTab="custom"
+        backLink={{ label: 'All registers', to: '/?tab=registers' }}
+      />
+      {isGenerated && isLoading && rows.length === 0 && <ReportSkeleton />}
+      {isGenerated && !isLoading && (
+        <>
+          <div className={styles.toolbar}>
+            <span className={styles.total}>
+              {total.toLocaleString()}
+              {isTotalExact ? '' : '+'} records
+            </span>
+            <Button kind="tertiary" size="sm" renderIcon={Download} onClick={exportCsv} disabled={isExporting}>
+              {isExporting ? 'Preparing…' : 'Export CSV'}
+            </Button>
+          </div>
+          {rows.length > 0 ? (
+            <>
+              <div className={sheetStyles.sheet}>
+                <MOH240Header
+                  facility={session?.sessionLocation?.display ?? ''}
+                  startDate={period.startDate}
+                  endDate={period.endDate}
+                />
+                <Moh240Register patientList={rows} />
+                <Moh240PageSummary rows={rows} />
+              </div>
+              {typeof total === 'number' && total > pageSize && (
+                <Pagination
+                  className={styles.pager}
+                  page={page}
+                  pageSize={pageSize}
+                  pageSizes={[25, 50, 100, 200]}
+                  totalItems={total}
+                  size="sm"
+                  onChange={onPageChange}
+                />
+              )}
+            </>
+          ) : (
+            <Layer className={styles.empty}>
+              <Document size={32} className={styles.emptyIcon} />
+              <h4>No records to list</h4>
+              <p>No laboratory entries matched the selected period and facility.</p>
+            </Layer>
+          )}
+        </>
+      )}
+      {!isGenerated && (
+        <ReportPlaceholder
+          reportName="MOH 240 laboratory register"
+          isLocationChanged={Boolean(period.startDate) && hasLocationChanged}
+        />
+      )}
+    </>
+  );
+};
+
+export default Moh240LabRegister;