Merge pull request #13 from justbetter/feature/magento-available-check

Add Magento availability check
justbetter · Sep 10, 2024 · 880bf12 · 880bf12
2 parents 18f05ef + 3793964
commit 880bf12
Show file tree

Hide file tree

Showing 9 changed files with 92 additions and 17 deletions.
diff --git a/.github/workflows/coverage.yml b/.github/workflows/coverage.yml
@@ -34,7 +34,7 @@ jobs:
             - name: Install dependencies
               run: |
                   composer config allow-plugins.pestphp/pest-plugin true
-                  composer require "laravel/framework:${{ matrix.laravel }}" "orchestra/testbench:${{ matrix.testbench }}" pestphp/pest --no-interaction --no-update
+                  composer require "laravel/framework:${{ matrix.laravel }}" "orchestra/testbench:${{ matrix.testbench }}" --no-interaction --no-update
                   composer update --${{ matrix.stability }} --prefer-dist --no-interaction
             - name: Execute tests
               run: XDEBUG_MODE=coverage php vendor/bin/pest --coverage --min=100
diff --git a/composer.json b/composer.json
@@ -5,7 +5,7 @@
   "license": "MIT",
   "require": {
     "php": "^8.1",
-    "justbetter/laravel-magento-client": "^2.4",
+    "justbetter/laravel-magento-client": "^2.6.1",
     "laravel/framework": "^10.0|^11.0"
   },
   "require-dev": {

diff --git a/src/Actions/CheckMagentoExistence.php b/src/Actions/CheckMagentoExistence.php
@@ -19,6 +19,7 @@ public function exists(string $sku): bool
         $magentoProduct = MagentoProduct::findBySku($sku);
 
         if ($magentoProduct === null) {
+            throw_if(! $this->magento->available(), 'Magento unavailable');
             $response = $this->getMagentoProduct($sku);
 
             $response->throwIf(! in_array($response->status(), [200, 404]));

diff --git a/src/Actions/RetrieveMagentoSkus.php b/src/Actions/RetrieveMagentoSkus.php
@@ -20,7 +20,7 @@ public function retrieve(int $page): Enumerable
             ->paginate($page, config('magento-products.page_size', 50))
             ->get();
 
-        return $this->magento->get('products', $search)->collect('items')->pluck('sku');
+        return $this->magento->get('products', $search)->throw()->collect('items')->pluck('sku');
     }
 
     public static function bind(): void

diff --git a/src/Actions/RetrieveProductData.php b/src/Actions/RetrieveProductData.php
@@ -16,6 +16,8 @@ public function retrieve(string $sku, bool $force = false, ?string $store = null
         $product = MagentoProduct::findBySku($sku, $store);
 
         if ($product === null) {
+            throw_if(! $this->magento->available(), 'Magento unavailable');
+
             $magentoProductResponse = $this->getMagentoProduct($sku, $store);
 
             $magentoProductResponse->throwIf($magentoProductResponse->serverError());

diff --git a/src/Jobs/CheckKnownProductsExistenceJob.php b/src/Jobs/CheckKnownProductsExistenceJob.php
@@ -7,6 +7,7 @@
 use Illuminate\Foundation\Bus\Dispatchable;
 use Illuminate\Queue\InteractsWithQueue;
 use Illuminate\Queue\SerializesModels;
+use JustBetter\MagentoClient\Jobs\Middleware\AvailableMiddleware;
 use JustBetter\MagentoProducts\Contracts\ChecksKnownProducts;
 
 class CheckKnownProductsExistenceJob implements ShouldQueue
@@ -27,4 +28,11 @@ public function handle(ChecksKnownProducts $checksKnownProducts): void
     {
         $checksKnownProducts->handle($this->skus);
     }
+
+    public function middleware(): array
+    {
+        return [
+            new AvailableMiddleware,
+        ];
+    }
 }
diff --git a/src/Jobs/DiscoverMagentoProductsJob.php b/src/Jobs/DiscoverMagentoProductsJob.php
@@ -9,6 +9,7 @@
 use Illuminate\Foundation\Bus\Dispatchable;
 use Illuminate\Queue\InteractsWithQueue;
 use Illuminate\Queue\SerializesModels;
+use JustBetter\MagentoClient\Jobs\Middleware\AvailableMiddleware;
 use JustBetter\MagentoProducts\Contracts\DiscoversMagentoProducts;
 
 class DiscoverMagentoProductsJob implements ShouldBeUnique, ShouldQueue
@@ -50,4 +51,11 @@ public function uniqueId(): int
     {
         return $this->page;
     }
+
+    public function middleware(): array
+    {
+        return [
+            new AvailableMiddleware,
+        ];
+    }
 }
diff --git a/tests/Actions/CheckMagentoExistenceTest.php b/tests/Actions/CheckMagentoExistenceTest.php
@@ -4,9 +4,13 @@
 
 use Illuminate\Http\Client\Request;
 use Illuminate\Support\Facades\Http;
+use JustBetter\MagentoClient\Contracts\ChecksMagento;
 use JustBetter\MagentoProducts\Actions\CheckMagentoExistence;
 use JustBetter\MagentoProducts\Models\MagentoProduct;
 use JustBetter\MagentoProducts\Tests\TestCase;
+use Mockery\MockInterface;
+use PHPUnit\Framework\Attributes\Test;
+use RuntimeException;
 
 class CheckMagentoExistenceTest extends TestCase
 {
@@ -27,19 +31,24 @@ protected function setUp(): void
         ])->preventStrayRequests();
     }
 
