Merge branch 'recovery-target-immediate' into 'master'

agneum · agneum · commit 2a86e664c2bd · 2022-03-15T00:26:21.000Z
fix(engine): replace the "standby_mode" parameter to "recovery_target" in the DLE configuration for the promotion stage

See merge request postgres-ai/database-lab!484
diff --git a/engine/configs/config.example.physical_generic.yml b/engine/configs/config.example.physical_generic.yml
@@ -215,6 +215,7 @@ retrieval:
           recovery:
           # Uncomment this only if you are on Postgres version 11 or older.
           #  standby_mode: on
+          #  recovery_target_timeline: 'latest'
 
         # Set environment variables here. See https://www.postgresql.org/docs/current/libpq-envars.html
         envs:
@@ -273,7 +274,9 @@ retrieval:
           # Add PostgreSQL recovery configuration parameters to the promotion container.
           recovery:
           # Uncomment this only if you are on Postgres version 11 or older.
-          # standby_mode: on
+          #  recovery_target: 'immediate'
+          #  recovery_target_action: 'promote'
+          #  recovery_target_timeline: 'latest'
 
         # It is possible to define a pre-processing script. For example, "/tmp/scripts/custom.sh".
         # Default: empty string (no pre-processing defined).
diff --git a/engine/configs/config.example.physical_pgbackrest.yml b/engine/configs/config.example.physical_pgbackrest.yml
@@ -214,7 +214,8 @@ retrieval:
           # Add PostgreSQL recovery configuration parameters to the sync container.
           recovery:
           # Uncomment this only if you are on Postgres version 11 or older.
-          # standby_mode: on
+          #  standby_mode: on
+          #  recovery_target_timeline: 'latest'
 
         # Passes custom environment variables to the Docker container with the restoring tool.
         envs:
@@ -277,7 +278,9 @@ retrieval:
           # Add PostgreSQL recovery configuration parameters to the promotion container.
           recovery:
           # Uncomment this only if you are on Postgres version 11 or older.
-          # standby_mode: on
+          #  recovery_target: 'immediate'
+          #  recovery_target_action: 'promote'
+          #  recovery_target_timeline: 'latest'
 
         # It is possible to define a pre-processing script. For example, "/tmp/scripts/custom.sh".
         # Default: empty string (no pre-processing defined).
diff --git a/engine/configs/config.example.physical_walg.yml b/engine/configs/config.example.physical_walg.yml
@@ -214,7 +214,8 @@ retrieval:
           # Add PostgreSQL recovery configuration parameters to the sync container.
           recovery:
           # Uncomment this only if you are on Postgres version 11 or older.
-          # standby_mode: on
+          #  standby_mode: on
+          #  recovery_target_timeline: 'latest'
 
         # Passes custom environment variables to the Docker container with the restoring tool.
         envs:
@@ -263,7 +264,9 @@ retrieval:
           # Add PostgreSQL recovery configuration parameters to the promotion container.
           recovery:
           # Uncomment this only if you are on Postgres version 11 or older.
-          # standby_mode: on
+          #  recovery_target: 'immediate'
+          #  recovery_target_action: 'promote'
+          #  recovery_target_timeline: 'latest'
 
         # It is possible to define a pre-processing script. For example, "/tmp/scripts/custom.sh".
         # Default: empty string (no pre-processing defined).
diff --git a/engine/internal/retrieval/engine/postgres/physical/custom.go b/engine/internal/retrieval/engine/postgres/physical/custom.go
@@ -40,7 +40,6 @@ func (c *custom) GetRecoveryConfig(pgVersion float64) map[string]string {
 		recoveryCfg["restore_command"] = c.options.RestoreCommand
 
 		if pgVersion < defaults.PGVersion12 {
-			recoveryCfg["standby_mode"] = "on"
 			recoveryCfg["recovery_target_timeline"] = "latest"
 		}
 	}
