EES-5373: Update frontend to provide boundary level as separate argument in requests.

Author: Tom Jones

src/explore-education-statistics-admin/src/pages/bau/BoundaryDataPage.tsx

@@ -8,9 +8,7 @@ import Link from '@admin/components/Link';
 import { useQuery } from '@tanstack/react-query';
 import boundaryDataQueries from '@admin/queries/boundaryDataQueries';
 import boundaryTypesMap from '@common/utils/boundaryTypesMap';
-import locationLevelsMap, {
-  LocationLevelKey,
-} from '@common/utils/locationLevelsMap';
+import locationLevelsMap from '@common/utils/locationLevelsMap';
 import InsetText from '@common/components/InsetText';
 import classNames from 'classnames';
 import styles from './BoundaryDataPage.module.scss';

src/explore-education-statistics-admin/src/pages/release/content/components/ReleasePreviewTableTool.tsx

@@ -48,6 +48,7 @@ const ReleasePreviewTableTool = ({
             ...query,
           },
           releaseId,
+          query.boundaryLevel,
         ),
       ]);
 

src/explore-education-statistics-admin/src/pages/release/datablocks/__tests__/ReleaseDataBlockEditPage.test.tsx

@@ -119,6 +119,7 @@ describe('ReleaseDataBlockEditPage', () => {
             dataSets: [],
           },
         },
