Skip to content

Commit

Permalink
first drafte blackbox descriptionfirst drafte blackbox descriptionss
Browse files Browse the repository at this point in the history
  • Loading branch information
Marc Gorzala committed Nov 26, 2023
1 parent b0da974 commit 1be27eb
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 8 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -87,14 +87,14 @@ Additionally the Dancer emits Business Events for every interessting use case th
[cols="h,4", stripes=none]
|===
|Purpose
|Identifiy all Pair of dancers that are likely to constitute a good dancing couple.
|Identify all Pairs of dancers that are likely to constitute a good dancing couple.

|Input
|Interface

The Recommendation System reads once a day, all profile updated events. Computes all scores new and offer them via a REST-Endpoint.
|The Recommendation System reads once a day, all profile updated events. Computes all scores new and offers them via a REST-Endpoint.

|Risks
|Computing Score only once a day could become to bad for our customers and we have to refactor to a degree, that you can call it more a rewrite.
|Computing Score only once a day could become to bad for our customers and we have to refactor to a degree, that you can call it more of a rewrite.

|Repo
|https://github.com/dancier/recommendation
Expand All @@ -109,11 +109,11 @@ The Recommendation System reads once a day, all profile updated events. Computes
|This is the backend for al chat related functionality

|Interface
|Ist being invoked by dancer via its REST-API to create/maintain chats. Write Businsess Event to Kafka in all interessting cases like chat-created, message created, message read. They are meant to be consumed by other systems to eg. determine if you should write the customer an e-mail to inform him about a new chat message...
|Ist being invoked by the dancer via its REST-API to create/maintain chats. Write <<BusinessEvent>> to Kafka in all interesting cases like ChatCreated, and MessageReceived. They are meant to be consumed by other systems eg. to determine if you should write the customer an e-mail to inform him about a new chat message...

|Risks
|Maybe we could have found an open-source chat backend. We decided against it, as we considered the effort to ingegrate a third party tool, could be on par with the effort implemtend basic funtionality. If this would be the case, than we would be more flexible with our own solution.
But this was mostly grounded and bare assumpptions.
|Maybe we could have found an open-source chat backend. We decided against it, as we considered the effort to integrate a third-party tool, could be on par with the effort to implement basic functionality. If this would be the case, then we would be more flexible with our solution.
But this was mostly grounded and bare assumptions.

|Repo
|https://github.com/dancier/chat-dancer
Expand All @@ -129,7 +129,9 @@ But this was mostly grounded and bare assumpptions.
|Send out mail to Danciers stakeholder

|Interface
Read Business Events from all other systems like:

a|Read Business Events from all other systems like:

* when a user logs in
* when a user is active
* when a user changes it's profile
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,15 @@
[options="header"]
|===
| Term | Definition
| [[BusinessEvent]]Buisiness Event

a| An Event that is being sent out to Kafka, exactly after something interesting has happened. Like:

* AccountValidated
* ProfileUpdated
* RecommendationComputed
* ChatMessageReceived

| [[profile]]Profile a| All the information that the dancer provides about himself. Those are things like:

* age
Expand Down

0 comments on commit 1be27eb

Please sign in to comment.