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

ReportNode V2.1 #3011

Merged
merged 17 commits into from
May 29, 2024
Merged

ReportNode V2.1 #3011

merged 17 commits into from
May 29, 2024

Conversation

flo-dup
Copy link
Contributor

@flo-dup flo-dup commented May 14, 2024

Please check if the PR fulfills these requirements

  • The commit message follows our guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)

Does this PR already have an issue describing the problem?
No

What kind of change does this PR introduce?
Feature / bug fix

What is the current behavior?

  • ReportNode v2.0
  • context of included ReportNode is not replaced by context of new root ReportNode
  • included ReportNode is silently replacing messageTemplate if key conflicts occur
  • Deserialization loads the whole file before deserializing it
  • No timestamps (except if added manually)
  • messageTemplate needed to construct ReportNodes

What is the new behavior (if this is a feature change)?

  • ReportNode v2.1
  • context of included ReportNode is replaced by context of new root ReportNode through RefChain
  • if messageTemplate key conflicts occur when including ReportNode, templates are not overridden, + warn log
  • Deserializes the JSON reportNode file while streaming it
  • Timestamp value added for each ReportNode with a specific pattern if enabled at root ReportNode creation
  • messageTemplate can be missing at ReportNode construction (to anticipate the dictionaries questions which will later arise)

Does this PR introduce a breaking change or deprecate an API?

  • Yes
  • No

If yes, please check if the following requirements are fulfilled

  • The Breaking Change or Deprecated label has been added
  • The migration steps are described in the following section

What changes might users need to make in their application due to this PR? (migration steps)

  • Starting from this release, the reportNode JSON files from API v2.0 cannot be read anymore. Please switch to JSON files generated with API V2.1.
  • ReportConstants.REPORT_SEVERITY_KEY has been renamed into ReportConstants.SEVERITY_KEY

@flo-dup flo-dup added the Breaking Change API is broken label May 14, 2024
@flo-dup flo-dup requested a review from geofjamg May 14, 2024 12:50
flo-dup added 6 commits May 14, 2024 16:11
flo-dup added 2 commits May 28, 2024 11:55
Signed-off-by: Florian Dupuy <[email protected]>
@flo-dup flo-dup requested a review from geofjamg May 28, 2024 11:43
Copy link

@flo-dup flo-dup merged commit 7400eea into main May 29, 2024
6 checks passed
@flo-dup flo-dup deleted the fix_reportnode branch May 29, 2024 09:19
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.

2 participants