1730

pending completion

Build # 1730

Build Type

push

travis-ci-com

Committed by

web-flow

Commit Message

Merge pull request #454 from stanford-oval/wip/fix-temp-unit

io.home-assistant: convert sensor values to the thingtalk units

Run Details

498 of 1548 branches covered (32.17%)

Branch coverage included in aggregate %.

6 of 35 new or added lines in 2 files covered. (17.14%)

1 existing line in 1 file now uncovered.

1381 of 3171 relevant lines covered (43.55%)

28.36 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

57.93

/main/com.bing/index.js

// -*- mode: js; indent-tabs-mode: nil; js-basic-offset: 4 -*-
//
// Copyright 2016-2021 The Board of Trustees of the Leland Stanford Junior University
//
// Redistribution and use in source and binary forms, with or
// without modification, are permitted provided that the following
// conditions are met:
//
// 1. Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
// 2. Redistributions in binary form must reproduce the above
//    copyright notice, this list of conditions and the following
//    disclaimer in the documentation and/or other materials
//    provided with the distribution.
// 3. Neither the name of the copyright holder nor the names of its
//    contributors may be used to endorse or promote products derived
//    from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
// FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
// COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
// INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
// (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
// HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
// STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
// OF THE POSSIBILITY OF SUCH DAMAGE.
"use strict";

const util = require('util');
const interpolate = require('string-interp');
const Tp = require('thingpedia');
const TT = require('thingtalk');
const qs = require('querystring');
const Logging = require("@stanford-oval/logging");
const Winston = require("winston");

const LogFactory = new Logging.Factory({
    runRoot: __dirname,
    level: "http",
    envVarPrefix: "TP_BING_LOG",
    transports: [
        new Winston.transports.Console({
            format: Logging.Format.prettySimple({ colorize: true }),
        }),
    ],
});

const LOG = LogFactory.get(__filename);
const { Temporal } = require('@js-temporal/polyfill');

/**
 *
 * @param {string} x
 * @returns {string}
 */
function toCamelCase(x) {
    return x[0].toLowerCase() + x.substring(1);
}

class BingDialogueHandler {
    /**
     *
     * @param {string} locale
     * @param {string} timezone
     * @param {string} apiKey
     */
    constructor(locale, timezone, apiKey) {
        this._locale = locale;
        this._timezone = timezone;
        this._apiKey = apiKey;

        this._ = BingClass.gettext.gettext;

        this._lastQuerySuggestion = null;
    }

    _interp(string, args) {
        return interpolate(string, args, {
            locale: this._locale,
            timezone: this._timezone,
        });
    }

    get priority() {
        return Tp.DialogueHandler.Priority.FALLBACK;
    }
    get icon() {
        return 'com.bing';
    }

    getState() {
        return { lastQuerySuggestion: this._lastQuerySuggestion };
    }
    async initialize(initialState) {
        if (initialState)
            this._lastQuerySuggestion = initialState.lastQuerySuggestion;
        return null;
    }
    reset() {
        this._lastQuerySuggestion = null;
    }

