all files / app/engine/ conversationInitializer.js

93.88% Statements 230/245
78.65% Branches 70/89
98.25% Functions 56/57
93.88% Lines 230/245
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405     231×   230×   465×     233× 233× 233× 233× 233× 233× 233× 233× 233× 233×           233×       235×         17× 17×   220× 220×     232× 232× 109×   123×       231× 231× 231× 231×       231× 17×         17× 17× 17×   214×     248×     241×         232× 232× 232× 232×     232× 232× 232× 232× 232× 232×       232× 232×       232× 232× 232×     232× 231× 231×   226×   226×                 118× 118× 118× 118×     117× 117× 117× 117× 117×         17×   17×     15× 15×   15× 15× 40× 40× 40× 236× 236× 236× 232× 232× 232× 232× 232×           236×   236× 251× 251× 251× 251× 251× 251× 250× 250× 15×   235×       251×       236× 236×   236× 235×   235× 235× 235×     235× 134× 131×     101×       101×   101×                       40×         17×   216× 216× 216× 216× 216× 216× 216× 216× 649× 649×   216× 313×   313× 313×   313× 213× 213× 640× 640×       216× 203× 203× 406×     216×           216× 203× 203×   203×   216× 232× 232× 216× 216×   232× 216× 216× 649× 649× 649× 331× 331× 331× 110×     649×     16×     216×         216× 18× 18×   18×     17× 17×           17×   16× 16×     16× 16× 16×       16×                   216× 424× 424× 215× 215× 215× 215×         215×       424×           17×        
var agents = {}
var async = require('async')
var path = require('path')
var messageService = require(path.join('..', 'services', 'messageService'))
var localEmitter = require(path.join('..', 'services', 'localEmitter'))
var events = require('events')
var privateEmitter = new events.EventEmitter()
var socketService = require(path.join('..', 'services', 'socketService'))
var logger = require(path.join('..', 'logger'))
var conversationService = require('./conversationService')
var util = require('util')
var AgentConversation = require('mongoose').model('AgentConversation')
var getAgentConversation = conversationService.restoreAgentConversation
var yaktor = require('../index')
 
var auditLogger = require(path.join('..', 'lib', 'auditLogger'))
 
var noAuth = function (user, agentName, cb) {
  cb(null, true)
}
var noMessageAuth = function (user, event, meta, reqData, cb) {
  cb(null, true)
}
var checkAuth = function (authorized, cb) {
  cb(authorized ? null : new Error('not authorized'))
}
 
var socketEventHandler = function (agent, reqData, event, qId, conversation, user, callback) {
  reqData = reqData || {}
  var meta = {}
  meta.qId = qId
  meta.user = user
  meta.agentDataId = reqData._id
  meta.agentData = reqData
  var agentAuthorize = yaktor.auth && yaktor.auth.agentAuthorize || noAuth
  var messageAuth = agent.messageAuth || noMessageAuth
  logger.silly('%s on event: %s; %s; agentDataId: %s', agent.name.blue, event.yellow, qId, meta.agentDataId.yellowBG)
  async.waterfall([
    async.apply(agentAuthorize, user, agent.name),
    checkAuth,
    async.apply(messageAuth, user, event, meta, reqData),
    checkAuth
  ], function (err) {
    callback(err, meta, agent.name)
  })
}
 
var logError = function (error) {
  Iif (error) {
    logger.error('%s \ncaused by: %s', new Error('transition failure').stack, error.stack)
  }
}
 
var fireEvent = function (meta, data, event, agentName, state) {
  auditLogger.event(meta, new Date(), JSON.stringify(data), agentName, event, state)
  localEmitter.emit(event, meta, data)
}
var firePrivateEvent = function (meta, data, event, agentName, state) {
  auditLogger.event(meta, new Date(), JSON.stringify(data), agentName, event, state)
  privateEmitter.emit(event, meta, data)
}
 
var doTransitionActivationHandler = function (transition, agentConversation, meta, data, done) {
  logger.silly('%s in %s; handler(%s) on: %s', agentConversation.agent.blue, meta.agentDataId.yellowBG, (transition.handler) ? 'true'.green : 'false'.red, transition.causeName.yellow)
  if (transition.handler) {
    transition.handler(transition.causeName, meta, data, done)
  } else {
    done(null, data)
  }
}
 
