hyrax 4.0.0.rc2 → 4.0.0.rc3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 24e7e9d00de4eebd2f2dfaf96bcd1a09ac9589b17e94ddcc0bf5681d3c93b0c4
-  data.tar.gz: 92753b2fbb1271cfec93e2eddd07d11da1091eaf8b36494e754ac3400a83a6a1
+  metadata.gz: f7d9595ce45877e35b01b14d36cdefb89a1bb8978ab424bbe9907edcfebb693e
+  data.tar.gz: 516c7de64fc06ede1b8bd0843ad4ad98b01d39f7440c4723e72235880d52d34a
 SHA512:
-  metadata.gz: 16a328b5b11d826f8149f0b260675ffe913d7e41a4b5c37035696cb32741b650a9f4bf9fa0d70ed08a1be712ddc8b452824bfb5be60a99b1a9d52ead57d8b7f3
-  data.tar.gz: bff8a0b37d073e1014f9566472030bb2b22e16a19fc1413dec6405cf21d6c3f178b0644ecbb48ee8ed0d259fe4f1b0422e747a5f3192c63753dc76d89ba8cb33
+  metadata.gz: 7a4173fac3ac9ee096966e8019d7bbb00e80715b1a7672fd830920229b6236cd31b63c3099992137d107f47ef4a863db2137607c8f86f094bcd981e90443ac38
+  data.tar.gz: 8fe124964ed3356cbb93bf5db4d1d491d8927020dce6226c0046a8068504ea21b427b99a25fd48b81b7b36ebc1702a23479ce4fe89189d4851551d5e703aa8c2

data/.dassie/config/initializers/redis_config.rb

@@ -1,4 +1,11 @@
 # frozen_string_literal: true
 require 'redis'
+require 'connection_pool'
 config = YAML.safe_load(ERB.new(IO.read(Rails.root.join('config', 'redis.yml'))).result)[Rails.env].with_indifferent_access
-Redis.current = Redis.new(config.merge(thread_safe: true))
+config[:thread_safe] = true
+
+size = ENV.fetch("HYRAX_REDIS_POOL_SIZE", 5)
+timeout = ENV.fetch("HYRAX_REDIS_TIMEOUT", 5)
+
+Hyrax.config.redis_connection =
+  ConnectionPool::Wrapper.new(size: size, timeout: timeout) { Redis.new(config) }

data/.koppie/config/initializers/redis_config.rb

@@ -1,4 +1,11 @@
 # frozen_string_literal: true
 require 'redis'
+require 'connection_pool'
 config = YAML.safe_load(ERB.new(IO.read(Rails.root.join('config', 'redis.yml'))).result)[Rails.env].with_indifferent_access
-Redis.current = Redis.new(config.merge(thread_safe: true))
+config[:thread_safe] = true
+
+size = ENV.fetch("HYRAX_REDIS_POOL_SIZE", 5)
+timeout = ENV.fetch("HYRAX_REDIS_TIMEOUT", 5)
+
+Hyrax.config.redis_connection =
+  ConnectionPool::Wrapper.new(size: size, timeout: timeout) { Redis.new(config) }

data/.regen

@@ -1,2 +1,2 @@
 # When updating CI regen seed, set to current date.
-2023-04-11T16:25:55
+2023-05-15T10:04:07

data/CONTAINERS.md

