optionally post-process results before displaying them

[alastair]

As described in trompamusic/ce-api#187, we sometimes have searches where the items that we want are returned as child objects of the main query, for example:

query {
  ItemList(identifier:"e91489d7-a776-40dd-8abf-0c934922bd99") {
    identifier
    name
    itemListElement(filter:{name_regexp:"(?i).*missa.*"}) {
      identifier
      name
    }
  }
}

The items that we want are actually the MusicCompositions returned in itemListElement. This query cannot be done any other way because we don't have reverse relationships saying that an item is part of a list.

This change adds optional preprocessQuery and processSearchResult methods to search types so that we can do a query such as the one above, and then post-process the results and return a list of the expected objects.

There is still a bug, where I don't understand the reasoning behind performing two queries in SearchConfig.performSearch - first it runs searchType.searchAllQuery and then searchType.searchQuery. In the example that I made, the first result runs fine, but then the second one filters out everything, I'm sure I'm missing something simple in the data flow.

I see that some ordering code appears to assume that there is a _searchScore property in some returned items, which might also not be the case here.

[ChristiaanScheermeijer]

Hi @alastair,

Thanks for the PR!

The reason that the multimodal component performs two queries is to be able to show all possible filters and facets.

The searchType.searchAllQuery query returns all matches based on the given search phrase. From the results, we can build lists for each configured filter. This query should be as light as possible and cannot contain concrete type properties since the return type is SearchableInterface.

The searchType.searchQuery query does the actual filtering based on the searchAllQuery results. This query is also used to get all the properties needed to populate the UI.

[ChristiaanScheermeijer]

Suggested change

	npm run start:example
	yarn start:example

[ChristiaanScheermeijer]

When processSearchResult is not defined, the generateFilter function won't receive allResults anymore. Doesn't this break the query without the processing functions?

[alastair]

I just tested this against prod and it gives me the expected results, thanks!

[alastair]

One additional thought about this - because the data that we're extracting is a child of the main returned object, will the automatic filter building work? (I didn't try it in my example). Hopefully it will correctly use the result of processSearchResult, is that right?

[alastair]

@ChristiaanScheermeijer can we merge this and get a new release made?