EES-4856 Move Variables to DataSetFileFileViewModel and update frontend interfaces

Author: mmyoungman

src/GovUk.Education.ExploreEducationStatistics.Content.Api.Tests/Controllers/DataSetFilesControllerTests.cs

@@ -2187,21 +2187,21 @@ await publicBlobStorageService.UploadFile(
             var response = await client.GetAsync(uri);
             var viewModel = response.AssertOk<DataSetFileViewModel>();
 
-            Assert.Equal(7, viewModel.Variables.Count);
-            Assert.Equal("A_filter_1", viewModel.Variables[0].Value);
-            Assert.Equal("Filter 1 - hint", viewModel.Variables[0].Label);
-            Assert.Equal("B_indicator_3", viewModel.Variables[1].Value);
-            Assert.Equal("Indicator 3", viewModel.Variables[1].Label);
-            Assert.Equal("C_filter_3", viewModel.Variables[2].Value);
-            Assert.Equal("Filter 3 - Another hint", viewModel.Variables[2].Label);
-            Assert.Equal("D_indicator_1", viewModel.Variables[3].Value);
-            Assert.Equal("Indicator 1", viewModel.Variables[3].Label);
-            Assert.Equal("E_indicator_2", viewModel.Variables[4].Value);
-            Assert.Equal("Indicator 2", viewModel.Variables[4].Label);
-            Assert.Equal("F_indicator_4", viewModel.Variables[5].Value);
-            Assert.Equal("Indicator 4", viewModel.Variables[5].Label);
-            Assert.Equal("G_filter_2", viewModel.Variables[6].Value);
-            Assert.Equal("Filter 2", viewModel.Variables[6].Label);
+            Assert.Equal(7, viewModel.File.Variables.Count);
+            Assert.Equal("A_filter_1", viewModel.File.Variables[0].Value);
+            Assert.Equal("Filter 1 - hint", viewModel.File.Variables[0].Label);
+            Assert.Equal("B_indicator_3", viewModel.File.Variables[1].Value);
+            Assert.Equal("Indicator 3", viewModel.File.Variables[1].Label);
+            Assert.Equal("C_filter_3", viewModel.File.Variables[2].Value);
+            Assert.Equal("Filter 3 - Another hint", viewModel.File.Variables[2].Label);
+            Assert.Equal("D_indicator_1", viewModel.File.Variables[3].Value);
+            Assert.Equal("Indicator 1", viewModel.File.Variables[3].Label);
+            Assert.Equal("E_indicator_2", viewModel.File.Variables[4].Value);
+            Assert.Equal("Indicator 2", viewModel.File.Variables[4].Label);
+            Assert.Equal("F_indicator_4", viewModel.File.Variables[5].Value);
+            Assert.Equal("Indicator 4", viewModel.File.Variables[5].Label);
+            Assert.Equal("G_filter_2", viewModel.File.Variables[6].Value);
+            Assert.Equal("Filter 2", viewModel.File.Variables[6].Label);
         }
 
         [Fact]

src/GovUk.Education.ExploreEducationStatistics.Content.Services/DataSetFileService.cs

@@ -208,12 +208,12 @@ public async Task<Either<ActionResult, DataSetFileViewModel>> GetDataSetFile(
                 Name = releaseFile.File.Filename,
                 Size = releaseFile.File.DisplaySize(),
                 DataCsvPreview = dataCsvPreview,
+                Variables = variables,
             },
             Meta = BuildDataSetFileMetaViewModel(
                 releaseFile.File.DataSetFileMeta,
                 releaseFile.FilterSequence,
                 releaseFile.IndicatorSequence),
-            Variables = variables,
             Footnotes = FootnotesViewModelBuilder.BuildFootnotes(footnotes),
             Api = BuildDataSetFileApiViewModel(releaseFile.File)
         };

src/GovUk.Education.ExploreEducationStatistics.Content.ViewModels/DataSetFileViewModel.cs

@@ -22,8 +22,6 @@ public record DataSetFileViewModel
 
     public required List<FootnoteViewModel> Footnotes { get; init; } = [];
 
-    public required List<LabelValue> Variables { get; init; } = [];
-
     public DataSetFileApiViewModel? Api { get; set; }
 }
 
@@ -65,4 +63,6 @@ public record DataSetFileFileViewModel
     public required string Size { get; init; } = string.Empty;
 
     public required DataSetFileCsvPreviewViewModel DataCsvPreview { get; init; } = new();
+
+    public required List<LabelValue> Variables { get; init; } = [];
 }

src/explore-education-statistics-frontend/src/modules/data-catalogue/__data__/testDataSets.ts

@@ -111,7 +111,13 @@ export const testDataSetFileSummaries: DataSetFileSummary[] = [
 
 export const testDataSet: DataSetFile = {
   id: 'datasetfile-id',
-  file: { id: 'file-id', name: 'file name', size: 'file size' },
+  file: {
+    id: 'file-id',
+    name: 'file name',
+    size: 'file size',
+    dataCsvPreview: { headers: ['column_1'], rows: [['1']] },
+    variables: [{ value: 'column_1', label: 'Column 1 is for something' }],
+  },
   release: {
     id: 'release-id',
     isLatestPublishedRelease: true,
@@ -138,4 +144,5 @@ export const testDataSet: DataSetFile = {
     geographicLevels: ['Local authority', 'National'],
     indicators: ['Indicator 1', 'Indicator 2'],
   },
+  footnotes: [{ id: 'footnote-1', label: 'Footnote 1' }],
 };

src/explore-education-statistics-frontend/src/services/dataSetFileService.ts

@@ -7,7 +7,16 @@ export interface DataSetFile {
   id: string;
   title: string;
   summary: string;
-  file: { id: string; name: string; size: string };
+  file: {
+    id: string;
+    name: string;
+    size: string;
+    dataCsvPreview: {
+      headers: string[];
+      rows: string[][];
+    };
+    variables: { label: string; value: string }[];
+  };
   release: {
     id: string;
     isLatestPublishedRelease: boolean;
@@ -22,7 +31,6 @@ export interface DataSetFile {
     title: string;
     type: ReleaseType;
   };
-  api?: DataSetFileApi;
   meta: {
     geographicLevels: string[];
     timePeriod: {
@@ -33,6 +41,8 @@ export interface DataSetFile {
     filters: string[];
     indicators: string[];
   };
+  footnotes: { id: string; label: string }[];
+  api?: DataSetFileApi;
 }
 
 export interface DataSetFileSummary {