11576939296

Committed 29 Oct 2024 03:15PM UTC coverage: 84.703% (-0.5%) from 85.23%

Build # 11576939296

Build Type

Pull #4774

github

Committed by

web-flow

Commit Message

Merge fcec82c6b into 6ef82744a

Pull Request Pull Request #4774: refactor: [#4684] Replace browserify with tsup

Run Details

8186 of 10820 branches covered (75.66%)

Branch coverage included in aggregate %.

2 of 2 new or added lines in 1 file covered. (100.0%)

23 existing lines in 13 files now uncovered.

20514 of 23063 relevant lines covered (88.95%)

7295.62 hits per line

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

73.17

/libraries/botframework-streaming/src/payloads/streamManager.ts

/**
 * @module botframework-streaming
 */
/**
 * Copyright (c) Microsoft Corporation. All rights reserved.
 * Licensed under the MIT License.
 */
import { IHeader } from '../interfaces';
import { SubscribableStream } from '../subscribableStream';
import { PayloadAssembler } from '../assemblers/payloadAssembler';

/**
 * Orchestrates and manages streams.
 */
export class StreamManager {
    private readonly activeAssemblers = [];

    /**
     * Initializes a new instance of the [StreamManager](xref:botframework-streaming.StreamManager) class.
     *
     * @param onCancelStream Function to trigger if the managed stream is cancelled.
     */
    constructor(private readonly onCancelStream: (contentStreamAssembler: PayloadAssembler) => void) {}

    /**
     * Retrieves a [PayloadAssembler](xref:botframework-streaming.PayloadAssembler) with the given ID if one exists, otherwise a new instance is created and assigned the given ID.
     *
     * @param id The ID of the [PayloadAssembler](xref:botframework-streaming.PayloadAssembler) to retrieve or create.
     * @returns The [PayloadAssembler](xref:botframework-streaming.PayloadAssembler) with the given ID.
     */
    getPayloadAssembler(id: string): PayloadAssembler {
        if (!this.activeAssemblers[id]) {
            // A new id has come in, kick off the process of tracking it.
            const assembler = new PayloadAssembler(this, { id });
            this.activeAssemblers[id] = assembler;

            return assembler;
        } else {
            return this.activeAssemblers[id];
        }
    }

    /**
     * Retrieves the [SubscribableStream](xref:botframework-streaming.SubscribableStream) from the [PayloadAssembler](xref:botframework-streaming.PayloadAssembler) this manager manages.
     *
     * @param header The Header of the [SubscribableStream](xref:botframework-streaming.SubscribableStream) to retrieve.
     * @returns The [SubscribableStream](xref:botframework-streaming.SubscribableStream) with the given header.
     */
    getPayloadStream(header: IHeader): SubscribableStream {
        const assembler = this.getPayloadAssembler(header.id);

        return assembler.getPayloadStream();
    }

    /**
     * Used to set the behavior of the managed [PayloadAssembler](xref:botframework-streaming.PayloadAssembler) when data is received.
     *
     * @param header The Header of the stream.
     * @param contentStream The [SubscribableStream](xref:botframework-streaming.SubscribableStream) to write incoming data to.
     * @param contentLength The amount of data to write to the contentStream.
     */
    onReceive(header: IHeader, contentStream: SubscribableStream, contentLength: number): void {
        if (!this.activeAssemblers[header.id]) {
            return;
        }
        this.activeAssemblers[header.id].onReceive(header, contentStream, contentLength);
    }

    /**
     * Closes the [PayloadAssembler](xref:botframework-streaming.PayloadAssembler) assigned to the [SubscribableStream](xref:botframework-streaming.SubscribableStream) with the given ID.
     *
     * @param id The ID of the [SubscribableStream](xref:botframework-streaming.SubscribableStream) to close.
     */
    closeStream(id: string): void {
        if (!this.activeAssemblers[id]) {
            return;
        } else {
            const assembler: PayloadAssembler = this.activeAssemblers[id];
            this.activeAssemblers.splice(this.activeAssemblers.indexOf(id), 1);
            const targetStream = assembler.getPayloadStream();
            if ((assembler.contentLength && targetStream.length < assembler.contentLength) || !assembler.end) {
                this.onCancelStream(assembler);
            }
        }
    }
}

