feat(translations): update name translations to use string type for consistency and performance

rsmithlal · rsmithlal · commit 8d593c43dc16 · 2025-10-27T12:35:45.000-02:30
diff --git a/app/models/better_together/calendar.rb b/app/models/better_together/calendar.rb
@@ -17,7 +17,7 @@ class Calendar < ApplicationRecord
 
     slugged :name
 
-    translates :name
+    translates :name, type: :string
     translates :description, backend: :action_text
 
     def to_s
diff --git a/app/models/better_together/call_for_interest.rb b/app/models/better_together/call_for_interest.rb
@@ -9,7 +9,7 @@ class CallForInterest < ApplicationRecord
     include Identifier
     include Privacy
 
-    translates :name
+    translates :name, type: :string
     translates :description, backend: :action_text
 
     slugged :name
diff --git a/app/models/better_together/event.rb b/app/models/better_together/event.rb
@@ -36,7 +36,7 @@ class Event < ApplicationRecord
     # delegate :geocoding_string, to: :address, allow_nil: true
     # geocoded_by :geocoding_string
 
-    translates :name
+    translates :name, type: :string
     translates :description, backend: :action_text
 
     slugged :name
diff --git a/app/models/better_together/infrastructure/building.rb b/app/models/better_together/infrastructure/building.rb
@@ -42,7 +42,7 @@ class Building < ApplicationRecord
       after_create :schedule_address_geocoding
       after_update :schedule_address_geocoding
 
-      translates :name
+      translates :name, type: :string
       translates :description, backend: :action_text
 
       slugged :name
diff --git a/app/models/better_together/infrastructure/floor.rb b/app/models/better_together/infrastructure/floor.rb
@@ -20,7 +20,7 @@ class Floor < ApplicationRecord
       belongs_to :building, class_name: 'BetterTogether::Infrastructure::Building', touch: true
       has_many :rooms, class_name: 'BetterTogether::Infrastructure::Room', dependent: :destroy
 
-      translates :name
+      translates :name, type: :string
       translates :description, backend: :action_text
 
       slugged :name
diff --git a/app/models/better_together/infrastructure/room.rb b/app/models/better_together/infrastructure/room.rb
@@ -19,7 +19,7 @@ class Room < ApplicationRecord
 
       delegate :level, to: :floor
 
-      translates :name
+      translates :name, type: :string
       translates :description, backend: :action_text
 
       slugged :name
diff --git a/app/models/better_together/role.rb b/app/models/better_together/role.rb
@@ -13,7 +13,7 @@ class Role < ApplicationRecord
 
     slugged :identifier, dependent: :delete_all
 
-    translates :name
+    translates :name, type: :string
     translates :description, type: :text
 
     validates :name,
diff --git a/app/models/better_together/upload.rb b/app/models/better_together/upload.rb
@@ -12,7 +12,7 @@ class Upload < ApplicationRecord
 
     delegate :attached?, :byte_size, :content_type, :download, :filename, :url, to: :file
 
-    translates :name
+    translates :name, type: :string
     translates :description, backend: :action_text
 
     include RemoveableAttachment
diff --git a/app/models/better_together/wizard.rb b/app/models/better_together/wizard.rb
@@ -12,7 +12,7 @@ class Wizard < ApplicationRecord
 
     slugged :identifier, dependent: :delete_all
 
-    translates :name
+    translates :name, type: :string
     translates :description, type: :text
 
     validates :name, presence: true
diff --git a/app/models/better_together/wizard_step_definition.rb b/app/models/better_together/wizard_step_definition.rb
@@ -14,7 +14,7 @@ class WizardStepDefinition < ApplicationRecord
 
     slugged :identifier, dependent: :delete_all
 
-    translates :name
+    translates :name, type: :string
     translates :description, type: :text
 
     validates :name, presence: true
