Add sample application #527

PeterKneale · 2019-03-16T11:57:10Z

Added a sample application consisting of three projects

a web api that publishes from a controller and subscribes via a background service
a console application that subscribes via a background service and publishes within an event handler
a shared models assembly containing event dto's
Further work required:
- Demonstrate use of PublishMetaData
- Demonstrate integration with CorrelationId
- Demonstrate use of Cancellation Tokens
- Add acceptance tests project
- Add dockerfiles for api, console, aws and tests
- Demonstrate docker-compose executing acceptance tests against api / console while using mocked aws environment

relates to issue #476

codecov · 2019-03-16T12:01:28Z

Codecov Report

Merging #527 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #527   +/-   ##
=======================================
  Coverage   37.64%   37.64%           
=======================================
  Files          78       78           
  Lines        2614     2614           
  Branches      458      458           
=======================================
  Hits          984      984           
  Misses       1485     1485           
  Partials      145      145

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 5e24a34...35d8568. Read the comment docs.

JustSaying.Sample.Restaurant.KitchenConsole/OrderPlacedEventHandler.cs

JustSaying.Sample.Restaurant.KitchenConsole/Program.cs

JustSaying.Sample.Restaurant.Models/OrderPlacedEvent.cs

JustSaying.Sample.Restaurant.Models/OrderReadyEvent.cs

JustSaying.Sample.Restaurant.OrderingApi/Handlers/OrderReadyEventHandler.cs

JustSaying.Sample.Restaurant.OrderingApi/Models/CustomerOrderModel.cs

JustSaying.Sample.Restaurant.OrderingApi/Program.cs

JustSaying.Sample.Restaurant.OrderingApi/Subscriber.cs

martincostello

This is a great start - thanks for picking up this issue 😃

JustSaying.Sample.Restaurant.KitchenConsole/Program.cs

JustSaying.Sample.Restaurant.KitchenConsole/OrderPlacedEventHandler.cs

JustSaying.Sample.Restaurant.KitchenConsole/appsettings.json

JustSaying.Sample.Restaurant.OrderingApi/Program.cs

JustSaying.Sample.Restaurant.OrderingApi/Startup.cs

README.md

slang25

Great start 👍

JustSaying.Sample.Restaurant.KitchenConsole/Program.cs

JustSaying.Sample.Restaurant.Models/OrderPlacedEvent.cs

JustSaying.Sample.Restaurant.OrderingApi/Controllers/OrdersController.cs

PeterKneale · 2019-03-17T12:25:42Z

Have pushed, can squash if required.
Have had to add suppression in order to remove the ConfigureAwait
[assembly: SuppressMessage("Reliability", "CA2007:Do not directly await a Task", Justification = "Console application do not have a SynchronizationContext")]

JustSaying.Sample.Restaurant.KitchenConsole/Program.cs

martincostello · 2019-03-17T12:31:05Z

JustSaying.Sample.Restaurant.KitchenConsole/Program.cs

