small rafactors

AgentSoftware · Apr 5, 2024 · 80cc814 · 80cc814
1 parent c2943f1
commit 80cc814
Show file tree

Hide file tree

Showing 4 changed files with 47 additions and 51 deletions.
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -54,8 +54,3 @@ parameters:
 			message: "#^Method AgentSoftware\\\\LaravelRawSqsConnector\\\\RawSqsQueue\\:\\:receiveMessage\\(\\) return type has no value type specified in iterable type array\\.$#"
 			count: 1
 			path: src/RawSqsQueue.php
-
-		-
-			message: "#^Parameter \\#2 \\$maxAttempts of static method Illuminate\\\\Support\\\\Facades\\\\RateLimiter\\:\\:attempt\\(\\) expects int, int\\|null given\\.$#"
-			count: 1
-			path: src/RawSqsQueue.php
diff --git a/src/RawSqsQueue.php b/src/RawSqsQueue.php
@@ -48,7 +48,7 @@ public function pop($queue = null): SqsJob|Job|null
 
     protected function receiveMessage(string $queue): Result|array|null
     {
-        if ($this->rateLimit === null) {
+        if ($this->getRateLimit() === null) {
             return $this->querySqs($queue);
         }
 
@@ -76,11 +76,11 @@ protected function log(string $text, array $context = []): void
     protected function hasRemainingAttempts(string $key): mixed
     {
         /** @var int $limit */
-        $limit = $this->rateLimit;
+        $limit = $this->getRateLimit();
 
         return RateLimiter::attempt(
             $key,
-            $this->rateLimit,
+            $limit,
             fn () => true,
         );
     }
@@ -129,7 +129,6 @@ public function later($delay, $job, $data = '', $queue = null)
         throw new InvalidPayloadException('later is not permitted for raw-sqs connector');
     }
 
-
     /**
      * @return string
      */
@@ -138,6 +137,14 @@ public function getJobClass(): string
         return $this->jobClass;
     }
 
+    /**
+     * @return int|null
+     */
+    public function getRateLimit(): ?int
+    {
+        return $this->rateLimit;
+    }
+
     /**
      * @param string $jobClass
      * @return $this

diff --git a/tests/RawSqsConnectorTest.php b/tests/RawSqsConnectorTest.php
@@ -26,6 +26,42 @@ public function testConnectShouldReturnRawSqsQueue(): void
         $this->assertInstanceOf(RawSqsQueue::class, $rawSqsQueue);
     }
 
+    public function testCanSpecifyAnIntegerRateLimit(): void
+    {
+        $rawSqsConnector = new RawSqsConnector();
+
+        $config = [
+            'key' => 'key',
+            'secret' => 'secret',
+            'region' => 'eu-west-2',
+            'queue' => 'raw-sqs',
+            'job_class' => TestJobClass::class,
+            'rate_limit' => 1
+        ];
+
+        $rawSqsQueue = $rawSqsConnector->connect($config);
+
+        $this->assertEquals(1, $rawSqsQueue->getRateLimit());
+    }
+
+    public function testCanSpecifyACallableRateLimit(): void
+    {
+        $rawSqsConnector = new RawSqsConnector();
+
+        $config = [
+            'key' => 'key',
+            'secret' => 'secret',
+            'region' => 'eu-west-2',
+            'queue' => 'raw-sqs',
+            'job_class' => TestJobClass::class,
+            'rate_limit' => fn () => 1
+        ];
+
+        $rawSqsQueue = $rawSqsConnector->connect($config);
+
+        $this->assertEquals(1, $rawSqsQueue->getRateLimit());
+    }
+
     public function testShouldThrowInvalidArgumentExceptionIfClassDoesNotExist(): void
     {
         $this->expectException(\InvalidArgumentException::class);

diff --git a/tests/RawSqsQueueTest.php b/tests/RawSqsQueueTest.php
@@ -202,48 +202,6 @@ public function testWillReturnMessageIfRateLimitEnabled(): void
         $this->expectNotToPerformAssertions();
     }
 
-    public function testWillReturnMessageIfRateLimitEnabledUsingAClosure(): void
-    {
-        $firstName = 'Primitive';
-        $lastName = 'Sense';
-
-        $sqsReturnMessage = [
-            'Body' => json_encode([
-                'first_name' => $firstName,
-                'last_name' => $lastName
-            ])
-        ];
-
-        $sqsClientMock = Mockery::mock(SqsClient::class);
-        $sqsClientMock->shouldReceive('receiveMessage')
-            ->andReturn([
-                'Messages' => [
-                    $sqsReturnMessage
-                ]
-            ]);
-
-        $rawSqsQueue = Mockery::mock(RawSqsQueue::class, [
-            $sqsClientMock,
-            'default',
-            'prefix'
-        ])
-            ->shouldAllowMockingProtectedMethods()
-            ->makePartial();
-
-        $rawSqsQueue
-            ->shouldReceive('hasRemainingAttempts')
-            ->andReturn(true);
-
-        $container = Mockery::mock(Container::class);
-        $rawSqsQueue->setContainer($container);
-        $rawSqsQueue->setJobClass(TestJobClass::class);
-        $rawSqsQueue->setRateLimit(fn () => 1);
-
-        $rawSqsQueue->pop();
-
-        $this->expectNotToPerformAssertions();
-    }
-
     public function testWillNotReturnMessageIfRateLimitEnabledButNoAttemptsLeft(): void
     {
         $sqsClientMock = Mockery::mock(SqsClient::class);