12752558330

Committed 13 Jan 2025 05:20PM UTC coverage: 84.412% (-0.2%) from 84.612%

Build # 12752558330

Build Type

Pull #4806

github

Committed by

web-flow

Commit Message

Merge 453e4eba2 into cd05a193d

Pull Request Pull Request #4806: feat: Support Sso for SharePoint bot ACEs

Run Details

6885 of 9082 branches covered (75.81%)

Branch coverage included in aggregate %.

7 of 57 new or added lines in 5 files covered. (12.28%)

1 existing line in 1 file now uncovered.

16866 of 19055 relevant lines covered (88.51%)

4679.63 hits per line

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

5.13

/libraries/botbuilder/src/sharepoint/sharePointActivityHandler.ts

/**
 * @module botbuilder
 */
/**
 * Copyright (c) Microsoft Corporation. All rights reserved.
 * Licensed under the MIT License.
 */

import {
    ActivityHandler,
    InvokeResponse,
    AceRequest,
    TurnContext,
    CardViewResponse,
    QuickViewResponse,
    GetPropertyPaneConfigurationResponse,
    SetPropertyPaneConfigurationResponse,
    HandleActionResponse,
} from 'botbuilder-core';

/**
 * The SharePointActivityHandler is derived from ActivityHandler. It adds support for
 * the SharePoint specific events and interactions
 */
export class SharePointActivityHandler extends ActivityHandler {
    /**
     * Invoked when an invoke activity is received from the connector.
     * Invoke activities can be used to communicate many different things.
     * Invoke activities communicate programmatic commands from a client or channel to a bot.
     *
     * @param context A strongly-typed context object for this turn
     * @returns A task that represents the work queued to execute
     */
    protected async onInvokeActivity(context: TurnContext): Promise<InvokeResponse> {
        try {
            if (!context.activity.name && context.activity.channelId === 'sharepoint') {
                throw new Error('NotImplemented');
            } else {
                switch (context.activity.name) {
                    case 'cardExtension/getCardView':
                        return ActivityHandler.createInvokeResponse(
                            await this.onSharePointTaskGetCardViewAsync(context, context.activity.value as AceRequest),
                        );

                    case 'cardExtension/getQuickView':
                        return ActivityHandler.createInvokeResponse(
                            await this.onSharePointTaskGetQuickViewAsync(context, context.activity.value as AceRequest),
                        );

                    case 'cardExtension/getPropertyPaneConfiguration':
                        return ActivityHandler.createInvokeResponse(
                            await this.onSharePointTaskGetPropertyPaneConfigurationAsync(
                                context,
                                context.activity.value as AceRequest,
                            ),
                        );

                    case 'cardExtension/setPropertyPaneConfiguration':
                        return ActivityHandler.createInvokeResponse(
                            await this.onSharePointTaskSetPropertyPaneConfigurationAsync(
                                context,
                                context.activity.value as AceRequest,
                            ),
                        );
                    case 'cardExtension/handleAction':
                        return ActivityHandler.createInvokeResponse(
                            await this.onSharePointTaskHandleActionAsync(context, context.activity.value as AceRequest),
                        );
                    case 'cardExtension/token':
                        await this.onSignInInvoke(context);
                        return ActivityHandler.createInvokeResponse();
                    default:
                        return super.onInvokeActivity(context);
                }
            }
        } catch (err) {
            if (err.message === 'NotImplemented') {
                return { status: 501 };
            } else if (err.message === 'BadRequest') {
                return { status: 400 };
            }
            throw err;
        }
    }

    /**
     * Override this in a derived class to provide logic for when a card view is fetched
     *
     * @param _context - A strongly-typed context object for this turn
     * @param _aceRequest - The Ace invoke request value payload
     * @returns A Card View Response for the request
     */
    protected async onSharePointTaskGetCardViewAsync(
        _context: TurnContext,
        _aceRequest: AceRequest,
    ): Promise<CardViewResponse> {
        throw new Error('NotImplemented');
    }

