Add a test for commit ac0e33136a using the injection point.
authorAmit Kapila <akapila@postgresql.org>
Wed, 19 Feb 2025 09:22:32 +0000 (14:52 +0530)
committerAmit Kapila <akapila@postgresql.org>
Wed, 19 Feb 2025 09:32:22 +0000 (15:02 +0530)
This test uses an injection point to bypass the time overhead caused by
the idle_replication_slot_timeout GUC, which has a minimum value of one
minute.

Author: Hayato Kuroda <kuroda.hayato@fujitsu.com>
Author: Nisha Moond <nisha.moond412@gmail.com>
Reviewed-by: Peter Smith <smithpb2250@gmail.com>
Reviewed-by: Vignesh C <vignesh21@gmail.com>
Reviewed-by: Amit Kapila <amit.kapila16@gmail.com>
Discussion: https://postgr.es/m/CALj2ACW4aUe-_uFQOjdWCEN-xXoLGhmvRFnL8SNw_TZ5nJe+aw@mail.gmail.com

src/backend/replication/slot.c
src/test/recovery/meson.build
src/test/recovery/t/044_invalidate_inactive_slots.pl [new file with mode: 0644]

index d73c9c2fc324d96c766ad6cf4ceaae58f853e319..292407f51494d0eb617e310921ec99681d2049ce 100644 (file)
@@ -56,6 +56,7 @@
 #include "storage/procarray.h"
 #include "utils/builtins.h"
 #include "utils/guc_hooks.h"
+#include "utils/injection_point.h"
 #include "utils/varlena.h"
 
 /*
@@ -1669,16 +1670,31 @@ DetermineSlotInvalidationCause(uint32 possible_causes, ReplicationSlot *s,
    {
        Assert(now > 0);
 
-       /*
-        * Check if the slot needs to be invalidated due to
-        * idle_replication_slot_timeout GUC.
-        */
-       if (CanInvalidateIdleSlot(s) &&
-           TimestampDifferenceExceedsSeconds(s->inactive_since, now,
-                                             idle_replication_slot_timeout_mins * SECS_PER_MINUTE))
+       if (CanInvalidateIdleSlot(s))
        {
-           *inactive_since = s->inactive_since;
-           return RS_INVAL_IDLE_TIMEOUT;
+           /*
+            * We simulate the invalidation due to idle_timeout as the minimum
+            * time idle time is one minute which makes tests take a long
+            * time.
+            */
+#ifdef USE_INJECTION_POINTS
+           if (IS_INJECTION_POINT_ATTACHED("slot-timeout-inval"))
+           {
+               *inactive_since = 0;    /* since the beginning of time */
+               return RS_INVAL_IDLE_TIMEOUT;
+           }
+#endif
+
+           /*
+            * Check if the slot needs to be invalidated due to
+            * idle_replication_slot_timeout GUC.
+            */
+           if (TimestampDifferenceExceedsSeconds(s->inactive_since, now,
+                                                 idle_replication_slot_timeout_mins * SECS_PER_MINUTE))
+           {
+               *inactive_since = s->inactive_since;
+               return RS_INVAL_IDLE_TIMEOUT;
+           }
        }
    }
 
index 0428704dbfd577b2dc9707a4fe722d96216083cd..057bcde1434d3cf79b98b03bbaed74c255e66c4e 100644 (file)
@@ -52,6 +52,7 @@ tests += {
       't/041_checkpoint_at_promote.pl',
       't/042_low_level_backup.pl',
       't/043_no_contrecord_switch.pl',
+      't/044_invalidate_inactive_slots.pl',
     ],
   },
 }
