pg_eventstore 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f21137e2e5210ac3482ac7dc91d6e7bcb7e34e51e24cbbfa558f891d071fdf4
-  data.tar.gz: 37e42584895549d55d99efd2bc1667916e5ded9c8a0b9539c2081cd2d0a1f323
+  metadata.gz: 28165ec2868d1585a23873a0aaeacf93cf5f088773f92b6d16255bc522e9d35f
+  data.tar.gz: 1c50c8958c7fd0ff4eb6b98aae2b81907ade4987078ab4d6711d7234cfd11850
 SHA512:
-  metadata.gz: e2190a042255a6e9b59c6822d586dbc9b142a2189ffc2c3e192fd4bc96862f1c38ceb5307fcf8f4f16d5ab2a0b57852cb46ef3553855f129a08ce289a2293266
-  data.tar.gz: 7b9e343f6fd66e620e8ae19c5d0bf480d393b69763c312786d983a7be90e13a2987ea8b6714268860dcd7d4e851674c755e88dc07c1da18f7bee82ae13480837
+  metadata.gz: 03f42aa5ee06cc45270e199a901fae2d24bbd2ebeeb68e7c6e05a5b81b28f78cd65b5bb98c348c8a31fa7446ba838181615234a1b9e81bfb2cdac72cfd98106a
+  data.tar.gz: c5b25f33166df1ad47616a1e0f3b24813992bdb68a8775b346565d9631f3f7cfc9c5e523ab68696c3dcd53cd4f4720b10d58df393361394d3a4b9a3a6aa294af

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## [Unreleased]
 
+## [0.7.0] - 2024-02-09
+
+- Refactor `pg_eventstore:create` and `pg_eventstore:drop` rake tasks. They now actually create/drop the database. You will have to execute `delete from migrations where number > 6` query before deploying this version.
+- Drop legacy migrations
+
 ## [0.6.0] - 2024-02-08
 
 - Add stream info into `PgEventstore::WrongExpectedRevisionError` error details

data/README.md

@@ -20,19 +20,7 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ## Usage
 
-Before you start, make sure you created a database where events will be stored. A PostgreSQL user must be a superuser to be able to create tables, indexes, primary/foreign keys, etc. Please don't use an existing database/user for this purpose. Example of creating such database and user:
-
-```bash
-sudo -u postgres createuser pg_eventstore --superuser
-sudo -u postgres psql --command="CREATE DATABASE eventstore OWNER pg_eventstore"
-sudo -u postgres psql --command="CREATE DATABASE eventstore OWNER pg_eventstore"
-```
-
-If necessary - adjust your `pg_hba.conf` to allow `pg_eventstore` user to connect to your PostgreSQL server. 
-
-Next step will be configuring a db connection. Please check the **Configuration** chapter bellow to find out how to do it.
-
-After the db connection is configured, it is time to create necessary database objects. Please include this line into your `Rakefile`:
+Before start using the gem - you have to create the database. Please include this line into your `Rakefile`:
 
 ```ruby
 load "pg_eventstore/tasks/setup.rake"
@@ -40,12 +28,13 @@ load "pg_eventstore/tasks/setup.rake"
 
 This will include necessary rake tasks. You can now run 
 ```bash
