Add ingestion attempt communication with PMPY

CHANGELOG.md

@@ -12,6 +12,8 @@ New entries in this file should aim to provide a meaningful amount of informatio
 ### Added
 - Push collections and communities to preservation on save along with a rake task to do so [#255](https://github.com/ualbertalib/pushmi_pullyu/issues/255)
 - Added minitest-retry gem to retry flapping tests that are able to pass through retries [#3044](https://github.com/ualbertalib/jupiter/pull/3044)
+- Add attempt count for entity ingestion on depositable model. Related to [pushmi_pullyu#297](https://github.com/ualbertalib/pushmi_pullyu/issues/297)
+
 ### Removed
 - Skylight performance monitoring.  Will need to remove this secret from ansible playbook secrets as well. [#3023](https://github.com/ualbertalib/jupiter/issues/3023)
 - Remove brakeman's ruby EOL check [PR#3051](https://github.com/ualbertalib/jupiter/pull/3051)

app/models/jupiter_core/depositable.rb

@@ -170,8 +170,11 @@ def push_entity_for_preservation
 
     $queue.with do |connection|
       # pushmi_pullyu requires both the id and type of the depositable
-      entity = { uuid: id, type: self.class.table_name }
-      connection.zadd queue_name, Time.now.to_f, entity.to_json
+      connection.zadd(queue_name, Time.now.to_f, { uuid: id, type: self.class.table_name }.to_json)
+      # Add the attempt count as value 0 that pmpy will use to count the tries to ingest the depositable. If the key
+      # already exists, the value will be reset to 0. the ```connection.zadd``` method called before resets the score as
+      # well. These two pieces of information let PMPY know that the entity needs to be deposited ASAP
+      connection.set("#{Rails.application.secrets.attempt_ingest_prefix}#{id}", 0)
     end
 
     true

config/secrets.yml

@@ -31,6 +31,8 @@ shared:
   google_analytics_token: <%= ENV['GOOGLE_ANALYTICS_TOKEN'] %>
   allow_crawlers: <%= ENV['RAILS_ALLOW_CRAWLERS'] || false %>
   preservation_queue_name: <%= ENV['PMPY_QUEUE_NAME'] || 'prod:pmpy_queue' %>
+  attempt_ingest_prefix: <%= ENV['ATTEMPT_INGEST_PREFIX'] || "'prod:pmpy_ingest_attempt:'" %>
+
   fits_path: <%= ENV['FITS_PATH'] || 'fits.sh' %>
   rack_attack_safelisted_ips: <%= ENV['RACK_ATTACK_SAFELISTED_IPS'] || '""' %>
   system_user_api_key: <%= ENV['SYSTEM_USER_API_KEY'] %>
@@ -62,7 +64,8 @@ development:
   fcrepo_password: fedoraAdmin
   fcrepo_base_path: /dev
 
-  preservation_queue_name: <%= ENV['PMPY_QUEUE_NAME']  || 'dev:pmpy_queue'%>
+  preservation_queue_name: <%= ENV['PMPY_QUEUE_NAME']  || 'dev:pmpy_queue' %>
+  attempt_ingest_prefix: <%= ENV['ATTEMPT_INGEST_PREFIX'] || "'dev:pmpy_ingest_attempt:'" %>
   system_user_api_key: <%= ENV['SYSTEM_USER_API_KEY'] || '3eeb395e-63b7-11ea-bc55-0242ac130003' %>
 
 test:
@@ -85,6 +88,7 @@ test:
   fcrepo_base_path: /test
 
   preservation_queue_name: <%= ENV['PMPY_QUEUE_NAME'] || 'test:pmpy_queue' %>
+  attempt_ingest_prefix: <%= ENV['ATTEMPT_INGEST_PREFIX'] || "'test:pmpy_ingest_attempt:'" %>
   system_user_api_key: <%= ENV['SYSTEM_USER_API_KEY'] || '3eeb395e-63b7-11ea-bc55-0242ac130003' %>
 
   google_client_id: 'test-google-client-id'