coil 1.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fe5c3a1be19ae3a27b0c9e9b9fb135d0331491b565b3bcb75bac84c34ba78094
+  data.tar.gz: e91931bcc919e0fac9c0970266450d648d3064dd72b43d54bc2ef9dfc28c9cf8
+SHA512:
+  metadata.gz: e03f621569bb0316057e10e3de93cfcab2e8729d4182c5922a41a8f212e595747c41d4d353f478a1cec718bf6754fe64d05cce4675ff39a5c21551a3c54555c0
+  data.tar.gz: 78f428ad483173301a0394c07f7dd3c84eec353a5f8941cb3a0a9821716b48a8f42b726c4dd4efaf742de276915c68da03ab78ba87227b098734af0c822c2ba5

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://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
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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
+
+       http://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,279 @@
+# Coil [![concourse.odeko.com](https://concourse.odeko.com/api/v1/teams/main/pipelines/coil-main/jobs/test/badge)](https://concourse.odeko.com/teams/main/pipelines/coil-main)
+
+<img src="./solenoid.svg" width="35%">
+
+Transactional inbox/outbox message queuing.
+
+This Rails engine can be mounted in any PostgreSQL-backed Rails app.
+
+# Motivation
+The motivating use-case involves event-streaming with Kafka.
+
+Kafka guarantees that messages on the same topic and partition will be read
+in the same order as written, but we need to ensure we're writing them in the
+correct order, regardless of any concurrent processes we may be running.
+
+Similarly, once we've read a message from the stream, we'd like to hand off the
+message processing to an asynchronous job while ensuring we process messages of
+a given type and key in the same order as read.
+
+## Implementation
+The [inbox/outbox](https://en.wikipedia.org/wiki/Inbox_and_outbox_pattern) pattern
+(see also [article](https://microservices.io/patterns/data/transactional-outbox.html))
+ensures message delivery.
+
+Message ordering is preserved using
+[advisory locks](https://www.postgresql.org/docs/current/explicit-locking.html#ADVISORY-LOCKS)
+as a synchronization mechanism.
+
+## Installation
+Add to the application's Gemfile:
+
+```ruby
+gem "coil", source: "https://gem.odeko.com/"
+gem "schema_version_cache", source: "https://gem.odeko.com/"
+```
+
+Install engine and migrations:
+```console
+$ bundle
+$ bundle exec rails coil:install:migrations
+$ bundle exec rails db:migrate
+```
+
+Register periodic jobs:
+```ruby
+# config/initializers/sidekiq.rb
+Sidekiq.configure_server do |config|
+  # ...
+  config.periodic do |mgr|
+    mgr.register("*/10 * * * *", "Coil::Inbox::MessagesPeriodicJob")
+    mgr.register("5-59/10 * * * *", "Coil::Outbox::MessagesPeriodicJob")
+  end
+end
+```
+
+Filter retryable errors out of airbrake:
+```ruby
+# config/initializers/airbrake.rb
+Airbrake.add_filter do |notice|
+  exception = notice.stash[:exception]
+  notice.ignore! if exception.is_a?(Coil::TransactionalMessagesJob::RetryableError)
+end
+```
+
+Set up schema version cache as described
+[here](https://github.com/OdekoTeam/schema_version_cache?tab=readme-ov-file#usage)
+
+## Usage: inbox
+
+Define a message type and corresponding job:
+```ruby
+# app/models/inbox/foo_message.rb
+class Inbox::FooMessage < Coil::Inbox::Message
+  def job_class
+    Inbox::FooMessagesJob
+  end
+end
+```
+```ruby
+# app/jobs/inbox/foo_messages_job.rb
+class Inbox::FooMessagesJob < Coil::TransactionalMessagesJob
+  private
+
+  # Put message processing logic in this method.
+  def process(message)
+    # For example...
+    uuid = message.key
+    val = message.value.deep_symbolize_keys
+    Foo.do_stuff(uuid:, potato: val[:potato])
+  end
+
+  def message_class
+    Inbox::FooMessage
+  end
+end
+```
+(The test-suite contains a working example with type-annotations:
+[message](./spec/dummy/app/models/dummy/inbox/foo_message.rb),
+[job](./spec/dummy/app/jobs/dummy/inbox/foo_messages_job.rb))
+
+(For advanced use-cases, you can also define an `around_process` job method.
+[See example](./spec/dummy/app/jobs/dummy/inbox/who_messages_job.rb))
+
+Receive messages from Kafka:
+```ruby
+# app/consumers/my_consumer.rb
+class MyConsumer < Racecar::Consumer
+  FOO = "com.example.service.foo".freeze
+  subscribes_to FOO
+
+  def process(message)
+    key = AvroMessaging.decode(message.key)
+    decoded = AvroMessaging.decode_message(message.value)
+    value = decoded.message.deep_symbolize_keys
+    schema_id = decoded.schema_id
+
+    case message.topic
+    when FOO
+      Receivers::FooReceiver.receive(key:, value:, schema_id:)
+    end
+  end
+end
+```
+```ruby
+# app/lib/receivers/foo_receiver.rb
+module Receivers::FooReceiver
+  VALUE_SCHEMA_SUBJECT = "com.example.service.Foo_value"
+
+  def self.receive(key:, value:, schema_id:)
+    schema_version = AvroVersionCache.get_version_number(
+      subject: VALUE_SCHEMA_SUBJECT,
+      schema_id:
+    )
+    Inbox::FooMessage.create!(
+      key:,
+      value:,
+      metadata: {
+        value_schema_subject: VALUE_SCHEMA_SUBJECT,
+        value_schema_version: schema_version,
+        value_schema_id: schema_id
+      }
+    )
+  end
+end
+```
+
+## Usage: outbox
+
+Define a message type and corresponding job:
+```ruby
+# app/models/outbox/bar_message.rb
+class Outbox::BarMessage < Coil::Outbox::Message
+  VALUE_SCHEMA_SUBJECT = "com.example.Bar_value"
+
+  def job_class
+    Outbox::BarMessagesJob
+  end
+end
+```
+```ruby
+# app/jobs/outbox/bar_messages_job.rb
+class Outbox::BarMessagesJob < Coil::TransactionalMessagesJob
+  private
+
+  # Attach schema metadata to message
+  def pre_process(message)
+    value_schema_subject = Outbox::BarMessage::VALUE_SCHEMA_SUBJECT
+    value_schema_id = AvroVersionCache.get_current_id(subject: value_schema_subject)
+    value_schema_version = AvroVersionCache.get_version_number(
+      subject: value_schema_subject,
+      schema_id: value_schema_id
+    )
+    metadata = {
+      value_schema_subject:,
+      value_schema_id:,
+      value_schema_version:
+    }.merge(message.metadata)
+
+    message.update!(metadata:)
+  end
+
+  # Write message to Kafka
+  def process(message)
+    BarEvent.new(message).produce_async
+  end
+
+  def message_class
+    Outbox::BarMessage
+  end
+end
+```
+(The test-suite contains a working example with type-annotations:
+[message](./spec/dummy/app/models/dummy/outbox/bar_message.rb),
+[job](./spec/dummy/app/jobs/dummy/outbox/bar_messages_job.rb))
+
+Write to the outbox:
+```ruby
+bar = Bar.first
+turnips = bar.count_turnips
+Outbox::BarMessage.create!(key: bar.uuid, value: {turnips:})
+```
+
+## Usage: queue locking
+The inbox and outbox operations described above automatically preserve message
+ordering by sequentializing the creation and processing of messages with a given
+type and key.
+
+You can access these synchronization mechanisms directly if necessary:
+```ruby
+# If we want to treat turnip-harvesting and message creation as one operation
+# and ensure that concurrent attempts to run that operation on the same Bar will
+# be run sequentially:
+Outbox::BarMessage.locking_persistence_queue(keys: [bar.uuid]) do
+  bar.harvest_turnips
+  bar.replant
+  turnips = bar.count_turnips
+  Outbox::BarMessage.create!(key: bar.uuid, value: {turnips:})
+end
+
+# More generally, we can run an action while holding advisory locks on a list of
+# keys in some arbitrary keyspace:
+queue_type = "FOOD_PREP"
+message_type = "SOUP"
+ingredients = ["lentils", "tomato"]
+Coil::QueueLocking.locking(queue_type:, message_type:, message_keys: ingredients) do
+  Chef.make_soup(ingredients)
+end
+
+# The `locking` call above will wait until it's able to obtain the requested
+# lock. If we'd rather abort the operation than wait for the lock:
+Coil::QueueLocking.locking(queue_type:, message_type:, message_keys: ingredients, wait: false) do
+  Chef.make_soup(ingredients)
+rescue Coil::QueueLocking::LockWaitTimeout
+  puts("Looks like someone else is already on it")
+end
+```
+
+## Development
+
+Install development dependencies:
+```console
+$ bundle
+```
+
+Install pre-commit hook:
+```console
+$ bin/install-pre-commit
+```
+
+Setup database:
+```console
+$ bin/rails db:setup
+$ bin/rails db:migrate
+```
+
+Run test-suite:
+```console
+$ bin/ci-test
+```
+
+Run linter:
+```console
+$ bin/lint
+```
+
+Regenerate type info for DSLs (e.g. after adding a db migration):
+```console
+$ bin/tapioca dsl --app-root=spec/dummy
+```
+
+Regenerate type info for gems (e.g. after adding a gem):
+```console
+$ bin/tapioca gem
+```
+
+Coil's type annotations are declared in `rbi/coil.rbi` to facilitate typechecking
+by Rails apps that use this engine along with Sorbet. Keeping these annotations
+in a separate file avoids foisting a Sorbet runtime dependency on any app that
+uses our engine.

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("spec/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

data/app/jobs/coil/application_job.rb

@@ -0,0 +1,7 @@
+# typed: strict
+
+module Coil
+  class ApplicationJob
+    include Sidekiq::Worker
+  end
+end

data/app/jobs/coil/inbox/messages_periodic_job.rb

@@ -0,0 +1,16 @@
+# typed: strict
+
+# This periodic job acts as a fallback mechanism, polling for inbox messages
+# that were not enqueued and processed automatically upon create, e.g. due to a
+# failure to push a job onto the Redis queue.
+module Coil
+  module Inbox
+    class MessagesPeriodicJob < TransactionalMessagesPeriodicJob
+      private
+
+      def message_parent_class
+        ::Coil::Inbox::Message
+      end
+    end
+  end
+end

data/app/jobs/coil/outbox/messages_periodic_job.rb

@@ -0,0 +1,16 @@
+# typed: strict
+
+# This periodic job acts as a fallback mechanism, polling for outbox messages
+# that were not enqueued and processed automatically upon create, e.g. due to a
+# failure to push a job onto the Redis queue.
+module Coil
+  module Outbox
+    class MessagesPeriodicJob < TransactionalMessagesPeriodicJob
+      private
+
+      def message_parent_class
+        ::Coil::Outbox::Message
+      end
+    end
+  end
+end

data/app/jobs/coil/transactional_messages_job.rb

@@ -0,0 +1,80 @@
+# typed: true
+
+module Coil
+  class TransactionalMessagesJob < ApplicationJob
+    RetryableError = Class.new(StandardError)
+    DuplicateJobError = Class.new(StandardError)
+
+    # Sidekiq is not designed for long-running jobs, so we place an upper bound
+    # on job duration. When a job exceeds this bound, we'll enqueue a subsequent
+    # job to pick up where we left off.
+    MAX_DURATION = 5.minutes
+
+    sidekiq_options retry: 4, dead: false
+
+    def perform(key, processor_name = self.class.to_s)
+      deadline = Time.current + MAX_DURATION
+      next_in_line = process_messages(key:, processor_name:, deadline:)
+      return if next_in_line.nil?
+
+      # If we reach this point, it means we exceeded the deadline and there
+      # are messages we still haven't processed.
+      Rails.logger.info(<<~INFO.squish)
+        #{self.class} exceeded deadline.
+        Enqueuing subsequent job with key=#{key} processor_name=#{processor_name}
+      INFO
+      next_in_line.enqueue_job(processor_name)
+    rescue DuplicateJobError
+      # A duplicate job is in the midst of its message-processing loop. We'll
+      # call this job done and allow the other one to continue.
+    end
+
+    private
+
+    # Process unprocessed messages until none remain or deadline is exceeded,
+    # then return the next unprocessed message, if any remain.
+    def process_messages(key:, processor_name:, deadline:)
+      loop do
+        next_in_line = next_message(key:, processor_name:)
+        return next_in_line if next_in_line.nil? || Time.current > deadline
+
+        locking(key) do
+          message = next_message(key:, processor_name:)
+
+          if message.present?
+            around_process(message, processor_name:) do
+              pre_process(message)
+              message.processed(processor_name:)
+              process(message)
+            end
+          end
+        end
+      end
+    end
+
+    def around_process(message, processor_name:, &blk)
+      blk.call
+    end
+
+    def pre_process(message)
+    end
+
+    def process(message)
+    end
+
+    def message_class
+    end
+
+    def next_message(key:, processor_name:)
+      message_class.uncached do
+        message_class.next_in_line(key:, processor_name:)
+      end
+    end
+
+    def locking(key, &blk)
+      message_class.locking_process_queue(keys: [key], wait: false, &blk)
+    rescue QueueLocking::LockWaitTimeout
+      raise DuplicateJobError
+    end
+  end
+end

data/app/jobs/coil/transactional_messages_periodic_job.rb

@@ -0,0 +1,33 @@
+# typed: strict
+
+# The periodic job acts as a fallback mechanism, polling for messages that were
+# not enqueued and processed automatically upon create, e.g. due to a failure to
+# push a job onto the Redis queue.
+module Coil
+  class TransactionalMessagesPeriodicJob < ApplicationJob
+    def perform
+      t = Time.current - TransactionalMessagesJob::MAX_DURATION
+
+      # Identify distinct message types, their associated job types, and
+      # the distinct keys for which we have unprocessed messages (excluding
+      # very recent messages, since a TransactionalMessagesJob may still be
+      # processing those). Then, enqueue the necessary jobs for those keys.
+      message_parent_class.select(:type).distinct.each do |x|
+        message_class = x.class
+        job_class = x.job_class
+
+        message_class
+          .unprocessed(processor_name: job_class.name)
+          .where(created_at: nil...t)
+          .distinct
+          .pluck(:key)
+          .each { |k| job_class.perform_async(k) }
+      end
+    end
+
+    private
+
+    def message_parent_class
+    end
+  end
+end

data/app/models/coil/application_record.rb

@@ -0,0 +1,7 @@
+# typed: strict
+
+module Coil
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/coil/inbox/completion.rb

@@ -0,0 +1,11 @@
+# typed: strict
+
+module Coil
+  module Inbox
+    class Completion < ApplicationRecord
+      include PreventDestruction
+
+      attr_readonly :processor_name, :message_type, :message_key
+    end
+  end
+end