6811766663

Committed 09 Nov 2023 12:27PM UTC coverage: 84.638% (+0.005%) from 84.633%

Build # 6811766663

Build Type

push

github

Committed by

web-flow

Commit Message

fix: [#4545] Please upgrade zod package - botbuilder (#4561)

* update zod in botbuilder

* change ts support in test consumer

* fix ts config

* simplify use of safeParse

* fix lint

---------

Co-authored-by: JhontSouth <jhonatan.sandoval@southworks.com>

Run Details

9951 of 13026 branches covered (0.0%)

Branch coverage included in aggregate %.

17 of 30 new or added lines in 5 files covered. (56.67%)

1 existing line in 1 file now uncovered.

20336 of 22758 relevant lines covered (89.36%)

7241.62 hits per line

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

81.67

/libraries/botbuilder/src/setSpeakMiddleware.ts

// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.

import * as z from 'zod';
import { ActivityTypes, Channels, Middleware, TurnContext } from 'botbuilder-core';
import { parseDocument } from 'htmlparser2';

const supportedChannels = new Set<string>([Channels.DirectlineSpeech, Channels.Emulator, Channels.Telephony]);

// Iterate through `obj` and all children in an attempt to locale a key `tag`
function hasTag(tag: string, nodes: unknown[]): boolean {
    while (nodes.length) {
        const item = nodes.shift();
        const itemParsed = z
            .object({ tagName: z.string(), children: z.array(z.unknown()) })
            .partial()
            .nonstrict()
            .safeParse(item);

        if (itemParsed.success) {
            if (itemParsed.data.tagName === tag) {
                return true;
            }

            if (itemParsed.data.children) {
                nodes.push(...itemParsed.data.children);
            }
        }
    }

    return false;
}

/**
 * Support the DirectLine speech and telephony channels to ensure the appropriate SSML tags are set on the
 * Activity Speak property.
 */
export class SetSpeakMiddleware implements Middleware {
    /**
     * Initializes a new instance of the SetSpeakMiddleware class.
     *
     * @param voiceName The SSML voice name attribute value.
     * @param fallbackToTextForSpeak true if an empty Activity.Speak is populated with Activity.Text.
     */
    constructor(private readonly voiceName: string | null, private readonly fallbackToTextForSpeak: boolean) {}

    /**
     * Processes an incoming activity.
     *
     * @param turnContext The context object for this turn.
     * @param next The delegate to call to continue the bot middleware pipeline.
     * @returns A promise representing the async operation.
     */
    onTurn(turnContext: TurnContext, next: () => Promise<void>): Promise<void> {
        turnContext.onSendActivities(async (_ctx, activities, next) => {
            await Promise.all(
                activities.map(async (activity) => {
                    if (activity.type !== ActivityTypes.Message) {
                        return;
                    }

                    if (this.fallbackToTextForSpeak && !activity.speak) {
                        activity.speak = activity.text;
                    }

                    const channelId = turnContext.activity.channelId?.trim().toLowerCase();

                    if (activity.speak && this.voiceName !== null && supportedChannels.has(channelId)) {
                        const nodes = parseDocument(activity.speak).childNodes;

                        if (!hasTag('speak', nodes.slice())) {
                            if (!hasTag('voice', nodes.slice())) {
                                activity.speak = `<voice name='${this.voiceName}'>${activity.speak}</voice>`;
                            }

                            activity.speak = `<speak version='1.0' xmlns='http://www.w3.org/2001/10/synthesis' xml:lang='${
                                activity.locale ?? 'en-US'
                            }'>${activity.speak}</speak>`;
                        }
                    }
                })
            );

            return next();
        });

        return next();
    }
}

1	// Copyright (c) Microsoft Corporation.
2	// Licensed under the MIT License.
3
4	import * as z from 'zod';	2✔
5	import { ActivityTypes, Channels, Middleware, TurnContext } from 'botbuilder-core';	2✔
6	import { parseDocument } from 'htmlparser2';	2✔
7
8	const supportedChannels = new Set<string>([Channels.DirectlineSpeech, Channels.Emulator, Channels.Telephony]);	2✔
9
10	// Iterate through `obj` and all children in an attempt to locale a key `tag`
11	function hasTag(tag: string, nodes: unknown[]): boolean {
12	while (nodes.length) {	4✔
13	const item = nodes.shift();	4✔
14	const itemParsed = z	4✔
15	.object({ tagName: z.string(), children: z.array(z.unknown()) })
16	.partial()
17	.nonstrict()
18	.safeParse(item);
19
20	if (itemParsed.success) {	4!
21	if (itemParsed.data.tagName === tag) {	4!
UNCOV 22	return true;	×
23	}
24
25	if (itemParsed.data.children) {	4!
NEW 26	nodes.push(...itemParsed.data.children);	×
27	}
28	}
29	}
30
31	return false;	4✔
32	}
33
34	/**
35	* Support the DirectLine speech and telephony channels to ensure the appropriate SSML tags are set on the
36	* Activity Speak property.
37	*/
38	export class SetSpeakMiddleware implements Middleware {	2✔
39	/**
40	* Initializes a new instance of the SetSpeakMiddleware class.
41	*
42	* @param voiceName The SSML voice name attribute value.
43	* @param fallbackToTextForSpeak true if an empty Activity.Speak is populated with Activity.Text.
44	*/
45	constructor(private readonly voiceName: string \| null, private readonly fallbackToTextForSpeak: boolean) {}	12✔
46
47	/**
48	* Processes an incoming activity.
49	*
50	* @param turnContext The context object for this turn.
51	* @param next The delegate to call to continue the bot middleware pipeline.
52	* @returns A promise representing the async operation.
53	*/
54	onTurn(turnContext: TurnContext, next: () => Promise<void>): Promise<void> {
55	turnContext.onSendActivities(async (_ctx, activities, next) => {	10✔
56	await Promise.all(	10✔
57	activities.map(async (activity) => {	10✔
58	if (activity.type !== ActivityTypes.Message) {	10!
59	return;	×
60	}
61
62	if (this.fallbackToTextForSpeak && !activity.speak) {	10✔
63	activity.speak = activity.text;	6✔
64	}
65
66	const channelId = turnContext.activity.channelId?.trim().toLowerCase();	10!
67
68	if (activity.speak && this.voiceName !== null && supportedChannels.has(channelId)) {	10✔
69	const nodes = parseDocument(activity.speak).childNodes;	2✔
70
71	if (!hasTag('speak', nodes.slice())) {	2!
72	if (!hasTag('voice', nodes.slice())) {	2!
73	activity.speak = `<voice name='${this.voiceName}'>${activity.speak}</voice>`;	2✔
74	}
75
76	activity.speak = `<speak version='1.0' xmlns='http://www.w3.org/2001/10/synthesis' xml:lang='${	2✔
77	activity.locale ?? 'en-US'	6!
78	}'>${activity.speak}</speak>`;
79	}
80	}
81	})
82	);
83
84	return next();	10✔
85	});
86
87	return next();	10✔
88	}
89	}

microsoft / botbuilder-js / 6811766663

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