add phone number analysis plugin #609

rursprung · 2024-10-11T16:04:16Z

Description

this is part of opensearch-project/OpenSearch#11326. the actual implementation was done opensearch-project/OpenSearch#15915. see the commit message on the PR for further details.

the new test group analysis has been added so that it can later be extended with all other optional language analyzers (which are currently also not covered).

Issues Resolved

n/a

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.

tests/plugins/analysis/plugins/phone.yaml

github-actions · 2024-10-11T16:11:48Z

Changes Analysis

Commit SHA: 780b653
Comparing To SHA: 6bb1fed

API Changes

Summary

└─┬Components
  ├──[➕] schemas (38207:7)
  └─┬_common.analysis___Analyzer
    ├──[➕] oneOf (38513:7)
    └─┬ONEOF
      └──[🔀] $ref (38207:13)❌

Document Element	Total Changes	Breaking Changes
components	3	1

❌ BREAKING Changes: 1 out of 3
Modifications: 1
Additions: 2
Breaking Modifications: 1

Report

The full API changes report is available at: https://github.com/opensearch-project/opensearch-api-specification/actions/runs/11834286056/artifacts/2186592205

API Coverage

	Before	After	Δ
Covered (%)	588 (57.59 %)	588 (57.59 %)	0 (0 %)
Uncovered (%)	433 (42.41 %)	433 (42.41 %)	0 (0 %)
Unknown	42	42	0

dblock · 2024-10-11T16:12:21Z

Looks great! Needs CHANGELOG, and a passing build (plugin installation likely needs work, ./bin/opensearch-plugin install -b analysis-phonenumber is failing).

tests/plugins/analysis/plugins/phone.yaml

rursprung · 2024-10-11T16:49:54Z

i've updated the path & added the changelog. i'm keeping this as a draft until this TODO is resolved:

TODO: the plugin is not yet released => installation fails. is there a snapshot somewhere which can be used instead?

