EES-4993 Move PublicApiDataSet* columns from Files to ReleaseFiles

Signed-off-by: Nicholas Tsim <nicholastsim@gmail.com>

Author: ntsim

src/GovUk.Education.ExploreEducationStatistics.Admin.Tests/Controllers/Api/Public.Data/DataSetCandidatesControllerTests.cs

@@ -179,16 +179,15 @@ public async Task ReleaseFileHasAssociatedDataSet_NotReturned()
 
             DataImport dataImport = DataFixture
                 .DefaultDataImport()
-                .WithFile(DataFixture.DefaultFile(FileType.Data)
-                    .WithPublicApiDataSetId(Guid.NewGuid())
-                );
+                .WithFile(DataFixture.DefaultFile(FileType.Data));
 
             var releaseVersion = release.Versions.Single();
 
             ReleaseFile releaseFile = DataFixture
                 .DefaultReleaseFile()
                 .WithFile(dataImport.File)
-                .WithReleaseVersion(releaseVersion);
+                .WithReleaseVersion(releaseVersion)
+                .WithPublicApiDataSetId(Guid.NewGuid());
 
             await TestApp.AddTestData<ContentDbContext>(context =>
             {

src/GovUk.Education.ExploreEducationStatistics.Admin.Tests/Services/ReleaseAmendmentServiceTests.cs

@@ -314,6 +314,8 @@ public async Task CreateReleaseAmendment()
                         )
                     ],
                     Published = new DateTime(2020, 1, 1, 0, 0, 0, DateTimeKind.Utc),
+                    PublicApiDataSetId = Guid.NewGuid(),
+                    PublicApiDataSetVersion = "1.0.0",
                 },
                 new()
                 {
@@ -1157,7 +1159,9 @@ private static void AssertAmendedReleaseRoleCorrect(
             Assert.Equal(originalReleaseRole.DeletedById, amendedReleaseRole.DeletedById);
         }
 
-        private static void AssertAmendedReleaseFileCorrect(ReleaseFile originalFile, ReleaseFile amendmentDataFile,
+        private static void AssertAmendedReleaseFileCorrect(
+            ReleaseFile originalFile,
+            ReleaseFile amendmentDataFile,
             ReleaseVersion amendment)
         {
             // Assert it's a new link table entry between the Release amendment and the data file reference
@@ -1170,6 +1174,9 @@ private static void AssertAmendedReleaseFileCorrect(ReleaseFile originalFile, Re
             originalFile.FilterSequence.AssertDeepEqualTo(amendmentDataFile.FilterSequence);
             originalFile.IndicatorSequence.AssertDeepEqualTo(amendmentDataFile.IndicatorSequence);
 
+            Assert.Equal(originalFile.PublicApiDataSetId, amendmentDataFile.PublicApiDataSetId);
+            Assert.Equal(originalFile.PublicApiDataSetVersion, amendmentDataFile.PublicApiDataSetVersion);
+
             // And assert that the file referenced is the SAME file reference as linked from the original Release's
             // link table entry
             Assert.Equal(originalFile.File.Id, amendmentDataFile.File.Id);

src/GovUk.Education.ExploreEducationStatistics.Admin/Controllers/Api/Bau/BauMigrationController.cs

@@ -0,0 +1,58 @@
+#nullable enable
+using System.Linq;
+using System.Threading;
+using System.Threading.Tasks;
+using GovUk.Education.ExploreEducationStatistics.Admin.Models;
+using GovUk.Education.ExploreEducationStatistics.Content.Model.Database;
+using GovUk.Education.ExploreEducationStatistics.Public.Data.Model;
+using GovUk.Education.ExploreEducationStatistics.Public.Data.Model.Database;
+using Microsoft.AspNetCore.Authorization;
+using Microsoft.AspNetCore.Mvc;
+using Microsoft.EntityFrameworkCore;
+
+namespace GovUk.Education.ExploreEducationStatistics.Admin.Controllers.Api.Bau;
+
+[Route("api/bau")]
+[ApiController]
+[Authorize(Roles = GlobalRoles.RoleNames.BauUser)]
+public class BauMigrationController(
+    ContentDbContext contentDbContext,
+    PublicDataDbContext publicDataDbContext)
+    : ControllerBase
+{
+    [HttpPost("migrate-ees-4993")]
+    public async Task<ActionResult> MigrateEes4993(CancellationToken cancellationToken)
+    {
+        var unpublishedDataSetVersions = await publicDataDbContext
+            .DataSetVersions
+            .Where(dsv => dsv.Status == DataSetVersionStatus.Draft
+                          || dsv.Status == DataSetVersionStatus.Failed
+                          || dsv.Status == DataSetVersionStatus.Processing
+                          || dsv.Status == DataSetVersionStatus.Cancelled)
+            .ToListAsync(cancellationToken);
+
+        foreach (var draftVersion in unpublishedDataSetVersions)
+        {
+            // Update any published release files to no longer incorrectly reference draft data set versions.
+            //
+            // This should only apply to draft data set versions for amendments that were created prior
+            // to the `EES4993_AddPublicApiDataSetIdVersionToReleaseFile` migration.
+
+            // The DB migration moves the `PublicApiDataSetId` and `PublicApiDataSetVersion` columns
+            // from `Files` to `ReleaseFiles`, but can set these incorrectly for published release files.
+            // We need this additional endpoint migration to fix any incorrect column values.
+            await contentDbContext.ReleaseFiles
+                .Where(rf => rf.ReleaseVersion.Published != null)
+                .Where(rf => rf.PublicApiDataSetId == draftVersion.DataSetId)
+                .Where(rf => rf.PublicApiDataSetVersion == draftVersion.Version)
+                .ExecuteUpdateAsync(
+                    s => s
+                        .SetProperty(rf => rf.PublicApiDataSetId, _ => null)
+                        .SetProperty(rf => rf.PublicApiDataSetVersion, _ => null),
+                    cancellationToken
+                );
+        }
+
+        return Ok();
+    }
+}