1	/**	8✔
2	* @module botframework-streaming
3	*/
4	/**
5	* Copyright (c) Microsoft Corporation. All rights reserved.
6	* Licensed under the MIT License.
7	*/
8	import { IHeader } from '../interfaces';
9	import { SubscribableStream } from '../subscribableStream';
10	import { PayloadAssembler } from '../assemblers/payloadAssembler';	2✔
11
12	/**
13	* Orchestrates and manages streams.
14	*/
15	export class StreamManager {	2✔
16	private readonly activeAssemblers = [];	113✔
17
18	/**
19	* Initializes a new instance of the [StreamManager](xref:botframework-streaming.StreamManager) class.
20	*
21	* @param onCancelStream Function to trigger if the managed stream is cancelled.
22	*/
23	constructor(private readonly onCancelStream: (contentStreamAssembler: PayloadAssembler) => void) {}	113✔
24
25	/**
26	* Retrieves a [PayloadAssembler](xref:botframework-streaming.PayloadAssembler) with the given ID if one exists, otherwise a new instance is created and assigned the given ID.
27	*
28	* @param id The ID of the [PayloadAssembler](xref:botframework-streaming.PayloadAssembler) to retrieve or create.
29	* @returns The [PayloadAssembler](xref:botframework-streaming.PayloadAssembler) with the given ID.
30	*/
31	getPayloadAssembler(id: string): PayloadAssembler {
32	if (!this.activeAssemblers[id]) {	62!
33	// A new id has come in, kick off the process of tracking it.
34	const assembler = new PayloadAssembler(this, { id });	44✔
35	this.activeAssemblers[id] = assembler;	44✔
36
37	return assembler;	44✔
38	} else {
39	return this.activeAssemblers[id];	18✔
40	}
41	}
42
43	/**
44	* Retrieves the [SubscribableStream](xref:botframework-streaming.SubscribableStream) from the [PayloadAssembler](xref:botframework-streaming.PayloadAssembler) this manager manages.
45	*
46	* @param header The Header of the [SubscribableStream](xref:botframework-streaming.SubscribableStream) to retrieve.
47	* @returns The [SubscribableStream](xref:botframework-streaming.SubscribableStream) with the given header.
48	*/
49	getPayloadStream(header: IHeader): SubscribableStream {
50	const assembler = this.getPayloadAssembler(header.id);	22✔
51
52	return assembler.getPayloadStream();	22✔
53	}
54
55	/**
56	* Used to set the behavior of the managed [PayloadAssembler](xref:botframework-streaming.PayloadAssembler) when data is received.
57	*
58	* @param header The Header of the stream.
59	* @param contentStream The [SubscribableStream](xref:botframework-streaming.SubscribableStream) to write incoming data to.
60	* @param contentLength The amount of data to write to the contentStream.
61	*/
62	onReceive(header: IHeader, contentStream: SubscribableStream, contentLength: number): void {
63	if (!this.activeAssemblers[header.id]) {	24!
64	return;	2✔
65	}
66	this.activeAssemblers[header.id].onReceive(header, contentStream, contentLength);	22✔
67	}
68
69	/**
70	* Closes the [PayloadAssembler](xref:botframework-streaming.PayloadAssembler) assigned to the [SubscribableStream](xref:botframework-streaming.SubscribableStream) with the given ID.
71	*
72	* @param id The ID of the [SubscribableStream](xref:botframework-streaming.SubscribableStream) to close.
73	*/
74	closeStream(id: string): void {
75	if (!this.activeAssemblers[id]) {	12!
76	return;	10✔
77	} else {
78	const assembler: PayloadAssembler = this.activeAssemblers[id];	2✔
79	this.activeAssemblers.splice(this.activeAssemblers.indexOf(id), 1);	2✔
80	const targetStream = assembler.getPayloadStream();	2✔
81	if ((assembler.contentLength && targetStream.length < assembler.contentLength) \|\| !assembler.end) {	2!
82	this.onCancelStream(assembler);	2✔
83	}
84	}
UNCOV 85	}	×
86	}

microsoft / botbuilder-js / 11576939296

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