active_durable 0.6.0 → 0.8.0

data/lib/generators/active_durable/install/templates/create_active_durable_tables.rb.tt

@@ -4,33 +4,37 @@ class CreateActiveDurableTables < ActiveRecord::Migration<%= migration_version %
   def change
     # One row per saga run. It is also the buzón: create it in the same transaction as your record.
     create_table :durable_executions, id: false do |t|
-      t.string :id, null: false, primary_key: true
+      t.string :id, null: false, primary_key: true, **exact
       t.string :recipe, null: false
       t.integer :recipe_version, null: false, default: 1
       t.string :status, null: false
       t.boolean :compensating, null: false, default: false
       t.column :input, json_type
+      t.column :context, json_type
       t.column :output, json_type
       t.column :error, json_type
       t.datetime :wake_at, precision: 6
       t.datetime :locked_until, precision: 6
       t.string :lease_token
-      t.string :forked_from
+      t.string :forked_from, **exact
+      t.string :continued_as, **exact
       t.timestamps precision: 6
     end
     add_index :durable_executions, %i[status wake_at]
     add_index :durable_executions, %i[status updated_at]
     add_index :durable_executions, %i[recipe status]
     add_index :durable_executions, :forked_from
+    add_index :durable_executions, :continued_as
 
     # The notebook: one row per step (and per undo) of an execution.
     create_table :durable_steps do |t|
-      t.string :execution_id, null: false
-      t.string :name, null: false
+      t.string :execution_id, null: false, **exact
+      t.string :name, null: false, **exact
       t.string :kind, null: false
       t.integer :position
       t.string :status, null: false
       t.integer :attempts, null: false, default: 0
+      t.string :signal_name, **exact
       t.column :result, json_type
       t.column :error, json_type
       t.datetime :wake_at, precision: 6
@@ -42,8 +46,8 @@ class CreateActiveDurableTables < ActiveRecord::Migration<%= migration_version %
 
     # Signals for flow.wait_for. They can arrive before the saga starts waiting.
     create_table :durable_signals do |t|
-      t.string :execution_id, null: false
-      t.string :name, null: false
+      t.string :execution_id, null: false, **exact
+      t.string :name, null: false, **exact
       t.column :payload, json_type
       t.datetime :consumed_at, precision: 6
       t.datetime :created_at, null: false, precision: 6
@@ -58,4 +62,9 @@ class CreateActiveDurableTables < ActiveRecord::Migration<%= migration_version %
   def json_type
     connection.adapter_name.downcase.include?("postg") ? :jsonb : :json
   end
+
+  # MySQL compares strings ignoring case and accents by default; ids and step names must match exactly.
+  def exact
+    connection.adapter_name.match?(/mysql|trilogy/i) ? { collation: "utf8mb4_bin" } : {}
+  end
 end

data/lib/generators/active_durable/upgrade/templates/add_active_durable_context.rb.tt

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+# ActiveDurable 0.8: the context an execution started with (config.context), given back to it on every run.
+class AddActiveDurableContext < ActiveRecord::Migration<%= migration_version %>
+  def up
+    add_column :durable_executions, :context, json_type unless column_exists?(:durable_executions, :context)
+  end
+
+  def down
+    remove_column :durable_executions, :context if column_exists?(:durable_executions, :context)
+  end
+
+  private
+
+  # jsonb on PostgreSQL, json elsewhere, like the other JSON columns.
+  def json_type
+    connection.adapter_name.downcase.include?("postg") ? :jsonb : :json
+  end
+end

data/lib/generators/active_durable/upgrade/templates/add_active_durable_continued_as.rb.tt

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# ActiveDurable 0.8: flow.continue_as_new closes an execution and points it to the one that carries on.
+class AddActiveDurableContinuedAs < ActiveRecord::Migration<%= migration_version %>
+  def up
+    add_column :durable_executions, :continued_as, :string, **exact unless column_exists?(:durable_executions, :continued_as)
+    add_index :durable_executions, :continued_as unless index_exists?(:durable_executions, :continued_as)
+  end
+
+  def down
+    remove_index :durable_executions, :continued_as if index_exists?(:durable_executions, :continued_as)
+    remove_column :durable_executions, :continued_as if column_exists?(:durable_executions, :continued_as)
+  end
+
+  private
+
+  # MySQL compares strings ignoring case and accents by default; ids must match exactly.
+  def exact
+    connection.adapter_name.match?(/mysql|trilogy/i) ? { collation: "utf8mb4_bin" } : {}
+  end
+end

