Foundation.Validation.EventValidator (foundation v0.1.0)

Pure validation functions for event structures.

Contains only validation logic - no side effects, no business logic. All functions are pure and easily testable.

This module validates Event structs to ensure they contain valid data before storage or processing.

Examples

iex> event = Foundation.Types.Event.new([
...>   event_id: 123,
...>   event_type: :function_entry,
...>   timestamp: System.monotonic_time()
...> ])
iex> Foundation.Validation.EventValidator.validate(event)
:ok

Summary

Types

max_data_size()

Maximum allowed size for event data in bytes

Functions

validate(event)

Validate an event structure.

validate_data_size(event)

Validate event data size to prevent memory issues.

validate_event_type(event_type)

Validate event type is allowed.

validate_field_types(event)

Validate event field types.

validate_required_fields(event)

Validate that an event has all required fields.

Types

max_data_size()

@type max_data_size() :: 1_000_000

Maximum allowed size for event data in bytes

Functions

validate(event)

@spec validate(Foundation.Types.Event.t()) ::
  :ok | {:error, Foundation.Types.Error.t()}

Validate an event structure.

Performs comprehensive validation including required fields, types, and data size.

Parameters

  • event: The Event struct to validate

Examples

iex> valid_event = Event.new([event_id: 1, event_type: :test, timestamp: 123])
iex> EventValidator.validate(valid_event)
:ok

iex> invalid_event = Event.new([event_id: nil, event_type: :test])
iex> EventValidator.validate(invalid_event)
{:error, %Error{error_type: :validation_failed}}

validate_data_size(event)

@spec validate_data_size(Foundation.Types.Event.t()) ::
  :ok | {:error, Foundation.Types.Error.t()}

Validate event data size to prevent memory issues.

Checks that the event data doesn't exceed the maximum allowed size.

validate_event_type(event_type)

@spec validate_event_type(atom()) :: :ok | {:error, Foundation.Types.Error.t()}

Validate event type is allowed.

Checks that the event type is one of the predefined valid types.

Parameters

  • event_type: Atom representing the event type

Examples

iex> EventValidator.validate_event_type(:function_entry)
:ok

iex> EventValidator.validate_event_type(:invalid_type)
{:error, %Error{error_type: :invalid_event_type}}

validate_field_types(event)

@spec validate_field_types(Foundation.Types.Event.t()) ::
  :ok | {:error, Foundation.Types.Error.t()}

Validate event field types.

Ensures all fields have the correct data types when present.

validate_required_fields(event)

@spec validate_required_fields(Foundation.Types.Event.t()) ::
  :ok | {:error, Foundation.Types.Error.t()}

Validate that an event has all required fields.

Checks that critical fields like event_id, event_type, and timestamp are present.