-    public function test_existing_product(): void
+    #[Test]
+    public function existing_product(): void
     {
-        MagentoProduct::query()->create(['sku' => '123', 'exists_in_magento' => true, 'last_checked' => now()->subHour()]);
+        MagentoProduct::query()->create([
+            'sku' => '123', 'exists_in_magento' => true, 'last_checked' => now()->subHour(),
+        ]);
 
         $this->assertTrue($this->action->exists('123'));
     }
 
-    public function test_urlencode(): void
+    #[Test]
+    public function urlencode(): void
     {
         $this->assertTrue($this->action->exists('123+456'));
     }
 
-    public function test_new_existing_product(): void
+    #[Test]
+    public function new_existing_product(): void
     {
         $this->assertTrue($this->action->exists('123'));
         $this->assertTrue(MagentoProduct::query()->where('sku', '123')->first()->exists_in_magento); /** @phpstan-ignore-line */
@@ -48,7 +57,8 @@ public function test_new_existing_product(): void
         });
     }
 
-    public function test_new_non_existing_product(): void
+    #[Test]
+    public function new_non_existing_product(): void
     {
         $this->assertFalse($this->action->exists('456'));
         $this->assertFalse(MagentoProduct::query()->where('sku', '456')->first()->exists_in_magento); /** @phpstan-ignore-line */
@@ -57,12 +67,31 @@ public function test_new_non_existing_product(): void
         });
     }
 
-    public function test_existing_last_checked(): void
+    #[Test]
+    public function existing_last_checked(): void
     {
-        MagentoProduct::query()->create(['sku' => '123', 'exists_in_magento' => true, 'last_checked' => now()->subHours(3)]);
+        MagentoProduct::query()->create([
+            'sku' => '123', 'exists_in_magento' => true, 'last_checked' => now()->subHours(3),
+        ]);
 
         $this->assertTrue($this->action->exists('123'));
 
         Http::assertNothingSent();
     }
+
+    #[Test]
+    public function it_throws_exception_when_magento_is_not_available(): void
+    {
+        $this->mock(ChecksMagento::class, function (MockInterface $mock): void {
+            $mock->shouldReceive('available')->andReturnFalse();
+        });
+
+        /** @var CheckMagentoExistence $action */
+        $action = app(CheckMagentoExistence::class);
+
+        $this->expectException(RuntimeException::class);
+        $action->exists('456');
+
+        Http::assertNothingSent();
+    }
 }
