Refactor Relevance Search out of Core #338

GumpacG · 2023-08-15T16:45:54Z

Description

Moving Relevance-based search functions out of core module and into opensearch module.
This only affects the Function Resolver.

Out of Scope:

OpenSearchFunction resolver was not moved, as the score tracking is needed in the analyzer and optimizer.
Parser
Analyzer and its sub-components
LogicalPlan or optimizer

Issues Resolved

Partially fixes opensearch-project#811

Check List

New functionality includes testing.
- All tests pass, including unit test, integration test and doctest
New functionality has been documented.
- New functionality has javadoc added
- New functionality has user manual doc added
Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Signed-off-by: Guian Gumpac <guian.gumpac@improving.com>

codecov · 2023-08-15T16:52:42Z

Codecov Report

Merging #338 (ba5222f) into integ-refactor-relevance (245c4f8) will decrease coverage by 0.08%.
The diff coverage is 95.53%.

❗ Current head ba5222f differs from pull request most recent head 0d3652e. Consider uploading reports for the commit 0d3652e to get more accurate results

@@                      Coverage Diff                       @@
##             integ-refactor-relevance     #338      +/-   ##
==============================================================
- Coverage                       97.51%   97.44%   -0.08%     
- Complexity                       4657     4658       +1     
==============================================================
  Files                             408      410       +2     
  Lines                           11933    11943      +10     
  Branches                          829      831       +2     
==============================================================
+ Hits                            11637    11638       +1     
- Misses                            289      297       +8     
- Partials                            7        8       +1

Flag	Coverage Δ
sql-engine	`97.44% <95.53%> (-0.08%)`	⬇️

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

Files Changed	Coverage Δ
...s/storage/OpenSearchDataSourceMetadataStorage.java	`97.53% <0.00%> (-1.22%)`	⬇️
...ql/prometheus/storage/PrometheusStorageEngine.java	`100.00% <ø> (ø)`
...c/main/java/org/opensearch/sql/expression/DSL.java	`98.63% <50.00%> (-1.37%)`	⬇️
...ql/expression/function/NestedFunctionResolver.java	`66.66% <66.66%> (ø)`
...rg/opensearch/sql/analysis/ExpressionAnalyzer.java	`98.78% <100.00%> (-1.22%)`	⬇️
...rch/sql/analysis/ExpressionReferenceOptimizer.java	`100.00% <100.00%> (ø)`
...expression/function/BuiltinFunctionRepository.java	`100.00% <100.00%> (ø)`
...ch/sql/expression/function/OpenSearchFunction.java	`100.00% <100.00%> (ø)`
.../sql/opensearch/functions/OpenSearchFunctions.java	`100.00% <100.00%> (ø)`
...pensearch/functions/RelevanceFunctionResolver.java	`100.00% <100.00%> (ø)`
... and 2 more

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

Yury-Fridlyand · 2023-08-15T19:35:46Z

core/src/main/java/org/opensearch/sql/expression/function/BuiltinFunctionRepository.java

