From a21f756c365180d4c004d8f8f0800116b5ac0e31 Mon Sep 17 00:00:00 2001 From: chughts Date: Tue, 20 Sep 2016 16:44:19 +0100 Subject: [PATCH] Fixed name space polution in STT node --- README.md | 1 + services/speech_to_text/v1.html | 200 ++++++++++++++++---------------- services/speech_to_text/v1.js | 138 +++++++++++----------- 3 files changed, 170 insertions(+), 169 deletions(-) diff --git a/README.md b/README.md index 50670b85..4cd9bbd3 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,7 @@ Node-RED Watson Nodes for IBM Bluemix CLA assistant ### New in version 0.4.15 +- Name space fixes to Speech to Text Node ### New in version 0.4.14 - The dialog for the Text to Speech service now loads available voices dynamically. This allows diff --git a/services/speech_to_text/v1.html b/services/speech_to_text/v1.html index 25a764b5..3d992ac3 100644 --- a/services/speech_to_text/v1.html +++ b/services/speech_to_text/v1.html @@ -21,11 +21,11 @@ -
- +
+
-
+
@@ -61,7 +61,7 @@ -
+
@@ -83,7 +83,7 @@ automatically but the is not true in reverse.

Use the continuous property to choose whether the decoding should stop at the first pause or wait until the end of the file.

The returned audio transcription will be returned on msg.transcription.

-

The full response, including alternative transcriptions can be found on +

The full response, including alternative transcriptions can be found on msg.fullresult.

For more information about the Speech To Text service, read the documentation.