+        boundaryLevel: undefined,
         legend: {
           position: 'top',
           items: [],

src/explore-education-statistics-admin/src/pages/release/datablocks/components/DataBlockPageReadOnlyTabs.tsx

@@ -32,6 +32,7 @@ const DataBlockPageReadOnlyTabs = ({ releaseId, dataBlock }: Props) => {
     const tableData = await tableBuilderService.getTableData(
       dataBlock.query,
       releaseId,
+      dataBlock.charts[0].boundaryLevel,
     );
     const table = mapFullTable(tableData);
 

src/explore-education-statistics-admin/src/pages/release/datablocks/components/DataBlockPageTabs.tsx

@@ -78,7 +78,12 @@ const DataBlockPageTabs = ({
       releaseId,
     };
 
-    const tableData = await tableBuilderService.getTableData(query, releaseId);
+    const boundaryLevel = dataBlock.charts[0]?.boundaryLevel ?? undefined;
+    const tableData = await tableBuilderService.getTableData(
+      query,
+      releaseId,
+      boundaryLevel,
+    );
     const { initialStep, subjectMeta } = await getInitialStepSubjectMeta(
       query,
       tableData,

src/explore-education-statistics-admin/src/pages/release/datablocks/components/chart/ChartBuilderTabSection.tsx

@@ -101,6 +101,7 @@ const ChartBuilderTabSection = ({
       const tableData = await tableBuilderService.getTableData(
         nextQuery,
         releaseId,
+        nextQuery.boundaryLevel,
       );
 
       onTableUpdate({

src/explore-education-statistics-admin/src/pages/release/datablocks/components/chart/reducers/__tests__/chartBuilderReducer.test.ts

@@ -604,6 +604,7 @@ describe('chartBuilderReducer', () => {
             },
           },
         },
+        boundaryLevel: undefined,
         type: 'line',
         height: 300,
         title: 'Table title',
@@ -717,6 +718,7 @@ describe('chartBuilderReducer', () => {
             visible: true,
           },
         },
+        boundaryLevel: undefined,
         type: 'line',
         height: 300,
         title: 'Table title',
@@ -815,6 +817,7 @@ describe('chartBuilderReducer', () => {
             visible: true,
           },
         },
+        boundaryLevel: undefined,
         type: 'line',
         height: 300,
         title: '',
@@ -889,6 +892,7 @@ describe('chartBuilderReducer', () => {
             },
           },
         },
+        boundaryLevel: undefined,
         type: 'line',
         height: 300,
         title: 'Chart title',

src/explore-education-statistics-admin/src/pages/release/pre-release/PreReleaseTableToolPage.tsx

@@ -55,6 +55,7 @@ const PreReleaseTableToolPage = ({
               ...query,
             },
             releaseId,
+            query.boundaryLevel,
           ),
         ]);
 

src/explore-education-statistics-common/src/modules/charts/components/__tests__/__data__/testChartData.ts

@@ -87,6 +87,7 @@ export const testChartConfiguration: Chart = {
       tickConfig: 'default',
     },
   },
+  boundaryLevel: undefined,
   type: 'line',
   title: 'Aggregated results chart',
   alt: 'Some alt text',

src/explore-education-statistics-common/src/modules/charts/components/__tests__/__data__/testMapBlockData.ts

@@ -69,6 +69,7 @@ export const testMapConfiguration: Chart = {
       },
     ],
   },
+  boundaryLevel: 1,
   type: 'map',
   title: '',
   alt: '',

src/explore-education-statistics-common/src/modules/find-statistics/components/DataBlockTabs.tsx

@@ -44,7 +44,11 @@ const DataBlockTabs = ({
     value: fullTable,
     isLoading,
     error,
-  } = useTableQuery(releaseId, dataBlock.dataBlockParentId);
+  } = useTableQuery(
+    releaseId,
+    dataBlock.dataBlockParentId,
+    dataBlock.charts[0]?.boundaryLevel,
+  );
 
   const errorMessage = <WarningMessage>Could not load content</WarningMessage>;
 

src/explore-education-statistics-common/src/modules/find-statistics/components/__tests__/DataBlockTabs.test.tsx

@@ -161,6 +161,7 @@ describe('DataBlockTabs', () => {
       expect(tableBuilderService.getDataBlockTableData).toBeCalledWith(
         'release-1',
         'block-1-parent',
+        undefined,
       );
 
       expect(screen.getAllByText('Could not load content')).toHaveLength(2);
@@ -194,6 +195,7 @@ describe('DataBlockTabs', () => {
       expect(tableBuilderService.getDataBlockTableData).toBeCalledWith(
         'release-1',
         'block-1-parent',
+        undefined,
       );
 
       expect(
@@ -225,6 +227,7 @@ describe('DataBlockTabs', () => {
       expect(tableBuilderService.getDataBlockTableData).toBeCalledWith(
         'release-1',
         'block-1-parent',
+        undefined,
       );
 
       expect(screen.getAllByRole('tab')).toHaveLength(2);
@@ -260,6 +263,7 @@ describe('DataBlockTabs', () => {
       expect(tableBuilderService.getDataBlockTableData).toBeCalledWith(
         'release-1',
         'block-1-parent',
+        undefined,
       );
 
       expect(screen.getAllByRole('tab')).toHaveLength(2);
@@ -294,6 +298,7 @@ describe('DataBlockTabs', () => {
       expect(tableBuilderService.getDataBlockTableData).toBeCalledWith(
         'release-1',
         'block-1-parent',
+        undefined,
       );
 
       expect(screen.getAllByRole('tab')).toHaveLength(2);
@@ -334,6 +339,7 @@ describe('DataBlockTabs', () => {
       expect(tableBuilderService.getDataBlockTableData).toBeCalledWith(
         'release-1',
         'block-1-parent',
+        undefined,
       );
 
       expect(screen.getByRole('table')).toBeInTheDocument();
@@ -362,6 +368,7 @@ describe('DataBlockTabs', () => {
       expect(tableBuilderService.getDataBlockTableData).toBeCalledWith(
         'release-1',
         'block-1-parent',
+        1,
       );
 
       expect(container.querySelector('.leaflet-container')).toBeInTheDocument();

src/explore-education-statistics-common/src/modules/find-statistics/hooks/useTableQuery.ts

@@ -6,11 +6,13 @@ import tableBuilderService from '@common/services/tableBuilderService';
 export default function useTableQuery(
   releaseId: string,
   dataBlockParentId: string,
+  boundaryLevelId?: number | undefined,
 ): AsyncRetryState<FullTable> {
   return useAsyncRetry(async () => {
     const response = await tableBuilderService.getDataBlockTableData(
       releaseId,
       dataBlockParentId,
+      boundaryLevelId,
     );
 
     return mapFullTable(response);

src/explore-education-statistics-common/src/services/tableBuilderService.ts

@@ -244,8 +244,16 @@ const tableBuilderService = {
   async getTableData(
     query: FullTableQuery,
     releaseId?: string,
+    boundaryLevelId?: number | undefined,
   ): Promise<TableDataResponse> {
-    return releaseId
+    if (releaseId && boundaryLevelId) {
+      return dataApi.post(
+        `/tablebuilder/release/${releaseId}/${boundaryLevelId}`,
+        query,
+      );
+    }
+
+    return releaseId && !boundaryLevelId
       ? dataApi.post(`/tablebuilder/release/${releaseId}`, query)
       : dataApi.post('/tablebuilder', query);
   },
@@ -267,10 +275,15 @@ const tableBuilderService = {
   async getDataBlockTableData(
     releaseId: string,
     dataBlockParentId: string,
+    boundaryLevelId?: number | undefined,
   ): Promise<TableDataResponse> {
-    return dataApi.get(
-      `/tablebuilder/release/${releaseId}/data-block/${dataBlockParentId}`,
-    );
+    return boundaryLevelId
+      ? dataApi.get(
+          `/tablebuilder/release/${releaseId}/data-block/${dataBlockParentId}/${boundaryLevelId}`,
+        )
+      : dataApi.get(
+          `/tablebuilder/release/${releaseId}/data-block/${dataBlockParentId}`,
+        );
   },
   getFastTrackTableAndReleaseMeta(
     dataBlockParentId: string,

src/explore-education-statistics-common/src/services/types/blocks.ts

@@ -25,6 +25,7 @@ type ChartAxesConfiguration = {
  */
 export type Chart = OmitStrict<ChartRendererProps, 'data' | 'meta' | 'axes'> & {
   axes: ChartAxesConfiguration;
+  boundaryLevel: number | undefined;
 };
 
 export interface Table {