var emitSocketState = function (agentName, state, toState, meta, data) {
  state = state || {}
  logger.silly('%s in %s; broadcasting(%s) to %s;', agentName.blue, meta.agentDataId.yellowBG, (state.name !== toState.name) ? 'true'.green : 'false'.red, toState.name.magenta)
  Eif (state.name !== toState.name) {
    messageService.emit(agentName + ':state:' + toState.name + ':' + meta.agentDataId, data)
  }
}
 
var doPostTransitionTrigger = function (transition, meta, data, agentName, state, done) {
  if (transition.triggers) {
    Iif (transition.triggers.type === 'InternalPublish') {
      // XXX: no one is Listening")
      logger.silly('emitting ' + agentName.blue + '::' + transition.triggers.name + ':' + meta.agentDataId, data)
      messageService.emit(agentName + '::' + transition.triggers.name + ':' + meta.agentDataId, data)
    }
    logger.silly('%s in %s; sends %s', agentName.blue, meta.agentDataId.yellowBG, transition.triggerName.yellow)
    fireEvent(meta, data, transition.triggers, agentName, state)
    done(null, data)
  } else {
    done(null, data)
  }
}
var doToState = function (agentName, fromState, toState, meta, data, cb) {
  if (toState.on) {
    logger.silly('%s in %s; handler for %s;', agentName.blue, meta.agentDataId.yellowBG, toState.name.magenta)
    // notice the extra argument
    toState.on(meta, data, cb)
  } else {
    cb(null, data)
  }
}
var doDecision = function (agentName, state, meta, data, decision, cb) {
  var ts = state.transitions
  Eif (ts && ts[ decision ]) {
    logger.silly('%s in %s; while %s %s to %s;', agentName.blue, meta.agentDataId.yellowBG, state.name.magenta, 'decided'.cyan, decision.yellow)
    firePrivateEvent(meta, data, ts[ decision ].on, agentName, state.name)
  }
  cb(null, data)
}
var doState = function (agentName, state, transition, agentConversation, meta, oldData, data, done) {
  var oldState = agentConversation.state
  var newState = transition.to.name
  done = done || data
  Iif (done === data) {
    data = oldData
  }
  agentConversation.state = newState
  var action = function (doc, cb) {
    var id = doc._id
    var docToSave = {}
    Eif (doc.toObject) {
      docToSave = doc.toObject()
    } else {
      util._extend(docToSave, doc)
    }
    delete docToSave._id
    AgentConversation.findOneAndUpdate({
      _id: id
    }, docToSave, cb)
  }
  action(agentConversation, function (err, agentConversation) {
    logger.silly('%s in %s; was %s %s %s;', agentName.blue, meta.agentDataId.yellowBG, oldState.magenta, 'becomes'.cyan, transition.to.name.magenta)
    Iif (err) {
      done(err, data)
    } else {
      doToState(agentName, oldState, transition.to, meta, data, function (err, toData, decision) {
        emitSocketState(agentName, oldState, transition.to, meta, toData)
        if (!err && decision) {
          doPostTransitionTrigger(transition, meta, toData, agentName, oldState, function () {
            doDecision(agentName, transition.to, meta, toData, decision, done)
          })
        } else Eif (!err) {
          // XXX should be toData !!
          doPostTransitionTrigger(transition, meta, data, agentName, oldState, done)
        } else {
          done(err, data)
        }
      })
    }
  })
}
 
var emitInit = function (meta, agentName, agentConversation, socket, data) {
  logger.silly('emitting %s:state:%s:%s', agentName.blue, agentConversation.state.magenta, meta.agentDataId.yellowBG)
  logger.silly('emitting %s::agent-init', agentName.blue)
  socket.emit(agentName + '::agent-init', null)
  socket.emit(agentName + ':state:' + agentConversation.state + ':' + meta.agentDataId, data)
}
 
