feat(sdk): Enable Custom Trigger Registration #587

AlexCuse · 2020-12-06T20:32:57Z

accept registration of factory functions for making custom trigger types
available to the SDK

Signed-off-by: Alex Ullrich alexullrich@technotects.com

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)

PR Type

What kind of change does this PR introduce?

What is the current behavior?

Issue Number: #586

What is the new behavior?

Allow registering custom trigger builders to be used when initializing trigger to run the service.

Does this PR introduce a breaking change?

Yes
No

Are there any new imports or modules? If so, what are they used for and why?

No

Are there any specific instructions or things that should be known prior to reviewing?

Other information

AlexCuse · 2020-12-06T20:39:43Z

I used the same string/factory function map approach as in edgexfoundry/go-mod-messaging#75

Happy to do something more robust if need be.

I was torn on whether or not to turn MessageError into a normal error for return from ProcessMessageFunc and decided to keep it simple for now but that is easy enough to add as well.

codecov-io · 2020-12-06T20:45:31Z

Codecov Report

Merging #587 (9df6351) into master (fb6bb54) will increase coverage by 0.04%.
The diff coverage is 64.00%.

@@            Coverage Diff             @@
##           master     #587      +/-   ##
==========================================
+ Coverage   61.76%   61.80%   +0.04%     
==========================================
  Files          31       32       +1     
  Lines        1810     1846      +36     
==========================================
+ Hits         1118     1141      +23     
- Misses        619      631      +12     
- Partials       73       74       +1

Impacted Files	Coverage Δ
appsdk/sdk.go	`32.86% <ø> (-1.94%)`	⬇️
appsdk/triggerfactory.go	`64.00% <64.00%> (ø)`

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 fb6bb54...9df6351. Read the comment docs.

AlexCuse · 2020-12-11T18:26:44Z

Before I rebase I think I'm going to add an internal method to the SDK to provide a 'starter' appcontext seeded with clients, config etc.....

AlexCuse · 2020-12-11T18:52:25Z

That should be better I just changed the builder function to take the same signature as the MQTT trigger

AlexCuse · 2020-12-17T13:45:02Z

Sorry for the chatter on this one - I wanted to check if anyone had any ideas as I worked through it. I've settled on a pair of functions to pass from the SDK to custom triggers - one to process messages on the runtime, and another to build an appcontext.Context for a given message. Its still a little awkward - I'm trying to not expose the BindingInfo type I need for the trigger, so I access it on construction by creating a fake appcontext.Context and reading through the configuration pointer available there. Other than that it feels pretty decent to use.

I think the context building function may be useful for #599 as well would just be a matter of incorporating in the built in triggers.

AlexCuse · 2020-12-17T14:52:48Z

Here is an example trigger that I have been using to test with kafka: https://github.com/AlexCuse/edgex-watermill/blob/master/core/watermilltrigger.go

AlexCuse · 2020-12-22T16:32:33Z

I added a new type TriggerConfig that provides a container to pass the necessary bits to construct a trigger from the SDK. Its still a little broad right now (I wonder about how to get to a generic broker config - I just use MessageBus currently) but better than opening up the whole SDK I think.

AlexCuse · 2020-12-30T15:13:20Z

This branch should be up to date now.

lenny-goodell

Overall this is great! Just a few minor nits. ;-)

appsdk/trigger.go

appsdk/triggerfactory.go

appsdk/triggerfactory_test.go

appsdk/sdk.go

appsdk/triggerfactory_test.go

accept registration of factory functions for making custom trigger types available to the SDK Signed-off-by: Alex Ullrich <alexullrich@technotects.com>

lenny-goodell

LGTM

Introduce an example for the custom trigger functionality introduced to the SDK in edgexfoundry/app-functions-sdk-go#587

Introduce an example for the custom trigger functionality introduced to the SDK in edgexfoundry/app-functions-sdk-go#587 Signed-off-by: Alex Ullrich <alexullrich@technotects.com>

AlexCuse changed the title ~~feat(sdk); Enable Custom Trigger Registration~~ feat(sdk): Enable Custom Trigger Registration Dec 6, 2020

AlexCuse force-pushed the custom-trigger-registration branch from 0a8f667 to cebda27 Compare December 6, 2020 20:34

AlexCuse force-pushed the custom-trigger-registration branch from cebda27 to e595e1c Compare December 11, 2020 18:51

AlexCuse mentioned this pull request Dec 11, 2020

bug(sdk): triggers don't set secret provider on appcontext passed to functions #599

Closed

