event_sourcery-postgres 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 75bff88c421cb623d91957ca0afec6054a835f2a
+  data.tar.gz: dd7c0cd3eaf82c26bb328fbbcdd80e810a38b45b
+SHA512:
+  metadata.gz: 016f2f36b96fef639e26584458ec2798649d3d81f54ce39a398fb4eec5645a31c278d680134630239cf3efba9ee76cccca5117dd98d56b59d8a8a6ce5b6c2efc
+  data.tar.gz: c033c7b72cb9ea7c31de75aca7c51c168397ea1eb18703eae709a2262a4f9a84893b740195acb5023fab05433fdaa9db26780232ef4ec416d579d3795cc00884

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,12 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2
+  - 2.3
+  - 2.4
+before_install:
+  - gem install bundler
+before_script:
+  - psql -c 'create database event_sourcery_test;' -U postgres
+addons:
+  postgresql: 9.4

data/CHANGELOG.md

@@ -0,0 +1,32 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](http://semver.org/).
+
+## [Unreleased]
+
+## [0.3.0] - 2017-6-16
+### Changed
+- The event store persists the event `correlation_id` and `causation_id`.
+  To facilitate this `correlation_id` and `causation_id` columns have been
+  added to the `events` table and the `write_events` function has been
+  altered. Event Sourcery apps will need to ensure these DB changes have
+  been applied to use this version of Event Sourcery.
+
+## [0.2.0] - 2017-6-1
+### Changed
+- Make `EventSourcery::Postgres::OptimisedEventPollWaiter#shutdown` private
+- Updated `EventSourcery::Postgres::OptimisedEventPollWaiter#poll` to ensure that `#shutdown!` is run when an error is raised
+or when the loop stops
+- Remove dynamic emit events methods from reactors (e.g. emit_item_added)
+- The emit_events method now accepts typed events instead of symbols
+
+### Added
+- Configure projector tracker table name via `EventSourcery::Postgres.configure`
+
+## [0.1.0] - 2017-5-26
+### Changed
+- Imported code from the [event_sourcery](https://github.com/envato/event_sourcery).
+- Postgres related configuration is through `EventSourcery::Postgres.configure`
+  instead of `EventSourcery.configure`.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at odindutton@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+ruby '>= 2.2.0'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Envato
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,102 @@
+# EventSourcery::Postgres
+
+[![Build Status](https://travis-ci.org/envato/event_sourcery-postgres.svg?branch=master)](https://travis-ci.org/envato/event_sourcery-postgres)
+
+## Development Status
+
+EventSourcery is currently being used in production by multiple apps but we
+haven't finalized the API yet and things are still moving rapidly. Until we
+release a 1.0 things may change without first being deprecated.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'event_sourcery-postgres'
+```
+
+## Configure
+
+```ruby
+EventSourcery::Postgres.configure do |config|
+  config.event_store_database = Sequel.connect(...)
+  config.projections_database = Sequel.connect(...)
+  config.use_optimistic_concurrency = true
+  config.write_events_function_name = 'writeEvents'
+  config.events_table_name = :events
+  config.aggregates_table_name = :aggregates
+  config.callback_interval_if_no_new_events = 60
+end
+```
+
+## Usage
+
+
+### Event Store
+
+```ruby
+ItemAdded = EventSourcery::Event
+
+EventSourcery::Postgres.event_store.sink(ItemAdded.new(aggregate_id: uuid, body: { }}))
+EventSourcery::Postgres.event_store.get_next_from(0).each do |event|
+  puts event.inspect
+end
+```
+
+### Projectors & Reactors
+
+```ruby
+class ItemProjector
+  include EventSourcery::Postgres::Projector
+
+  table :items do
+    column :item_uuid, 'UUID NOT NULL'
+    column :title, 'VARCHAR(255) NOT NULL'
+  end
+
+  project ItemAdded do |event|
+    table(:items).insert(item_uuid: event.aggregate_id,
+                         title: event.body.fetch('title'))
+  end
+end
+
+class UserEmailer
+  include EventSourcery::Postgres::Reactor
+
+  emits_events SignUpEmailSent
+
+  process UserSignedUp do |event|
+    emit_event SignUpEmailSent.new(user_id: event.aggregate_id) do
+      UserMailer.signed_up(...).deliver
+    end
+  end
+end
+
+EventSourcery::EventProcessing::ESPRunner.new(
+  event_processors: [item_projector, user_emailer],
+  event_store:      EventSourcery::Postgres.config.event_store,
+  stop_on_failure:  true,
+).start!
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. (This will install dependencies and recreate the test database.) Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+To release a new version:
+
+1. Update the version number in `lib/event_sourcery/postgres/version.rb`
+2. Get this change onto master via the normal PR process
+3. Run `gem_push=false be rake release`,
+   this will create a git tag for the version,
+   push tags up to GitHub, and package the code in a `.gem` file.
+4. Manually upload the generated gem file (`pkg/event_sourcery-postgres-#{version}.gem`) to
+   [rubygems.envato.com](https://rubygems.envato.com).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/envato/event_sourcery-postgres.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "event_sourcery/postgres"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,15 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+echo
+echo "--- Preparing test databases"
+echo
+
+dropdb event_sourcery_test || echo 0
+createdb event_sourcery_test
+
+# Do any other automated setup that you need to do here

data/event_sourcery-postgres.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'event_sourcery/postgres/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "event_sourcery-postgres"
+  spec.version       = EventSourcery::Postgres::VERSION
+  # TODO: update authors
+  spec.authors       = ["Steve Hodgkiss"]
+  spec.email         = ["steve@hodgkiss.me"]
+
+  spec.summary       = %q{Postgres event store for use with EventSourcery}
+  spec.homepage      = "https://github.com/envato/event_sourcery-postgres"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 2.2.0'
+
+  spec.add_dependency 'sequel', '~> 4.38'
+  spec.add_dependency 'pg'
+  spec.add_dependency 'event_sourcery', '>= 0.10.0'
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "benchmark-ips"
+end

data/lib/event_sourcery/postgres.rb

@@ -0,0 +1,28 @@
+require 'sequel'
+
+Sequel.extension :pg_json
+Sequel.default_timezone = :utc
+
+require 'event_sourcery'
+require 'event_sourcery/postgres/version'
+require 'event_sourcery/postgres/config'
+require 'event_sourcery/postgres/queue_with_interval_callback'
+require 'event_sourcery/postgres/schema'
+require 'event_sourcery/postgres/optimised_event_poll_waiter'
+require 'event_sourcery/postgres/event_store'
+require 'event_sourcery/postgres/table_owner'
+require 'event_sourcery/postgres/projector'
+require 'event_sourcery/postgres/reactor'
+require 'event_sourcery/postgres/tracker'
+
+module EventSourcery
+  module Postgres
+    def self.configure
+      yield config
+    end
+
+    def self.config
+      @config ||= Config.new
+    end
+  end
+end

data/lib/event_sourcery/postgres/config.rb

@@ -0,0 +1,47 @@
+module EventSourcery
+  module Postgres
+    class Config
+      attr_accessor :event_store_database,
+                    :lock_table_to_guarantee_linear_sequence_id_growth,
+                    :write_events_function_name,
+                    :events_table_name,
+                    :aggregates_table_name,
+                    :tracker_table_name,
+                    :callback_interval_if_no_new_events,
+                    :auto_create_projector_tracker,
+                    :event_tracker,
+                    :projections_database,
+                    :event_store,
+                    :event_source,
+                    :event_sink
+
+      def initialize
+        @lock_table_to_guarantee_linear_sequence_id_growth = true
+        @write_events_function_name = 'writeEvents'
+        @events_table_name = :events
+        @aggregates_table_name = :aggregates
+        @tracker_table_name = :projector_tracker
+        @callback_interval_if_no_new_events = 10
+        @event_store_database = nil
+        @auto_create_projector_tracker = true
+      end
+
+      def event_store
+        @event_store ||= EventStore.new(event_store_database)
+      end
+
+      def event_source
+        @event_source ||= ::EventSourcery::EventStore::EventSource.new(event_store)
+      end
+
+      def event_sink
+        @event_sink ||= ::EventSourcery::EventStore::EventSink.new(event_store)
+      end
+
+      def projections_database=(sequel_connection)
+        @projections_database = sequel_connection
+        @event_tracker = Postgres::Tracker.new(sequel_connection)
+      end
+    end
+  end
+end

data/lib/event_sourcery/postgres/event_store.rb

@@ -0,0 +1,144 @@
+module EventSourcery
+  module Postgres
+    class EventStore
+      include EventSourcery::EventStore::EachByRange
+
+      def initialize(pg_connection,
+                     events_table_name: EventSourcery::Postgres.config.events_table_name,
+                     lock_table: EventSourcery::Postgres.config.lock_table_to_guarantee_linear_sequence_id_growth,
+                     write_events_function_name: EventSourcery::Postgres.config.write_events_function_name,
+                     event_builder: EventSourcery.config.event_builder)
+        @pg_connection = pg_connection
+        @events_table_name = events_table_name
+        @write_events_function_name = write_events_function_name
+        @lock_table = lock_table
+        @event_builder = event_builder
+      end
+
+      def sink(event_or_events, expected_version: nil)
+        events = Array(event_or_events)
+        aggregate_ids = events.map(&:aggregate_id).uniq
+        raise AtomicWriteToMultipleAggregatesNotSupported unless aggregate_ids.count == 1
+        sql = write_events_sql(aggregate_ids.first, events, expected_version)
+        @pg_connection.run(sql)
+        log_events_saved(events)
+        true
+      rescue Sequel::DatabaseError => e
+        if e.message =~ /Concurrency conflict/
+          raise ConcurrencyError, "expected version was not #{expected_version}. Error: #{e.message}"
+        else
+          raise
+        end
+      end
+
+      def get_next_from(id, event_types: nil, limit: 1000)
+        query = events_table.
+          order(:id).
+          where(Sequel.lit('id >= ?', id)).
+          limit(limit)
+        if event_types
+          query = query.where(type: event_types)
+        end
+        query.map do |event_row|
+          build_event(event_row)
+        end
+      end
+
+      def latest_event_id(event_types: nil)
+        latest_event = events_table
+        if event_types
+          latest_event = latest_event.where(type: event_types)
+        end
+        latest_event = latest_event.order(:id).last
+        if latest_event
+          latest_event[:id]
+        else
+          0
+        end
+      end
+
+      def get_events_for_aggregate_id(aggregate_id)
+        events_table.where(aggregate_id: aggregate_id.to_str).order(:version).map do |event_hash|
+          build_event(event_hash)
+        end
+      end
+
+      def subscribe(from_id:, event_types: nil, after_listen: nil, subscription_master:, &block)
+        poll_waiter = OptimisedEventPollWaiter.new(pg_connection: @pg_connection, after_listen: after_listen)
+        args = {
+          poll_waiter: poll_waiter,
+          event_store: self,
+          from_event_id: from_id,
+          event_types: event_types,
+          events_table_name: @events_table_name,
+          subscription_master: subscription_master,
+          on_new_events: block
+        }
+        EventSourcery::EventStore::Subscription.new(args).tap do |s|
+          s.start
+        end
+      end
+
+      private
+
+      def events_table
+        @pg_connection[@events_table_name]
+      end
+
+      def build_event(data)
+        @event_builder.build(data)
+      end
+
+      def write_events_sql(aggregate_id, events, expected_version)
+        bodies = sql_literal_array(events, 'json', &:body)
+        types = sql_literal_array(events, 'varchar', &:type)
+        created_ats = sql_literal_array(events, 'timestamp without time zone', &:created_at)
+        event_uuids = sql_literal_array(events, 'uuid', &:uuid)
+        correlation_ids = sql_literal_array(events, 'uuid', &:correlation_id)
+        causation_ids = sql_literal_array(events, 'uuid', &:causation_id)
+        <<-SQL
+          select #{@write_events_function_name}(
+            #{sql_literal(aggregate_id.to_str, 'uuid')},
+            #{types},
+            #{sql_literal(expected_version, 'int')},
+            #{bodies},
+            #{created_ats},
+            #{event_uuids},
+            #{correlation_ids},
+            #{causation_ids},
+            #{sql_literal(@lock_table, 'boolean')}
+          );
+        SQL
+      end
+
+      def sql_literal_array(events, type, &block)
+        sql_array = events.map do |event|
+         to_sql_literal(block.call(event))
+        end.join(', ')
+        "array[#{sql_array}]::#{type}[]"
+      end
+
+      def sql_literal(value, type)
+        "#{to_sql_literal(value)}::#{type}"
+      end
+
+      def to_sql_literal(value)
+        return 'null' unless value
+        wrapped_value = if Time === value
+          value.iso8601(6)
+        elsif Hash === value
+          Sequel.pg_json(value)
+        else
+          value
+        end
+        @pg_connection.literal(wrapped_value)
+      end
+
+      def log_events_saved(events)
+        events.each do |event|
+          EventSourcery.logger.debug { "Saved event: #{event.inspect}" }
+        end
+      end
+    end
+  end
+end