Review all Controllers overrides and reconcile with upstream changes

[jillpe]

Summary

Includes catalogue controller, contributions controller, safe searches controller,

Acceptance Criteria

• Controllers overrides are reconciled with upstream changes

Screenshots or Video

Testing Instructions

Notes

[jillpe]

Blocked by:

• Upgrade to Hyrax 4.0 in new rails branch #22
• Rails Upgrade #23
• Create alternative docker compose / dockerfile to support upgrade rails version #24

[jillpe]

No longer blocked, as of 2023-08-10

[ShanaLMoore]

Controllers

Custom Actors

ADMIN

• users_controller.rb

API

• assets_controller.rb
  • inherits APIController

CONCERNS

HYDRA/ROLE_MANAGEMENT

• roles_behavior.rb

HYRAX

• child_work_redirect.rb
• redirect_new_action.rb

DEVISE

• sessions_controller.rb

HYRAX

• assets_controller.rb
• contributions_controller.rb
• digital_instantiations_controller.rb
• essence_tracks_controller.rb
• physical_instantiation_controller.rb

SONY_CI

• api_controller.rb
  • inherits ::APIController
• webhook_logs_controller.rb
• webhooks_controller.rb
  • inherits ::APIController

OTHER

• api_controller.rb
• application_controller.rb
• audits_controller.rb
• catalog_controller.rb
• media_controller.rb (related to sony_ci_api)
• pushes_controller.rb
• roles_controller.rb
• saved_searches_controller.rb => Rob commented this out for to deploy rails 6. Why and what do we need to do to replace it? ref: https://github.com/WGBH-MLA/ams/blob/bb2411034ff8a93abbce07c33f90448dac0cf647/app/controllers/saved_searches_controller.rb#L4-L6
• search_history_controller.rb

Overridden Controllers

HYRAX/BATCH INGEST (batches_controller_decorator.rb)

// OVERRIDES HYRAX-Batch_Ingest revision: dc9d38039728eab581ab7b1cb55cf9ff33984b13
// disable /batches endpoint for new creation. Redirect to bulkrax's importer paths

• batches_controller_decorator.rb => redirects users to bulkrax instead of batches endpoints if SETTINGS__BULKRAX__ENABLED is true

HYRAX/MYCONTROLLER (my_controller.rb)

// This is an override of Hyrax 2.2.4 [hyrax/app/controllers/hyrax/my_controller.rb]
// The override adds hyrax_batch_ingest_batch_id to the configure_facets class method
// WARNING: upgrading Hyrax may break this override.

v2.2.4 vs v.4.0 diff

We already added dual boot support for the query_solr method. Besides this, I'd suspect this override will still work in hyrax 4.0

4.0 uses search_service instead of query_solr. It is defined as

    def search_service
      Hyrax::SearchService.new(config: blacklight_config, user_params: params, scope: self)
    end

Summary

Rob had to comment out the saved_searches_controller when deploying rails 6 to demo because Blacklight::SavedSearches must not be valid anymore. We will need to dig into this and how to appropriately update it for it to continue working in rails 6.

[ShanaLMoore]

Blacklight::SavedSearches

v.6.24.0
https://github.com/projectblacklight/blacklight/blob/v6.24.0/spec/features/saved_searches_spec.rb
https://github.com/projectblacklight/blacklight/blob/v6.24.0/app/views/saved_searches/index.html.erb

Removed: projectblacklight/blacklight#1736

it looks like blacklight removed saved searches back in 2017 and as far I can tell, nothing replaced it. It seems like there wasn't a need for it so it may be ok to not have it/do anything about it.

[ShanaLMoore]

SONY_CI_API

We switched from branch v0.1 to main. Are there any changes that relate to controllers?

diffs: WGBH-MLA/sony_ci_api_rewrite@v0.1...main

=> No, these changes don't seem to impact controllers. The changes don't seem to be that significant. I would expect switching to main should not cause breaking changes.

Client testing and feedback would be valuable and appreciated, given their familiarity with this tool.