@@ -92,81 +92,82 @@ // Need to simulate a namespace, as some of the variables had started to leak across nodes function STT () { - var models = null; - var LANGUAGES = null; - var languages = null; - var bands = null; - var language_selected = ''; - var band_selected = ''; - } - - // This is the namespace for stt. Currently only contains models, but more vars and functions may need to be + } + + + // This is the namespace for stt. Currently only contains models, but more vars and functions may need to be // moved in if there is a clash with other nodes. var stt = new STT(); - - stt.LANGUAGES = { 'en-US' : 'US English', - 'pt-BR': 'Portuguese Braziilian', - 'en-UK': 'UK English' , - 'zh-CN': 'Mandarin', - 'es-ES': 'Spanish', - 'ar-AR': 'Arablic', + stt.models = null; + stt.languages = null; + stt.bands = null; + stt.language_selected = ''; + stt.band_selected = ''; + + stt.LANGUAGES = { 'en-US': 'US English', + 'pt-BR': 'Portuguese Braziilian', + 'en-UK': 'UK English' , + 'fr-FR': 'French', + 'zh-CN': 'Mandarin', + 'es-ES': 'Spanish', + 'ar-AR': 'Arablic', 'ja-JP': 'Japanese' }; // sorting functions - function onlyUnique(value, index, self) { + stt.onlyUnique = function (value, index, self) { return self.indexOf(value) === index; } - // Function to be used at the start, as don't want to expose any fields, unless the models are - // available. The models can only be fetched if the credentials are available. - function hideEverything() { + // Function to be used at the start, as don't want to expose any fields, unless the models are + // available. The models can only be fetched if the credentials are available. + stt.hideEverything = function () { if (!stt.models) { $('#credentials-not-found').show(); - $('label#node-label-message').parent().hide(); - $('input#node-input-continuous').parent().hide(); + $('label#node-label-message').parent().hide(); + $('input#node-input-continuous').parent().hide(); $('select#node-input-lang').parent().hide(); - $('select#node-input-band').parent().hide(); - } + $('select#node-input-band').parent().hide(); + } } - // Check if there is a model then can show the fields. - // available. The models can only be fetched if the credentials are available. - function visibilityCheck() { + // Check if there is a model then can show the fields. + // available. The models can only be fetched if the credentials are available. + stt.VisibilityCheck = function () { if (stt.models) { - $('label#node-label-message').parent().hide(); - $('input#node-input-continuous').parent().show(); - $('select#node-input-lang').parent().show(); - $('select#node-input-band').parent().show(); + $('label#node-label-message').parent().hide(); + $('input#node-input-continuous').parent().show(); + $('select#node-input-lang').parent().show(); + $('select#node-input-band').parent().show(); } else { - $('label#node-label-message').parent().hide(); - $('input#node-input-continuous').parent().hide(); - $('select#node-input-lang').parent().hide(); - $('select#node-input-band').parent().hide(); - } + $('label#node-label-message').parent().hide(); + $('input#node-input-continuous').parent().hide(); + $('select#node-input-lang').parent().hide(); + $('select#node-input-band').parent().hide(); + } } // Simple check that is only invoked if the service is not bound into bluemix. In this case the - // user has to provide credentials. Once there are credentials, then the stt.models are retrieved. - function checkCredentials() { + // user has to provide credentials. Once there are credentials, then the stt.models are retrieved. + stt.checkCredentials = function () { var u = $('#node-input-username').val(); var p = $('#node-input-password').val(); - if (u && u.length && p) { + if (u && u.length && p) { if (!stt.models) { - getModels(); - } - } + stt.getModels(); + } + } } // Populate the quality select field - function populateBands() { + stt.populateBands = function () { if (!stt.bands && stt.models) { stt.bands = stt.models.map(function(m) { return m.name.split('_')[1]; }); - var unique_bands = stt.bands.filter(onlyUnique); + var unique_bands = stt.bands.filter(stt.onlyUnique); stt.bands = unique_bands; } @@ -183,52 +184,54 @@ + '"' + b + '"' + selectedText + '>' - + b - + ''); + + b + + ''); }); } } // Register the handlers for the fields - function handlersUI() { + stt.handlersUI = function () { $('#node-input-username').change(function(val){ - checkCredentials(); - }); + stt.checkCredentials(); + }); $('#node-input-password').change(function(val){ - checkCredentials(); - }); + stt.checkCredentials(); + }); $('#node-input-lang').change(function (val) { stt.language_selected = $('#node-input-lang').val(); - populateBands(); - }); + stt.populateBands(); + }); $('#node-input-band').change(function (val) { stt.band_selected = $('#node-input-band').val(); - }); + }); } // Function called when either when the models have been retrieved, or // on dialog load, if the model has already been retrieved - function postModelCheck() { - processModels(); - visibilityCheck(); + stt.postModelCheck = function () { + stt.processModels(); + stt.VisibilityCheck(); } - // Retrieve the available models from the server, if data is returned, then - // can enable the dynamic selection fields. - function getModels(haveCredentials) { + // Retrieve the available models from the server, if data is returned, then + // can enable the dynamic selection fields. + stt.getModels = function (haveCredentials) { var u = $('#node-input-username').val(); var p = $('#node-input-password').val(); $.getJSON('watson-speech-to-text/models/', {un: u, pwd: p}).done(function (data) { if (data.error) { $('label#node-label-message').parent().show(); - $('label#node-label-message').text(data.error); + $('label#node-label-message').text(data.error); } else if (data.models) { + console.log('models found'); + console.log(data.models); stt.models = data.models; - //have_credentials = true; - postModelCheck(); + //have_credentials = true; + stt.postModelCheck(); } }).fail(function (err) { $('label#node-label-message').parent().show(); @@ -238,7 +241,7 @@ } // Called to complete the languages selection table - function processLanguages() { + stt.processSTTLanguages = function () { if (!stt.languages && stt.models) { stt.languages = stt.models.map(function(m) { return m.language; @@ -246,7 +249,7 @@ } if (stt.languages) { $('select#node-input-lang').empty(); - var unique_langs = stt.languages.filter(onlyUnique); + var unique_langs = stt.languages.filter(stt.onlyUnique); unique_langs.forEach(function(l) { var selectedText = ''; @@ -258,49 +261,48 @@ + '"' + l + '"' + selectedText + '>' - + (stt.LANGUAGES[l] ? stt.LANGUAGES[l] : l) - + ''); + + (stt.LANGUAGES[l] ? stt.LANGUAGES[l] : l) + + ''); }); - } } // Called to work through the models, completing the dyanmic selection fields. - function processModels() { + stt.processModels = function () { if (stt.models) { - processLanguages(); - populateBands(); + stt.processSTTLanguages(); + stt.populateBands(); } } // The dynamic nature of the selection fields in this node has caused problems. - // Whenever there is a fetch for the models, on a page refresh or applicaiton - // restart, the settings for the dynamic fields are lost. + // Whenever there is a fetch for the models, on a page refresh or applicaiton + // restart, the settings for the dynamic fields are lost. // So hidden (text) fields are being used to squirrel away the values, so that // they can be restored. - function restoreFromHidden() { - stt.language_selected = $('#node-input-langhidden').val(); + stt.restoreFromHidden = function () { + stt.language_selected = $('#node-input-langhidden').val(); $('select#node-input-lang').val(stt.language_selected); - stt.band_selected = $('#node-input-bandhidden').val(); + stt.band_selected = $('#node-input-bandhidden').val(); $('select#node-input-band').val(stt.band_selected); - } + } // This is the on edit prepare function, which will be invoked everytime the dialog - // is shown. - function oneditprepare() { - hideEverything(); - restoreFromHidden(); - handlersUI(); + // is shown. + function sttoneditprepare() { + stt.hideEverything(); + stt.restoreFromHidden(); + stt.handlersUI(); $.getJSON('watson-speech-to-text/vcap/') - // for some reason the getJSON resets the vars so need to restoreFromHidden again + // for some reason the getJSON resets the vars so need to restoreFromHidden again // so again. .done(function (service) { - restoreFromHidden(); + stt.restoreFromHidden(); $('.credentials').toggle(!service); - if (!stt.models) {getModels(service);} - else {postModelCheck();} + if (!stt.models) {stt.getModels(service);} + else {stt.postModelCheck();} }) .fail(function () { $('.credentials').show(); @@ -310,9 +312,9 @@ } // Save the values in the dyanmic lists to the hidden fields. - function oneditsave(){ - $('#node-input-langhidden').val(stt.language_selected); - $('#node-input-bandhidden').val(stt.band_selected); + function sttoneditsave(){ + $('#node-input-langhidden').val(stt.language_selected); + $('#node-input-bandhidden').val(stt.band_selected); } (function() { @@ -324,8 +326,8 @@ lang: {value: ''}, langhidden: {value: ''}, band: {value: ''}, - bandhidden: {value: ''}, - password: {value: ''} + bandhidden: {value: ''}, + password: {value: ''} }, credentials: { username: {type:'text'} //, @@ -342,9 +344,9 @@ labelStyle: function() { return this.name ? 'node_label_italic' : ''; }, - oneditprepare: oneditprepare, - oneditsave: oneditsave + oneditprepare: sttoneditprepare, + oneditsave: sttoneditsave }); })(); - \ No newline at end of file + diff --git a/services/speech_to_text/v1.js b/services/speech_to_text/v1.js index 2f210a3f..b7667729 100644 --- a/services/speech_to_text/v1.js +++ b/services/speech_to_text/v1.js @@ -19,17 +19,18 @@ module.exports = function (RED) { var cfenv = require('cfenv'); var temp = require('temp'); var url = require('url'); - var fs = require('fs'); + var fs = require('fs'); var fileType = require('file-type'); - var watson = require('watson-developer-cloud'); + //var watson = require('watson-developer-cloud'); + var sttV1 = require('watson-developer-cloud/speech-to-text/v1'); var service = cfenv.getAppEnv().getServiceCreds(/speech to text/i); - // Require the Cloud Foundry Module to pull credentials from bound service - // If they are found then the username and password will be stored in - // the variables sUsername and sPassword. + // Require the Cloud Foundry Module to pull credentials from bound service + // If they are found then the username and password will be stored in + // the variables sUsername and sPassword. // - // This separation between sUsername and username is to allow + // This separation between sUsername and username is to allow // the end user to modify the credentials when the service is not bound. // Otherwise, once set credentials are never reset, resulting in a frustrated // user who, when he errenously enters bad credentials, can't figure out why @@ -43,13 +44,13 @@ module.exports = function (RED) { } - // temp is being used for file streaming to allow the file to arrive so it can be processed. + // temp is being used for file streaming to allow the file to arrive so it can be processed. temp.track(); // These are APIs that the node has created to allow it to dynamically fetch Bluemix - // credentials, and also translation models. This allows the node to keep up to - // date with new tranlations, without the need for a code update of this node. + // credentials, and also translation models. This allows the node to keep up to + // date with new tranlations, without the need for a code update of this node. // Node RED Admin - fetch and set vcap services RED.httpAdmin.get('/watson-speech-to-text/vcap', function (req, res) { @@ -59,11 +60,9 @@ module.exports = function (RED) { // API used by widget to fetch available models RED.httpAdmin.get('/watson-speech-to-text/models', function (req, res) { - var stt = watson.speech_to_text({ - username: username ? username : req.query.un, - password: password ? password : req.query.pwd, - version: 'v1', - url: 'https://stream.watsonplatform.net/speech-to-text/api' + var stt = new sttV1({ + username: sUsername ? sUsername : req.query.un, + password: sPassword ? sPassword : req.query.pwd }); stt.getModels({}, function(err, models){ @@ -72,7 +71,7 @@ module.exports = function (RED) { } else { res.json(models); } - }); + }); }); // Utility function to perform a URL validation check @@ -83,7 +82,7 @@ module.exports = function (RED) { } // Function that is syncing up the asynchronous nature of the stream - // so that the full file can be sent to the API. + // so that the full file can be sent to the API. var stream_buffer = function(file, contents, cb) { fs.writeFile(file, contents, function (err) { if (err) throw err; @@ -93,7 +92,7 @@ module.exports = function (RED) { // Function that is syncing up the asynchronous nature of the stream - // so that the full file can be sent to the API. + // so that the full file can be sent to the API. var stream_url = function(file, url, cb) { var wstream = fs.createWriteStream(file); @@ -126,37 +125,36 @@ module.exports = function (RED) { this.on('input', function (msg) { // This section is for var functions that will be called, in context with - // msg, when the input stream has been received. + // msg, when the input stream has been received. - // This is the callback after the call to the speech to text service. - // Set up as a var within this scope, so it has access to node, msg etc. + // This is the callback after the call to the speech to text service. + // Set up as a var within this scope, so it has access to node, msg etc. var actionComplete = function(err, data) { if (err || data.status === 'ERROR') { - node.status({fill:'red', shape:'ring', text:'call to speech to text service failed'}); + node.status({fill:'red', shape:'ring', text:'call to speech to text service failed'}); node.error(err, msg); } else { - var r = data.results; + var r = data.results; msg.transcription = ''; if (r) { if (r.length && r[0].alternatives.length) { msg.fullresult = r; - } + } msg.transcription = ''; r.forEach(function(a){ - // console.log(a.alternatives); a.alternatives.forEach(function(t){ msg.transcription += t.transcript; }); - }); + }); } - node.send(msg); - } - }; + node.send(msg); + } + }; - // Utility function that performs the speech to text service call. - // the cleanup removes the temp storage, and I am not sure whether + // Utility function that performs the speech to text service call. + // the cleanup removes the temp storage, and I am not sure whether // it should be called here or after the service returns and passed // control back to cbdone. function performAction(audio, format, cbdone, cbcleanup) { @@ -165,10 +163,10 @@ module.exports = function (RED) { password: password, version: 'v1', url: 'https://stream.watsonplatform.net/speech-to-text/api' - }); + }); - // If we get to here then the audio is in one of the supported formats. - if (format === 'ogg') { + // If we get to here then the audio is in one of the supported formats. + if (format === 'ogg') { format += ';codecs=opus'; } @@ -183,7 +181,7 @@ module.exports = function (RED) { node.status({fill:'blue', shape:'dot', text:'requesting'}); - // Everything is now in place to invoke the service + // Everything is now in place to invoke the service speech_to_text.recognize(params, function (err, res) { node.status({}); cbdone(err,res); @@ -206,16 +204,16 @@ module.exports = function (RED) { var message = ''; // Credentials are needed for the service. They will either be bound or - // specified by the user in the dialog. + // specified by the user in the dialog. username = sUsername || this.credentials.username; - password = sPassword || this.credentials.password || config.password; + password = sPassword || this.credentials.password || config.password; if (!username || !password) { var message_err_credentials = 'Missing Speech To Text service credentials'; node.error(message_err_credentials, msg); return; - } + } if (!config.lang) { var message_err_lang = 'Missing audio language configuration, unable to process speech.'; @@ -229,19 +227,19 @@ module.exports = function (RED) { node.error(message_err_band, msg); return; - } + } - // Has to be there, as its a checkbox, but flows switching from the old (frankly + // Has to be there, as its a checkbox, but flows switching from the old (frankly // unbeliveable) select might not have it set. if (!config.continuous) { var message_err_continuous = 'Missing continuous details, unable to process speech.'; node.error(message_err_continuous, msg); return; - } + } - // The input comes in on msg.payload, and can either be an audio file or a string - // representing a URL. + // The input comes in on msg.payload, and can either be an audio file or a string + // representing a URL. if (!msg.payload instanceof Buffer || !typeof msg.payload === 'string') { message = 'Invalid property: msg.payload, can only be a URL or a Buffer.'; @@ -249,8 +247,8 @@ module.exports = function (RED) { return; } - // This check is repeated just before the call to the service, but - // its also performed here as a double check. + // This check is repeated just before the call to the service, but + // its also performed here as a double check. if (!(msg.payload instanceof Buffer)) { if (typeof msg.payload === 'string' && !urlCheck(msg.payload)) { message = 'Invalid URL.'; @@ -267,66 +265,66 @@ module.exports = function (RED) { case 'ogg': break; default: - var message_err_format + var message_err_format = 'Audio format (' + f + ') not supported, must be encoded as WAV, FLAC or OGG.'; node.error(message_err_format, msg); - return; + return; } - } + } - // We are now ready to process the input data - // If its a buffer then need to read it all before invoking the service + // We are now ready to process the input data + // If its a buffer then need to read it all before invoking the service if (msg.payload instanceof Buffer) { temp.open({suffix: '.' + fileType(msg.payload).ext}, function (err, info) { if (err) { - node.status({fill:'red', shape:'ring', text:'unable to open audio stream'}); - message = 'Node has been unable to open the audio stream'; + node.status({fill:'red', shape:'ring', text:'unable to open audio stream'}); + message = 'Node has been unable to open the audio stream'; node.error(message, msg); - return; - } + return; + } stream_buffer(info.path, msg.payload, function (format) { var audio = fs.createReadStream(info.path); - performAction(audio, format, actionComplete, temp.cleanup); + performAction(audio, format, actionComplete, temp.cleanup); }); }); } else if (urlCheck(msg.payload)) { temp.open({suffix: '.audio'}, function(err, info){ if (err) { - node.status({fill:'red', shape:'ring', - text:'unable to open url audio stream'}); - message = 'Node has been unable to open the url audio stream'; + node.status({fill:'red', shape:'ring', + text:'unable to open url audio stream'}); + message = 'Node has been unable to open the url audio stream'; node.error(message, msg); - return; - } + return; + } stream_url(info.path, msg.payload, function (err, format) { if (err) { - node.status({fill:'red', shape:'ring', - text:'url stream not recognised as audio'}); - message = 'Node did not recognise the url audio stream as audio'; + node.status({fill:'red', shape:'ring', + text:'url stream not recognised as audio'}); + message = 'Node did not recognise the url audio stream as audio'; node.error(message, msg); - return; - } + return; + } var audio = fs.createReadStream(info.path); - performAction(audio, format, actionComplete, temp.cleanup); + performAction(audio, format, actionComplete, temp.cleanup); }); }); } else { - node.status({fill:'red', shape:'ring', text:'payload is invalid'}); - message = 'Payload must be either an audio buffer or a string representing a url'; + node.status({fill:'red', shape:'ring', text:'payload is invalid'}); + message = 'Payload must be either an audio buffer or a string representing a url'; node.error(message, msg); - return; + return; } - }); + }); } RED.nodes.registerType('watson-speech-to-text', Node, { @@ -335,4 +333,4 @@ module.exports = function (RED) { password: {type:'password'} } }); -}; \ No newline at end of file +};