Add comment for patching

microsoft · Jan 12, 2019 · 535d675 · 535d675
1 parent 94a8026
commit 535d675
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/packages/core/src/sagas/incomingActivitySaga.js b/packages/core/src/sagas/incomingActivitySaga.js
@@ -45,6 +45,10 @@ function* observeActivity(directLine, userID) {
 }
 
 function patchActivityWithFromRole(activity, userID) {
+  // Some activities, such as "ConversationUpdate", does not have "from" defined.
+  // And although "role" is defined in Direct Line spec, it was not sent over the wire.
+  // We normalize the activity here to simplify null-check and logic later.
+
   // Patch activity.from.role to make sure its either "bot", "user", or "channel"
   if (!activity.from) {
     activity = updateIn(activity, ['from', 'role'], () => 'channel');