pushmi_pullyu 2.1.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da4560ad8303a06ea455d4da2915bd9be6a98edb70a8ee91bc12cb25d977f3b5
-  data.tar.gz: db98dc991f3149b0d217f6ae61f9c07c34ecc8ab7c878d4e60ecdbc08aed95bd
+  metadata.gz: b4380518d529c79ac7972e3ab29dee3524082df9e66a3f0f1e3eefbb5c08855d
+  data.tar.gz: c43b7f5a944ceb4fafa298ebbb7ec47725a8bbff04a8b04ea51874b6bacc2ba6
 SHA512:
-  metadata.gz: 5d565b6ecf4fcd0cab2690f04aaf619dc70d83848a8fc48960de393fac94b83ff18f9751528dbbb184c4f411d270113ec90c807146c8c14e35010c8a40434734
-  data.tar.gz: 478f4047534baaf2931733f0f48d199dd51088262e0076f5b52ad1f63f74fb5fee6dc5265ec8c8b5064f8b87d1ecaebf94513a5d9ecf299c3455df4526fbc9cb
+  metadata.gz: 0c7e9b00f0e8a6727393da41e9060dff06a6b8aba0baf9f7ed84bbc89e17e0988e1858a8c0bd925983ccda379e249374af0c738be976ec21708a3cf6be35b20e
+  data.tar.gz: 6ed33393e60e371ea74b9eba143ff3ce3f6ddac81954ddf944d68f3d75087f2adc777ac4f8a8db4037c20131201ec0f1325a90d465b3cd06be6fa04a878a728d

data/CHANGELOG.md