    /**
     * Override this in a derived class to provide logic for when a quick view is fetched
     *
     * @param _context - A strongly-typed context object for this turn
     * @param _aceRequest - The Ace invoke request value payload
     * @returns A Quick View Response for the request
     */
    protected async onSharePointTaskGetQuickViewAsync(
        _context: TurnContext,
        _aceRequest: AceRequest,
    ): Promise<QuickViewResponse> {
        throw new Error('NotImplemented');
    }

    /**
     * Override this in a derived class to provide logic for getting configuration pane properties.
     *
     * @param _context - A strongly-typed context object for this turn
     * @param _aceRequest - The Ace invoke request value payload
     * @returns A Property Pane Configuration Response for the request
     */
    protected async onSharePointTaskGetPropertyPaneConfigurationAsync(
        _context: TurnContext,
        _aceRequest: AceRequest,
    ): Promise<GetPropertyPaneConfigurationResponse> {
        throw new Error('NotImplemented');
    }

    /**
     * Override this in a derived class to provide logic for setting configuration pane properties.
     *
     * @param _context - A strongly-typed context object for this turn
     * @param _aceRequest - The Ace invoke request value payload
     * @returns A Card view or no-op action response
     */
    protected async onSharePointTaskSetPropertyPaneConfigurationAsync(
        _context: TurnContext,
        _aceRequest: AceRequest,
    ): Promise<SetPropertyPaneConfigurationResponse> {
        throw new Error('NotImplemented');
    }

    /**
     * Override this in a derived class to provide logic for handling ACE action.
     *
     * @param _context - A strongly-typed context object for this turn
     * @param _aceRequest - The Ace invoke request value payload
     * @returns A handle action response
     */
    protected async onSharePointTaskHandleActionAsync(
        _context: TurnContext,
        _aceRequest: AceRequest,
    ): Promise<HandleActionResponse> {
        throw new Error('NotImplemented');
    }

    /**
     * Override this method to support channel-specific behavior across multiple channels.
     *
     * @param _context - A strongly-typed context object for this turn
     */
    protected async onSignInInvoke(
        _context: TurnContext
    ): Promise<void> {
        throw new Error('NotImplemented');
    }
}

