@fonoster/voice 0.2.22 → 0.2.29

package/dist/server.d.ts

@@ -1,8 +1,10 @@
 import { ServerConfig } from "./types";
 import { Plugin } from "@fonoster/common";
+import { VoiceTracer } from "./tracer";
 export default class VoiceServer {
     config: ServerConfig;
     plugins: {};
+    voiceTracer: VoiceTracer;
     constructor(config?: ServerConfig);
     /**
      * Add tts or asr plugin.

package/dist/server.js

@@ -10,6 +10,7 @@ const path_1 = require("path");
 const fs_1 = __importDefault(require("fs"));
 const os_1 = __importDefault(require("os"));
 const pubsub_js_1 = __importDefault(require("pubsub-js"));
+const tracer_1 = require("./tracer");
 const merge = require("deepmerge");
 const app = (0, express_1.default)();
 app.use(express_1.default.json());
@@ -54,7 +55,9 @@ class VoiceServer {
             res.send("pong");
         });
         app.post(path_1.posix.join(this.config.base), async (req, res) => {
-            const response = new voice_1.default(req.body);
+            this.voiceTracer = new tracer_1.VoiceTracer(this.config.otlSpanExporters);
+            this.voiceTracer.init();
+            const response = new voice_1.default(req.body, this.voiceTracer);
             response.plugins = this.plugins;
             handler(req.body, response);
             res.end();

package/dist/tracer.d.ts

@@ -0,0 +1,10 @@
+import { Context, Span, Tracer } from "@opentelemetry/api";
+export declare class VoiceTracer {
+    callTracer: Tracer;
+    parentSpan: Span;
+    ctx: Context;
+    constructor(otlSpanExporters: Array<any>);
+    init(): void;
+    close(): void;
+    createSpan(name: string): Span;
+}

package/dist/tracer.js

@@ -0,0 +1,56 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VoiceTracer = void 0;
+/*
+ * Copyright (C) 2021 by Fonoster Inc (https://fonoster.com)
+ * http://github.com/fonoster/fonoster
+ *
+ * This file is part of Fonoster
+ *
+ * Licensed under the MIT License (the "License");
+ * you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ *    https://opensource.org/licenses/MIT
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+const api_1 = __importDefault(require("@opentelemetry/api"));
+const resources_1 = require("@opentelemetry/resources");
+const semantic_conventions_1 = require("@opentelemetry/semantic-conventions");
+const sdk_trace_base_1 = require("@opentelemetry/sdk-trace-base");
+const { NodeTracerProvider } = require("@opentelemetry/node");
+class VoiceTracer {
+    constructor(otlSpanExporters) {
+        // Configure span processor to send spans to the exporter
+        const provider = new NodeTracerProvider({
+            resource: new resources_1.Resource({
+                [semantic_conventions_1.SemanticResourceAttributes.SERVICE_NAME]: "voice-service"
+            })
+        });
+        for (const exp of otlSpanExporters) {
+            const exporter = new exp.exporter(exp.config);
+            provider.addSpanProcessor(new sdk_trace_base_1.BatchSpanProcessor(exporter));
+        }
+        provider.register();
+        this.callTracer = api_1.default.trace.getTracer("call_tracer");
+    }
+    init() {
+        this.parentSpan = this.callTracer.startSpan("call");
+        this.ctx = api_1.default.trace.setSpan(api_1.default.context.active(), this.parentSpan);
+    }
+    close() {
+        this.parentSpan.end();
+    }
+    createSpan(name) {
+        return this.callTracer.startSpan(name, undefined, this.ctx);
+    }
+}
+exports.VoiceTracer = VoiceTracer;

package/dist/types.d.ts

@@ -1,3 +1,4 @@
+import { MeterProvider } from "@opentelemetry/sdk-metrics-base";
 export interface VoiceRequest {
     accessKeyId: string;
     sessionToken: string;
@@ -13,6 +14,8 @@ export interface ServerConfig {
     port?: number;
     base?: string;
     pathToFiles?: string;
+    otlSpanExporters?: Array<any>;
+    meterProvider?: MeterProvider;
 }
 export interface VoiceEventData {
     type: string;

package/dist/voice.d.ts

@@ -1,3 +1,4 @@
+import { GatherOptions } from "./gather/gather";
 import { MuteOptions } from "./mute/mute";
 import { PlayOptions } from "./play/play";
 import { RecordOptions, RecordResult } from "./record/record";
@@ -10,6 +11,7 @@ import { SGatherStream } from "./sgather/types";
 import { DtmfOptions } from "./dtmf/types";
 import { DialOptions } from "./dial/types";
 import StreamStatus from "./dial/status_stream";
+import { VoiceTracer } from "./tracer";
 /**
  * @classdesc Use the VoiceResponse object, to construct advance Interactive
  * Voice Response (IVR) applications.
@@ -30,13 +32,14 @@ import StreamStatus from "./dial/status_stream";
 export default class VoiceResponse {
     request: VoiceRequest;
     plugins: {};
+    voiceTracer: VoiceTracer;
     /**
      * Constructs a new VoiceResponse object.
      *
      * @param {VoiceRequest} request - Options to indicate the objects endpoint
      * @see module:core:APIClient
      */
-    constructor(request: VoiceRequest);
+    constructor(request: VoiceRequest, voiceTracer: VoiceTracer);
     /**
      * Adds a tts or asr plugin. Only one type of plugin can be attached.
      *
@@ -103,9 +106,7 @@ export default class VoiceResponse {
      *   console.log("digits: " + digits);
      * }
      */
-    gather(options: {
-        source: "speech,dtmf";
-    }): Promise<string>;
+    gather(options?: GatherOptions): Promise<string>;
     /**
      * Waits for data entry from the user's keypad or from a stream speech provider. This command is different from `gather`
      * in that it returns a stream of results instead of a single result. You can think of it as active listening.

package/dist/voice.js

@@ -60,8 +60,9 @@ class VoiceResponse {
      * @param {VoiceRequest} request - Options to indicate the objects endpoint
      * @see module:core:APIClient
      */
-    constructor(request) {
+    constructor(request, voiceTracer) {
         this.request = request;
+        this.voiceTracer = voiceTracer;
         this.plugins = {};
     }
     /**
@@ -92,7 +93,9 @@ class VoiceResponse {
      * }
      */
     async play(media, options = {}) {
+        const span = this.voiceTracer.createSpan("play");
         await new play_1.default(this.request).run(media, options);
+        span.end();
     }
     /**
      * Converts a text into a sound and sends sound to media server. To use this verb, you must
@@ -118,9 +121,17 @@ class VoiceResponse {
         (0, asserts_1.assertPluginExist)(this, "tts");
         const tts = this.plugins["tts"];
         // It should return the filename and the generated file location
+        const main = this.voiceTracer.createSpan("play");
+        const span = this.voiceTracer.createSpan("synthetize");
         const result = await tts.synthetize(text, options);
+        span.setAttribute("text", text);
+        span.setAttribute("options", JSON.stringify(options));
+        span.end();
         const media = `sound:${this.request.selfEndpoint}/tts/${result.filename}`;
         await new play_1.default(this.request).run(media, options);
+        main.setAttribute("media", media);
+        main.setAttribute("options", JSON.stringify(options));
+        main.end();
     }
     /**
      * Waits for data entry from the user's keypad or from a speech provider.
@@ -141,13 +152,17 @@ class VoiceResponse {
      *   console.log("digits: " + digits);
      * }
      */
-    async gather(options) {
+    async gather(options = { source: "speech,dtmf" }) {
         let asr = null;
         if (options.source.includes("speech")) {
             (0, asserts_1.assertPluginExist)(this, "asr");
             asr = this.plugins["asr"];
         }
-        return await new gather_1.default(this.request, asr).run(options);
+        const span = this.voiceTracer.createSpan("gather");
+        const result = await new gather_1.default(this.request, asr).run(options);
+        span.setAttribute("options", JSON.stringify(options));
+        span.end();
+        return result;
     }
     /**
      * Waits for data entry from the user's keypad or from a stream speech provider. This command is different from `gather`
@@ -197,7 +212,11 @@ class VoiceResponse {
      * }
      */
     async dtmf(options) {
-        return await new dtmf_1.default(this.request).run(options);
+        const span = this.voiceTracer.createSpan("dtmf");
+        const result = await new dtmf_1.default(this.request).run(options);
+        span.setAttribute("options", JSON.stringify(options));
+        span.end();
+        return result;
     }
     /**
      * Forwards the call to an Agent or the PSTN.
@@ -219,7 +238,12 @@ class VoiceResponse {
      * }
      */
     async dial(destination, options) {
-        return await new dial_1.default(this.request).run(destination, options);
+        const span = this.voiceTracer.createSpan("dial");
+        const result = await new dial_1.default(this.request).run(destination, options);
+        span.setAttribute("destination", destination);
+        span.setAttribute("options", JSON.stringify(options));
+        span.end();
+        return result;
     }
     /**
      * Returns a PlaybackControl control object.
@@ -243,7 +267,11 @@ class VoiceResponse {
      * }
      */
     playback(playbackId) {
-        return new playback_1.PlaybackControl(this.request, playbackId);
+        const span = this.voiceTracer.createSpan("playback");
+        const result = new playback_1.PlaybackControl(this.request, playbackId);
+        span.setAttribute("playbackId", playbackId);
+        span.end();
+        return result;
     }
     /**
      * Listens event publication.
@@ -284,7 +312,11 @@ class VoiceResponse {
      * }
      */
     async mute(options) {
-        await new mute_1.default(this.request).run(options);
+        const span = this.voiceTracer.createSpan("mute");
+        const result = new mute_1.default(this.request).run(options);
+        span.setAttribute("options", JSON.stringify(options));
+        span.end();
+        await result;
     }
     /**
      * Unmutes a channel.
@@ -300,7 +332,11 @@ class VoiceResponse {
      * }
      */
     async unmute(options) {
-        await new unmute_1.default(this.request).run(options);
+        const span = this.voiceTracer.createSpan("unmute");
+        const result = new unmute_1.default(this.request).run(options);
+        span.setAttribute("options", JSON.stringify(options));
+        span.end();
+        await result;
     }
     /**
      * Answer the communication channel. Before running any other verb you
@@ -314,7 +350,10 @@ class VoiceResponse {
      * }
      */
     async answer() {
-        await new answer_1.default(this.request).run();
+        const span = this.voiceTracer.createSpan("answer");
+        const result = new answer_1.default(this.request).run();
+        span.end();
+        await result;
     }
     /**
      * Terminates the communication channel.
@@ -327,7 +366,12 @@ class VoiceResponse {
      * }
      */
     async hangup() {
-        await new hangup_1.default(this.request).run();
+        const span = this.voiceTracer.createSpan("hangup");
+        const result = new hangup_1.default(this.request).run();
+        span.end();
+        // Need to close or the span will be lost
+        this.voiceTracer.close();
+        await result;
     }
     /**
      * Records the current channel and uploads the file to the storage subsystem.
@@ -348,17 +392,24 @@ class VoiceResponse {
      * }
      */
     async record(options) {
-        return await new record_1.default(this.request).run(options);
+        const span = this.voiceTracer.createSpan("record");
+        const result = await new record_1.default(this.request).run(options);
+        span.end();
+        return result;
     }
     // Requests media from Media server
     async openMediaPipe() {
+        const span = this.voiceTracer.createSpan("openMediaPipe");
         const genericVerb = new verb_1.Verb(this.request);
         await (0, utils_1.startMediaTransfer)(genericVerb, this.request.sessionId);
+        span.end();
     }
     // Requests media stop from Media server
     async closeMediaPipe() {
+        const span = this.voiceTracer.createSpan("stopMediaTransfer");
         const genericVerb = new verb_1.Verb(this.request);
         await (0, utils_1.stopMediaTransfer)(genericVerb, this.request.sessionId);
+        span.end();
     }
 }
 exports.default = VoiceResponse;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fonoster/voice",
-  "version": "0.2.22",
+  "version": "0.2.29",
   "description": "Voice verbs",
   "author": "Pedro Sanders <psanders@fonoster.com>",
   "homepage": "https://github.com/fonoster/fonoster#readme",
@@ -29,8 +29,18 @@
     "url": "https://github.com/fonoster/fonoster/issues"
   },
   "dependencies": {
-    "@fonoster/common": "^0.2.21",
-    "@fonoster/logger": "^0.2.21",
+    "@fonoster/common": "^0.2.29",
+    "@fonoster/logger": "^0.2.29",
+    "@opentelemetry/api": "^1.0.2",
+    "@opentelemetry/node": "^0.24.0",
+    "@opentelemetry/plugin-express": "^0.15.0",
+    "@opentelemetry/plugin-http": "^0.18.2",
+    "@opentelemetry/plugin-https": "^0.18.2",
+    "@opentelemetry/resources": "0.25.0",
+    "@opentelemetry/sdk-metrics-base": "0.25.0",
+    "@opentelemetry/sdk-trace-base": "0.25.0",
+    "@opentelemetry/semantic-conventions": "0.25.0",
+    "@opentelemetry/tracing": "^0.24.0",
     "axios": "^0.21.1",
     "deepmerge": "^4.2.2",
     "express": "^4.17.1",
@@ -39,7 +49,7 @@
     "pubsub-js": "^1.9.3",
     "sync": "^0.2.5"
   },
-  "gitHead": "255c8a0950b19565a2e11c56612d8696afaa322f",
+  "gitHead": "622d59a103faddb8e1ea721091ae58370102e764",
   "devDependencies": {
     "@types/pubsub-js": "^1.8.2"
   }