tobox 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 20f2b2ccbeacc67bb55403fa085c7d02bbe38e7f49263a5c006958bb35d987f2
+  data.tar.gz: 0e69f560de1959cf87acc8b245ae02dfdf7b8beff693023a6a2651a29cb9b43d
+SHA512:
+  metadata.gz: d3588443eaf61c20ce1eebcf8b3a291ff959bc9861a5ffb157210b9790106e7ed5fe9818362539c5943d1531afbe93d8e9c84f8dd545b8d3a22d9fcede7d0a43
+  data.tar.gz: 1d19aa8d047754f107043fcab8c6ea2835007fb1dfe206bedb2831561f5cf4616e03befe46310ac4463cbd8adf7abe532d736acc7e6790dde792c7a2ccb80972

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-09-05
+
+- Initial release.
+
+* `tobox` entrypoint to start the consumer.
+* `sentry` integration.
+* `datadog` integration.
+* `zeitwerk` integration.

data/LICENSE.txt

@@ -0,0 +1,191 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        https://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2013-2017 Docker, Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       https://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,384 @@
+# Tobox: Transactional outbox pattern implementation in ruby
+
+[![Gem Version](https://badge.fury.io/rb/tobox.svg)](http://rubygems.org/gems/tobox)
+[![pipeline status](https://gitlab.com/honeyryderchuck/tobox/badges/master/pipeline.svg)](https://gitlab.com/honeyryderchuck/tobox/pipelines?page=1&scope=all&ref=master)
+[![coverage report](https://gitlab.com/honeyryderchuck/tobox/badges/master/coverage.svg?job=coverage)](https://honeyryderchuck.gitlab.io/tobox/#_AllFiles)
+
+Simple, data-first events processing framework based on the [transactional outbox pattern](https://microservices.io/patterns/data/transactional-outbox.html).
+
+## Requirements
+
+`tobox` requires integration with RDBMS which supports `SKIP LOCKED` functionality. As of today, that's:
+
+* PostgreSQL 9.5+
+* MySQL 8+
+* Oracle
+* Microsoft SQL Server
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "tobox"
+
+# You'll also need to aadd the right database client gem for the target RDBMS
+# ex, for postgresql:
+#
+# gem "pg"
+# see more: http://sequel.jeremyevans.net/rdoc/files/doc/opening_databases_rdoc.html
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install tobox
+
+## Usage
+
+1. create the `outbox` table in your application's database:
+
+```ruby
+# example migration using sequel
+Sequel.migration do
+  up do
+    create_table(:outbox) do
+      primary_key :id
+      column :type, :varchar, null: false
+      column :data_before, :json, null: true
+      column :data_after, :json, null: true
+      column :created_at, "timestamp without time zone", null: false, default: Sequel::CURRENT_TIMESTAMP
+      column :attempts, :integer, null: false, default: 0
+      column :run_at, "timestamp without time zone", null: true
+      column :last_error, :text, null: true
+      column :metadata, :json, null: true
+
+      index Sequel.desc(:run_at)
+    end
+  end
+
+  down do
+    drop_table(:outbox)
+  end
+end
+```
+2. create a `tobox.rb` config file in your project directory tree:
+
+```ruby
+# tobox
+database Sequel.connect("postgres://user:pass@dbhost/database")
+# table :outbox
+# concurrency 8
+on("user_created") do |event|
+  puts "created user #{event[:after]["id"]}"
+  DataLakeService.user_created(user_data_hash)
+  BillingService.bill_user_account(user_data_hash)
+end
+on("user_updated") do |event|
+  # ...
+end
+```
+
+3. Start the `tobox` process
+
+```
+> bundle exec tobox -C path/to/tobox.rb -r path/to/file_requiring_application_code.rb
+```
+
+There is no API for event production yet (still TODO). It's recommended you write directly into the "outbox" table via database triggers (i.e. *insert into users table -> add user_created event"). Alternatively you can use `sequel` directly (`DB[:outbox].insert(...)`).
+
+4. Emit outbox events
+
+Currently, `tobox` only deals with outbox events consumption. When it comes to producing, you can do it yourself. There essentially two alternatives:
+
+4.1 Emit from application code
+
+If you're using `sequel` as your ORM, you can use the dataset API:
+
+```ruby
+# Assuming DB points to your `Sequel::Database`, and defaults are used:
+order = Order.new(
+  item_id: item.id,
+  price: 20_20,
+  currency: "EUR"
+)
+DB.transaction do
+  order.save
+  DB[:outbox].insert(event_type: "order_created", data_after: order.to_hash)
+end
+```
+
+4.2 Emit from database trigger
+
+This is how it could be done in PostgreSQL using trigger functions:
+
+```sql
+CREATE OR REPLACE FUNCTION order_created_outbox_event()
+  RETURNS TRIGGER
+  LANGUAGE PLPGSQL
+  AS
+$$
+BEGIN
+	INSERT INTO outbox(event_type, data_after)
+		 VALUES('order_created', row_to_json(NEW.*));
+	RETURN NEW;
+END;
+$$
+
+CREATE TRIGGER order_created_outbox_event
+  AFTER INSERT
+  ON orders
+  FOR EACH ROW
+  EXECUTE PROCEDURE order_created_outbox_event();
+```
+
+## Configuration
+
+As mentioned above, configuration can be set in a particular file. The following options are configurable:
+
+### `environment``
+
+Sets the application environment (either "development" or "production"). Can be set directly, or via `APP_ENV` environment variable (defaults to "development").
+
+### `database_uri`
+
+Accepts a URI pointing to a database, [where scheme identifies the database adapter to be used](https://sequel.jeremyevans.net/rdoc/files/doc/opening_databases_rdoc.html):
+
+```ruby
+database_uri `"postgres://user:password@localhost/blog"`.
+```
+
+### `table`
+
+the name of the database table where outbox events are stored (`:outbox` by default).
+
+```ruby
+table :outbox
+```
+
+### `max_attempts`
+
+Maximum number of times a failed attempt to process an event will be retried (`10` by default).
+
+```ruby
+concurrency 4
+```
+
+**Note**: the new attempt will be retried in `n ** 4`, where `n` is the number of past attempts for that event.
+
+### `concurrency`
+
+Number of workers processing events.
+
+```ruby
+concurrency 4
+```
+
+**Note**: the default concurrency is adapted and different for each worker pool type, so make sure you understand how this tweak may affect you.
+
+### `worker`
+
+Type of the worker used to process events. Can be `:thread` (default), `:fiber`, or a class implementing the `Tobox::Pool` protocol (TBD: define what this protocol is).
+
+### `wait_for_events_delay`
+
+Time (in seconds) to wait before checking again for events in the outbox.
+
+### `shutdown_timeout`
+
+Time (in seconds) to wait for events to finishing processing, before hard-killing the process.
+
+### `on(event_type) { |before, after| }`
+
+callback executed when processing an event of the given type. By default, it'll yield the state of data before and after the event (unless `message_to_arguments` is set).
+
+```ruby
+on("order_created") { |event| puts "order created: #{event[:after]}" }
+on("order_updated") { |event| puts "order created: was #{event[:before]}, now is #{event[:after]}" }
+# ...
+```
+
+### `on_before_event { |event| }`
+
+callback executed right before proocessing an event.
+
+
+```ruby
+on_before_event { |event| start_trace(event[:id]) }
+```
+
+### `on_after_event { |event| }`
+
+callback executed right after proocessing an event.
+
+
+```ruby
+on_before_event { |event| finish_trace(event[:id]) }
+```
+
+### `on_error_event { |event, error| }`
+
+callback executed when an exception was raised while processing an event.
+
+
+```ruby
+on_error_event { |event, exception| Sentry.capture_exception(exception) }
+```
+
+### `message_to_arguments { |event| }`
+
+if exposing raw data to the `on` handlers is not what you'd want, you can always override the behaviour by providing an alternative "before/after fetcher" implementation.
+
+```ruby
+# if you'd like to yield the ORM object only
+message_to_arguments do |event|
+case event_type
+when "order_created", "order_updated"
+  Order.get(after[:id])
+when "payment_created", "payment_processed", "payment_reconciled"
+  Payment.get(after[:id])
+else
+  super(event)
+end
+on("order_created") { |order| puts "order created: #{order}" }
+# ...
+on("payment_created") { |payment| puts "payment created: #{payment}" }
+# ...
+```
+
+### logger
+
+Overrides the internal logger (an instance of `Logger`).
+
+### log_level
+
+Overrides the default log level ("info" when in "production" environment, "debug" otherwise).
+
+## Event
+
+The event is composed of the following properties:
+
+* `:id`: unique event identifier
+* `:type`: label identifying the event (i.e. `"order_created"`)
+* `:before`: hash of the associated event data before event is emitted (can be `nil`)
+* `:after`: hash of the associated event data after event is emitted (can be `nil`)
+* `:created_at`: timestamp of when the event is emitted
+
+(*NOTE*: The event is also composed of other properties which are only relevant for `tobox`.)
+
+## Rails support
+
+Rails is supported out of the box by adding the [sequel-activerecord_connection](https://github.com/janko/sequel-activerecord_connection) gem into your Gemfile, and requiring the rails application in the `tobox` cli call:
+
+```bash
+> bundle exec tobox -C path/to/tobox.rb -r path/to/rails_app/config/environment.rb
+```
+
+In the `tobox` config, you can set the environment:
+
+```ruby
+environment Rails.env
+```
+
+## Plugins
+
+`tobox` ships with a very simple plugin system. (TODO: add docs).
+
+Plugins can be loaded in the config via `plugin`:
+
+```ruby
+# tobox.rb
+plugin(:plugin_name)
+```
+
+It ships with the following integrations.
+
+### Zeitwerk
+
+(requires the `zeitwerk` gem.)
+
+Plugin for the [zeitwerk](https://github.com/fxn/zeitwerk) auto-loader. It allows to set the autoload dirs, and seamlessly integrates code reloading in "development", and eagerloading in "production":
+
+```ruby
+# tobox.rb
+plugin(:zeitwerk)
+zeitwerk_loader do |loader|
+  loader.push_dir("path/to/handlers")
+end
+```
+
+### Sentry
+
+(requires the `sentry-ruby` gem.)
+
+Plugin for the [sentry](https://github.com/getsentry/sentry-ruby) ruby SDK for error tracking. It'll send all errors happening while processing events to Sentry.
+
+```ruby
+# tobox.rb
+plugin(:sentry)
+```
+
+### Datadog
+
+(requires the `ddtrace` gem.)
+
+Plugin for [datadog](https://github.com/DataDog/dd-trace-rb) ruby SDK. It'll generate traces for event handling.
+
+```ruby
+# you can init the datadog config in another file to load:
+Datadog.configure do |c|
+  c.tracing.instrument :tobox
+end
+
+# tobox.rb
+plugin(:datadog)
+```
+
+## Supported Rubies
+
+All Rubies greater or equal to 2.6, and always latest JRuby and Truffleruby.
+
+## Why?
+
+### Simple and lightweight, framework (and programming language) agnostic
+
+`tobox` event callbacks yield the data in ruby primitive types, rather than heavy ORM instances. This is by design, as callbacks may not rely on application code being loaded.
+
+This allows `tobox` to process events dispatched from an application done in another programmming language, as an example.
+
+
+### No second storage system
+
+While `tobox` does not advertise itself as a background job framework, it can be used as such.
+
+Most tiered applications already have an RDBMS. Popular background job solutions, like `"sidekiq"` and `"shoryuken"`, usually require integrating with a separate message broker (Redis, SQS, RabbitMQ...). This increases the overhead in deployment and operations, as these brokers need to be provisioned, monitored, scaled separately, and billed differently.
+
+`tobox` only requires the database you usually need to account for anyway, allowing you to delay buying into more complicated setups until you have to and have budget for.
+
+However, it can work well in tandem with such solutions:
+
+```ruby
+# process event by scheduling an active job
+on("order_created") { |event| SendOrderMailJob.perform_later(event[:after]["id"]) }
+```
+
+### Atomic processing via database transactions
+
+When scheduling work, one needs to ensure that data is committed to the database before scheduling. This is a very frequent bug when using non-RDBMS background job frameworks, such as [Sidekiq, which has a FAQ entry for this](https://github.com/mperham/sidekiq/wiki/FAQ#why-am-i-seeing-a-lot-of-cant-find-modelname-with-id12345-errors-with-sidekiq) .
+
+But even if you do that, the system can go down **after** the data is committed in the database and **before** the job is enqueued to the broker. Failing to address this behaviour makes the [job delivery guarantee "at most once"](https://brandur.org/job-drain). This may or may not be a problem depending on what your job does (if it bills a customer, it probably is).
+
+By using the database as the message broker, `tobox` can rely on good old transactions to ensure that data committed to the database has a corresponding event. This makes the delivery guarantee "exactly once".
+
+(The actual processing may change this to "at least once", as issues may happen before the event is successfully deleted from the outbox. Still, "at least once" is acceptable and solvable using idempotency mechanisms).
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://gitlab.com/honeyryderchuck/tobox.

data/exe/tobox

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative "../lib/tobox/cli"
+
+begin
+  Tobox::CLI.run
+rescue StandardError => e
+  raise e if $DEBUG
+
+  warn e.message
+  warn e.backtrace.join("\n")
+  exit 1
+end

data/lib/tobox/application.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Tobox
+  class Application
+    def initialize(configuration)
+      @configuration = configuration
+      @running = false
+    end
+
+    def start
+      return if @running
+
+      worker = @configuration[:worker]
+
+      @pool = case worker
+              when :thread then ThreadedPool
+              when :fiber then FiberPool
+              else worker
+              end.new(@configuration)
+
+      @running = true
+    end
+
+    def stop
+      return unless @running
+
+      @pool.stop
+
+      @running = false
+    end
+  end
+end