Module: SpreeCmCommissioner::AuditWrapper

Extended by:
ActiveSupport::Concern
Included in:
Integrations::BookMeBusV1::ExternalClient::Client, Integrations::Larryta::ExternalClient::Client, Integrations::VireakBuntham::ExternalClient::Client
Defined in:
app/models/concerns/spree_cm_commissioner/audit_wrapper.rb

Overview

AuditWrapper is a reusable mixin for classes that make external API calls.

It wraps an API call in a three-event lifecycle:

1. <event_base>.request  – logged before the call
2. <event_base>.response – logged after a successful call (includes timing)
3. <event_base>.failed   – logged when the block raises, then re-raises

Metadata follows this canonical shape:

{
  request:  { method:, endpoint:, body:, params: },
  response: { status:, body: },
  timing:   { duration_ms: },
  error:    nil | { message: }
}

Usage:

include SpreeCmCommissioner::AuditWrapper

with_audit(
  event_base: 'bookmebus.order.hold',
  request:    { method: 'POST', endpoint: '/api/v2/trip_reservations', body: body },
  auditable:  order,
  user:       current_user
) do
  post("#{BASE_PATH}/trip_reservations", body)
end

Instance Method Summary collapse

Instance Method Details

#with_audit(event_base:, request: {}, auditable: nil, user: nil, attempt: 0, retention_days: nil) ⇒ Object

rubocop:disable Metrics/ParameterLists



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
 
# File 'app/models/concerns/spree_cm_commissioner/audit_wrapper.rb', line 32

def with_audit(event_base:, request: {}, auditable: nil, user: nil, # rubocop:disable Metrics/ParameterLists
               attempt: 0, retention_days: nil
)
  correlation_id = SecureRandom.uuid

  shared = {
    auditable: auditable,
    user: user,
    correlation_id: correlation_id,
    attempt: attempt,
    retention_days: retention_days
  }

  # 1. Log the outbound request
  AuditLogger.log!(
    **shared,
    event_type: "#{event_base}.request",
    success: true,
    metadata: build_request_metadata(request)
  )

  started_at = Process.clock_gettime(Process::CLOCK_MONOTONIC)
  result     = yield
  duration   = elapsed_ms(started_at)

  # 2. Log the successful response
  AuditLogger.log!(
    **shared,
    event_type: "#{event_base}.response",
    success: true,
    metadata: build_response_metadata(request, result, duration)
  )

  result
rescue StandardError => e
  duration = elapsed_ms(started_at || Process.clock_gettime(Process::CLOCK_MONOTONIC))

  # 3. Log the failure event
  AuditLogger.log!(
    **shared,
    event_type: "#{event_base}.failed",
    success: false,
    metadata: build_error_metadata(request, e, duration)
  )

  raise
end