-
Notifications
You must be signed in to change notification settings - Fork 893
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.
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
[De-Angular] Clean angular context in Data plugin #5682
base: main
Are you sure you want to change the base?
Conversation
Signed-off-by: Shahriar Shatil <52494840+ShatilKhan@users.noreply.github.com>
Signed-off-by: Shahriar Shatil <52494840+ShatilKhan@users.noreply.github.com>
Signed-off-by: Shahriar Shatil <52494840+ShatilKhan@users.noreply.github.com>
Signed-off-by: Shahriar Shatil <52494840+ShatilKhan@users.noreply.github.com>
Signed-off-by: Miki <miki@amazon.com>
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #5682 +/- ##
==========================================
+ Coverage 67.03% 67.05% +0.01%
==========================================
Files 3296 3295 -1
Lines 63339 63323 -16
Branches 10087 10078 -9
==========================================
Hits 42459 42459
+ Misses 18430 18414 -16
Partials 2450 2450
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
@@ -35,7 +35,7 @@ | |||
* @internal | |||
* @deprecated This function will be removed in the next major version. | |||
*/ | |||
export function toAngularJSON(obj: any, pretty?: any): string { | |||
export function toJSON(obj: any, pretty?: any): string { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
change method signature is same as delete the method.
if change method will not break anything, it should be safely deleted.
btw, to all osd maintainer, is this change worth to call out in change log, or should we skip change log?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A breaking change (including a backward-incompatible change to signature) has a place in the CHANGELOG.
As called out in the parent issue. This function as a whole can be removed in the next major release. The only reason for having this custom method was to handle some custom angular specific transformations that are no longer required. The change needed for the next major release is to remove the method as a whole since its currently exported by the data plugin contract. @ShatilKhan can you just delete the function and its corresponding exports? @seraphjiang yes this should be a part of the changelog but it should not be backported to 2.x |
@ashwin-pc , so I should just remove this entire file |
Yep and all its references |
Signed-off-by: Shahriar Shatil <52494840+ShatilKhan@users.noreply.github.com>
Signed-off-by: Shahriar Shatil <52494840+ShatilKhan@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Deleted file & removed all references
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do not backport this to the 2.x line. This is a breaking change.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is used in https://github.com/opensearch-project/OpenSearch-Dashboards/blob/main/src/plugins/data/common/search/aggs/buckets/filters.ts#L117 (and maybe other places too)
The 2.x branch also should mark it as deprecated, in file and in CHANGELOG. |
Convert to draft due to no progress. |
Closes #5021
Check List