AlexCuse force-pushed the custom-trigger-registration branch 3 times, most recently from c7b974f to f81c328 Compare December 12, 2020 00:20

lenny-goodell linked an issue Dec 14, 2020 that may be closed by this pull request

Custom Trigger Support #586

Closed

AlexCuse force-pushed the custom-trigger-registration branch 2 times, most recently from 7a3b32b to 123c7b3 Compare December 17, 2020 13:08

AlexCuse force-pushed the custom-trigger-registration branch from 123c7b3 to 27d96ca Compare December 17, 2020 14:36

AlexCuse force-pushed the custom-trigger-registration branch 2 times, most recently from fdab45b to 083785a Compare December 22, 2020 16:23

AlexCuse force-pushed the custom-trigger-registration branch from 083785a to 9df6351 Compare December 30, 2020 15:09

AlexCuse force-pushed the custom-trigger-registration branch from 9df6351 to c18f6a6 Compare January 4, 2021 20:28

lenny-goodell previously approved these changes Jan 7, 2021

View reviewed changes

AlexCuse dismissed lenny-goodell’s stale review via 95f303c January 7, 2021 22:36

AlexCuse force-pushed the custom-trigger-registration branch 2 times, most recently from 95f303c to 8b097a4 Compare January 7, 2021 22:38

feat(sdk): Enable Custom Trigger Registration

109166e

accept registration of factory functions for making custom trigger types available to the SDK Signed-off-by: Alex Ullrich <alexullrich@technotects.com>

AlexCuse force-pushed the custom-trigger-registration branch from 8b097a4 to 109166e Compare January 7, 2021 22:46

lenny-goodell approved these changes Jan 8, 2021

View reviewed changes

lenny-goodell merged commit 8220514 into edgexfoundry:master Jan 8, 2021

lenny-goodell mentioned this pull request Jan 8, 2021

Add documentation for App SDK custom trigger edgexfoundry/edgex-docs#321

Closed

AlexCuse pushed a commit to AlexCuse/edgex-examples that referenced this pull request Jan 11, 2021

feat(app): Add Custom Trigger Example

06b484d

Introduce an example for the custom trigger functionality introduced to the SDK in edgexfoundry/app-functions-sdk-go#587

AlexCuse mentioned this pull request Jan 11, 2021

feat(app): Add Custom Trigger Example edgexfoundry/edgex-examples#28

Merged

4 tasks

AlexCuse mentioned this pull request Jan 11, 2021

Add Custom Trigger Example edgexfoundry/edgex-examples#29

Closed

lenny-goodell linked an issue Jun 9, 2021 that may be closed by this pull request

bug(sdk): triggers don't set secret provider on appcontext passed to functions #599

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(sdk): Enable Custom Trigger Registration #587

feat(sdk): Enable Custom Trigger Registration #587

AlexCuse commented Dec 6, 2020 •

edited

Loading

AlexCuse commented Dec 6, 2020

codecov-io commented Dec 6, 2020 •

edited

Loading

AlexCuse commented Dec 11, 2020

AlexCuse commented Dec 11, 2020

AlexCuse commented Dec 17, 2020

AlexCuse commented Dec 17, 2020 •

edited

Loading

AlexCuse commented Dec 22, 2020

AlexCuse commented Dec 30, 2020

lenny-goodell left a comment

lenny-goodell left a comment

feat(sdk): Enable Custom Trigger Registration #587

feat(sdk): Enable Custom Trigger Registration #587

Conversation

AlexCuse commented Dec 6, 2020 • edited Loading

PR Checklist

PR Type

What is the current behavior?

What is the new behavior?

Does this PR introduce a breaking change?

Are there any new imports or modules? If so, what are they used for and why?

Are there any specific instructions or things that should be known prior to reviewing?

Other information

AlexCuse commented Dec 6, 2020

codecov-io commented Dec 6, 2020 • edited Loading

Codecov Report

AlexCuse commented Dec 11, 2020

AlexCuse commented Dec 11, 2020

AlexCuse commented Dec 17, 2020

AlexCuse commented Dec 17, 2020 • edited Loading

AlexCuse commented Dec 22, 2020

AlexCuse commented Dec 30, 2020

lenny-goodell left a comment

Choose a reason for hiding this comment

lenny-goodell left a comment

Choose a reason for hiding this comment

AlexCuse commented Dec 6, 2020 •

edited

Loading

codecov-io commented Dec 6, 2020 •

edited

Loading

AlexCuse commented Dec 17, 2020 •

edited

Loading