Skip to content

Commit ccf2fdb

Browse files
AlexWeinstein92AlexWeinstein92
authored
Connector Warnings Cleanup (#74)
* org, product connectors * member, reservation, store connectors * tenant, event connectors * revert conf * don't show missing warnings * revert conf
1 parent ab3806a commit ccf2fdb

17 files changed

+370
-136
lines changed

‎src/main/riddl/Events/Reservations/reservation.riddl

+3-9
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,7 @@ type ReservationId is Id (ImprovingApp.Events.ReservationContext.Reservation)
44
context ReservationContext is {
55
include "reservationTypeDefinitions"
66
include "reservationMessages"
7-
8-
// TODO: List the names of the public reservation events here
9-
type PublicReservationEvent is one of {
10-
???
11-
}
12-
13-
outlet Events is type PublicReservationEvent
7+
include "reservationSources"
148

159
entity Reservation is {
1610
option event-sourced
@@ -22,7 +16,7 @@ context ReservationContext is {
2216
record ImprovingApp.Events.ReservationContext.Reservation.DraftState
2317
"Copy fields from the command into Draft fields"
2418
"adjust meta fields to reflect the change set"
25-
send event ReservationEstablished to outlet ReservationContext.Events
19+
send event ReservationEstablished to outlet ReservationEventsSource.Events
2620
}
2721
on other {
2822
error "Only EstablishReservation command is allowed in the default state"
@@ -41,7 +35,7 @@ context ReservationContext is {
4135
}
4236
on command ImprovingApp.Events.ReservationContext.EditReservationInfo {
4337
set field ImprovingApp.Events.ReservationContext.Reservation.Draft.reservationInfo to "EditReservationInfo.info"
44-
send event ReservationInfoUpdated to outlet ReservationContext.Events
38+
send event ReservationInfoUpdated to outlet ReservationEventsSource.Events
4539
}
4640
on command ImprovingApp.Events.ReservationContext.UpdateReservationStatus {
4741
"morph entity Reservation to state provided in UpdateReservationStatus"

‎src/main/riddl/Events/Reservations/reservationSources.riddl

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
connector ReservationCommandsChannel is {
2+
from outlet ReservationCommandsSource.Commands to
3+
inlet ReservationCommandsSink.Commands
4+
}
5+
6+
connector ReservationEventsChannel is {
7+
from outlet ReservationEventsSource.Events to
8+
inlet ReservationEventsSink.Events
9+
}
10+
11+
source ReservationCommandsSource is {
12+
outlet Commands is type ReservationCommand
13+
}
14+
15+
sink ReservationCommandsSink is {
16+
inlet Commands is type ReservationCommand
17+
}
18+
19+
source ReservationEventsSource is {
20+
outlet Events is type ReservationEvent
21+
}
22+
23+
sink ReservationEventsSink is {
24+
inlet Events is type ReservationEvent
25+
}
26+
27+
type ReservationCommand is one of {
28+
EstablishReservation,
29+
EditReservationInfo,
30+
UpdateReservationStatus,
31+
DeleteReservation,
32+
GetReservationInfo
33+
}
34+
35+
type ReservationEvent is one of {
36+
ReservationEstablished,
37+
ReservationInfoUpdated,
38+
ReservationStatusUpdated,
39+
ReservationDeleted,
40+
ReservationInfoResult
41+
}

‎src/main/riddl/Events/eventContext.riddl

+19-19
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ context EventContext is {
66
include "eventTypeDefinitions"
77
include "eventSources"
88

9-
function incrementDelayedEventTime is {
9+
function IncrementDelayedEventTime is {
1010
requires {originalTime: DateTime, duration: Duration}
1111
returns { newTime: DateTime }
1212
body ???
@@ -41,7 +41,7 @@ context EventContext is {
4141

4242
handler EventHandler is {
4343
on command CreateEvent {
44-
send event EventCreated to outlet EventEvents.Events
44+
send event EventCreated to outlet EventEventsSource.Events
4545
morph entity Event to state DraftEvent with record DraftEventState
4646
}
4747
on other {
@@ -60,20 +60,20 @@ context EventContext is {
6060
on command ScheduleEvent{
6161
if "all required info fields are present" then {
6262
"set a scheduled Akka call for emitting StartEvent at DraftEventState.info.expectedStart"
63-
send event EventScheduled to outlet EventEvents.Events
63+
send event EventScheduled to outlet EventEventsSource.Events
6464
morph entity Event to state ScheduledEvent with record ScheduledEventState
6565
}
6666
}
6767
on command EditEventInfo{
6868
set field DraftEventState.info to "EventContext.newEditableInfoFromFieldsPresentInEditable"
6969
set field DraftEventState.meta to "EventMetaInfo"
7070
send event EventRescheduled
71-
to outlet EventEvents.Events
71+
to outlet EventEventsSource.Events
7272
}
7373
on command CancelEvent{
7474
if "all required info fields are present" then {
7575
"cancel associated scheduled call to emit StartEvent"
76-
send event EventCancelled to outlet EventEvents.Events
76+
send event EventCancelled to outlet EventEventsSource.Events
7777
morph entity Event to state ScheduledEvent with record ScheduledEventState
7878
}
7979
}
@@ -82,13 +82,13 @@ context EventContext is {
8282
"adjust associated scheduled call to emit StartEvent"
8383
set field DraftEventState.info to "EditableEventInfo"
8484
set field DraftEventState.meta to "EventMetaInfo"
85-
send event EventRescheduled to outlet EventEvents.Events
85+
send event EventRescheduled to outlet EventEventsSource.Events
8686
}
8787
}
8888
on command DelayEvent{
8989
if "all required info fields are present" then {
9090
"adjust associated scheduled call to emit StartEvent"
91-
send event EventDelayed to outlet EventEvents.Events
91+
send event EventDelayed to outlet EventEventsSource.Events
9292
morph entity Event to state ScheduledEvent with record ScheduledEventState
9393
}
9494
}
@@ -127,29 +127,29 @@ context EventContext is {
127127
on command EditEventInfo {
128128
set field ScheduledEventState.info to "EventContext.newInfoFromFieldsPresentInEditable"
129129
set field ScheduledEventState.meta to "EventMetaInfo"
130-
send event EventInfoEdited to outlet EventEvents.Events
130+
send event EventInfoEdited to outlet EventEventsSource.Events
131131
}
132132
on command CancelEvent {
133133
"cancel associated scheduled call to emit StartEvent"
134-
send event EventCancelled to outlet EventEvents.Events
134+
send event EventCancelled to outlet EventEventsSource.Events
135135
become entity Event to handler CancelledEventHandler
136136
}
137137
on command DelayEvent {
138138
"adjust associated scheduled Akka call to emit StartEvent"
139-
send event EventDelayed to outlet EventEvents.Events
139+
send event EventDelayed to outlet EventEventsSource.Events
140140
become entity Event to handler DelayedEventHandler
141141
}
142142
on command StartEvent{
143143
"create scheduled Akka call using ScheduledEventState.info.expectedEnd to emit EndEvent"
144-
send event EventStarted to outlet EventEvents.Events
144+
send event EventStarted to outlet EventEventsSource.Events
145145
become entity Event to handler InProgressEventHandler
146146
} briefly "to be invoked by Akka scheduler upon ScheduleEvent reception"
147147
on command RescheduleEvent {
148148
if "start is validated to be before end in command" then {
149149
"adjust associated scheduled call to emit StartEvent"
150150
set field ScheduledEventState.info to "EventInfo"
151151
set field ScheduledEventState.meta to "EventMetaInfo"
152-
send event EventRescheduled to outlet EventEvents.Events
152+
send event EventRescheduled to outlet EventEventsSource.Events
153153
}
154154
}
155155
on command EndEvent{
@@ -178,14 +178,14 @@ context EventContext is {
178178
}
179179
on command DelayEvent{
180180
"adjust associated scheduled Akka call to emit StartEvent"
181-
send event EventDelayed to outlet EventEvents.Events
181+
send event EventDelayed to outlet EventEventsSource.Events
182182
become entity Event to handler DelayedEventHandler
183183
}
184184
on command StartEvent {
185185
error "Event is already started. Cannot start an event that is already in progress"
186186
}
187187
on command EndEvent {
188-
send event EventEnded to outlet EventEvents.Events
188+
send event EventEnded to outlet EventEventsSource.Events
189189
become entity Event to handler PastEventHandler
190190
}
191191
// TODO: specify AddLiveUpdate on clause
@@ -203,27 +203,27 @@ context EventContext is {
203203
on command EditEventInfo{
204204
set field ScheduledEventState.info to "EventContext.newInfoFromFieldsPresentInEditable"
205205
set field ScheduledEventState.meta to "EventMetaInfo"
206-
send event EventInfoEdited to outlet EventEvents.Events
206+
send event EventInfoEdited to outlet EventEventsSource.Events
207207
}
208208
on command CancelEvent{
209209
"cancel associated scheduled call to emit StartEvent"
210-
send event EventCancelled to outlet EventEvents.Events
210+
send event EventCancelled to outlet EventEventsSource.Events
211211
become entity Event to handler CancelledEventHandler
212212
}
213213
on command RescheduleEvent{
214214
if "start is validated to be before end in command" then {
215215
"adjust associated scheduled call to emit StartEvent"
216216
set field ScheduledEventState.info to "EventInfo"
217217
set field ScheduledEventState.meta to "EventMetaInfo"
218-
send event EventRescheduled to outlet EventEvents.Events
218+
send event EventRescheduled to outlet EventEventsSource.Events
219219
}
220220
}
221221
on command DelayEvent{
222222
error "Cannot delay a delayed event again, must be rescheduled"
223223
}
224224
on command StartEvent{
225225
"create scheduled Akka call using ScheduledEventState.info.expectedEnd to emit EndEvent"
226-
send event EventStarted to outlet EventEvents.Events
226+
send event EventStarted to outlet EventEventsSource.Events
227227
become entity Event to handler InProgressEventHandler
228228
} briefly "to be invoked by Akka scheduler upon ScheduleEvent reception"
229229
on command EndEvent{
@@ -240,7 +240,7 @@ context EventContext is {
240240
"adjust associated scheduled call to emit StartEvent"
241241
set field ScheduledEventState.info to "EventInfo"
242242
set field ScheduledEventState.meta to "EventMetaInfo"
243-
send event EventRescheduled to outlet EventEvents.Events
243+
send event EventRescheduled to outlet EventEventsSource.Events
244244
}
245245
}
246246
on other {

‎src/main/riddl/Events/eventSources.riddl

+53-19
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,56 @@
1-
source LiveUpdates is {
2-
outlet Updates is type LiveUpdate
3-
} explained as "This is a source for things that happen as an event progresses"
4-
5-
// plant EventPlant is {
6-
// pipe EventPipe is {???}
7-
// }
1+
// source LiveUpdates is {
2+
// outlet Updates is type LiveUpdate
3+
// } explained as "This is a source for things that happen as an event progresses"
84

95
//ReservationAddedToEvent,
10-
type PublicEventEvent is one of {
11-
Events.EventContext.EventInfoEdited,
12-
Events.EventContext.EventCreated,
13-
Events.EventContext.EventScheduled,
14-
Events.EventContext.EventCancelled,
15-
Events.EventContext.EventRescheduled,
16-
Events.EventContext.EventDelayed,
17-
Events.EventContext.EventStarted,
18-
Events.EventContext.EventEnded
6+
7+
connector EventCommandsChannel is {
8+
from outlet EventCommandsSource.Commands to
9+
inlet EventCommandsSink.Commands
10+
}
11+
12+
connector EventEventsChannel is {
13+
from outlet EventEventsSource.Events to
14+
inlet EventEventsSink.Events
15+
}
16+
17+
source EventCommandsSource is {
18+
outlet Commands is type EventCommand
19+
}
20+
21+
sink EventCommandsSink is {
22+
inlet Commands is type EventCommand
1923
}
20-
source EventEvents is {
21-
outlet Events is type PublicEventEvent
22-
} explained as "This is a source for event from Events entities"
24+
25+
source EventEventsSource is {
26+
outlet Events is type EventEvent
27+
}
28+
29+
sink EventEventsSink is {
30+
inlet Events is type EventEvent
31+
}
32+
33+
type EventCommand is one of {
34+
EditEventInfo,
35+
CreateEvent,
36+
ScheduleEvent,
37+
CancelEvent,
38+
RescheduleEvent,
39+
DelayEvent,
40+
StartEvent,
41+
EndEvent,
42+
TerminateEvent,
43+
AddLiveUpdate
44+
}
45+
46+
type EventEvent is one of {
47+
EventInfoEdited,
48+
EventCreated,
49+
EventScheduled,
50+
EventCancelled,
51+
EventRescheduled,
52+
EventDelayed,
53+
EventStarted,
54+
EventEnded,
55+
EventTerminated
56+
}

‎src/main/riddl/Gateway/ReservationGateway/reservationStories.riddl

+2-2
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@ epic CreateReservation {
1111
step from user GatewayAPI "Create Reservation" to entity ImprovingApp.Events.ReservationContext.Reservation
1212
briefly "create reservation"
1313
step send event ImprovingApp.Events.ReservationContext.ReservationEstablished
14-
from entity ImprovingApp.Events.ReservationContext.Reservation to source ImprovingApp.Events.ReservationContext.PublicReservationEvent
14+
from entity ImprovingApp.Events.ReservationContext.Reservation to source ImprovingApp.Events.ReservationContext.ReservationEventsSource
1515
briefly "reservation created"
1616
step send event ImprovingApp.Events.ReservationContext.ReservationEstablished
17-
from source ImprovingApp.Events.ReservationContext.PublicReservationEvent to application App
17+
from source ImprovingApp.Events.ReservationContext.ReservationEventsSource to application App
1818
}
1919
} briefly "A story about creating a reservation in Improving.app"
2020
described as "This is the story of how a reservation comes into existence"

‎src/main/riddl/Gateway/gatewayStories.riddl

+2-2
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ epic RegisterMember {
99
briefly "send creation message"
1010
step from context GatewayAPI "Register Member" to entity ImprovingApp.MemberContext.Member
1111
briefly "add new Member"
12-
step send event ImprovingApp.MemberContext.MemberRegistered from entity ImprovingApp.MemberContext.Member to source ImprovingApp.MemberContext.MemberEvents
12+
step send event ImprovingApp.MemberContext.MemberRegistered from entity ImprovingApp.MemberContext.Member to source ImprovingApp.MemberContext.MemberEventsSource
1313
briefly "Member added in Draft state"
14-
step send event ImprovingApp.MemberContext.MemberRegistered from source ImprovingApp.MemberContext.MemberEvents to application App
14+
step send event ImprovingApp.MemberContext.MemberRegistered from source ImprovingApp.MemberContext.MemberEventsSource to application App
1515
//example Foo is {...}
1616
}
1717
} briefly "A story about registering a member in Improving.app"

‎src/main/riddl/ImprovingApp.conf

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,8 @@ command = hugo
55

66
# This block provides options that are common to any command.
77
common = {
8-
show-times = true
98
show-include-times = true
10-
verbose = true
9+
verbose = false
1110
quiet = false
1211
dry-run = false
1312
show-warnings = true
@@ -16,6 +15,7 @@ common = {
1615
show-usage-warnings = false
1716
debug = false
1817
group-by-message-kind = true
18+
warnings-are-fatal = true
1919
}
2020

2121
# This block provides options for the "hugo" command to translate riddl to a hugo web site.

‎src/main/riddl/Members/memberSources.riddl

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
connector MemberCommandsChannel is {
2+
from outlet MemberCommandsSource.Commands to
3+
inlet MemberCommandsSink.Commands
4+
}
5+
6+
connector MemberEventsChannel is {
7+
from outlet MemberEventsSource.Events to
8+
inlet MemberEventsSink.Events
9+
}
10+
11+
source MemberCommandsSource is {
12+
outlet Commands is type MemberCommand
13+
}
14+
15+
sink MemberCommandsSink is {
16+
inlet Commands is type MemberCommand
17+
}
18+
19+
source MemberEventsSource is {
20+
outlet Events is type MemberEvent
21+
}
22+
23+
sink MemberEventsSink is {
24+
inlet Events is type MemberEvent
25+
}
26+
27+
type MemberCommand is one of {
28+
ImprovingApp.MemberContext.RegisterMember,
29+
ImprovingApp.MemberContext.ActivateMember,
30+
ImprovingApp.MemberContext.SuspendMember,
31+
ImprovingApp.MemberContext.TerminateMember,
32+
ImprovingApp.MemberContext.EditMemberInfo,
33+
ImprovingApp.MemberContext.GetMemberData
34+
}
35+
36+
type MemberEvent is one of {
37+
ImprovingApp.MemberContext.MemberRegistered,
38+
ImprovingApp.MemberContext.MemberActivated,
39+
ImprovingApp.MemberContext.MemberSuspended,
40+
ImprovingApp.MemberContext.MemberTerminated,
41+
ImprovingApp.MemberContext.MemberInfoEdited,
42+
ImprovingApp.MemberContext.MemberData
43+
}

0 commit comments

Comments
 (0)