diff --git a/src/test/recovery/t/044_invalidate_inactive_slots.pl b/src/test/recovery/t/044_invalidate_inactive_slots.pl
new file mode 100644 (file)
index 0000000..ccace14
--- /dev/null
@@ -0,0 +1,105 @@
+# Copyright (c) 2025, PostgreSQL Global Development Group
+
+# Test for replication slots invalidation due to idle_timeout
+use strict;
+use warnings FATAL => 'all';
+
+use PostgreSQL::Test::Utils;
+use PostgreSQL::Test::Cluster;
+use Test::More;
+
+# This test depends on injection point that forces slot invalidation
+# due to idle_timeout.
+# https://www.postgresql.org/docs/current/xfunc-c.html#XFUNC-ADDIN-INJECTION-POINTS
+if ($ENV{enable_injection_points} ne 'yes')
+{
+   plan skip_all => 'Injection points not supported by this build';
+}
+
+# Wait for slot to first become idle and then get invalidated
+sub wait_for_slot_invalidation
+{
+   my ($node, $slot_name, $offset) = @_;
+   my $node_name = $node->name;
+
+   # The slot's invalidation should be logged
+   $node->wait_for_log(
+       qr/invalidating obsolete replication slot \"$slot_name\"/, $offset);
+
+   # Check that the invalidation reason is 'idle_timeout'
+   $node->poll_query_until(
+       'postgres', qq[
+       SELECT COUNT(slot_name) = 1 FROM pg_replication_slots
+           WHERE slot_name = '$slot_name' AND
+           invalidation_reason = 'idle_timeout';
+   ])
+     or die
+     "Timed out while waiting for invalidation reason of slot $slot_name to be set on node $node_name";
+}
+
+# ========================================================================
+# Testcase start
+#
+# Test invalidation of physical replication slot and logical replication slot
+# due to idle timeout.
+
+# Initialize the node
+my $node = PostgreSQL::Test::Cluster->new('node');
+$node->init(allows_streaming => 'logical');
+
+# Avoid unpredictability
+$node->append_conf(
+   'postgresql.conf', qq{
+checkpoint_timeout = 1h
+idle_replication_slot_timeout = 1min
+});
+$node->start;
+
+# Check if the 'injection_points' extension is available, as it may be
+# possible that this script is run with installcheck, where the module
+# would not be installed by default.
+if (!$node->check_extension('injection_points'))
+{
+   plan skip_all => 'Extension injection_points not installed';
+}
+
+# Create both physical and logical replication slots
+$node->safe_psql(
+   'postgres', qq[
+       SELECT pg_create_physical_replication_slot(slot_name := 'physical_slot', immediately_reserve := true);
+       SELECT pg_create_logical_replication_slot('logical_slot', 'test_decoding');
+]);
+
+my $log_offset = -s $node->logfile;
+
+# Register an injection point on the node to forcibly cause a slot
+# invalidation due to idle_timeout
+$node->safe_psql('postgres', 'CREATE EXTENSION injection_points;');
+
+$node->safe_psql('postgres',
+   "SELECT injection_points_attach('slot-timeout-inval', 'error');");
+
+# Slot invalidation occurs during a checkpoint, so perform a checkpoint to
+# invalidate the slots.
+$node->safe_psql('postgres', "CHECKPOINT");
+
+# Wait for slots to become inactive. Since nobody has acquired the slot yet,
+# it can only be due to the idle timeout mechanism.
+wait_for_slot_invalidation($node, 'physical_slot', $log_offset);
+wait_for_slot_invalidation($node, 'logical_slot', $log_offset);
+
+# Check that the invalidated slot cannot be acquired
+my ($result, $stdout, $stderr);
+($result, $stdout, $stderr) = $node->psql(
+   'postgres', qq[
+       SELECT pg_replication_slot_advance('logical_slot', '0/1');
+]);
+ok( $stderr =~ /can no longer access replication slot "logical_slot"/,
+   "detected error upon trying to acquire invalidated slot on node")
+  or die
+  "could not detect error upon trying to acquire invalidated slot \"logical_slot\" on node";
+
+# Testcase end
+# =============================================================================
+
+done_testing();