Database health check deactivation via configuration (#732)

* feat: enable health check configuration for consumer api * feat: enable health check configuration for admin api * feat: enable health check configuration for sse server checks * chore: fix formatting * fix: handle data annotation validation error * fix: handle data annotation validation error * fix: handle data annotation validation error * fix: handle data annotation validation error * fix: handle data annotation validation error * feat: enable health check configuration for sse server * fix: show tier in adnim api * feat: undo appsetting.override for postgres and sqlserver json * feat: remove push notification configuration * feat: revert changes to SeeServer/Program.cs * Update ConsumerApi/appsettings.json Co-authored-by: Timo Notheisen <[email protected]> * feat: remove prop * feat: remove sse health check * feat: enable healtcheck by default * feat: perform the check outside of the method instead of passing EnableHealthCheck * fix: vulnerability * Revert "fix: vulnerability" This reverts commit ae718fb. * ci: exclude vulnerability from npm audit --------- Co-authored-by: Nikola Vetnić <[email protected]> Co-authored-by: Timo Notheisen <[email protected]> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> Co-authored-by: Vladimir Vuckovic <[email protected]> Co-authored-by: Timo Notheisen <[email protected]>
nmshd · Jul 10, 2024 · c958875 · c958875
1 parent e8cb7aa
commit c958875
Show file tree

Hide file tree

Showing 26 changed files with 139 additions and 11 deletions.
diff --git a/.ci/aui/runChecks.sh b/.ci/aui/runChecks.sh
@@ -8,5 +8,5 @@ npm ci
 npx eslint --ext ts ./src
 npx prettier --check .
 npx license-check --ignorePackages [email protected]
-npx better-npm-audit audit
+npx better-npm-audit audit --exclude 1098115
 cd $INITIAL_DIR
diff --git a/AdminApi/src/AdminApi/Configuration/ChallengesConfiguration.cs b/AdminApi/src/AdminApi/Configuration/ChallengesConfiguration.cs
@@ -26,6 +26,9 @@ public class SqlDatabaseConfiguration
             [Required]
             [MinLength(1)]
             public string ConnectionString { get; set; } = string.Empty;
+
+            [Required]
+            public bool EnableHealthCheck { get; set; } = true;
         }
     }
 }
diff --git a/AdminApi/src/AdminApi/Configuration/DevicesConfiguration.cs b/AdminApi/src/AdminApi/Configuration/DevicesConfiguration.cs
@@ -30,6 +30,9 @@ public class SqlDatabaseConfiguration
             [Required]
             [MinLength(1)]
             public string ConnectionString { get; set; } = string.Empty;
+
+            [Required]
+            public bool EnableHealthCheck { get; set; } = true;
         }
     }
 }
diff --git a/AdminApi/src/AdminApi/Configuration/QuotasConfiguration.cs b/AdminApi/src/AdminApi/Configuration/QuotasConfiguration.cs
@@ -26,6 +26,9 @@ public class SqlDatabaseConfiguration
             [Required]
             [MinLength(1)]
             public string ConnectionString { get; set; } = string.Empty;
+
+            [Required]
+            public bool EnableHealthCheck { get; set; } = true;
         }
     }
 }
diff --git a/AdminApi/src/AdminApi/Extensions/IServiceCollectionExtensions.cs b/AdminApi/src/AdminApi/Extensions/IServiceCollectionExtensions.cs
@@ -127,6 +127,10 @@ public static IServiceCollection AddCustomAspNetCore(this IServiceCollection ser
             var module = configuration.Modules.GetType().GetProperty(moduleName)!.GetValue(configuration.Modules, null)!;
             var provider = GetPropertyValue(module, "Infrastructure.SqlDatabase.Provider") as string;
             var connectionString = (string)GetPropertyValue(module, "Infrastructure.SqlDatabase.ConnectionString");
+            var enableHealthCheck = Convert.ToBoolean(GetPropertyValue(module, "Infrastructure.SqlDatabase.EnableHealthCheck"));
+
+            if (!enableHealthCheck)
+                continue;
 
             switch (provider)
             {

diff --git a/AdminApi/src/AdminApi/appsettings.json b/AdminApi/src/AdminApi/appsettings.json
@@ -12,12 +12,24 @@
         }
     },
     "Modules": {
+        "Challenges": {
+            "Infrastructure": {
+                "SqlDatabase": {
+                    "EnableHealthCheck": true
+                }
+            }
+        },
         "Quotas": {
             "Application": {
                 "Pagination": {
                     "DefaultPageSize": 50,
                     "MaxPageSize": 200
                 }
+            },
+            "Infrastructure": {
+                "SqlDatabase": {
+                    "EnableHealthCheck": true
+                }
             }
         },
         "Devices": {
@@ -26,6 +38,11 @@
                     "DefaultPageSize": 50,
                     "MaxPageSize": 200
                 }
+            },
+            "Infrastructure": {
+                "SqlDatabase": {
+                    "EnableHealthCheck": true
+                }
             }
         }
     },

