Add support for geobox searches to GraphQL #792
Conversation
** Why are these changes being introduced: * We have enabled searching via a bounding box within OpenSearch, and need to extend that support to GraphQL in order to make it possible in the UI. ** Relevant ticket(s): * https://mitlibraries.atlassian.net/browse/gdt-184 ** How does this address that need: * This defines a GeoboxType, with four fields: two latitude and two longitude values, each expressed as floats. ** Document any side effects to this change: * I've tried to write tests to indicate the edges of what is possible - for example showing that you get results back if you provide both a geodistance and geobox (even if they don't result in overlapping regions - it seems like bbox is used in that case). * Similarly, I've written a test showing that it is valid to search using either order of the longitude values, because both results are valid - and different - bounding boxes. (If the latitude orders are reversed, the application errors in a way that is not captured via a cassette)
| end | ||
|
|
||
| test 'graphqlv2 geobox search with geodistance search' do | ||
| # Should this work? It does. |
There was a problem hiding this comment.
I think a slightly better comment might point out that we don't intend this to be a feature, but we aren't going to prevent people from doing it maybe? I guess we could suggest in the docs that only one geo query at a time is supported.
From my exploration around this I think it ANDs the results together but our data is difficult to reason with at times as we have a lot of things that show up effectively globally that feel like they shouldn't so it's hard to know if our queries are wonky or the data is wonky. For sure I get a smaller set of results when I search for a geobox around Boston and combine with with a geodistance search around the center of India than either of those searches independently which feels correct (even if some of the results are questionable... like "Rivers of Alaska" I'd expect not to be in that search but it is)
There was a problem hiding this comment.
I've updated this code comment - will be merging now. Thanks!
Why are these changes being introduced:
We have enabled searching via a bounding box within OpenSearch, and need to extend that support to GraphQL in order to make it possible in the UI.
Relevant ticket(s):
https://mitlibraries.atlassian.net/browse/gdt-184
How does this address that need:
This defines a GeoboxType, with four fields: two latitude and two longitude values, each expressed as floats.
Document any side effects to this change:
I've tried to write tests to indicate the edges of what is possible - for example showing that you get results back if you provide both a geodistance and geobox (even if they don't result in overlapping regions - it seems like bbox is used in that case).
Similarly, I've written a test showing that it is valid to search using either order of the longitude values, because both results are valid - and different - bounding boxes. (If the latitude orders are reversed, the application errors in a way that is not captured via a cassette)
Developer
our guide and
all issues introduced by these changes have been resolved or opened as new
issues (link to those issues in the Pull Request details above)
Code Reviewer
(not just this pull request message)
Requires database migrations?
NO
Includes new or updated dependencies?
NO