Clear base backup progress on backup failure

Previously, if a base backup failed after it had started streaming
files, pg_stat_progress_basebackup could continue to show a stale
progress entry even though the backup was no longer running. This could
be observed when the client kept the replication connection open after
the error. It is normally not observable when using pg_basebackup,
because the client disconnects after the error.

The problem was that progress reporting was cleared only after
successful completion.

This commit moves the progress reporting cleanup into the progress
sink's cleanup callback so that it is cleared after both successful
and failed backups.

Backpatch to v15. v14 has the same issue, but the fix does not apply
cleanly because it lacks the base backup sink infrastructure. Since
the bug does not affect the backup itself and is normally not
observable when using pg_basebackup, skip the v14 backpatch.

Author: Chao Li <lic@highgo.com>
Reviewed-by: Fujii Masao <masao.fujii@gmail.com>
Discussion: https://postgr.es/m/EA1A6CD2-EFA6-462B-9A02-03003555AB4A@gmail.com
Backpatch-through: 15

diff --git a/src/backend/backup/basebackup.c b/src/backend/backup/basebackup.c
index 9a2bf59e84ee4a14ea5dfe24940aa146851084d9..e12db1d2f3f21249af99978411d7e480e5b55593 100644 (file)
--- a/src/backend/backup/basebackup.c
+++ b/src/backend/backup/basebackup.c
@@ -672,8 +672,6 @@ perform_base_backup(basebackup_options *opt, bbsink *sink,
 
        /* clean up the resource owner we created */
        WalSndResourceCleanup(true);
-
-       basebackup_progress_done();
 }
 
 /*

diff --git a/src/backend/backup/basebackup_progress.c b/src/backend/backup/basebackup_progress.c
index 8ff6c6073336a2054b78cf73256618da400ea7fa..4af247b488785b4fac2f5b6b4b7f455fccb2109f 100644 (file)
--- a/src/backend/backup/basebackup_progress.c
+++ b/src/backend/backup/basebackup_progress.c
@@ -38,6 +38,7 @@
 static void bbsink_progress_begin_backup(bbsink *sink);
 static void bbsink_progress_archive_contents(bbsink *sink, size_t len);
 static void bbsink_progress_end_archive(bbsink *sink);
+static void bbsink_progress_cleanup(bbsink *sink);
 
 static const bbsink_ops bbsink_progress_ops = {
        .begin_backup = bbsink_progress_begin_backup,
@@ -48,7 +49,7 @@ static const bbsink_ops bbsink_progress_ops = {
        .manifest_contents = bbsink_forward_manifest_contents,
        .end_manifest = bbsink_forward_end_manifest,
        .end_backup = bbsink_forward_end_backup,
-       .cleanup = bbsink_forward_cleanup
+       .cleanup = bbsink_progress_cleanup
 };
 
 /*
@@ -179,6 +180,16 @@ bbsink_progress_archive_contents(bbsink *sink, size_t len)
        pgstat_progress_update_multi_param(nparam, index, val);
 }
 
+/*
+ * Clean up progress reporting.
+ */
+static void
+bbsink_progress_cleanup(bbsink *sink)
+{
+       pgstat_progress_end_command();
+       bbsink_forward_cleanup(sink);
+}
+
 /*
  * Advertise that we are waiting for the start-of-backup checkpoint.
  */
@@ -231,12 +242,3 @@ basebackup_progress_transfer_wal(void)
        pgstat_progress_update_param(PROGRESS_BASEBACKUP_PHASE,
                                                                 PROGRESS_BASEBACKUP_PHASE_TRANSFER_WAL);
 }
-
-/*
- * Advertise that we are no longer performing a backup.
- */
-void
-basebackup_progress_done(void)
-{
-       pgstat_progress_end_command();
-}

diff --git a/src/include/backup/basebackup_sink.h b/src/include/backup/basebackup_sink.h
index fcedba75a65432cce009d7a9297a15b10130f4ea..272fafd1c4b17fc0621d24ae594ab9eaeb1b1001 100644 (file)
--- a/src/include/backup/basebackup_sink.h
+++ b/src/include/backup/basebackup_sink.h
@@ -296,6 +296,5 @@ extern void basebackup_progress_wait_checkpoint(void);
 extern void basebackup_progress_estimate_backup_size(void);
 extern void basebackup_progress_wait_wal_archive(bbsink_state *);
 extern void basebackup_progress_transfer_wal(void);
-extern void basebackup_progress_done(void);
 
 #endif