Replace calls to ActiveFedora::Base.where (removes 7 refs to ActiveFedora) #3820

elrayle · 2019-06-17T17:17:48Z

Prerequisites

This issue cannot be completed until the following issues are completed first...

setup solr indexers to use valkyrie/wings #3800 setup solr indexers and solr metadata adapter

Descriptive summary

The ActiveFedora::Base.where is used to apply a solr query and return instances of Active Fedora objects.

It is used to accomplish a few tasks in Hyrax...

get a count of objects searching solr and counting results
get a count of objects that the current user can see by searching solr, limiting results based on current_ability, and counting the filtered results
get a set of objects

This issue involves removing references to ActiveFedora::Base.where.

ActiveFedora code

Active Fedora class being replaced...

Example from app/models/hyrax/collection_type.rb

      ActiveFedora::Base.where(collection_type_gid_ssim: gid.to_s)

To locate, search code for ActiveFedora::Base.where in app. You will also need to search for .where, but some of these will be for non ActiveFedora::Base objects (e.g. Users) and should not be updated as they are using ActiveRecord #where. The ones for ActiveFedora::Base objects (e.g. AdminSet, Collection, Work, FileSet) will need to be updated.

Replacement code

Pseudocode replacement code...

query = build a solr query based on what was being passed to ActiveFedora::Base.where - Can existing Hyrax::SolrQueryServiceBuilder be used or expanded as a replacement for building the solr query?
ids = submit query to Hyrax::SolrService
resources = use Wings::Valkyrie::QueryService #find_many_by_ids passing ids from solr search if resources are needed

Perhaps create a service that performs all these steps that can be used as a direct replacement for #where.

Considerations

Can some uses of where to find related objects be replaced with calls to one of the custom navigation queries or the standard find_references_by query method?
Do NOT replace this call if found in lib/wings directories.

Impact on Testing

Not expected to require test changes. All tests should pass with the replacement code.

The text was updated successfully, but these errors were encountered:

elrayle · 2019-06-17T18:25:54Z

Checkout PR #3804 which as a first step replaces ActiveFedora::SolrService with Hyrax::SolrService which continues to call ActiveFedora::SolrService.

Something similar might make a good first PR for this issue.

lsitu · 2019-08-29T17:50:45Z

@no-reply The ActiveFedora::Base.where call is used in lib/wings several times:
https://github.com/samvera/hyrax/blob/master/lib/wings/models/concerns/collection_behavior.rb#L25
https://github.com/samvera/hyrax/blob/master/lib/wings/valkyrie/query_service.rb#L137
https://github.com/samvera/hyrax/blob/master/lib/wings/valkyrie/query_service.rb#L150

It seems like we we shouldn't replace it (see the Considerations section in the description text). Is there anything can do for the ticket?

elrayle · 2021-07-13T13:55:41Z

Previous Work

PR #4910 replace ActiveFedora where with Valkyrized where

ActiveFedora::Base.where finds objects in the solr index and then returns ActiveFedora::Base objects. The objects themselves are not always needed, but in some cases they are. This PR addresses the need to get objects back.

This adds service FindObjectsViaSolrService which returns ActiveFedora::Base objects or Valkyrie::Resource objects based on the value of use_valkyrie.

PR #4929 replace AF.where in dashboard_helper_behavior

Uses Hyrax::SolrQueryBuilderService.construct_query to generate a query that can be submitted to Hyrax::SolrService.

NOTE: Hyrax::SolrQueryBuilderService is deprecated and uses should be replaced with calls to Hyrax::SolrQueryService instead. See PR #4938.

PR #4938 Refactor hyrax search query builder to build and execute queries

Replaces Hyrax::SolrQueryBuilderService, which implemented methods to that cannot be chained, with Hyrax::SolrQueryService, which allows methods to be chained to create more complex queries.

See Issue #4946 which addresses the deprecation.

NOTE: Remaining work for this issue should use Hyrax::SolrQueryService.

