Merge pull request #2 from onurkose/feature/webhooks-graphql-support

Feature/webhooks graphql support
onurkose · Jun 20, 2021 · 105b949 · 105b949
2 parents b3a2f11 + e005312
commit 105b949
Show file tree

Hide file tree

Showing 9 changed files with 137 additions and 88 deletions.
diff --git a/src/ShopifyApp/Actions/CreateWebhooks.php b/src/ShopifyApp/Actions/CreateWebhooks.php
@@ -49,9 +49,9 @@ public function __invoke(ShopIdValue $shopId, array $configWebhooks): array
          *
          * @return bool
          */
-        $exists = function (array $webhook, ResponseAccess $webhooks): bool {
-            foreach ($webhooks as $shopWebhook) {
-                if ($shopWebhook['address'] === $webhook['address']) {
+        $exists = static function (array $webhook, ResponseAccess $webhooks): bool {
+            foreach (data_get($webhooks, 'data.webhookSubscriptions.container.edges', []) as $shopWebhook) {
+                if (data_get($shopWebhook, 'node.endpoint.callbackUrl') === $webhook['address']) {
                     // Found the webhook in our list
                     return true;
                 }
@@ -82,10 +82,10 @@ public function __invoke(ShopIdValue $shopId, array $configWebhooks): array
         }
 
         // Delete unused webhooks
-        foreach ($webhooks as $webhook) {
-            if (! in_array($webhook->address, $used)) {
+        foreach (data_get($webhooks, 'data.webhookSubscriptions.container.edges', []) as $webhook) {
+            if (! in_array(data_get($webhook, 'node.endpoint.callbackUrl'), $used)) {
                 // Webhook should be deleted
-                $apiHelper->deleteWebhook($webhook->id);
+                $apiHelper->deleteWebhook(data_get($webhook, 'node.id'));
                 $deleted[] = $webhook;
             }
         }

diff --git a/src/ShopifyApp/Actions/DeleteWebhooks.php b/src/ShopifyApp/Actions/DeleteWebhooks.php
@@ -47,9 +47,9 @@ public function __invoke(ShopId $shopId): array
         $webhooks = $apiHelper->getWebhooks();
 
         $deleted = [];
-        foreach ($webhooks as $webhook) {
+        foreach (data_get($webhooks, 'data.webhookSubscriptions.container.edges', []) as $webhook) {
             // Its a webhook in the config, delete it
-            $apiHelper->deleteWebhook($webhook['id']);
+            $apiHelper->deleteWebhook(data_get($webhook, 'node.id'));
 
             // Keep track of what was deleted
             $deleted[] = $webhook;

diff --git a/src/ShopifyApp/Contracts/ApiHelper.php b/src/ShopifyApp/Contracts/ApiHelper.php
@@ -167,11 +167,11 @@ public function createWebhook(array $payload): ResponseAccess;
     /**
      * Delete a webhook.
      *
-     * @param int $webhookId The webhook ID to delete.
+     * @param string $webhookId The webhook ID to delete.
      *
      * @return void
      */
-    public function deleteWebhook(int $webhookId);
+    public function deleteWebhook(string $webhookId);
 
     /**
      * Creates a usage charge for a recurring charge.

diff --git a/src/ShopifyApp/Services/ApiHelper.php b/src/ShopifyApp/Services/ApiHelper.php
@@ -326,56 +326,99 @@ public function createChargeGraphQL(PlanDetailsTransfer $payload): ResponseAcces
 
     /**
      * {@inheritdoc}
-     * TODO: Convert to GraphQL.
+     * @throws Exception
      */
     public function getWebhooks(array $params = []): ResponseAccess
     {
-        // Setup the params
-        $reqParams = array_merge(
-            [
-                'limit'  => 250,
-                'fields' => 'id,address',
-            ],
-            $params
-        );
+        $query = '
+        query webhookSubscriptions($first: Int!) {
+            webhookSubscriptions(first: $first) {
+                edges {
+                    node {
+                        id
+                        topic
+                        endpoint {
+                            ...on WebhookHttpEndpoint {
+                                callbackUrl
+                            }
+                        }
+                    }
+                }
+            }
+        }
+        ';
 
-        // Fire the request
-        $response = $this->doRequest(
-            ApiMethod::GET(),
-            '/admin/webhooks.json',
-            $reqParams
-        );
+        $variables = [
+            'first' => 250,
+        ];
 
-        return $response['body']['webhooks'];
+        $response = $this->doRequestGraphQL($query, $variables);
+
+        return $response['body'];
     }
 
     /**
      * {@inheritdoc}
-     * TODO: Convert to GraphQL.
+     * @throws Exception
      */
     public function createWebhook(array $payload): ResponseAccess
     {
-        // Fire the request
-        $response = $this->doRequest(
-            ApiMethod::POST(),
-            '/admin/webhooks.json',
-            ['webhook' => $payload]
-        );
+        $query = '
+        mutation webhookSubscriptionCreate(
+            $topic: WebhookSubscriptionTopic!,
+            $webhookSubscription: WebhookSubscriptionInput!
+        ) {
+            webhookSubscriptionCreate(
+                topic: $topic
+                webhookSubscription: $webhookSubscription
+            ) {
+                userErrors {
+                    field
+                    message
+                }
+                webhookSubscription {
+                    id
+                }
+            }
+        }
+        ';
 
-        return $response['body']['webhook'];
+        $variables = [
+            'topic' => $payload['topic'],
+            'webhookSubscription' => [
+                'callbackUrl' => $payload['address'],
+                'format' => 'JSON',
+            ],
+        ];
+
+        $response = $this->doRequestGraphQL($query, $variables);
+
+        return $response['body'];
     }
 
     /**
      * {@inheritdoc}
-     * TODO: Convert to GraphQL.
+     * @throws Exception
      */
-    public function deleteWebhook(int $webhookId): ResponseAccess
+    public function deleteWebhook(string $webhookId): ResponseAccess
     {
-        // Fire the request
-        $response = $this->doRequest(
-            ApiMethod::DELETE(),
-            "/admin/webhooks/{$webhookId}.json"
-        );
+        $query = '
+        mutation webhookSubscriptionDelete($id: ID!) {
+            webhookSubscriptionDelete(id: $id) {
+                userErrors {
+                    field
+                    message
+                }
+                deletedWebhookSubscriptionId
+            }
+        }
+        ';
+
+        $variables = [
+            'id' => $webhookId,
+        ];
+
+        $response = $this->doRequestGraphQL($query, $variables);
 
         return $response['body'];
     }
@@ -428,7 +471,7 @@ protected function chargeApiPath(ChargeType $chargeType): string
      *
      * @param ApiMethod $method  The HTTP method.
      * @param string    $path    The endpoint path.
-     * @param array     $payload The optional payload to send to the endpoint.
+     * @param ?array    $payload The optional payload to send to the endpoint.
      *
      * @throws RequestException
      *
@@ -459,7 +502,7 @@ protected function doRequest(ApiMethod $method, string $path, array $payload = n
      *
      * @return array
      */
-    protected function doRequestGraphQL(string $query, array $payload = null)
+    protected function doRequestGraphQL(string $query, array $payload = []): array
     {
         $response = $this->api->graph($query, $payload);
         if ($response['errors'] !== false) {

diff --git a/tests/Actions/CreateWebhooksTest.php b/tests/Actions/CreateWebhooksTest.php
@@ -25,7 +25,7 @@ public function testShouldNotCreateIfExists(): void
         // Create the config
         $webhooks = [
             [
-                'topic'   => 'orders/create',
+                'topic'   => 'ORDERS_CREATE',
                 'address' => 'https://localhost/webhooks/orders-create',
             ],
         ];
@@ -35,7 +35,7 @@ public function testShouldNotCreateIfExists(): void
         $this->setApiStub();
         ApiStub::stubResponses([
             'get_webhooks',
-            'post_webhook',
+            'delete_webhook',
         ]);
 
         // Create the shop
@@ -50,23 +50,23 @@ public function testShouldNotCreateIfExists(): void
 
         $this->assertCount(0, $result['created']);
         $this->assertCount(1, $result['deleted']);
-        $this->assertSame($result['deleted'][0]['address'], 'http://apple.com/uninstall');
+        $this->assertSame($result['deleted'][0]['node']['endpoint']['callbackUrl'], 'http://apple.com/uninstall');
     }
 
     public function testShouldCreate(): void
     {
         // Create the config
         $webhooks = [
             [
-                'topic'   => 'orders/create',
+                'topic'   => 'ORDERS_CREATE',
                 'address' => 'https://localhost/webhooks/orders-create',
             ],
             [
-                'topic'   => 'orders/create',
+                'topic'   => 'ORDERS_CREATE',
                 'address' => 'https://localhost/webhooks/orders-create-different',
             ],
             [
-                'topic'   => 'app/uninstalled',
+                'topic'   => 'APP_UNINSTALLED',
                 'address' => 'http://apple.com/uninstall',
             ],
         ];

diff --git a/tests/Actions/DeleteWebhooksTest.php b/tests/Actions/DeleteWebhooksTest.php
@@ -6,7 +6,7 @@
 use Osiset\ShopifyApp\Test\Stubs\Api as ApiStub;
 use Osiset\ShopifyApp\Test\TestCase;
 
-class DeleteWebhooksTestTest extends TestCase
+class DeleteWebhooksTest extends TestCase
 {
     /**
      * @var \Osiset\ShopifyApp\Actions\DeleteWebhooks
@@ -26,8 +26,8 @@ public function testShouldDelete(): void
         $this->setApiStub();
         ApiStub::stubResponses([
             'get_webhooks',
-            'empty',
-            'empty',
+            'delete_webhook',
+            'delete_webhook',
         ]);
 
         // Create the shop

diff --git a/tests/fixtures/delete_webhook.json b/tests/fixtures/delete_webhook.json
@@ -0,0 +1,7 @@
+{
+    "data": {
+        "webhookSubscriptionDelete": {
+            "id": "gid://shopify/WebhookSubscription/1016678842437"
+        }
+    }
+}
diff --git a/tests/fixtures/get_webhooks.json b/tests/fixtures/get_webhooks.json
@@ -1,28 +1,32 @@
 {
-  "webhooks": [
-    {
-      "id": 4759306,
-      "address": "https:\/\/localhost\/webhooks\/orders-create",
-      "topic": "orders\/create",
-      "created_at": "2017-03-20T16:02:17-04:00",
-      "updated_at": "2017-03-20T16:02:17-04:00",
-      "format": "json",
-      "fields": [
-      ],
-      "metafield_namespaces": [
-      ]
-    },
-    {
-      "id": 901431826,
-      "address": "http:\/\/apple.com\/uninstall",
-      "topic": "app\/uninstalled",
-      "created_at": "2017-03-20T16:02:17-04:00",
-      "updated_at": "2017-03-20T16:02:17-04:00",
-      "format": "json",
-      "fields": [
-      ],
-      "metafield_namespaces": [
-      ]
+    "data": {
+        "webhookSubscriptions": {
+            "edges": [
+                {
+                    "node": {
+                        "id": "gid://shopify/WebhookSubscription/1016678842437",
+                        "topic": "ORDERS_CREATE",
+                        "endpoint": {
+                            "callbackUrl": "https:\/\/localhost\/webhooks\/orders-create"
+                        },
+                        "created_at": "2017-03-20T16:02:17-04:00",
+                        "updated_at": "2017-03-20T16:02:17-04:00",
+                        "format": "JSON"
+                    }
+                },
+                {
+                    "node": {
+                        "id": "gid://shopify/WebhookSubscription/1016678907973",
+                        "topic": "APP_UNINSTALLED",
+                        "endpoint": {
+                            "callbackUrl": "http://apple.com/uninstall"
+                        },
+                        "created_at": "2017-03-20T16:02:17-04:00",
+                        "updated_at": "2017-03-20T16:02:17-04:00",
+                        "format": "JSON"
+                    }
+                }
+            ]
+        }
     }
-  ]
-}
+}
diff --git a/tests/fixtures/post_webhook.json b/tests/fixtures/post_webhook.json
@@ -1,12 +1,7 @@
 {
-    "webhook": {
-        "id": 1047897670,
-        "address": "https://localhost/webhooks/app-uninstalled",
-        "topic": "app/uninstalled",
-        "created_at": "2018-12-18T09:51:03-05:00",
-        "updated_at": "2018-12-18T09:51:03-05:00",
-        "format": "json",
-        "fields": [],
-        "metafield_namespaces": []
+    "data": {
+        "webhookSubscriptionCreate": {
+            "id": "gid://shopify/WebhookSubscription/1016678842437"
+        }
     }
-}
+}