Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adds opensearch geo_bounding_box query support #789

Merged
merged 1 commit into from
Feb 13, 2024
Merged

Adds opensearch geo_bounding_box query support #789

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions app/models/opensearch.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,9 +111,34 @@ def matches
match_single_field_nested(:subjects, m)

match_geodistance(m) if @params[:geodistance].present?
match_geobox(m) if @params[:geobox].present?
m
end

# https://opensearch.org/docs/latest/query-dsl/geo-and-xy/geo-bounding-box/
def match_geobox(match_array)
match_array << {
bool: {
must: {
match_all: {}
},
filter: {
geo_bounding_box: {
'locations.geoshape': {
top: @params[:geobox][:max_latitude],
bottom: @params[:geobox][:min_latitude],
left: @params[:geobox][:min_longitude],
right: @params[:geobox][:max_longitude]
}
}
}
}
}
end

# https://www.elastic.co/guide/en/elasticsearch/reference/7.17/query-dsl-geo-distance-query.html
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Weird that they haven't created a page for this type of search, but I see what you're talking about.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suspect the Docs licensing didn't allow a fork so I believe OpenSearch had to throw away all the docs and start over whereas with the code they had the fork... so docs required a lot of work to build back up.

# Note: at the time of this implementation, opensearch does not have documentation on
# this features hence the link to the prefork elasticsearch docs
def match_geodistance(match_array)
match_array << {
bool: {
Expand Down
29 changes: 29 additions & 0 deletions test/models/opensearch_test.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -279,6 +279,8 @@ class OpensearchTest < ActiveSupport::TestCase
os.instance_variable_set(:@params,
{ geodistance: { latitude: '42.361145', longitude: '-71.057083', distance: '50mi' } })

refute(os.matches.to_json.include?('{"multi_match":{"query":'))

assert(
os.query.to_json.include?('{"distance":"50mi","locations.geoshape":{"lat":"42.361145","lon":"-71.057083"}}')
)
Expand All @@ -296,4 +298,31 @@ class OpensearchTest < ActiveSupport::TestCase
os.query.to_json.include?('{"distance":"50mi","locations.geoshape":{"lat":"42.361145","lon":"-71.057083"}}')
)
end

test 'can search by bounding box' do
os = Opensearch.new
os.instance_variable_set(:@params,
{ geobox: { max_latitude: '42.886', min_latitude: '41.239',
max_longitude: '-73.928', min_longitude: '-69.507' } })

refute(os.matches.to_json.include?('{"multi_match":{"query"'))

assert(
os.query.to_json.include?('{"locations.geoshape":{"top":"42.886","bottom":"41.239","left":"-69.507","right":"-73.928"}}')
)
end

test 'can search by bounding box and keyword' do
os = Opensearch.new
os.instance_variable_set(:@params,
{ geobox: { max_latitude: '42.886', min_latitude: '41.239',
max_longitude: '-73.928', min_longitude: '-69.507' },
q: 'rail stations' })

assert(os.matches.to_json.include?('{"multi_match":{"query":"rail stations","fields":'))

assert(
os.query.to_json.include?('{"locations.geoshape":{"top":"42.886","bottom":"41.239","left":"-69.507","right":"-73.928"}}')
)
end
end
Loading