PSM Data Feed Addition

[Michael7371]

PR Details

Description

This PR introduces support for PSM message processing to the ODE. Support for both required and optional fields is present, however I do not have a sample message that covers any of the optional fields for testing. All required fields have been tested with sample PSM messages generated from the NJDOT deployment.

This pipeline takes in PSM messages on the new UDP port (44940) and outputs processed JSON PSM messages on the topic: topic.OdePsmJson. As with other data feeds, multiple other topics are used for internal processing/management: topic.OdeRawEncodedPSMJson and topic.OdePsmTxPojo.

Related Issue

There are no open GitHub issues related to this PR.

Motivation and Context

Required for processing Personal Safety Messages through the ODE.

How Has This Been Tested?

I followed the convention from previous data feeds for unit testing and verified message processing with sample messages from the NJDOT deployment.

Types of changes

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

Checklist:

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

[drewjj]

Everything checks out, runs well and tests well. I think this is ready to go but do you mind editing this schema documentation to include PSM? Link to the schema you have like the others do. It is an easier, more human, way to find the schemas.

https://github.com/Michael7371/jpo-ode/tree/psm-data-feed/docs/schemas

[Michael7371]

Everything checks out, runs well and tests well. I think this is ready to go but do you mind editing this schema documentation to include PSM? Link to the schema you have like the others do. It is an easier, more human, way to find the schemas.

https://github.com/Michael7371/jpo-ode/tree/psm-data-feed/docs/schemas

Gotcha, that should be updated now.

[drewjj]

Great, Looks good!

[dmccoystephenson]

With the addition of a new message type, the following should be done:

• The ODE Data Flow Overview diagram should be updated to include the path that PSMs take.
• The existing overview data flow explanations should be updated as necessary in the README in the docs/data-flow-diagrams directory.
• A new subdirectory 'psm' should be added to the docs/data-flow-diagrams directory.
• In that new subdirectory a new diagram for the data flow of PSMs should be created.
• A new data flow explanation for PSMs should be added to the README in the docs/data-flow-diagrams directory.

[Michael7371]

@dmccoystephenson I pushed an update that addresses most of your comments. I didn't see what needed to be added to the ODE Data Flow Diagram, so I left that unchanged.

[dmccoystephenson]

Looks good, just a few comments! All tests are passing.

One thing: The architecture diagram should be updated to include PSMs as input:
https://github.com/CDOT-CV/jpo-ode/blob/master/docs/images/readme/figure1.png

[Michael7371]

Looks good, just a few comments! All tests are passing.

One thing: The architecture diagram should be updated to include PSMs as input: https://github.com/CDOT-CV/jpo-ode/blob/master/docs/images/readme/figure1.png

Do you know where the source file that generated that figure is stored?

[dmccoystephenson]

This looks good to me!