@@ -191,7 +191,7 @@ We publish several Hyrax images to the [GitHub container registry][ghcr] under
 the [Samvera organization][samvera-packages].  To build them:
 
 ```sh
-export HYRAX_VERSION=v4.0.0.rc2 # or desired version
+export HYRAX_VERSION=v4.0.0.rc3 # or desired version
 git checkout hyrax-$HYRAX_VERSION
 
 docker build --target hyrax-base --tag ghcr.io/samvera/hyrax/hyrax-base:$(git rev-parse HEAD) .

data/README.md

@@ -42,7 +42,7 @@ Hyrax offers the ability to:
 
 More detailed documentation about Hyrax is available on the [Hyrax Github Wiki](https://github.com/samvera/hyrax/wiki) but if you have questions or need help, please email the [Samvera community tech list](https://samvera.atlassian.net/wiki/spaces/samvera/pages/1171226735/Samvera+Community+Email+Lists#Samvera-Tech-(15-20-messages-per-week-on-average)) or stop by the #dev channel in the [Samvera community Slack team](https://samvera.atlassian.net/wiki/spaces/samvera/pages/405211682/Getting+Started+in+the+Samvera+Community#Join-the-Samvera-Slack-workspace). You can also get in touch with the [Hyrax Maintenance Working Group](https://samvera.atlassian.net/wiki/spaces/samvera/pages/496632295/Hyrax+Maintenance+Working+Group), including the Hyrax Product Owner and Hyrax Tech Lead.
 
-[Reporting Issues](./.github/SUPPORT.md) 
+[Reporting Issues](./.github/SUPPORT.md)
 
 ## How to Run the Code
 
@@ -79,4 +79,4 @@ This software has been developed by and is brought to you by the Samvera communi
 
 ## License
 
-Hyrax is available under [the Apache 2.0 license](LICENSE).
+Hyrax is available under [the Apache 2.0 license](LICENSE).

data/app/builders/hyrax/bootstrap_breadcrumbs_builder.rb

@@ -12,7 +12,7 @@ class Hyrax::BootstrapBreadcrumbsBuilder < BreadcrumbsOnRails::Breadcrumbs::Buil
   def render
     return "" if @elements.blank?
 
-    @context.tag.nav(breadcrumbs_options) do
+    @context.tag.nav(**breadcrumbs_options) do
       @context.tag.ol do
         safe_join(@elements.uniq.collect { |e| render_element(e) })
       end

data/app/services/hyrax/custom_queries/navigators/find_files.rb

@@ -80,10 +80,7 @@ module Hyrax
           files =
             query_service.custom_queries.find_many_file_metadata_by_use(resource: file_set, use: use)
 
-          raise Valkyrie::Persistence::ObjectNotFoundError, "FileSet #{file_set.id}'s #{use.fragment} is missing." if
-            files.empty?
-
-          files.first
+          files.first || raise(Valkyrie::Persistence::ObjectNotFoundError, "FileSet #{file_set.id}'s #{use.fragment} is missing.")
         end
       end
     end

data/app/services/hyrax/lock_manager.rb

@@ -4,24 +4,54 @@ module Hyrax
   class LockManager
     class UnableToAcquireLockError < StandardError; end
 
-    attr_reader :client
-
+    ##
     # @param [Fixnum] time_to_live How long to hold the lock in milliseconds
     # @param [Fixnum] retry_count How many times to retry to acquire the lock before raising UnableToAcquireLockError
     # @param [Fixnum] retry_delay Maximum wait time in milliseconds before retrying. Wait time is a random value between 0 and retry_delay.
     def initialize(time_to_live, retry_count, retry_delay)
       @ttl = time_to_live
-      @client = Redlock::Client.new([Redis.current], retry_count: retry_count, retry_delay: retry_delay)
+      @retry_count = retry_count
+      @retry_delay = retry_delay
     end
 
+    ##
     # Blocks until lock is acquired or timeout.
     def lock(key)
       returned_from_block = nil
-      client.lock(key, @ttl) do |locked|
-        raise UnableToAcquireLockError unless locked
-        returned_from_block = yield
+
+      pool.then do |conn|
+        client(conn).lock(key, @ttl) do |locked|
+          raise UnableToAcquireLockError unless locked
+          returned_from_block = yield
+        end
       end
+
       returned_from_block
+    rescue ConnectionPool::TimeoutError => err
+      Hyrax.logger.error(err.message)
+      raise(ConnectionPool::TimeoutError,
+            "Failed to aquire a lock from Redlock due to a Redis connection " /
+            "timeout: #{err}. If you are using Redis via `ConnectionPool` " /
+            "you may wish to increase the pool size.")
+    end
+
+    private
+
+    ##
+    # @api_private
+    def client(conn)
+      Redlock::Client.new([conn], retry_count: @retry_count, retry_delay: @retry_delay)
+    end
+
+    ##
+    # @api private
+    #
+    # @note support both a ConnectionPool and a raw Redis client for now.
+    #   we should drop support for `Redis.current` in 5.0.0.
+    #   `#then` supports both options. for a ConnectionPool it will block
+    #   until a connection is available.
+    def pool
+      Hyrax.config.redis_connection || Redis.current
     end
   end
 end

