Reorder

Author: HypeMC

README.md

@@ -86,9 +86,9 @@ bizkit_circuit_breaker:
         # Service ID of the PSR-6 cache pool used to store circuit breaker state.
         storage:               cache.circuit_breaker
         failure_threshold:     5
-        success_threshold:     1
         failure_time_window:   20
         open_timeout:          30
+        success_threshold:     1
         half_open_timeout:     20
         half_open_max_concurrent_attempts: 1
         half_open_attempt_timeout: 5
@@ -107,9 +107,9 @@ bizkit_circuit_breaker:
             # Service ID of the PSR-6 cache pool used to store circuit breaker state.
             storage:               cache.circuit_breaker
             failure_threshold:     3
-            success_threshold:     1
             failure_time_window:   20
             open_timeout:          60
+            success_threshold:     1
             half_open_timeout:     20
             half_open_max_concurrent_attempts: 1
             half_open_attempt_timeout: 5

config/definition.php

@@ -47,11 +47,6 @@
                         ->defaultValue(5)
                         ->min(1)
                     ->end()
-                    ->integerNode('success_threshold')
-                        ->info('Number of successful half-open attempts required before the circuit closes.')
-                        ->defaultValue(1)
-                        ->min(1)
-                    ->end()
                     ->integerNode('failure_time_window')
                         ->info('Number of seconds during which closed-state failures are counted.')
                         ->defaultValue(20)
@@ -62,6 +57,11 @@
                         ->defaultValue(30)
                         ->min(1)
                     ->end()
+                    ->integerNode('success_threshold')
+                        ->info('Number of successful half-open attempts required before the circuit closes.')
+                        ->defaultValue(1)
+                        ->min(1)
+                    ->end()
                     ->integerNode('half_open_timeout')
                         ->info('Number of seconds a half-open circuit waits for attempt results before closing.')
                         ->defaultValue(20)
@@ -99,11 +99,6 @@
                             ->defaultValue(5)
                             ->min(1)
                         ->end()
-                        ->integerNode('success_threshold')
-                            ->info('Number of successful half-open attempts required before the circuit closes.')
-                            ->defaultValue(1)
-                            ->min(1)
-                        ->end()
                         ->integerNode('failure_time_window')
                             ->info('Number of seconds during which closed-state failures are counted.')
                             ->defaultValue(20)
@@ -114,6 +109,11 @@
                             ->defaultValue(30)
                             ->min(1)
                         ->end()
+                        ->integerNode('success_threshold')
+                            ->info('Number of successful half-open attempts required before the circuit closes.')
+                            ->defaultValue(1)
+                            ->min(1)
+                        ->end()
                         ->integerNode('half_open_timeout')
                             ->info('Number of seconds a half-open circuit waits for attempt results before closing.')
                             ->defaultValue(20)

src/CircuitBreaker/CircuitBreaker.php

@@ -43,9 +43,7 @@ public function tryAcquireAttempt(string $serviceName): Attempt
         }
 
         $now = $this->timestamp();
-        do {
-            $attemptToken = self::createAttemptToken();
-        } while (isset($record->attempts[$attemptToken]));
+        $attemptToken = self::createAttemptToken();
 
         $attemptExpiresAt = $now + $this->config->halfOpenAttemptTimeout;
         if (null !== $record->expiresAt) {
@@ -138,6 +136,7 @@ public function recordSuccess(string $serviceName, Attempt $attempt): void
         }
 
         $record = $record->withoutAttempt($attempt->getToken());
