Added design for core refactor #331

GumpacG · 2023-08-08T17:00:53Z

Description

Proposal for refactoring core to remove OpenSearch specific functions.

Issues Resolved

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 <[email protected]>

codecov · 2023-08-08T17:08:31Z

Codecov Report

Merging #331 (955a415) into integ-core-refactor-docs (d144706) will not change coverage.
The diff coverage is n/a.

@@                     Coverage Diff                     @@
##             integ-core-refactor-docs     #331   +/-   ##
===========================================================
  Coverage                       97.42%   97.42%           
  Complexity                       4647     4647           
===========================================================
  Files                             408      408           
  Lines                           11526    11526           
  Branches                          839      839           
===========================================================
  Hits                            11229    11229           
  Misses                            290      290           
  Partials                            7        7

Flag	Coverage Δ
sql-engine	`97.42% <ø> (ø)`

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

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

GumpacG · 2023-08-08T17:10:08Z

docs/dev/core-refactor.md

+```
+
+```mermaid
+flowchart LR


Which is the preferred diagram here? Sequence or flowchart?

Both are fine

Yury-Fridlyand · 2023-08-08T22:08:35Z

docs/dev/core-refactor.md

+```
+
+```mermaid
+flowchart LR


Both are fine

Yury-Fridlyand · 2023-08-08T22:11:33Z

docs/dev/core-refactor.md

+
+# 2. Requirements
+
+Resolve https://github.com/opensearch-project/sql/issues/811


Please, add more info. Probably, describe a user story with this feature implemented: plugin for plugin case. It also add dependency clean up and extensibility.

Yury-Fridlyand · 2023-08-08T22:12:59Z

docs/dev/core-refactor.md

Please, rename, core refactor is too common.

Yury-Fridlyand · 2023-08-08T22:13:09Z

docs/dev/core-refactor.md

@@ -0,0 +1,71 @@
+# 1. Overview


Add an abstract, title or intro.

Yury-Fridlyand · 2023-08-08T22:22:27Z

docs/dev/core-refactor.md

