hyrax 5.1.0 → 5.2.0

data/lib/hyrax/configuration.rb

@@ -133,8 +133,23 @@ module Hyrax
     attr_writer :analytics_reporting
     attr_reader :analytics_reporting
     def analytics_reporting?
-      @analytics_reporting ||=
+      @analytics_reporting ||= begin
+        required_env_vars = %w[
+          HYRAX_ANALYTICS_REPORTING
+          GOOGLE_ANALYTICS_ID
+          GOOGLE_ANALYTICS_PROPERTY_ID
+        ]
+
+        required_env_vars << if ENV['GOOGLE_ACCOUNT_JSON'].blank?
+                               'GOOGLE_ACCOUNT_JSON_PATH'
+                             else
+                               'GOOGLE_ACCOUNT_JSON'
+                             end
+
+        return false if required_env_vars.any? { |var| ENV.fetch(var, '').blank? }
+
         ActiveModel::Type::Boolean.new.cast(ENV.fetch('HYRAX_ANALYTICS_REPORTING', false))
+      end
     end
 
     # Currently supports 'google' or 'matomo'
@@ -142,7 +157,7 @@ module Hyrax
     attr_writer :analytics_provider
     def analytics_provider
       @analytics_provider ||=
-        ENV.fetch('HYRAX_ANALYTICS_PROVIDER', 'google')
+        ENV.fetch('HYRAX_ANALYTICS_PROVIDER', 'ga4')
     end
 
     ##
@@ -478,31 +493,31 @@ module Hyrax
     # Path on the local file system where derivatives will be stored
     attr_writer :derivatives_path
     def derivatives_path
-      @derivatives_path ||= ENV.fetch('HYRAX_DERIVATIVES_PATH', Rails.root.join('tmp', 'derivatives'))
+      @derivatives_path ||= Pathname.new(ENV.fetch('HYRAX_DERIVATIVES_PATH', Rails.root.join('tmp', 'derivatives')))
     end
 
     # Path on the local file system where originals will be staged before being ingested into Fedora.
     attr_writer :working_path
     def working_path
-      @working_path ||= ENV.fetch('HYRAX_UPLOAD_PATH', Rails.root.join('tmp', 'uploads'))
+      @working_path ||= Pathname.new(ENV.fetch('HYRAX_UPLOAD_PATH', Rails.root.join('tmp', 'uploads')))
     end
 
     # @todo do we use both upload_path and working path?
     # Path on the local file system where originals will be staged before being ingested into Fedora.
     attr_writer :upload_path
     def upload_path
-      @upload_path ||= ->() { ENV.fetch('HYRAX_UPLOAD_PATH') { Rails.root.join('tmp', 'uploads') } }
+      @upload_path ||= ->() { Pathname.new(ENV.fetch('HYRAX_UPLOAD_PATH') { Rails.root.join('tmp', 'uploads') }) }
     end
 
     attr_writer :cache_path
     def cache_path
-      @cache_path ||= ->() { ENV.fetch('HYRAX_CACHE_PATH') { Rails.root.join('tmp', 'cache') } }
+      @cache_path ||= ->() { Pathname.new(ENV.fetch('HYRAX_CACHE_PATH') { Rails.root.join('tmp', 'cache') }) }
     end
 
     # Path on the local file system where where log and banners will be stored.
     attr_writer :branding_path
     def branding_path
-      @branding_path ||= ENV.fetch('HYRAX_BRANDING_PATH', Rails.root.join('public', 'branding'))
+      @branding_path ||= Pathname.new(ENV.fetch('HYRAX_BRANDING_PATH', Rails.root.join('public', 'branding')))
     end
 
     # @!endgroup

data/lib/hyrax/controlled_vocabulary/importer/language.rb

@@ -13,7 +13,11 @@ module Hyrax
           stdout_logger.formatter = proc do |_severity, _datetime, _progname, msg|
             "#{msg}\n"
           end