diff --git a/ConsumerApi/appsettings.json b/ConsumerApi/appsettings.json
@@ -14,16 +14,30 @@
                 "MinimumBackoff": 2,
                 "MaximumBackoff": 120
             }
+        },
+        "SqlDatabaseConfiguration": {
+            "EnableHealthCheck": true
         }
     },
     "Modules": {
-        "Challenges": {},
+        "Challenges": {
+            "Infrastructure": {
+                "SqlDatabase": {
+                    "EnableHealthCheck": true
+                }
+            }
+        },
         "Quotas": {
             "Application": {
                 "Pagination": {
                     "DefaultPageSize": 50,
                     "MaxPageSize": 200
                 }
+            },
+            "Infrastructure": {
+                "SqlDatabase": {
+                    "EnableHealthCheck": true
+                }
             }
         },
         "Devices": {
@@ -33,6 +47,11 @@
                     "DefaultPageSize": 50,
                     "MaxPageSize": 200
                 }
+            },
+            "Infrastructure": {
+                "SqlDatabase": {
+                    "EnableHealthCheck": true
+                }
             }
         },
         "Files": {
@@ -41,6 +60,11 @@
                     "DefaultPageSize": 50,
                     "MaxPageSize": 200
                 }
+            },
+            "Infrastructure": {
+                "SqlDatabase": {
+                    "EnableHealthCheck": true
+                }
             }
         },
         "Messages": {
@@ -51,6 +75,11 @@
                     "DefaultPageSize": 50,
                     "MaxPageSize": 200
                 }
+            },
+            "Infrastructure": {
+                "SqlDatabase": {
+                    "EnableHealthCheck": true
+                }
             }
         },
         "Relationships": {
@@ -59,6 +88,11 @@
                     "DefaultPageSize": 50,
                     "MaxPageSize": 200
                 }
+            },
+            "Infrastructure": {
+                "SqlDatabase": {
+                    "EnableHealthCheck": true
+                }
             }
         },
         "Synchronization": {
@@ -67,6 +101,11 @@
                     "DefaultPageSize": 50,
                     "MaxPageSize": 200
                 }
+            },
+            "Infrastructure": {
+                "SqlDatabase": {
+                    "EnableHealthCheck": true
+                }
             }
         },
         "Tokens": {
@@ -75,6 +114,11 @@
                     "DefaultPageSize": 50,
                     "MaxPageSize": 200
                 }
+            },
+            "Infrastructure": {
+                "SqlDatabase": {
+                    "EnableHealthCheck": true
+                }
             }
         }
     },

diff --git a/Infrastructure/Infrastructure.csproj b/Infrastructure/Infrastructure.csproj
@@ -5,7 +5,7 @@
         <PackageReference Include="Microsoft.AspNetCore.Http.Abstractions" Version="2.2.0" />
         <PackageReference Include="Newtonsoft.Json" Version="13.0.3" />
         <PackageReference Include="Serilog.AspNetCore" Version="8.0.1" />
-        <PackageReference Include="Serilog" Version="4.0.0"/>
+        <PackageReference Include="Serilog" Version="4.0.0" />
     </ItemGroup>
 
     <ItemGroup>

