[ODS-6432] Add support for key set paging (#1127)

Co-authored-by: EdFiBuildAgent <devops@ed-fi.org>
Ed-Fi-Alliance-OSS · Sep 26, 2024 · 069aa80 · 069aa80
1 parent e13b249
commit 069aa80
Show file tree

Hide file tree

Showing 7 changed files with 38 additions and 29 deletions.
diff --git a/...rations/SecurityDatabaseMigrationsTask.cs → ...curityDatabaseMigrationsStartupCommand.cs b/...rations/SecurityDatabaseMigrationsTask.cs → ...curityDatabaseMigrationsStartupCommand.cs
@@ -4,24 +4,25 @@
 // See the LICENSE and NOTICES files in the project root for more information.
 
 using System.Reflection;
-using EdFi.Ods.Api.ExternalTasks;
+using System.Threading.Tasks;
+using EdFi.Ods.Api.Startup;
 
 namespace EdFi.Ods.Api.IntegrationTestHarness.Migrations;
 
-public class SecurityDatabaseMigrationsTask : IExternalTask
+public class ApplySecurityDatabaseMigrationsStartupCommand : IStartupCommand
 {
     private readonly IDatabaseMigrationsApplicator _databaseMigrationsApplicator;
     private readonly ISecurityDatabaseConnectionStringCatalog _securityConnectionStringCatalog;
 
-    public SecurityDatabaseMigrationsTask(
+    public ApplySecurityDatabaseMigrationsStartupCommand(
         IDatabaseMigrationsApplicator databaseMigrationsApplicator,
         ISecurityDatabaseConnectionStringCatalog securityConnectionStringCatalog)
     {
         _databaseMigrationsApplicator = databaseMigrationsApplicator;
         _securityConnectionStringCatalog = securityConnectionStringCatalog;
     }
 
-    public void Execute()
+    public Task ExecuteAsync()
     {
         foreach (var connectionString in _securityConnectionStringCatalog.GetConnectionStrings())
         {
@@ -31,5 +32,7 @@ public void Execute()
                 MigrationArtifactType.Data,
                 MigrationDatabaseType.Security);
         }
+
+        return Task.CompletedTask;
     }
 }
diff --git a/Application/EdFi.Ods.Api.IntegrationTestHarness/Modules/MigrationsModule.cs b/Application/EdFi.Ods.Api.IntegrationTestHarness/Modules/MigrationsModule.cs
@@ -4,8 +4,8 @@
 // See the LICENSE and NOTICES files in the project root for more information.
 
 using Autofac;
-using EdFi.Ods.Api.ExternalTasks;
 using EdFi.Ods.Api.IntegrationTestHarness.Migrations;
+using EdFi.Ods.Api.Startup;
 using EdFi.Ods.Common.Database;
 
 namespace EdFi.Ods.Api.IntegrationTestHarness.Modules;
@@ -18,8 +18,8 @@ protected override void Load(ContainerBuilder builder)
             .As<IDatabaseMigrationsApplicator>()
             .SingleInstance();
 
-        builder.RegisterType<SecurityDatabaseMigrationsTask>()
-            .As<IExternalTask>()
+        builder.RegisterType<ApplySecurityDatabaseMigrationsStartupCommand>()
+            .As<IStartupCommand>()
             .SingleInstance();
 
         builder.RegisterDecorator<OdsDatabaseConnectionStringProviderMigratingDecorator, IOdsDatabaseConnectionStringProvider>();

diff --git a/Application/EdFi.Ods.Api.IntegrationTestHarness/Modules/UpdateAdminDatabaseModule.cs b/Application/EdFi.Ods.Api.IntegrationTestHarness/Modules/UpdateAdminDatabaseModule.cs
@@ -5,7 +5,7 @@
 
 using Autofac;
 using EdFi.Admin.DataAccess.Utils;
-using EdFi.Ods.Api.ExternalTasks;
+using EdFi.Ods.Api.Startup;
 
 namespace EdFi.Ods.Api.IntegrationTestHarness.Modules
 {
@@ -16,8 +16,8 @@ protected override void Load(ContainerBuilder builder)
             builder.RegisterType<TestHarnessConfigurationProvider>()
                 .SingleInstance();
 
-            builder.RegisterType<UpdateAdminDatabaseTask>()
-                .As<IExternalTask>();
+            builder.RegisterType<UpdateAdminDatabaseStartupCommand>()
+                .As<IStartupCommand>();
 
             builder.RegisterType<DefaultApplicationCreator>()
                 .As<IDefaultApplicationCreator>();

diff --git a/...ionTestHarness/UpdateAdminDatabaseTask.cs → ...ness/UpdateAdminDatabaseStartupCommand.cs b/...ionTestHarness/UpdateAdminDatabaseTask.cs → ...ness/UpdateAdminDatabaseStartupCommand.cs
@@ -8,13 +8,14 @@
 using System.IO;
 using System.Linq;
 using System.Numerics;
+using System.Threading.Tasks;
 using System.Xml;
 using EdFi.Admin.DataAccess.Models;
 using EdFi.Admin.DataAccess.Repositories;
 using EdFi.Admin.DataAccess.Utils;
 using EdFi.Common.Extensions;
-using EdFi.Ods.Api.ExternalTasks;
 using EdFi.Ods.Api.Middleware;
+using EdFi.Ods.Api.Startup;
 using EdFi.Ods.Common.Configuration;
 using EdFi.Ods.Common.Constants;
 using EdFi.Ods.Common.Context;
@@ -30,9 +31,9 @@
 
 namespace EdFi.Ods.Api.IntegrationTestHarness
 {
-    public class UpdateAdminDatabaseTask : IExternalTask
+    public class UpdateAdminDatabaseStartupCommand : IStartupCommand
     {
-        private readonly ILog _logger = LogManager.GetLogger(typeof(UpdateAdminDatabaseTask));
+        private readonly ILog _logger = LogManager.GetLogger(typeof(UpdateAdminDatabaseStartupCommand));
         private readonly IClientAppRepo _clientAppRepo;
         private readonly IDefaultApplicationCreator _defaultApplicationCreator;
         private readonly IConfiguration _configuration;
@@ -44,7 +45,7 @@ public class UpdateAdminDatabaseTask : IExternalTask
         private readonly Version _edfiDomainModelVersion;
         private readonly long _maxSafeEducationOrganizationId;
 
-        public UpdateAdminDatabaseTask(IClientAppRepo clientAppRepo,
+        public UpdateAdminDatabaseStartupCommand(IClientAppRepo clientAppRepo,
             IDefaultApplicationCreator defaultApplicationCreator,
             IConfiguration configuration,
             ApiSettings apiSettings,
@@ -72,7 +73,7 @@ public UpdateAdminDatabaseTask(IClientAppRepo clientAppRepo,
             _maxSafeEducationOrganizationId = _edfiDomainModelVersion.Major < 5 ? int.MaxValue : maxSafeInt64;
         }
 
-        public UpdateAdminDatabaseTask(IClientAppRepo clientAppRepo,
+        public UpdateAdminDatabaseStartupCommand(IClientAppRepo clientAppRepo,
             IDefaultApplicationCreator defaultApplicationCreator,
             IConfiguration configuration,
             ApiSettings apiSettings,
@@ -86,7 +87,7 @@ public UpdateAdminDatabaseTask(IClientAppRepo clientAppRepo,
             _tenantConfigurationContextProvider = tenantConfigurationContextProvider;
         }
 
-        public void Execute()
+        public Task ExecuteAsync()
         {
             PostmanEnvironment postmanEnvironment;
 
@@ -112,6 +113,8 @@ public void Execute()
 
             CreateEnvironmentFile();
 
+            return Task.CompletedTask;
+
             void CreateEnvironmentFile()
             {
                 // This checks if the Ed-Fi Data Standard in use has a Parent entity,

diff --git a/Application/EdFi.Ods.Api.IntegrationTestHarness/log4net.config b/Application/EdFi.Ods.Api.IntegrationTestHarness/log4net.config
@@ -42,4 +42,4 @@
         <conversionPattern value="%date [%thread] %-5level ClientId:%property{ApiClientId} CorrelationId:%property{CorrelationId} RequestUrl:%property{RequestUrl} RequestMethod:%property{RequestMethod} ProfilesHeader:%property{ProfilesHeader} ResponseCode:%property{ResponseCode} ResponseMessage:%message%n" />
     </layout>
   </appender>
-</log4net>
+</log4net>
diff --git a/Application/EdFi.Ods.WebApi/log4net.development.config b/Application/EdFi.Ods.WebApi/log4net.development.config
@@ -30,6 +30,9 @@
   <logger name="EdFi.Ods.Common.Infrastructure.Interceptors">
     <level value="OFF"/>
   </logger>
+  <logger name="EdFi.Ods.Common.Models.Domain.DomainModelEnhancers">
+    <level value="OFF"/>
+  </logger>
   <logger name="EdFi.Ods.Api.Security.Authorization.Repositories.EntityAuthorizer">
     <level value="OFF"/>
   </logger>

diff --git a/configuration.packages.json b/configuration.packages.json
@@ -2,47 +2,47 @@
   "packages": {
     "EdFiMinimalTemplate": {
       "PackageName": "EdFi.Suite3.Ods.Minimal.Template.Standard.{StandardVersion}",
-      "PackageVersion": "7.3.152",
+      "PackageVersion": "7.3.175",
       "PackageSource": "https://pkgs.dev.azure.com/ed-fi-alliance/Ed-Fi-Alliance-OSS/_packaging/EdFi/nuget/v3/index.json"
     },
     "GrandBend": {
       "PackageName": "EdFi.Suite3.Ods.Populated.Template.Standard.{StandardVersion}",
-      "PackageVersion": "7.3.138",
+      "PackageVersion": "7.3.154",
       "PackageSource": "https://pkgs.dev.azure.com/ed-fi-alliance/Ed-Fi-Alliance-OSS/_packaging/EdFi/nuget/v3/index.json"
     },
     "PostgreSqlMinimalTemplate": {
       "PackageName": "EdFi.Suite3.Ods.Minimal.Template.PostgreSQL.Standard.{StandardVersion}",
-      "PackageVersion": "7.3.132",
+      "PackageVersion": "7.3.153",
       "PackageSource": "https://pkgs.dev.azure.com/ed-fi-alliance/Ed-Fi-Alliance-OSS/_packaging/EdFi/nuget/v3/index.json"
     },
     "PostgreSqlPopulatedTemplate": {
       "PackageName": "EdFi.Suite3.Ods.Populated.Template.PostgreSQL.Standard.{StandardVersion}",
-      "PackageVersion": "7.3.137",
+      "PackageVersion": "7.3.153",
       "PackageSource": "https://pkgs.dev.azure.com/ed-fi-alliance/Ed-Fi-Alliance-OSS/_packaging/EdFi/nuget/v3/index.json"
     },
     "TPDMCoreMinimalTemplate": {
       "PackageName": "EdFi.Suite3.Ods.Minimal.Template.TPDM.Core.{ExtensionVersion}.Standard.{StandardVersion}",
-      "PackageVersion": "7.3.113",
+      "PackageVersion": "7.3.122",
       "PackageSource": "https://pkgs.dev.azure.com/ed-fi-alliance/Ed-Fi-Alliance-OSS/_packaging/EdFi/nuget/v3/index.json"
     },
     "TPDMCorePopulatedTemplate": {
       "PackageName": "EdFi.Suite3.Ods.Populated.Template.TPDM.Core.{ExtensionVersion}.Standard.{StandardVersion}",
-      "PackageVersion": "7.3.117",
+      "PackageVersion": "7.3.126",
       "PackageSource": "https://pkgs.dev.azure.com/ed-fi-alliance/Ed-Fi-Alliance-OSS/_packaging/EdFi/nuget/v3/index.json"
     },
     "TPDMCorePostgreSqlMinimalTemplate": {
       "PackageName": "EdFi.Suite3.Ods.Minimal.Template.TPDM.Core.{ExtensionVersion}.PostgreSQL.Standard.{StandardVersion}",
-      "PackageVersion": "7.3.117",
+      "PackageVersion": "7.3.126",
       "PackageSource": "https://pkgs.dev.azure.com/ed-fi-alliance/Ed-Fi-Alliance-OSS/_packaging/EdFi/nuget/v3/index.json"
     },
     "TPDMCorePostgreSqlPopulatedTemplate": {
       "PackageName": "EdFi.Suite3.Ods.Populated.Template.TPDM.Core.{ExtensionVersion}.PostgreSQL.Standard.{StandardVersion}",
-      "PackageVersion": "7.3.118",
+      "PackageVersion": "7.3.127",
       "PackageSource": "https://pkgs.dev.azure.com/ed-fi-alliance/Ed-Fi-Alliance-OSS/_packaging/EdFi/nuget/v3/index.json"
     },
     "homograph": {
       "PackageName": "EdFi.Suite3.Ods.Extensions.Homograph.1.0.0.Standard.{StandardVersion}",
-      "PackageVersion": "7.3.131",
+      "PackageVersion": "7.3.145",
       "PackageSource": "https://pkgs.dev.azure.com/ed-fi-alliance/Ed-Fi-Alliance-OSS/_packaging/EdFi/nuget/v3/index.json"
     },
     "profiles.sample": {
@@ -52,17 +52,17 @@
     },
     "sample": {
       "PackageName": "EdFi.Suite3.Ods.Extensions.Sample.1.0.0.Standard.{StandardVersion}",
-      "PackageVersion": "7.3.125",
+      "PackageVersion": "7.3.135",
       "PackageSource": "https://pkgs.dev.azure.com/ed-fi-alliance/Ed-Fi-Alliance-OSS/_packaging/EdFi/nuget/v3/index.json"
     },
     "tpdm": {
       "PackageName": "EdFi.Suite3.Ods.Extensions.TPDM.Core.{ExtensionVersion}.Standard.{StandardVersion}",
-      "PackageVersion": "7.3.111",
+      "PackageVersion": "7.3.121",
       "PackageSource": "https://pkgs.dev.azure.com/ed-fi-alliance/Ed-Fi-Alliance-OSS/_packaging/EdFi/nuget/v3/index.json"
     },
     "EdFi.Ods.CodeGen": {
       "PackageName": "EdFi.Suite3.Ods.CodeGen",
-      "PackageVersion": "7.3.494",
+      "PackageVersion": "7.3.538",
       "PackageSource": "https://pkgs.dev.azure.com/ed-fi-alliance/Ed-Fi-Alliance-OSS/_packaging/EdFi/nuget/v3/index.json"
     },
     "EdFi.Db.Deploy": {