-          ActiveSupport::BroadcastLogger.new(Hyrax.logger, stdout_logger)
+          if Rails.version >= '7.1'
+            ActiveSupport::BroadcastLogger.new(Hyrax.logger, stdout_logger)
+          else
+            Hyrax.logger.extend(ActiveSupport::Logger.broadcast(stdout_logger))
+          end
         end
 
         def import

data/lib/hyrax/transactions/steps/add_file_sets.rb

@@ -20,10 +20,11 @@ module Hyrax
         ##
         # @param [Hyrax::Work] obj
         # @param [Enumerable<UploadedFile>] uploaded_files
-        # @param [Enumerable<Hash>] file_set_params
+        # @param [Enumerable<Hash>] file_set_params or nil
         #
         # @return [Dry::Monads::Result]
         def call(obj, uploaded_files: [], file_set_params: [])
+          return Success(obj) if uploaded_files.empty? && file_set_params.blank? # Skip if no files to attach
           if @handler.new(work: obj).add(files: uploaded_files, file_set_params: file_set_params).attach
             file_sets = obj.member_ids.map do |member|
               Hyrax.query_service.find_by(id: member) if Hyrax.query_service.find_by(id: member).is_a? Hyrax::FileSet

data/lib/hyrax/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Hyrax
-  VERSION = '5.1.0'
+  VERSION = '5.2.0'
 end

data/lib/hyrax.rb

@@ -23,6 +23,7 @@ require 'hyrax/valkyrie_can_can_adapter'
 require 'retriable'
 require 'valkyrie/indexing_adapter'
 require 'valkyrie/indexing/solr/indexing_adapter'
+require 'valkyrie/indexing/redis_queue/indexing_adapter'
 require 'valkyrie/indexing/null_indexing_adapter'
 
 ##

data/lib/valkyrie/indexing/redis_queue/indexing_adapter.rb