diff --git a/Modules/Challenges/src/Challenges.ConsumerApi/ChallengesModule.cs b/Modules/Challenges/src/Challenges.ConsumerApi/ChallengesModule.cs
@@ -29,7 +29,10 @@ public override void ConfigureServices(IServiceCollection services, IConfigurati
             dbOptions.DbConnectionString = parsedConfiguration.Infrastructure.SqlDatabase.ConnectionString;
         });
 
-        services.AddSqlDatabaseHealthCheck(Name, parsedConfiguration.Infrastructure.SqlDatabase.Provider, parsedConfiguration.Infrastructure.SqlDatabase.ConnectionString);
+        if (parsedConfiguration.Infrastructure.SqlDatabase.EnableHealthCheck)
+            services.AddSqlDatabaseHealthCheck(Name,
+                parsedConfiguration.Infrastructure.SqlDatabase.Provider,
+                parsedConfiguration.Infrastructure.SqlDatabase.ConnectionString);
     }
 
     public override void ConfigureEventBus(IEventBus eventBus)

diff --git a/Modules/Challenges/src/Challenges.ConsumerApi/Configuration.cs b/Modules/Challenges/src/Challenges.ConsumerApi/Configuration.cs
@@ -27,4 +27,7 @@ public class SqlDatabase
     [Required]
     [MinLength(1)]
     public string ConnectionString { get; set; } = null!;
+
+    [Required]
+    public bool EnableHealthCheck { get; set; } = true;
 }
diff --git a/Modules/Devices/src/Devices.ConsumerApi/Configuration.cs b/Modules/Devices/src/Devices.ConsumerApi/Configuration.cs
@@ -30,6 +30,9 @@ public class SqlDatabaseConfiguration
             [Required]
             [MinLength(1)]
             public string ConnectionString { get; set; } = string.Empty;
+
+            [Required]
+            public bool EnableHealthCheck { get; set; } = true;
         }
 
     }

diff --git a/Modules/Devices/src/Devices.ConsumerApi/DevicesModule.cs b/Modules/Devices/src/Devices.ConsumerApi/DevicesModule.cs
@@ -36,7 +36,10 @@ public override void ConfigureServices(IServiceCollection services, IConfigurati
 
         services.AddSingleton<ISignatureHelper, SignatureHelper>(_ => SignatureHelper.CreateEd25519WithRawKeyFormat());
 
-        services.AddSqlDatabaseHealthCheck(Name, parsedConfiguration.Infrastructure.SqlDatabase.Provider, parsedConfiguration.Infrastructure.SqlDatabase.ConnectionString);
+        if (parsedConfiguration.Infrastructure.SqlDatabase.EnableHealthCheck)
+            services.AddSqlDatabaseHealthCheck(Name,
+                parsedConfiguration.Infrastructure.SqlDatabase.Provider,
+                parsedConfiguration.Infrastructure.SqlDatabase.ConnectionString);
     }
 
     public override void ConfigureEventBus(IEventBus eventBus)

diff --git a/Modules/Files/src/Files.ConsumerApi/Configuration.cs b/Modules/Files/src/Files.ConsumerApi/Configuration.cs
@@ -41,6 +41,9 @@ public class SqlDatabaseConfiguration
             [Required]
             [MinLength(1)]
             public string ConnectionString { get; set; } = string.Empty;
+
+            [Required]
+            public bool EnableHealthCheck { get; set; } = true;
         }
     }
 }
diff --git a/Modules/Files/src/Files.ConsumerApi/FilesModule.cs b/Modules/Files/src/Files.ConsumerApi/FilesModule.cs
@@ -37,7 +37,10 @@ public override void ConfigureServices(IServiceCollection services, IConfigurati
                     : parsedConfiguration.Infrastructure.BlobStorage.ContainerName;
         });
 
-        services.AddSqlDatabaseHealthCheck(Name, parsedConfiguration.Infrastructure.SqlDatabase.Provider, parsedConfiguration.Infrastructure.SqlDatabase.ConnectionString);
+        if (parsedConfiguration.Infrastructure.SqlDatabase.EnableHealthCheck)
+            services.AddSqlDatabaseHealthCheck(Name,
+                parsedConfiguration.Infrastructure.SqlDatabase.Provider,
+                parsedConfiguration.Infrastructure.SqlDatabase.ConnectionString);
     }
 
     public override void ConfigureEventBus(IEventBus eventBus)