+    Core LogicalPlanOptimizer ->> #8249;DataSource#8250; LogicalPlanOptimizer: getList()
+    #8249;DataSource#8250; LogicalPlanOptimizer -->> Core LogicalPlanOptimizer: Datasource specific rules list
+    Core LogicalPlanOptimizer -->> Planner: LogicalPlan
+```


Describe:

discovered DS interfaces, for example:

parse for UDF

parse for identifier

analyze, optimize, etc

API to plug/attach new DS on runtime

how parser with UDF should work

algorithm of resolution of a DS for a query with examples; consider tricky examples, when UDF or identifier exists in multiple DS

override policy and workflow (in case if a DS overrides a built-in function), or if it is prohibited - how it is checked

Query processing flow and response if UDF/identifier isn't resolved

acarbonetto · 2023-08-08T17:51:44Z

docs/dev/core-refactor.md

+
+# 2. Requirements
+
+Resolve https://github.com/opensearch-project/sql/issues/811


Does this resolve the entire issue? According to opensearch-project#811 (comment), I believe this only resolves core functions. But does it also refactor the parser and pull out the push-down functions?

In other words, I think we need to list exactly what we are resolving as part of issue opensearch-project#811.

acarbonetto · 2023-08-08T17:53:24Z

docs/dev/core-refactor.md

@@ -0,0 +1,71 @@
+# 1. Overview


Can we name this file a bit more specifically? I think core-refactor doesn't describe the changes or objectives accurately enough.

acarbonetto · 2023-08-08T17:54:49Z

docs/dev/core-refactor.md

+
+- Using data sources other than OpenSearch, users will encounter a `SyntaxCheckException` when they query with OpenSearch specific functions. (Some of these functions can be found in https://opensearch.org/docs/latest/search-plugins/sql/sql/functions/)
+- The Parser will have a different token to categorize OpenSearch functions.
+- Core module will no longer contain OpenSearch functions.


This is the #1 goal, right?
Everything is a by-product of getting the functions out of the core module.

acarbonetto · 2023-08-08T17:56:05Z

docs/dev/core-refactor.md

+## 2.2 Functional change
+
+- Using data sources other than OpenSearch, users will encounter a `SyntaxCheckException` when they query with OpenSearch specific functions. (Some of these functions can be found in https://opensearch.org/docs/latest/search-plugins/sql/sql/functions/)
+- The Parser will have a different token to categorize OpenSearch functions.


This is a architectural design element, not functional. The users won't see this, nor is this a requirement.

* Implement creation of ip2geo feature (#257) * Update gradle version to 7.6 (#265) Signed-off-by: Vijayan Balasubramanian <[email protected]> * Implement creation of ip2geo feature * Implementation of ip2geo datasource creation * Implementation of ip2geo processor creation Signed-off-by: Heemin Kim <[email protected]> --------- Signed-off-by: Vijayan Balasubramanian <[email protected]> Signed-off-by: Heemin Kim <[email protected]> Co-authored-by: Vijayan Balasubramanian <[email protected]> * 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 <[email protected]> * Sync from main (#280) * Update gradle version to 7.6 (#265) Signed-off-by: Vijayan Balasubramanian <[email protected]> * Exclude lombok generated code from jacoco coverage report (#268) Signed-off-by: Heemin Kim <[email protected]> * Make jacoco report to be generated faster in local (#267) Signed-off-by: Heemin Kim <[email protected]> * 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 <[email protected]> --------- Signed-off-by: Vijayan Balasubramanian <[email protected]> Signed-off-by: Heemin Kim <[email protected]> Co-authored-by: Vijayan Balasubramanian <[email protected]> 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 <[email protected]> * 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 <[email protected]> * Change field name from md5 to sha256 (#285) Signed-off-by: Heemin Kim <[email protected]> * Implement get datasource api (#279) Signed-off-by: Heemin Kim <[email protected]> * 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 <[email protected]> * Make some fields in manifest file as mandatory (#289) Signed-off-by: Heemin Kim <[email protected]> * Create datasource index explicitly (#283) Signed-off-by: Heemin Kim <[email protected]> * Add wrapper class of job scheduler lock service (#290) Signed-off-by: Heemin Kim <[email protected]> * Remove all unused client attributes (#293) Signed-off-by: Heemin Kim <[email protected]> * Update copyright header (#298) Signed-off-by: Heemin Kim <[email protected]> * Run system index handling code with stashed thread context (#297) Signed-off-by: Heemin Kim <[email protected]> * Reduce lock duration and renew the lock during update (#299) Signed-off-by: Heemin Kim <[email protected]> * Implements delete datasource API (#291) Signed-off-by: Heemin Kim <[email protected]> * Set User-Agent in http request (#300) Signed-off-by: Heemin Kim <[email protected]> * Implement datasource update API (#292) Signed-off-by: Heemin Kim <[email protected]> * Refactoring test code (#302) Make buildGeoJSONFeatureProcessorConfig method to be more general Signed-off-by: Heemin Kim <[email protected]> * Add ip2geo processor integ test for failure case (#303) Signed-off-by: Heemin Kim <[email protected]> * 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 <[email protected]> * Add integration test for Ip2GeoProcessor (#306) Signed-off-by: Heemin Kim <[email protected]> * Add ConcurrentModificationException (#308) Signed-off-by: Heemin Kim <[email protected]> * Add integration test for UpdateDatasource API (#307) Signed-off-by: Heemin Kim <[email protected]> * 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 <[email protected]> * 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 <[email protected]> * Fix bug in get datasource API and improve memory usage (#313) Signed-off-by: Heemin Kim <[email protected]> * Change package for Strings.hasText (#314) (#317) Signed-off-by: Heemin Kim <[email protected]> * Remove jitter and move index setting from DatasourceFacade to DatasourceExtension (#319) Signed-off-by: Heemin Kim <[email protected]> * Do not index blank value and do not enrich null property (#320) Signed-off-by: Heemin Kim <[email protected]> * Move index setting keys to constants (#321) Signed-off-by: Heemin Kim <[email protected]> * 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 <[email protected]> * Add new fields in datasource (#325) Signed-off-by: Heemin Kim <[email protected]> * Delete index once it is expired (#326) Signed-off-by: Heemin Kim <[email protected]> * Add restoring event listener (#328) In the listener, we trigger a geoip data update Signed-off-by: Heemin Kim <[email protected]> * Reverse forcemerge and refresh order (#331) Otherwise, opensearch does not clear old segment files Signed-off-by: Heemin Kim <[email protected]> * 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 <[email protected]> * Add a field in datasource for current index name (#333) Signed-off-by: Heemin Kim <[email protected]> * 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 <[email protected]> * Use bool query for array form of IPs (#335) Signed-off-by: Heemin Kim <[email protected]> * Run update/delete request in a new thread (#337) This is not to block transport thread Signed-off-by: Heemin Kim <[email protected]> * 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 <[email protected]> * 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 <[email protected]> * Added a cache to store datasource metadata (#338) Signed-off-by: Heemin Kim <[email protected]> * Changed class name and package (#341) Signed-off-by: Heemin Kim <[email protected]> * 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 <[email protected]> * Add geo data cache (#340) Signed-off-by: Heemin Kim <[email protected]> * Add cache layer to reduce GeoIp data retrieval latency (opensearch-project#343) Signed-off-by: Heemin Kim <[email protected]> * 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 <[email protected]> * Wait until GeoIP data to be replicated to all data nodes (opensearch-project#348) Signed-off-by: Heemin Kim <[email protected]> * 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 <[email protected]> * Update packages according to a change in OpenSearch core (opensearch-project#353) Signed-off-by: Heemin Kim <[email protected]> --------- Signed-off-by: Heemin Kim <[email protected]> --------- Signed-off-by: Vijayan Balasubramanian <[email protected]> Signed-off-by: Heemin Kim <[email protected]> Co-authored-by: Vijayan Balasubramanian <[email protected]> Co-authored-by: mend-for-github-com[bot] <50673670+mend-for-github-com[bot]@users.noreply.github.com>

Added design for core refactor

955a415

Signed-off-by: Guian Gumpac <[email protected]>

GumpacG requested review from MaxKsyunz, Yury-Fridlyand, forestmvey and acarbonetto as code owners August 8, 2023 17:00

GumpacG commented Aug 8, 2023

View reviewed changes

Yury-Fridlyand reviewed Aug 8, 2023

View reviewed changes

acarbonetto reviewed Aug 21, 2023

View reviewed changes

acarbonetto mentioned this pull request Aug 23, 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

Added design for core refactor #331

Added design for core refactor #331

GumpacG commented Aug 8, 2023

codecov bot commented Aug 8, 2023 •

edited

Loading

GumpacG Aug 8, 2023

Yury-Fridlyand Aug 8, 2023

Yury-Fridlyand Aug 8, 2023

Yury-Fridlyand Aug 8, 2023

Yury-Fridlyand Aug 8, 2023

Yury-Fridlyand Aug 8, 2023

Yury-Fridlyand Aug 8, 2023

acarbonetto Aug 8, 2023

acarbonetto Aug 8, 2023

acarbonetto Aug 8, 2023

acarbonetto Aug 8, 2023

acarbonetto Aug 8, 2023


		# 2. Requirements

		Resolve https://github.com/opensearch-project/sql/issues/811

Added design for core refactor #331

Are you sure you want to change the base?

Added design for core refactor #331

Conversation

GumpacG commented Aug 8, 2023

Description

Issues Resolved

Check List

codecov bot commented Aug 8, 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov bot commented Aug 8, 2023 •

edited

Loading