1	/**
2	* @module botbuilder
3	*/
4	/**
5	* Copyright (c) Microsoft Corporation. All rights reserved.
6	* Licensed under the MIT License.
7	*/
8
9	import {	1✔
10	ActivityHandler,
11	InvokeResponse,
12	AceRequest,
13	TurnContext,
14	CardViewResponse,
15	QuickViewResponse,
16	GetPropertyPaneConfigurationResponse,
17	SetPropertyPaneConfigurationResponse,
18	HandleActionResponse,
19	} from 'botbuilder-core';
20
21	/**
22	* The SharePointActivityHandler is derived from ActivityHandler. It adds support for
23	* the SharePoint specific events and interactions
24	*/
25	export class SharePointActivityHandler extends ActivityHandler {	1✔
26	/**
27	* Invoked when an invoke activity is received from the connector.
28	* Invoke activities can be used to communicate many different things.
29	* Invoke activities communicate programmatic commands from a client or channel to a bot.
30	*
31	* @param context A strongly-typed context object for this turn
32	* @returns A task that represents the work queued to execute
33	*/
34	protected async onInvokeActivity(context: TurnContext): Promise<InvokeResponse> {
35	try {	×
36	if (!context.activity.name && context.activity.channelId === 'sharepoint') {	×
37	throw new Error('NotImplemented');	×
38	} else {
39	switch (context.activity.name) {	×
40	case 'cardExtension/getCardView':	×
41	return ActivityHandler.createInvokeResponse(	×
42	await this.onSharePointTaskGetCardViewAsync(context, context.activity.value as AceRequest),
43	);
44
45	case 'cardExtension/getQuickView':
46	return ActivityHandler.createInvokeResponse(	×
47	await this.onSharePointTaskGetQuickViewAsync(context, context.activity.value as AceRequest),
48	);
49
50	case 'cardExtension/getPropertyPaneConfiguration':
51	return ActivityHandler.createInvokeResponse(	×
52	await this.onSharePointTaskGetPropertyPaneConfigurationAsync(
53	context,
54	context.activity.value as AceRequest,
55	),
56	);
57
58	case 'cardExtension/setPropertyPaneConfiguration':
59	return ActivityHandler.createInvokeResponse(	×
60	await this.onSharePointTaskSetPropertyPaneConfigurationAsync(
61	context,
62	context.activity.value as AceRequest,
63	),
64	);
65	case 'cardExtension/handleAction':
66	return ActivityHandler.createInvokeResponse(	×
67	await this.onSharePointTaskHandleActionAsync(context, context.activity.value as AceRequest),
68	);
69	case 'cardExtension/token':
NEW 70	await this.onSignInInvoke(context);	×
NEW 71	return ActivityHandler.createInvokeResponse();	×
72	default:
73	return super.onInvokeActivity(context);	×
74	}
75	}
76	} catch (err) {
77	if (err.message === 'NotImplemented') {	×
78	return { status: 501 };	×
79	} else if (err.message === 'BadRequest') {	×
80	return { status: 400 };	×
81	}
82	throw err;	×
83	}
84	}
85
86	/**
87	* Override this in a derived class to provide logic for when a card view is fetched
88	*
89	* @param _context - A strongly-typed context object for this turn
90	* @param _aceRequest - The Ace invoke request value payload
91	* @returns A Card View Response for the request
92	*/
93	protected async onSharePointTaskGetCardViewAsync(
94	_context: TurnContext,
95	_aceRequest: AceRequest,
96	): Promise<CardViewResponse> {
97	throw new Error('NotImplemented');	×
98	}
99
100	/**
101	* Override this in a derived class to provide logic for when a quick view is fetched
102	*
103	* @param _context - A strongly-typed context object for this turn
104	* @param _aceRequest - The Ace invoke request value payload
105	* @returns A Quick View Response for the request
106	*/
107	protected async onSharePointTaskGetQuickViewAsync(
108	_context: TurnContext,
109	_aceRequest: AceRequest,
110	): Promise<QuickViewResponse> {
111	throw new Error('NotImplemented');	×
112	}
113
114	/**
115	* Override this in a derived class to provide logic for getting configuration pane properties.
116	*
117	* @param _context - A strongly-typed context object for this turn
118	* @param _aceRequest - The Ace invoke request value payload
119	* @returns A Property Pane Configuration Response for the request
120	*/
121	protected async onSharePointTaskGetPropertyPaneConfigurationAsync(
122	_context: TurnContext,
123	_aceRequest: AceRequest,
124	): Promise<GetPropertyPaneConfigurationResponse> {
125	throw new Error('NotImplemented');	×
126	}
127
128	/**
129	* Override this in a derived class to provide logic for setting configuration pane properties.
130	*
131	* @param _context - A strongly-typed context object for this turn
132	* @param _aceRequest - The Ace invoke request value payload
133	* @returns A Card view or no-op action response
134	*/
135	protected async onSharePointTaskSetPropertyPaneConfigurationAsync(
136	_context: TurnContext,
137	_aceRequest: AceRequest,
138	): Promise<SetPropertyPaneConfigurationResponse> {
139	throw new Error('NotImplemented');	×
140	}
141
142	/**
143	* Override this in a derived class to provide logic for handling ACE action.
144	*
145	* @param _context - A strongly-typed context object for this turn
146	* @param _aceRequest - The Ace invoke request value payload
147	* @returns A handle action response
148	*/
149	protected async onSharePointTaskHandleActionAsync(
150	_context: TurnContext,
151	_aceRequest: AceRequest,
152	): Promise<HandleActionResponse> {
153	throw new Error('NotImplemented');	×
154	}
155
156	/**
157	* Override this method to support channel-specific behavior across multiple channels.
158	*
159	* @param _context - A strongly-typed context object for this turn
160	*/
161	protected async onSignInInvoke(
162	_context: TurnContext
163	): Promise<void> {
NEW UNCOV 164	throw new Error('NotImplemented');	×
165	}
166	}

microsoft / botbuilder-js / 12752558330

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