var initAgent = function (agent, meta, socket, data, cb) {
  agent.init(meta, function (agentConversations) {
    var agentName = agent.name
    var agentConversation = agentConversations[ agentName ]
    emitInit(meta, agentName, agentConversation, socket, data)
    cb(null, agentConversation)
  })
}
module.exports = function (conversation, done) {
  var conversationName = conversation.name
  logger.silly('loading conversation %s', conversationName)
  Iif (!conversation.agents) {
    return done()
  }
  async.series([ function (next) {
    async.each(Object.keys(conversation.agents), function (agentName, configDone) {
      var agent = conversation.agents[ agentName ]
      // short circuit if not our conversation
      if (agents[ agentName ] || agent.conversationName !== conversationName) {
        return configDone()
      }
 
      var states = agent.states
      var transitionEvents = agent.transitionEvents
      // Listen to transition events
      agents[ agentName ] = true
      async.each(Object.keys(transitionEvents), function (eventName, transConfigDone) {
        var event = transitionEvents[ eventName ]
        var emitter = eventName.indexOf('.') > -1 ? localEmitter : privateEmitter
        emitter.on(event.label, function (oldMeta, data) {
          var keysMapped = {}
          var originalAgentDataId = oldMeta.agentDataId
          var doFullTrans = function (meta, agentConversation, ftcb) {
            var state = states[ agentConversation.state ]
            var transition = state.transitions[ eventName ]
            logger.debug('%s in %s state %s doing %s ', agentName.blue, meta.agentDataId.yellowBG, agentConversation.state.magenta, transition.description.cyan)
            auditLogger.transition(originalAgentDataId, meta, agentName, agentConversation, transition, data)
            async.waterfall([
              async.apply(doTransitionActivationHandler, transition, agentConversation, meta, data),
              async.apply(doState, agentName, state, transition, agentConversation, meta, data)
            ], ftcb)
          }
 
          async.waterfall([
            function findKeys (cb) {
              async.each(event.states, function (stateName, ccb) {
                var state = states[ stateName ]
                var transition = state.transitions[ eventName ]
                var agentDataId = transition.mapping ? transition.mapping(oldMeta, data) : originalAgentDataId
                var agentDataIds = [].concat(agentDataId)
                agentDataIds.forEach(function (id) {
                  if (id) {
                    var a = keysMapped[ id ]
                    if (a) {
                      a.push(stateName)
                    } else {
                      keysMapped[ id ] = [ stateName ]
                    }
                  }
                })
                ccb()
              }, cb)
            },
            function lookupAgent (cb) {
              logger.silly('%s from %s; mapping to { %s }', agentName.blue, originalAgentDataId.yellowBG, JSON.stringify(keysMapped))
              var sharedMeta = oldMeta
              // var originalConversationId = oldMeta.conversationId
              async.each(Object.keys(keysMapped), function (agentDataId, dcb) {
                var meta = {}
                // clone it
                util._extend(meta, sharedMeta)
                meta.agentDataId = agentDataId
                async.waterfall([
                  async.apply(getAgentConversation, meta, agentName),
                  function (agentConversation, meta, dcb) {
                    if (agentConversation) {
                      if (keysMapped[ agentDataId ].indexOf(agentConversation.state) > -1) {
                        doFullTrans(meta, agentConversation, dcb)
                      } else {
                        return dcb()
                      }
                    } else Eif (
                      keysMapped[ agentDataId ].indexOf(agent.initialState) > -1 ||
                      keysMapped[ agentDataId ].indexOf('null') > -1) {
                      // we have permission to init()
                      initAgent(agent, meta, messageService, data, function (ignoredError, agentConversation) {
                        // now that we have a conversation do the transition.
                        doFullTrans(meta, agentConversation, dcb)
                      })
                    } else {
                      logger.silly('not emitting, %s:%s already emitted/not inited.', agentName, meta.agentDataId.yellowBG)
                      return dcb()
                    }
                  }
                ], dcb)
              }, cb)
            }
          ], logError)
        })
        transConfigDone()
      }, configDone)
    }, next)
  }, function (next) {
    async.each(Object.keys(conversation.agents), function (agentName, connectionNext) {
      // register with socketService so that we listen when they connect.
      socketService.agents[ agentName ] = function (socket, conn, sessionId, session, user, doneConnecting) {
        // ////////
        var agent = conversation.agents[ agentName ]
        var states = agent.states
        Eif (agent.isConnectable) {
          logger.silly('connection in %s', agentName.blue)
          var initName = agentName + '::init'
          var deinitName = agentName + '::deinit'
          var agentListeners = {}
          var listen = function (agentDataId, e, fn) {
            agentListeners[ agentDataId ].push([ e, fn ])
            messageService.on(e, fn)
          }
          var unListen = function (agentDataId) {
            logger.silly('agent: %s; %s listeners %s', agentName.blue, 'ending'.red, agentDataId.yellowBG)
 
            var listeners = agentListeners[ agentDataId ]
            delete agentListeners[ agentDataId ]
 
            if (listeners) {
              var ln
              while (listeners.length) {
                ln = listeners.pop()
                messageService.removeListener(ln[ 0 ], ln[ 1 ])
              }
            }
          }
          var disconnect = function () {
            socket.removeAllListeners(initName)
            async.each(agent.internalEvents, function (event, cb) {
              socket.removeAllListeners(event)
            })
          }
          var socketEventComplete = function (err) {
            Eif (err) {
              logger.silly('agent: %s::error %s', agentName.blue, err.stack || err.toString())
              socket.emit(agentName + '::error', {
                message: err.message,
                name: err.name
              })
            }
          }
          conn.on('close', function () {
            for (var a in agentListeners) {
              unListen(a)
            }
            disconnect()
          })
          var registerClientListeners = function (agentDataId, cb) {
            var isListening = true
            if (agentListeners[ agentDataId ] == null) {
              agentListeners[ agentDataId ] = []
              isListening = false
            }
            if (!isListening) {
              logger.silly('agent: %s; initing', agentName.blue, !isListening ? 'true'.green : 'false'.blue)
              async.each(Object.keys(agent.states), function (stateName, cb) {
                var state = agent.states[ stateName ]
                var ts = Object.keys(state.transitions).length
                listen(agentDataId, agentName + ':state:' + stateName + ':' + agentDataId, function (data) {
                  logger.silly('emitting ' + agentName.blue + ':state:' + stateName.magenta + ':' + agentDataId.yellowBG)
                  socket.emit(agentName + ':state:' + stateName + ':' + agentDataId, data)
                  if (ts < 1) {
                    unListen(agentDataId)
                  }
                })
                cb()
              }, cb)
            } else {
              cb()
            }
          }
          socket.on(deinitName, function (data) {
            var agentDataId = data._id
            logger.silly('%s deinit in %s', agentName.blue, agentDataId.yellowBG)
            unListen(agentDataId)
          })
          socket.on(initName, function (data) {
            var agentDataId = data._id
            logger.silly('%s init in %s', agentName.blue, agentDataId.yellowBG)
            // remove listeners and make ready in case you need to listen again.
            async.waterfall([
              async.apply(socketEventHandler, agent, data, initName, sessionId, conversation, user),
              function (meta, agentName, cb) {
                registerClientListeners(agentDataId, function () {
                  cb(null, meta, agentName)
                })
              },
              async.apply(getAgentConversation),
              function (agentConversation, meta) {
                // replay current state event
                if (!agentConversation) {
                  // You are the instigator we will init the conversation
                  logger.silly('no state about to create; %s: %s', agentName.blue, sessionId)
                  async.waterfall([
                    async.apply(initAgent, agent, meta, socket, null),
                    function (agentConversation, cb) {
                      var state = states[ agentConversation.state ]
                      doToState(agentName, null, state, meta, meta, function (err, toData, decision) {
                        cb(err, toData, decision, state)
                      })
                    },
                    function (toData, decision, state, cb) {
                      Iif (decision) {
                        doDecision(agentName, state, meta, toData, decision, cb)
                      }
                    }
                  ], logError)
                } else {
                  emitInit(meta, agentName, agentConversation, socket, null)
                }
              }
            ], socketEventComplete)
          })
          async.each(agent.internalEvents, function (event, cb) {
            logger.silly('%s for %s', 'listening'.red, event.yellow)
            socket.on(event, function (socketDataWrapper) {
              var socketData = socketDataWrapper.data
              var data = socketDataWrapper.agentData
              var agentDataId = data._id
              async.waterfall([
                async.apply(registerClientListeners, agentDataId),
                async.apply(socketEventHandler, agent, data, event + ':' + agentDataId, sessionId, conversation, user),
                async.apply(getAgentConversation),
                function (agentConversation, meta) {
                  firePrivateEvent(meta, socketData, event, agentName, agentConversation ? agentConversation.state : 'null')
                }
              ], socketEventComplete)
            })
            cb()
          }, doneConnecting)
        } else {
          doneConnecting()
        }
      }
      connectionNext()
    }, next)
  } ], done)
}