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

Update the schema version to 8 for the output messages #136

Merged
merged 6 commits into from
Dec 31, 2024

Conversation

drewjj
Copy link
Collaborator

@drewjj drewjj commented Dec 24, 2024

PR Details

Description

Incrementing the schemaVersion value for the ODE output messages since a new breaking change has been introduced and this will make it clear that data generated from this version of the jpo-ode is not the same as the older version.

The output version has also been removed from the application.yaml. This field wasn't used yet but it would be undesirable to suggest that this field should be customizable since this is explicitly paired with the current version of message output. The schema documentation has been updated to reflect where to change this value if it is necessary.

Related Issue

N/A

Motivation and Context

If the schemaVersion doesn't change, it will be confusing and users may believe they are backwards compatible or that the schema hasn't changed.

How Has This Been Tested?

This has been tested locally with UDP sender scripts and the unit tests have been updated.

Types of changes

  • Defect fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (fix or feature that cause existing functionality to change)

Checklist:

  • I have added any new packages to the sonar-scanner.properties file
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
    ODE Contributing Guide
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@drewjj
Copy link
Collaborator Author

drewjj commented Dec 24, 2024

Ignoring all checkstyle comments regarding line length. Completely refactoring the tests is out of scope of this.

Copy link

@Michael7371 Michael7371 left a comment

Choose a reason for hiding this comment

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

I am still seeing a few references to schema version 7. These need to be updated as well, right?

OdeBsmDataTest
OdeMapDataTest
OdePsmDataTest
OdeSpatDataTest
OdeSrmDataTest
OdeSsmDataTest

@drewjj
Copy link
Collaborator Author

drewjj commented Dec 29, 2024

I am still seeing a few references to schema version 7. These need to be updated as well, right?

OdeBsmDataTest OdeMapDataTest OdePsmDataTest OdeSpatDataTest OdeSrmDataTest OdeSsmDataTest

Addressed

Copy link

@Michael7371 Michael7371 left a comment

Choose a reason for hiding this comment

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

Looks good and all tests still pass.

@dmccoystephenson dmccoystephenson self-requested a review December 30, 2024 22:48
Copy link
Member

@dmccoystephenson dmccoystephenson left a comment

Choose a reason for hiding this comment

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

Looks good & the unit tests pass!

@drewjj drewjj merged commit 9ab6086 into dev Dec 31, 2024
3 checks passed
@drewjj drewjj deleted the fix/schema-version-update branch December 31, 2024 00:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants