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 3fe6468400eeebf52b7867b08c6a49ffa71b6e64..cb87612d49023040382d99708c4f7de8bab3e52e 100644 (file)
--- a/src/backend/backup/basebackup.c
+++ b/src/backend/backup/basebackup.c
@@ -646,8 +646,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 6d4b5a23d11af9419f634b21a59bb9c85ef2eae5..f20e5ffe47b316dd991a7eafe97a03e7d38f2230 100644 (file)
--- a/src/backend/backup/basebackup_progress.c
+++ b/src/backend/backup/basebackup_progress.c
@@ -42,6 +42,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,
@@ -52,7 +53,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
 };
 
 /*
@@ -183,6 +184,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.
  */
@@ -235,12 +246,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 a1cd24ce8146221acd024148a3c1e30ea462a13b..325bdaff3808383f65810a4552ee137b897d8839 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