Merge pull request #762 from PHOENIXCONTACT/remove/dump-restore-model

Removed support of dump and restore of data-models

Author: dbeuchler

docs/migrations/v8_to_v10.md

@@ -35,6 +35,7 @@ With MORYX 10, several changes have been made to the data model to improve perfo
 
 - Naming conventions across the data model have been standardized to ensure consistency and clarity. We use pluralised names for DbSet properties and singular names for entity classes. Sample: `public DbSet<ProductEntity> Products { get; set; }` instead of `public DbSet<ProductEntity> ProductEntities { get; set; }`.
 - Derived data models are now fully supported. This needs some changes how the model is defined in code first scenarios. Please refer to the [Data Model Tutorial](/docs/tutorials/data-model/CodeFirst.md) for more information.
+- Removed support of Dump and Restore operations in the data model. These operations were rarely used and added unnecessary complexity to the data model management. Use your database admin tools to perform backup and restore operations instead.
 
 ### Removal of ProductFileEntity
 

src/Moryx.CommandCenter.Web/src/databases/api/DatabasesRestClient.ts

@@ -9,7 +9,6 @@ import DatabaseConfigModel from "../models/DatabaseConfigModel";
 import DatabasesResponse from "../models/DatabasesResponse";
 import DataModel from "../models/DataModel";
 import ExecuteSetupRequest from "./requests/ExecuteSetupRequest";
-import RestoreDatabaseRequest from "./requests/RestoreDatabaseRequest";
 import DatabaseUpdateSummary from "./responses/DatabaseUpdateSummary";
 import TestConnectionResponse from "./responses/TestConnectionResponse";
 
@@ -45,14 +44,6 @@ export default class DatabasesRestClient extends RestClientBase {
         return this.delete<DatabaseConfigModel, InvocationResponse>(DatabasesRestClient.pathTo(targetModel), request, new InvocationResponse());
     }
 
-    public dumpDatabase(request: DatabaseConfigModel, targetModel: string): Promise<InvocationResponse> {
-        return this.post<DatabaseConfigModel, InvocationResponse>(DatabasesRestClient.pathTo(targetModel, "/dump"), request, new InvocationResponse());
-    }
-
-    public restoreDatabase(request: RestoreDatabaseRequest, targetModel: string): Promise<InvocationResponse> {
-        return this.post<RestoreDatabaseRequest, InvocationResponse>(DatabasesRestClient.pathTo(targetModel, "/restore"), request, new InvocationResponse());
-    }
-
     public applyMigration(targetModel: string, migrationName: string, request: DatabaseConfigModel): Promise<DatabaseUpdateSummary> {
         return this.post<DatabaseConfigModel, DatabaseUpdateSummary>(DatabasesRestClient.pathTo(targetModel, `/migrate`), request, new DatabaseUpdateSummary());
     }

src/Moryx.CommandCenter.Web/src/databases/api/requests/RestoreDatabaseRequest.ts

@@ -46,7 +46,6 @@ interface DatabaseModelStateModel {
     activeTab: number;
     config: DatabaseConfigModel;
     targetModel: string;
-    selectedBackup: string;
     testConnectionPending: boolean;
     testConnectionResult: TestConnectionResult;
 }
@@ -72,7 +71,6 @@ class DatabaseModel extends React.Component<DatabaseModelPropsModel & DatabaseMo
             activeTab: 1,
             config: this.getConfigValue(),
             targetModel: props.DataModel.targetModel,
-            selectedBackup : (props.DataModel.backups.length !== 0 ? props.DataModel.backups[0].fileName : ""),
             testConnectionPending : false,
             testConnectionResult : TestConnectionResult.ConfigurationError,
         };
@@ -126,10 +124,6 @@ class DatabaseModel extends React.Component<DatabaseModelPropsModel & DatabaseMo
         this.setState({ config });
     }
 