+//              dataSourceMetadata.getName()).getStorageEngine().getFunctions().stream().
+//              forEach(function -> instance.register(function)));
+
+      if (dataSourceService != null) {


If instance is not null and dataSourceService too, you won't return an updated repository.
Probably, you have to (one of):

store in instance default repository with build in functions only. When dataSourceService is given, clone it and update clone.

store a map with multiple instances aka cache created with different parameters

extend BuiltinFunctionRepository by adding a link to extension repos. When requested, you can do a non-deep clone of default repo and add a corresponding link; the dataSourceService specific repo could be also cached.

Yury-Fridlyand · 2023-08-15T19:36:31Z

core/src/test/java/org/opensearch/sql/analysis/ExpressionReferenceOptimizerTest.java

@@ -132,7 +132,7 @@ Expression optimize(Expression expression) {
  }

  Expression optimize(Expression expression, LogicalPlan logicalPlan) {
-    BuiltinFunctionRepository functionRepository = BuiltinFunctionRepository.getInstance();
+    BuiltinFunctionRepository functionRepository = BuiltinFunctionRepository.getInstance(null);


You can create new no arg function getInstance() which calls getInstance(null)

Yury-Fridlyand · 2023-08-15T19:38:18Z

opensearch/src/main/java/org/opensearch/sql/opensearch/functions/OpenSearchFunctions.java

+import static org.opensearch.sql.data.type.ExprCoreType.BOOLEAN;
+
+@UtilityClass
+public class OpenSearchFunctions {


Rename to FullTextSearchFunctions or RelevanceSearchFunctions

Yury-Fridlyand · 2023-08-15T19:39:03Z

opensearch/src/main/java/org/opensearch/sql/opensearch/functions/OpenSearchFunctions.java

+    return new RelevanceFunctionResolver(funcName);
+  }
+
+  public static class OpenSearchFunction extends FunctionExpression {


Move to another file

Yury-Fridlyand · 2023-08-15T19:39:51Z

opensearch/src/main/java/org/opensearch/sql/opensearch/functions/OpenSearchFunctions.java

+
+import static org.opensearch.sql.data.type.ExprCoreType.BOOLEAN;
+
+@UtilityClass


Somebody mentioned that UtilityClass could be troublesome

Yury-Fridlyand · 2023-08-15T19:55:26Z

opensearch/src/test/java/org/opensearch/sql/opensearch/planner/DefaultImplementorTest.java

+import org.opensearch.sql.planner.physical.PhysicalPlan;
+import org.opensearch.sql.planner.physical.PhysicalPlanDSL;
+
+


Suggested change

@DisplayNameGeneration(DisplayNameGenerator.ReplaceUnderscores.class)

Yury-Fridlyand · 2023-08-15T19:55:37Z

opensearch/src/test/java/org/opensearch/sql/opensearch/planner/DefaultImplementorTest.java

+import org.opensearch.sql.planner.physical.PhysicalPlanDSL;
+
+
+class DefaultImplementorTest {


Rename or add a comment

Yury-Fridlyand · 2023-08-15T19:57:00Z

opensearch/src/test/java/org/opensearch/sql/opensearch/planner/DefaultImplementorTest.java

+    Map<String, List<String>> groupedFieldsByPath = Map.of("message", List.of("message.info"));
+
+    LogicalPlan plan =
+        project(


No need to copy and test all things here. You can test opensearch specific feature only here.
Try plan = nested(values(List.of()))

Yury-Fridlyand · 2023-08-15T19:57:50Z

.../src/test/java/org/opensearch/sql/opensearch/planner/logical/LogicalPlanNodeVisitorTest.java

+            tableWriteBuilder,
+            filter,
+            aggregation,
+            nested,


You can test here nested and cursor only.

Yury-Fridlyand · 2023-08-15T19:59:18Z

.../src/test/java/org/opensearch/sql/opensearch/planner/optimizer/LogicalPlanOptimizerTest.java

+
+  @BeforeEach
+  void setUp() {
+    lenient().when(table.createScanBuilder()).thenReturn(tableScanBuilder);


Suggested change

lenient().when(table.createScanBuilder()).thenReturn(tableScanBuilder);

when(table.createScanBuilder()).thenReturn(tableScanBuilder);

You need lenient only if you have a test which doesn't use that mock.

Signed-off-by: Guian Gumpac <guian.gumpac@improving.com>

This reverts commit a602e30.

Signed-off-by: Guian Gumpac <guian.gumpac@improving.com>

…archFunctions and RelevanceFunctionResolver Signed-off-by: acarbonetto <andrewc@bitquilltech.com>

Signed-off-by: Guian Gumpac <guian.gumpac@improving.com>

Signed-off-by: acarbonetto <andrewc@bitquilltech.com>

Signed-off-by: Guian Gumpac <guian.gumpac@improving.com>

Signed-off-by: acarbonetto <andrewc@bitquilltech.com>

Signed-off-by: Guian Gumpac <guian.gumpac@improving.com>

Signed-off-by: acarbonetto <andrewc@bitquilltech.com>

Signed-off-by: Guian Gumpac <guian.gumpac@improving.com>

Signed-off-by: acarbonetto <andrewc@bitquilltech.com>

* Implement creation of ip2geo feature (#257) * Update gradle version to 7.6 (#265) Signed-off-by: Vijayan Balasubramanian <balasvij@amazon.com> * Implement creation of ip2geo feature * Implementation of ip2geo datasource creation * Implementation of ip2geo processor creation Signed-off-by: Heemin Kim <heemin@amazon.com> --------- Signed-off-by: Vijayan Balasubramanian <balasvij@amazon.com> Signed-off-by: Heemin Kim <heemin@amazon.com> Co-authored-by: Vijayan Balasubramanian <balasvij@amazon.com> * Added unit tests with some refactoring of codes (#271) * Add Unit tests * Set cache true for search query * Remove in memory cache implementation (Two way door decision) * Relying on search cache without custom cache * Renamed datasource state from FAILED to CREATE_FAILED * Renamed class name from *Helper to *Facade * Changed updateIntervalInDays to updateInterval * Changed value type of default update_interval from TimeValue to Long * Read setting value from cluster settings directly Signed-off-by: Heemin Kim <heemin@amazon.com> * Sync from main (#280) * Update gradle version to 7.6 (#265) Signed-off-by: Vijayan Balasubramanian <balasvij@amazon.com> * Exclude lombok generated code from jacoco coverage report (#268) Signed-off-by: Heemin Kim <heemin@amazon.com> * Make jacoco report to be generated faster in local (#267) Signed-off-by: Heemin Kim <heemin@amazon.com> * Update dependency org.json:json to v20230227 (#273) Co-authored-by: mend-for-github-com[bot] <50673670+mend-for-github-com[bot]@users.noreply.github.com> * Baseline owners and maintainers (#275) Signed-off-by: Vijayan Balasubramanian <balasvij@amazon.com> --------- Signed-off-by: Vijayan Balasubramanian <balasvij@amazon.com> Signed-off-by: Heemin Kim <heemin@amazon.com> Co-authored-by: Vijayan Balasubramanian <balasvij@amazon.com> Co-authored-by: mend-for-github-com[bot] <50673670+mend-for-github-com[bot]@users.noreply.github.com> * Add datasource name validation (#281) Signed-off-by: Heemin Kim <heemin@amazon.com> * Refactoring of code (#282) 1. Change variable name from datasourceName to name 2. Change variable name from id to name 3. Added helper methods in test code Signed-off-by: Heemin Kim <heemin@amazon.com> * Change field name from md5 to sha256 (#285) Signed-off-by: Heemin Kim <heemin@amazon.com> * Implement get datasource api (#279) Signed-off-by: Heemin Kim <heemin@amazon.com> * Update index option (#284) 1. Make geodata index as hidden 2. Make geodata index as read only allow delete after creation is done 3. Refresh datasource index immediately after update Signed-off-by: Heemin Kim <heemin@amazon.com> * Make some fields in manifest file as mandatory (#289) Signed-off-by: Heemin Kim <heemin@amazon.com> * Create datasource index explicitly (#283) Signed-off-by: Heemin Kim <heemin@amazon.com> * Add wrapper class of job scheduler lock service (#290) Signed-off-by: Heemin Kim <heemin@amazon.com> * Remove all unused client attributes (#293) Signed-off-by: Heemin Kim <heemin@amazon.com> * Update copyright header (#298) Signed-off-by: Heemin Kim <heemin@amazon.com> * Run system index handling code with stashed thread context (#297) Signed-off-by: Heemin Kim <heemin@amazon.com> * Reduce lock duration and renew the lock during update (#299) Signed-off-by: Heemin Kim <heemin@amazon.com> * Implements delete datasource API (#291) Signed-off-by: Heemin Kim <heemin@amazon.com> * Set User-Agent in http request (#300) Signed-off-by: Heemin Kim <heemin@amazon.com> * Implement datasource update API (#292) Signed-off-by: Heemin Kim <heemin@amazon.com> * Refactoring test code (#302) Make buildGeoJSONFeatureProcessorConfig method to be more general Signed-off-by: Heemin Kim <heemin@amazon.com> * Add ip2geo processor integ test for failure case (#303) Signed-off-by: Heemin Kim <heemin@amazon.com> * Bug fix and refactoring of code (#305) 1. Bugfix: Ingest metadata can be null if there is no processor created 2. Refactoring: Moved private method to another class for better testing support 3. Refactoring: Set some private static final variable as public so that unit test can use it 4. Refactoring: Changed string value to static variable Signed-off-by: Heemin Kim <heemin@amazon.com> * Add integration test for Ip2GeoProcessor (#306) Signed-off-by: Heemin Kim <heemin@amazon.com> * Add ConcurrentModificationException (#308) Signed-off-by: Heemin Kim <heemin@amazon.com> * Add integration test for UpdateDatasource API (#307) Signed-off-by: Heemin Kim <heemin@amazon.com> * Bug fix on lock management and few performance improvements (#310) * Release lock before response back to caller for update/delete API * Release lock in background task for creation API * Change index settings to improve indexing performance Signed-off-by: Heemin Kim <heemin@amazon.com> * Change index setting from read_only_allow_delete to write (#311) read_only_allow_delete does not block write to an index. The disk-based shard allocator may add and remove this block automatically. Therefore, use index.blocks.write instead. Signed-off-by: Heemin Kim <heemin@amazon.com> * Fix bug in get datasource API and improve memory usage (#313) Signed-off-by: Heemin Kim <heemin@amazon.com> * Change package for Strings.hasText (#314) (#317) Signed-off-by: Heemin Kim <heemin@amazon.com> * Remove jitter and move index setting from DatasourceFacade to DatasourceExtension (#319) Signed-off-by: Heemin Kim <heemin@amazon.com> * Do not index blank value and do not enrich null property (#320) Signed-off-by: Heemin Kim <heemin@amazon.com> * Move index setting keys to constants (#321) Signed-off-by: Heemin Kim <heemin@amazon.com> * Return null index name for expired data (#322) Return null index name for expired data so that it can be deleted by clean up process. Clean up process exclude current index from deleting. Signed-off-by: Heemin Kim <heemin@amazon.com> * Add new fields in datasource (#325) Signed-off-by: Heemin Kim <heemin@amazon.com> * Delete index once it is expired (#326) Signed-off-by: Heemin Kim <heemin@amazon.com> * Add restoring event listener (#328) In the listener, we trigger a geoip data update Signed-off-by: Heemin Kim <heemin@amazon.com> * Reverse forcemerge and refresh order (#331) Otherwise, opensearch does not clear old segment files Signed-off-by: Heemin Kim <heemin@amazon.com> * Removed parameter and settings (#332) * Removed first_only parameter * Removed max_concurrency and batch_size setting first_only parameter was added as current geoip processor has it. However, the parameter have no benefit for ip2geo processor as we don't do a sequantial search for array data but use multi search. max_concurrency and batch_size setting is removed as these are only reveal internal implementation and could be a future blocker to improve performance later. Signed-off-by: Heemin Kim <heemin@amazon.com> * Add a field in datasource for current index name (#333) Signed-off-by: Heemin Kim <heemin@amazon.com> * Delete GeoIP data indices after restoring complete (#334) We don't want to use restored GeoIP data indices. Therefore we delete the indices once restoring process complete. When GeoIP metadata index is restored, we create a new GeoIP data index instead. Signed-off-by: Heemin Kim <heemin@amazon.com> * Use bool query for array form of IPs (#335) Signed-off-by: Heemin Kim <heemin@amazon.com> * Run update/delete request in a new thread (#337) This is not to block transport thread Signed-off-by: Heemin Kim <heemin@amazon.com> * Remove IP2Geo processor validation (#336) Cannot query index to get data to validate IP2Geo processor. Will add validation when we decide to store some of data in cluster state metadata. Signed-off-by: Heemin Kim <heemin@amazon.com> * Acquire lock sychronously (#339) By acquiring lock asychronously, the remaining part of the code is being run by transport thread which does not allow blocking code. We want only single update happen in a node using single thread. However, it cannot be acheived if I acquire lock asynchronously and pass the listener. Signed-off-by: Heemin Kim <heemin@amazon.com> * Added a cache to store datasource metadata (#338) Signed-off-by: Heemin Kim <heemin@amazon.com> * Changed class name and package (#341) Signed-off-by: Heemin Kim <heemin@amazon.com> * Refactoring of code (#342) 1. Changed class name from Ip2GeoCache to Ip2GeoCachedDao 2. Moved the Ip2GeoCachedDao from cache to dao package Signed-off-by: Heemin Kim <heemin@amazon.com> * Add geo data cache (#340) Signed-off-by: Heemin Kim <heemin@amazon.com> * Add cache layer to reduce GeoIp data retrieval latency (opensearch-project#343) Signed-off-by: Heemin Kim <heemin@amazon.com> * Use _primary in query preference and few changes (opensearch-project#347) 1. Use _primary preference to get datasource metadata so that it can read the latest data. RefreshPolicy.IMMEDIATE won't refresh replica shards immediately according to #346 2. Update datasource metadata index mapping 3. Move batch size from static value to setting Signed-off-by: Heemin Kim <heemin@amazon.com> * Wait until GeoIP data to be replicated to all data nodes (opensearch-project#348) Signed-off-by: Heemin Kim <heemin@amazon.com> * Update packages according to a change in OpenSearch core (opensearch-project#354) * Update packages according to a change in OpenSearch core Signed-off-by: Heemin Kim <heemin@amazon.com> * Update packages according to a change in OpenSearch core (opensearch-project#353) Signed-off-by: Heemin Kim <heemin@amazon.com> --------- Signed-off-by: Heemin Kim <heemin@amazon.com> --------- Signed-off-by: Vijayan Balasubramanian <balasvij@amazon.com> Signed-off-by: Heemin Kim <heemin@amazon.com> Co-authored-by: Vijayan Balasubramanian <balasvij@amazon.com> Co-authored-by: mend-for-github-com[bot] <50673670+mend-for-github-com[bot]@users.noreply.github.com>

GumpacG added 3 commits August 14, 2023 10:24

Created Relevance and OpenSeach Functions in opensearch module

c265987

Signed-off-by: Guian Gumpac <guian.gumpac@improving.com>

Moving Test in progress. Committing for rebase purposes

850ed72

Signed-off-by: Guian Gumpac <guian.gumpac@improving.com>

Moved tests out from core

3b818c0

Signed-off-by: Guian Gumpac <guian.gumpac@improving.com>

Yury-Fridlyand reviewed Aug 15, 2023

View reviewed changes

GumpacG and others added 7 commits August 17, 2023 10:44

Pulled out analyzers to opensearch module

a602e30

Signed-off-by: Guian Gumpac <guian.gumpac@improving.com>

Revert "Pulled out analyzers to opensearch module"

95d5285

This reverts commit a602e30.

Fixed jacoco for opensearch module

4c35cbf

Signed-off-by: Guian Gumpac <guian.gumpac@improving.com>

Refactor out OpenSearchFunction from OpenSearchFunctions; Move OpenSe…

b7f067d

…archFunctions and RelevanceFunctionResolver Signed-off-by: acarbonetto <andrewc@bitquilltech.com>

Fixed tests in core. WIP

3b8d006

Signed-off-by: Guian Gumpac <guian.gumpac@improving.com>

Update to use OpenSearchDSL

ba5b851

Signed-off-by: acarbonetto <andrewc@bitquilltech.com>

Fixed nested test coverage

e4e866e

Signed-off-by: Guian Gumpac <guian.gumpac@improving.com>

GumpacG force-pushed the dev-refactor-relevance branch from 629d900 to e4e866e Compare August 22, 2023 18:45

acarbonetto and others added 9 commits August 22, 2023 13:00

Update datasource metadata to check for initial cluster state

675aa08

Signed-off-by: acarbonetto <andrewc@bitquilltech.com>

Add score functions to analyzer test

32ce604

Signed-off-by: acarbonetto <andrewc@bitquilltech.com>

Re-add nested tests into core

4c582d0

Signed-off-by: acarbonetto <andrewc@bitquilltech.com>

Added hashcode for DataSourceMetadata

5f6eaf2

Signed-off-by: Guian Gumpac <guian.gumpac@improving.com>

Added test for score without boost

ba5222f

Signed-off-by: Guian Gumpac <guian.gumpac@improving.com>

Re-add nested tests in Analyzer

a9d3300

Signed-off-by: acarbonetto <andrewc@bitquilltech.com>

Clean up analyzer tests

cc4967b

Signed-off-by: acarbonetto <andrewc@bitquilltech.com>

Cleaned up some code

014a31d

Signed-off-by: Guian Gumpac <guian.gumpac@improving.com>

Fix jacoco and add unit tests for coverage

0d3652e

Signed-off-by: acarbonetto <andrewc@bitquilltech.com>

acarbonetto marked this pull request as ready for review August 22, 2023 23:47

acarbonetto requested review from MaxKsyunz, forestmvey and acarbonetto as code owners August 22, 2023 23:47

acarbonetto merged commit 490669b into integ-refactor-relevance Aug 22, 2023

acarbonetto deleted the dev-refactor-relevance branch August 22, 2023 23:53

acarbonetto changed the title ~~[WIP] Refactor Relevance out of Core~~ Refactor Relevance Search out of Core Aug 22, 2023

MitchellGale mentioned this pull request Aug 22, 2023

Refactor OpenSearch Relevance Functions out of Core opensearch-project/sql#2019

Open

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor Relevance Search out of Core #338

Refactor Relevance Search out of Core #338

GumpacG commented Aug 15, 2023 •

edited by acarbonetto

Loading

codecov bot commented Aug 15, 2023 •

edited

Loading

Yury-Fridlyand Aug 15, 2023

Yury-Fridlyand Aug 15, 2023

Yury-Fridlyand Aug 15, 2023

Yury-Fridlyand Aug 15, 2023

Yury-Fridlyand Aug 15, 2023

Yury-Fridlyand Aug 15, 2023

Yury-Fridlyand Aug 15, 2023

Yury-Fridlyand Aug 15, 2023

Yury-Fridlyand Aug 15, 2023

Yury-Fridlyand Aug 15, 2023


		import static org.opensearch.sql.data.type.ExprCoreType.BOOLEAN;

		@UtilityClass

		import org.opensearch.sql.planner.physical.PhysicalPlan;
		import org.opensearch.sql.planner.physical.PhysicalPlanDSL;


	@DisplayNameGeneration(DisplayNameGenerator.ReplaceUnderscores.class)

		import org.opensearch.sql.planner.physical.PhysicalPlanDSL;


		class DefaultImplementorTest {

	lenient().when(table.createScanBuilder()).thenReturn(tableScanBuilder);
	when(table.createScanBuilder()).thenReturn(tableScanBuilder);

Refactor Relevance Search out of Core #338

Refactor Relevance Search out of Core #338

Conversation

GumpacG commented Aug 15, 2023 • edited by acarbonetto Loading

Description

Issues Resolved

Check List

codecov bot commented Aug 15, 2023 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

GumpacG commented Aug 15, 2023 •

edited by acarbonetto

Loading

codecov bot commented Aug 15, 2023 •

edited

Loading