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.

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

Draft
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

ShatilKhan
Copy link
Contributor

Closes #5021

Check List

  • Update CHANGELOG.md
  • Commits are signed per the DCO using --signoff

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>
@AMoo-Miki AMoo-Miki changed the title Json [De-Angular] Clean angular context in Data plugin Jan 11, 2024
Signed-off-by: Miki <miki@amazon.com>
Copy link

codecov bot commented Jan 11, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (b5d39b6) 67.03% compared to head (824ab55) 67.05%.
Report is 15 commits behind head on main.

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              
Flag Coverage Δ
Linux_1 35.25% <ø> (+0.01%) ⬆️
Linux_2 55.22% <ø> (+0.03%) ⬆️
Linux_3 43.93% <ø> (+<0.01%) ⬆️
Linux_4 35.35% <ø> (+0.01%) ⬆️
Windows_1 35.28% <ø> (+0.01%) ⬆️
Windows_2 55.19% <ø> (+0.03%) ⬆️
Windows_3 43.95% <ø> (+0.02%) ⬆️
Windows_4 35.35% <ø> (+0.01%) ⬆️

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

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@@ -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 {
Copy link
Member

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?

Copy link
Collaborator

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.

@ashwin-pc
Copy link
Member

ashwin-pc commented Jan 17, 2024

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 ashwin-pc closed this Jan 17, 2024
@ashwin-pc ashwin-pc reopened this Jan 17, 2024
@ShatilKhan
Copy link
Contributor Author

@ashwin-pc , so I should just remove this entire file src/plugins/data/common/search/aggs/utils/to_json.ts?

@ashwin-pc
Copy link
Member

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>
Copy link
Contributor Author

@ShatilKhan ShatilKhan left a 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

Copy link
Member

@ashwin-pc ashwin-pc left a 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.

@kavilla kavilla added the v3.0.0 label Feb 8, 2024
Copy link
Collaborator

@AMoo-Miki AMoo-Miki left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@AMoo-Miki
Copy link
Collaborator

The 2.x branch also should mark it as deprecated, in file and in CHANGELOG.

@ananzh
Copy link
Member

ananzh commented Oct 30, 2024

Convert to draft due to no progress.

@ananzh ananzh marked this pull request as draft October 30, 2024 19:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[De-Angular] Clean angular context in Data plugin
6 participants