-    public onSelectBackup(e: React.ChangeEvent<HTMLInputElement>): void {
-        this.setState({ selectedBackup: e.target.value });
-    }
-
     private createEntriesInput(): React.JSX.Element[] {
         return Object.keys(this.state.config.entries)?.map((element) => {
             return (
@@ -240,32 +234,6 @@ class DatabaseModel extends React.Component<DatabaseModelPropsModel & DatabaseMo
         }).catch((d) => this.props.onShowWaitDialog(false));
     }
 
-    public onExecuteDump(): void {
-        this.props.onShowWaitDialog(true);
-
-        this.props.RestClient.dumpDatabase(this.createConfigModel(), this.props.DataModel.targetModel).then((data) => {
-            this.props.onShowWaitDialog(false);
-            if (data.success) {
-                toast.success("Database dump started successfully. Please refer to the log to get information about the progress.", { autoClose: 5000 });
-            } else {
-                toast.error("Dump start failed: " + data.errorMessage, { autoClose: 5000 });
-            }
-        }).catch((d) => this.props.onShowWaitDialog(false));
-    }
-
-    public onExecuteRestore(): void {
-        this.props.onShowWaitDialog(true);
-
-        this.props.RestClient.restoreDatabase({ Config: this.createConfigModel(), BackupFileName: this.props.DataModel.targetModel }, this.state.targetModel).then((data) => {
-            this.props.onShowWaitDialog(false);
-            if (data.success) {
-                toast.success("Database restore started successfully. Please refer to the log to get information about the progress.", { autoClose: 5000 });
-            } else {
-                toast.error("Restore start failed: " + data.errorMessage, { autoClose: 5000 });
-            }
-        }).catch((d) => this.props.onShowWaitDialog(false));
-    }
-
     public onApplyMigration(migration: string): void {
         this.props.onShowWaitDialog(true);
 
@@ -380,40 +348,6 @@ class DatabaseModel extends React.Component<DatabaseModelPropsModel & DatabaseMo
                                 <Button color="primary" variant="outlined" onClick={() => this.onSave()}>Save</Button>
                             </GridLegacy>
                         </DatabaseSection>
-                        <DatabaseSection title="Backup &amp; Restore">
-                            <GridLegacy item={true} md={12}>
-                                <Stack>
-                                    <TextField
-                                        label="Backup"
-                                        size="small"
-                                        margin="dense"
-                                        disabled={this.props.DataModel.backups.length === 0 }
-                                        variant="outlined"
-                                        select={true}
-                                        onChange={(e: React.ChangeEvent<HTMLInputElement>) => this.onSelectBackup(e)}>
-                                        {
-                                            this.props.DataModel.backups.map((backup, idx) => {
-                                                return (<MenuItem key={idx} value={backup.fileName}>{backup.fileName + " (Size: " + kbToString(backup.size * 1024) + ", Created on: " + moment(backup.creationDate).format("YYYY-MM-DD HH:mm:ss") + ")"}</MenuItem>);
-                                            })
-                                        }
-                                    </TextField>
-                                </Stack>
-                            </GridLegacy>
-                            <GridLegacy item={true} md={12}>
-                                <ButtonGroup>
-                                    <Button color="primary"
-                                        disabled={this.state.testConnectionResult !== TestConnectionResult.Success && this.state.testConnectionResult !== TestConnectionResult.PendingMigrations}
-                                        onClick={this.onExecuteDump.bind(this)}>
-                                        Create a backup
-                                    </Button>
-                                    <Button color="primary"
-                                        disabled={this.state.selectedBackup === "" || (this.state.testConnectionResult !== TestConnectionResult.Success && this.state.testConnectionResult !== TestConnectionResult.PendingMigrations)}
-                                        onClick={this.onExecuteRestore.bind(this)}>
-                                        Restore selected backup
-                                    </Button>
-                                </ButtonGroup>
-                            </GridLegacy>
-                        </DatabaseSection>
                         <DatabaseSection title="Database">
                             <GridLegacy item={true} md={12}>
                                 <ButtonGroup>

src/Moryx.CommandCenter.Web/src/databases/container/DatabaseModel.tsx

@@ -2,7 +2,6 @@
  * Copyright (c) 2020, Phoenix Contact GmbH & Co. KG
  * Licensed under the Apache License, Version 2.0
 */
-import BackupModel from "./BackupModel";
 import DatabaseConfigModel from "./DatabaseConfigModel";
 import DatabaseConfigOptionModel from "./DatabaseConfigOptionModel";
 import DbMigrationsModel from "./DbMigrationsModel";
@@ -12,7 +11,6 @@ export default class DataModel {
     public targetModel: string;
     public config: DatabaseConfigModel;
     public setups: SetupModel[];
-    public backups: BackupModel[];
     public availableMigrations: DbMigrationsModel[];
     public appliedMigrations: DbMigrationsModel[];
     public possibleConfigurators: DatabaseConfigOptionModel[];

src/Moryx.CommandCenter.Web/src/databases/models/BackupModel.ts

@@ -54,30 +54,6 @@ public override async Task DeleteDatabase(IDatabaseConfig config)
             await connection.CloseAsync();
         }
 
-        /// <inheritdoc />
-        public override Task DumpDatabase(IDatabaseConfig config, string targetPath)
-        {
-            var connectionString = CreateConnectionStringBuilder(config);
-
-            var dumpName = $"{DateTime.Now:dd-MM-yyyy-hh-mm-ss}_{connectionString.Database}.backup";
-            var fileName = Path.Combine(targetPath, dumpName);
-
-            Logger.Log(LogLevel.Debug, "Starting to dump database with pg_dump to: {0}", fileName);
-
-            // Create process
-            var arguments = $"-U {connectionString.Username} --format=c --file={fileName} " +
-                            $"-h {connectionString.Host} -p {connectionString.Port} {connectionString.Database}";
-
-            var process = CreateBackgroundPgProcess("pg_dump.exe", arguments, connectionString.Password);
-
-            // Configure the process using the StartInfo properties.
-            process.Start();
-            process.BeginOutputReadLine();
-            process.BeginErrorReadLine();
-
-            return Task.CompletedTask;
-        }
-
         private static NpgsqlConnectionStringBuilder CreateConnectionStringBuilder(IDatabaseConfig config, bool includeModel = true)
         {
             var builder = new NpgsqlConnectionStringBuilder(config.ConnectionSettings.ConnectionString);
@@ -125,26 +101,6 @@ public override Task<TestConnectionResult> TestConnection(IDatabaseConfig config
             return base.TestConnection(CreateTestDatabaseConfig(config));
         }
 
-        /// <inheritdoc />
-        public override Task RestoreDatabase(IDatabaseConfig config, string filePath)
-        {
-            Logger.Log(LogLevel.Debug, "Starting to restore database with pg_restore from: {0}", filePath);
-            var connectionString = CreateConnectionStringBuilder(config);
-
-            // Create process
-            var arguments = $"-U {connectionString.Username} --format=c --single-transaction --clean " +
-                            $"-h {connectionString.Host} -p {connectionString.Port} -d {connectionString.Database} {filePath}";
-
-            var process = CreateBackgroundPgProcess("pg_restore.exe", arguments, connectionString.Password);
-
-            // Configure the process using the StartInfo properties.
-            process.Start();
-            process.BeginOutputReadLine();
-            process.BeginErrorReadLine();
-
-            return Task.CompletedTask;
-        }
-
         /// <inheritdoc />
         public override DbContextOptions BuildDbContextOptions(IDatabaseConfig config)
         {
@@ -162,54 +118,6 @@ private static string BuildConnectionString(IDatabaseConfig config, bool include
             return builder.ToString();
         }
 
-        private Process CreateBackgroundPgProcess(string fileName, string arguments, string pgPassword)
-        {
-            var process = new Process { EnableRaisingEvents = true };
-            process.Exited += OnProcessCompleted;
-
-            var startInfo = process.StartInfo;
-            startInfo.UseShellExecute = false;
-            startInfo.RedirectStandardOutput = true;
-            startInfo.RedirectStandardError = true;
-            process.StartInfo.EnvironmentVariables["PGPASSWORD"] = pgPassword;
-
-            startInfo.FileName = fileName;
-            startInfo.Arguments = arguments;
-
-            process.OutputDataReceived += OnProcessOutputDataReceived;
-            process.ErrorDataReceived += OnProcessOutputDataReceived;
-
-            return process;
-        }
-
-        private void OnProcessCompleted(object sender, EventArgs eventArgs)
-        {
-            var process = (Process)sender;
-            process.Exited -= OnProcessCompleted;
-
-            process.CancelOutputRead();
-            process.CancelErrorRead();
-            process.OutputDataReceived -= OnProcessOutputDataReceived;
-            process.ErrorDataReceived -= OnProcessOutputDataReceived;
-
-            if (process.ExitCode != 0)
-            {
-                Logger.Log(LogLevel.Error, "Error while running process {0}, ExitCode: {1}!",
-                    process.Id, process.ExitCode);
-            }
-            else
-            {
-                Logger.Log(LogLevel.Debug, "Process {0} exited successfully!",
-                    process.Id);
-            }
-        }
-
-        private void OnProcessOutputDataReceived(object sender, DataReceivedEventArgs args)
-        {
-            var process = (Process)sender;
-            Logger.Log(LogLevel.Debug, "Process: {0}: {1}", process.Id, args.Data);
-        }
-
         /// <inheritdoc />
         protected override DbContext CreateMigrationContext(IDatabaseConfig config)
         {

src/Moryx.CommandCenter.Web/src/databases/models/DataModel.ts

@@ -53,28 +53,6 @@ public override async Task DeleteDatabase(IDatabaseConfig config)
         await command.ExecuteNonQueryAsync();
     }
 
-    /// <inheritdoc />
-    public override async Task DumpDatabase(IDatabaseConfig config, string targetPath)
-    {
-        if (!IsValidBackupFilePath(targetPath))
-            throw new ArgumentException("Invalid backup file path.");
-
-        var connectionString = CreateConnectionStringBuilder(config);
-
-        var dumpName = $"{DateTime.Now:dd-MM-yyyy-hh-mm-ss}_{connectionString.InitialCatalog}.bak";
-        var fileName = Path.Combine(targetPath, dumpName);
-
-        await using var connection = new SqlConnection(BuildConnectionString(config, false));
-        await using var command =
-            CreateCommand($"BACKUP DATABASE [{connectionString.InitialCatalog}] TO DISK = N'{fileName}' WITH INIT",
-                connection);
-
-        Logger.Log(LogLevel.Debug, "Starting to dump database with 'BACKUP DATABASE' to: {fileName}", fileName);
-
-        await connection.OpenAsync();
-        await command.ExecuteNonQueryAsync();
-    }
-
     private static SqlConnectionStringBuilder CreateConnectionStringBuilder(IDatabaseConfig config, bool includeModel = true)
     {
         var builder = new SqlConnectionStringBuilder(config.ConnectionSettings.ConnectionString)
@@ -85,24 +63,6 @@ private static SqlConnectionStringBuilder CreateConnectionStringBuilder(IDatabas
         return builder;
     }
 
-    /// <inheritdoc />
-    public override async Task RestoreDatabase(IDatabaseConfig config, string filePath)
-    {
-        if (!IsValidBackupFilePath(filePath))
-            throw new ArgumentException("Invalid backup file path.");
-
-        var connectionString = CreateConnectionStringBuilder(config);
-
-        await using var connection = new SqlConnection(BuildConnectionString(config, false));
-        await using var command = CreateCommand($"RESTORE DATABASE [{connectionString.InitialCatalog}] FROM DISK = N'{filePath}' WITH REPLACE",
-                connection);
-
-        Logger.Log(LogLevel.Debug, "Starting to restore database with 'RESTORE DATABASE' from: {filePath}", filePath);
-
-        await connection.OpenAsync();
-        await command.ExecuteNonQueryAsync();
-    }
-
     /// <inheritdoc />
     public override DbContextOptions BuildDbContextOptions(IDatabaseConfig config)
     {
@@ -145,11 +105,4 @@ private static bool IsValidDatabaseName(string dbName)
         // Only allow letters, numbers, and underscores
         return Regex.IsMatch(dbName, @"^[A-Za-z0-9_]+$");
     }
-
-    private static bool IsValidBackupFilePath(string filePath)
-    {
-        // Disallow dangerous characters
-        var invalidStrings = new[] { ";", "'", "\"", "--" };
-        return invalidStrings.All(s => !filePath.Contains(s));
-    }
 }

src/Moryx.Model.PostgreSQL/NpgsqlModelConfigurator.cs

@@ -45,18 +45,6 @@ public override Task DeleteDatabase(IDatabaseConfig config)
             return Task.CompletedTask;
         }
 
-        /// <inheritdoc />
-        public override Task DumpDatabase(IDatabaseConfig config, string targetPath)
-        {
-            throw new NotSupportedException();
-        }
-
-        /// <inheritdoc />
-        public override Task RestoreDatabase(IDatabaseConfig config, string filePath)
-        {
-            throw new NotSupportedException();
-        }
-
         /// <inheritdoc />
         public override DbContextOptions BuildDbContextOptions(IDatabaseConfig config)
         {

src/Moryx.Model.SqlServer/SqlServerModelConfigurator.cs

@@ -230,12 +230,6 @@ public async Task<IReadOnlyList<string>> AppliedMigrations(DbContext context)
         /// <inheritdoc />
         public abstract Task DeleteDatabase(IDatabaseConfig config);
 
-        /// <inheritdoc />
-        public abstract Task DumpDatabase(IDatabaseConfig config, string targetPath);
-
-        /// <inheritdoc />
-        public abstract Task RestoreDatabase(IDatabaseConfig config, string filePath);
-
         /// <summary>
         /// Generally tests the connection to the database
         /// </summary>