@@ -6,6 +6,9 @@ PushmiPullyu is a Ruby application, whose primary job is to manage the flow of c
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and releases in PushmiPullyu adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [2.1.1]
+ - Increase clarity of log files [#433](https://github.com/ualbertalib/pushmi_pullyu/issues/433)
+
 ## [2.1.0]
  - Add more logging information [#433](https://github.com/ualbertalib/pushmi_pullyu/issues/433)
  - Add V3 authentication [#349](https://github.com/ualbertalib/pushmi_pullyu/issues/349)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pushmi_pullyu (2.1.0)
+    pushmi_pullyu (2.1.1)
       activesupport (>= 5, < 8)
       bagit (~> 0.4)
       connection_pool (~> 2.2)

data/lib/pushmi_pullyu/cli.rb

@@ -214,7 +214,7 @@ class PushmiPullyu::CLI
         # Push tarred AIP to swift API
         deposited_file = swift.deposit_file(aip_filename, options[:swift][:container])
         # Log successful preservation event to the log files
-        PushmiPullyu::Logging.log_preservation_success(deposited_file, aip_directory)
+        PushmiPullyu::Logging.log_preservation_success(entity, deposited_file, aip_directory)
       end
     # An EntityInvalid expection means there is a problem with the entity information format so there is no point in
     # readding it to the queue as it will always fail

data/lib/pushmi_pullyu/logging.rb

@@ -52,7 +52,7 @@ module PushmiPullyu::Logging
       @preservation_json_logger.info("#{message_json},")
     end
 
-    def log_preservation_success(deposited_file, aip_directory)
+    def log_preservation_success(entity, deposited_file, aip_directory)
       message = "#{deposited_file.name} was successfully deposited into Swift Storage!\n" \
                 "Here are the details of this preservation event:\n" \
                 "\tUUID: '#{deposited_file.name}'\n" \
@@ -74,14 +74,24 @@ module PushmiPullyu::Logging
         end
       end
 
-      log_preservation_event(message, preservation_success_to_json(deposited_file, aip_directory))
+      message_information = {
+        event_type: :success,
+        event_time: Time.now.to_s,
+        entity_type: entity[:type],
+        entity_uuid: entity[:uuid],
+        event_details: preservation_success_to_json(deposited_file, aip_directory)
+      }
+
+      log_preservation_event(message, message_information.to_json)
     end
 
-    def log_preservation_fail_and_retry(entity, retry_attempt, exception)
+    def log_preservation_fail_and_retry(entity, try_attempt, exception)
+      # We add + 1 to try_attempt because humans like to start counting from 1
+      try_attempt += 1
       message = "#{entity[:type]} failed to be deposited and will try again.\n" \
                 "Here are the details of this preservation event:\n" \
                 "\t#{entity[:type]} uuid: #{entity[:uuid]}" \
-                "\tReadding to preservation queue with retry attempt: #{retry_attempt}\n" \
+                "\tReadding to preservation queue with try attempt: #{try_attempt}\n" \
                 "\tError of type: #{exception.class.name}\n" \
                 "\tError message: #{exception.message}\n"
 
@@ -90,43 +100,47 @@ module PushmiPullyu::Logging
         event_time: Time.now.to_s,
         entity_type: entity[:type],
         entity_uuid: entity[:uuid],
-        retry_attempt: retry_attempt,
+        try_attempt: try_attempt,
         error_message: exception.message
       }
 
       log_preservation_event(message, message_information.to_json)
     end
 
-    def log_preservation_failure(entity, retry_attempt, exception)
+    def log_preservation_failure(entity, try_attempt, exception)
+      # We add + 1 to try_attempt because humans like to start counting from 1
+      try_attempt += 1
       message = "#{entity[:type]} failed to be deposited.\n" \
                 "Here are the details of this preservation event:\n" \
                 "\t#{entity[:type]} uuid: #{entity[:uuid]}" \
-                "\tRetry attempt: #{retry_attempt}\n"
+                "\tTry attempt: #{try_attempt}\n"
 
       message_information = {
-        event_type: :fail_and_retry,
+        event_type: :failure,
         event_time: Time.now.to_s,
         entity_type: entity[:type],
         entity_uuid: entity[:uuid],
-        retry_attempt: retry_attempt,
+        try_attempt: try_attempt,
         error_message: exception.message
       }
 
       log_preservation_event(message, message_information.to_json)
     end
 
-    def log_preservation_attempt(entity, retry_attempt)
+    def log_preservation_attempt(entity, try_attempt)
+      # We add + 1 to try_attempt because humans like to start counting from 1
+      try_attempt += 1
       message = "#{entity[:type]} will attempt to be deposited.\n" \
                 "Here are the details of this preservation event:\n" \
                 "\t#{entity[:type]} uuid: #{entity[:uuid]}" \
-                "\tRetry attempt: #{retry_attempt}\n"
+                "\tTry attempt: #{try_attempt}\n"
 
       message_information = {
         event_type: :attempt,
         event_time: Time.now.to_s,
         entity_type: entity[:type],
         entity_uuid: entity[:uuid],
-        retry_attempt: retry_attempt
+        try_attempt: try_attempt
       }
 
       log_preservation_event(message, message_information.to_json)
@@ -184,7 +198,7 @@ module PushmiPullyu::Logging
       end
 
       message['aip_file_details'] = tmp_details
-      message.to_json
+      message
     end
 
     def reopen

data/lib/pushmi_pullyu/preservation_queue.rb

@@ -73,7 +73,7 @@ class PushmiPullyu::PreservationQueue
   def get_entity_ingestion_attempt(entity)
     entity_attempts_key = "#{PushmiPullyu.options[:ingestion_prefix]}#{entity[:uuid]}"
     @redis.with do |connection|
-      return connection.get entity_attempts_key
+      return connection.get(entity_attempts_key).to_i
     end
   end
 

data/lib/pushmi_pullyu/version.rb

@@ -1,3 +1,3 @@
 module PushmiPullyu
-  VERSION = '2.1.0'.freeze
+  VERSION = '2.1.1'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pushmi_pullyu
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.1.1
 platform: ruby
 authors:
 - Shane Murnaghan
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-05-27 00:00:00.000000000 Z
+date: 2024-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -294,7 +294,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Ruby application to manage flow of content from Jupiter into Swift for preservation