Class: ShopifyAPI::Webhooks::Registry

Inherits:
Object
  • Object
show all
Extended by:
T::Sig
Defined in:
lib/shopify_api/webhooks/registry.rb

Class Method Summary collapse

Class Method Details

.add_registration(topic:, delivery_method:, path:, handler: nil, fields: nil) ⇒ Object 



18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
 
# File 'lib/shopify_api/webhooks/registry.rb', line 18

def add_registration(topic:, delivery_method:, path:, handler: nil, fields: nil)
  @registry[topic] = case delivery_method
  when :pub_sub
    Registrations::PubSub.new(topic: topic, path: path, fields: fields)
  when :event_bridge
    Registrations::EventBridge.new(topic: topic, path: path, fields: fields)
  when :http
    unless handler
      raise Errors::InvalidWebhookRegistrationError, "Cannot create an Http registration without a handler."
    end

    Registrations::Http.new(topic: topic, path: path, handler: handler, fields: fields)
  else
    raise Errors::InvalidWebhookRegistrationError,
      "Unsupported delivery method #{delivery_method}. Allowed values: {:http, :pub_sub, :event_bridge}."
  end
end

.clear ⇒ Object 



37
38
39
 
# File 'lib/shopify_api/webhooks/registry.rb', line 37

def clear
  @registry.clear
end

.get_webhook_id(topic:, client:) ⇒ Object

Raises:



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/shopify_api/webhooks/registry.rb', line 136

def get_webhook_id(topic:, client:)
  fetch_id_query = <<~QUERY
    {
      webhookSubscriptions(first: 1, topics: #{topic.gsub(%r{/|\.}, "_").upcase}) {
        edges {
          node {
            id
          }
        }
      }
    }
  QUERY

  fetch_id_response = client.query(query: fetch_id_query)
  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])
  errors = body["errors"] || {}
  raise Errors::WebhookRegistrationError,
    "Failed to fetch webhook from Shopify: #{errors[0]["message"]}" unless errors.empty?

  edges = body.dig("data", "webhookSubscriptions", "edges") || {}
  return nil if edges.empty?

  edges[0]["node"]["id"].to_s
end

.process(request) ⇒ Object

Raises:



163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/shopify_api/webhooks/registry.rb', line 163

def process(request)
  raise Errors::InvalidWebhookError, "Invalid webhook HMAC." unless Utils::HmacValidator.validate(request)

  handler = @registry[request.topic]&.handler

  unless handler
    raise Errors::NoWebhookHandler, "No webhook handler found for topic: #{request.topic}."
  end

  handler.handle(topic: request.topic, shop: request.shop, body: request.parsed_body)
end

.register(topic:, session:) ⇒ Object 



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/shopify_api/webhooks/registry.rb', line 47

def register(topic:, session:)
  registration = @registry[topic]

  unless registration
    raise Errors::InvalidWebhookRegistrationError, "Webhook topic #{topic} has not been added to the registry."
  end

  client = Clients::Graphql::Admin.new(session: session)
  register_check_result = webhook_registration_needed?(client, registration)

  registered = true
  register_body = nil

  if register_check_result[:must_register]
    register_body = send_register_request(
      client,
      registration,
      register_check_result[:webhook_id],
    )
    registered = registration_sucessful?(
      register_body,
      registration.mutation_name(register_check_result[:webhook_id]),
    )
  end

  RegisterResult.new(topic: topic, success: registered, body: register_body)
end

.register_all(session:) ⇒ Object 



80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/shopify_api/webhooks/registry.rb', line 80

def register_all(session:)
  topics = @registry.keys
  result = T.let([], T::Array[RegisterResult])
  topics.each do |topic|
    register_response = register(
      topic: topic,
      session: session,
    )
    result.push(register_response)
  end
  result
end

.unregister(topic:, session:) ⇒ Object

Raises:



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/shopify_api/webhooks/registry.rb', line 99

def unregister(topic:, session:)
  client = Clients::Graphql::Admin.new(session: session)

  webhook_id = get_webhook_id(topic: topic, client: client)
  return {} if webhook_id.nil?

  delete_mutation = <<~MUTATION
    mutation webhookSubscription {
      webhookSubscriptionDelete(id: "#{webhook_id}") {
        userErrors {
          field
          message
        }
        deletedWebhookSubscriptionId
      }
    }
  MUTATION

  delete_response = client.query(query: delete_mutation)
  raise Errors::WebhookRegistrationError,
    "Failed to delete webhook from Shopify" unless delete_response.ok?
  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?
  user_errors = result.dig("data", "webhookSubscriptionDelete", "userErrors") || {}
  raise Errors::WebhookRegistrationError,
    "Failed to delete webhook from Shopify: #{user_errors[0]["message"]}" unless user_errors.empty?
  result
end