deimos-ruby 1.6.3 → 1.8.1.pre.beta1

data/README.md

@@ -23,6 +23,7 @@ Built on Phobos and hence Ruby-Kafka.
    * [Consumers](#consumers)
    * [Rails Integration](#rails-integration)
    * [Database Backend](#database-backend)
+   * [Database Poller](#database-poller)
    * [Running Consumers](#running-consumers)
    * [Metrics](#metrics)
    * [Testing](#testing)
@@ -313,28 +314,19 @@ messages as an array and then process them together. This can improve
 consumer throughput, depending on the use case. Batch consumers behave like
 other consumers in regards to key and payload decoding, etc.
 
-To enable batch consumption, ensure that the `delivery` property is set to `inline_batch`. For example:
+To enable batch consumption, ensure that the `delivery` property of your
+consumer is set to `inline_batch`.
 
-```ruby
-Deimos.configure do
-  consumer do
-    class_name 'Consumers::MyBatchConsumer'
-    topic 'my_batched_topic'
-    group_id 'my_group_id'
-    delivery :inline_batch
-  end
-end
-```
-
-Batch consumers must inherit from the Deimos::BatchConsumer class as in
-this sample:
+Batch consumers will invoke the `consume_batch` method instead of `consume`
+as in this example:
 
 ```ruby
-class MyBatchConsumer < Deimos::BatchConsumer
+class MyBatchConsumer < Deimos::Consumer
 
   def consume_batch(payloads, metadata)
     # payloads is an array of schema-decoded hashes.
-    # metadata is a hash that contains information like :keys and :topic.
+    # metadata is a hash that contains information like :keys, :topic, 
+    # and :first_offset.
     # Keys are automatically decoded and available as an array with
     # the same cardinality as the payloads. If you need to iterate
     # over payloads and keys together, you can use something like this:
@@ -532,12 +524,14 @@ class MyConsumer < Deimos::ActiveRecordConsumer
 
   # Optional override of the way to fetch records based on payload and
   # key. Default is to use the key to search the primary key of the table.
+  # Only used in non-batch mode.
   def fetch_record(klass, payload, key)
     super
   end
 
   # Optional override on how to set primary key for new records. 
   # Default is to set the class's primary key to the message's decoded key. 
+  # Only used in non-batch mode.
   def assign_key(record, payload, key)
     super
   end
@@ -545,6 +539,7 @@ class MyConsumer < Deimos::ActiveRecordConsumer
   # Optional override of the default behavior, which is to call `destroy`
   # on the record - e.g. you can replace this with "archiving" the record
   # in some way. 
+  # Only used in non-batch mode.
   def destroy_record(record)
     super
   end
@@ -554,9 +549,159 @@ class MyConsumer < Deimos::ActiveRecordConsumer
   def record_attributes(payload)
     super.merge(:some_field => 'some_value')
   end
+
+  # Optional override to change the attributes used for identifying records
+  def record_key(payload)
+    super
+  end
+end
+```
+
+#### Generating Tables and Models
+
+Deimos provides a generator that takes an existing schema and generates a 
+database table based on its fields. By default, any complex sub-types (such as 
+records or arrays) are turned into JSON (if supported) or string columns.
+
+Before running this migration, you must first copy the schema into your repo
+in the correct path (in the example above, you would need to have a file
+`{SCHEMA_ROOT}/com/my-namespace/MySchema.avsc`).
+
+To generate a model and migration, run the following:
+
+    rails g deimos:active_record TABLE_NAME FULL_SCHEMA_NAME
+    
+Example:
+
+    rails g deimos:active_record my_table com.my-namespace.MySchema
+    
+...would generate:
+
+    db/migrate/1234_create_my_table.rb
+    app/models/my_table.rb
+
+#### Batch Consumers
+
+Deimos also provides a batch consumption mode for `ActiveRecordConsumer` which
+processes groups of messages at once using the ActiveRecord backend. 
+
+Batch ActiveRecord consumers make use of the
+[activerecord-import](https://github.com/zdennis/activerecord-import) to insert
+or update multiple records in bulk SQL statements. This reduces processing
+time at the cost of skipping ActiveRecord callbacks for individual records.
+Deleted records (tombstones) are grouped into `delete_all` calls and thus also
+skip `destroy` callbacks.
+
+Batch consumption is used when the `delivery` setting for your consumer is set to `inline_batch`.
+
+**Note**: Currently, batch consumption only supports only primary keys as identifiers out of the box. See
+[the specs](spec/active_record_batch_consumer_spec.rb) for an example of how to use compound keys.
+
+By default, batches will be compacted before processing, i.e. only the last
+message for each unique key in a batch will actually be processed. To change
+this behaviour, call `compacted false` inside of your consumer definition.
+
+A sample batch consumer would look as follows:
+
+```ruby
+class MyConsumer < Deimos::ActiveRecordConsumer
+  schema 'MySchema'
+  key_config field: 'my_field'
+  record_class Widget
+
+  # Controls whether the batch is compacted before consuming.
+  # If true, only the last message for each unique key in a batch will be
+  # processed.
+  # If false, messages will be grouped into "slices" of independent keys
+  # and each slice will be imported separately.
+  #
+  # compacted false
+
+
+  # Optional override of the default behavior, which is to call `delete_all`
+  # on the associated records - e.g. you can replace this with setting a deleted
+  # flag on the record. 
+  def remove_records(records)
+    super
+  end
+ 
+  # Optional override to change the attributes of the record before they
+  # are saved.
+  def record_attributes(payload)
+    super.merge(:some_field => 'some_value')
+  end
+end
+```
+
+## Database Poller
+
+Another method of fetching updates from the database to Kafka is by polling
+the database (a process popularized by [Kafka Connect](https://docs.confluent.io/current/connect/index.html)).
+Deimos provides a database poller, which allows you the same pattern but
+with all the flexibility of real Ruby code, and the added advantage of having
+a single consistent framework to talk to Kafka.
+
+One of the disadvantages of polling the database is that it can't detect deletions.
+You can get over this by configuring a mixin to send messages *only* on deletion,
+and use the poller to handle all other updates. You can reuse the same producer
+for both cases to handle joins, changes/mappings, business logic, etc.
+
+To enable the poller, generate the migration:
+
+```ruby
+rails g deimos:db_poller
+```
+
+Run the migration:
+
+```ruby
+rails db:migrate
+```
+
+Add the following configuration:
+
+```ruby
+Deimos.configure do
+  db_poller do
+    producer_class 'MyProducer' # an ActiveRecordProducer
+  end
+  db_poller do
+    producer_class 'MyOtherProducer'
+    run_every 2.minutes
+    delay 5.seconds # to allow for transactions to finish
+    full_table true # if set, dump the entire table every run; use for small tables
+  end
+end
+```
+
+All the information around connecting and querying the database lives in the
+producer itself, so you don't need to write any additional code. You can 
+define one additional method on the producer:
+
+```ruby
+class MyProducer < Deimos::ActiveRecordProducer
+  ...
+  def poll_query(time_from:, time_to:, column_name:, min_id:)
+    # Default is to use the timestamp `column_name` to find all records
+    # between time_from and time_to, or records where `updated_at` is equal to
+    # `time_from` but its ID is greater than `min_id`. This is called
+    # successively as the DB is polled to ensure even if a batch ends in the
+    # middle of a timestamp, we won't miss any records.
+    # You can override or change this behavior if necessary.
+  end
 end
 ```
 
+To run the DB poller:
+
+    rake deimos:db_poller
+
+Note that the DB poller creates one thread per configured poller, and is
+currently designed *not* to be scaled out - i.e. it assumes you will only
+have one process running at a time. If a particular poll takes longer than
+the poll interval (i.e. interval is set at 1 minute but it takes 75 seconds)
+the next poll will begin immediately following the first one completing.
+
 ## Running consumers
 
 Deimos includes a rake task. Once it's in your gemfile, just run
@@ -783,6 +928,9 @@ Deimos::Utils::InlineConsumer.get_messages_for(
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/flipp-oss/deimos .
 
+We have more information on the [internal architecture](docs/ARCHITECTURE.md) of Deimos
+for contributors!
+
 ### Linting
 
 Deimos uses Rubocop to lint the code. Please run Rubocop on your code 

data/Rakefile

@@ -6,7 +6,7 @@ begin
 
   RSpec::Core::RakeTask.new(:spec)
   task(default: :spec)
-rescue LoadError # rubocop:disable Lint/SuppressedException
+rescue LoadError
   # no rspec available
 end
 

data/deimos-ruby.gemspec

@@ -21,11 +21,12 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency('avro_turf', '~> 0.11')
   spec.add_runtime_dependency('phobos', '~> 1.9')
   spec.add_runtime_dependency('ruby-kafka', '~> 0.7')
+  spec.add_runtime_dependency('sigurd', '0.0.1')
 
-  spec.add_development_dependency('activerecord', '~> 5.2')
+  spec.add_development_dependency('activerecord', '~> 6')
   spec.add_development_dependency('activerecord-import')
   spec.add_development_dependency('avro', '~> 1.9')
-  spec.add_development_dependency('bundler', '~> 1')
+  spec.add_development_dependency('database_cleaner', '~> 1.7')
   spec.add_development_dependency('ddtrace', '~> 0.11')
   spec.add_development_dependency('dogstatsd-ruby', '~> 4.2')
   spec.add_development_dependency('guard', '~> 2')
@@ -33,7 +34,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency('guard-rubocop', '~> 1')
   spec.add_development_dependency('mysql2', '~> 0.5')
   spec.add_development_dependency('pg', '~> 1.1')
-  spec.add_development_dependency('rails', '~> 5.2', '>= 5.2.4.2')
+  spec.add_development_dependency('rails', '~> 6')
   spec.add_development_dependency('rake', '~> 13')
   spec.add_development_dependency('rspec', '~> 3')
   spec.add_development_dependency('rspec_junit_formatter', '~>0.3')

data/docs/ARCHITECTURE.md

@@ -0,0 +1,144 @@
+# Deimos Architecture
+
+Deimos is the third of three libraries that add functionality on top of each 
+other:
+
+* [RubyKafka](https://github.com/zendesk/ruby-kafka) is the low-level Kafka
+  client, providing API's for producers, consumers and the client as a whole.
+* [Phobos](https://github.com/phobos/phobos) is a lightweight wrapper on top
+  of RubyKafka that provides threaded consumers, a simpler way to write
+  producers, and lifecycle management.
+* [Deimos](https://github.com/flipp-oss/deimos/) is a full-featured framework
+  using Phobos as its base which provides schema integration (e.g. Avro), 
+  database integration, metrics, tracing, test helpers and other utilities.
+  
+## Folder structure
+
+As of May 12, 2020, the following are the important files to understand in how
+Deimos fits together:
+* `lib/generators`: Generators to generate database migrations, e.g.
+   for the DB Poller and DB Producer features.
+* `lib/tasks`: Rake tasks for starting consumers, DB Pollers, etc.
+* `lib/deimos`: Main Deimos code.
+* `lib/deimos/deimos.rb`: The bootstrap / startup code for Deimos. Also provides
+   some global convenience methods and (for legacy purposes) the way to 
+   start the DB Producer.
+* `lib/deimos/backends`: The different plug-in producer backends - e.g. produce
+   directly to Kafka, use the DB backend, etc.
+* `lib/deimos/schema_backends`: The different plug-in schema handlers, such
+  as the various flavors of Avro (with/without schema registry etc.)
+* `lib/deimos/metrics`: The different plug-in metrics providers, e.g. Datadog.
+* `lib/deimos/tracing`: The different plug-in tracing providers, e.g. Datadog.
+* `lib/deimos/utils`: Utility classes for things not directly related to
+   producing and consuming, such as the DB Poller, DB Producer, lag reporter, etc.
+* `lib/deimos/config`: Classes related to configuring Deimos.
+* `lib/deimos/monkey_patches`: Monkey patches to existing libraries. These
+   should be removed in a future update.
+
+## Features
+
+### Producers and Consumers
+
+Both producers and consumers include the `SharedConfig` module, which 
+standardizes configuration like schema settings, topic, keys, etc.
+
+Consumers come in two flavors: `Consumer` and `BatchConsumer`. Both include
+`BaseConsumer` for shared functionality.
+
+While producing messages go to Kafka by default, literally anything else
+can happen when your producer calls `produce`, by swapping out the producer
+_backend_. This is just a file that needs to inherit from `Deimos::Backends::Base`
+and must implement a single method, `execute`.
+
+Producers have a complex workflow while processing the payload to publish. This
+is aided by the `Deimos::Message` class (not to be confused with the 
+`KafkaMessage` class, which is an ActiveRecord used by the DB Producer feature,
+below).
+
+### Schemas
+
+Schema backends are used to encode and decode payloads into different formats
+such as Avro. These are integrated with producers and consumers, as well
+as test helpers. These are a bit more involved than producer backends, and
+must define methods such as:
+* `encode` a payload or key (when encoding a key, for Avro a key schema
+  may be auto-generated)
+* `decode` a payload or key
+* `validate` that a payload is correct for encoding
+* `coerce` a payload into the given schema (e.g. turn ints into strings)
+* Get a list of `schema_fields` in the configured schema, used when interacting
+  with ActiveRecord
+* Define a `mock` backend when the given backend is used. This is used
+  during testing. Typically mock backends will validate values but not
+  actually encode/decode them.
+  
+### Configuration
+
+Deimos has its own `Configurable` module that makes heavy use of `method_missing`
+to provide a very succinct but powerful configuration format (including
+default values, procs, print out as hash, reset, etc.). It also
+allows for multiple blocks to define different objects of the same time
+(like producers, consumers, pollers etc.).
+
+The configuration definition for Deimos is in `config/configuration.rb`. In
+addition, there are methods in `config/phobos_config.rb` which translate to/from
+the Phobos configuration format and support the old `phobos.yml` method
+of configuration.
+
+### Metrics and Tracing
+
+These are simpler than other plugins and must implement the expected methods
+(`increment`, `gauge`, `histogram` and `time` for metrics, and `start`, `finish`
+and `set_error` for tracing). These are used primarily in producers and consumers.
+
+### ActiveRecord Integration
+
+Deimos provides an `ActiveRecordConsumer` and `ActiveRecordProducer`. These are
+relatively lightweight ways to save data into a database or read it off 
+the database as part of app logic. It uses things like the `coerce` method
+of the schema backends to manage the differences between the given payload
+and the configured schema for the topic.
+
+### Database Backend / Database Producer
+
+This feature (which provides better performance and transaction guarantees)
+is powered by two components:
+* The `db` _publish backend_, which saves messages to the database rather
+  than to Kafka;
+* The `DbProducer` utility, which runs as a separate process, pulls data
+  from the database and sends it to Kafka.
+
+There are a set of utility classes that power the producer, which are largely
+copied from Phobos:
+* `Executor` takes a set of "runnable" things (which implement a `start` and `stop`
+  method) puts them in a thread pool and runs them all concurrently. It
+  manages starting and stopping all threads when necessary.
+* `SignalHandler` wraps the Executor and handles SIGINT and SIGTERM signals
+  to stop the executor gracefully.
+  
+In the case of this feature, the `DbProducer` is the runnable object - it
+can run several threads at once.
+
+On the database side, the `ActiveRecord` models that power this feature are:
+* `KafkaMessage`: The actual message, saved to the database. This message
+  is already encoded by the producer, so only has to be sent.
+* `KafkaTopicInfo`: Used for locking topics so only one producer can work
+  on it at once.
+  
+A Rake task (defined in `deimos.rake`) can be used to start the producer.
+  
+### Database Poller
+
+This feature (which periodically polls the database to send Kafka messages)
+primarily uses other aspects of Deimos and hence is relatively small in size.
+The `DbPoller` class acts as a "runnable" and is used by an Executor (above).
+The `PollInfo` class is saved to the database to keep track of where each
+poller is up to.
+
+A Rake task (defined in `deimos.rake`) can be used to start the pollers.
+
+### Other Utilities
+
+The `utils` folder also contains the `LagReporter` (which sends metrics on
+lag) and the `InlineConsumer`, which can read data from a topic and directly
+pass it into a handler or save it to memory.

data/docs/CONFIGURATION.md

@@ -58,6 +58,10 @@ Deimos.configure do
     namespace 'my.namespace'
     key_config field: :id
 
+    # Setting to :inline_batch will invoke consume_batch instead of consume
+    # for each batch of messages.
+    delivery :batch
+
   # If config.schema.path is app/schemas, assumes there is a file in
   # app/schemas/my/namespace/MyTopicSchema.avsc
   end
@@ -89,6 +93,29 @@ offset_commit_threshold|0|Number of messages that can be processed before their
 heartbeat_interval|10|Interval between heartbeats; must be less than the session window.
 backoff|`(1000..60_000)`|Range representing the minimum and maximum number of milliseconds to back off after a consumer error.
 
+## Defining Database Pollers
+
+These are used when polling the database via `rake deimos:db_poller`. You
+can create a number of pollers, one per topic.
+
+```ruby
+Deimos.configure do
+  db_poller do
+    producer_class 'MyProducer'
+    run_every 2.minutes
+  end
+end
+```
+
+Config name|Default|Description
+-----------|-------|-----------
+producer_class|nil|ActiveRecordProducer class to use for sending messages.
+run_every|60|Amount of time in seconds to wait between runs.
+timestamp_column|`:updated_at`|Name of the column to query. Remember to add an index to this column!
+delay_time|2|Amount of time in seconds to wait before picking up records, to allow for transactions to finish.
+full_table|false|If set to true, do a full table dump to Kafka each run. Good for very small tables.
+start_from_beginning|true|If false, start from the current time instead of the beginning of time if this is the first time running the poller.
+
 ## Kafka Configuration
 
 Config name|Default|Description