OBSLabs/etl

Welcome to Virool Etl

Virool Etl is library that includes everything needed to solve complex data transformation inside ruby application according OOP best practices.

The basic idea behind it is to separate transformation state and stateless transforming operations (workflow). Workflow starts with a initial state (injected from outside) and incrementally fill the state following throughout steps.

Another idea is that workflows are composable. A typical approach is to have one workflow to extact data, another to transform them and the last one load data to external device(persist) (ETL).

Virool Etl provides an simple and yet universal DSL to describe workflow and the result code is linear and easy to understand.

This gem is super lightweight (just about 100 LOC) and does not affect performance of the host application.

Getting Started

Add the following code to Gemfile

gem 'etl', :git => 'git://github.com/OBSLabs/etl.git'

and run bundle install

Now Etl::Workflow module is available in the application.

The next step is create a brand new workflow.

module MyWorkflow
  extend Etl::Workflow
  step do |x|
    x + 10
  end
end

To eval workflow: MyWorkflow.run(32) #=> 42

How it works

Workflow is a sequential set of neccessary & sufficient operations to load the data into the end target. Workflow is stateless and state is passed from one step/workflow to another. The root workflow defines the initial state. Workflow is a stand alone component that has a single entry point (inital state), set of operations to accomplish the end goal. set of operations could be grouped into 3 parts.

None of the parts know about each other and the workflow is something that conduct communication between them. Each part consists of one or several steps which are mutually independend and data fall from one step into another.

Composing steps to make workflow

Step is a atomic part of a workflow. There could be any number of steps in workflow. Each step is a stateless ruby block that receive a state object as a single argument and returns a new version of the state. Workflow could be evaluated by sequentially evaluating each of its steps:

• take the initial value
• eval first step with initial value as a state.
• eval second step with a value that first step returned
• ...
• the result of the last step is a result of Workflow evaluation.

step :a do |s|
...
end

step :b do |s|
...
end

step :c do |s|
...
end

is an equivalent of c(b(a(...))) or in clojure (->> ... (a) (b) (c))

Composing workflows

Workflow might be a composition of serveral workflows. In this case workflow behave the same way as a regular step.

module Workflow
  module A
  ...
  end

  module B
  ...
  end

  module C
  ...
  end
  workflow A, B, C
end

is equvalent of C.call(B.call(A.call))) The root workflow is responsible for definition of the initial state and providing a clear entry point (public interface).

Incremental state

State is a object that goes into the step and step returns the next value of state (very similar to monad). State can be mutable or immutable

# Immutable, merge returns a new hash.
step :foo do |state|
  state.merge({foo: :bar})
end

# Mutable
step :foo do |state|
  state[:foo] = :bar
  state
end

Typical operations

Set state attribute

step do |state|
  state.foo = User.find(:all)
  state
end

is equivalent to:

update :foo do |state|
  User.find(:all)
end

Perform side effect operation

step do |state|
  S3.upload(state.foo)
  state
end

is equivalent to:

push do |state|
  S3.upload(state.foo)
end

Testing

Workflow has a "#[]" accessor to steps that returns Proc so step could be tested as regular ruby method:

module Foo
  step :inc do |state|
    state + 1
  end
end

could be tested with:

...
expect(Foo[:inc].call(5)).to eq(6)
...

As long each step is using only a trivial portion of state it's very simple to mock it. That's very helpful when testing transformation logic without any external adapter.

Example workflow

require 'etl'

module SomeEtl
  extend Etl::Workflow

  class State
    attr_accessor :users, :contracts, :invoices, :groups
  end

  module Extract
    extend Etl::Workflow

    update :users do |state|
      User.find(:all)
    end

    update :contracts do |state|
      Contract.active.where(user_id: state.users.map(&:id))
    end
  end

  module Transform
    extend Etl::Workflow

    update :invoices do |state|
      calculate(state.users, state.contracts)
    end

    update :groups do |state|
      state.invoices.group_by(&:user_id)....
    end

    def caclulate(users, contracts)
      # <scary logic goes here>
    end
  end

  module Load
    extend Etl::Workflow

    push 'Persist to db' do |state|
      Invoice.transaction do
        state.invoices.each do |invoice|
          invoice.save!
        end
      end
    end

    push 'Send notifications' do |state|
      state.groups.each do |user, invoice|
        UserMailer.deliver_invoice(user, invoice)
      end
    end
  end
  workflow Extract,Transform, Load
end

puts SomeEtl.run(SomeEtl::State.new).inspect

License

Virool Etl is released under the MIT License.