diff --git a/engine/internal/retrieval/engine/postgres/physical/custom_test.go b/engine/internal/retrieval/engine/postgres/physical/custom_test.go
@@ -14,7 +14,6 @@ func TestCustomRecoveryConfig(t *testing.T) {
 	recoveryConfig := customTool.GetRecoveryConfig(11.7)
 	expectedResponse11 := map[string]string{
 		"restore_command":          "pg_basebackup -X stream -D dataDirectory",
-		"standby_mode":             "on",
 		"recovery_target_timeline": "latest",
 	}
 	assert.Equal(t, expectedResponse11, recoveryConfig)
diff --git a/engine/internal/retrieval/engine/postgres/physical/pgbackrest.go b/engine/internal/retrieval/engine/postgres/physical/pgbackrest.go
@@ -48,7 +48,6 @@ func (p *pgbackrest) GetRecoveryConfig(pgVersion float64) map[string]string {
 	}
 
 	if pgVersion < defaults.PGVersion12 {
-		recoveryCfg["standby_mode"] = "on"
 		recoveryCfg["recovery_target_timeline"] = "latest"
 	}
 
diff --git a/engine/internal/retrieval/engine/postgres/physical/pgbackrest_test.go b/engine/internal/retrieval/engine/postgres/physical/pgbackrest_test.go
@@ -12,7 +12,6 @@ func TestPgBackRestRecoveryConfig(t *testing.T) {
 	recoveryConfig := pgbackrest.GetRecoveryConfig(11.7)
 	expectedResponse11 := map[string]string{
 		"restore_command":          "pgbackrest --pg1-path=dataDir --stanza=stanzaName archive-get %f %p",
-		"standby_mode":             "on",
 		"recovery_target_timeline": "latest",
 	}
 	assert.Equal(t, expectedResponse11, recoveryConfig)
diff --git a/engine/internal/retrieval/engine/postgres/physical/wal_g.go b/engine/internal/retrieval/engine/postgres/physical/wal_g.go
@@ -43,7 +43,6 @@ func (w *walg) GetRecoveryConfig(pgVersion float64) map[string]string {
 	}
 
 	if pgVersion < defaults.PGVersion12 {
-		recoveryCfg["standby_mode"] = "on"
 		recoveryCfg["recovery_target_timeline"] = "latest"
 	}
 
diff --git a/engine/internal/retrieval/engine/postgres/physical/wal_g_test.go b/engine/internal/retrieval/engine/postgres/physical/wal_g_test.go
@@ -12,7 +12,6 @@ func TestWALGRecoveryConfig(t *testing.T) {
 	recoveryConfig := walg.GetRecoveryConfig(11.7)
 	expectedResponse11 := map[string]string{
 		"restore_command":          "wal-g wal-fetch %f %p",
-		"standby_mode":             "on",
 		"recovery_target_timeline": "latest",
 	}
 	assert.Equal(t, expectedResponse11, recoveryConfig)
diff --git a/engine/internal/retrieval/engine/postgres/snapshot/physical.go b/engine/internal/retrieval/engine/postgres/snapshot/physical.go
@@ -756,16 +756,18 @@ func parseWALLine(line string) string {
 }
 
 func buildRecoveryConfig(fileConfig, userRecoveryConfig map[string]string) map[string]string {
+	if len(userRecoveryConfig) != 0 {
+		return userRecoveryConfig
+	}
+
 	recoveryConf := fileConfig
 
 	if rc, ok := fileConfig[restoreCommandOption]; ok || rc != "" {
 		for k, v := range defaultRecoveryCfg {
 			recoveryConf[k] = v
 		}
-	}
 
-	for k, v := range userRecoveryConfig {
-		recoveryConf[k] = v
+		delete(fileConfig, "standby_mode")
 	}
 
 	return recoveryConf
diff --git a/engine/internal/retrieval/engine/postgres/snapshot/physical_test.go b/engine/internal/retrieval/engine/postgres/snapshot/physical_test.go
@@ -164,3 +164,49 @@ func TestParsingWalLine(t *testing.T) {
 		assert.EqualValues(t, tc.expectedDataStateAt, dsa)
 	}
 }
+
+func TestRecoveryConfig(t *testing.T) {
+	testCases := []struct {
+		fileConfig     map[string]string
+		userConfig     map[string]string
+		recoveryConfig map[string]string
+	}{
+		{
+			fileConfig: map[string]string{
+				"restore_command":          "cp /mnt/wal/%f %p",
+				"standby_mode":             "true",
+				"recovery_target_timeline": "latest",
+			},
+			recoveryConfig: map[string]string{
+				"restore_command":          "cp /mnt/wal/%f %p",
+				"recovery_target":          "immediate",
+				"recovery_target_action":   "promote",
+				"recovery_target_timeline": "latest",
+			},
+		},
+		{
+			fileConfig: map[string]string{
+				"restore_command":          "cp /mnt/wal/%f %p",
+				"standby_mode":             "true",
+				"recovery_target_timeline": "latest",
+			},
+			userConfig: map[string]string{
+				"restore_command":          "wal-g wal-fetch %f %p",
+				"recovery_target":          "immediate",
+				"recovery_target_action":   "promote",
+				"recovery_target_timeline": "latest",
+			},
+			recoveryConfig: map[string]string{
+				"restore_command":          "wal-g wal-fetch %f %p",
+				"recovery_target":          "immediate",
+				"recovery_target_action":   "promote",
+				"recovery_target_timeline": "latest",
+			},
+		},
+	}
+
+	for _, tc := range testCases {
+		recoveryConfig := buildRecoveryConfig(tc.fileConfig, tc.userConfig)
+		assert.EqualValues(t, tc.recoveryConfig, recoveryConfig)
+	}
+}

Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,6 @@ func (c *custom) GetRecoveryConfig(pgVersion float64) map[string]string {`
`40`	`40`	`recoveryCfg["restore_command"] = c.options.RestoreCommand`
`41`	`41`
`42`	`42`	`if pgVersion < defaults.PGVersion12 {`
`43`		`- recoveryCfg["standby_mode"] = "on"`
`44`	`43`	`recoveryCfg["recovery_target_timeline"] = "latest"`
`45`	`44`	`}`
`46`	`45`	`}`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,6 @@ func TestCustomRecoveryConfig(t *testing.T) {`
`14`	`14`	`recoveryConfig := customTool.GetRecoveryConfig(11.7)`
`15`	`15`	`expectedResponse11 := map[string]string{`
`16`	`16`	`"restore_command": "pg_basebackup -X stream -D dataDirectory",`
`17`		`- "standby_mode": "on",`
`18`	`17`	`"recovery_target_timeline": "latest",`
`19`	`18`	`}`
`20`	`19`	`assert.Equal(t, expectedResponse11, recoveryConfig)`
Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,6 @@ func (p *pgbackrest) GetRecoveryConfig(pgVersion float64) map[string]string {`
`48`	`48`	`}`
`49`	`49`
`50`	`50`	`if pgVersion < defaults.PGVersion12 {`
`51`		`- recoveryCfg["standby_mode"] = "on"`
`52`	`51`	`recoveryCfg["recovery_target_timeline"] = "latest"`
`53`	`52`	`}`
`54`	`53`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,6 @@ func TestPgBackRestRecoveryConfig(t *testing.T) {`
`12`	`12`	`recoveryConfig := pgbackrest.GetRecoveryConfig(11.7)`
`13`	`13`	`expectedResponse11 := map[string]string{`
`14`	`14`	`"restore_command": "pgbackrest --pg1-path=dataDir --stanza=stanzaName archive-get %f %p",`
`15`		`- "standby_mode": "on",`
`16`	`15`	`"recovery_target_timeline": "latest",`
`17`	`16`	`}`
`18`	`17`	`assert.Equal(t, expectedResponse11, recoveryConfig)`
Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,6 @@ func (w *walg) GetRecoveryConfig(pgVersion float64) map[string]string {`
`43`	`43`	`}`
`44`	`44`
`45`	`45`	`if pgVersion < defaults.PGVersion12 {`
`46`		`- recoveryCfg["standby_mode"] = "on"`
`47`	`46`	`recoveryCfg["recovery_target_timeline"] = "latest"`
`48`	`47`	`}`
`49`	`48`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,6 @@ func TestWALGRecoveryConfig(t *testing.T) {`
`12`	`12`	`recoveryConfig := walg.GetRecoveryConfig(11.7)`
`13`	`13`	`expectedResponse11 := map[string]string{`
`14`	`14`	`"restore_command": "wal-g wal-fetch %f %p",`
`15`		`- "standby_mode": "on",`
`16`	`15`	`"recovery_target_timeline": "latest",`
`17`	`16`	`}`
`18`	`17`	`assert.Equal(t, expectedResponse11, recoveryConfig)`
Original file line number	Diff line number	Diff line change
`@@ -756,16 +756,18 @@ func parseWALLine(line string) string {`
`756`	`756`	`}`
`757`	`757`
`758`	`758`	`func buildRecoveryConfig(fileConfig, userRecoveryConfig map[string]string) map[string]string {`
	`759`	`+ if len(userRecoveryConfig) != 0 {`
	`760`	`+ return userRecoveryConfig`
	`761`	`+ }`
	`762`	`+`
`759`	`763`	`recoveryConf := fileConfig`
`760`	`764`
`761`	`765`	`if rc, ok := fileConfig[restoreCommandOption]; ok \|\| rc != "" {`
`762`	`766`	`for k, v := range defaultRecoveryCfg {`
`763`	`767`	`recoveryConf[k] = v`
`764`	`768`	`}`
`765`		`- }`
`766`	`769`
`767`		`- for k, v := range userRecoveryConfig {`
`768`		`- recoveryConf[k] = v`
	`770`	`+ delete(fileConfig, "standby_mode")`
`769`	`771`	`}`
`770`	`772`
`771`	`773`	`return recoveryConf`