PR #5024 replace calls to deprecated SolrQueryBuilderService with SolrQueryService

Updates the same file that was changed in PR #4929, but using SolrQuery Service instead.

PR #5023 deprecate FindObjectsViaSolrService replaced by SolrQueryService#get_objects

Add #get_objects method to SolrQueryService. This allows for the construction of the query by chaining methods and then requesting the solr_docs with #get OR requesting the ActiveFedora::Base or Valkyrie::Resource objects with #get_objects.

Partially addresses Issue #3820 by removing use of `ActiveFedora::Base #where` method when using `#accessible_by` method. See original [`#accessible_by`\(https://github.com/samvera/hydra-head/blob/main/hydra-access-controls/lib/active_fedora/accessible_by.rb) method defined in hydra-access-controls. See Hyrax override of [`#gated_discovery_filters`](https://github.com/samvera/hyrax/blob/b034218b89dde7df534e32d1e5ade9161e129a1d/app/search_builders/hyrax/search_filters.rb#L16-L21).

elrayle · 2021-07-14T17:40:55Z

Remaining Work after PRs #4910, #4929, and #4938

searching for ActiveFedora::Base.where return 6 matches in 4 files

4 need the equivalent of #accessible_by added as a method in Hyrax::SolrQueryService

app/presenters/hyrax/admin_set_presenter.rb15 (Fixed in PR add accessible_by to SolrQueryService #5025)
app/presenters/hyrax/collection_presenter:85 (Fixed in PR add accessible_by to SolrQueryService #5025)
app/presenters/hyrax/collection_presenter:89 (Fixed in PR add accessible_by to SolrQueryService #5025)
app/presenters/hyrax/collection_presenter:93 (Fixed in PR add accessible_by to SolrQueryService #5025)

2 others should follow the pattern established in #4929 except using Hyrax::SolrQueryService as in PR #5024

hyrax/app/models/concerns/hyrax/collection_behavior.rb

Line 57 in ff6bb7d

ActiveFedora::Base.where("member_of_collection_ids_ssim:#{id}")

-- no changes needed, this model only exists in active fedora world, so will be deleted with wings.
hyrax/app/models/hyrax/collection_type.rb

Line 118 in ff6bb7d

ActiveFedora::Base.where(Hyrax.config.collection_type_index_field.to_sym => to_global_id.to_s)

-- no changes needed, this model only exists in active fedora world, so will be deleted with wings.

.where applied to ActiveFedora::Relation

3 uses of relation.where with relation being an ActiveFedora::Relation that should also follow the pattern established in #4929 except using Hyrax::SolrQueryService as in PR #5024

hyrax/app/services/hyrax/statistics/query_service.rb

Line 10 in ff6bb7d

relation.where(build_date_query(start_datetime, end_datetime))
hyrax/app/services/hyrax/statistics/query_service.rb

Line 48 in ff6bb7d

relation.where Hydra.config.permissions.read.group => access_level
hyrax/app/services/hyrax/statistics/over_time.rb

Line 35 in ff6bb7d

relation.where(query(min, max)).count

The three above were worked around for the postgres case in #6088. This won't work for non-postgres, but that's future scope.

a few others that might also be using ActiveFedora where

3 that need further investigation

app/services/hyrax/find_objects_via_solr_service.rb:19 (Fixed in PR deprecate FindObjectsViaSolrService replaced by SolrQueryService#get_objects #5023)
hyrax/app/services/hyrax/statistics/works/count.rb

Line 38 in ff6bb7d

works_count[:public] = query_service.where_public.count
hyrax/app/services/hyrax/statistics/works/count.rb

Line 39 in ff6bb7d

works_count[:registered] = query_service.where_registered.count

These three got marked off by #6088 as well. This won't work for non-postgres, but that's future scope.

Examples

PR #5024 uses a single SolrQueryService method to build the query and uses the #count method to get the count in DashboardHelperBehavior.

Hyrax::SolrQueryService.new.with_field_pairs(field_pairs: field_pairs(user)).count

PR #5023 uses chained SolrQueryService methods to build the query and uses #get_objects to get Valkyrie::Resource objects in MultipleMembershipChecker

      Hyrax::SolrQueryService.new
                             .with_model(model: ::Collection)
                             .with_field_pairs(field_pairs: field_pairs, join_with: ' OR ')
                             .get_objects(use_valkyrie: true)

Partially addresses Issue #3820 by removing use of `ActiveFedora::Base #where` method when using `#accessible_by` method. See original [`#accessible_by`\(https://github.com/samvera/hydra-head/blob/main/hydra-access-controls/lib/active_fedora/accessible_by.rb) method defined in hydra-access-controls. See Hyrax override of [`#gated_discovery_filters`](https://github.com/samvera/hyrax/blob/b034218b89dde7df534e32d1e5ade9161e129a1d/app/search_builders/hyrax/search_filters.rb#L16-L21).

elrayle added Effort: Moderate wings labels Jun 17, 2019

lsitu self-assigned this Aug 29, 2019

no-reply added this to the Wings milestone Sep 23, 2019

elrayle assigned elrayle and unassigned lsitu Apr 30, 2021

This was referenced May 4, 2021

replace ActiveFedora where with Valkyrized where #4910

Merged

replace AF.where in dashboard_helper_behavior #4929

Merged

elrayle mentioned this issue Jul 13, 2021

deprecate FindObjectsViaSolrService replaced by SolrQueryService#get_objects #5023

Merged

elrayle mentioned this issue Jul 13, 2021

add accessible_by to SolrQueryService #5025

Merged

elrayle added Effort: Minor and removed Effort: Moderate labels Jul 14, 2021

elrayle removed their assignment Jul 14, 2021

jessicahilt added the valkyrization label Aug 7, 2023

hackartisan self-assigned this Aug 22, 2023

tpendragon closed this as completed Aug 22, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Replace calls to ActiveFedora::Base.where (removes 7 refs to ActiveFedora) #3820

Replace calls to ActiveFedora::Base.where (removes 7 refs to ActiveFedora) #3820

elrayle commented Jun 17, 2019 •

edited

Loading

elrayle commented Jun 17, 2019

lsitu commented Aug 29, 2019

elrayle commented Jul 13, 2021 •

edited

Loading

elrayle commented Jul 14, 2021 •

edited by tpendragon

Loading

Replace calls to ActiveFedora::Base.where (removes 7 refs to ActiveFedora) #3820

Replace calls to ActiveFedora::Base.where (removes 7 refs to ActiveFedora) #3820

Comments

elrayle commented Jun 17, 2019 • edited Loading

Prerequisites

Descriptive summary

ActiveFedora code

Replacement code

Considerations

Impact on Testing

elrayle commented Jun 17, 2019

lsitu commented Aug 29, 2019

elrayle commented Jul 13, 2021 • edited Loading

Previous Work

PR #4910 replace ActiveFedora where with Valkyrized where

PR #4929 replace AF.where in dashboard_helper_behavior

PR #4938 Refactor hyrax search query builder to build and execute queries

PR #5024 replace calls to deprecated SolrQueryBuilderService with SolrQueryService

PR #5023 deprecate FindObjectsViaSolrService replaced by SolrQueryService#get_objects

elrayle commented Jul 14, 2021 • edited by tpendragon Loading

Remaining Work after PRs #4910, #4929, and #4938

searching for ActiveFedora::Base.where return 6 matches in 4 files

.where applied to ActiveFedora::Relation

a few others that might also be using ActiveFedora where

Examples

elrayle commented Jun 17, 2019 •

edited

Loading

elrayle commented Jul 13, 2021 •

edited

Loading

elrayle commented Jul 14, 2021 •

edited by tpendragon

Loading