Skip to content

DB tables schema in health checks #241

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

DB tables schema in health checks #241

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions src/Skoruba.Duende.IdentityServer.Admin.EntityFramework/Helpers/DbContextHelpers.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,5 +31,28 @@ public static string GetEntityTable<TDbContext>(IServiceProvider serviceProvider

return null;
}

/// <summary>
/// Get the table schema of an entity in the given DbContext
/// </summary>
/// <typeparam name="TDbContext"></typeparam>
/// <param name="serviceProvider"></param>
/// <param name="entityTypeName">If specified, the full name of the type of the entity.
/// Otherwise, the first entity in the DbContext will be retrieved</param>
/// <param name="systemDefaultSchemaName">The default schema name of the RDBMS, for example `dbo` for SQL Server</param>
/// <returns></returns>
public static string GetEntityTableSchema<TDbContext>(IServiceProvider serviceProvider, string entityTypeName = null, string systemDefaultSchemaName = null)
where TDbContext : DbContext
{
var db = serviceProvider.GetService<TDbContext>();
if (db != null)
{
var entityType = entityTypeName != null ? db.Model.FindEntityType(entityTypeName) : db.Model.GetEntityTypes().OrderBy(x => x.Name).FirstOrDefault();
if (entityType != null)
return entityType.GetSchema() ?? entityType.GetDefaultSchema() ?? systemDefaultSchemaName;
}

return null;
}
}
}
19 changes: 13 additions & 6 deletions src/Skoruba.Duende.IdentityServer.Admin.UI.Api/Helpers/StartupHelpers.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -312,19 +312,26 @@ public static void AddIdSHealthChecks<TConfigurationDbContext, TPersistedGrantDb
switch (databaseProvider.ProviderType)
{
case DatabaseProviderType.SqlServer:
const string defaultSchemaName = "dbo";
var configurationTableSchema = DbContextHelpers.GetEntityTableSchema<TConfigurationDbContext>(scope.ServiceProvider, systemDefaultSchemaName: defaultSchemaName);
var persistedGrantTableSchema = DbContextHelpers.GetEntityTableSchema<TPersistedGrantDbContext>(scope.ServiceProvider, systemDefaultSchemaName: defaultSchemaName);
var identityTableSchema = DbContextHelpers.GetEntityTableSchema<TIdentityDbContext>(scope.ServiceProvider, systemDefaultSchemaName: defaultSchemaName);
var logTableSchema = DbContextHelpers.GetEntityTableSchema<TLogDbContext>(scope.ServiceProvider, systemDefaultSchemaName: defaultSchemaName);
var auditLogTableSchema = DbContextHelpers.GetEntityTableSchema<TAuditLoggingDbContext>(scope.ServiceProvider, systemDefaultSchemaName: defaultSchemaName);
var dataProtectionTableSchema = DbContextHelpers.GetEntityTableSchema<TDataProtectionDbContext>(scope.ServiceProvider, systemDefaultSchemaName: defaultSchemaName);
healthChecksBuilder
.AddSqlServer(configurationDbConnectionString, name: "ConfigurationDb",
healthQuery: $"SELECT TOP 1 * FROM dbo.[{configurationTableName}]")
healthQuery: $"SELECT TOP 1 * FROM [{configurationTableSchema}].[{configurationTableName}]")
.AddSqlServer(persistedGrantsDbConnectionString, name: "PersistentGrantsDb",
healthQuery: $"SELECT TOP 1 * FROM dbo.[{persistedGrantTableName}]")
healthQuery: $"SELECT TOP 1 * FROM [{persistedGrantTableSchema}].[{persistedGrantTableName}]")
.AddSqlServer(identityDbConnectionString, name: "IdentityDb",
healthQuery: $"SELECT TOP 1 * FROM dbo.[{identityTableName}]")
healthQuery: $"SELECT TOP 1 * FROM [{identityTableSchema}].[{identityTableName}]")
.AddSqlServer(logDbConnectionString, name: "LogDb",
healthQuery: $"SELECT TOP 1 * FROM dbo.[{logTableName}]")
healthQuery: $"SELECT TOP 1 * FROM [{logTableSchema}].[{logTableName}]")
.AddSqlServer(auditLogDbConnectionString, name: "AuditLogDb",
healthQuery: $"SELECT TOP 1 * FROM dbo.[{auditLogTableName}]")
healthQuery: $"SELECT TOP 1 * FROM [{auditLogTableSchema}].[{auditLogTableName}]")
.AddSqlServer(dataProtectionDbConnectionString, name: "DataProtectionDb",
healthQuery: $"SELECT TOP 1 * FROM dbo.[{dataProtectionTableName}]");
healthQuery: $"SELECT TOP 1 * FROM [{dataProtectionTableSchema}].[{dataProtectionTableName}]");
break;
case DatabaseProviderType.PostgreSQL:
healthChecksBuilder
Expand Down
19 changes: 13 additions & 6 deletions src/Skoruba.Duende.IdentityServer.Admin.UI/Helpers/StartupHelpers.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -473,19 +473,26 @@ private static Task OnRedirectToIdentityProvider(RedirectContext context, AdminC
switch (databaseProviderConfiguration.ProviderType)
{
case DatabaseProviderType.SqlServer:
const string defaultSchemaName = "dbo";
var configurationTableSchema = DbContextHelpers.GetEntityTableSchema<TConfigurationDbContext>(scope.ServiceProvider, systemDefaultSchemaName: defaultSchemaName);
var persistedGrantTableSchema = DbContextHelpers.GetEntityTableSchema<TPersistedGrantDbContext>(scope.ServiceProvider, systemDefaultSchemaName: defaultSchemaName);
var identityTableSchema = DbContextHelpers.GetEntityTableSchema<TIdentityDbContext>(scope.ServiceProvider, systemDefaultSchemaName: defaultSchemaName);
var logTableSchema = DbContextHelpers.GetEntityTableSchema<TLogDbContext>(scope.ServiceProvider, systemDefaultSchemaName: defaultSchemaName);
var auditLogTableSchema = DbContextHelpers.GetEntityTableSchema<TAuditLoggingDbContext>(scope.ServiceProvider, systemDefaultSchemaName: defaultSchemaName);
var dataProtectionTableSchema = DbContextHelpers.GetEntityTableSchema<TDataProtectionDbContext>(scope.ServiceProvider, systemDefaultSchemaName: defaultSchemaName);
healthChecksBuilder
.AddSqlServer(configurationDbConnectionString, name: "ConfigurationDb",
healthQuery: $"SELECT TOP 1 * FROM dbo.[{configurationTableName}]")
healthQuery: $"SELECT TOP 1 * FROM [{configurationTableSchema}].[{configurationTableName}]")
.AddSqlServer(persistedGrantsDbConnectionString, name: "PersistentGrantsDb",
healthQuery: $"SELECT TOP 1 * FROM dbo.[{persistedGrantTableName}]")
healthQuery: $"SELECT TOP 1 * FROM [{persistedGrantTableSchema}].[{persistedGrantTableName}]")
.AddSqlServer(identityDbConnectionString, name: "IdentityDb",
healthQuery: $"SELECT TOP 1 * FROM dbo.[{identityTableName}]")
healthQuery: $"SELECT TOP 1 * FROM [{identityTableSchema}].[{identityTableName}]")
.AddSqlServer(logDbConnectionString, name: "LogDb",
healthQuery: $"SELECT TOP 1 * FROM dbo.[{logTableName}]")
healthQuery: $"SELECT TOP 1 * FROM [{logTableSchema}].[{logTableName}]")
.AddSqlServer(auditLogDbConnectionString, name: "AuditLogDb",
healthQuery: $"SELECT TOP 1 * FROM dbo.[{auditLogTableName}]")
healthQuery: $"SELECT TOP 1 * FROM [{auditLogTableSchema}].[{auditLogTableName}]")
.AddSqlServer(dataProtectionDbConnectionString, name: "DataProtectionDb",
healthQuery: $"SELECT TOP 1 * FROM dbo.[{dataProtectionTableName}]");
healthQuery: $"SELECT TOP 1 * FROM [{dataProtectionTableSchema}].[{dataProtectionTableName}]");
break;
case DatabaseProviderType.PostgreSQL:
healthChecksBuilder
Expand Down
13 changes: 9 additions & 4 deletions src/Skoruba.Duende.IdentityServer.STS.Identity/Helpers/StartupHelpers.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -479,15 +479,20 @@ public static void AddIdSHealthChecks<TConfigurationDbContext, TPersistedGrantDb
switch (databaseProvider.ProviderType)
{
case DatabaseProviderType.SqlServer:
const string defaultSchemaName = "dbo";
var configurationTableSchema = DbContextHelpers.GetEntityTableSchema<TConfigurationDbContext>(scope.ServiceProvider, systemDefaultSchemaName: defaultSchemaName);
var persistedGrantTableSchema = DbContextHelpers.GetEntityTableSchema<TPersistedGrantDbContext>(scope.ServiceProvider, systemDefaultSchemaName: defaultSchemaName);
var identityTableSchema = DbContextHelpers.GetEntityTableSchema<TIdentityDbContext>(scope.ServiceProvider, systemDefaultSchemaName: defaultSchemaName);
var dataProtectionTableSchema = DbContextHelpers.GetEntityTableSchema<TDataProtectionDbContext>(scope.ServiceProvider, systemDefaultSchemaName: defaultSchemaName);
healthChecksBuilder
.AddSqlServer(configurationDbConnectionString, name: "ConfigurationDb",
healthQuery: $"SELECT TOP 1 * FROM dbo.[{configurationTableName}]")
healthQuery: $"SELECT TOP 1 * FROM [{configurationTableSchema}].[{configurationTableName}]")
.AddSqlServer(persistedGrantsDbConnectionString, name: "PersistentGrantsDb",
healthQuery: $"SELECT TOP 1 * FROM dbo.[{persistedGrantTableName}]")
healthQuery: $"SELECT TOP 1 * FROM [{persistedGrantTableSchema}].[{persistedGrantTableName}]")
.AddSqlServer(identityDbConnectionString, name: "IdentityDb",
healthQuery: $"SELECT TOP 1 * FROM dbo.[{identityTableName}]")
healthQuery: $"SELECT TOP 1 * FROM [{identityTableSchema}].[{identityTableName}]")
.AddSqlServer(dataProtectionDbConnectionString, name: "DataProtectionDb",
healthQuery: $"SELECT TOP 1 * FROM dbo.[{dataProtectionTableName}]");
healthQuery: $"SELECT TOP 1 * FROM [{dataProtectionTableSchema}].[{dataProtectionTableName}]");

break;
case DatabaseProviderType.PostgreSQL:
Expand Down