Module: TrackRelay::Validators::CatalogValidator

Defined in:
lib/track_relay/validators/catalog_validator.rb

Overview

Validates an EventDefinition at catalog-load time.

Runs both GA4 constraint checks (Ga4Constraints) and the reserved-key collision guard. Failures raise immediately so the offending catalog file fails to load — much louder than a silent collision at track time.

Two distinct error types are raised by design:

This module is invoked by ‘EventBuilder#event` (DSL) before registering the definition with the catalog. It is also safe to call against externally-built definitions (e.g. tests).

Class Method Summary collapse

Class Method Details

.validate!(definition) ⇒ void

This method returns an undefined value.

Run all catalog-load-time checks against a definition.

Parameters:

Raises:



33
34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/track_relay/validators/catalog_validator.rb', line 33

def validate!(definition)
  Ga4Constraints.validate_event_name!(definition.name)
  Ga4Constraints.validate_param_count!(definition.params)

  definition.params.each_key do |param_name|
    if TrackRelay::RESERVED_KEYS.include?(param_name)
      raise ReservedKeyError,
        "Param #{param_name.inspect} on event #{definition.name.inspect} collides with a reserved context key — rename to e.g. :actor_user_id, :session_token, :tracking_client_id, or :http_request"
    end

    Ga4Constraints.validate_param_name!(param_name)
  end
end