A platform for community discussion. Free, open, simple.
MT: Let a generated model declare its conflict strategy in the schema DSL
Gerhard Schlager67e987c1f5a5
diff --git a/migrations/tooling/lib/migrations/tooling/schema.rb b/migrations/tooling/lib/migrations/tooling/schema.rbindex a0289ba48ac..2a18f097548 100644--- a/migrations/tooling/lib/migrations/tooling/schema.rb+++ b/migrations/tooling/lib/migrations/tooling/schema.rb@@ -14,7 +14,12 @@ module Migrations:primary_key_column_names,:constraints,:model_mode,+ :conflict_strategy,) do+ def initialize(conflict_strategy: :raise, **args)+ super(conflict_strategy:, **args)+ end+def sorted_columnspk_position = primary_key_column_names.each_with_index.to_hcolumns.sort_by { |c| [c.is_primary_key ? 0 : 1, pk_position.fetch(c.name, 0), c.name] }diff --git a/migrations/tooling/lib/migrations/tooling/schema/dsl/schema_resolver.rb b/migrations/tooling/lib/migrations/tooling/schema/dsl/schema_resolver.rbindex dad72aebbee..9b977a8d90f 100644--- a/migrations/tooling/lib/migrations/tooling/schema/dsl/schema_resolver.rb+++ b/migrations/tooling/lib/migrations/tooling/schema/dsl/schema_resolver.rb@@ -56,6 +56,7 @@ module Migrationsprimary_key_column_names: resolved_pk_names,constraints:,model_mode: table_def.model_mode,+ conflict_strategy: table_def.conflict_strategy,)enddiff --git a/migrations/tooling/lib/migrations/tooling/schema/dsl/table_builder.rb b/migrations/tooling/lib/migrations/tooling/schema/dsl/table_builder.rbindex bbfbdffbf93..c75e13d1c9c 100644--- a/migrations/tooling/lib/migrations/tooling/schema/dsl/table_builder.rb+++ b/migrations/tooling/lib/migrations/tooling/schema/dsl/table_builder.rb@@ -24,6 +24,7 @@ module Migrations:ignore_plugin_columns,:ignore_plugin_names,:model_mode,+ :conflict_strategy,) dodef column_options_for(col)column_options[col.to_s]@@ -43,6 +44,7 @@ module MigrationsendVALID_MODEL_MODES = %i[extended manual].freeze+ VALID_CONFLICT_STRATEGIES = %i[raise ignore].freezeclass TableBuilderdef initialize(name)@@ -60,6 +62,7 @@ module Migrations@ignore_plugin_columns = false@ignore_plugin_names = nil@model_mode = nil+ @conflict_strategy = :raiseenddef copy_structure_from(table)@@ -148,6 +151,18 @@ module Migrations@model_mode = modeend+ # How the model's inserts and the shard merge handle a duplicate row.+ # `:raise` (the default) uses a plain `INSERT`; `:ignore` uses `INSERT OR+ # IGNORE`, keeping the first row and dropping later duplicates.+ def conflict_strategy(strategy)+ strategy = strategy.to_sym+ if VALID_CONFLICT_STRATEGIES.exclude?(strategy)+ raise ConfigError,+ "Invalid conflict strategy :#{strategy} for table :#{@name}. Valid: #{VALID_CONFLICT_STRATEGIES.join(", ")}"+ end+ @conflict_strategy = strategy+ end+def buildif @source_table_name && @included_columns.nil? && !@include_all &&@ignored_columns.empty?@@ -186,6 +201,7 @@ module Migrationsignore_plugin_columns: @ignore_plugin_columns,ignore_plugin_names: @ignore_plugin_names&.freeze,model_mode: @model_mode,+ conflict_strategy: @conflict_strategy,)enddiff --git a/migrations/tooling/lib/migrations/tooling/schema/model_writer.rb b/migrations/tooling/lib/migrations/tooling/schema/model_writer.rbindex 244a0eb0b7c..ce0f6dc8af2 100644--- a/migrations/tooling/lib/migrations/tooling/schema/model_writer.rb+++ b/migrations/tooling/lib/migrations/tooling/schema/model_writer.rb@@ -28,7 +28,7 @@ module Migrations@namespace_parts.each { |part| emit "module #{part}" }emit " module #{module_name}"emit " SQL = <<~SQL"- emit " INSERT INTO #{escape_identifier(table.name)} ("+ emit " #{insert_statement(table)} INTO #{escape_identifier(table.name)} ("emit column_names(columns)emit " )"emit " VALUES ("@@ -38,6 +38,8 @@ module Migrationsemit " private_constant :SQL"emit+ emit_conflict_strategy(table)+if table.model_mode == :extendedemit " # -- custom code --"emit custom_code if custom_code.present?@@ -71,6 +73,22 @@ module Migrationsendend+ def insert_statement(table)+ table.conflict_strategy == :ignore ? "INSERT OR IGNORE" : "INSERT"+ end++ # Only `:ignore` needs a declaration; the absent method reads back as+ # `:raise` via `IntermediateDB.conflict_strategy_for`, so a plain model's+ # output is unchanged.+ def emit_conflict_strategy(table)+ return unless table.conflict_strategy == :ignore++ emit " def self.conflict_strategy"+ emit " :ignore"+ emit " end"+ emit+ end+def column_names(columns)columns.map { |c| " #{escape_identifier(c.name)}" }.join(",\n")enddiff --git a/migrations/tooling/spec/lib/migrations/tooling/schema/dsl/generator_spec.rb b/migrations/tooling/spec/lib/migrations/tooling/schema/dsl/generator_spec.rbindex b05f2b8f9fd..a760c6bfa58 100644--- a/migrations/tooling/spec/lib/migrations/tooling/schema/dsl/generator_spec.rb+++ b/migrations/tooling/spec/lib/migrations/tooling/schema/dsl/generator_spec.rb@@ -3,9 +3,10 @@RSpec.describe Migrations::Tooling::Schema::DSL::Generator doafter { Migrations::Tooling::Schema.reset! }- def make_table(name, model_mode: nil)+ def make_table(name, model_mode: nil, conflict_strategy: :raise)Migrations::Tooling::Schema::TableDefinition.new(name:,+ conflict_strategy:,columns: [Migrations::Tooling::Schema::ColumnDefinition.new(name: "id",@@ -158,6 +159,37 @@ RSpec.describe Migrations::Tooling::Schema::DSL::Generator doendend+ it "generates a plain `INSERT` and no conflict strategy for the default `:raise`" do+ Dir.mktmpdir do |tmpdir|+ paths = configure_output(tmpdir)+ stub_validation_and_resolution(resolved_definition)++ described_class.new(Migrations::Tooling::Schema).generate++ model_content = File.read(File.join(paths[:models], "user.rb"))+ expect(model_content).to include("INSERT INTO users")+ expect(model_content).not_to include("INSERT OR IGNORE")+ expect(model_content).not_to include("def self.conflict_strategy")+ end+ end++ it "generates `INSERT OR IGNORE` and a conflict strategy for `:ignore`" do+ Dir.mktmpdir do |tmpdir|+ paths = configure_output(tmpdir)++ table = make_table("users", conflict_strategy: :ignore)+ definition = Migrations::Tooling::Schema::Definition.new(tables: [table], enums: [])+ stub_validation_and_resolution(definition)++ described_class.new(Migrations::Tooling::Schema).generate++ model_content = File.read(File.join(paths[:models], "user.rb"))+ expect(model_content).to include("INSERT OR IGNORE INTO users")+ expect(model_content).to include("def self.conflict_strategy")+ expect(model_content).to include(":ignore")+ end+ end+it "does not create a model file for :manual mode even when models directory exists" doDir.mktmpdir do |tmpdir|paths = configure_output(tmpdir)diff --git a/migrations/tooling/spec/lib/migrations/tooling/schema/dsl/table_builder_spec.rb b/migrations/tooling/spec/lib/migrations/tooling/schema/dsl/table_builder_spec.rbindex a7e1bde1e38..d537e57f5a7 100644--- a/migrations/tooling/spec/lib/migrations/tooling/schema/dsl/table_builder_spec.rb+++ b/migrations/tooling/spec/lib/migrations/tooling/schema/dsl/table_builder_spec.rb@@ -36,6 +36,37 @@ RSpec.describe Migrations::Tooling::Schema::DSL::TableBuilder doend.to raise_error(Migrations::Tooling::Schema::ConfigError, /Invalid model mode :invalid/)end+ it "defaults the conflict strategy to `:raise`" do+ Migrations::Tooling::Schema.table :users do+ primary_key :id+ include :id+ end++ expect(Migrations::Tooling::Schema.tables["users"].conflict_strategy).to eq(:raise)+ end++ it "records a declared conflict strategy" do+ Migrations::Tooling::Schema.table :uploads do+ conflict_strategy :ignore+ synthetic!+ primary_key :id+ add_column :id, :text+ end++ expect(Migrations::Tooling::Schema.tables["uploads"].conflict_strategy).to eq(:ignore)+ end++ it "raises on an invalid conflict strategy" do+ expect do+ Migrations::Tooling::Schema.table :users do+ conflict_strategy :maybe+ end+ end.to raise_error(+ Migrations::Tooling::Schema::ConfigError,+ /Invalid conflict strategy :maybe/,+ )+ end+it "raises when synthetic table uses include or include_all" do%i[include include_all].each do |method|expect do