deb-s3-lock-fix 0.11.8.fix7 → 0.11.8.fix9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64a940f929792ef7097c9833c41692f970f42aa1943020468147d9960ab88edb
-  data.tar.gz: 6ec72dd113fa7cfdaaf04223e7f85c23d4b2b0a4e61a7a7edf04ca34727cad78
+  metadata.gz: 7359269b0c261eb75e972418c5d5b52b9cba54982c538ed3cb33d5c809fe8822
+  data.tar.gz: e9fe79de351ab1c1fee248b166ae403a24f8eaa2981a47916f2d89a3b332547a
 SHA512:
-  metadata.gz: 531da15da212e104d6a3702cd522ce6c5e4b6718dc5d79773dc5ed409973b40913735dc42bb81a7b9407db07b84692ded0e8f16f59bc1967964438d314e551c3
-  data.tar.gz: ec1259ba39dae97af68702687459fa3b16629444724a785dcd17721fe5f6032d0ab296e000c70d6cad7a788463b8094c13201e9ca2ed401eed029f8c2bfee182
+  metadata.gz: 537086dbaf030c0227fc536326b863925080b18002cab7bb296730d2b65542bbf34ec0c9358d2d0f83dbf2fcf3f09c0a38d53075daa9991bf0372aef3f38d897
+  data.tar.gz: 25e69e5642d3a819484bbffaad0405d77ec4fdd88e62ea39d8cd9cd5ca0be73fdf510610ee8292de1999f8a474e778876203ea671f8f36133dc382d50f758896

data/README.md