@@ -0,0 +1,144 @@
+# frozen_string_literal: true
+module Valkyrie
+  module Indexing
+    module RedisQueue
+      class IndexingAdapter
+        ##
+        # @!attribute [r] connection
+        #   @return [RSolr::Client]
+        attr_writer :connection
+        attr_accessor :index_queue_name, :delete_queue_name, :index_error_name, :delete_error_name
+
+        ##
+        # @param connection [RSolr::Client] The RSolr connection to index to.
+        def initialize(connection: nil, index_queue_name: 'toindex', delete_queue_name: 'todelete')
+          @connection = connection
+          @index_queue_name = index_queue_name
+          @delete_queue_name = delete_queue_name
+          @index_error_name = index_queue_name + "-error"
+          @delete_error_name = delete_queue_name + "-error"
+        end
+
+        def connection
+          @connection ||= default_connection
+        end
+
+        def save(resource:)
+          persist([resource])
+        end
+
+        def save_all(resources:)
+          persist(resources)
+        end
+
+        # Deletes a Solr Document using the ID
+        # @return [Array<Valkyrie::Resource>] resources which have been deleted from Solr
+        def delete(resource:)
+          connection.zadd(delete_queue_name, Time.current.to_i, resource.id.to_s)
+        end
+
+        # Delete the Solr index of all Documents
+        def wipe!
+          connection.del(index_queue_name)
+          connection.del(index_error_name)
+          connection.del(delete_queue_name)
+          connection.del(delete_error_name)
+        end
+
+        def reset!
+          self.connection = default_connection
+        end
+
+        def index_queue(size: 200)
+          set = connection.zpopmin(index_queue_name, size)
+          return [] if set.blank?
+          # we have to load these one at a time because find_all_by_id gets duplicates during wings transition
+          resources = set.map { |id, _time| Hyrax.query_service.find_by(id: id) }
+          solr_indexer = Valkyrie::IndexingAdapter.find(:solr_index)
+          solr_indexer.save_all(resources: resources)
+          solr_indexer.connection.commit
+        rescue
+          # if anything goes wrong, try to requeue the items
+          set.each { |id, time| connection.zadd(index_error_name, time, id) }
+          raise
+        end
+
+        # If a batch fails, try running them one at a time to get down to just records that really fail
+        def index_error_queue(size: 200)
+          @set = []
+          solr_indexer = Valkyrie::IndexingAdapter.find(:solr_index)
+
+          size.times do
+            @set = queue.connection.zpopmin(index_error_name, 1)
+            return [] if @set.blank?
+            # we have to load these one at a time because find_all_by_id gets duplicates during wings transition
+            resource = Hyrax.query_service.find_by(id: @set[0])
+            solr_indexer.save(resource: resource)
+          rescue
+            # if anything goes wrong, try to requeue the items
+            @set.each { |id, _time| queue.connection.zadd(index_error_name + "-twice", Time.now.to_i, id) }
+          end
+          solr_indexer.connection.commit
+        end
+
+        # We reach in to solr directly here to prevent needing to load the objects unnecessarily
+        def delete_queue(size: 200)
+          set = connection.zpopmin(delete_queue_name, size)
+          return [] if set.blank?
+          solr_indexer = Valkyrie::IndexingAdapter.find(:solr_index)
+          set.each do |id, _time|
+            solr_indexer.connection.delete_by_id id.to_s, { softCommit: true }
+          end
+          solr_indexer.connection.commit
+        rescue
+          # if anything goes wrong, try to requeue the items
+          set.each { |id, time| connection.zadd(delete_error_name, time, id) }
+          raise
+        end
+
+        # If a batch fails, try running them one at a time to get down to just records that really fail
+        def delete_error_queue(size: 200)
+          @set = []
+          size.times do
+            @set = connection.zpopmin(delete_error_name, 1)
+            return [] if @set.blank?
+            solr_indexer = Valkyrie::IndexingAdapter.find(:solr_index)
+            solr_indexer.connection.delete_by_id @set[0].to_s, { softCommit: true }
+            solr_indexer.connection.commit
+          rescue
+            # if anything goes wrong, try to requeue the items
+            @set.each { |id, _time| connection.zadd(delete_error_name, Time.now.to_i, id) }
+          end
+        end
+
+        def list_index
+          connection.zrange(index_queue_name, 0, -1, with_scores: true)
+        end
+
+        def list_delete
+          connection.zrange(delete_queue_name, 0, -1, with_scores: true)
+        end
+
+        def list_index_errors
+          connection.zrange(index_error_name, 0, -1, with_scores: true)
+        end
+
+        def list_delete_errors
+          connection.zrange(delete_error_name, 0, -1, with_scores: true)
+        end
+
+        private
+
+        def persist(resources)
+          resources.map do |r|
+            connection.zadd(index_queue_name, Time.current.to_i, r.id.to_s)
+          end
+        end
+
+        def default_connection
+          Hyrax.config.redis_connection
+        end
+      end
+    end
+  end
+end

data/lib/wings/valkyrie/query_service.rb

@@ -63,11 +63,10 @@ module Wings
       #
       # @param model [Class]
       # @return [Array<Valkyrie::Resource>]
-      #
-      # @note Due to implementation details, .find_all_of_model and .count_all_of_model may not
-      #       return the same number of results.  Is that a bug?  Probably.
       def find_all_of_model(model:)
-        model_class_for(model).all.map do |obj|
+        ActiveFedora::Base
+          .where(has_model_ssim: [model_class_for(model).to_rdf_representation,
+                                  model.to_rdf_representation]).map do |obj|
           resource_factory.to_resource(object: obj)
         end
       end

data/template.rb

@@ -4,6 +4,6 @@ insert_into_file 'config/application.rb', after: /config\.load_defaults [0-9.]+$
   "\n    config.add_autoload_paths_to_load_path = true"
 end
 
-gem 'hyrax', '5.1.0'
+gem 'hyrax', '5.2.0'
 run 'bundle install'
 generate 'hyrax:install', '-f'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hyrax
 version: !ruby/object:Gem::Version
-  version: 5.1.0
+  version: 5.2.0
 platform: ruby
 authors:
 - Justin Coyne
