EES-5373: Change boundary route parameter to query parameter, remove "undefined" from type definition.

Author: Tom Jones

src/GovUk.Education.ExploreEducationStatistics.Admin/Controllers/Api/Statistics/TableBuilderController.cs

@@ -38,13 +38,13 @@ public TableBuilderController(
             _dataBlockService = dataBlockService;
         }
 
-        [HttpPost("data/tablebuilder/release/{releaseVersionId:guid}/{boundaryLevelId:long?}")]
+        [HttpPost("data/tablebuilder/release/{releaseVersionId:guid}")]
         [Produces("application/json", "text/csv")]
         [CancellationTokenTimeout(TableBuilderQuery)]
         public async Task<ActionResult> Query(
             Guid releaseVersionId,
             [FromBody] FullTableQueryRequest request,
-            long? boundaryLevelId,
+            [FromQuery] long? boundaryLevelId,
             CancellationToken cancellationToken = default)
         {
             if (Request.AcceptsCsv(exact: true))
@@ -67,11 +67,11 @@ public async Task<ActionResult> Query(
                 .HandleFailuresOr(Ok);
         }
 
-        [HttpGet("data/tablebuilder/release/{releaseVersionId:guid}/data-block/{dataBlockParentId:guid}/{boundaryLevelId:long?}")]
+        [HttpGet("data/tablebuilder/release/{releaseVersionId:guid}/data-block/{dataBlockParentId:guid}")]
         public async Task<ActionResult<TableBuilderResultViewModel>> QueryForDataBlock(
             Guid releaseVersionId,
             Guid dataBlockParentId,
-            long? boundaryLevelId,
+            [FromQuery] long? boundaryLevelId,
             CancellationToken cancellationToken = default)
         {
             return await _dataBlockService

src/GovUk.Education.ExploreEducationStatistics.Common/Requests/QueryRequests.cs

@@ -18,10 +18,6 @@ public record FullTableQueryRequest
 
     public IEnumerable<Guid> Indicators { get; set; } = new List<Guid>();
 
-    // BoundaryLevel is used by DataBlockUpdateRequest, and TableBuilderController#Query with Map Charts
-    // Also see EES-3328 and EES-3319
-    public long? BoundaryLevel { get; set; }
-
     public FullTableQuery AsFullTableQuery()
     {
         return new FullTableQuery

src/GovUk.Education.ExploreEducationStatistics.Data.Api/Controllers/TableBuilderController.cs

@@ -94,18 +94,18 @@ public async Task<ActionResult> Query(
             }
 
             return await _tableBuilderService
-                .Query(releaseVersionId, request.AsFullTableQuery(), request.BoundaryLevel, cancellationToken)
+                .Query(releaseVersionId, request.AsFullTableQuery(), boundaryLevelId: null, cancellationToken)
                 .HandleFailuresOr(Ok);
         }
 
         // Note that releaseVersionId is not necessary for this method to function any more in the Data API, but remains in place
         // both in order to support legacy URLs in bookmarks and in content, but also to remain consistent with the equivalent
         // endpoint in the Admin API, which does require the Release Id in order to differentiate between different 
         // DataBlockVersions rather than simply picking the latest published one.
-        [HttpGet("tablebuilder/release/{releaseVersionId:guid}/data-block/{dataBlockParentId:guid}/{boundaryLevelId:long?}")]
+        [HttpGet("tablebuilder/release/{releaseVersionId:guid}/data-block/{dataBlockParentId:guid}")]
         public async Task<ActionResult<TableBuilderResultViewModel>> QueryForTableBuilderResult(
             Guid dataBlockParentId,
-            long? boundaryLevelId)
+            [FromQuery] long? boundaryLevelId)
         {
             var actionResult = await GetLatestPublishedDataBlockVersion(dataBlockParentId)
                 .OnSuccessDo(dataBlockVersion => this

src/GovUk.Education.ExploreEducationStatistics.Data.Services.Tests/SubjectResultMetaServiceTests.cs

@@ -98,7 +98,7 @@ public async Task GetSubjectMeta_SubjectNotFound()
             var result = await service.GetSubjectMeta(
                 releaseVersionId: Guid.NewGuid(),
                 query,
-                null,
+                boundaryLevelId: null,
                 new List<Observation>());
 
             result.AssertNotFound();
@@ -200,7 +200,7 @@ public async Task GetSubjectMeta_EmptyModelReturnedForSubject()
                 var result = await service.GetSubjectMeta(
                     releaseVersion.Id,
                     query,
-                    null,
+                    boundaryLevelId: null,
                     observations);
 
                 VerifyAllMocks(
@@ -379,7 +379,7 @@ public async Task GetSubjectMeta_BoundaryLevelViewModelsReturnedForSubject()
                 var result = await service.GetSubjectMeta(
                     releaseVersion.Id,
                     query,
-                    null,
+                    boundaryLevelId: null,
                     observations);
 
                 VerifyAllMocks(
@@ -603,7 +603,7 @@ public async Task GetSubjectMeta_LocationViewModelsReturnedForSubject()
                 var result = await service.GetSubjectMeta(
                     releaseVersion.Id,
                     query,
-                    null,
+                    boundaryLevelId: null,
                     observations);
 
                 VerifyAllMocks(
@@ -862,7 +862,7 @@ public async Task GetSubjectMeta_LocationViewModelsReturnedForSubject_SpecificBo
                 var result = await service.GetSubjectMeta(
                     releaseVersion.Id,
                     query,
-                    123,
+                    boundaryLevelId: 123,
                     observations);
 
                 VerifyAllMocks(

src/GovUk.Education.ExploreEducationStatistics.Data.Services.Tests/TableBuilderServicePermissionTests.cs

@@ -102,7 +102,7 @@ await PolicyCheckBuilder<DataSecurityPolicies>()
                             {
                                 SubjectId = _subject.Id
                             },
-                            null
+                            boundaryLevelId: null
                         );
                     }
                 );

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

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

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

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

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

@@ -101,7 +101,6 @@ 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,7 +604,6 @@ describe('chartBuilderReducer', () => {
             },
           },
         },
-        boundaryLevel: undefined,
         type: 'line',
         height: 300,
         title: 'Table title',

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

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

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

@@ -87,7 +87,6 @@ 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/find-statistics/hooks/useTableQuery.ts

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

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

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

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

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