Class: Karafka::Web::Management::Migrations::Base

Inherits:

Object

• Object
• Karafka::Web::Management::Migrations::Base

Includes:

Core::Helpers::Time

Defined in:

lib/karafka/web/management/migrations/base.rb

Overview

Base for all our migrations

Each migration MUST have a #migrate method defined Migrations are expected to modify the provided state IN PLACE

Direct Known Subclasses

ConsumersMetrics::FillMissingReceivedAndSentBytes, ConsumersMetrics::IntroduceLagTotal, ConsumersMetrics::IntroduceWaiting, ConsumersMetrics::PopulateJobsMetrics, ConsumersMetrics::RemoveProcessing, ConsumersMetrics::RenameLagTotalToLagHybrid, ConsumersMetrics::SetInitial, ConsumersMetrics::SplitListenersIntoActiveAndPaused, ConsumersStates::AddJobsCounter, ConsumersStates::FillMissingReceivedAndSentBytes, ConsumersStates::IntroduceLagTotal, ConsumersStates::IntroduceWaiting, ConsumersStates::RemoveProcessing, ConsumersStates::RenameLagTotalToLagHybrid, ConsumersStates::SetInitial, ConsumersStates::SplitListenersIntoActiveAndPaused

Class Attribute Summary

• .type ⇒ Object

  What resource does it relate it One migration should modify only one resource type.

• .versions_until ⇒ Object

  First version that should NOT be affected by this migration.

Class Method Summary

• .applicable?(version) ⇒ Boolean

  Is the given migration applicable.

• .index ⇒ Integer

  Index for sorting.

• .migrate(state) ⇒ Object
• .sorted_descendants ⇒ Array<Class>

  Array with migrations sorted from oldest to latest.

Class Attribute Details

.type ⇒ Object

What resource does it relate it One migration should modify only one resource type

# File 'lib/karafka/web/management/migrations/base.rb', line 20

def type
  @type
end

.versions_until ⇒ Object

First version that should NOT be affected by this migration

# File 'lib/karafka/web/management/migrations/base.rb', line 17

def versions_until
  @versions_until
end

Class Method Details

.applicable?(version) ⇒ Boolean

Returns is the given migration applicable.

Parameters:

• version (String) —

  sem-ver version

Returns:

• (Boolean) —

  is the given migration applicable

# File 'lib/karafka/web/management/migrations/base.rb', line 24

def applicable?(version)
  version < versions_until
end

.index ⇒ Integer

Returns index for sorting. Older migrations are always applied first.

Returns:

• (Integer) —

  index for sorting. Older migrations are always applied first

# File 'lib/karafka/web/management/migrations/base.rb', line 34

def index
  instance_method(:migrate)
    .source_location
    .first
    .split('/')
    .last
    .split('_')
    .first
    .to_i
end

.migrate(state) ⇒ Object

Parameters:

• state (Hash) —

  deserialized state to be modified

Raises:

• (NotImplementedError)

# File 'lib/karafka/web/management/migrations/base.rb', line 29

def migrate(state)
  raise NotImplementedError, 'Implement in a subclass'
end

.sorted_descendants ⇒ Array<Class>

Returns array with migrations sorted from oldest to latest. This is the order in which they need to be applied.

Returns:

• (Array<Class>) —

  array with migrations sorted from oldest to latest. This is the order in which they need to be applied

# File 'lib/karafka/web/management/migrations/base.rb', line 47

def sorted_descendants
  ObjectSpace
    .each_object(Class)
    .select { |klass| klass != self && klass.ancestors.include?(self) }
    .sort_by(&:index)
end