@@ -11,17 +11,18 @@ authors:
 - Jeremy Friesen
 - Trey Pendragon
 - Esmé Cowles
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-04-23 00:00:00.000000000 Z
+date: 2025-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '7.2'
+        version: '6.1'
     - - "<"
       - !ruby/object:Gem::Version
         version: '8.0'
@@ -29,9 +30,9 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '7.2'
+        version: '6.1'
     - - "<"
       - !ruby/object:Gem::Version
         version: '8.0'
@@ -971,16 +972,16 @@ dependencies:
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '6.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: rspec_junit_formatter
   requirement: !ruby/object:Gem::Requirement
@@ -1420,7 +1421,6 @@ files:
 - ".github/stale.yml"
 - ".github/workflows/build.yml"
 - ".github/workflows/lint-build-test.yml"
-- ".github/workflows/main.yml"
 - ".github/workflows/release.yml"
 - ".github/workflows/test-results.yml"
 - ".gitignore"
@@ -2073,6 +2073,7 @@ files:
 - app/jobs/characterize_job.rb
 - app/jobs/concerns/hyrax/members_permission_job_behavior.rb
 - app/jobs/concerns/hyrax/permission_job_behavior.rb
+- app/jobs/concerns/hyrax/queued_job_behavior.rb
 - app/jobs/content_delete_event_job.rb
 - app/jobs/content_deposit_event_job.rb
 - app/jobs/content_event_job.rb
@@ -2091,6 +2092,8 @@ files:
 - app/jobs/hyrax/grant_read_job.rb
 - app/jobs/hyrax/grant_read_to_members_job.rb
 - app/jobs/hyrax/propagate_change_depositor_job.rb
+- app/jobs/hyrax/queued_delete_job.rb
+- app/jobs/hyrax/queued_indexing_job.rb
 - app/jobs/hyrax/revoke_edit_from_members_job.rb
 - app/jobs/hyrax/revoke_edit_job.rb
 - app/jobs/iiif_manifest_cache_prewarm_job.rb
@@ -2102,6 +2105,7 @@ files:
 - app/jobs/lease_expiry_job.rb
 - app/jobs/migrate_files_to_valkyrie_job.rb
 - app/jobs/migrate_resources_job.rb
+- app/jobs/migrate_sipity_entity_job.rb
 - app/jobs/resolrize_job.rb
 - app/jobs/stream_notifications_job.rb
 - app/jobs/user_edit_profile_event_job.rb
@@ -3011,6 +3015,7 @@ files:
 - config/initializers/kaminari_engine_patch.rb
 - config/initializers/listeners.rb
 - config/initializers/new_framework_defaults_7_2.rb
+- config/initializers/reform_rails_6_1_monkey_patch.rb
 - config/initializers/simple_form.rb
 - config/initializers/storage_adapter_initializer.rb
 - config/initializers/valkyrie_id_equality.rb
@@ -3371,6 +3376,7 @@ files:
 - lib/tasks/universal_viewer.rake
 - lib/tasks/workflow.rake
 - lib/valkyrie/indexing/null_indexing_adapter.rb
+- lib/valkyrie/indexing/redis_queue/indexing_adapter.rb
 - lib/valkyrie/indexing/solr/indexing_adapter.rb
 - lib/valkyrie/indexing_adapter.rb
 - lib/wings.rb
@@ -3432,6 +3438,7 @@ licenses:
 - Apache-2.0
 metadata:
   rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -3446,7 +3453,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.5.22
+signing_key:
 specification_version: 4
 summary: Hyrax is a front-end based on the robust Samvera framework, providing a user
   interface for common repository features. Hyrax offers the ability to create repository

data/.github/workflows/main.yml

@@ -1,17 +0,0 @@
-name: Trigger Nurax build
-on:
-  workflow_dispatch:
-#  push:
-#    branches:
-#      - 'main'
-
-jobs:
-  trigger:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: peter-evans/repository-dispatch@v3
-      with:
-         token: ${{ secrets.NURAX_ACCESS_TOKEN }}
-         event-type: push
-         repository: samvera-labs/nurax
-         client-payload: '{"ref": "${{ github.ref }}", "sha": "${{ github.sha }}"}'