-export PG_EVENTSTORE_URI="postgresql://postgres:postgres@localhost:5532/postgres" # Replace this with your real connection url
+# Replace this with your real connection url
+export PG_EVENTSTORE_URI="postgresql://postgres:postgres@localhost:5532/eventstore"
 bundle exec rake pg_eventstore:create
 bundle exec rake pg_eventstore:migrate
 ```
 
-to create necessary database objects and migrate them to the actual version. After this step your `pg_eventstore` is ready to use.
+to create the database, necessary database objects and migrate them to the latest version. After this step your `pg_eventstore` is ready to use. There is also a `rake pg_eventstore:drop` task which drops the database.
 
 Documentation chapters:
 

data/db/migrations/1_create_streams.sql

@@ -0,0 +1,13 @@
+CREATE TABLE public.streams
+(
+    id              bigserial                     NOT NULL,
+    context         character varying             NOT NULL,
+    stream_name     character varying             NOT NULL,
+    stream_id       character varying             NOT NULL,
+    stream_revision integer DEFAULT '-1'::integer NOT NULL
+);
+
+ALTER TABLE ONLY public.streams
+    ADD CONSTRAINT streams_pkey PRIMARY KEY (id);
+
+CREATE UNIQUE INDEX idx_streams_context_and_stream_name_and_stream_id ON public.streams USING btree (context, stream_name, stream_id);

data/db/migrations/2_create_event_types.sql

@@ -0,0 +1,10 @@
+CREATE TABLE public.event_types
+(
+    id   bigserial         NOT NULL,
+    type character varying NOT NULL
+);
+
+ALTER TABLE ONLY public.event_types
+    ADD CONSTRAINT event_types_pkey PRIMARY KEY (id);
+
+CREATE UNIQUE INDEX idx_event_types_type ON public.event_types USING btree (type);

data/db/migrations/3_create_events.sql

@@ -0,0 +1,27 @@
+CREATE TABLE public.events
+(
+    id              uuid                        DEFAULT public.gen_random_uuid() NOT NULL,
+    stream_id       bigint                                                       NOT NULL,
+    global_position bigserial                                                    NOT NULL,
+    stream_revision integer                                                      NOT NULL,
+    data            jsonb                       DEFAULT '{}'::jsonb              NOT NULL,
+    metadata        jsonb                       DEFAULT '{}'::jsonb              NOT NULL,
+    link_id         uuid,
+    created_at      timestamp without time zone DEFAULT now()                    NOT NULL,
+    event_type_id   bigint                                                       NOT NULL
+);
+
+ALTER TABLE ONLY public.events
+    ADD CONSTRAINT events_pkey PRIMARY KEY (id);
+
+CREATE INDEX idx_events_event_type_id_and_global_position ON public.events USING btree (event_type_id, global_position);
+CREATE INDEX idx_events_global_position ON public.events USING btree (global_position);
+CREATE INDEX idx_events_link_id ON public.events USING btree (link_id);
+CREATE INDEX idx_events_stream_id_and_revision ON public.events USING btree (stream_id, stream_revision);
+
+ALTER TABLE ONLY public.events
+    ADD CONSTRAINT events_stream_fk FOREIGN KEY (stream_id) REFERENCES public.streams (id) ON DELETE CASCADE;
+ALTER TABLE ONLY public.events
+    ADD CONSTRAINT events_event_type_fk FOREIGN KEY (event_type_id) REFERENCES public.event_types (id);
+ALTER TABLE ONLY public.events
+    ADD CONSTRAINT events_link_fk FOREIGN KEY (link_id) REFERENCES public.events (id) ON DELETE CASCADE;

data/lib/pg_eventstore/config.rb

@@ -9,7 +9,9 @@ module PgEventstore
     # @!attribute pg_uri
     #   @return [String] PostgreSQL connection URI docs
     #     https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING-URIS
-    option(:pg_uri) { 'postgresql://postgres:postgres@localhost:5432/eventstore' }
+    option(:pg_uri) do
+      ENV.fetch('PG_EVENTSTORE_URI') { 'postgresql://postgres:postgres@localhost:5432/eventstore' }
+    end
     # @!attribute max_count
     #   @return [Integer] Number of events to return in one response when reading from a stream
     option(:max_count) { 1000 }

data/lib/pg_eventstore/rspec/test_helpers.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module PgEventstore
+  module TestHelpers
+    class << self
+      def clean_up_db
+        tables_to_purge = PgEventstore.connection.with do |conn|
+          conn.exec(<<~SQL)
+            SELECT tablename 
+            FROM pg_catalog.pg_tables WHERE schemaname NOT IN ('pg_catalog', 'information_schema') AND tablename != 'migrations'                
+          SQL
+        end.map { |attrs| attrs['tablename'] }
+        tables_to_purge.each do |table_name|
+          PgEventstore.connection.with { |c| c.exec("DELETE FROM #{table_name}") }
+        end
+      end
+    end
+  end
+end

data/lib/pg_eventstore/tasks/setup.rake

@@ -1,20 +1,36 @@
 # frozen_string_literal: true
 
+helpers = Class.new do
+  class << self
+    def postgres_uri
+      @postgres_uri ||=
+        begin
+          uri = URI.parse(ENV.fetch('PG_EVENTSTORE_URI'))
+          uri.path = '/postgres'
+          uri.to_s
+        end
+    end
+
+    def db_name
+      @db_name ||= URI.parse(ENV.fetch('PG_EVENTSTORE_URI')).path&.delete("/")
+    end
+  end
+end
+
 namespace :pg_eventstore do
   desc "Creates events table, indexes, etc."
   task :create do
     PgEventstore.configure do |config|
-      config.pg_uri = ENV['PG_EVENTSTORE_URI']
+      config.pg_uri = helpers.postgres_uri
     end
 
-    db_files_root = "#{Gem::Specification.find_by_name("pg_eventstore").gem_dir}/db/initial"
-
     PgEventstore.connection.with do |conn|
-      conn.transaction do
-        conn.exec(File.read("#{db_files_root}/extensions.sql"))
-        conn.exec(File.read("#{db_files_root}/tables.sql"))
-        conn.exec(File.read("#{db_files_root}/primary_and_foreign_keys.sql"))
-        conn.exec(File.read("#{db_files_root}/indexes.sql"))
+      exists =
+        conn.exec_params("SELECT 1 as exists FROM pg_database where datname = $1", [helpers.db_name]).first&.dig('exists')
+      if exists
+        puts "#{helpers.db_name} already exists. Skipping."
+      else
+        conn.exec("CREATE DATABASE #{conn.escape_string(helpers.db_name)} WITH OWNER #{conn.escape_string(conn.user)}")
       end
     end
   end
@@ -50,22 +66,11 @@ namespace :pg_eventstore do
   desc "Drops events table and related pg_eventstore objects."
   task :drop do
     PgEventstore.configure do |config|
-      config.pg_uri = ENV['PG_EVENTSTORE_URI']
+      config.pg_uri = helpers.postgres_uri
     end
 
     PgEventstore.connection.with do |conn|
-      conn.exec <<~SQL
-        DROP TABLE IF EXISTS public.events;
-        DROP TABLE IF EXISTS public.streams;
-        DROP TABLE IF EXISTS public.event_types;
-        DROP TABLE IF EXISTS public.migrations;
-        DROP TABLE IF EXISTS public.subscription_commands;
-        DROP TABLE IF EXISTS public.subscriptions_set_commands;
-        DROP TABLE IF EXISTS public.subscriptions_set;
-        DROP TABLE IF EXISTS public.subscriptions;
-        DROP EXTENSION IF EXISTS "uuid-ossp";
-        DROP EXTENSION IF EXISTS pgcrypto;
-      SQL
+      conn.exec("DROP DATABASE IF EXISTS #{conn.escape_string(helpers.db_name)}")
     end
   end
 end

data/lib/pg_eventstore/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PgEventstore
-  VERSION = "0.6.0"
+  VERSION = "0.7.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pg_eventstore
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Ivan Dzyzenko
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-02-08 00:00:00.000000000 Z
+date: 2024-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg
@@ -49,24 +49,13 @@ files:
 - CODE_OF_CONDUCT.md
 - LICENSE.txt
 - README.md
-- db/initial/extensions.sql
-- db/initial/indexes.sql
-- db/initial/primary_and_foreign_keys.sql
-- db/initial/tables.sql
-- db/migrations/0_improve_all_stream_indexes.sql
-- db/migrations/10_create_subscription_commands.sql
-- db/migrations/11_create_subscriptions_set_commands.sql
-- db/migrations/12_improve_events_indexes.sql
-- db/migrations/13_remove_duplicated_index.sql
-- db/migrations/1_improve_specific_stream_indexes.sql
-- db/migrations/2_adjust_global_position_index.sql
-- db/migrations/3_extract_type_into_separate_table.sql
-- db/migrations/4_populate_event_types.rb
-- db/migrations/5_adjust_indexes.sql
-- db/migrations/6_change_events_event_type_id_null_constraint.sql
-- db/migrations/7_change_events_type_constraint.sql
-- db/migrations/8_drop_events_type.sql
-- db/migrations/9_create_subscriptions.sql
+- db/migrations/0_create_extensions.sql
+- db/migrations/1_create_streams.sql
+- db/migrations/2_create_event_types.sql
+- db/migrations/3_create_events.sql
+- db/migrations/4_create_subscriptions.sql
+- db/migrations/5_create_subscription_commands.sql
+- db/migrations/6_create_subscriptions_set_commands.sql
 - docs/appending_events.md
 - docs/configuration.md
 - docs/events_and_streams.md
@@ -112,6 +101,7 @@ files:
 - lib/pg_eventstore/queries/transaction_queries.rb
 - lib/pg_eventstore/query_builders/events_filtering_query.rb
 - lib/pg_eventstore/rspec/has_option_matcher.rb
+- lib/pg_eventstore/rspec/test_helpers.rb
 - lib/pg_eventstore/sql_builder.rb
 - lib/pg_eventstore/stream.rb
 - lib/pg_eventstore/subscriptions/basic_runner.rb

data/db/initial/indexes.sql

@@ -1,13 +0,0 @@
-CREATE UNIQUE INDEX idx_streams_context_and_stream_name_and_stream_id ON public.streams USING btree (context, stream_name, stream_id);
--- This index is used when searching by the specific stream and event's types
-CREATE INDEX idx_events_stream_id_and_revision_and_type ON public.events USING btree (stream_id, stream_revision, type);
-
--- This index is used when searching by "all" stream using stream's attributes(context, stream_name, stream_id) and
--- event's types. PG's query planner picks this index when none of the given event's type exist
-CREATE INDEX idx_events_type_and_stream_id_and_position ON public.events USING btree (type, stream_id, global_position);
-
--- This index is used when searching by "all" stream using stream's attributes(context, stream_name, stream_id) and
--- event's types. PG's query planner picks this index when some of the given event's types exist
-CREATE INDEX idx_events_position_and_type ON public.events USING btree (global_position, type);
-
-CREATE INDEX idx_events_link_id ON public.events USING btree (link_id);

data/db/initial/primary_and_foreign_keys.sql

@@ -1,11 +0,0 @@
-ALTER TABLE ONLY public.streams
-    ADD CONSTRAINT streams_pkey PRIMARY KEY (id);
-ALTER TABLE ONLY public.events
-    ADD CONSTRAINT events_pkey PRIMARY KEY (id);
-
-ALTER TABLE ONLY public.events
-    ADD CONSTRAINT events_stream_fk FOREIGN KEY (stream_id)
-        REFERENCES public.streams (id) ON DELETE CASCADE;
-ALTER TABLE ONLY public.events
-    ADD CONSTRAINT events_link_fk FOREIGN KEY (link_id)
-        REFERENCES public.events (id) ON DELETE CASCADE;

data/db/initial/tables.sql

@@ -1,21 +0,0 @@
-CREATE TABLE public.streams
-(
-    id              bigserial         NOT NULL,
-    context         character varying NOT NULL,
-    stream_name     character varying NOT NULL,
-    stream_id       character varying NOT NULL,
-    stream_revision int DEFAULT -1    NOT NULL
-);
-
-CREATE TABLE public.events
-(
-    id              uuid                        NOT NULL DEFAULT public.gen_random_uuid(),
-    stream_id       bigint                      NOT NULL,
-    type            character varying           NOT NULL,
-    global_position bigserial                   NOT NULL,
-    stream_revision int                         NOT NULL,
-    data            jsonb                       NOT NULL DEFAULT '{}'::jsonb,
-    metadata        jsonb                       NOT NULL DEFAULT '{}'::jsonb,
-    link_id         uuid,
-    created_at      timestamp without time zone NOT NULL DEFAULT now()
-);

data/db/migrations/0_improve_all_stream_indexes.sql

@@ -1,3 +0,0 @@
-CREATE INDEX idx_events_type_and_position ON public.events USING btree (type, global_position);
-CREATE INDEX idx_events_global_position ON public.events USING btree (global_position);
-DROP INDEX idx_events_position_and_type;

data/db/migrations/12_improve_events_indexes.sql

@@ -1 +0,0 @@
-CREATE INDEX idx_events_event_type_id_and_global_position ON public.events USING btree (event_type_id, global_position);

data/db/migrations/13_remove_duplicated_index.sql

@@ -1 +0,0 @@
-DROP INDEX idx_events_event_type_id;

data/db/migrations/1_improve_specific_stream_indexes.sql

@@ -1,3 +0,0 @@
-CREATE INDEX idx_events_stream_id_and_type_and_revision ON public.events USING btree (stream_id, type, stream_revision);
-CREATE INDEX idx_events_stream_id_and_revision ON public.events USING btree (stream_id, stream_revision);
-DROP INDEX idx_events_stream_id_and_revision_and_type;

data/db/migrations/2_adjust_global_position_index.sql

@@ -1,4 +0,0 @@
-CREATE INDEX idx_events_global_position_including_type ON public.events USING btree (global_position) INCLUDE (type);
-COMMENT ON INDEX idx_events_global_position_including_type IS 'Usually "type" column has low distinct values. Thus, composit index by "type" and "global_position" columns may not be picked by Query Planner properly. Improve an index by "global_position" by including "type" column which allows Query Planner to perform better by picking the correct index.';
-
-DROP INDEX idx_events_global_position;

data/db/migrations/3_extract_type_into_separate_table.sql

@@ -1,17 +0,0 @@
-CREATE TABLE public.event_types
-(
-    id              bigserial         NOT NULL,
-    type            character varying NOT NULL
-);
-
-ALTER TABLE ONLY public.events ADD COLUMN event_type_id bigint;
-
-ALTER TABLE ONLY public.event_types
-    ADD CONSTRAINT event_types_pkey PRIMARY KEY (id);
-
-ALTER TABLE ONLY public.events
-    ADD CONSTRAINT events_event_type_fk FOREIGN KEY (event_type_id)
-        REFERENCES public.event_types (id);
-
-CREATE UNIQUE INDEX idx_event_types_type ON public.event_types USING btree (type);
-CREATE INDEX idx_events_event_type_id ON public.events USING btree (event_type_id);

data/db/migrations/4_populate_event_types.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-PgEventstore.connection.with do |conn|
-  types = conn.exec('select type from events group by type').to_a.map { |attrs| attrs['type'] }
-  types.each.with_index(1) do |type, index|
-    id = conn.exec_params('SELECT id FROM event_types WHERE type = $1', [type]).to_a.first['id']
-    id ||= conn.exec_params('INSERT INTO event_types (type) VALUES ($1) RETURNING *', [type]).to_a.first['id']
-    conn.exec_params('UPDATE events SET event_type_id = $1 WHERE type = $2 AND event_type_id IS NULL', [id, type])
-    puts "Processed #{index} types of #{types.size}"
-  end
-end

data/db/migrations/5_adjust_indexes.sql

@@ -1,6 +0,0 @@
-CREATE INDEX idx_events_global_position ON public.events USING btree (global_position);
-
-DROP INDEX idx_events_stream_id_and_type_and_revision;
-DROP INDEX idx_events_type_and_stream_id_and_position;
-DROP INDEX idx_events_global_position_including_type;
-DROP INDEX idx_events_type_and_position;

data/db/migrations/6_change_events_event_type_id_null_constraint.sql

@@ -1 +0,0 @@
-ALTER TABLE public.events ALTER COLUMN event_type_id SET NOT NULL;

data/db/migrations/7_change_events_type_constraint.sql

@@ -1 +0,0 @@
-ALTER TABLE public.events ALTER COLUMN type DROP NOT NULL;

data/db/migrations/8_drop_events_type.sql

@@ -1 +0,0 @@
-ALTER TABLE public.events DROP COLUMN type;