Replace "Linked Agent By Role" - new Plugin for filtering Typed Relations in search API

[rosiel]

• REPLACES #88* (my apologies for git silliness)

• Other Relevant Links:

• discussed recently with @seth-shaw-asu and Chris Day (no @?)

What does this Pull Request do?

Creates new "fields" (in search api) for your Typed Relation fields. You can filter what relation types get included.

This does the same thing as the Linked Agent By Role plugin on the Islandora Install Profile Demo, except without the hard-coding and without cluttering the Search API field with 271 different fields.

What's new?

New Search API Processor plugin!

• Creates a new field (under "general" - FIXME!!) for each configured Typed Relation field. For example there is one for "Linked Agent [islandora_object]"
• When you select this field, it lets you choose one or more "Relation Types" from the list that is currently configured for that field.

• Does this change require documentation to be updated? Sure!
• Does this change add any new dependencies? no!
• Does this change require any other modifications to be made to the repository (i.e. Regeneration activity, etc.)? nah.
• Could this change impact execution of existing code? no.

How should this be tested?

A description of what steps someone could take to:

• Reproduce the problem you are fixing (if applicable)
• Test that the Pull Request does what is intended.
• Please be as detailed as possible.
• Good testing instructions help get your PR completed faster.

Additional Notes:

Any additional information that you think would be helpful when reviewing this PR.

Interested parties

Tag (@ mention) interested parties or, if unsure, @Islandora/committers

[rosiel]

Can be tested, feedback welcome.

I'm going to try to move these fields out of search api's "General" section, and into the individual sections for "Content", "Media", etc.

[rosiel]

With the last commit, the fields no longer show in "General" but in the appropriate "datasource" (i.e. Content, Taxonomy Term, etc... they show up with their partner fields.)

If you already had started testing before this commit, you need to remove existing fields of this type, and clear the index and "rebuild tracking information". I had trouble because it had cached the old (invalid) field definition.

[simonhm]

@rosiel We're testing this patch, and unfortunately this's not working as intended. After patching this PR, new search API processor is showed up. I enabled it and was able to add new field Linked Agent (filtered by type) as same as your instruction. Then when I re-index, I got the below messages in Recent Logs:

`Notice: Undefined index: bundle in Drupal\controlled_access_terms\Plugin\search_api\processor\TypedRelationFiltered->addFieldValues() (line 137 of /var/www/html/drupal/web/modules/contrib/controlled_access_terms/src/Plugin/search_api/processor/TypedRelationFiltered.php)

0 /var/www/html/drupal/web/core/includes/bootstrap.inc(347): _drupal_error_handler_real(8, 'Undefined index...', '/var/www/html/d...', 137)

1 /var/www/html/drupal/web/modules/contrib/controlled_access_terms/src/Plugin/search_api/processor/TypedRelationFiltered.php(137): _drupal_error_handler(8, 'Undefined index...', '/var/www/html/d...', 137, Array) ...`

And the facet for this new field is not displaying/working as intended after I do a search. Simon.

[rosiel]

Thank you so much! I think I've fixed that now.

[jordandukart]

Configuration schema changes here are the same as in https://github.com/Islandora/islandora/pull/913#discussion_r1089461386. I think we may be able to re-work how these are constructed. I may give this a go and update this further.

[seth-shaw-asu]

@jordandukart, were you able to re-work the configuration schema changes as mentioned in https://github.com/Islandora/controlled_access_terms/pull/89#issuecomment-1426021950, or should we move forward with testing and merging?

[wgilling]

I will add "review this" PR to my to-do list for this week sometime.

[wgilling]

I must have something in my local "bd-isle" project that is interfering with seeing these. Would I be able to see the "Linked Agent (filtered by type) [islandora] typed_relation_filternodeislandora_object_field_linked_agent" on the Solr index | Fields page https://islandora.traefik.me/admin/config/search/search-api/index/default_solr_index/fields?

[rosiel]

You might have to enable it first, under the "Processors" tab.

[wgilling]

Linked Agent by Type "adds the item's linked agent separately by type" was checked. This is probably conflicting with something in the bd-isle flavor site I pulled this feature branch of controlled access terms into. How do I spin up a vanilla islandora site?