Feature: Idiomatic lib #421

Jakob3xD · 2023-11-09T15:26:33Z

Description

Adds opensearchapi with new client and function structure
Adds integration tests for all opensearchapi functions
golangci-lint: update rules and fail when issues are found
go: update to golang version 1.20
guids: updated to work for the new opensearchapi
Test adjusted to new opensearchapi functions and structs
Removes all old opensearchapi functions
Removes /internal/build code and folders

Issues Resolved

Closes #65

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

…PI type from client Signed-off-by: Jakob Hahn <[email protected]>

Signed-off-by: Jakob Hahn <[email protected]>

…arch Signed-off-by: Jakob Hahn <[email protected]>

Signed-off-by: Jakob Hahn <[email protected]>

dblock

Have some nits in UPGRADING, otherwise looks good.

@VachaShah @Xtansia merge?

dblock · 2023-11-16T20:32:13Z

UPGRADING.md

@@ -46,6 +50,148 @@ reqSnapshots := &opensearchapi.SnapshotDeleteRequest{
  Snapshot: sliceSnapshotsToDelete,
 ```

+## Upgrading to >= 3.0.0


Should probably reverse-order them, newest version on top.

dblock · 2023-11-16T20:32:40Z

UPGRADING.md

@@ -46,6 +50,148 @@ reqSnapshots := &opensearchapi.SnapshotDeleteRequest{
  Snapshot: sliceSnapshotsToDelete,
 ```

+## Upgrading to >= 3.0.0
+
+Version 3.0.0 contains a large restructure of the lib braking all existing implementations.


Typo: breaking

Keep it short?

"Version 3.0 is a major refactor of the client."

dblock · 2023-11-16T20:32:52Z

UPGRADING.md

+
+Version 3.0.0 contains a large restructure of the lib braking all existing implementations.
+
+### Client creation


Capitalize Titles?

VachaShah

I am fine with merging this, @Jakob3xD the version increment will happen in an upcoming PR?

sbansal7 · 2023-11-17T07:08:21Z

opensearchapi/api_indices-create.go

+// IndicesCreateReq represents possible options for the index create request
+type IndicesCreateReq struct {
+	Index  string
+	Body   io.Reader


I think it will be much more useful if there was a defined struct for the body instead of a generic io.Reader.
Same applies for all other Request structs.

Yes, it would be useful but this is not my goal with this PR and would make it even more complex to review. I want to make the basic refactor of the lib to the named issue. You could open an issue for that request so we can work on that in the future.

sbansal7 · 2023-11-17T07:10:32Z

opensearchapi/api_search-params.go

+	MinCompatibleShardNode     string
+	Preference                 string
+	PreFilterShardSize         *int
+	Query                      string


It would be great if Query can also be defined as a struct instead of leaving it as a string. One possible inspiration could be this one: https://github.com/mottaquikarim/esquerydsl/blob/master/esquerydsl.go

That is not my goal for this PR. What you want would be more related to #184 otherwise feel free to open an issue for your request.

Signed-off-by: Jakob Hahn <[email protected]>

Jakob3xD · 2023-11-17T09:51:38Z

I am fine with merging this, @Jakob3xD the version increment will happen in an upcoming PR?

I am not familiar with how the release process works and how the branch creation stuff works.
I would suggest to make the version bump in an separate PR.

dblock

I'm going to merge this so we can move forward.

dblock · 2023-11-18T13:41:35Z

I am fine with merging this, @Jakob3xD the version increment will happen in an upcoming PR?

I am not familiar with how the release process works and how the branch creation stuff works. I would suggest to make the version bump in an separate PR.

Generally the first change that requires a version bump carries the version bump. In this case this is a major breaking change so we should be incrementing the version. We don't want to increment the version right before the release, because the code is already at the next version. It's fine though, make that change later.

dblock · 2023-11-18T13:42:41Z

Now that it's merged, what's the delta between this code and a major next release @Jakob3xD? Open issues/make PRs! And massive THANK YOU this is a lot of solid work.

henvic · 2023-11-22T13:27:22Z

Thank you! That's excellent!

Jakob3xD added 7 commits November 7, 2023 10:03

Update golangci-lint config

7e097e3

Signed-off-by: Jakob Hahn <[email protected]>

opensearch: Add type Request

fcfebeb

Signed-off-by: Jakob Hahn <[email protected]>

opensearch: Add type Response

a0c6675

Signed-off-by: Jakob Hahn <[email protected]>

opensearch: Remove test for ElasticearchURL env

bf2d0a2

Signed-off-by: Jakob Hahn <[email protected]>

opensearch: add Do() func to client, remove elastic url env, remove A…

4b157fa

…PI type from client Signed-off-by: Jakob Hahn <[email protected]>

opensearch.go: remove init func, add err vars, solve linting complains

538a712

Signed-off-by: Jakob Hahn <[email protected]>

go: Update to 1.20

d2bc6ec

Signed-off-by: Jakob Hahn <[email protected]>

Jakob3xD requested review from dblock, VijayanB and VachaShah as code owners November 9, 2023 15:26

Jakob3xD added 10 commits November 9, 2023 16:44

opensearch: Add BuildRequest function

ed84c1e

Signed-off-by: Jakob Hahn <[email protected]>

opensearchapi: Remove all old api files

161c805

Signed-off-by: Jakob Hahn <[email protected]>

opensearchapi: Add api,error and inspect file

92cafac

Signed-off-by: Jakob Hahn <[email protected]>

opensearchapi: Add internal package

1d469d6

Signed-off-by: Jakob Hahn <[email protected]>

opensearchapi: add catClient

b60390b

Signed-off-by: Jakob Hahn <[email protected]>

opensearchapi: Add Bulk

45eb315

Signed-off-by: Jakob Hahn <[email protected]>

opensearchapi: Add Info

339178e

Signed-off-by: Jakob Hahn <[email protected]>

opensearchapi: Add Index

89a4b86

Signed-off-by: Jakob Hahn <[email protected]>

opensearchapi: Add Search

1cd5af7

Signed-off-by: Jakob Hahn <[email protected]>

opensearchapi: Add indices create,delete,exists

9ce341d

Signed-off-by: Jakob Hahn <[email protected]>

Jakob3xD force-pushed the feature/idiomatic branch from db259a5 to 2efba60 Compare November 9, 2023 15:44

Jakob3xD added 8 commits November 9, 2023 17:18

opensearchapi: Add missing indices endpoints

c752b28

Signed-off-by: Jakob Hahn <[email protected]>

opensearchapi: add nodes client

2fbfbc2

Signed-off-by: Jakob Hahn <[email protected]>

opensearchutil: Adjust bulk_indexer to new opensearchapi functions

72d2198

Signed-off-by: Jakob Hahn <[email protected]>

tests: Adjust to new openearchapi client and functions

c956859

Signed-off-by: Jakob Hahn <[email protected]>

DEVELOPDER_GUID: Update links and go version

cc6d9bb

Signed-off-by: Jakob Hahn <[email protected]>

internal: Remove build

a4bc434

Signed-off-by: Jakob Hahn <[email protected]>

opensearchutil: Solve linting complains

d631ed8

Signed-off-by: Jakob Hahn <[email protected]>

internal: Solve linting complains

df78fae

Signed-off-by: Jakob Hahn <[email protected]>

Jakob3xD force-pushed the feature/idiomatic branch from 2efba60 to b252a0d Compare November 9, 2023 16:18

Jakob3xD added 12 commits November 16, 2023 12:30

opensearchapi: add snapshotClient

e9fa4a1

Signed-off-by: Jakob Hahn <[email protected]>

opensearchapi: add snapshotClient to rootClient

c2f0a90

Signed-off-by: Jakob Hahn <[email protected]>

opensearchapi: add termvactor function to rootClient

0a10255

Signed-off-by: Jakob Hahn <[email protected]>

opensearchapi: add update function to rootClient

5234fb2

Signed-off-by: Jakob Hahn <[email protected]>

opensearchapi: add update_by_query function to rootClient

34a8b1f

Signed-off-by: Jakob Hahn <[email protected]>

opensearchapi: add UpdateByQueryRethrottle function to rootClient

7ab0c61

Signed-off-by: Jakob Hahn <[email protected]>

guids: updated to new opensearchapi functions

0ca5bd0

Signed-off-by: Jakob Hahn <[email protected]>

changelog: add changes

b60573d

Signed-off-by: Jakob Hahn <[email protected]>

workflows: Skip json compare for integ test against unreleased opense…

8605077

…arch Signed-off-by: Jakob Hahn <[email protected]>

opensearchapi: update license header

f5c9743

Signed-off-by: Jakob Hahn <[email protected]>

github: update license header txt

a2343e1

Signed-off-by: Jakob Hahn <[email protected]>

github: remove govulncheck workflow

0993615

Signed-off-by: Jakob Hahn <[email protected]>

Jakob3xD force-pushed the feature/idiomatic branch from d7a7706 to a7c7f1f Compare November 16, 2023 11:30

dblock previously approved these changes Nov 16, 2023

View reviewed changes

VachaShah previously approved these changes Nov 16, 2023

View reviewed changes

sbansal7 reviewed Nov 17, 2023

View reviewed changes

UPGRADING: add differences of 3.0.0 release

cc1095a

Signed-off-by: Jakob Hahn <[email protected]>

Jakob3xD dismissed stale reviews from VachaShah and dblock via cc1095a November 17, 2023 09:39

Jakob3xD force-pushed the feature/idiomatic branch from a7c7f1f to cc1095a Compare November 17, 2023 09:39

dblock approved these changes Nov 18, 2023

View reviewed changes

dblock merged commit 9d56cba into main Nov 18, 2023
87 of 88 checks passed

dblock deleted the feature/idiomatic branch November 18, 2023 13:41

This was referenced Nov 20, 2023

[BUG] ExplainRequest does not work properly #281

Closed

[FEATURE] Add tests for Document API #280

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature: Idiomatic lib #421

Feature: Idiomatic lib #421

Jakob3xD commented Nov 9, 2023

dblock left a comment

dblock Nov 16, 2023

dblock Nov 16, 2023

dblock Nov 16, 2023

VachaShah left a comment

sbansal7 Nov 17, 2023

Jakob3xD Nov 17, 2023

sbansal7 Nov 17, 2023

Jakob3xD Nov 17, 2023

Jakob3xD commented Nov 17, 2023

dblock left a comment

dblock commented Nov 18, 2023

dblock commented Nov 18, 2023

henvic commented Nov 22, 2023


		Version 3.0.0 contains a large restructure of the lib braking all existing implementations.

		### Client creation

Feature: Idiomatic lib #421

Feature: Idiomatic lib #421

Conversation

Jakob3xD commented Nov 9, 2023

Description

Issues Resolved

dblock left a comment

Choose a reason for hiding this comment

dblock Nov 16, 2023

Choose a reason for hiding this comment

dblock Nov 16, 2023

Choose a reason for hiding this comment

dblock Nov 16, 2023

Choose a reason for hiding this comment

VachaShah left a comment

Choose a reason for hiding this comment

sbansal7 Nov 17, 2023

Choose a reason for hiding this comment

Jakob3xD Nov 17, 2023

Choose a reason for hiding this comment

sbansal7 Nov 17, 2023

Choose a reason for hiding this comment

Jakob3xD Nov 17, 2023

Choose a reason for hiding this comment

Jakob3xD commented Nov 17, 2023

dblock left a comment

Choose a reason for hiding this comment

dblock commented Nov 18, 2023

dblock commented Nov 18, 2023

henvic commented Nov 22, 2023