diff --git a/Modules/Messages/src/Messages.ConsumerApi/Configuration.cs b/Modules/Messages/src/Messages.ConsumerApi/Configuration.cs
@@ -26,6 +26,9 @@ public class SqlDatabaseConfiguration
             [Required]
             [MinLength(1)]
             public string ConnectionString { get; set; } = string.Empty;
+
+            [Required]
+            public bool EnableHealthCheck { get; set; } = true;
         }
     }
 }
diff --git a/Modules/Messages/src/Messages.ConsumerApi/MessagesModule.cs b/Modules/Messages/src/Messages.ConsumerApi/MessagesModule.cs
@@ -29,7 +29,10 @@ public override void ConfigureServices(IServiceCollection services, IConfigurati
 
         services.AddApplication();
 
-        services.AddSqlDatabaseHealthCheck(Name, parsedConfiguration.Infrastructure.SqlDatabase.Provider, parsedConfiguration.Infrastructure.SqlDatabase.ConnectionString);
+        if (parsedConfiguration.Infrastructure.SqlDatabase.EnableHealthCheck)
+            services.AddSqlDatabaseHealthCheck(Name,
+                parsedConfiguration.Infrastructure.SqlDatabase.Provider,
+                parsedConfiguration.Infrastructure.SqlDatabase.ConnectionString);
     }
 
     public override void ConfigureEventBus(IEventBus eventBus)

diff --git a/Modules/Quotas/src/Quotas.ConsumerApi/Configuration.cs b/Modules/Quotas/src/Quotas.ConsumerApi/Configuration.cs
@@ -24,4 +24,7 @@ public class SqlDatabaseConfiguration
     [Required]
     [MinLength(1)]
     public string ConnectionString { get; set; } = string.Empty;
+
+    [Required]
+    public bool EnableHealthCheck { get; set; } = true;
 }
diff --git a/Modules/Quotas/src/Quotas.ConsumerApi/QuotasModule.cs b/Modules/Quotas/src/Quotas.ConsumerApi/QuotasModule.cs
@@ -29,7 +29,10 @@ public override void ConfigureServices(IServiceCollection services, IConfigurati
             dbOptions.DbConnectionString = parsedConfiguration.Infrastructure.SqlDatabase.ConnectionString;
         });
 
-        services.AddSqlDatabaseHealthCheck(Name, parsedConfiguration.Infrastructure.SqlDatabase.Provider, parsedConfiguration.Infrastructure.SqlDatabase.ConnectionString);
+        if (parsedConfiguration.Infrastructure.SqlDatabase.EnableHealthCheck)
+            services.AddSqlDatabaseHealthCheck(Name,
+                parsedConfiguration.Infrastructure.SqlDatabase.Provider,
+                parsedConfiguration.Infrastructure.SqlDatabase.ConnectionString);
 
         services.AddResponseCaching();
     }

diff --git a/Modules/Relationships/src/Relationships.ConsumerApi/Configuration.cs b/Modules/Relationships/src/Relationships.ConsumerApi/Configuration.cs
@@ -26,6 +26,9 @@ public class SqlDatabaseConfiguration
             [Required]
             [MinLength(1)]
             public string ConnectionString { get; set; } = string.Empty;
+
+            [Required]
+            public bool EnableHealthCheck { get; set; } = true;
         }
     }
 }
diff --git a/Modules/Relationships/src/Relationships.ConsumerApi/RelationshipsModule.cs b/Modules/Relationships/src/Relationships.ConsumerApi/RelationshipsModule.cs
@@ -29,7 +29,10 @@ public override void ConfigureServices(IServiceCollection services, IConfigurati
             options.DbOptions.DbConnectionString = parsedConfiguration.Infrastructure.SqlDatabase.ConnectionString;
         });
 
