zaikio / zaikio-webhooks Goto Github PK

Problem

In Mission Control, the ApplicationController enables authentication using a before_filter. Zaikio::Webhooks::WebhooksController, which inherits from MC's ApplicationController, inherits this filter, effectively preventing webhooks from being delivered.

Cause

The webhook engine's Zaikio::Webhooks::WebhooksController inherits from ApplicationController, but doesn't define it's own ApplicationController.

Ideas

I've worked around the issue by creating a custom controller + route:

# app/controllers/webhooks_controller.rb
class WebhooksController < Zaikio::Webhooks::WebhooksController
  skip_before_filter :ensure_authentication, only: %i[receive_event]
end

# config/routes.rb
post "/zaikio/webhook/:client_name", to: "webhooks#receive_event"

I was wondering whether this is the most appropriate solution, or whether it makes sense to include a plain ApplicationController in the Webhook engine, or to include some other mechanism of un-requiring authentication for the webhooks engine.

Other repos (e.g. zai-procurement) don't run into this issue because they have a different controller structure:
ApplicationController (not authed)
Consumers::ApplicationController < ApplicationController (authed)
Suppliers::ApplicationController < ApplicationController (authed)

Thoughts?