Check for deleted products in Magento

.github/workflows/tests.yml

@@ -11,7 +11,7 @@ jobs:
                 os: [ubuntu-latest]
                 php: [8.1, 8.2]
                 laravel: [10.*]
-                stability: [prefer-lowest, prefer-stable]
+                stability: [prefer-stable]
                 include:
                     - laravel: 10.*
                       testbench: 8.*

README.md

@@ -7,8 +7,7 @@
 </p>
 
 This package tracks if products exist in Magento by storing the status locally in the DB.
-We developed this to prevent multiple calls when multiple packages need to check product existance in Magento.
-This package does do the assumption that once a product exists in Magento it will always be there.
+We developed this to prevent multiple calls when multiple packages need to check product existence in Magento.
 
 
 ## Installation
@@ -26,6 +25,9 @@ $schedule->command(\JustBetter\MagentoProducts\Commands\CheckKnownProductsExiste
 $schedule->command(\JustBetter\MagentoProducts\Commands\DiscoverMagentoProductsCommand::class)->daily();
 ```
 
+> [!IMPORTANT]
+> This package requires Job Batching
+
 ## Usage
 
 ### Checking if a product exists in Magento

composer.json

@@ -9,10 +9,13 @@
     "laravel/framework": "^10.0"
   },
   "require-dev": {
-    "laravel/pint": "^1.6",
-    "nunomaduro/larastan": "^2.5",
-    "phpstan/phpstan-mockery": "^1.1",
-    "phpunit/phpunit": "^10.0"
+      "laravel/pint": "^1.6",
+      "nunomaduro/larastan": "^2.5",
+      "orchestra/testbench": "^8.0",
+      "pestphp/pest": "^2.0",
+      "phpstan/phpstan-mockery": "^1.1",
+      "phpunit/phpunit": "^10.0",
+      "doctrine/dbal": "^3.7.1"
   },
   "authors": [
     {
@@ -43,7 +46,10 @@
     "fix-style": "pint"
   },
   "config": {
-    "sort-packages": true
+    "sort-packages": true,
+    "allow-plugins": {
+      "pestphp/pest-plugin": true
+    }
   },
   "extra": {
     "laravel": {

database/migrations/2023_11_21_102103_magento_products_retrieved_field.php

@@ -0,0 +1,20 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+return new class extends Migration
+{
+    public function up(): void
+    {
+        Schema::table('magento_products', function (Blueprint $table): void {
+            $table->boolean('retrieved')->default(false)->after('last_checked');
+        });
+    }
+
+    public function down(): void
+    {
+        Schema::dropColumns('magento_products', ['retrieved']);
+    }
+};

phpunit.xml

@@ -1,17 +1,14 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:noNamespaceSchemaLocation="./vendor/phpunit/phpunit/phpunit.xsd"
-         bootstrap="vendor/autoload.php"
-         colors="true"
->
-    <testsuites>
-        <testsuite name="Tests">
-            <directory>./tests/*</directory>
-        </testsuite>
-    </testsuites>
-    <coverage>
-        <include>
-            <directory suffix=".php">./src</directory>
-        </include>
-    </coverage>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.4/phpunit.xsd" bootstrap="vendor/autoload.php" colors="true">
+  <testsuites>
+    <testsuite name="Tests">
+      <directory>./tests/*</directory>
+    </testsuite>
+  </testsuites>
+  <coverage/>
+  <source>
+    <include>
+      <directory suffix=".php">./src</directory>
+    </include>
+  </source>
 </phpunit>

src/Actions/CheckRemovedProducts.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace JustBetter\MagentoProducts\Actions;
+
+use JustBetter\MagentoProducts\Contracts\ChecksRemovedProducts;
+use JustBetter\MagentoProducts\Events\ProductDeletedInMagentoEvent;
+use JustBetter\MagentoProducts\Models\MagentoProduct;
+
+class CheckRemovedProducts implements ChecksRemovedProducts
+{
+    public function check(): void
+    {
+        $query = MagentoProduct::query()
+            ->where('exists_in_magento', '=', true)
+            ->where('retrieved', '=', false);
+
+        $skus = $query->select(['sku'])->get();
+
+        $query->update([
+            'exists_in_magento' => false,
+        ]);
+
+        $skus->each(fn (MagentoProduct $product) => ProductDeletedInMagentoEvent::dispatch($product->sku));
+    }
+
+    public static function bind(): void
+    {
+        app()->singleton(ChecksRemovedProducts::class, static::class);
+    }
+}

src/Actions/DiscoverMagentoProducts.php

@@ -0,0 +1,46 @@
+<?php
+
+namespace JustBetter\MagentoProducts\Actions;
+
+use Illuminate\Bus\Batch;
+use JustBetter\MagentoProducts\Contracts\DiscoversMagentoProducts;
+use JustBetter\MagentoProducts\Contracts\ProcessesMagentoSkus;
+use JustBetter\MagentoProducts\Contracts\RetrievesMagentoSkus;
+use JustBetter\MagentoProducts\Jobs\DiscoverMagentoProductsJob;
+use JustBetter\MagentoProducts\Models\MagentoProduct;
+
+class DiscoverMagentoProducts implements DiscoversMagentoProducts
+{
+    public function __construct(
+        protected RetrievesMagentoSkus $magentoSkus,
+        protected ProcessesMagentoSkus $processor
+    ) {
+    }
+
+    public function discover(int $page, Batch $batch): void
+    {
+        if ($page === 0) {
+            MagentoProduct::query()
+                ->update(['retrieved' => false]);
+        }
+
+        $skus = $this->magentoSkus->retrieve($page);
+
+        $hasNextPage = $skus->count() == config('magento-products.page_size');
+
+        if ($hasNextPage) {
+            $batch->add(new DiscoverMagentoProductsJob($page + 1));
+        }
+
+        MagentoProduct::query()
+            ->whereIn('sku', $skus)
+            ->update(['retrieved' => true]);
+
+        $this->processor->process($skus);
+    }
+
+    public static function bind(): void
+    {
+        app()->singleton(DiscoversMagentoProducts::class, static::class);
+    }
+}

src/Actions/ProcessMagentoSkus.php

@@ -15,6 +15,7 @@ public function process(Enumerable $skus): void
             ->whereIn('sku', $skus)
             ->where('exists_in_magento', true)
             ->select(['sku'])
+            ->distinct()
             ->get()
             ->pluck('sku');
 

src/Commands/DiscoverMagentoProductsCommand.php

@@ -3,6 +3,8 @@
 namespace JustBetter\MagentoProducts\Commands;
 
 use Illuminate\Console\Command;
+use Illuminate\Support\Facades\Bus;
+use JustBetter\MagentoProducts\Jobs\CheckRemovedProductsJob;
 use JustBetter\MagentoProducts\Jobs\DiscoverMagentoProductsJob;
 
 class DiscoverMagentoProductsCommand extends Command
@@ -13,11 +15,11 @@ class DiscoverMagentoProductsCommand extends Command
 
     public function handle(): int
     {
-        $this->info('Dispatching...');
-
-        DiscoverMagentoProductsJob::dispatch();
-
-        $this->info('Done!');
+        Bus::batch([new DiscoverMagentoProductsJob])
+            ->name('Discover Magento Products')
+            ->then(fn () => CheckRemovedProductsJob::dispatch())
+            ->onQueue(config('magento-products.queue'))
+            ->dispatch();
 
         return static::SUCCESS;
     }

src/Contracts/ChecksRemovedProducts.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace JustBetter\MagentoProducts\Contracts;
+
+interface ChecksRemovedProducts
+{
+    public function check(): void;
+}

src/Contracts/DiscoversMagentoProducts.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace JustBetter\MagentoProducts\Contracts;
+
+use Illuminate\Bus\Batch;
+
+interface DiscoversMagentoProducts
+{
+    public function discover(int $page, Batch $batch): void;
+}

src/Events/ProductCreatedInMagentoEvent.php

@@ -2,7 +2,7 @@
 
 namespace JustBetter\MagentoProducts\Events;
 
-use Illuminate\Foundation\Bus\Dispatchable;
+use Illuminate\Foundation\Events\Dispatchable;
 
 class ProductCreatedInMagentoEvent
 {

src/Events/ProductDeletedInMagentoEvent.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace JustBetter\MagentoProducts\Events;
+
+use Illuminate\Foundation\Events\Dispatchable;
+
+class ProductDeletedInMagentoEvent
+{
+    use Dispatchable;
+
+    public function __construct(public string $sku)
+    {
+    }
+}

src/Events/ProductDiscoveredEvent.php

@@ -2,7 +2,7 @@
 
 namespace JustBetter\MagentoProducts\Events;
 
-use Illuminate\Foundation\Bus\Dispatchable;
+use Illuminate\Foundation\Events\Dispatchable;
 
 class ProductDiscoveredEvent
 {

src/Jobs/CheckRemovedProductsJob.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace JustBetter\MagentoProducts\Jobs;
+
+use Illuminate\Bus\Queueable;
+use Illuminate\Contracts\Queue\ShouldBeUnique;
+use Illuminate\Contracts\Queue\ShouldQueue;
+use Illuminate\Foundation\Bus\Dispatchable;
+use Illuminate\Queue\InteractsWithQueue;
+use Illuminate\Queue\SerializesModels;
+use JustBetter\MagentoProducts\Contracts\ChecksRemovedProducts;
+
+class CheckRemovedProductsJob implements ShouldBeUnique, ShouldQueue
+{
+    use Dispatchable;
+    use InteractsWithQueue;
+    use Queueable;
+    use SerializesModels;
+
+    public int $tries = 1;
+
+    public function __construct()
+    {
+        $this->onQueue(config('magento-products.queue'));
+    }
+
+    public function handle(ChecksRemovedProducts $contract): void
+    {
+        $contract->check();
+    }
+}

src/Jobs/DiscoverMagentoProductsJob.php

@@ -9,8 +9,7 @@
 use Illuminate\Foundation\Bus\Dispatchable;
 use Illuminate\Queue\InteractsWithQueue;
 use Illuminate\Queue\SerializesModels;
-use JustBetter\MagentoProducts\Contracts\ProcessesMagentoSkus;
-use JustBetter\MagentoProducts\Contracts\RetrievesMagentoSkus;
+use JustBetter\MagentoProducts\Contracts\DiscoversMagentoProducts;
 
 class DiscoverMagentoProductsJob implements ShouldBeUnique, ShouldQueue
 {
@@ -31,23 +30,13 @@ public function __construct(public int $page = 0)
         $this->onQueue(config('magento-products.queue'));
     }
 
-    public function handle(
-        RetrievesMagentoSkus $retrievesMagentoSkus,
-        ProcessesMagentoSkus $processesMagentoSkus
-    ): void {
-        $skus = $retrievesMagentoSkus->retrieve($this->page);
-
-        $hasNextPage = $skus->count() == config('magento-products.page_size', 50);
-
-        if ($hasNextPage) {
-            if ($this->batching()) {
-                $this->batch()->add(new static($this->page + 1)); /** @phpstan-ignore-line */
-            } else {
-                static::dispatch($this->page + 1);
-            }
+    public function handle(DiscoversMagentoProducts $contract): void
+    {
+        if ($this->batch() === null || $this->batch()->cancelled()) {
+            return;
         }
 
-        $processesMagentoSkus->process($skus);
+        $contract->discover($this->page, $this->batch());
     }
 
     public function tags(): array

src/Models/MagentoProduct.php

@@ -2,10 +2,9 @@
 
 namespace JustBetter\MagentoProducts\Models;
 
-use Carbon\Carbon;
 use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Database\Eloquent\Model;
-use JustBetter\MagentoProducts\Contracts\ChecksMagentoExistence;
+use Illuminate\Support\Carbon;
 
 /**
  * @property int $id
@@ -15,6 +14,9 @@
  * @property bool $enabled
  * @property ?array $data
  * @property ?Carbon $last_checked
+ * @property bool $retrieved
+ * @property ?Carbon $created_at
+ * @property ?Carbon $updated_at
  */
 class MagentoProduct extends Model
 {
@@ -24,6 +26,7 @@ class MagentoProduct extends Model
         'data' => 'array',
         'exists_in_magento' => 'boolean',
         'last_checked' => 'datetime',
+        'retrieved' => 'boolean',
     ];
 
     public static function findBySku(string $sku, string $store = null): ?static
@@ -36,17 +39,4 @@ public static function findBySku(string $sku, string $store = null): ?static
 
         return $item;
     }
-
-    /**
-     * @deprecated Use the action ChecksMagentoExistence instead
-     *
-     * @codeCoverageIgnore
-     */
-    public static function existsInMagento(string $sku): bool
-    {
-        /** @var ChecksMagentoExistence $action */
-        $action = app(ChecksMagentoExistence::class);
-
-        return $action->exists($sku);
-    }
 }