    /**
     *
     * @param {string} command
     * @returns {Tp.DialogueHandler.CommandAnalysisResult}
     */
    async analyzeCommand(utterance) {
        let confident = Tp.DialogueHandler.Confidence.NONCONFIDENT_IN_DOMAIN_COMMAND;
        let query = utterance;

        const prefixregexp = new RegExp(this._("^\\s*ask bing (to|for)?\\b"), 'i');
        const prefixmatch = prefixregexp.exec(utterance);
        if (prefixmatch) {
            query = utterance.substring(prefixmatch[0].length).trim();
            confident = Tp.DialogueHandler.Confidence.EXACT_IN_DOMAIN_COMMAND;
        }
        const suffixregexp = new RegExp(this._("\\b(ask|on|using) bing\\?*\\s*$"), 'i');
        const suffixmatch = suffixregexp.exec(utterance);
        if (suffixmatch) {
            query = utterance.substring(0, utterance.length-suffixmatch[0].length).trim();
            confident = Tp.DialogueHandler.Confidence.EXACT_IN_DOMAIN_COMMAND;
        }

        if (this._lastQuerySuggestion) {
            const yes = new RegExp(this._("^\\s*(yes|yeah|yep|sure)\b"));
            const yesmatch = yes.exec(utterance);
            if (yesmatch) {
                query = this._lastQuerySuggestion;
                confident = Tp.DialogueHandler.Confidence.EXACT_IN_DOMAIN_FOLLOWUP;
            }
        }

        const response = JSON.parse(await Tp.Helpers.Http.get(`https://api.cognitive.microsoft.com/bing/v7.0/search?` + qs.stringify({
            mkt: this._locale,
            setLang: this._locale,
            q: query,
        }), {
            extraHeaders: { 'Ocp-Apim-Subscription-Key': this._apiKey }
        }));
        if (process.env.TP_BING_DEBUG)
            console.log(util.inspect(response, { depth: Infinity }));

        if (!response.rankingResponse)
            return { confident: Tp.DialogueHandler.Confidence.OUT_OF_DOMAIN_COMMAND, utterance, user_target: '' };

        if (confident === Tp.DialogueHandler.Confidence.NONCONFIDENT_IN_DOMAIN_COMMAND &&
            response.rankingResponse.pole)
            confident = Tp.DialogueHandler.Confidence.CONFIDENT_IN_DOMAIN_COMMAND;

        // choose computation over other types of results, regardless of what bing returns (bing ranking is terrible)
        if (response.computation) {
            // computation should take over from thingtalk
            // unless the reply is just a measure answer, in which case we should let
            // thingtalk interpret it
            if (confident !== Tp.DialogueHandler.Confidence.EXACT_IN_DOMAIN_COMMAND &&
                !/^\s*[0-9.-]+\s+[a-z]+\.?\s*$/i.test(utterance))
                confident = Tp.DialogueHandler.Confidence.STRONLY_CONFIDENT_IN_DOMAIN_COMMAND; // FIXME
            return {
                confident,
                utterance,
                user_target: `$dialogue @com.bing.computation;`,

                query: response.queryContext,
                answerType: 'computation',
                response: response.computation
            };
        }
        // same for timezone answers
        if (response.timeZone) {
            return {
                confident,
                utterance,
                user_target: `$dialogue @com.bing.timeZone;`,

                query: response.queryContext,
                answerType: 'timeZone',
                response: response.timeZone
            };
        }

        const bestRankingItems = [];
        if (response.rankingResponse.pole && response.rankingResponse.pole.items) {
            if (response.rankingResponse.pole.items instanceof Array)
                bestRankingItems.push(...response.rankingResponse.pole.items);
            else if ('answerType' in response.rankingResponse.pole.items)
                bestRankingItems.push(response.rankingResponse.pole.items);
        }
        if (response.rankingResponse.mainline && response.rankingResponse.mainline.items) {
            if (response.rankingResponse.mainline.items instanceof Array)
                bestRankingItems.push(...response.rankingResponse.mainline.items);
            else if ('answerType' in response.rankingResponse.mainline.items)
                bestRankingItems.push(response.rankingResponse.mainline.items);
        }
        if (response.rankingResponse.sidebar && response.rankingResponse.sidebar.items) {
            if (response.rankingResponse.sidebar.items instanceof Array)
                bestRankingItems.push(...response.rankingResponse.sidebar.items);
            else if ('answerType' in response.rankingResponse.sidebar.items)
                bestRankingItems.push(response.rankingResponse.sidebar.items);
        }

        for (const candidate of bestRankingItems) {
            const answerType = toCamelCase(candidate.answerType);
            if (answerType === 'videos' || answerType === 'relatedSearches' || answerType === 'images')
                continue;
            let bestResponse = response[answerType];
            if (!bestResponse)
                continue;
            if (answerType === 'entities' && !('resultIndex' in candidate))
                continue;
            if ('resultIndex' in candidate)
                bestResponse = bestResponse.value[candidate.resultIndex || 0];
            if (bestResponse) {
                return {
                    confident,
                    utterance,
                    user_target: `$dialogue @com.bing.${answerType};`,

                    query: response.queryContext,
                    answerType: answerType,
                    response: bestResponse
                };
            }
        }

        return { confident: Tp.DialogueHandler.Confidence.OUT_OF_DOMAIN_COMMAND, utterance, user_target: '' };
    }

