feat(data): Make Core Data publish events to <TopicPrefix>/<DeviceProfile>/<DeviceName> #3002

judehung · 2021-01-08T11:42:01Z

PR Checklist

Please check if your PR fulfills the following requirements:

Tests for the changes have been added (for bug fixes / features)
Docs have been added / updated (for bug fixes / features)

If your build fails due to your commit message not passing the build checks, please review the guidelines here: https://github.com/edgexfoundry/edgex-go/blob/master/.github/Contributing.md.

What is the current behavior?

Issue Number:

fix #2934
fix #2995

What is the new behavior?

Per https://github.com/edgexfoundry/edgex-docs/blob/master/docs_src/design/adr/013-Device-Service-Events-Message-Bus.md, Core data shall publish Events to //.

This PR made following changes:

Add new property PublishTopicPrefix into MessageQueue configuration.
Update Core Data configuration.toml to add PublishTopicPrefix set it to:
PublishTopicPrefix = 'edgex/events' # // will be added to this Publish Topic prefix
Change V2 Add Event endpoint to be /event/{DeviceProfileName}/{DeviceName}
When publishing V2 Event DTO use topic PublishTopicPrefix+ /{DeviceProfileName}/{DeviceName}
Publish []AddEventRequestDTO instead of single EventDTO to message queue

Does this PR introduce a breaking change?

Yes
No

New Imports

Yes
No

internal/core/data/config/config.go

internal/core/data/v2/application/event.go

internal/core/data/v2/controller/http/event.go

internal/core/data/v2/controller/http/event_test.go

internal/core/data/v2/application/event.go

judehung · 2021-01-11T07:56:41Z

@lenny-intel All of your comments have been addressed by the second commit 66ea3a1 Please kindly take a look. Thanks!

lenny-goodell

Code looks good, we now just need to resolve the issue of multiple AddEventRequest vs single AddEventRequest published to the MessageBus (JSON & CBOR).

judehung · 2021-01-13T01:41:04Z

rebased and squashed 2 commits into 1 commit.

Per discussion over edgexfoundry/edgex-go#3002 (comment), AddEvent V2 API shall be updated to deal with single AddEventRequest DTO instead of AddEventRequest DTO array. As a result, func AddEventReqToEventModels shall be updated accordingly. fix edgexfoundry#429 Signed-off-by: Jude Hung <jude@iotechsys.com>

Per discussion over edgexfoundry#3002 (comment), AddEvent V2 API shall be updated to deal with single AddEventRequest DTO instead of AddEventRequest DTO array. This commit makes such changes. Signed-off-by: Jude Hung <jude@iotechsys.com>

Per discussion over edgexfoundry#3002 (comment), AddEvent V2 API shall be updated to deal with single AddEventRequest DTO instead of AddEventRequest DTO array. This commit makes such changes and also updates the swagger API doc. Signed-off-by: Jude Hung <jude@iotechsys.com>

internal/core/data/v2/application/event.go

openapi/v2/core-data.yaml

…eName> Per https://github.com/edgexfoundry/edgex-docs/blob/master/docs_src/design/adr/013-Device-Service-Events-Message-Bus.md, Core data shall publish Events to <TopicPrefix>/<DeviceProfile>/<DeviceName>. This commit made following changes: 1. Add new property PublishTopicPrefix into MessageQueue configuration. 2. Update Core Data configuration.toml to add PublishTopicPrefix set it to: PublishTopicPrefix = 'edgex/events' # /<device-profile-name>/<device-name> will be added to this Publish Topic prefix 3. Change V2 Add Event endpoint to be /event/{DeviceProfileName}/{DeviceName} 4. When publishing V2 Event DTO use topic PublishTopicPrefix+ /{DeviceProfileName}/{DeviceName} Update the codes per review comments: 1. Add TODO to remove Topic when V1 code is removed. 2. Remove empty string validation as it will catch by event deive/profile name match check 3. Change validateEvent to ValidateEvent and move the validation to protocal layer(event controller) 4. Remove event id return from apllication layer 5. Update swagger doc for API path changes and profile/device name consistency check 6. Add reader back to event controller, and have AddEvent reuse the reader from event controller. Signed-off-by: Jude Hung <jude@iotechsys.com>

Per discussion over edgexfoundry#3002 (comment), AddEvent V2 API shall be updated to deal with single AddEventRequest DTO instead of AddEventRequest DTO array. This commit makes such changes and also updates the swagger API doc. Signed-off-by: Jude Hung <jude@iotechsys.com>

1. Update go doc for func PublishEvent 2. Update debug log when publishing event on the message queue 3. Update description for core-data V2 swagger API doc Signed-off-by: Jude Hung <jude@iotechsys.com>

judehung · 2021-01-14T02:15:29Z

rebased and updated code per review comments from Lenny.
@lenny-intel please kindly take a look for PR changes on bce2c04

codecov-io · 2021-01-14T02:33:18Z

Codecov Report

Merging #3002 (3f947bb) into master (9e7cc68) will decrease coverage by 0.07%.
The diff coverage is 66.66%.

@@            Coverage Diff             @@
##           master    #3002      +/-   ##
==========================================
- Coverage   40.34%   40.27%   -0.08%     
==========================================
  Files         159      159              
  Lines       13961    13962       +1     