-        services.AddSqlDatabaseHealthCheck(Name, parsedConfiguration.Infrastructure.SqlDatabase.Provider, parsedConfiguration.Infrastructure.SqlDatabase.ConnectionString);
+        if (parsedConfiguration.Infrastructure.SqlDatabase.EnableHealthCheck)
+            services.AddSqlDatabaseHealthCheck(Name,
+                parsedConfiguration.Infrastructure.SqlDatabase.Provider,
+                parsedConfiguration.Infrastructure.SqlDatabase.ConnectionString);
     }
 
     public override void ConfigureEventBus(IEventBus eventBus)

diff --git a/Modules/Synchronization/src/Synchronization.ConsumerApi/Configuration.cs b/Modules/Synchronization/src/Synchronization.ConsumerApi/Configuration.cs
@@ -26,6 +26,9 @@ public class SqlDatabaseConfiguration
             [Required]
             [MinLength(1)]
             public string ConnectionString { get; set; } = string.Empty;
+
+            [Required]
+            public bool EnableHealthCheck { get; set; } = true;
         }
     }
 }
diff --git a/Modules/Synchronization/src/Synchronization.ConsumerApi/SynchronizationModule.cs b/Modules/Synchronization/src/Synchronization.ConsumerApi/SynchronizationModule.cs
@@ -29,7 +29,10 @@ public override void ConfigureServices(IServiceCollection services, IConfigurati
 
         services.AddApplication();
 
-        services.AddSqlDatabaseHealthCheck(Name, parsedConfiguration.Infrastructure.SqlDatabase.Provider, parsedConfiguration.Infrastructure.SqlDatabase.ConnectionString);
+        if (parsedConfiguration.Infrastructure.SqlDatabase.EnableHealthCheck)
+            services.AddSqlDatabaseHealthCheck(Name,
+                parsedConfiguration.Infrastructure.SqlDatabase.Provider,
+                parsedConfiguration.Infrastructure.SqlDatabase.ConnectionString);
     }
 
     public override void ConfigureEventBus(IEventBus eventBus)

diff --git a/Modules/Tokens/src/Tokens.ConsumerApi/Configuration.cs b/Modules/Tokens/src/Tokens.ConsumerApi/Configuration.cs
@@ -26,6 +26,9 @@ public class SqlDatabaseConfiguration
             [Required]
             [MinLength(1)]
             public string ConnectionString { get; set; } = string.Empty;
+
+            [Required]
+            public bool EnableHealthCheck { get; set; } = true;
         }
     }
 }
diff --git a/Modules/Tokens/src/Tokens.ConsumerApi/TokensModule.cs b/Modules/Tokens/src/Tokens.ConsumerApi/TokensModule.cs
@@ -29,7 +29,10 @@ public override void ConfigureServices(IServiceCollection services, IConfigurati
 
         services.AddApplication();
 
-        services.AddSqlDatabaseHealthCheck(Name, parsedConfiguration.Infrastructure.SqlDatabase.Provider, parsedConfiguration.Infrastructure.SqlDatabase.ConnectionString);
+        if (parsedConfiguration.Infrastructure.SqlDatabase.EnableHealthCheck)
+            services.AddSqlDatabaseHealthCheck(Name,
+                parsedConfiguration.Infrastructure.SqlDatabase.Provider,
+                parsedConfiguration.Infrastructure.SqlDatabase.ConnectionString);
     }
 
     public override void ConfigureEventBus(IEventBus eventBus)

diff --git a/SseServer/src/SseServer/Program.cs b/SseServer/src/SseServer/Program.cs
@@ -148,6 +148,7 @@ static void Configure(WebApplication app)
     app.UseAuthentication().UseAuthorization();
 
     app.MapControllers();
+
     app.MapHealthChecks("/health", new HealthCheckOptions
     {
         ResponseWriter = HealthCheckWriter.WriteResponse

diff --git a/SseServer/src/SseServer/appsettings.json b/SseServer/src/SseServer/appsettings.json
@@ -12,6 +12,11 @@
                     "DefaultPageSize": 50,
                     "MaxPageSize": 200
                 }
+            },
+            "Infrastructure": {
+                "SqlDatabase": {
+                    "EnableHealthCheck": true
+                }
             }
         }
     },