Removed OStructHashUtils Utility Class.

Added response_as_struct as param to client query to be able to override the default behavior and passed in false for all calls from the webhook registry.

Author: DaveEshopGuide

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/utils/ostruct_hash_utils.rb

@@ -138,11 +138,10 @@ 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(ShopifyAPI::Utils::OstructHashUtils.ensure_hash(delete_response.body),
-            T::Hash[String, T.untyped])
+          result = T.cast(delete_response.body, T::Hash[String, T.untyped])
           errors = result["errors"] || {}
           raise Errors::WebhookRegistrationError,
             "Failed to delete webhook from Shopify: #{errors[0]["message"]}" unless errors.empty?
@@ -171,11 +170,10 @@ 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(ShopifyAPI::Utils::OstructHashUtils.ensure_hash(fetch_id_response.body),
-            T::Hash[String, T.untyped])
+          body = T.cast(fetch_id_response.body, T::Hash[String, T.untyped])
           errors = body["errors"] || {}
           raise Errors::WebhookRegistrationError,
             "Failed to fetch webhook from Shopify: #{errors[0]["message"]}" unless errors.empty?
@@ -218,13 +216,10 @@ 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?
-
-          response_body = ShopifyAPI::Utils::OstructHashUtils.ensure_hash(check_response.body)
-
-          parsed_check_result = registration.parse_check_result(T.cast(response_body, T::Hash[String, T.untyped]))
+          parsed_check_result = registration.parse_check_result(T.cast(check_response.body, T::Hash[String, T.untyped]))
           must_register = parsed_check_result[:current_address] != registration.callback_address
 
           { webhook_id: parsed_check_result[:webhook_id], must_register: must_register }
@@ -238,12 +233,12 @@ 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?
 
-          response_body = ShopifyAPI::Utils::OstructHashUtils.ensure_hash(register_response.body)
-          T.cast(response_body, T::Hash[String, T.untyped])
+          T.cast(register_response.body, T::Hash[String, T.untyped])
         end
 
         sig { params(body: T::Hash[String, T.untyped], mutation_name: String).returns(T::Boolean) }

lib/shopify_api/webhooks/registry.rb

@@ -71,11 +71,11 @@ def test_process_with_response_as_struct
             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)