OK Here is my current solution that seems to be working.
Because I am already using sidekiq / redis and have some rate limiting setup in my sidekiq job I used that to limit the orders_updated job to 1 job per 1 second. I had to override the webhooks controller that comes with the shopify_app gem and run the jobs myself ( because the gem wants to use perform_later which activejob uses but I cannot use activejob when including sidekiq::worker ).
So now my job class looks like this:
class OrdersUpdatedJob
include Sidekiq::Worker
require 'unirest'
require "redis"
sidekiq_options throttle: {
threshold: 1,
period: 1.seconds,
key: ->(shop_domain, webhook){ shop_domain }
},
:retry => 5
sidekiq_retry_in do |count|
10 * (count + 1) # (i.e. 10, 20, 30, 40, 50...)
end
sidekiq_retries_exhausted do |msg|
Sidekiq.logger.warn "Failed #{msg['class']} with #{msg['args']}: #{msg['error_message']}"
end
def perform(shop_domain, webhook)
...
end
end
Any my new webhooks controller looks like this:
class WebhooksController < ShopifyApp::WebhooksController
include ShopifyApp::WebhookVerification
class ShopifyApp::MissingWebhookJobError < StandardError; end
def orders_updated
OrdersUpdatedJob.perform_async(shop_domain, webhook_params)
head :no_content
end
def app_uninstalled
AppUninstalledJob.perform_async(shop_domain, webhook_params)
head :no_content
end
def receive
webhook_job_klass.perform_async(shop_domain, webhook_params)
head :no_content
end
private
def webhook_params
params.except(:controller, :action, :type)
end
def webhook_job_klass
"#{webhook_type.classify}Job".safe_constantize or raise ShopifyApp::MissingWebhookJobError
end
def webhook_type
params[:type]
end
end
I am sure there is a better way to handle the response and I probably don't need to include most of those functions since they are brought in by inheritence. Reason why I am not funneling everything to the receive method is because I was getting an error in webhook_job_klass with .classify. I figured that I could simply create my own methods to not have to worry about it for time-saving reasoons.
Last part to modify was the routes:
Rails.application.routes.draw do
root 'home#index'
post '/webhooks/orders_updated', to: 'webhooks#orders_updated'
post '/webhooks/app_uninstalled', to: 'webhooks#app_uninstalled'
post '/webhooks/receive', to: 'webhooks#receive'
mount ShopifyApp::Engine, at: '/'
So now my orders_updated job will only run once every second which will ensure that redis has my order_id stored and also the database should have already been updating saying that the order has already been synced.
Note: I am using https://github.com/gevans/sidekiq-throttler for the throttling.. unless you want to pay the $2K a year for the enterprise version of sidekiq you have to use an alternate method such as this one.
