Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Maintenance] Review use of JSON Flattener #2930

Closed
stephen-crawford opened this issue Jul 3, 2023 · 2 comments
Closed

[Maintenance] Review use of JSON Flattener #2930

stephen-crawford opened this issue Jul 3, 2023 · 2 comments
Assignees
@willyborankin
Labels
enhancement New feature or request good first issue These are recommended starting points for newcomers looking to make their first contributions. triaged Issues labeled as 'Triaged' have been reviewed and are deemed actionable.

Comments

@stephen-crawford
Copy link
Contributor

Is your feature request related to a problem?
During his review of #2926, @cwperks brought up a good point about potentially removing the dependency on the JSON-flattener.

Craig mentioned: "If that is all we use the json-flattener for than I would be in favor of less dependencies. If I am understanding it correctly, it is recursively going through a JSON structure and flattening it so all.entries.are.dot.separated and there is no object nesting?"

I am making this issue to unblock the original JSON bump PR but make sure that Craig's point is not forgotten.

To resolve this issue, we will want to review the use of the library and see whether it can be removed.
@stephen-crawford stephen-crawford added enhancement New feature or request good first issue These are recommended starting points for newcomers looking to make their first contributions. untriaged Require the attention of the repository maintainers and may need to be prioritized labels Jul 3, 2023
@stephen-crawford stephen-crawford mentioned this issue Jul 3, 2023
Merged
3 tasks
@stephen-crawford
Copy link
Contributor Author

[Triage] Craig and @willyborankin's point is valid. We should try to address this at some point.

@stephen-crawford stephen-crawford added triaged Issues labeled as 'Triaged' have been reviewed and are deemed actionable. and removed untriaged Require the attention of the repository maintainers and may need to be prioritized labels Jul 10, 2023
@stephen-crawford
Copy link
Contributor Author

The same goes for the JPath Library -- can be replaced by JSONPoint.

@willyborankin willyborankin self-assigned this Sep 15, 2023
@prabhask5 prabhask5 mentioned this issue Nov 9, 2023
Merged
3 tasks
willyborankin pushed a commit that referenced this issue Dec 2, 2023
@prabhask5
[Maintenance-2930] Review use of JSON Flattener (#3674)
87de7e2 
### Description

Implement JsonFlattener helper class as written in #2926 to deprecate
the use of the unnecessary JsonFlattener third party module.

* Category (Enhancement, New feature, Bug fix, Test fix, Refactoring,
Maintenance, Documentation)

Maintenance

* Why these changes are required?

The JsonFlattener module was being utilized in only one place for one
specific purpose, so these functions can be implemented as part of the
OpenSearch codebase instead of importing an unnecessary third party
module.

* What is the old behavior before changes and new behavior after
changes?

Hopefully nothing.

### Issues Resolved
- #2930 

Is this a backport? If so, please add backport PR # and/or commits #

No

### Testing
Tests checked to make sure functions are not broken.

### Check List
- [x] New functionality includes testing
- [x] New functionality has been documented
- [x] 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](https://github.com/opensearch-project/OpenSearch/blob/main/CONTRIBUTING.md#developer-certificate-of-origin).

---------

Signed-off-by: Prabhas Kurapati <prabhask@berkeley.edu>
opensearch-trigger-bot bot pushed a commit that referenced this issue Dec 2, 2023
@github-actions
[Maintenance-2930] Review use of JSON Flattener (#3674)
7100981 
### Description

Implement JsonFlattener helper class as written in #2926 to deprecate
the use of the unnecessary JsonFlattener third party module.

* Category (Enhancement, New feature, Bug fix, Test fix, Refactoring,
Maintenance, Documentation)

Maintenance

* Why these changes are required?

The JsonFlattener module was being utilized in only one place for one
specific purpose, so these functions can be implemented as part of the
OpenSearch codebase instead of importing an unnecessary third party
module.

* What is the old behavior before changes and new behavior after
changes?

Hopefully nothing.

### Issues Resolved
- #2930

Is this a backport? If so, please add backport PR # and/or commits #

No

### Testing
Tests checked to make sure functions are not broken.

### Check List
- [x] New functionality includes testing
- [x] New functionality has been documented
- [x] 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](https://github.com/opensearch-project/OpenSearch/blob/main/CONTRIBUTING.md#developer-certificate-of-origin).

---------

Signed-off-by: Prabhas Kurapati <prabhask@berkeley.edu>
(cherry picked from commit 87de7e2)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
prabhask5 added a commit to prabhask5/opensearch-security that referenced this issue Jan 11, 2024
@prabhask5
[Maintenance-2930] Review use of JSON Flattener (opensearch-project#3674
7889401 
)

### Description

Implement JsonFlattener helper class as written in opensearch-project#2926 to deprecate
the use of the unnecessary JsonFlattener third party module.

* Category (Enhancement, New feature, Bug fix, Test fix, Refactoring,
Maintenance, Documentation)

Maintenance

* Why these changes are required?

The JsonFlattener module was being utilized in only one place for one
specific purpose, so these functions can be implemented as part of the
OpenSearch codebase instead of importing an unnecessary third party
module.

* What is the old behavior before changes and new behavior after
changes?

Hopefully nothing.

### Issues Resolved
- opensearch-project#2930

Is this a backport? If so, please add backport PR # and/or commits #

No

### Testing
Tests checked to make sure functions are not broken.

### Check List
- [x] New functionality includes testing
- [x] New functionality has been documented
- [x] 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](https://github.com/opensearch-project/OpenSearch/blob/main/CONTRIBUTING.md#developer-certificate-of-origin).

---------

Signed-off-by: Prabhas Kurapati <prabhask@berkeley.edu>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@willyborankin willyborankin

Labels
enhancement New feature or request good first issue These are recommended starting points for newcomers looking to make their first contributions. triaged Issues labeled as 'Triaged' have been reviewed and are deemed actionable.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@willyborankin @stephen-crawford