data/app/views/layouts/hyrax/dashboard.html.erb

@@ -16,7 +16,7 @@
         <%= render 'hyrax/dashboard/sidebar' %>
       </div>
       <div class="main-content maximized<%= " admin-stats" if request.fullpath.include? '/admin/stats' %>">
-        <%= render_breadcrumbs builder: Hyrax::BootstrapBreadcrumbsBuilder %>
+        <%= render_breadcrumbs builder: Hyrax.config.breadcrumb_builder %>
         <%= render '/flash_msg' %>
         <% if content_for?(:page_header) %>
           <div class="row">

data/app/views/layouts/hyrax.html.erb

@@ -15,7 +15,7 @@
     <div id="content-wrapper" class="container" role="main">
       <%= content_for(:container_header) %>
       <%= render '/flash_msg' %>
-      <%= render_breadcrumbs builder: Hyrax::BootstrapBreadcrumbsBuilder %>
+      <%= render_breadcrumbs builder: Hyrax.config.breadcrumb_builder %>
       <% if content_for?(:page_header) %>
         <div class="row">
           <div class="col-12 main-header">

data/docker-compose-koppie.yml

@@ -104,7 +104,6 @@ services:
 
   postgres:
     image: postgres:latest
-    restart: always
     env_file:
       - .koppie/.env
     ports:

data/docker-compose.yml

@@ -99,7 +99,6 @@ services:
 
   postgres:
     image: postgres:latest
-    restart: always
     environment:
       - POSTGRES_USER=hyrax_user
       - POSTGRES_PASSWORD=hyrax_password

data/documentation/legacyREADME.md