acc. to @dblock the plugin should be part of the docker image (but doesn't seem to be as it tries to fetch it from the web)

dblock · 2024-10-11T17:59:00Z

i've updated the path & added the changelog. i'm keeping this as a draft until this TODO is resolved:

TODO: the plugin is not yet released => installation fails. is there a snapshot somewhere which can be used instead?

acc. to @dblock the plugin should be part of the docker image (but doesn't seem to be as it tries to fetch it from the web)

I can confirm that anlaysis-phone is not in the docker image.

[opensearch@6b69e2640682 ~]$ ls -R -la | grep analysis-
-rw-r--r-- 1 opensearch opensearch  1723718 Sep 12 10:57 lucene-analysis-common-9.11.1.jar
drwxr-xr-x  2 opensearch opensearch 4096 Sep 12 10:57 analysis-common
./modules/analysis-common:
-rw-r--r--  1 opensearch opensearch 199046 Sep 12 10:57 analysis-common-2.17.0.jar
-rw-r--r--  1 opensearch opensearch  34776 Sep 12 10:57 asm-analysis-9.7.jar

rursprung · 2024-11-07T09:26:55Z

since 2.18.0 has now been released the plugin installation should now work and there's no need to use the snapshot build of 2.18.0 anymore. i've removed the snapshot part and pushed it here again (sorry, i don't have docker-compose available locally and thus can't test if this really works; but presuming that the release of the plugin happened then it should work fine)

tests/plugins/analysis/indices/analyze/analyzer/phone.yaml

dblock

Almost there.

CHANGELOG.md

tests/plugins/analysis/indices/analyze/analyzer/phone.yaml

dblock · 2024-11-11T13:40:02Z

I fixed the Vale problem in #660.

dblock · 2024-11-12T13:55:00Z

I upgraded to 2.18 GA in #665, so this becomes easier.

this is part of opensearch-project/OpenSearch#11326. the actual implementation was done opensearch-project/OpenSearch#15915. see the commit message on the PR for further details. the new test group `analysis` has been added so that it can later be extended with all other optional language analyzers (which are currently also not covered). Signed-off-by: Ralph Ursprung <[email protected]>

github-actions · 2024-11-14T09:24:55Z

Spec Test Coverage Analysis

Total	Tested
517	349 (67.5 %)

rursprung · 2024-11-14T09:26:27Z

i've now fixed the failure (text values are now quoted) and rebased after #666 => this should now be ready!

dblock

The CHANGELOG is in the wrong section, otherwise LGTM!

dblock · 2024-11-14T16:33:10Z

CHANGELOG.md

@@ -136,6 +136,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 - Added a spec style checker [#620](https://github.com/opensearch-project/opensearch-api-specification/pull/620).
 - Added `remote_store` to node `Stats` ([#643](https://github.com/opensearch-project/opensearch-api-specification/pull/643))
 - Added `/_cluster/stats/{metric}/nodes/{node_id}` and `/_cluster/stats/{metric}/{index_metric}/nodes/{node_id}` ([#639](https://github.com/opensearch-project/opensearch-api-specification/pull/639))
+- Added `PhoneAnalyzer` from `analysis-phonenumber` plugin ([#609](https://github.com/opensearch-project/opensearch-api-specification/pull/609))


This is in the wrong place, it should be in the unreleased section above. Actually I think the line above also is wrong here and possibly more (please check in this PR).

oh, sorry, i think i missed that when rebasing! 🫣
thanks for fixing it!

dblock · 2024-11-14T16:34:21Z

~~Actually, I'll merge and fix CHANGELOG in a separate PR.~~

Included in #671.

dblock reviewed Oct 11, 2024

View reviewed changes

tests/plugins/analysis/plugins/phone.yaml Outdated Show resolved Hide resolved

dblock reviewed Oct 11, 2024

View reviewed changes

tests/plugins/analysis/plugins/phone.yaml Outdated Show resolved Hide resolved

rursprung force-pushed the add-spec-for-opensearch-phone-plugin branch 2 times, most recently from 05fcc57 to 6f3e2d6 Compare October 11, 2024 16:48

dblock mentioned this pull request Oct 11, 2024

Add pluginZip publication for plugins in the plugins folder opensearch-project/OpenSearch#16219

Closed

3 tasks

rursprung force-pushed the add-spec-for-opensearch-phone-plugin branch from 6f3e2d6 to 8dd2d68 Compare November 7, 2024 09:25

rursprung marked this pull request as ready for review November 7, 2024 09:25

rursprung requested review from harshavamsi, sachetalva, nhtruong, Xtansia, VachaShah, Tokesh and aabeshov as code owners November 7, 2024 09:25

rursprung requested a review from dblock November 7, 2024 09:26

rursprung force-pushed the add-spec-for-opensearch-phone-plugin branch 2 times, most recently from 9fd9897 to 77259f3 Compare November 7, 2024 10:43

rursprung commented Nov 7, 2024

View reviewed changes

tests/plugins/analysis/indices/analyze/analyzer/phone.yaml Outdated Show resolved Hide resolved

dblock requested changes Nov 7, 2024

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

tests/plugins/analysis/indices/analyze/analyzer/phone.yaml Outdated Show resolved Hide resolved

rursprung force-pushed the add-spec-for-opensearch-phone-plugin branch 3 times, most recently from c196412 to 5ba47a7 Compare November 8, 2024 17:13

dblock mentioned this pull request Nov 13, 2024

Correct index mapping types #666

Merged

rursprung force-pushed the add-spec-for-opensearch-phone-plugin branch from 5ba47a7 to d349baf Compare November 14, 2024 09:22

rursprung force-pushed the add-spec-for-opensearch-phone-plugin branch from d349baf to 780b653 Compare November 14, 2024 09:23

dblock requested changes Nov 14, 2024

View reviewed changes

dblock approved these changes Nov 14, 2024

View reviewed changes

dblock merged commit 1c46b69 into opensearch-project:main Nov 14, 2024
25 checks passed

rursprung deleted the add-spec-for-opensearch-phone-plugin branch November 15, 2024 08:28

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add phone number analysis plugin #609

add phone number analysis plugin #609

rursprung commented Oct 11, 2024 •

edited

Loading

github-actions bot commented Oct 11, 2024 •

edited

Loading

dblock commented Oct 11, 2024

rursprung commented Oct 11, 2024

dblock commented Oct 11, 2024

rursprung commented Nov 7, 2024

dblock left a comment

dblock commented Nov 11, 2024

dblock commented Nov 12, 2024

github-actions bot commented Nov 14, 2024

rursprung commented Nov 14, 2024

dblock left a comment

dblock Nov 14, 2024

rursprung Nov 15, 2024

dblock commented Nov 14, 2024 •

edited

Loading

add phone number analysis plugin #609

add phone number analysis plugin #609

Conversation

rursprung commented Oct 11, 2024 • edited Loading

Description

Issues Resolved

github-actions bot commented Oct 11, 2024 • edited Loading

Changes Analysis

API Changes

Summary

Report

API Coverage

dblock commented Oct 11, 2024

rursprung commented Oct 11, 2024

dblock commented Oct 11, 2024

rursprung commented Nov 7, 2024

dblock left a comment

Choose a reason for hiding this comment

dblock commented Nov 11, 2024

dblock commented Nov 12, 2024

github-actions bot commented Nov 14, 2024

Spec Test Coverage Analysis

rursprung commented Nov 14, 2024

dblock left a comment

Choose a reason for hiding this comment

dblock Nov 14, 2024

Choose a reason for hiding this comment

rursprung Nov 15, 2024

Choose a reason for hiding this comment

dblock commented Nov 14, 2024 • edited Loading

rursprung commented Oct 11, 2024 •

edited

Loading

github-actions bot commented Oct 11, 2024 •

edited

Loading

dblock commented Nov 14, 2024 •

edited

Loading