+
         $this->storage->save(
             $serviceName,
             new CircuitRecord(

src/CircuitBreaker/Settings.php

@@ -10,15 +10,15 @@ public function __construct(
         /** Number of failures inside the failure time window before the circuit opens. */
         public readonly int $failureThreshold = 5,
 
-        /** Number of successful half-open attempts required before the circuit closes. */
-        public readonly int $successThreshold = 1,
-
         /** Number of seconds during which closed-state failures are counted. */
         public readonly int $failureTimeWindow = 20,
 
         /** Number of seconds an open circuit stays open before moving to half-open. */
         public readonly int $openTimeout = 30,
 
+        /** Number of successful half-open attempts required before the circuit closes. */
+        public readonly int $successThreshold = 1,
+
         /** Number of seconds a half-open circuit waits for attempt results before closing. */
         public readonly int $halfOpenTimeout = 20,
 

src/CircuitBreaker/Storage/CircuitRecord.php

@@ -22,21 +22,6 @@ public function __construct(
     ) {
     }
 
-    /**
-     * @return array{state: string, failure_count: int, success_count: int, failure_window_started_at: ?int, expires_at: ?int, attempts: array<string, int>}
-     */
-    public function toArray(): array
-    {
-        return [
-            'state' => $this->state->value,
-            'failure_count' => $this->failureCount,
-            'success_count' => $this->successCount,
-            'failure_window_started_at' => $this->failureWindowStartedAt,
-            'expires_at' => $this->expiresAt,
-            'attempts' => $this->attempts,
-        ];
-    }
-
     /**
      * @return array<string, int>
      */
@@ -84,6 +69,21 @@ public function withoutAttempt(?string $token): self
         );
     }
 
+    /**
+     * @return array{state: string, failure_count: int, success_count: int, failure_window_started_at: ?int, expires_at: ?int, attempts: array<string, int>}
+     */
+    public function toArray(): array
+    {
+        return [
+            'state' => $this->state->value,
+            'failure_count' => $this->failureCount,
+            'success_count' => $this->successCount,
+            'failure_window_started_at' => $this->failureWindowStartedAt,
+            'expires_at' => $this->expiresAt,
+            'attempts' => $this->attempts,
+        ];
+    }
+
     /**
      * @param array<string, mixed> $value
      */

src/DependencyInjection/CircuitBreakerHttpClientCompilerPass.php

@@ -30,9 +30,9 @@ public function process(ContainerBuilder $container): void
          * @var array{
          *     storage: ?string,
          *     failure_threshold: int,
-         *     success_threshold: int,
          *     failure_time_window: int,
          *     open_timeout: int,
+         *     success_threshold: int,
          *     half_open_timeout: int,
          *     half_open_max_concurrent_attempts: int,
          *     half_open_attempt_timeout: int,
@@ -55,9 +55,9 @@ public function process(ContainerBuilder $container): void
          * @var array<string, array{
          *     storage: ?string,
          *     failure_threshold: int,
-         *     success_threshold: int,
          *     failure_time_window: int,
          *     open_timeout: int,
+         *     success_threshold: int,
          *     half_open_timeout: int,
          *     half_open_max_concurrent_attempts: int,
          *     half_open_attempt_timeout: int,
@@ -86,9 +86,9 @@ public function process(ContainerBuilder $container): void
      * @param array{
      *     storage: string,
      *     failure_threshold: int,
-     *     success_threshold: int,
      *     failure_time_window: int,
      *     open_timeout: int,
+     *     success_threshold: int,
      *     half_open_timeout: int,
      *     half_open_max_concurrent_attempts: int,
      *     half_open_attempt_timeout: int,
@@ -131,9 +131,9 @@ private static function decorateClient(ContainerBuilder $container, string $clie
         $container->register($configId = $idPrefix.'.config', Settings::class)
             ->setArguments([
                 $config['failure_threshold'],
-                $config['success_threshold'],
                 $config['failure_time_window'],
                 $config['open_timeout'],
+                $config['success_threshold'],
                 $config['half_open_timeout'],
                 $config['half_open_max_concurrent_attempts'],
                 $config['half_open_attempt_timeout'],

tests/BizkitCircuitBreakerBundleTest.php

@@ -43,9 +43,9 @@ public function testLoadsHttpClientConfiguration(): void
             'http_client' => [
                 'storage' => 'cache.app',
                 'failure_threshold' => 6,
-                'success_threshold' => 2,
                 'failure_time_window' => 40,
                 'open_timeout' => 50,
+                'success_threshold' => 2,
                 'half_open_timeout' => 15,
                 'half_open_max_concurrent_attempts' => 2,
                 'half_open_attempt_timeout' => 7,
@@ -57,9 +57,9 @@ public function testLoadsHttpClientConfiguration(): void
         self::assertSame([
             'storage' => 'cache.app',
             'failure_threshold' => 6,
-            'success_threshold' => 2,
             'failure_time_window' => 40,
             'open_timeout' => 50,
+            'success_threshold' => 2,
             'half_open_timeout' => 15,
             'half_open_max_concurrent_attempts' => 2,
             'half_open_attempt_timeout' => 7,
@@ -89,9 +89,9 @@ public function testLoadsScopedHttpClientConfiguration(): void
             'client1' => [
                 'storage' => 'cache.client1',
                 'failure_threshold' => 2,
-                'success_threshold' => 1,
                 'failure_time_window' => 20,
                 'open_timeout' => 30,
+                'success_threshold' => 1,
                 'half_open_timeout' => 20,
                 'half_open_max_concurrent_attempts' => 1,
                 'half_open_attempt_timeout' => 5,

tests/CircuitBreaker/CircuitBreakerTest.php

@@ -101,8 +101,8 @@ public function testHalfOpenReleasesAttemptAfterSuccessWhenSuccessThresholdIsNot
         $clock = new MockClock();
         $circuitBreaker = new CircuitBreaker(new InMemoryStorage(), new Settings(
             failureThreshold: 1,
-            successThreshold: 2,
             openTimeout: 10,
+            successThreshold: 2,
             halfOpenMaxConcurrentAttempts: 1,
         ), $clock);
 
@@ -125,8 +125,8 @@ public function testHalfOpenSuccessReleasesOnlyMatchingAttempt(): void
         $storage = new InMemoryStorage();
         $circuitBreaker = new CircuitBreaker($storage, new Settings(
             failureThreshold: 1,
-            successThreshold: 3,
             openTimeout: 10,
+            successThreshold: 3,
             halfOpenMaxConcurrentAttempts: 2,
         ), $clock);
 
@@ -151,8 +151,8 @@ public function testHalfOpenRequiresSuccessThresholdBeforeClosing(): void
         $clock = new MockClock();
         $circuitBreaker = new CircuitBreaker(new InMemoryStorage(), new Settings(
             failureThreshold: 1,
-            successThreshold: 2,
             openTimeout: 10,
+            successThreshold: 2,
             halfOpenTimeout: 10,
         ), $clock);
 
@@ -174,8 +174,8 @@ public function testBlockedAttemptDoesNotRecordSuccess(): void
         $clock = new MockClock();
         $circuitBreaker = new CircuitBreaker(new InMemoryStorage(), new Settings(
             failureThreshold: 1,
-            successThreshold: 1,
             openTimeout: 10,
+            successThreshold: 1,
         ), $clock);
 
         $circuitBreaker->recordFailure('api');

tests/DependencyInjection/CircuitBreakerHttpClientCompilerPassTest.php

@@ -94,7 +94,7 @@ public function testDecoratesScopedHttpClient(): void
         self::assertSame('cache.app', (string) $storage->getArgument(0));
 
         $config = $container->getDefinition($configId);
-        self::assertSame([2, 1, 20, 30, 17, 1, 5], $config->getArguments());
+        self::assertSame([2, 20, 30, 1, 17, 1, 5], $config->getArguments());
 
         $decorator = $container->getDefinition($decoratorId);
         self::assertSame('bizkit_circuit_breaker.failure_checker.default', (string) $decorator->getArgument(2));
@@ -293,9 +293,9 @@ private static function config(array $configOverrides = []): array
         return array_replace([
             'storage' => null,
             'failure_threshold' => 5,
-            'success_threshold' => 1,
             'failure_time_window' => 20,
             'open_timeout' => 30,
+            'success_threshold' => 1,
             'half_open_timeout' => 20,
             'half_open_max_concurrent_attempts' => 1,
             'half_open_attempt_timeout' => 5,