@@ -1,8 +1,18 @@
-# deb-s3
+# deb-s3-lock-fix
 
 [![Build Status](https://travis-ci.org/deb-s3/deb-s3.svg?branch=master)](https://travis-ci.org/deb-s3/deb-s3)
 
-**This repository is a fork of [krobertson/deb-s3](https://github.com/krobertson/deb-s3).**
+**This repository is a fork of [deb-s3](https://github.com/deb-s3/deb-s3).**
+
+Note: The locking mechanism in the original deb-s3 library does not prevent race conditions.
+It relies on S3 for distributed locking, which will not work consistently due to S3's eventual
+consistency model. This fork uses DynamoDB for distributed locking, since it ensures atomic
+conditional put operations on the lock.
+
+To use this library create a DynamoDB table and export the following three env variables:
+`DEB_S3_ACCESS_KEY_ID`
+`DEB_S3_SECRET_ACCESS_KEY`
+`AWS_BUILDERS_REGION`
 
 `deb-s3` is a simple utility to make creating and managing APT repositories on
 S3.

data/lib/deb/s3/cli.rb

@@ -165,7 +165,7 @@ class Deb::S3::CLI < Thor
       if options[:lock]
         log("Checking for existing lock file")
         log("Locking repository for updates")
-        Deb::S3::Lock.lock(options[:codename])
+        Deb::S3::Lock.lock(options[:bucket], options[:codename])
         @lock_acquired = true
       end
 
@@ -257,7 +257,7 @@ class Deb::S3::CLI < Thor
       log("Update complete.")
     ensure
       if options[:lock] && @lock_acquired
-        Deb::S3::Lock.unlock(options[:codename])
+        Deb::S3::Lock.unlock(options[:bucket], options[:codename])
         log("Lock released.")
       end
     end
@@ -406,7 +406,7 @@ class Deb::S3::CLI < Thor
       if options[:lock]
         log("Checking for existing lock file")
         log("Locking repository for updates")
-        Deb::S3::Lock.lock(options[:codename])
+        Deb::S3::Lock.lock(options[:bucket], options[:codename])
         @lock_acquired = true
       end
 
@@ -448,7 +448,7 @@ class Deb::S3::CLI < Thor
       log "Copy complete."
     ensure
       if options[:lock] && @lock_acquired
-        Deb::S3::Lock.unlock(options[:codename])
+        Deb::S3::Lock.unlock(options[:bucket], options[:codename])
         log("Lock released.")
       end
     end
@@ -501,7 +501,7 @@ class Deb::S3::CLI < Thor
       if options[:lock]
         log("Checking for existing lock file")
         log("Locking repository for updates")
-        Deb::S3::Lock.lock(options[:codename])
+        Deb::S3::Lock.lock(options[:bucket], options[:codename])
         @lock_acquired = true
       end
 
@@ -549,7 +549,7 @@ class Deb::S3::CLI < Thor
       end
     ensure
       if options[:lock] && @lock_acquired
-        Deb::S3::Lock.unlock(options[:codename])
+        Deb::S3::Lock.unlock(options[:bucket], options[:codename])
         log("Lock released.")
       end
     end
@@ -615,7 +615,7 @@ class Deb::S3::CLI < Thor
       if options[:lock]
         log("Checking for existing lock file")
         log("Locking repository for updates")
-        Deb::S3::Lock.lock(options[:codename])
+        Deb::S3::Lock.lock(options[:bucket], options[:codename])
         @lock_acquired = true
       end
 
@@ -679,7 +679,7 @@ class Deb::S3::CLI < Thor
       end
     ensure
       if options[:lock] && @lock_acquired
-        Deb::S3::Lock.unlock(options[:codename])
+        Deb::S3::Lock.unlock(options[:bucket], options[:codename])
         log("Lock released.")
       end
     end

data/lib/deb/s3/lock.rb

@@ -16,8 +16,8 @@ class Deb::S3::Lock
     @dynamodb ||= begin
       validate_environment_variables!
       Aws::DynamoDB::Client.new(
-        access_key_id: ENV['DEB_S3_LOCK_ACCESS_KEY_ID'],
-        secret_access_key: ENV['DEB_S3_LOCK_SECRET_ACCESS_KEY'],
+        access_key_id: ENV['DEB_S3_ACCESS_KEY_ID'],
+        secret_access_key: ENV['DEB_S3_SECRET_ACCESS_KEY'],
         region: ENV['AWS_BUILDERS_REGION']
       )
     end
@@ -30,10 +30,10 @@ class Deb::S3::Lock
   end
 
   class << self
-    def lock(codename, max_attempts = 60, max_wait_interval = 10)
+    def lock(bucket, codename, max_attempts = 60, max_wait_interval = 10)
       uuid = SecureRandom.uuid
       lock_body = "#{Etc.getlogin}@#{Socket.gethostname}-#{uuid}"
-      lock_key = codename
+      lock_key = "#{bucket}/#{codename}"
 
       $stderr.puts("Current job's hostname with UUID: #{lock_body}")
 
@@ -51,7 +51,7 @@ class Deb::S3::Lock
           })
           return
         rescue Aws::DynamoDB::Errors::ConditionalCheckFailedException
-          lock_holder = current_lock_holder(codename)
+          lock_holder = current_lock_holder(bucket, codename)
           current_time = Time.now.strftime("%Y-%m-%d %H:%M:%S")
           $stderr.puts("[#{current_time}] Repository is locked by another user: #{lock_holder.user} at host #{lock_holder.host_with_uuid}")
           $stderr.puts("Attempting to obtain a lock after #{wait_interval} second(s).")
@@ -62,20 +62,20 @@ class Deb::S3::Lock
       raise "Unable to obtain a lock after #{max_attempts} attemtps, giving up."
     end
 
-    def unlock(codename)
+    def unlock(bucket, codename)
       dynamodb.delete_item({
         table_name: DYNAMODB_TABLE_NAME,
         key: {
-          'lock_key' => codename
+          'lock_key' => "#{bucket}/#{codename}"
         }
       })
     end
 
-    def current_lock_holder(codename)
+    def current_lock_holder(bucket, codename)
       response = dynamodb.get_item({
         table_name: DYNAMODB_TABLE_NAME,
         key: {
-          'lock_key' => codename
+          'lock_key' => "#{bucket}/#{codename}"
         }
       })
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deb-s3-lock-fix
 version: !ruby/object:Gem::Version
-  version: 0.11.8.fix7
+  version: 0.11.8.fix9
 platform: ruby
 authors:
 - Braeden Wolf & Ken Robertson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-09-15 00:00:00.000000000 Z
+date: 2023-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -80,9 +80,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '11'
-description: Fork of deb-s3 with a specific fix for locking. Original work by Ken
-  Robertson.
-email: braedenwolf@outlook.com & ken@invalidlogic.com
+description: Fork of deb-s3 with fix for locking. Original work by Ken Robertson.
+email: braeden.wolf@sanctuary.ai & ken@invalidlogic.com
 executables:
 - deb-s3
 extensions: []
@@ -99,7 +98,7 @@ files:
 - lib/deb/s3/templates/package.erb
 - lib/deb/s3/templates/release.erb
 - lib/deb/s3/utils.rb
-homepage: https://github.com/braedenwolf/deb-s3-lock-fix
+homepage: https://gitlab.com/sanctuaryai/precog2/infrastructure/deb-s3-lock-fix
 licenses:
 - MIT
 metadata: {}
@@ -121,5 +120,5 @@ requirements: []
 rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: Easily create and manage an APT repository on S3 (with specific lock fix).
+summary: Easily create and manage an APT repository on S3 with lock fix.
 test_files: []