@@ -50,7 +50,7 @@ The Samvera community is here to help. Please see our [support guide](../.github
 # Getting started
 
 This document contains instructions specific to setting up an app with __Hyrax
-v4.0.0.rc2__. If you are looking for instructions on installing a different
+v4.0.0.rc3__. If you are looking for instructions on installing a different
 version, be sure to select the appropriate branch or tag from the drop-down
 menu above.
 
@@ -159,7 +159,7 @@ NOTE: The steps need to be done in order to create a new Hyrax based app.
 Generate a new Rails application using the template.
 
 ```
-rails _6.1.7.3_ new my_app -m https://raw.githubusercontent.com/samvera/hyrax/hyrax-v4.0.0.rc2/template.rb
+rails _6.1.7.3_ new my_app -m https://raw.githubusercontent.com/samvera/hyrax/hyrax-v4.0.0.rc3/template.rb
 ```
 
 Generating a new Rails application using Hyrax's template above takes cares of a number of steps for you, including:

data/hyrax.gemspec

@@ -41,6 +41,7 @@ SUMMARY
   spec.add_dependency 'browse-everything', '>= 0.16', '< 2.0'
   spec.add_dependency 'carrierwave', '~> 1.0'
   spec.add_dependency 'clipboard-rails', '~> 1.5'
+  spec.add_dependency 'connection_pool', '~> 2.4'
   spec.add_dependency 'draper', '~> 4.0'
   spec.add_dependency 'dry-events', '~> 0.2.0'
   spec.add_dependency 'dry-equalizer', '~> 0.2'

data/lib/generators/hyrax/templates/config/initializers/redis_config.rb

@@ -1,4 +1,11 @@
 # frozen_string_literal: true
 require 'redis'
+require 'connection_pool'
 config = YAML.safe_load(ERB.new(IO.read(Rails.root.join('config', 'redis.yml'))).result)[Rails.env].with_indifferent_access
-Redis.current = Redis.new(config.merge(thread_safe: true))
+config[:thread_safe] = true
+
+size = ENV.fetch("HYRAX_REDIS_POOL_SIZE", 5)
+timeout = ENV.fetch("HYRAX_REDIS_TIMEOUT", 5)
+
+Hyrax.config.redis_connection =
+  ConnectionPool::Wrapper.new(size: size, timeout: timeout) { Redis.new(config) }

data/lib/hyrax/configuration.rb

@@ -393,6 +393,11 @@ module Hyrax
       @banner_image ||= 'https://user-images.githubusercontent.com/101482/29949206-ffa60d2c-8e67-11e7-988d-4910b8787d56.jpg'
     end
 
+    attr_writer :breadcrumb_builder
+    def breadcrumb_builder
+      @breadcrumb_builder ||= Hyrax::BootstrapBreadcrumbsBuilder
+    end
+
     ##
     # @return [Boolean]
     def disable_wings
@@ -611,9 +616,10 @@ module Hyrax
       @persistent_hostpath ||= "http://localhost/files/"
     end
 
+    attr_accessor :redis_connection
     attr_writer :redis_namespace
     def redis_namespace
-      @redis_namespace ||= "hyrax"
+      @redis_namespace ||= ENV.fetch("HYRAX_REDIS_NAMESPACE", "hyrax")
     end
 
     attr_writer :libreoffice_path

data/lib/hyrax/redis_event_store.rb

@@ -7,9 +7,11 @@ module Hyrax
     class << self
       # @return [Fixnum, nil] the id of the event, or `nil` on failure(?!)
       def create(action, timestamp)
-        event_id = instance.incr("events:latest_id")
-        instance.hmset("events:#{event_id}", "action", action, "timestamp", timestamp)
-        event_id
+        instance.then do |redis|
+          event_id = redis.incr("events:latest_id")
+          redis.hmset("events:#{event_id}", "action", action, "timestamp", timestamp)
+          event_id
+        end
       rescue Redis::CommandError => e
         logger.error("unable to create event: #{e}")
         nil
@@ -23,12 +25,16 @@ module Hyrax
       #
       # @return [Redis]
       def instance
-        if Redis.current.is_a? Redis::Namespace
-          Redis.current.namespace = namespace
+        connection = Hyrax.config.redis_connection || Redis.current
+
+        if connection.is_a? Redis::Namespace
+          connection.namespace = namespace
+          connection
+        elsif connection == Redis.current
+          Redis.current = Redis::Namespace.new(namespace, redis: connection)
         else
-          Redis.current = Redis::Namespace.new(namespace, redis: Redis.current)
+          connection
         end
-        Redis.current
       end
 
       ##
@@ -44,11 +50,13 @@ module Hyrax
     #
     # @return [Enumerable<Hash<Symbol, String>>]
     def fetch(size)
-      RedisEventStore.instance.lrange(@key, 0, size).map do |event_id|
-        {
-          action: RedisEventStore.instance.hget("events:#{event_id}", "action"),
-          timestamp: RedisEventStore.instance.hget("events:#{event_id}", "timestamp")
-        }
+      Hyrax::RedisEventStore.instance.then do |redis|
+        redis.lrange(@key, 0, size).map do |event_id|
+          {
+            action: redis.hget("events:#{event_id}", "action"),
+            timestamp: redis.hget("events:#{event_id}", "timestamp")
+          }
+        end
       end
     rescue Redis::CommandError, Redis::CannotConnectError
       RedisEventStore.logger.error("unable to fetch event: #{@key}")
@@ -62,7 +70,7 @@ module Hyrax
     #
     # @return [Integer, nil] the value successfully pushed; or `nil` on failure(!?)
     def push(value)
-      RedisEventStore.instance.lpush(@key, value)
+      Hyrax::RedisEventStore.instance.then { |r| r.lpush(@key, value) }
     rescue Redis::CommandError, Redis::CannotConnectError
       RedisEventStore.logger.error("unable to push event: #{@key}")
       nil

data/lib/hyrax/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Hyrax
-  VERSION = '4.0.0.rc2'
+  VERSION = '4.0.0.rc3'
 end

data/template.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 # Hack for https://github.com/rails/rails/issues/35153
 gsub_file 'Gemfile', /^gem ["']sqlite3["']$/, 'gem "sqlite3", "~> 1.3.0"'
-gem 'hyrax', '4.0.0.rc2'
+gem 'hyrax', '4.0.0.rc3'
 run 'bundle install'
 generate 'hyrax:install', '-f'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hyrax
 version: !ruby/object:Gem::Version
-  version: 4.0.0.rc2
+  version: 4.0.0.rc3
 platform: ruby
 authors:
 - Justin Coyne
@@ -14,7 +14,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-01 00:00:00.000000000 Z
+date: 2023-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -162,6 +162,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: connection_pool
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
 - !ruby/object:Gem::Dependency
   name: draper
   requirement: !ruby/object:Gem::Requirement