Disable Signal Handling During Test Execution to Prevent SIGINT Interference (#569)

* add failing test

* feat: add signal interceptor configuration to polling metadata

* enable feature

* restore signal handlers on consumer shutdown

* fix amqp

* clean

Author: jlabedo

packages/Ecotone/src/Messaging/Endpoint/ConsumerInterceptor.php

@@ -21,6 +21,11 @@ interface ConsumerInterceptor
      */
     public function onStartup(): void;
 
+    /**
+     * Do some one time action when the consumer is shutting down
+     */
+    public function onShutdown(): void;
+
     /**
      * should this consumer be stopped before next run
      */

packages/Ecotone/src/Messaging/Endpoint/ConsumerInterceptorTrait.php

@@ -0,0 +1,42 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Ecotone\Messaging\Endpoint;
+
+use Throwable;
+
+/**
+ * licence Apache-2.0
+ */
+trait ConsumerInterceptorTrait
+{
+    public function onStartup(): void {}
+
+    public function onShutdown(): void {}
+
+    public function shouldBeStopped(): bool {
+        return false;
+    }
+
+    public function shouldBeThrown(Throwable $exception): bool
+    {
+        return false;
+    }
+
+    public function preRun(): void {
+
+    }
+
+    /**
+     * Called after each run
+     */
+    public function postRun(?Throwable $unhandledFailure): void
+    {}
+
+    /**
+     * Called after each sending message to request channel
+     */
+    public function postSend(): void
+    {}
+}

packages/Ecotone/src/Messaging/Endpoint/Interceptor/ConnectionExceptionRetryInterceptor.php

@@ -5,6 +5,7 @@
 namespace Ecotone\Messaging\Endpoint\Interceptor;
 
 use Ecotone\Messaging\Endpoint\ConsumerInterceptor;
+use Ecotone\Messaging\Endpoint\ConsumerInterceptorTrait;
 use Ecotone\Messaging\Endpoint\PollingConsumer\ConnectionException;
 use Ecotone\Messaging\Handler\Recoverability\RetryTemplateBuilder;
 use Ecotone\Messaging\Scheduling\Duration;
@@ -17,6 +18,7 @@
  */
 class ConnectionExceptionRetryInterceptor implements ConsumerInterceptor
 {
+    use ConsumerInterceptorTrait;
     private int $currentNumberOfRetries = 0;
     private ?\Ecotone\Messaging\Handler\Recoverability\RetryTemplate $retryTemplate;
 
@@ -33,14 +35,6 @@ public function onStartup(): void
         $this->currentNumberOfRetries = 0;
     }
 
-    /**
-     * @inheritDoc
-     */
-    public function shouldBeStopped(): bool
-    {
-        return false;
-    }
-
     /**
      * @inheritDoc
      */
@@ -87,11 +81,4 @@ public function postRun(?Throwable $unhandledFailure): void
 
         $this->currentNumberOfRetries = 0;
     }
-
-    /**
-     * @inheritDoc
-     */
-    public function postSend(): void
-    {
-    }
 }

packages/Ecotone/src/Messaging/Endpoint/Interceptor/FinishWhenNoMessagesInterceptor.php

@@ -5,6 +5,7 @@
 namespace Ecotone\Messaging\Endpoint\Interceptor;
 
 use Ecotone\Messaging\Endpoint\ConsumerInterceptor;
+use Ecotone\Messaging\Endpoint\ConsumerInterceptorTrait;
 use Ecotone\Messaging\Scheduling\DatePoint;
 use Ecotone\Messaging\Scheduling\Duration;
 use Ecotone\Messaging\Scheduling\EcotoneClockInterface;
@@ -15,6 +16,7 @@
  */
 class FinishWhenNoMessagesInterceptor implements ConsumerInterceptor
 {
+    use ConsumerInterceptorTrait;
     private bool $shouldBeStopped = false;
     private ?DatePoint $lastTimeMessageWasReceived;
 
@@ -38,14 +40,6 @@ public function preRun(): void
         $this->shouldBeStopped = true;
     }
 
-    /**
-     * @inheritDoc
-     */
-    public function shouldBeThrown(Throwable $exception): bool
-    {
-        return false;
-    }
-
     /**
      * @inheritDoc
      */
@@ -62,13 +56,6 @@ public function shouldBeStopped(): bool
         return $this->shouldBeStopped;
     }
 