diff --git a/lib/tasks/mobility_translation_migration.rake b/lib/tasks/mobility_translation_migration.rake
@@ -0,0 +1,290 @@
+# Mobility Translation Migration Tasks
+#
+# These tasks handle migrating community and partner name translations from the
+# mobility_text_translations table to the mobility_string_translations table.
+# This fixes an issue where names were incorrectly stored as text type instead
+# of string type due to Mobility gem defaults.
+#
+# Performance Optimizations:
+# - Uses bulk operations (insert_all, delete_all) instead of individual record operations
+# - Reduces database round trips from N operations to 2 operations
+# - Bypasses ActiveRecord callbacks (especially Elasticsearch indexing)
+# - Provides timing information for performance monitoring
+#
+# Usage:
+#   bin/dc-run rails translations:mobility:check_names_status          # Check current status
+#   bin/dc-run rails translations:mobility:migrate_names_to_string     # Perform migration
+#   bin/dc-run rails translations:mobility:clean_up_text_translations  # Clean up remaining records
+#
+# The migration can also be executed through Rails migrations via:
+#   bin/dc-run rails db:migrate
+
+namespace :translations do
+  namespace :mobility do
+    desc 'Migrate community and partner name translations from text to string translations'
+    task migrate_names_to_string: :environment do
+      puts 'Starting migration of names from text to string translations...'
+      puts '=' * 80
+
+      # Use Mobility's KeyValue backend models for safer operations
+      text_translation_class = Mobility::Backends::ActiveRecord::KeyValue::TextTranslation
+      string_translation_class = Mobility::Backends::ActiveRecord::KeyValue::StringTranslation
+
+      # Find all name translations for communities and partners in text translations
+      text_name_translations = text_translation_class.where(
+        key: 'name'
+      )
+
+      all_text_translations = text_name_translations.uniq
+
+      puts "Found #{all_text_translations.count} name translations in text_translations table"
+
+      if all_text_translations.empty?
+        puts 'No name translations found in text translations table. Migration not needed.'
+        next
+      end
+
+      # Group by translatable_type for reporting
+      grouped_translations = all_text_translations.group_by(&:translatable_type)
+      grouped_translations.each do |type, translations|
+        puts "  - #{type}: #{translations.count} translations"
+      end
+
+      puts "\nStarting migration process..."
+      puts '-' * 40
+
+      migration_count = 0
+      skipped_count = 0
+      error_count = 0
+
+      # Collect records for bulk operations
+      # This approach is much faster than individual operations:
+      # - Single insert_all() vs N individual creates
+      # - Single delete_all() vs N individual destroys
+      # - Bypasses ActiveRecord callbacks (especially Elasticsearch)
+      # - Reduces database round trips from N to 2 operations
+      records_to_create = []
+      records_to_delete = []
+
+      all_text_translations.each_with_index do |text_translation, index|
+        begin
+          # Check if a string translation already exists for this record
+          existing_string = string_translation_class.find_by(
+            translatable_type: text_translation.translatable_type,
+            translatable_id: text_translation.translatable_id,
+            key: 'name',
+            locale: text_translation.locale
+          )
+
+          if existing_string.nil?
+            # Prepare record for bulk creation
+            records_to_create << {
+              translatable_type: text_translation.translatable_type,
+              translatable_id: text_translation.translatable_id,
+              key: 'name',
+              locale: text_translation.locale,
+              value: text_translation.value,
+              created_at: text_translation.created_at,
+              updated_at: text_translation.updated_at
+            }
+
+            puts "✓ Prepared for migration: #{text_translation.translatable_type} ##{text_translation.translatable_id} name (#{text_translation.locale}): '#{text_translation.value}'"
+            migration_count += 1
+          else
+            puts "⚠ String translation already exists for #{text_translation.translatable_type} ##{text_translation.translatable_id} name (#{text_translation.locale}), skipping"
+            skipped_count += 1
+          end
+
+          # Always prepare text translation for bulk deletion
+          records_to_delete << text_translation.id
+        rescue StandardError => e
+          puts "✗ Error preparing #{text_translation.translatable_type} ##{text_translation.translatable_id}: #{e.message}"
+          error_count += 1
+        end
+
+        # Progress indicator for large datasets
+        if (index + 1) % 10 == 0 || (index + 1) == all_text_translations.count
+          puts "Progress: #{index + 1}/#{all_text_translations.count} prepared"
+        end
+      end
+
+      # Perform bulk operations
+      puts "\nPerforming bulk operations..."
+      puts '-' * 40
+
+      # Bulk create string translations
+      if records_to_create.any?
+        puts "Creating #{records_to_create.count} string translations in bulk..."
+        start_time = Time.current
+        begin
+          # Use insert_all for maximum performance - single SQL statement
+          string_translation_class.insert_all(records_to_create)
+          elapsed = (Time.current - start_time).round(3)
+          puts "✓ Successfully created #{records_to_create.count} string translations in #{elapsed}s"
+        rescue StandardError => e
+          elapsed = (Time.current - start_time).round(3)
+          puts "✗ Error during bulk creation (#{elapsed}s): #{e.message}"
+          error_count += records_to_create.count
+          migration_count -= records_to_create.count
+        end
+      end
+
+      # Bulk delete text translations (bypass Elasticsearch callbacks)
+      if records_to_delete.any?
+        puts "Deleting #{records_to_delete.count} text translations in bulk..."
+        start_time = Time.current
+        begin
+          # Use delete_all for bulk deletion - single SQL statement, bypasses callbacks
+          deleted_count = text_translation_class.where(id: records_to_delete).delete_all
+          elapsed = (Time.current - start_time).round(3)
+          puts "✓ Successfully deleted #{deleted_count} text translations in #{elapsed}s"
+        rescue StandardError => e
+          elapsed = (Time.current - start_time).round(3)
+          puts "✗ Error during bulk deletion (#{elapsed}s): #{e.message}"
+          # Don't count as errors since string translations were already created
+        end
+      end
+
+      puts "\n" + ('=' * 80)
+      puts 'Migration Summary:'
+      puts "  ✓ Successfully migrated: #{migration_count}"
+      puts "  ⚠ Skipped (already exist): #{skipped_count}"
+      puts "  ✗ Errors encountered: #{error_count}"
+      puts "  Total processed: #{all_text_translations.count}"
+      puts "\nMigration completed!"
+    end
+
+    desc 'Clean up remaining text translations after successful migration (DANGEROUS: removes data)'
+    task clean_up_text_translations: :environment do
+      puts 'Cleaning up remaining text translations for community/partner names...'
+      puts '⚠️  WARNING: This will permanently delete records from the text_translations table!'
+      puts '=' * 80
+
+      text_translation_class = Mobility::Backends::ActiveRecord::KeyValue::TextTranslation
+      string_translation_class = Mobility::Backends::ActiveRecord::KeyValue::StringTranslation
+
+      # Find remaining text name translations
+      text_name_translations = text_translation_class.where(
+        key: 'name'
+      )
+
+      all_text_translations = text_name_translations.uniq
+
+      if all_text_translations.empty?
+        puts '✅ No text translations found to clean up!'
+        next
+      end
+
+      puts "Found #{all_text_translations.count} remaining text translations:"
+
+      cleanup_count = 0
+      verification_failures = 0
+      records_to_delete = []
+
+      # First pass: verify and collect IDs for bulk deletion
+      all_text_translations.each do |text_translation|
+        # Verify corresponding string translation exists before deleting
+        string_exists = string_translation_class.exists?(
+          translatable_type: text_translation.translatable_type,
+          translatable_id: text_translation.translatable_id,
+          key: 'name',
+          locale: text_translation.locale
+        )
+
+        if string_exists
+          # Safe to delete the text translation - add to bulk deletion list
+          records_to_delete << text_translation.id
+          puts "🗑️  Prepared for cleanup: #{text_translation.translatable_type} ##{text_translation.translatable_id} name (#{text_translation.locale})"
+          cleanup_count += 1
+        else
+          puts "⚠️  String translation missing for #{text_translation.translatable_type} ##{text_translation.translatable_id} (#{text_translation.locale}) - skipping cleanup"
+          verification_failures += 1
+        end
+      end
+
+      # Perform bulk deletion
+      if records_to_delete.any?
+        puts "\nPerforming bulk cleanup of #{records_to_delete.count} records..."
+        start_time = Time.current
+        begin
+          deleted_count = text_translation_class.where(id: records_to_delete).delete_all
+          elapsed = (Time.current - start_time).round(3)
+          puts "✓ Successfully cleaned up #{deleted_count} text translations in #{elapsed}s"
+        rescue StandardError => e
+          elapsed = (Time.current - start_time).round(3)
+          puts "✗ Error during bulk cleanup (#{elapsed}s): #{e.message}"
+          cleanup_count = 0 # Reset count on error
+        end
+      end
+
+      puts "\n" + ('=' * 80)
+      puts 'Cleanup Summary:'
+      puts "  🗑️  Records cleaned up: #{cleanup_count}"
+      puts "  ⚠️  Verification failures: #{verification_failures}"
+      puts "  Total processed: #{all_text_translations.count}"
+      puts "\nCleanup completed!"
+    end
+
+    desc 'Check status of community/partner name translations (dry run)'
+    task check_names_status: :environment do
+      puts 'Checking status of community/partner name translations...'
+      puts '=' * 80
+
+      # Use Mobility's KeyValue backend models
+      text_translation_class = Mobility::Backends::ActiveRecord::KeyValue::TextTranslation
+      string_translation_class = Mobility::Backends::ActiveRecord::KeyValue::StringTranslation
+
+      # Check text translations
+      text_name_translations = text_translation_class.where(
+        key: 'name'
+      )
+
+      all_text_translations = text_name_translations.uniq
+
+      # Check string translations
+      string_name_translations = string_translation_class.where(
+        key: 'name'
+      )
+
+      all_string_translations = string_name_translations.uniq
+
+      puts 'Current Translation Status:'
+      puts '-' * 40
+      puts '📝 Text translations (should be 0 after migration):'
+      puts "   Total: #{all_text_translations.count}"
+
+      if all_text_translations.any?
+        grouped_text = all_text_translations.group_by(&:translatable_type)
+        grouped_text.each do |type, translations|
+          puts "   - #{type}: #{translations.count}"
+          translations.first(3).each do |trans|
+            puts "     • ID #{trans.translatable_id} (#{trans.locale}): '#{trans.value}'"
+          end
+          puts "     ... and #{translations.count - 3} more" if translations.count > 3
+        end
+      end
+
+      puts "\n📄 String translations (target location):"
+      puts "   Total: #{all_string_translations.count}"
+
+      if all_string_translations.any?
+        grouped_string = all_string_translations.group_by(&:translatable_type)
+        grouped_string.each do |type, translations|
+          puts "   - #{type}: #{translations.count}"
+          translations.first(3).each do |trans|
+            puts "     • ID #{trans.translatable_id} (#{trans.locale}): '#{trans.value}'"
+          end
+          puts "     ... and #{translations.count - 3} more" if translations.count > 3
+        end
+      end
+
+      puts "\n" + ('=' * 80)
+      if all_text_translations.empty?
+        puts '✅ Migration appears complete - no name translations found in text_translations'
+      else
+        puts "⚠️  Migration needed - #{all_text_translations.count} name translations found in text_translations"
+        puts '   Run: rails translations:mobility:migrate_names_to_string'
+      end
+    end
+  end
+end
