Fix for Job Serialization for Webhooks (gnikyt#624)

* Fix to remove job class from arguments passed to job, issues with serialization occurs

* StyleCI fixes

* Adjustment to webhook jobs and webhook stub to use scalar values for job arguments

* Fix to StyleCI

Author: Tyler King

src/ShopifyApp/Console/stubs/webhook-job.stub

@@ -15,7 +15,7 @@ class DummyClass implements ShouldQueue
     /**
      * Shop's myshopify domain
      *
-     * @var ShopDomain
+     * @var ShopDomain|string
      */
     public $shopDomain;
 
@@ -29,8 +29,8 @@ class DummyClass implements ShouldQueue
     /**
      * Create a new job instance.
      *
-     * @param ShopDomain $shopDomain The shop's myshopify domain
-     * @param stdClass   $data       The webhook data (JSON decoded)
+     * @param string   $shopDomain The shop's myshopify domain.
+     * @param stdClass $data       The webhook data (JSON decoded).
      *
      * @return void
      */
@@ -47,6 +47,9 @@ class DummyClass implements ShouldQueue
      */
     public function handle()
     {
+        // Convert domain
+        $this->shopDomain = ShopDomain::fromNative($this->domain);
+
         // Do what you wish with the data
         // Access domain name as $this->shopDomain->toNative()
     }

src/ShopifyApp/Messaging/Jobs/AppUninstalledJob.php

@@ -9,8 +9,8 @@
 use Illuminate\Queue\SerializesModels;
 use Osiset\ShopifyApp\Actions\CancelCurrentPlan;
 use Osiset\ShopifyApp\Contracts\Commands\Shop as IShopCommand;
-use Osiset\ShopifyApp\Contracts\Objects\Values\ShopDomain;
 use Osiset\ShopifyApp\Contracts\Queries\Shop as IShopQuery;
+use Osiset\ShopifyApp\Objects\Values\ShopDomain;
 use stdClass;
 
 /**
@@ -26,7 +26,7 @@ class AppUninstalledJob implements ShouldQueue
     /**
      * The shop domain.
      *
-     * @var ShopDomain
+     * @var ShopDomain|string
      */
     protected $domain;
 
@@ -40,12 +40,12 @@ class AppUninstalledJob implements ShouldQueue
     /**
      * Create a new job instance.
      *
-     * @param ShopDomain $domain  The shop domain.
-     * @param stdClass   $data   The webhook data (JSON decoded).
+     * @param string   $domain The shop domain.
+     * @param stdClass $data   The webhook data (JSON decoded).
      *
      * @return void
      */
-    public function __construct(ShopDomain $domain, stdClass $data)
+    public function __construct(string $domain, stdClass $data)
     {
         $this->domain = $domain;
         $this->data = $data;
@@ -65,6 +65,9 @@ public function handle(
         IShopQuery $shopQuery,
         CancelCurrentPlan $cancelCurrentPlanAction
     ): bool {
+        // Convert the domain
+        $this->domain = ShopDomain::fromNative($this->domain);
+
         // Get the shop
         $shop = $shopQuery->getByDomain($this->domain);
         $shopId = $shop->getId();

src/ShopifyApp/Traits/WebhookController.php

@@ -5,7 +5,6 @@
 use Illuminate\Http\Request;
 use Illuminate\Http\Response as ResponseResponse;
 use Illuminate\Support\Facades\Response;
-use Osiset\ShopifyApp\Objects\Values\ShopDomain;
 
 /**
  * Responsible for handling incoming webhook requests.
@@ -29,7 +28,7 @@ public function handle(string $type, Request $request): ResponseResponse
         $jobData = json_decode($request->getContent());
 
         $jobClass::dispatch(
-            ShopDomain::fromNative($request->header('x-shopify-shop-domain')),
+            $request->header('x-shopify-shop-domain'),
             $jobData
         );
 

tests/Messaging/Jobs/AppUninstalledTest.php

@@ -38,7 +38,7 @@ public function testJobSoftDeletesShopAndCharges()
 
         // Run the job
         AppUninstalledJob::dispatchNow(
-            $shop->getDomain(),
+            $shop->getDomain()->toNative(),
             json_decode(file_get_contents(__DIR__.'/../../fixtures/app_uninstalled.json'))
         );
 

tests/Traits/WebhookControllerTest.php

@@ -3,6 +3,7 @@
 namespace Osiset\ShopifyApp\Test\Controllers;
 
 use Illuminate\Support\Facades\Queue;
+use Osiset\ShopifyApp\Objects\Values\ShopDomain;
 use Osiset\ShopifyApp\Test\TestCase;
 
 require_once __DIR__.'/../Stubs/OrdersCreateJob.php';
@@ -36,9 +37,9 @@ public function testSuccess(): void
         // Check it was created and job was pushed
         $response->assertStatus(201);
         Queue::assertPushed(\App\Jobs\OrdersCreateJob::class, function ($job) use ($shop) {
-            return $job->shopDomain->isSame($shop->getDomain())
-                   && $job->data instanceof \stdClass
-                   && $job->data->email === 'jon@doe.ca';
+            return ShopDomain::fromNative($job->shopDomain)->isSame($shop->getDomain())
+                && $job->data instanceof \stdClass
+                && $job->data->email === 'jon@doe.ca';
         });
     }