feat actionHook delay action (#470)

* feat actionHook delay action

* wip

* wip

* wip

* wip

* wip

* wip

* wip

* wip

* wip

* wip

* wip

* wip

* wip

lib/session/call-session.js

@@ -449,6 +449,47 @@ class CallSession extends Emitter {
     this._sipRequestWithinDialogHook = url;
   }
 
+  // Bot Delay (actionHook delayed)
+  get actionHookDelayEnabled() {
+    return this._actionHookDelayEnabled;
+  }
+
+  set actionHookDelayEnabled(e) {
+    this._actionHookDelayEnabled = e;
+  }
+
+  get actionHookNoResponseTimeout() {
+    return this._actionHookNoResponseTimeout;
+  }
+
+  set actionHookNoResponseTimeout(e) {
+    this._actionHookNoResponseTimeout = e;
+  }
+
+  get actionHookNoResponseGiveUpTimeout() {
+    return this._actionHookNoResponseGiveUpTimeout;
+  }
+
+  set actionHookNoResponseGiveUpTimeout(e) {
+    this._actionHookNoResponseGiveUpTimeout = e;
+  }
+
+  get actionHookDelayRetries() {
+    return this._actionHookDelayRetries;
+  }
+
+  set actionHookDelayRetries(e) {
+    this._actionHookDelayRetries = e;
+  }
+
+  get actionHookDelayActions() {
+    return this._actionHookDelayActions;
+  }
+
+  set actionHookDelayActions(e) {
+    this._actionHookDelayActions = e;
+  }
+
   hasGlobalSttPunctuation() {
     return this._globalSttPunctuation !== undefined;
   }
@@ -836,6 +877,7 @@ class CallSession extends Emitter {
       task.on('VerbHookSpanWaitForEnd', ({span}) => {
         this.verbHookSpan = span;
       });
+      task.on('ActionHookDelayActionOptions', this._onActionHookDelayActions.bind(this));
       try {
         const resources = await this._evaluatePreconditions(task);
         let skip = false;
@@ -1107,6 +1149,9 @@ class CallSession extends Emitter {
       this.currentTask.kill(this);
     }
     this._endVerbHookSpan();
+    // clear all delay action hook timeout if there is
+    this._clearActionHookNoResponseGiveUpTimer();
+    this._clearActionHookNoResponseTimer();
   }
 
   /**
@@ -1294,6 +1339,14 @@ Duration=${duration} `
     task.whisper(tasks, callSid).catch((err) => this.logger.error(err, 'CallSession:_lccWhisper'));
   }
 
+  /**
+   * perform call hangup by jambonz
+   */
+
+  async hangup() {
+    return this._callerHungup();
+  }
+
 
   /**
    * perform live call control
@@ -1505,6 +1558,9 @@ Duration=${duration} `
           }
           resolution = {reason: 'received command, new tasks', queue: queueCommand, command};
           resolution.command = listTaskNames(t);
+          // clear all delay action hook timeout if there is
+          this._clearActionHookNoResponseGiveUpTimer();
+          this._clearActionHookNoResponseTimer();
         }
         else this._lccCallHook(data);
         break;
@@ -1745,6 +1801,8 @@ Duration=${duration} `
     this.rootSpan && this.rootSpan.end();
     // close all background tasks
     this.backgroundTaskManager.stopAll();
+    this._clearActionHookNoResponseGiveUpTimer();
+    this._clearActionHookNoResponseTimer();
   }
 
   /**
@@ -2170,6 +2228,69 @@ Duration=${duration} `
       this.verbHookSpan = null;
     }
   }
+  // actionHook delay actions
+  _onActionHookDelayActions(options) {
+    this._actionHookDelayRetryCount = 0;
+    this._startActionHookNoResponseTimer(options);
+    this._startActionHookNoResponseGiveUpTimer(options);
+  }
+
+  _startActionHookNoResponseTimer(options) {
+    this._clearActionHookNoResponseTimer();
+    if (options.noResponseTimeoutMs) {
+      this.logger.debug(`CallSession:_startActionHookNoResponseTimer ${options.noResponseTimeoutMs}`);
+      this._actionHookNoResponseTimer = setTimeout(() => {
+        if (this._actionHookDelayRetryCount >= options.retries) {
+          this._callerHungup();
+        }
+        const verb = options.actions[this._actionHookDelayRetryCount % options.actions.length];
+        // Inject verb to main stack
+        const t = normalizeJambones(this.logger, [verb])
+          .map((tdata) => makeTask(this.logger, tdata));
+        if (t.length) {
+          t[0].on('playDone', (err) => {
+            if (err) this.logger.error({err}, `Call-Session:exec Error delay action, play ${verb}`);
+            this._startActionHookNoResponseTimer(options);
+          });
+        }
+        this.tasks.push(...t);
+        if (this.wakeupResolver) {
+          this.wakeupResolver({reason: 'actionHook no response, applied delay actions', verb});
+          this.wakeupResolver = null;
+        }
+
+        this.logger.debug(`CallSession:_startActionHookNoResponseTimer, executing verb ${JSON.stringify(verb)}`);
+
+        this._actionHookDelayRetryCount++;
+      }, options.noResponseTimeoutMs);
+    }
+  }
+
+  _clearActionHookNoResponseTimer() {
+    if (this._actionHookNoResponseTimer) {
+      clearTimeout(this._actionHookNoResponseTimer);
+    }
+    this._actionHookNoResponseTimer = null;
+  }
+
+  _startActionHookNoResponseGiveUpTimer(options) {
+    this._clearActionHookNoResponseGiveUpTimer();
+    if (options.noResponseGiveUpTimeoutMs) {
+      this.logger.debug(`CallSession:_startActionHookNoResponseGiveUpTimer ${options.noResponseGiveUpTimeoutMs}`);
+      this._actionHookNoResponseGiveUpTimer = setTimeout(() => {
+        this.logger.debug('CallSession:_startActionHookNoResponseGiveUpTimer Timeout');
+        this._callerHungup();
+        this._actionHookNoResponseGiveUpTimer = null;
+      }, options.noResponseGiveUpTimeoutMs);
+    }
+  }
+
+  _clearActionHookNoResponseGiveUpTimer() {
+    if (this._actionHookNoResponseGiveUpTimer) {
+      clearTimeout(this._actionHookNoResponseGiveUpTimer);
+    }
+    this._actionHookNoResponseGiveUpTimer = null;
+  }
 }
 
 module.exports = CallSession;