Merge branch '373-apply-restore-config' into 'master'

fix: apply the configuration and then start Postgres on the restore stage (#373)

Closes #373

See merge request postgres-ai/database-lab!572

Author: agneum

engine/internal/retrieval/engine/postgres/logical/dump.go

@@ -241,7 +241,9 @@ func (d *DumpJob) Reload(cfg map[string]interface{}) (err error) {
 func (d *DumpJob) Run(ctx context.Context) (err error) {
 	log.Msg("Run job: ", d.Name())
 
-	isEmpty, err := tools.IsEmptyDirectory(d.fsPool.DataDir())
+	dataDir := d.fsPool.DataDir()
+
+	isEmpty, err := tools.IsEmptyDirectory(dataDir)
 	if err != nil {
 		return errors.Wrap(err, "failed to explore the data directory")
 	}
@@ -252,6 +254,10 @@ func (d *DumpJob) Run(ctx context.Context) (err error) {
 		}
 
 		log.Msg("The data directory is not empty. Existing data may be overwritten.")
+
+		if err := updateConfigs(dataDir, d.DumpOptions.Restore.Configs); err != nil {
+			return fmt.Errorf("failed to update configs: %w", err)
+		}
 	}
 
 	if err := tools.PullImage(ctx, d.dockerClient, d.DockerImage); err != nil {
@@ -289,12 +295,12 @@ func (d *DumpJob) Run(ctx context.Context) (err error) {
 	log.Msg(fmt.Sprintf("Running container: %s. ID: %v", d.dumpContainerName(), containerID))
 
 	if err := d.dockerClient.ContainerStart(ctx, containerID, types.ContainerStartOptions{}); err != nil {
-		collectDiagnostics(ctx, d.dockerClient, d.dumpContainerName(), d.fsPool.DataDir())
+		collectDiagnostics(ctx, d.dockerClient, d.dumpContainerName(), dataDir)
 		return errors.Wrapf(err, "failed to start container %q", d.dumpContainerName())
 	}
 
 	if err := d.setupConnectionOptions(ctx); err != nil {
-		collectDiagnostics(ctx, d.dockerClient, d.dumpContainerName(), d.fsPool.DataDir())
+		collectDiagnostics(ctx, d.dockerClient, d.dumpContainerName(), dataDir)
 		return errors.Wrap(err, "failed to setup connection options")
 	}
 
@@ -304,8 +310,6 @@ func (d *DumpJob) Run(ctx context.Context) (err error) {
 		return err
 	}
 
-	dataDir := d.fsPool.DataDir()
-
 	pgDataDir := tmpDBLabPGDataDir
 	if d.DumpOptions.Restore.Enabled {
 		pgDataDir = dataDir
@@ -317,16 +321,15 @@ func (d *DumpJob) Run(ctx context.Context) (err error) {
 			return errors.Wrap(err, "failed to readiness check")
 		}
 
-		if err := setupPGData(ctx, d.dockerClient, pgDataDir, containerID); err != nil {
-			collectDiagnostics(ctx, d.dockerClient, d.dumpContainerName(), pgDataDir)
-			return errors.Wrap(err, "failed to set up Postgres data")
+		var configs map[string]string
+
+		if d.DumpOptions.Restore.Enabled {
+			configs = d.DumpOptions.Restore.Configs
 		}
-	}
 
-	if d.DumpOptions.Restore.Enabled && len(d.DumpOptions.Restore.Configs) > 0 {
-		if err := updateConfigs(ctx, d.dockerClient, dataDir, containerID, d.dumpContainerName(), d.DumpOptions.Restore.Configs); err != nil {
+		if err := setupPGData(ctx, d.dockerClient, pgDataDir, containerID, configs); err != nil {
 			collectDiagnostics(ctx, d.dockerClient, d.dumpContainerName(), pgDataDir)
-			return errors.Wrap(err, "failed to update configs")
+			return errors.Wrap(err, "failed to set up Postgres data")
 		}
 	}
 
@@ -484,7 +487,7 @@ func (d *DumpJob) dumpDatabase(ctx context.Context, dumpContID, dbName string, d
 	return nil
 }
 
-func setupPGData(ctx context.Context, dockerClient *client.Client, dataDir string, dumpContID string) error {
+func setupPGData(ctx context.Context, dockerClient *client.Client, dataDir, dumpContID string, configs map[string]string) error {
 	entryList, err := tools.LsContainerDirectory(ctx, dockerClient, dumpContID, dataDir)
 	if err != nil {
 		return errors.Wrap(err, "failed to explore the data directory")
@@ -507,6 +510,10 @@ func setupPGData(ctx context.Context, dockerClient *client.Client, dataDir strin
 
 	log.Dbg("Database has been initialized")
 
+	if err := updateConfigs(dataDir, configs); err != nil {
+		return fmt.Errorf("failed to update configs: %w", err)
+	}
+
 	if err := tools.StartPostgres(ctx, dockerClient, dumpContID, tools.DefaultStopTimeout); err != nil {
 		return errors.Wrap(err, "failed to init Postgres")
 	}
@@ -516,17 +523,11 @@ func setupPGData(ctx context.Context, dockerClient *client.Client, dataDir strin
 	return nil
 }
 
-func updateConfigs(
-	ctx context.Context,
-	dockerClient *client.Client,
-	dataDir, contID, containerName string,
-	configs map[string]string,
-) error {
-	log.Dbg("Stopping container to update configuration")
-
-	tools.StopContainer(ctx, dockerClient, contID, cont.StopTimeout)
+func updateConfigs(dataDir string, configs map[string]string) error {
+	if len(configs) == 0 {
+		return nil
+	}
 
-	// Run basic PostgreSQL configuration.
 	cfgManager, err := pgconfig.NewCorrector(dataDir)
 	if err != nil {
 		return errors.Wrap(err, "failed to create a config manager")
@@ -536,18 +537,6 @@ func updateConfigs(
 		return errors.Wrap(err, "failed to append general configuration")
 	}
 
-	if err := dockerClient.ContainerStart(ctx, contID, types.ContainerStartOptions{}); err != nil {
-		diagnostic.CollectContainerDiagnostics(ctx, dockerClient, containerName)
-		return errors.Wrapf(err, "failed to start container %q", contID)
-	}
-
-	log.Dbg("Waiting for container readiness")
-
-	if err := tools.CheckContainerReadiness(ctx, dockerClient, contID); err != nil {
-		diagnostic.CollectContainerDiagnostics(ctx, dockerClient, containerName)
-		return errors.Wrap(err, "failed to readiness check")
-	}
-
 	return nil
 }
 

engine/internal/retrieval/engine/postgres/logical/restore.go

@@ -166,18 +166,24 @@ func (r *RestoreJob) Reload(cfg map[string]interface{}) (err error) {
 func (r *RestoreJob) Run(ctx context.Context) (err error) {
 	log.Msg("Run job: ", r.Name())
 
-	isEmpty, err := tools.IsEmptyDirectory(r.fsPool.DataDir())
+	dataDir := r.fsPool.DataDir()
+
+	isEmpty, err := tools.IsEmptyDirectory(dataDir)
 	if err != nil {
-		return errors.Wrapf(err, "failed to explore the data directory %q", r.fsPool.DataDir())
+		return fmt.Errorf("failed to explore the data directory %q: %w", dataDir, err)
 	}
 
 	if !isEmpty {
 		if !r.ForceInit {
-			return errors.Errorf("the data directory %q is not empty. Use 'forceInit' or empty the data directory",
-				r.fsPool.DataDir())
+			return fmt.Errorf("the data directory %q is not empty. Use 'forceInit' or empty the data directory: %w",
+				dataDir, err)
 		}
 
-		log.Msg(fmt.Sprintf("The data directory %q is not empty. Existing data may be overwritten.", r.fsPool.DataDir()))
+		log.Msg(fmt.Sprintf("The data directory %q is not empty. Existing data may be overwritten.", dataDir))
+
+		if err := updateConfigs(dataDir, r.RestoreOptions.Configs); err != nil {
+			return fmt.Errorf("failed to update configuration: %w", err)
+		}
 	}
 
 	if err := tools.PullImage(ctx, r.dockerClient, r.RestoreOptions.DockerImage); err != nil {
@@ -214,8 +220,6 @@ func (r *RestoreJob) Run(ctx context.Context) (err error) {
 		return errors.Wrapf(err, "failed to start container %q", r.restoreContainerName())
 	}
 
-	dataDir := r.fsPool.DataDir()
-
 	log.Msg("Waiting for container readiness")
 
 	if err := tools.CheckContainerReadiness(ctx, r.dockerClient, containerID); err != nil {
@@ -224,17 +228,11 @@ func (r *RestoreJob) Run(ctx context.Context) (err error) {
 			return errors.Wrap(err, "failed to readiness check")
 		}
 
-		if err := setupPGData(ctx, r.dockerClient, dataDir, containerID); err != nil {
+		if err := setupPGData(ctx, r.dockerClient, dataDir, containerID, r.RestoreOptions.Configs); err != nil {
 			return errors.Wrap(err, "failed to set up Postgres data")
 		}
 	}
 
-	if len(r.RestoreOptions.Configs) > 0 {
-		if err := updateConfigs(ctx, r.dockerClient, dataDir, containerID, r.restoreContainerName(), r.RestoreOptions.Configs); err != nil {
-			return errors.Wrap(err, "failed to update configs")
-		}
-	}
-
 	dbList, err := r.getDBList(ctx, containerID)
 	if err != nil {
 		return err