-
Notifications
You must be signed in to change notification settings - Fork 465
/
registry.rb
215 lines (186 loc) · 7.51 KB
/
registry.rb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
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
129
130
131
132
133
134
135
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
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
# typed: strict
# frozen_string_literal: true
module ShopifyAPI
module Webhooks
class Registry
@registry = T.let({}, T::Hash[String, Registration])
class << self
extend T::Sig
sig do
params(topic: String,
delivery_method: Symbol,
path: String,
handler: T.nilable(Handler),
fields: T.nilable(T.any(String, T::Array[String]))).void
end
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
sig { void }
def clear
@registry.clear
end
sig do
params(
topic: String,
session: Auth::Session,
).returns(RegisterResult)
end
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
sig do
params(
session: Auth::Session,
).returns(T::Array[RegisterResult])
end
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
sig do
params(
topic: String,
session: T.nilable(Auth::Session),
).returns(T::Hash[String, T.untyped])
end
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
sig do
params(
topic: String,
client: Clients::Graphql::Admin,
).returns(T.nilable(String))
end
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
sig { params(request: Request).void }
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
private
sig do
params(
client: Clients::Graphql::Admin,
registration: Registration,
).returns(T::Hash[Symbol, T.untyped])
end
def webhook_registration_needed?(client, registration)
check_response = client.query(query: registration.build_check_query)
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]))
must_register = parsed_check_result[:current_address] != registration.callback_address
{ webhook_id: parsed_check_result[:webhook_id], must_register: must_register }
end
sig do
params(
client: Clients::Graphql::Admin,
registration: Registration,
webhook_id: T.nilable(String),
).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))
raise Errors::WebhookRegistrationError, "Failed to register webhook with Shopify" unless register_response.ok?
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) }
def registration_sucessful?(body, mutation_name)
!body.dig("data", mutation_name, "webhookSubscription").nil?
end
end
end
end
end