Skip to content

Add expectedReplies, update skillDialog and botFrameworkAdapter #1876

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
stevengum merged 1 commit into from
Mar 8, 2020
Merged

Add expectedReplies, update skillDialog and botFrameworkAdapter #1876

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions libraries/botbuilder-dialogs/src/skillDialog.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import {
ActivityTypes,
ConversationReference,
DeliveryModes,
ExpectedReplies,
SkillConversationIdFactoryOptions,
TurnContext
} from 'botbuilder-core';
Expand Down Expand Up @@ -182,18 +183,18 @@ export class SkillDialog extends Dialog {
const skillInfo = this.dialogOptions.skill;
await this.dialogOptions.conversationState.saveChanges(context, true);

const response = await this.dialogOptions.skillClient.postActivity<Activity[]>(this.dialogOptions.botId, skillInfo.appId, skillInfo.skillEndpoint, this.dialogOptions.skillHostEndpoint, skillConversationId, activity);
const response = await this.dialogOptions.skillClient.postActivity<ExpectedReplies>(this.dialogOptions.botId, skillInfo.appId, skillInfo.skillEndpoint, this.dialogOptions.skillHostEndpoint, skillConversationId, activity);

// Inspect the skill response status
if (!(response.status >= 200 && response.status <= 299)) {
throw new Error(`Error invoking the skill id: "${ skillInfo.id }" at "${ skillInfo.skillEndpoint }" (status is ${ response.status }). \r\n ${ response.body }`);
}

let eocActivity: Activity;
if (activity.deliveryMode == DeliveryModes.ExpectReplies && response.body) {
if (activity.deliveryMode == DeliveryModes.ExpectReplies && response.body && response.body.activities) {
// Process replies in the response.Body.
if (Array.isArray(response.body)) {
response.body.forEach(async (fromSkillActivity: Activity): Promise<void> => {
if (Array.isArray(response.body.activities)) {
response.body.activities.forEach(async (fromSkillActivity: Activity): Promise<void> => {
if (fromSkillActivity.type === ActivityTypes.EndOfConversation) {
// Capture the EndOfConversation activity if it was sent from skill
eocActivity = fromSkillActivity;
Expand Down
8 changes: 5 additions & 3 deletions libraries/botbuilder/src/botFrameworkAdapter.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
import { STATUS_CODES } from 'http';
import * as os from 'os';

import { Activity, ActivityTypes, BotAdapter, BotCallbackHandlerKey, ChannelAccount, ConversationAccount, ConversationParameters, ConversationReference, ConversationsResult, DeliveryModes,InvokeResponse, ExtendedUserTokenProvider, ResourceResponse, StatusCodes, TokenResponse, TurnContext } from 'botbuilder-core';
import { Activity, ActivityTypes, BotAdapter, BotCallbackHandlerKey, ChannelAccount, ConversationAccount, ConversationParameters, ConversationReference, ConversationsResult, DeliveryModes, ExpectedReplies, InvokeResponse, ExtendedUserTokenProvider, ResourceResponse, StatusCodes, TokenResponse, TurnContext } from 'botbuilder-core';
import { AuthenticationConfiguration, AuthenticationConstants, ChannelValidation, Claim, ClaimsIdentity, ConnectorClient, EmulatorApiClient, GovernmentConstants, GovernmentChannelValidation, JwtTokenValidation, MicrosoftAppCredentials, AppCredentials, CertificateAppCredentials, SimpleCredentialProvider, TokenApiClient, TokenStatus, TokenApiModels, SignInUrlResponse, SkillValidation, TokenExchangeRequest } from 'botframework-connector';

import { INodeBuffer, INodeSocket, IReceiveRequest, ISocket, IStreamingTransportServer, NamedPipeServer, NodeWebSocketFactory, NodeWebSocketFactoryBase, RequestHandler, StreamingResponse, WebSocketServer } from 'botframework-streaming';
Expand Down Expand Up @@ -838,7 +838,8 @@ export class BotFrameworkAdapter extends BotAdapter implements ExtendedUserToken
status = 501;
}
} else if (request.deliveryMode === DeliveryModes.ExpectReplies) {
body = context.bufferedReplyActivities;
const expectedReplies: ExpectedReplies = { activities: context.bufferedReplyActivities as Activity[] };
body = expectedReplies;
status = StatusCodes.OK;
} else {
status = 200;
Expand Down Expand Up @@ -1272,7 +1273,8 @@ export class BotFrameworkAdapter extends BotAdapter implements ExtendedUserToken
response.statusCode = StatusCodes.NOT_IMPLEMENTED;
}
} else if (body.deliveryMode === DeliveryModes.ExpectReplies) {
response.setBody(context.bufferedReplyActivities);
const replies: ExpectedReplies = { activities : context.bufferedReplyActivities as Activity[] };
response.setBody(replies);
response.statusCode = StatusCodes.OK;
} else {
response.statusCode = StatusCodes.OK;
Expand Down
22 changes: 22 additions & 0 deletions libraries/botframework-connector/src/connectorApi/models/mappers.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -956,6 +956,28 @@ export const ConversationsResult: msRest.CompositeMapper = {
}
};

export const ExpectedReplies: msRest.CompositeMapper = {
Copy link
Member

@stevengum stevengum Mar 8, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure this is needed as the activities will come in a response to BotframeworkClient.postActivity()... but otherwise it looks good!

serializedName: "ExpectedReplies",
type: {
name: "Composite",
className: "ExpectedReplies",
modelProperties: {
activities: {
serializedName: "activities",
type: {
name: "Sequence",
element: {
type: {
name: "Composite",
className: "Activity"
}
}
}
}
}
}
};

export const ResourceResponse: msRest.CompositeMapper = {
serializedName: "ResourceResponse",
type: {
Expand Down
10 changes: 10 additions & 0 deletions libraries/botframework-schema/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -579,6 +579,16 @@ export interface ConversationsResult {
conversations: ConversationMembers[];
}

/**
* Expected Replies in response to DeliveryModes.ExpectReplies
*/
export interface ExpectedReplies {
/**
* A collection of Activities that conforms to the ExpectedReplies schema.
*/
activities: Activity[];
}

/**
* A response containing a resource ID
*/
Expand Down
2 changes: 1 addition & 1 deletion libraries/testskills/skillparent/parentBot.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ class ParentBot extends ActivityHandler {

if (response.status == 200)
{
await context.sendActivities(response.body);
await context.sendActivities(response.body.activities);
}

await context.sendActivity('parent: after child');
Expand Down