Merge pull request #22330 from samphilipd/samphilipd/rename_advisory_lock_key

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

4 files changed, 18 insertions, 18 deletions

diff --git a/activerecord/lib/active_record/connection_adapters/abstract_adapter.rb b/activerecord/lib/active_record/connection_adapters/abstract_adapter.rb
index 55910865e5..4d4dc07b04 100644
--- a/activerecord/lib/active_record/connection_adapters/abstract_adapter.rb
+++ b/activerecord/lib/active_record/connection_adapters/abstract_adapter.rb
@@ -289,14 +289,14 @@ module ActiveRecord
       # locks
       #
       # Return true if we got the lock, otherwise false
-      def get_advisory_lock(key) # :nodoc:
+      def get_advisory_lock(lock_id) # :nodoc:
       end
 
       # This is meant to be implemented by the adapters that support advisory
       # locks.
       #
       # Return true if we released the lock, otherwise false
-      def release_advisory_lock(key) # :nodoc:
+      def release_advisory_lock(lock_id) # :nodoc:
       end
 
       # A list of extensions, to be filled in by adapters that support them.
diff --git a/activerecord/lib/active_record/connection_adapters/abstract_mysql_adapter.rb b/activerecord/lib/active_record/connection_adapters/abstract_mysql_adapter.rb
index c75c9ab3b5..deef246c37 100644
--- a/activerecord/lib/active_record/connection_adapters/abstract_mysql_adapter.rb
+++ b/activerecord/lib/active_record/connection_adapters/abstract_mysql_adapter.rb
@@ -224,12 +224,12 @@ module ActiveRecord
         version >= '5.0.0'
       end
 
-      def get_advisory_lock(key, timeout = 0) # :nodoc:
-        select_value("SELECT GET_LOCK('#{key}', #{timeout});").to_s == '1'
+      def get_advisory_lock(lock_name, timeout = 0) # :nodoc:
+        select_value("SELECT GET_LOCK('#{lock_name}', #{timeout});").to_s == '1'
       end
 
-      def release_advisory_lock(key) # :nodoc:
-        select_value("SELECT RELEASE_LOCK('#{key}')").to_s == '1'
+      def release_advisory_lock(lock_name) # :nodoc:
+        select_value("SELECT RELEASE_LOCK('#{lock_name}')").to_s == '1'
       end
 
       def native_database_types
diff --git a/activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb b/activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb
index 3eefab8f44..719592349b 100644
--- a/activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb
+++ b/activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb
@@ -304,18 +304,18 @@ module ActiveRecord
         postgresql_version >= 90300
       end
 
-      def get_advisory_lock(key) # :nodoc:
-        unless key.is_a?(Integer) && key.bit_length <= 63
-          raise(ArgumentError, "Postgres requires advisory lock keys to be a signed 64 bit integer")
+      def get_advisory_lock(lock_id) # :nodoc:
+        unless lock_id.is_a?(Integer) && lock_id.bit_length <= 63
+          raise(ArgumentError, "Postgres requires advisory lock ids to be a signed 64 bit integer")
         end
-        select_value("SELECT pg_try_advisory_lock(#{key});")
+        select_value("SELECT pg_try_advisory_lock(#{lock_id});")
       end
 
-      def release_advisory_lock(key) # :nodoc:
-        unless key.is_a?(Integer) && key.bit_length <= 63
-          raise(ArgumentError, "Postgres requires advisory lock keys to be a signed 64 bit integer")
+      def release_advisory_lock(lock_id) # :nodoc:
+        unless lock_id.is_a?(Integer) && lock_id.bit_length <= 63
+          raise(ArgumentError, "Postgres requires advisory lock ids to be a signed 64 bit integer")
         end
-        select_value("SELECT pg_advisory_unlock(#{key})")
+        select_value("SELECT pg_advisory_unlock(#{lock_id})")
       end
 
       def enable_extension(name)
diff --git a/activerecord/lib/active_record/migration.rb b/activerecord/lib/active_record/migration.rb
index ffd243a517..ca2537cdc3 100644
--- a/activerecord/lib/active_record/migration.rb
+++ b/activerecord/lib/active_record/migration.rb
@@ -1202,17 +1202,17 @@ module ActiveRecord
     end
 
     def with_advisory_lock
-      key = generate_migrator_advisory_lock_key
-      got_lock = Base.connection.get_advisory_lock(key)
+      lock_id = generate_migrator_advisory_lock_id
+      got_lock = Base.connection.get_advisory_lock(lock_id)
       raise ConcurrentMigrationError unless got_lock
       load_migrated # reload schema_migrations to be sure it wasn't changed by another process before we got the lock
       yield
     ensure
-      Base.connection.release_advisory_lock(key) if got_lock
+      Base.connection.release_advisory_lock(lock_id) if got_lock
     end
 
     MIGRATOR_SALT = 2053462845
-    def generate_migrator_advisory_lock_key
+    def generate_migrator_advisory_lock_id
       db_name_hash = Zlib.crc32(Base.connection.current_database)
       MIGRATOR_SALT * db_name_hash
     end