[Geospatial] Add new geo shape filter field to support geospatial search query

[VijayanB]

Description

Add new filter query, 'geo_shape' to search geospatial field types . This is required as part of Maps plugin which
uses geo_shape filter query to search documents.

Issues Resolved

opensearch-project/dashboards-maps#213

Check List

• All tests pass
  • yarn test:jest
  • yarn test:jest_integration
  • yarn test:ftr
• New functionality includes testing.
• New functionality has been documented.
• Update CHANGELOG.md
• Commits are signed per the DCO using --signoff

[codecov-commenter]

Codecov Report

Merging #3605 (5ac7d4e) into main (f8c9182) will decrease coverage by 0.06%.
The diff coverage is 75.00%.

📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

@@            Coverage Diff             @@
##             main    #3605      +/-   ##
==========================================
- Coverage   66.47%   66.42%   -0.06%     
==========================================
  Files        3209     3210       +1     
  Lines       61617    61625       +8     
  Branches     9504     9506       +2     
==========================================
- Hits        40958    40932      -26     
- Misses      18386    18414      +28     
- Partials     2273     2279       +6     

Flag	Coverage Δ
Linux	?
Windows	66.42% <75.00%> (-0.01%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
...ommon/opensearch_query/filters/get_filter_field.ts	33.33% <0.00%> (-4.17%)	⬇️
...gins/data/common/opensearch_query/filters/index.ts	100.00% <ø> (ø)
...ommon/opensearch_query/filters/geo_shape_filter.ts	100.00% <100.00%> (ø)

... and 6 files with indirect coverage changes

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

[VijayanB]

@AMoo-Miki Can you take a look at PR one more time? Thanks. Sorry for the rush, since we will be building feature in Maps using this PR and this is blocker for our current development.

[kavilla]

@VijayanB for speed could you provide a screen shot or describe recreation steps how to be able to use this new functionality.

[ananzh]

Will we consider define a more specific interface or type for the geo_shape property?

[VijayanB]

geo_shape will have dynamic field name and "ignored_unmapped" as well. I couldn't find a way to define both in same structure. Do you know how to do that?

[ananzh]

Not quite sure about what should be geo_shape, but it is similar to meta, will this work?

export type GeoShapeFilter = Filter & {
  meta: GeoShapeFilterMeta;
  geo_shape: {
    [fieldName: string]: {
      shape?: ShapeFilter;
      indexed_shape?: PreIndexedShapeFilter;
      relation?: GeoShapeRelation;
      ignore_unmapped?: boolean;
    };
  };
};

[ananzh]

Not a blocker. I will just approve it.

[VijayanB]

Here ignore_unmapped should be inside geo_shape , something like below

geo_shape: {
    [fieldName: string]: {
      shape?: ShapeFilter;
      indexed_shape?: PreIndexedShapeFilter;
      relation?: GeoShapeRelation;
    },
   ignore_unmapped?: boolean;
}

but typescript don't like this, since ignore_unmapped is also string and it can't differentiate whether is it part of fieldName or ignore_mapped.

[VijayanB]

@VijayanB for speed could you provide a screen shot or describe recreation steps how to be able to use this new functionality.

Sure. geo_shape is a query type that can be used to define search query for geospatial index. Currently Region Maps and Coordinate maps uses geo_polygon query type, but, it is deprecated and not encourage any more. Hence, this PR, will understand any query with Filter of type GeoShape and can serialize into geo_shape query for search request .

Maps will be using geo_shape filter instead of geo_polygon.

[VijayanB]

@kavilla @AMoo-Miki Can you please take a look at this PR?