-    /**
-     * @inheritDoc
-     */
-    public function postRun(?Throwable $unhandledFailure): void
-    {
-    }
-
     /**
      * @inheritDoc
      */

packages/Ecotone/src/Messaging/Endpoint/Interceptor/LimitConsumedMessagesInterceptor.php

@@ -5,6 +5,7 @@
 namespace Ecotone\Messaging\Endpoint\Interceptor;
 
 use Ecotone\Messaging\Endpoint\ConsumerInterceptor;
+use Ecotone\Messaging\Endpoint\ConsumerInterceptorTrait;
 use Throwable;
 
 /**
@@ -17,6 +18,7 @@
  */
 class LimitConsumedMessagesInterceptor implements ConsumerInterceptor
 {
+    use ConsumerInterceptorTrait;
     private bool $shouldBeStopped = false;
 
     private int $currentConsumedMessages = 0;
@@ -41,21 +43,6 @@ public function onStartup(): void
         $this->shouldBeStopped = false;
     }
 
-    /**
-     * @inheritDoc
-     */
-    public function preRun(): void
-    {
-    }
-
-    /**
-     * @inheritDoc
-     */
-    public function shouldBeThrown(Throwable $exception): bool
-    {
-        return false;
-    }
-
     /**
      * @inheritDoc
      */

packages/Ecotone/src/Messaging/Endpoint/Interceptor/LimitExecutionAmountInterceptor.php

@@ -5,6 +5,7 @@
 namespace Ecotone\Messaging\Endpoint\Interceptor;
 
 use Ecotone\Messaging\Endpoint\ConsumerInterceptor;
+use Ecotone\Messaging\Endpoint\ConsumerInterceptorTrait;
 use Throwable;
 
 /**
@@ -17,6 +18,8 @@
  */
 class LimitExecutionAmountInterceptor implements ConsumerInterceptor
 {
+    use ConsumerInterceptorTrait;
+
     private bool $shouldBeStopped = false;
 
     private int $currentExecutionAmount = 0;
@@ -41,21 +44,6 @@ public function onStartup(): void
         $this->shouldBeStopped = false;
     }
 
-    /**
-     * @inheritDoc
-     */
-    public function preRun(): void
-    {
-    }
-
-    /**
-     * @inheritDoc
-     */
-    public function shouldBeThrown(Throwable $exception): bool
-    {
-        return false;
-    }
-
     /**
      * @inheritDoc
      */
@@ -72,11 +60,4 @@ public function postRun(?Throwable $unhandledFailure): void
         $this->currentExecutionAmount++;
         $this->shouldBeStopped = $this->currentExecutionAmount >= $this->executionLimit;
     }
-
-    /**
-     * @inheritDoc
-     */
-    public function postSend(): void
-    {
-    }
 }

packages/Ecotone/src/Messaging/Endpoint/Interceptor/LimitMemoryUsageInterceptor.php

@@ -6,6 +6,7 @@
 
 use Ecotone\Messaging\Config\ConfigurationException;
 use Ecotone\Messaging\Endpoint\ConsumerInterceptor;
+use Ecotone\Messaging\Endpoint\ConsumerInterceptorTrait;
 use Throwable;
 
 /**
@@ -18,6 +19,7 @@
  */
 class LimitMemoryUsageInterceptor implements ConsumerInterceptor
 {
+    use ConsumerInterceptorTrait;
     private int $memoryLimitInMegaBytes;
 
     /**
@@ -34,13 +36,6 @@ public function __construct(int $memoryLimitInMegaBytes)
         $this->memoryLimitInMegaBytes = $memoryLimitInMegaBytes * 1024 * 1024;
     }
 
-    /**
-     * @inheritDoc
-     */
-    public function onStartup(): void
-    {
-    }
-
     /**
      * @inheritDoc
      */
@@ -52,33 +47,4 @@ public function shouldBeStopped(): bool
 
         return memory_get_usage(true) >= $this->memoryLimitInMegaBytes;
     }
-
-    /**
-     * @inheritDoc
-     */
-    public function shouldBeThrown(Throwable $exception): bool
-    {
-        return false;
-    }
-
-    /**
-     * @inheritDoc
-     */
-    public function preRun(): void
-    {
-    }
-
-    /**
-     * @inheritDoc
-     */
-    public function postRun(?Throwable $unhandledFailure): void
-    {
-    }
-
-    /**
-     * @inheritDoc
-     */
-    public function postSend(): void
-    {
-    }
 }