    /**
     *
     * @param {Tp.DialogueHandler.CommandAnalysisResult} analysis
     * @returns {Tp.DialogueHandler.ReplyResult}
     */
    getReply(analysis) {
        //console.log(analysis);
        switch (analysis.answerType) {
        case 'webPages': {
            const webPage = analysis.response;
            return {
                messages: [
                    this._interp(this._("I found ${name}. ${description}."), {
                        name: webPage.name,
                        description: webPage.snippet
                    }),
                    {
                        type: 'rdl',
                        webCallback: webPage.url,
                        displayTitle: webPage.name,
                    }
                ],
                expecting: null,
                context: analysis.user_target,
                agent_target: '@com.bing.reply;'
            };
        }

        case 'computation':
            return {
                messages: [this._interp(this._("${expression} is equal to ${value}."), {
                    expression: analysis.response.expression,
                    value: analysis.response.value
                })],
                expecting: null,
                context: analysis.user_target,
                agent_target: '$dialogue @com.bing.reply;'
            };

        case 'entities': {
            const entity = analysis.response;
            if (!(entity.name || entity.description) || entity.name === "" || entity.description === "")
                throw new Error(`Unexpected bing answer type (invalid entity)`);
            return {
                messages: [
                    this._interp(this._("${description}."), {
                        name: entity.name,
                        description: entity.description
                    }),
                    {
                        type: 'rdl',
                        webCallback: entity.webSearchUrl,
                        displayTitle: entity.name,
                        pictureUrl: (entity.image === undefined || entity.image.thumbnailUrl === undefined) ? "" : entity.image.thumbnailUrl
                    }
                ],
                expecting: null,
                context: analysis.user_target,
                agent_target: '@com.bing.reply;'
            };
        }

        case 'spellSuggestions': {
            const rewrite = analysis.response.query[0];
            this._lastQuerySuggestion = rewrite.text;
            return {
                messages: [
                    this._interp(this._("Did you mean ${rewrite}?"), {
                        rewrite: rewrite.displayText,
                    })
                ],
                expecting: TT.Type.Boolean,
                context: analysis.user_target,
                agent_target: '@com.bing.propose_spell_suggestion;'
            };
        }

        case 'translations': {
            return {
                messages: [
                    this._interp(this._("The translation is “${translation}”. Data from ${attribution}."), {
                        translation: analysis.response.translatedText,
                        attribution: analysis.response.attributions.map((a) => a.providerDisplayName)
                    }),
                ],
                expecting: null,
                context: analysis.user_target,
                agent_target: '@com.bing.reply;'
            };
        }

        case 'news': {
            return {
                messages: [
                    this._interp(this._("I found ${name}. ${description}."), {
                        name: analysis.response.value[0].name,
                        description: analysis.response.value[0].description,
                    }),
                    {
                        type: 'rdl',
                        webCallback: analysis.response.value[0].url,
                        displayTitle: analysis.response.value[0].name
                    }
                ],
                expecting: null,
                context: analysis.user_target,
                agent_target: '@com.bing.reply;'
            };
        }

        case 'timeZone': {
            if (analysis.response.description && analysis.response.primaryResponse) {
                return {
                    messages: [
                        this._interp(this._("${description} is ${answer}."), {
                            description: analysis.response.description,
                            answer: analysis.response.primaryResponse,
                        }),
                    ],
                    expecting: null,
                    context: analysis.user_target,
                    agent_target: '@com.bing.reply;'
                };
            } else if (analysis.response.primaryCityTime) {
                return {
                    messages: [
                        this._interp(this._("Right now it is ${time} in ${location}."), {
                            time: Temporal.PlainDateTime.from(analysis.response.primaryCityTime.time).toLocaleString(this._locale, { timeStyle: 'short' }),
                            location: analysis.response.primaryCityTime.location
                        }),
                    ],
                    expecting: null,
                    context: analysis.user_target,
                    agent_target: '@com.bing.reply;'
                };
            } else if (analysis.response.primaryTimeZone) {
                return {
                    messages: [
                        this._interp(this._("${location} uses ${timezone}."), {
                            location: analysis.response.primaryTimeZone.location,
                            timezone: analysis.response.primaryTimeZone.timeZoneName,
                        }),
                    ],
                    expecting: null,
                    context: analysis.user_target,
                    agent_target: '@com.bing.reply;'
                };
            } else {
                // fallthrough
            }
        }

        case 'places': {
            if (analysis.response.value && analysis.response.value.length > 0) {
                return {
                    messages: [
                        this._interp(this._("I found ${name}. Its phone number is ${phone}."), {
                            name: analysis.response.value[0].name,
                            phone: analysis.response.value[0].telephone,
                        }),
                    ],
                };
            } else {
                // fallthrough
            }
        }

        default:
            LOG.error(`Unexpected bing answer type`, analysis);
            return {
                messages: [
                    this._("Sorry, I don't know that one yet.")
                ],
                expecting: null,
                context: analysis.user_target,
                agent_target: '@com.bing.reply_fail;'
            };
        }
    }
}

