Rename 'key' to 'lock_id' or 'lock_name' for advisory locking

- key was a poor choice of name. A key implies something that will
  unlock a lock. The concept is actually more like a 'lock identifier'
- mysql documentation calls this a 'lock name'
- postgres documentation calls it a 'lock_id'
- Updated variable names to reflect the preferred terminology for the database in
  question

1 files changed, 19 insertions, 19 deletions

diff --git a/activerecord/test/cases/migration_test.rb b/activerecord/test/cases/migration_test.rb
index 15a0e0516d..c3c204cf9f 100644
--- a/activerecord/test/cases/migration_test.rb
+++ b/activerecord/test/cases/migration_test.rb
@@ -524,33 +524,33 @@ class MigrationTest < ActiveRecord::TestCase
   end
 
   if ActiveRecord::Base.connection.supports_advisory_locks?
-    def test_migrator_generates_valid_lock_key
+    def test_migrator_generates_valid_lock_id
       migration = Class.new(ActiveRecord::Migration).new
       migrator = ActiveRecord::Migrator.new(:up, [migration], 100)
 
-      lock_key = migrator.send(:generate_migrator_advisory_lock_key)
+      lock_id = migrator.send(:generate_migrator_advisory_lock_id)
 
-      assert ActiveRecord::Base.connection.get_advisory_lock(lock_key),
-        "the Migrator should have generated a valid lock key, but it didn't"
-      assert ActiveRecord::Base.connection.release_advisory_lock(lock_key),
-        "the Migrator should have generated a valid lock key, but it didn't"
+      assert ActiveRecord::Base.connection.get_advisory_lock(lock_id),
+        "the Migrator should have generated a valid lock id, but it didn't"
+      assert ActiveRecord::Base.connection.release_advisory_lock(lock_id),
+        "the Migrator should have generated a valid lock id, but it didn't"
     end
 
-    def test_generate_migrator_advisory_lock_key
+    def test_generate_migrator_advisory_lock_id
       # It is important we are consistent with how we generate this so that
       # exclusive locking works across migrator versions
       migration = Class.new(ActiveRecord::Migration).new
       migrator = ActiveRecord::Migrator.new(:up, [migration], 100)
 
-      lock_key = migrator.send(:generate_migrator_advisory_lock_key)
+      lock_id = migrator.send(:generate_migrator_advisory_lock_id)
 
       current_database = ActiveRecord::Base.connection.current_database
       salt = ActiveRecord::Migrator::MIGRATOR_SALT
-      expected_key = Zlib.crc32(current_database) * salt
+      expected_id = Zlib.crc32(current_database) * salt
 
-      assert lock_key == expected_key, "expected lock key generated by the migrator to be #{expected_key}, but it was #{lock_key} instead"
-      assert lock_key.is_a?(Fixnum), "expected lock key to be a Fixnum, but it wasn't"
-      assert lock_key.bit_length <= 63, "lock key must be a signed integer of max 63 bits magnitude"
+      assert lock_id == expected_id, "expected lock id generated by the migrator to be #{expected_id}, but it was #{lock_id} instead"
+      assert lock_id.is_a?(Fixnum), "expected lock id to be a Fixnum, but it wasn't"
+      assert lock_id.bit_length <= 63, "lock id must be a signed integer of max 63 bits magnitude"
     end
 
     def test_migrator_one_up_with_unavailable_lock
@@ -564,9 +564,9 @@ class MigrationTest < ActiveRecord::TestCase
       }.new
 
       migrator = ActiveRecord::Migrator.new(:up, [migration], 100)
-      lock_key = migrator.send(:generate_migrator_advisory_lock_key)
+      lock_id = migrator.send(:generate_migrator_advisory_lock_id)
 
-      with_another_process_holding_lock(lock_key) do
+      with_another_process_holding_lock(lock_id) do
         assert_raise(ActiveRecord::ConcurrentMigrationError) { migrator.migrate }
       end
 
@@ -585,9 +585,9 @@ class MigrationTest < ActiveRecord::TestCase
       }.new
 
       migrator = ActiveRecord::Migrator.new(:up, [migration], 100)
-      lock_key = migrator.send(:generate_migrator_advisory_lock_key)
+      lock_id = migrator.send(:generate_migrator_advisory_lock_id)
 
-      with_another_process_holding_lock(lock_key) do
+      with_another_process_holding_lock(lock_id) do
         assert_raise(ActiveRecord::ConcurrentMigrationError) { migrator.run }
       end
 
@@ -606,18 +606,18 @@ class MigrationTest < ActiveRecord::TestCase
       }
     end
 
-    def with_another_process_holding_lock(lock_key)
+    def with_another_process_holding_lock(lock_id)
       thread_lock = Concurrent::CountDownLatch.new
       test_terminated = Concurrent::CountDownLatch.new
 
       other_process = Thread.new do
         begin
           conn = ActiveRecord::Base.connection_pool.checkout
-          conn.get_advisory_lock(lock_key)
+          conn.get_advisory_lock(lock_id)
           thread_lock.count_down
           test_terminated.wait # hold the lock open until we tested everything
         ensure
-          conn.release_advisory_lock(lock_key)
+          conn.release_advisory_lock(lock_id)
           ActiveRecord::Base.connection_pool.checkin(conn)
         end
       end