Merge pull request #1313 from eshopguide/fix/registry-process-with-response-as-struct

Webhook Registry: Ensuring that the response body is always a Hash, even if ShopifyAPI.Context.response_as_struct is true.

Author: lizkenyon

CHANGELOG.md

@@ -6,6 +6,7 @@ Note: For changes to the API, see https://shopify.dev/changelog?filter=api
 
 ## 14.3.0
 - [#1312](https://github.com/Shopify/shopify-api-ruby/pull/1312) Use same leeway for `exp` and `nbf` when parsing JWT
+- [#1313](https://github.com/Shopify/shopify-api-ruby/pull/1313) Fix: Webhook Registry now working with response_as_struct enabled
 - [#1314](https://github.com/Shopify/shopify-api-ruby/pull/1314)
   - Add new session util method `SessionUtils::session_id_from_shopify_id_token`
   - `SessionUtils::current_session_id` now accepts shopify Id token in the format of `Bearer this_token` or just `this_token`

lib/shopify_api/clients/graphql/client.rb

@@ -28,9 +28,10 @@ def initialize(session:, base_path:, api_version: nil)
             variables: T.nilable(T::Hash[T.any(Symbol, String), T.untyped]),
             headers: T.nilable(T::Hash[T.any(Symbol, String), T.untyped]),
             tries: Integer,
+            response_as_struct: T.nilable(T::Boolean),
           ).returns(HttpResponse)
         end
-        def query(query:, variables: nil, headers: nil, tries: 1)
+        def query(query:, variables: nil, headers: nil, tries: 1, response_as_struct: Context.response_as_struct)
           body = { query: query, variables: variables }
           @http_client.request(
             HttpRequest.new(
@@ -42,7 +43,7 @@ def query(query:, variables: nil, headers: nil, tries: 1)
               body_type: "application/json",
               tries: tries,
             ),
-            response_as_struct: Context.response_as_struct || false,
+            response_as_struct: response_as_struct || false,
           )
         end
       end

lib/shopify_api/clients/graphql/storefront.rb

@@ -45,11 +45,13 @@ def initialize(shop, storefront_access_token = nil, private_token: nil, public_t
             variables: T.nilable(T::Hash[T.any(Symbol, String), T.untyped]),
             headers: T.nilable(T::Hash[T.any(Symbol, String), T.untyped]),
             tries: Integer,
+            response_as_struct: T.nilable(T::Boolean),
           ).returns(HttpResponse)
         end
-        def query(query:, variables: nil, headers: {}, tries: 1)
+        def query(query:, variables: nil, headers: {}, tries: 1, response_as_struct: Context.response_as_struct)
           T.must(headers).merge!({ @storefront_auth_header => @storefront_access_token })
-          super(query: query, variables: variables, headers: headers, tries: tries)
+          super(query: query, variables: variables, headers: headers, tries: tries,
+                    response_as_struct: response_as_struct)
         end
       end
     end

lib/shopify_api/webhooks/registry.rb

@@ -138,7 +138,7 @@ def unregister(topic:, session:)
             }
           MUTATION
 
-          delete_response = client.query(query: delete_mutation)
+          delete_response = client.query(query: delete_mutation, response_as_struct: false)
           raise Errors::WebhookRegistrationError,
             "Failed to delete webhook from Shopify" unless delete_response.ok?
           result = T.cast(delete_response.body, T::Hash[String, T.untyped])
@@ -170,7 +170,7 @@ def get_webhook_id(topic:, client:)
             }
           QUERY
 
-          fetch_id_response = client.query(query: fetch_id_query)
+          fetch_id_response = client.query(query: fetch_id_query, response_as_struct: false)
           raise Errors::WebhookRegistrationError,
             "Failed to fetch webhook from Shopify" unless fetch_id_response.ok?
           body = T.cast(fetch_id_response.body, T::Hash[String, T.untyped])
@@ -216,7 +216,7 @@ def process(request)
           ).returns(T::Hash[Symbol, T.untyped])
         end
         def webhook_registration_needed?(client, registration)
-          check_response = client.query(query: registration.build_check_query)
+          check_response = client.query(query: registration.build_check_query, response_as_struct: false)
           raise Errors::WebhookRegistrationError,
             "Failed to check if webhook was already registered" unless check_response.ok?
           parsed_check_result = registration.parse_check_result(T.cast(check_response.body, T::Hash[String, T.untyped]))
@@ -233,7 +233,8 @@ def webhook_registration_needed?(client, registration)
           ).returns(T::Hash[String, T.untyped])
         end
         def send_register_request(client, registration, webhook_id)
-          register_response = client.query(query: registration.build_register_query(webhook_id: webhook_id))
+          register_response = client.query(query: registration.build_register_query(webhook_id: webhook_id),
+            response_as_struct: false)
 
           raise Errors::WebhookRegistrationError, "Failed to register webhook with Shopify" unless register_response.ok?
 

test/webhooks/registry_test.rb

@@ -59,6 +59,29 @@ def test_process
         assert(handler_called)
       end
 
+      def test_process_with_response_as_struct
+        modify_context(response_as_struct: true)
+
+        handler_called = false
+
+        handler = TestHelpers::FakeWebhookHandler.new(
+          lambda do |topic, shop, body,|
+            assert_equal(@topic, topic)
+            assert_equal(@shop, shop)
+            assert_equal({}, body)
+            handler_called = true
+          end,
+        )
+
+        ShopifyAPI::Webhooks::Registry.add_registration(
+          topic: @topic, path: "path", delivery_method: :http, handler: handler,
+        )
+
+        ShopifyAPI::Webhooks::Registry.process(@webhook_request)
+
+        assert(handler_called)
+      end
+
       def test_process_new_handler
         handler_called = false