#58 envent handler comments

Zuehlke · Jun 7, 2020 · e5bb7da · e5bb7da
1 parent c68b329
commit e5bb7da
Show file tree

Hide file tree

Showing 15 changed files with 67 additions and 16 deletions.
diff --git a/server/docu/commandAndEventDocu.md b/server/docu/commandAndEventDocu.md
@@ -1,5 +1,5 @@
 # Poinz Command and Event Docu
-This is an autogenerated docu. 6/7/2020, 12:23:12 PM
+This is an autogenerated docu. 6/7/2020, 4:05:11 PM
 
 ## Commands
 
@@ -818,7 +818,7 @@ Produced by: **[addStory](#addStory)** **[selectStory](#selectStory)**
 Description
 
 ```text
-
+Store id of given story as "selectedStory"
 ```
 
 
@@ -831,7 +831,7 @@ Produced by: **[changeStory](#changeStory)**
 Description
 
 ```text
-
+Title and/or Description of story changed
 ```
 
 
@@ -844,7 +844,7 @@ Produced by: **[clearStoryEstimate](#clearStoryEstimate)**
 Description
 
 ```text
-
+Removes a previously set estimation value on the given story for the given user
 ```
 
 
@@ -857,7 +857,10 @@ Produced by: **[createRoom](#createRoom)**
 Description
 
 ```text
-
+A room was created. Creates a new default room object
+@param room
+@param eventPayload
+@return {}
 ```
 
 
@@ -870,7 +873,7 @@ Produced by: **[createRoom](#createRoom)** **[joinRoom](#joinRoom)**
 Description
 
 ```text
-
+Adds user object with given userId to "users" list on room
 ```
 
 
@@ -909,7 +912,7 @@ Produced by: **[deleteStory](#deleteStory)**
 Description
 
 ```text
-
+Removes matching story from "stories" list in room
 ```
 
 
@@ -922,7 +925,7 @@ Produced by: **[giveStoryEstimate](#giveStoryEstimate)**
 Description
 
 ```text
-
+Stores the given estimation value on the story for the given user
 ```
 
 
@@ -950,7 +953,7 @@ Produced by: **[giveStoryEstimate](#giveStoryEstimate)**
 Description
 
 ```text
-
+Stores consensus estimation value (that everybody agreed on) on story.
 ```
 
 
@@ -963,7 +966,7 @@ Produced by: **[joinRoom](#joinRoom)** **[toggleExclude](#toggleExclude)**
 Description
 
 ```text
-
+Sets "excluded" flag on user to true
 ```
 
 
@@ -976,7 +979,8 @@ Produced by: **[kick](#kick)**
 Description
 
 ```text
-
+removes user from "users" list
+removes estimations on all stories that were given by user
 ```
 
 
@@ -989,7 +993,7 @@ Produced by: **[leaveRoom](#leaveRoom)**
 Description
 
 ```text
-
+Marks user as "disconnected".
 ```
 
 
@@ -1002,7 +1006,8 @@ Produced by: **[leaveRoom](#leaveRoom)**
 Description
 
 ```text
-
+removes user from "users" list
+removes estimations on all stories that were given by user
 ```
 
 
@@ -1015,7 +1020,7 @@ Produced by: **[newEstimationRound](#newEstimationRound)**
 Description
 
 ```text
-
+Clears all estimations on story, sets "revealed" flag to false and erases "consensus"
 ```
 
 
@@ -1028,7 +1033,7 @@ Produced by: **[toggleExclude](#toggleExclude)**
 Description
 
 ```text
-
+Sets "excluded" flag on user to false
 ```
 
 

diff --git a/server/src/eventHandlers/connectionLost.js b/server/src/eventHandlers/connectionLost.js
@@ -1,3 +1,6 @@
+/**
+ * Marks user as "disconnected".
+ */
 const connectionLostEventHandler = (room, eventPayload) => {
   const matchingUser = room.getIn(['users', eventPayload.userId]);
   if (matchingUser) {

diff --git a/server/src/eventHandlers/consensusAchieved.js b/server/src/eventHandlers/consensusAchieved.js
@@ -1,3 +1,6 @@
+/**
+ * Stores consensus estimation value (that everybody agreed on) on story.
+ */
 const consensusAchievedEventHandler = (room, eventPayload) =>
   room.setIn(['stories', eventPayload.storyId, 'consensus'], eventPayload.value);
 

diff --git a/server/src/eventHandlers/excludedFromEstimations.js b/server/src/eventHandlers/excludedFromEstimations.js
@@ -1,3 +1,6 @@
+/**
+ * Sets "excluded" flag on user to true
+ */
 const excludedFromEstimationsEventHandler = (room, eventPayload) =>
   room.updateIn(['users', eventPayload.userId], (user) => user.set('excluded', true));
 

diff --git a/server/src/eventHandlers/includedInEstimations.js b/server/src/eventHandlers/includedInEstimations.js
@@ -1,3 +1,6 @@
+/**
+ * Sets "excluded" flag on user to false
+ */
 const includedInEstimationsEventHandler = (room, eventPayload) =>
   room.updateIn(['users', eventPayload.userId], (user) => user.set('excluded', false));
 

diff --git a/server/src/eventHandlers/joinedRoom.js b/server/src/eventHandlers/joinedRoom.js
@@ -1,5 +1,8 @@
 import Immutable from 'immutable';
 
+/**
+ * Adds user object with given userId to "users" list on room
+ */
 const joinedRoomEventHandler = (room, eventPayload) =>
   room.setIn(['users', eventPayload.userId], new Immutable.Map({id: eventPayload.userId}));
 

diff --git a/server/src/eventHandlers/kicked.js b/server/src/eventHandlers/kicked.js
@@ -1,3 +1,7 @@
+/**
+ * removes user from "users" list
+ * removes estimations on all stories that were given by user
+ */
 const kickedEventHandler = (room, eventPayload) =>
   room
     .update('stories', (stories) =>

diff --git a/server/src/eventHandlers/leftRoom.js b/server/src/eventHandlers/leftRoom.js
@@ -1,3 +1,7 @@
+/**
+ * removes user from "users" list
+ * removes estimations on all stories that were given by user
+ */
 const leftRoomEventHandler = (room, eventPayload) =>
   room
     .update('stories', (stories) =>

diff --git a/server/src/eventHandlers/newEstimationRoundStarted.js b/server/src/eventHandlers/newEstimationRoundStarted.js
@@ -1,5 +1,8 @@
 import Immutable from 'immutable';
 
+/**
+ * Clears all estimations on story, sets "revealed" flag to false and erases "consensus"
+ */
 const newEstimationRoundStartedEventHandler = (room, eventPayload) =>
   room
     .setIn(['stories', eventPayload.storyId, 'estimations'], new Immutable.Map())

diff --git a/server/src/eventHandlers/roomCreated.js b/server/src/eventHandlers/roomCreated.js
@@ -1,6 +1,11 @@
 import Immutable from 'immutable';
 
-// here we create the room object
+/**
+ * A room was created. Creates a new default room object
+ * @param room
+ * @param eventPayload
+ * @return {*}
+ */
 const roomCreatedEventHandler = (room, eventPayload) =>
   Immutable.fromJS({
     id: eventPayload.id,

diff --git a/server/src/eventHandlers/storyChanged.js b/server/src/eventHandlers/storyChanged.js
@@ -1,3 +1,6 @@
+/**
+ * Title and/or Description of story changed
+ */
 const storyChangedEventHandler = (room, eventPayload) =>
   // for now, the changeStory command must contain always both attributes (see validation schema)
   // so we can just overwrite both

diff --git a/server/src/eventHandlers/storyDeleted.js b/server/src/eventHandlers/storyDeleted.js
@@ -1,3 +1,6 @@
+/**
+ * Removes matching story from "stories" list in room
+ */
 const storyDeletedEventHandler = (room, eventPayload) =>
   room.removeIn(['stories', eventPayload.storyId]);
 

diff --git a/server/src/eventHandlers/storyEstimateCleared.js b/server/src/eventHandlers/storyEstimateCleared.js
@@ -1,3 +1,6 @@
+/**
+ * Removes a previously set estimation value on the given story for the given user
+ */
 const storyEstimateClearedEventHandler = (room, eventPayload) =>
   room.removeIn(['stories', eventPayload.storyId, 'estimations', eventPayload.userId]);
 

diff --git a/server/src/eventHandlers/storyEstimateGiven.js b/server/src/eventHandlers/storyEstimateGiven.js
@@ -1,3 +1,6 @@
+/**
+ * Stores the given estimation value on the story for the given user
+ */
 const storyEstimateGivenEventHandler = (room, eventPayload) =>
   room.setIn(
     ['stories', eventPayload.storyId, 'estimations', eventPayload.userId],

diff --git a/server/src/eventHandlers/storySelected.js b/server/src/eventHandlers/storySelected.js
@@ -1,3 +1,6 @@
+/**
+ * Store id of given story as "selectedStory"
+ */
 const storySelectedEventHandler = (room, eventPayload) =>
   room.set('selectedStory', eventPayload.storyId);