==========================================
- Hits         5633     5623      -10     
- Misses       7997     8011      +14     
+ Partials      331      328       -3

Impacted Files	Coverage Δ
internal/core/data/v2/application/event.go	`56.75% <50.00%> (-11.14%)`	⬇️
internal/core/data/v2/controller/http/event.go	`79.03% <76.92%> (+0.77%)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 9e7cc68...3f947bb. Read the comment docs.

sonarcloud · 2021-01-14T15:16:47Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
1 Code Smell

No Coverage information
6.7% Duplication

lenny-goodell

LGTM

judehung changed the title ~~feat(data): Core Data publish to <TopicPrefix>/<DeviceProfile>/<DeviceName>~~ feat(data): Make Core Data publish events to <TopicPrefix>/<DeviceProfile>/<DeviceName> Jan 8, 2021

judehung marked this pull request as ready for review January 8, 2021 11:43

judehung requested review from lenny-goodell and cloudxxx8 January 8, 2021 11:44

lenny-goodell requested changes Jan 8, 2021

View reviewed changes

lenny-goodell reviewed Jan 8, 2021

View reviewed changes

internal/core/data/v2/application/event.go Outdated Show resolved Hide resolved

judehung force-pushed the issue-2934 branch from 383e753 to 66ea3a1 Compare January 11, 2021 07:53

judehung requested a review from lenny-goodell January 11, 2021 07:56

lenny-goodell reviewed Jan 11, 2021

View reviewed changes

FelixTing mentioned this pull request Jan 12, 2021

feat(meta): Complete the EventClient edgexfoundry/go-mod-core-contracts#416

Merged

6 tasks

judehung force-pushed the issue-2934 branch from 66ea3a1 to 343823b Compare January 13, 2021 01:40

cloudxxx8 requested a review from lenny-goodell January 13, 2021 08:02

judehung mentioned this pull request Jan 13, 2021

[V2 data] Update func AddEventReqToEventModels to transform AddEventRequest DTO to the Event model edgexfoundry/go-mod-core-contracts#429

Closed

judehung mentioned this pull request Jan 13, 2021

feat(data): Update AddEvent to use single AddEventRequest DTO edgexfoundry/go-mod-core-contracts#430

Merged

6 tasks

judehung force-pushed the issue-2934 branch from 032114f to 4d8d5a8 Compare January 13, 2021 15:24

judehung force-pushed the issue-2934 branch from 4d8d5a8 to 8b357b4 Compare January 13, 2021 15:25

judehung force-pushed the issue-2934 branch from 8b357b4 to f2181a9 Compare January 13, 2021 15:27

lenny-goodell requested changes Jan 13, 2021

View reviewed changes

internal/core/data/v2/application/event.go Outdated Show resolved Hide resolved

internal/core/data/v2/application/event.go Outdated Show resolved Hide resolved

openapi/v2/core-data.yaml Outdated Show resolved Hide resolved

judehung added 2 commits January 14, 2021 09:56

feat(data): Code adjustment for PR#3002 per review comments

bce2c04

1. Update go doc for func PublishEvent 2. Update debug log when publishing event on the message queue 3. Update description for core-data V2 swagger API doc Signed-off-by: Jude Hung <jude@iotechsys.com>

judehung force-pushed the issue-2934 branch from f2181a9 to bce2c04 Compare January 14, 2021 02:12

judehung requested a review from lenny-goodell January 14, 2021 02:15

judehung mentioned this pull request Jan 14, 2021

[V2] Send single AddEventRequest DTO rather than EventDTO to Message Queue #2995

Closed

Merge branch 'master' into issue-2934

3f947bb

lenny-goodell approved these changes Jan 14, 2021

View reviewed changes

lenny-goodell merged commit cd24e07 into edgexfoundry:master Jan 14, 2021

judehung deleted the issue-2934 branch January 15, 2021 01:38

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(data): Make Core Data publish events to <TopicPrefix>/<DeviceProfile>/<DeviceName> #3002

feat(data): Make Core Data publish events to <TopicPrefix>/<DeviceProfile>/<DeviceName> #3002

judehung commented Jan 8, 2021 •

edited

Loading

judehung commented Jan 11, 2021

lenny-goodell left a comment

judehung commented Jan 13, 2021

judehung commented Jan 14, 2021

codecov-io commented Jan 14, 2021 •

edited

Loading

sonarcloud bot commented Jan 14, 2021

lenny-goodell left a comment

feat(data): Make Core Data publish events to <TopicPrefix>/<DeviceProfile>/<DeviceName> #3002

feat(data): Make Core Data publish events to <TopicPrefix>/<DeviceProfile>/<DeviceName> #3002

Conversation

judehung commented Jan 8, 2021 • edited Loading

PR Checklist

What is the current behavior?

Issue Number:

What is the new behavior?

Does this PR introduce a breaking change?

New Imports

judehung commented Jan 11, 2021

lenny-goodell left a comment

Choose a reason for hiding this comment

judehung commented Jan 13, 2021

judehung commented Jan 14, 2021

codecov-io commented Jan 14, 2021 • edited Loading

Codecov Report

sonarcloud bot commented Jan 14, 2021

lenny-goodell left a comment

Choose a reason for hiding this comment

judehung commented Jan 8, 2021 •

edited

Loading

codecov-io commented Jan 14, 2021 •

edited

Loading