diff --git a/tests/Actions/RetrieveProductDataTest.php b/tests/Actions/RetrieveProductDataTest.php
@@ -4,9 +4,13 @@
 
 use Illuminate\Http\Client\Request;
 use Illuminate\Support\Facades\Http;
+use JustBetter\MagentoClient\Contracts\ChecksMagento;
 use JustBetter\MagentoProducts\Actions\RetrieveProductData;
 use JustBetter\MagentoProducts\Models\MagentoProduct;
 use JustBetter\MagentoProducts\Tests\TestCase;
+use Mockery\MockInterface;
+use PHPUnit\Framework\Attributes\Test;
+use RuntimeException;
 
 class RetrieveProductDataTest extends TestCase
 {
@@ -28,7 +32,8 @@ protected function setUp(): void
         ]);
     }
 
-    public function test_it_retrieves_existing_product(): void
+    #[Test]
+    public function it_retrieves_existing_product(): void
     {
         MagentoProduct::query()->create(['sku' => '123', 'data' => ['test'], 'last_checked' => now()->subHour()]);
 
@@ -37,7 +42,8 @@ public function test_it_retrieves_existing_product(): void
         $this->assertEquals(['test'], $data);
     }
 
-    public function test_it_retrieves_new_product(): void
+    #[Test]
+    public function it_retrieves_new_product(): void
     {
         $data = $this->action->retrieve('123+456');
 
@@ -48,7 +54,8 @@ public function test_it_retrieves_new_product(): void
         });
     }
 
-    public function test_it_retrieves_product_for_store(): void
+    #[Test]
+    public function it_retrieves_product_for_store(): void
     {
         $data = $this->action->retrieve('789', false, 'some_store');
 
@@ -64,7 +71,8 @@ public function test_it_retrieves_product_for_store(): void
         });
     }
 
-    public function test_it_retrieves_missing_product(): void
+    #[Test]
+    public function it_retrieves_missing_product(): void
     {
         $data = $this->action->retrieve('404');
 
@@ -75,7 +83,8 @@ public function test_it_retrieves_missing_product(): void
         });
     }
 
-    public function test_it_rechecks_on_interval(): void
+    #[Test]
+    public function it_rechecks_on_interval(): void
     {
         MagentoProduct::query()->create(['sku' => '123', 'data' => ['test'], 'last_checked' => now()->subHours(3)]);
 
@@ -88,7 +97,8 @@ public function test_it_rechecks_on_interval(): void
         });
     }
 
-    public function test_it_forces_recheck(): void
+    #[Test]
+    public function it_forces_recheck(): void
     {
         MagentoProduct::query()->create(['sku' => '123', 'data' => ['test'], 'last_checked' => now()->subHour()]);
 
@@ -101,7 +111,8 @@ public function test_it_forces_recheck(): void
         });
     }
 
-    public function test_it_returns_null_when_check_fails(): void
+    #[Test]
+    public function it_returns_null_when_check_fails(): void
     {
         MagentoProduct::query()->create(['sku' => '404', 'data' => ['test'], 'last_checked' => now()->subHour()]);
 
@@ -113,4 +124,20 @@ public function test_it_returns_null_when_check_fails(): void
             return $request->url() == 'magento/rest/all/V1/products/404';
         });
     }
+
+    #[Test]
+    public function it_throws_exception_when_magento_is_not_available(): void
+    {
+        $this->mock(ChecksMagento::class, function (MockInterface $mock): void {
+            $mock->shouldReceive('available')->andReturnFalse();
+        });
+
+        /** @var RetrieveProductData $action */
+        $action = app(RetrieveProductData::class);
+
+        $this->expectException(RuntimeException::class);
+        $action->retrieve('456');
+
+        Http::assertNothingSent();
+    }
 }