class BingClass extends Tp.BaseDevice {
    /**
     *
     * @param {Tp.BaseEngine} engine
     * @param {Tp.BaseDevice.DeviceState} state
     */
    constructor(engine, state) {
        super(engine, state);
        this._dialogueHandler = new BingDialogueHandler(this.platform.locale, this.platform.timezone, this.constructor.metadata.auth.api_key);
    }

    /**
     *
     * @param {string} iface
     */
    queryInterface(iface) {
        switch (iface) {
        case 'dialogue-handler':
            return this._dialogueHandler;

        default:
            return super.queryInterface(iface);
        }
    }

    get_web_search({ query }, hints) {
        const locale = this.platform.locale;
        const count = hints.limit && !hints.sort ? hints.limit : 5;

        const url = `https://api.cognitive.microsoft.com/bing/v7.0/search?count=${count}&mkt=${locale}&setLang=${locale}&q=${encodeURIComponent(query)}&responseFilter=Webpages`;
        return Tp.Helpers.Http.get(url, {
            extraHeaders: { 'Ocp-Apim-Subscription-Key': this.constructor.metadata.auth.api_key }
        }).then((response) => {
            let parsedResponse = JSON.parse(response);
            return parsedResponse.webPages.value.map((result) => {
                return ({
                    query: query,
                    title: result.name,
                    description: result.snippet,
                    link: result.url,
                });
            });
        });
    }

    get_image_search({ query }, hints) {
        const locale = this.platform.locale;
        const count = hints.limit && !hints.sort ? hints.limit : 5;

        let url = `https://api.cognitive.microsoft.com/bing/v7.0/images/search?count=${count}&mkt=${locale}&setLang=${locale}&q=${encodeURIComponent(query)}`;

        for (const filter of hints.filter || []) {
            if (filter[0] === 'width') {
                if (filter[1] === '==')
                    url += `&width=${filter[2]}`;
                else if (filter[1] === '>=')
                    url += `&minWidth=${filter[2]}`;
                else if (filter[1] === '<=')
                    url += `&maxWidth=${filter[2]}`;
            } else if (filter[0] === 'height') {
                if (filter[1] === '==')
                    url += `&height=${filter[2]}`;
                else if (filter[1] === '>=')
                    url += `&minHeight=${filter[2]}`;
                else if (filter[1] === '<=')
                    url += `&maxHeight=${filter[2]}`;
            }
        }
        return Tp.Helpers.Http.get(url, {
            extraHeaders: { 'Ocp-Apim-Subscription-Key': this.constructor.metadata.auth.api_key }
        }).then((response) => {
            let parsedResponse = JSON.parse(response);
            return parsedResponse.value.map((result) => {
                return ({
                    query: query,
                    title: result.name,
                    picture_url: result.contentUrl,
                    link: result.hostPageUrl,
                    width: result.width,
                    height: result.height
                });
            });
        });

    }
}
module.exports = BingClass;