+                           else
+                           {
+                               // The real AWS environment will require some means of authentication
+                               //x.WithBasicCredentials("###", "###");


If you add UserSecrets to the config providers, you could load these from config without needing to have it commented-out with placeholders.

Yeah im a bit torn - im trying to be careful to leave the sample app in the simplest possible state where people can easily see what they might need to do or change in order to get it running on their box. Some have keys, others env variables etc. Not sure whats best.
Can go with the secrets if you think that's best but I think its a bit of a distraction from demonstrating the bus.

on a similar note i was thinking of leaving a line like this for those who configure the region via environment variables too..?

//x.WithRegion(new Amazon.Runtime.EnvironmentVariableAWSRegion().Region);

I guess that's more of an advanced use case? We wouldn't want to balloon the samples too much with all the possible things you could do. Also if you were using environment variables, you'd probably be using the .NET provider for that and binding them to IConfiguration somehow I'd have thought.

Yeah and it feels a bit orthogonal to the actual demonstration of your library. Its more demonstrating aspnet core configuration and the aws sdk

JustSaying.Sample.Restaurant.OrderingApi/JustSaying.Sample.Restaurant.OrderingApi.csproj

JustSaying.Sample.Restaurant.OrderingApi/Program.cs

JustSaying.Sample.Restaurant.OrderingApi/Startup.cs

martincostello · 2019-03-17T12:33:35Z

JustSaying.Sample.Restaurant.OrderingApi/Startup.cs

+                    else
+                    {
+                        // The real AWS environment will require some means of authentication
+                        //x.WithBasicCredentials("###", "###");


As above regarding user secrets.

JustSaying.Sample.Restaurant.OrderingApi/Controllers/OrdersController.cs

JustSaying.Sample.Restaurant.OrderingApi/Subscriber.cs

PeterKneale · 2019-03-19T10:14:35Z

Further feedback welcome

martincostello · 2019-03-19T10:20:04Z

@PeterKneale Thanks for your work on this. When I get some time today or tomorrow, I'll pull your branch locally and have a play around with what's there so far. 👍

PeterKneale · 2019-03-19T10:27:28Z

Sure thing. Thanks for a great library

README.md

JustSaying.Sample.Restaurant.KitchenConsole/OrderPlacedEventHandler.cs

JustSaying.Sample.Restaurant.KitchenConsole/Program.cs

JustSaying.Sample.Restaurant.Models/JustSaying.Sample.Restaurant.Models.csproj

JustSaying.Sample.Restaurant.OrderingApi/Startup.cs

JustSaying.Sample.Restaurant.OrderingApi/Subscriber.cs

martincostello · 2019-03-24T15:53:42Z

I've cloned the the sample locally and had a play around with it. Here's a few bits of feedback on specifics, but overall this is pretty good.

I think rather than Swagger and an "API", we should have a simple one-page MVC app with Bootstrap added, then when you run the sample it can present a UI where the order can be picked from a few options (e.g. pizza, curry, burger, etc.) with a few simple JavaScript calls to post the order and poll for and update (simple meta refresh?) when the "kitchen" says it is ready.

This is more natural to navigate that doing a manual HTTP POST in the Swagger UI and provides feedback that's a bit more visual that watching two consoles, though that's still there for a more "low level" view.

I'd also add some additional handlers that simulates payment and store the order in an in-memory database in the web app to persist things. Then if messages fail the process can be potentially recovered by leveraging the reliability of building on top of a messaging system. This would also demonstrate things like have multiple subscriptions to the same queue for different purposes.

Then we can flesh out the sample with a few extra handlers/processes, something like:

User creates order in UI via POST to back-end
UI back-end publishes "placed" message to queue
UI back-end receives "placed" message and stores in in-memory database
User "pays" for the order in the UI via POST to back-end
UI back-end publishes "paid" message to topic
UI back-end receives "paid" message and updates order in in-memory database with new state
UI updates to show the user payment made and restaurant is awaiting confirmation
Separate handler receives "paid" message and sends order to restaurant queue.
Restaurant handler receives "order" message and sends "accepted" message to topic
UI back-end receives "accepted" message and updates order in in-memory database with new state
UI updates to show the user the order has been "accepted" by the restaurant to be cooked

JustSaying.Sample.Restaurant.KitchenConsole/Program.cs

JustSaying.Sample.Restaurant.OrderingApi/Startup.cs

PeterKneale · 2019-04-13T03:39:45Z

I've addressed your basic feedback. I like the idea about building the web frontend and demonstrating a more thorough workflow.. I'm wondering what delivers the most advantage because I've got limited time.

An area that I think also really needs to be added is an example of how to build dockerised system tests.
ie:

A docker compose file/s consisting of
- p4tin/goaws
- sql
- OrderingApi
- KitchenConsole
- XUnit System Tests
The system tests can publish an event, then patiently await an expected outcome in the database for a few seconds.
The tests could perform a HTTP POST to the API, then patiently await an expected outcome in the database for a few seconds.
I'm doing this at work at the moment and it feels like one of the only ways to test the interaction of multiple services but would welcome any other ideas.

martincostello · 2019-04-13T07:18:48Z

I think it's fine to keep the scope more confined here, than my original suggestion/comments. That way this delivers value into master sooner, and then it can be iterated on over time to have the option of a more "interactive" sample as well as the lower-level one here.

Otherwise what you've alluded to above sounds reasonable. Often the acceptance/integration/system tests for our own workers that use JustSaying involve observing the side effects of the implementation details for message publishing and consumption (e.g. a record appears in a database).

JustSaying.Sample.Restaurant.KitchenConsole/ConfigurationExtensions.cs

JustSaying.Sample.Restaurant.KitchenConsole/JustSaying.Sample.Restaurant.KitchenConsole.csproj

JustSaying.Sample.Restaurant.KitchenConsole/OrderPlacedEventHandler.cs

martincostello · 2019-04-13T07:23:23Z

JustSaying.Sample.Restaurant.KitchenConsole/Program.cs

+            await new HostBuilder()
+                .ConfigureAppConfiguration((hostContext, config) =>
+                {
+                    config.SetBasePath(AppContext.BaseDirectory);


Is there a method on HostBuilder anywhere that does all this by default? WebHostBuilder does similar (or comes preconfigured that way), so would shave off a few lines of code if it's not needed or there's a one-liner.

Just removing it seems to work...
executing this from the projects folder works
dotnet run
as does this from the solution root
dotnet run --project samples/JustSaying.Sample.Restaurant.KitchenConsole/JustSaying.Sample.Restaurant.KitchenConsole.csproj

JustSaying.Sample.Restaurant.OrderingApi/ConfigurationExtensions.cs

JustSaying.Sample.Restaurant.OrderingApi/Properties/launchSettings.json

martincostello · 2019-04-13T07:31:28Z

@PeterKneale Just some minor comments around naming and comments, otherwise this looks really good.

We're planning on moving the code around soon to tidy up the mess of folders that's arisen over time into a src, tests structure as has become a .NET Core "standard" recently. As an initial step towards that, could you move all the new things into a samples folder in the repo root please, instead of putting them directly at the root? That'll save the extra churn later when we shift things around.

Again, thanks for all your work on this! 👍

PeterKneale · 2019-04-13T08:18:39Z

moved to samples folder
addressed feedback
squashed & pushed
will add bootstrap skeleton and remove swashbuckle in another PR later tonight if i get a chance and start iterating towards a more complete sample over time

Added a sample application consisting of three projects - a web api that publishes from a controller and subscribes via a background service - a console application that subscribes via a background service and publishes within an event handler - a shared models assembly containing messages

PeterKneale · 2019-04-13T08:35:49Z

samples/JustSaying.Sample.Restaurant.KitchenConsole/appsettings.json

+  "AWSRegion": "eu-west-1",
+  "AWSServiceUrl": "http://localhost:4100",
+  "Logging": {
+    "LogLevel": {


Should I be able to add "EventLog": "Trace" here and have the messages contents logged?

I think so - at some point in v7 we need to rename that, because it's easy to confuse with the Windows Event Log.

martincostello · 2019-04-13T09:00:50Z

samples/JustSaying.Sample.Restaurant.KitchenConsole/appsettings.json

+  "AWSRegion": "eu-west-1",
+  "AWSServiceUrl": "http://localhost:4100",
+  "Logging": {
+    "LogLevel": {


I think so - at some point in v7 we need to rename that, because it's easy to confuse with the Windows Event Log.

martincostello · 2019-04-13T09:02:54Z

I think I'm happy with this as it is as a starting point. If the rest of the maintainers are happy, I think we could get this merged next week and further changes can be done in follow-up PRs over time.

PeterKneale · 2019-04-13T09:54:14Z

👍

slang25

I'm more than happy with this, fantastic work!

martincostello · 2019-04-17T13:38:38Z

@PeterKneale Is there any more you're planning to do as part of this PR to justify the WIP status still, or should we merge this?

PeterKneale · 2019-04-17T22:10:34Z

Ready to merge - I cant remove the WIP label.

martincostello · 2019-04-18T07:54:20Z

Excellent work @PeterKneale!

PeterKneale requested a review from a team as a code owner March 16, 2019 11:57

PeterKneale commented Mar 16, 2019

View reviewed changes

martincostello added the enhancement label Mar 16, 2019

martincostello added this to the v7.0.0 milestone Mar 16, 2019

martincostello reviewed Mar 16, 2019

View reviewed changes

martincostello added the WIP label Mar 16, 2019

martincostello changed the title ~~Add sample application~~ [WIP] Add sample application Mar 16, 2019

slang25 reviewed Mar 16, 2019

View reviewed changes

martincostello reviewed Mar 17, 2019

View reviewed changes

martincostello mentioned this pull request Mar 17, 2019

Sample application #476

Closed

AnthonySteele reviewed Mar 18, 2019

View reviewed changes

JustSaying.Sample.Restaurant.OrderingApi/Controllers/OrdersController.cs Outdated Show resolved Hide resolved

AnthonySteele reviewed Mar 18, 2019

View reviewed changes

JustSaying.Sample.Restaurant.OrderingApi/Subscriber.cs Outdated Show resolved Hide resolved

martincostello reviewed Mar 24, 2019

View reviewed changes

README.md Outdated Show resolved Hide resolved

martincostello reviewed Mar 24, 2019

View reviewed changes

martincostello mentioned this pull request Mar 24, 2019

Add anonymous credentials method #528

Merged

martincostello reviewed Mar 25, 2019

View reviewed changes

JustSaying.Sample.Restaurant.KitchenConsole/Program.cs Outdated Show resolved Hide resolved

JustSaying.Sample.Restaurant.OrderingApi/Startup.cs Outdated Show resolved Hide resolved

martincostello reviewed Apr 13, 2019

View reviewed changes

PeterKneale commented Apr 13, 2019

View reviewed changes

martincostello approved these changes Apr 13, 2019

View reviewed changes

slang25 approved these changes Apr 13, 2019

View reviewed changes

adammorr approved these changes Apr 17, 2019

View reviewed changes

PeterKneale changed the title ~~[WIP] Add sample application~~ Add sample application Apr 17, 2019

slang25 removed the WIP label Apr 17, 2019

martincostello merged commit f3a05e3 into justeattakeaway:master Apr 18, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add sample application #527

Add sample application #527

PeterKneale commented Mar 16, 2019 •

edited

Loading

codecov bot commented Mar 16, 2019 •

edited

Loading

martincostello left a comment

slang25 left a comment

PeterKneale commented Mar 17, 2019

martincostello Mar 17, 2019

PeterKneale Mar 19, 2019

PeterKneale Mar 19, 2019

martincostello Mar 19, 2019

PeterKneale Mar 19, 2019

martincostello Mar 17, 2019

PeterKneale commented Mar 19, 2019

martincostello commented Mar 19, 2019

PeterKneale commented Mar 19, 2019

martincostello commented Mar 24, 2019

PeterKneale commented Apr 13, 2019

martincostello commented Apr 13, 2019

martincostello Apr 13, 2019

PeterKneale Apr 13, 2019 •

edited

Loading

martincostello commented Apr 13, 2019

PeterKneale commented Apr 13, 2019

PeterKneale Apr 13, 2019

martincostello Apr 13, 2019

martincostello Apr 13, 2019

martincostello commented Apr 13, 2019

PeterKneale commented Apr 13, 2019

slang25 left a comment

martincostello commented Apr 17, 2019

PeterKneale commented Apr 17, 2019

martincostello commented Apr 18, 2019

Add sample application #527

Add sample application #527

Conversation

PeterKneale commented Mar 16, 2019 • edited Loading

codecov bot commented Mar 16, 2019 • edited Loading

Codecov Report

martincostello left a comment

Choose a reason for hiding this comment

slang25 left a comment

Choose a reason for hiding this comment

PeterKneale commented Mar 17, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

PeterKneale commented Mar 19, 2019

martincostello commented Mar 19, 2019

PeterKneale commented Mar 19, 2019

martincostello commented Mar 24, 2019

PeterKneale commented Apr 13, 2019

martincostello commented Apr 13, 2019

Choose a reason for hiding this comment

PeterKneale Apr 13, 2019 • edited Loading

Choose a reason for hiding this comment

martincostello commented Apr 13, 2019

PeterKneale commented Apr 13, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

martincostello commented Apr 13, 2019

PeterKneale commented Apr 13, 2019

slang25 left a comment

Choose a reason for hiding this comment

martincostello commented Apr 17, 2019

PeterKneale commented Apr 17, 2019

martincostello commented Apr 18, 2019

PeterKneale commented Mar 16, 2019 •

edited

Loading

codecov bot commented Mar 16, 2019 •

edited

Loading

PeterKneale Apr 13, 2019 •

edited

Loading