data/lib/generators/active_durable/upgrade/templates/add_active_durable_signal_name.rb.tt

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# ActiveDurable 0.8: flow.wait_for(name, signal: ...) writes down which signal a step waits for, when it is not the
+# step's own name.
+class AddActiveDurableSignalName < ActiveRecord::Migration<%= migration_version %>
+  def up
+    return if column_exists?(:durable_steps, :signal_name)
+
+    add_column :durable_steps, :signal_name, :string, **exact
+  end
+
+  def down
+    remove_column :durable_steps, :signal_name if column_exists?(:durable_steps, :signal_name)
+  end
+
+  private
+
+  # MySQL compares strings ignoring case and accents by default; signal names must match exactly.
+  def exact
+    connection.adapter_name.match?(/mysql|trilogy/i) ? { collation: "utf8mb4_bin" } : {}
+  end
+end

data/lib/generators/active_durable/upgrade/templates/make_active_durable_ids_case_sensitive.rb.tt

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+# ActiveDurable 0.7: MySQL compared ids and step names ignoring case and accents, so "order-abc" and "order-ÁBC"
+# shared one saga. These columns now compare byte by byte, as on PostgreSQL and SQLite. Elsewhere it does nothing.
+#
+# On MySQL it rebuilds the three tables and blocks writes to them while it runs: run it at a quiet time, or prune
+# first. MySQL cannot roll DDL back, so if it stops halfway, run it again: it finishes the columns and puts the
+# foreign keys back.
+class MakeActiveDurableIdsCaseSensitive < ActiveRecord::Migration<%= migration_version %>
+  COLUMNS = {
+    durable_executions: %w[id forked_from],
+    durable_steps: %w[execution_id name],
+    durable_signals: %w[execution_id name]
+  }.freeze
+
+  def up
+    change_collation { |_table| "utf8mb4_bin" }
+  end
+
+  def down
+    change_collation { |table| table_collation(table) }
+  end
+
+  private
+
+  def change_collation
+    return unless connection.adapter_name.match?(/mysql|trilogy/i)
+
+    changes = COLUMNS.flat_map do |table, names|
+      wanted = yield(table)
+      connection.columns(table).select { |column| names.include?(column.name) && column.collation != wanted }
+                .map { |column| [table, column, wanted] }
+    end
+
+    # Both ends of a foreign key must share a collation, so the keys come off while the columns change.
+    on_delete = remove_foreign_keys if changes.any?
+    changes.each do |table, column, collation|
+      change_column table, column.name, :string, limit: column.limit, null: column.null, collation: collation
+    end
+    restore_foreign_keys(on_delete || {})
+  end
+
+  FOREIGN_KEY_TABLES = %i[durable_steps durable_signals].freeze
+
+  def foreign_key(table)
+    connection.foreign_keys(table).find { |key| key.column == "execution_id" }
+  end
+
+  def remove_foreign_keys
+    FOREIGN_KEY_TABLES.each_with_object({}) do |table, on_delete|
+      key = foreign_key(table)
+      next unless key
+
+      on_delete[table] = key.options[:on_delete]
+      remove_foreign_key table, column: :execution_id
+    end
+  end
+
+  # Also puts back keys that an earlier run, stopped halfway, left off.
+  def restore_foreign_keys(on_delete)
+    FOREIGN_KEY_TABLES.each do |table|
+      next if foreign_key(table)
+
+      add_foreign_key table, :durable_executions, column: :execution_id, on_delete: on_delete.fetch(table, :cascade)
+    end
+  end
+
+  def table_collation(table)
+    select_value("SELECT TABLE_COLLATION FROM information_schema.TABLES " \
+                 "WHERE TABLE_SCHEMA = DATABASE() AND TABLE_NAME = #{connection.quote(table.to_s)}")
+  end
+end

data/lib/generators/active_durable/upgrade/upgrade_generator.rb

@@ -16,7 +16,10 @@ module ActiveDurable
       desc "Adds the migrations that newer ActiveDurable versions need. Run it after updating the gem."
 
       # In the order they were released. Never edit one that shipped: add a new one.
-      MIGRATIONS = %w[add_active_durable_prune_index].freeze
+      MIGRATIONS = %w[
+        add_active_durable_prune_index make_active_durable_ids_case_sensitive add_active_durable_context
+        add_active_durable_signal_name add_active_durable_continued_as
+      ].freeze
 
       # @api private
       def create_migration_files

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_durable
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.8.0
 platform: ruby
 authors:
 - William Romero
@@ -120,7 +120,11 @@ files:
 - lib/active_durable/version.rb
 - lib/generators/active_durable/install/install_generator.rb
 - lib/generators/active_durable/install/templates/create_active_durable_tables.rb.tt
+- lib/generators/active_durable/upgrade/templates/add_active_durable_context.rb.tt
+- lib/generators/active_durable/upgrade/templates/add_active_durable_continued_as.rb.tt
 - lib/generators/active_durable/upgrade/templates/add_active_durable_prune_index.rb.tt
+- lib/generators/active_durable/upgrade/templates/add_active_durable_signal_name.rb.tt
+- lib/generators/active_durable/upgrade/templates/make_active_durable_ids_case_sensitive.rb.tt
 - lib/generators/active_durable/upgrade/upgrade_generator.rb
 - lib/tasks/active_durable.rake
 - sig/active_durable.rbs