1	// -- mode: js; indent-tabs-mode: nil; js-basic-offset: 4 --
2	//
3	// Copyright 2016-2021 The Board of Trustees of the Leland Stanford Junior University
4	//
5	// Redistribution and use in source and binary forms, with or
6	// without modification, are permitted provided that the following
7	// conditions are met:
8	//
9	// 1. Redistributions of source code must retain the above copyright
10	// notice, this list of conditions and the following disclaimer.
11	// 2. Redistributions in binary form must reproduce the above
12	// copyright notice, this list of conditions and the following
13	// disclaimer in the documentation and/or other materials
14	// provided with the distribution.
15	// 3. Neither the name of the copyright holder nor the names of its
16	// contributors may be used to endorse or promote products derived
17	// from this software without specific prior written permission.
18	//
19	// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20	// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21	// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
22	// FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
23	// COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
24	// INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
25	// (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
26	// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27	// HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
28	// STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29	// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
30	// OF THE POSSIBILITY OF SUCH DAMAGE.
31	"use strict";
32
33	const util = require('util');	2✔
34	const interpolate = require('string-interp');	2✔
35	const Tp = require('thingpedia');	2✔
36	const TT = require('thingtalk');	2✔
37	const qs = require('querystring');	2✔
38	const Logging = require("@stanford-oval/logging");	2✔
39	const Winston = require("winston");	2✔
40
41	const LogFactory = new Logging.Factory({	2✔
42	runRoot: __dirname,
43	level: "http",
44	envVarPrefix: "TP_BING_LOG",
45	transports: [
46	new Winston.transports.Console({
47	format: Logging.Format.prettySimple({ colorize: true }),
48	}),
49	],
50	});
51
52	const LOG = LogFactory.get(__filename);	2✔
53	const { Temporal } = require('@js-temporal/polyfill');	2✔
54
55	/**
56	*
57	* @param {string} x
58	* @returns {string}
59	*/
60	function toCamelCase(x) {
61	return x[0].toLowerCase() + x.substring(1);	105✔
62	}
63
64	class BingDialogueHandler {
65	/**
66	*
67	* @param {string} locale
68	* @param {string} timezone
69	* @param {string} apiKey
70	*/
71	constructor(locale, timezone, apiKey) {
72	this._locale = locale;	2✔
73	this._timezone = timezone;	2✔
74	this._apiKey = apiKey;	2✔
75
76	this._ = BingClass.gettext.gettext;	2✔
77
78	this._lastQuerySuggestion = null;	2✔
79	}
80
81	_interp(string, args) {
82	return interpolate(string, args, {	3✔
83	locale: this._locale,
84	timezone: this._timezone,
85	});
86	}
87
88	get priority() {
89	return Tp.DialogueHandler.Priority.FALLBACK;	347✔
90	}
91	get icon() {
92	return 'com.bing';	3✔
93	}
94
95	getState() {
96	return { lastQuerySuggestion: this._lastQuerySuggestion };	1,079✔
97	}
98	async initialize(initialState) {
99	if (initialState)	1!
100	this._lastQuerySuggestion = initialState.lastQuerySuggestion;	×
101	return null;	1✔
102	}
103	reset() {
104	this._lastQuerySuggestion = null;	197✔
105	}
106
107	/**
108	*
109	* @param {string} command
110	* @returns {Tp.DialogueHandler.CommandAnalysisResult}
111	*/
112	async analyzeCommand(utterance) {
113	let confident = Tp.DialogueHandler.Confidence.NONCONFIDENT_IN_DOMAIN_COMMAND;	83✔
114	let query = utterance;	83✔
115
116	const prefixregexp = new RegExp(this._("^\\s*ask bing (to\|for)?\\b"), 'i');	83✔
117	const prefixmatch = prefixregexp.exec(utterance);	83✔
118	if (prefixmatch) {	83✔
119	query = utterance.substring(prefixmatch[0].length).trim();	1✔
120	confident = Tp.DialogueHandler.Confidence.EXACT_IN_DOMAIN_COMMAND;	1✔
121	}
122	const suffixregexp = new RegExp(this._("\\b(ask\|on\|using) bing\\?\\s$"), 'i');	83✔
123	const suffixmatch = suffixregexp.exec(utterance);	83✔
124	if (suffixmatch) {	83!
125	query = utterance.substring(0, utterance.length-suffixmatch[0].length).trim();	×
126	confident = Tp.DialogueHandler.Confidence.EXACT_IN_DOMAIN_COMMAND;	×
127	}
128
129	if (this._lastQuerySuggestion) {	83!
130	const yes = new RegExp(this._("^\\s*(yes\|yeah\|yep\|sure)\b"));	×
131	const yesmatch = yes.exec(utterance);	×
132	if (yesmatch) {	×
133	query = this._lastQuerySuggestion;	×
134	confident = Tp.DialogueHandler.Confidence.EXACT_IN_DOMAIN_FOLLOWUP;	×
135	}
136	}
137
138	const response = JSON.parse(await Tp.Helpers.Http.get(`https://api.cognitive.microsoft.com/bing/v7.0/search?` + qs.stringify({	83✔
139	mkt: this._locale,
140	setLang: this._locale,
141	q: query,
142	}), {
143	extraHeaders: { 'Ocp-Apim-Subscription-Key': this._apiKey }
144	}));
145	if (process.env.TP_BING_DEBUG)	83!
146	console.log(util.inspect(response, { depth: Infinity }));	×
147
148	if (!response.rankingResponse)	83!
149	return { confident: Tp.DialogueHandler.Confidence.OUT_OF_DOMAIN_COMMAND, utterance, user_target: '' };	×
150
151	if (confident === Tp.DialogueHandler.Confidence.NONCONFIDENT_IN_DOMAIN_COMMAND &&	83✔
152	response.rankingResponse.pole)
153	confident = Tp.DialogueHandler.Confidence.CONFIDENT_IN_DOMAIN_COMMAND;	3✔
154
155	// choose computation over other types of results, regardless of what bing returns (bing ranking is terrible)
156	if (response.computation) {	83✔
157	// computation should take over from thingtalk
158	// unless the reply is just a measure answer, in which case we should let
159	// thingtalk interpret it
160	if (confident !== Tp.DialogueHandler.Confidence.EXACT_IN_DOMAIN_COMMAND &&	3✔
161	!/^\s[0-9.-]+\s+[a-z]+\.?\s$/i.test(utterance))
162	confident = Tp.DialogueHandler.Confidence.STRONLY_CONFIDENT_IN_DOMAIN_COMMAND; // FIXME	1✔
163	return {	3✔
164	confident,
165	utterance,
166	user_target: `$dialogue @com.bing.computation;`,
167
168	query: response.queryContext,
169	answerType: 'computation',
170	response: response.computation
171	};
172	}
173	// same for timezone answers
174	if (response.timeZone) {	80✔
175	return {	1✔
176	confident,
177	utterance,
178	user_target: `$dialogue @com.bing.timeZone;`,
179
180	query: response.queryContext,
181	answerType: 'timeZone',
182	response: response.timeZone
183	};
184	}
185
186	const bestRankingItems = [];	79✔
187	if (response.rankingResponse.pole && response.rankingResponse.pole.items) {	79✔
188	if (response.rankingResponse.pole.items instanceof Array)	3!
189	bestRankingItems.push(...response.rankingResponse.pole.items);	3✔
190	else if ('answerType' in response.rankingResponse.pole.items)	×
191	bestRankingItems.push(response.rankingResponse.pole.items);	×
192	}
193	if (response.rankingResponse.mainline && response.rankingResponse.mainline.items) {	79!
194	if (response.rankingResponse.mainline.items instanceof Array)	79!
195	bestRankingItems.push(...response.rankingResponse.mainline.items);	79✔
196	else if ('answerType' in response.rankingResponse.mainline.items)	×
197	bestRankingItems.push(response.rankingResponse.mainline.items);	×
198	}
199	if (response.rankingResponse.sidebar && response.rankingResponse.sidebar.items) {	79✔
200	if (response.rankingResponse.sidebar.items instanceof Array)	58!
201	bestRankingItems.push(...response.rankingResponse.sidebar.items);	58✔
202	else if ('answerType' in response.rankingResponse.sidebar.items)	×
203	bestRankingItems.push(response.rankingResponse.sidebar.items);	×
204	}
205
206	for (const candidate of bestRankingItems) {	79✔
207	const answerType = toCamelCase(candidate.answerType);	105✔
208	if (answerType === 'videos' \|\| answerType === 'relatedSearches' \|\| answerType === 'images')	105✔
209	continue;	23✔
210	let bestResponse = response[answerType];	82✔
211	if (!bestResponse)	82!
UNCOV 212	continue;	×
213	if (answerType === 'entities' && !('resultIndex' in candidate))	82✔
214	continue;	3✔
215	if ('resultIndex' in candidate)	79✔
216	bestResponse = bestResponse.value[candidate.resultIndex \|\| 0];	77✔
217	if (bestResponse) {	79!
218	return {	79✔
219	confident,
220	utterance,
221	user_target: `$dialogue @com.bing.${answerType};`,
222
223	query: response.queryContext,
224	answerType: answerType,
225	response: bestResponse
226	};
227	}
228	}
229
230	return { confident: Tp.DialogueHandler.Confidence.OUT_OF_DOMAIN_COMMAND, utterance, user_target: '' };	×
231	}
232
233	/**
234	*
235	* @param {Tp.DialogueHandler.CommandAnalysisResult} analysis
236	* @returns {Tp.DialogueHandler.ReplyResult}
237	*/
238	getReply(analysis) {
239	//console.log(analysis);
240	switch (analysis.answerType) {	3!
241	case 'webPages': {
242	const webPage = analysis.response;	1✔
243	return {	1✔
244	messages: [
245	this._interp(this._("I found ${name}. ${description}."), {
246	name: webPage.name,
247	description: webPage.snippet
248	}),
249	{
250	type: 'rdl',
251	webCallback: webPage.url,
252	displayTitle: webPage.name,
253	}
254	],
255	expecting: null,
256	context: analysis.user_target,
257	agent_target: '@com.bing.reply;'
258	};
259	}
260
261	case 'computation':
262	return {	1✔
263	messages: [this._interp(this._("${expression} is equal to ${value}."), {
264	expression: analysis.response.expression,
265	value: analysis.response.value
266	})],
267	expecting: null,
268	context: analysis.user_target,
269	agent_target: '$dialogue @com.bing.reply;'
270	};
271
272	case 'entities': {
273	const entity = analysis.response;	×
274	if (!(entity.name \|\| entity.description) \|\| entity.name === "" \|\| entity.description === "")	×
275	throw new Error(`Unexpected bing answer type (invalid entity)`);	×
276	return {	×
277	messages: [
278	this._interp(this._("${description}."), {
279	name: entity.name,
280	description: entity.description
281	}),
282	{
283	type: 'rdl',
284	webCallback: entity.webSearchUrl,
285	displayTitle: entity.name,
286	pictureUrl: (entity.image === undefined \|\| entity.image.thumbnailUrl === undefined) ? "" : entity.image.thumbnailUrl	×
287	}
288	],
289	expecting: null,
290	context: analysis.user_target,
291	agent_target: '@com.bing.reply;'
292	};
293	}
294
295	case 'spellSuggestions': {
296	const rewrite = analysis.response.query[0];	×
297	this._lastQuerySuggestion = rewrite.text;	×
298	return {	×
299	messages: [
300	this._interp(this._("Did you mean ${rewrite}?"), {
301	rewrite: rewrite.displayText,
302	})
303	],
304	expecting: TT.Type.Boolean,
305	context: analysis.user_target,
306	agent_target: '@com.bing.propose_spell_suggestion;'
307	};
308	}
309
310	case 'translations': {
311	return {	×
312	messages: [
313	this._interp(this._("The translation is “${translation}”. Data from ${attribution}."), {
314	translation: analysis.response.translatedText,
315	attribution: analysis.response.attributions.map((a) => a.providerDisplayName)	×
316	}),
317	],
318	expecting: null,
319	context: analysis.user_target,
320	agent_target: '@com.bing.reply;'
321	};
322	}
323
324	case 'news': {
325	return {	×
326	messages: [
327	this._interp(this._("I found ${name}. ${description}."), {
328	name: analysis.response.value[0].name,
329	description: analysis.response.value[0].description,
330	}),
331	{
332	type: 'rdl',
333	webCallback: analysis.response.value[0].url,
334	displayTitle: analysis.response.value[0].name
335	}
336	],
337	expecting: null,
338	context: analysis.user_target,
339	agent_target: '@com.bing.reply;'
340	};
341	}
342
343	case 'timeZone': {
344	if (analysis.response.description && analysis.response.primaryResponse) {	1!
345	return {	×
346	messages: [
347	this._interp(this._("${description} is ${answer}."), {
348	description: analysis.response.description,
349	answer: analysis.response.primaryResponse,
350	}),
351	],
352	expecting: null,
353	context: analysis.user_target,
354	agent_target: '@com.bing.reply;'
355	};
356	} else if (analysis.response.primaryCityTime) {	1!
357	return {	1✔
358	messages: [
359	this._interp(this._("Right now it is ${time} in ${location}."), {
360	time: Temporal.PlainDateTime.from(analysis.response.primaryCityTime.time).toLocaleString(this._locale, { timeStyle: 'short' }),
361	location: analysis.response.primaryCityTime.location
362	}),
363	],
364	expecting: null,
365	context: analysis.user_target,
366	agent_target: '@com.bing.reply;'
367	};
368	} else if (analysis.response.primaryTimeZone) {	×
369	return {	×
370	messages: [
371	this._interp(this._("${location} uses ${timezone}."), {
372	location: analysis.response.primaryTimeZone.location,
373	timezone: analysis.response.primaryTimeZone.timeZoneName,
374	}),
375	],
376	expecting: null,
377	context: analysis.user_target,
378	agent_target: '@com.bing.reply;'
379	};
380	} else {
381	// fallthrough
382	}
383	}
384
385	case 'places': {
386	if (analysis.response.value && analysis.response.value.length > 0) {	×
387	return {	×
388	messages: [
389	this._interp(this._("I found ${name}. Its phone number is ${phone}."), {
390	name: analysis.response.value[0].name,
391	phone: analysis.response.value[0].telephone,
392	}),
393	],
394	};
395	} else {
396	// fallthrough
397	}
398	}
399
400	default:
401	LOG.error(`Unexpected bing answer type`, analysis);	×
402	return {	×
403	messages: [
404	this._("Sorry, I don't know that one yet.")
405	],
406	expecting: null,
407	context: analysis.user_target,
408	agent_target: '@com.bing.reply_fail;'
409	};
410	}
411	}
412	}
413
414	class BingClass extends Tp.BaseDevice {
415	/**
416	*
417	* @param {Tp.BaseEngine} engine
418	* @param {Tp.BaseDevice.DeviceState} state
419	*/
420	constructor(engine, state) {
421	super(engine, state);	2✔
422	this._dialogueHandler = new BingDialogueHandler(this.platform.locale, this.platform.timezone, this.constructor.metadata.auth.api_key);	2✔
423	}
424
425	/**
426	*
427	* @param {string} iface
428	*/
429	queryInterface(iface) {
430	switch (iface) {	390✔
431	case 'dialogue-handler':
432	return this._dialogueHandler;	1✔
433
434	default:
435	return super.queryInterface(iface);	389✔
436	}
437	}
438
439	get_web_search({ query }, hints) {
440	const locale = this.platform.locale;	2✔
441	const count = hints.limit && !hints.sort ? hints.limit : 5;	2!
442
443	const url = `https://api.cognitive.microsoft.com/bing/v7.0/search?count=${count}&mkt=${locale}&setLang=${locale}&q=${encodeURIComponent(query)}&responseFilter=Webpages`;	2✔
444	return Tp.Helpers.Http.get(url, {	2✔
445	extraHeaders: { 'Ocp-Apim-Subscription-Key': this.constructor.metadata.auth.api_key }
446	}).then((response) => {
447	let parsedResponse = JSON.parse(response);	2✔
448	return parsedResponse.webPages.value.map((result) => {	2✔
449	return ({	10✔
450	query: query,
451	title: result.name,
452	description: result.snippet,
453	link: result.url,
454	});
455	});
456	});
457	}
458
459	get_image_search({ query }, hints) {
460	const locale = this.platform.locale;	1✔
461	const count = hints.limit && !hints.sort ? hints.limit : 5;	1!
462
463	let url = `https://api.cognitive.microsoft.com/bing/v7.0/images/search?count=${count}&mkt=${locale}&setLang=${locale}&q=${encodeURIComponent(query)}`;	1✔
464
465	for (const filter of hints.filter \|\| []) {	1✔
466	if (filter[0] === 'width') {	×
467	if (filter[1] === '==')	×
468	url += `&width=${filter[2]}`;	×
469	else if (filter[1] === '>=')	×
470	url += `&minWidth=${filter[2]}`;	×
471	else if (filter[1] === '<=')	×
472	url += `&maxWidth=${filter[2]}`;	×
473	} else if (filter[0] === 'height') {	×
474	if (filter[1] === '==')	×
475	url += `&height=${filter[2]}`;	×
476	else if (filter[1] === '>=')	×
477	url += `&minHeight=${filter[2]}`;	×
478	else if (filter[1] === '<=')	×
479	url += `&maxHeight=${filter[2]}`;	×
480	}
481	}
482	return Tp.Helpers.Http.get(url, {	1✔
483	extraHeaders: { 'Ocp-Apim-Subscription-Key': this.constructor.metadata.auth.api_key }
484	}).then((response) => {
485	let parsedResponse = JSON.parse(response);	1✔
486	return parsedResponse.value.map((result) => {	1✔
487	return ({	5✔
488	query: query,
489	title: result.name,
490	picture_url: result.contentUrl,
491	link: result.hostPageUrl,
492	width: result.width,
493	height: result.height
494	});
495	});
496	});
497
498	}
499	}
500	module.exports = BingClass;	2✔

stanford-oval / thingpedia-common-devices / 1730

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous