58913

Build # 58913

Build Type

push

Azure DevOps 1

Committed by GitHub

Commit Message

<a href="https://github.com/Microsoft/BotFramework-Emulator/commit/<a class=hub.com/Microsoft/BotFramework-Emulator/commit/dddf04af5430fa25609ee8c7946136d470393173">dddf04af5<a href="https://github.com/Microsoft/BotFramework-Emulator/commit/dddf04af5430fa25609ee8c7946136d470393173">">Merge </a><a class="double-link" href="https://github.com/Microsoft/BotFramework-Emulator/commit/<a class="double-link" href="https://github.com/Microsoft/BotFramework-Emulator/commit/897c76f27fb9b351b882a6c92879c99c797973d7">897c76f27</a>">897c76f27</a><a href="https://github.com/Microsoft/BotFramework-Emulator/commit/dddf04af5430fa25609ee8c7946136d470393173"> into 712e57b99">712e57b99</a>

Run Details

2045 of 4101 branches covered (49.87%)

Branch coverage included in aggregate %.

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

5424 of 8859 relevant lines covered (61.23%)

6.65 hits per line

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

84.66

/packages/app/client/src/data/sagas/chatSagas.ts

//
// Copyright (c) Microsoft. All rights reserved.
// Licensed under the MIT license.
//
// Microsoft Bot Framework: http://botframework.com
//
// Bot Framework Emulator Github:
// https://github.com/Microsoft/BotFramwork-Emulator
//
// Copyright (c) Microsoft Corporation
// All rights reserved.
//
// MIT License:
// Permission is hereby granted, free of charge, to any person obtaining
// a copy of this software and associated documentation files (the
// "Software"), to deal in the Software without restriction, including
// without limitation the rights to use, copy, modify, merge, publish,
// distribute, sublicense, and/or sell copies of the Software, and to
// permit persons to whom the Software is furnished to do so, subject to
// the following conditions:
//
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED ""AS IS"", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
//
import * as Electron from 'electron';
import { MenuItemConstructorOptions } from 'electron';
import { Activity } from 'botframework-schema';
import { SharedConstants, ValueTypes } from '@bfemulator/app-shared';
import { InspectableObjectLogItem, LogItem, LogItemType } from '@bfemulator/sdk-shared';
import { diff } from 'deep-diff';
import { IEndpointService } from 'botframework-config/lib/schema';
import { createCognitiveServicesBingSpeechPonyfillFactory } from 'botframework-webchat';
import { createStore as createWebChatStore } from 'botframework-webchat-core';
import { call, ForkEffect, put, select, takeEvery, takeLatest } from 'redux-saga/effects';

import {
  ChatAction,
  ChatActions,
  closeDocument,
  DocumentIdPayload,
  NewChatPayload,
  setHighlightedObjects,
  setInspectorObjects,
  updatePendingSpeechTokenRetrieval,
  webChatStoreUpdated,
  webSpeechFactoryUpdated,
} from '../action/chatActions';
import { CommandServiceImpl } from '../../platform/commands/commandServiceImpl';
import { RootState } from '../store';
import { isSpeechEnabled } from '../../utils';

const getConversationIdFromDocumentId = (state: RootState, documentId: string) => {
  return (state.chat.chats[documentId] || {}).conversationId;
};

const getWebSpeechFactoryForDocumentId = (state: RootState, documentId: string): (() => any) => {
  return state.chat.webSpeechFactories[documentId];
};

const getEndpointServiceByDocumentId = (state: RootState, documentId: string): IEndpointService => {
  const chat = state.chat.chats[documentId];
  return ((state.bot.activeBot && state.bot.activeBot.services) || []).find(
    s => s.id === chat.endpointId
  ) as IEndpointService;
};

const getCurrentDocumentId = (state: RootState): string => {
  const { editors, activeEditor } = state.editor;
  const { activeDocumentId } = editors[activeEditor];
  return activeDocumentId;
};

const getPreviousBotState = (state: RootState, selectedTrace: Activity): Activity => {
  const { editors, activeEditor } = state.editor;
  const { activeDocumentId } = editors[activeEditor];
  const chat = state.chat.chats[activeDocumentId];
  const entries = chat.log.entries as any[];

  const allEntries: LogItem<InspectableObjectLogItem>[] = entries.reduce(
    (agg: LogItem[], entry) => agg.concat(entry.items),
    []
  );
  const filteredLogItems: LogItem<InspectableObjectLogItem>[] = allEntries.filter(
    (item: LogItem<InspectableObjectLogItem>) => {
      const activity = item.payload.obj as Activity;
      return item.type === LogItemType.InspectableObject && activity.valueType === ValueTypes.BotState;
    }
  );
  const index = filteredLogItems.findIndex(logItem => logItem.payload.obj.id === selectedTrace.id) - 1;
  const targetLogEntry = filteredLogItems[index];
  return targetLogEntry && (targetLogEntry.payload.obj as Activity);
};

const getChatFromDocumentId = (state: RootState, documentId: string): any => {
  return state.chat.chats[documentId];
};

export function* showContextMenuForActivity(action: ChatAction<Activity>): Iterable<any> {
  const { payload: activity } = action;
  const previousBotState = yield select(getPreviousBotState, activity);
  const diffEnabled = activity.valueType.endsWith('botState') && !!previousBotState;
  const menuItems = [
    { label: 'Copy text', id: 'copy' },
    { label: 'Copy json', id: 'json' },
    { type: 'separator' },
    { label: 'Compare with previous', id: 'diff', enabled: diffEnabled },
  ] as MenuItemConstructorOptions[];

  const { DisplayContextMenu } = SharedConstants.Commands.Electron;
  const response: { id: string } = yield call(
    CommandServiceImpl.remoteCall.bind(CommandServiceImpl),
    DisplayContextMenu,
    menuItems
  );

  if (!response) {
    return; // canceled context menu
  }
  switch (response.id) {
    case 'copy':
      return Electron.clipboard.writeText(getTextFromActivity(activity));

    case 'json':
      return Electron.clipboard.writeText(JSON.stringify(activity, null, 2));

    default:
      yield* diffWithPreviousBotState(activity);
  }
}

export function* closeConversation(action: ChatAction<DocumentIdPayload>): Iterable<any> {
  const conversationId = yield select(getConversationIdFromDocumentId, action.payload.documentId);
  const { DeleteConversation } = SharedConstants.Commands.Emulator;
  const { documentId } = action.payload;
  const chat = yield select(getChatFromDocumentId, documentId);
  if (chat.directLine) {
    chat.directLine.end(); // stop polling
  }
  yield call([CommandServiceImpl, CommandServiceImpl.remoteCall], DeleteConversation, conversationId);
  yield put(closeDocument(documentId));
  // remove the webchat store when the document is closed
  yield put(webChatStoreUpdated(documentId, null));
}

export function* newChat(action: ChatAction<NewChatPayload>): Iterable<any> {
  const { documentId } = action.payload;
  // Create a new webchat store for this documentId
  yield put(webChatStoreUpdated(documentId, createWebChatStore()));
  // Each time a new chat is open, retrieve the speech token
  // if the endpoint is speech enabled and create a bind speech
  // pony fill factory. This is consumed by WebChat...
  yield put(webSpeechFactoryUpdated(documentId, null)); // remove the old factory
  const endpoint: IEndpointService = yield select(getEndpointServiceByDocumentId, documentId);
  if (!isSpeechEnabled(endpoint)) {
    return;
  }
  yield put(updatePendingSpeechTokenRetrieval(true));
  // If an existing factory is found, refresh the token
  const existingFactory: string = yield select(getWebSpeechFactoryForDocumentId, documentId);
  const { GetSpeechToken: command } = SharedConstants.Commands.Emulator;
  const token = yield call(
    [CommandServiceImpl, CommandServiceImpl.remoteCall],
    command,
    endpoint.id,
    !!existingFactory
  );
  if (token) {
    const factory = yield call(createCognitiveServicesBingSpeechPonyfillFactory, {
      authorizationToken: token,
    });
    yield put(webSpeechFactoryUpdated(documentId, factory)); // Provide the new factory to the store
  }
  yield put(updatePendingSpeechTokenRetrieval(false));
}

export function* diffWithPreviousBotState(currentBotState: Activity): Iterable<any> {
  const previousBotState: Activity = yield select(getPreviousBotState, currentBotState);

  const lhs = [];
  const rhs = [];
  const deltas = diff(previousBotState.value, currentBotState.value);
  (deltas || []).forEach(diff => {
    switch (diff.kind) {
      case 'A':
        {
          const { item, path } = diff;
          path.push(diff.index);
          if (item.kind === 'D') {
            lhs.push(path);
          } else if (item.kind === 'E') {
            rhs.push(path);
            lhs.push(path);
          } else {
            rhs.push(path);
          }
        }
        break;

      case 'D':
        lhs.push(diff.path);
        break;

      case 'E':
        rhs.push(diff.path);
        lhs.push(diff.path);
        break;

      case 'N':
        rhs.push(diff.path);
        break;
    }
  });

  // Clone the bot state and update the keys to show changes
  const botStateClone: Activity = JSON.parse(
    JSON.stringify(currentBotState, (key: string, value: any) => {
      if (value instanceof Array) {
        return Object.keys(value).reduce((conversion: any, key) => {
          conversion['' + key] = value[key];
          return conversion;
        }, {});
      }
      return value;
    })
  );
  botStateClone.valueType = ValueTypes.Diff;
  // values that were added
  rhs.forEach(path => {
    buildDiff('+', path, botStateClone.value, botStateClone.value);
  });
  // values that were removed
  lhs.forEach(path => {
    buildDiff('-', path, botStateClone.value, previousBotState.value);
  });
  const documentId = yield select(getCurrentDocumentId);
  yield put(setHighlightedObjects(documentId, [previousBotState, currentBotState]));
  yield put(setInspectorObjects(documentId, botStateClone));
}

function getTextFromActivity(activity: Activity): string {
  if (activity.valueType === ValueTypes.Command) {
    return activity.value;
  } else if (activity.valueType === ValueTypes.Activity) {
    return 'text' in activity.value ? activity.value.text : activity.label;
  }
  return activity.text || activity.label || '';
}

function buildDiff(prependWith: string, path: (string | number)[], target: any, source: any): void {
  let key;
  for (let i = 0; i < path.length; i++) {
    key = path[i];
    if (key in target && target[key] !== null && typeof target[key] === 'object') {
      target = target[key];
      source = source[key];
    } else {
      break;
    }
  }
  const value = source[key];
  delete target[key];
  target[prependWith + key] = value;
}

export function* chatSagas(): IterableIterator<ForkEffect> {
  yield takeEvery(ChatActions.showContextMenuForActivity, showContextMenuForActivity);
  yield takeEvery(ChatActions.closeConversation, closeConversation);
  yield takeLatest([ChatActions.newChat, ChatActions.clearLog], newChat);
}

1	//
2	// Copyright (c) Microsoft. All rights reserved.
3	// Licensed under the MIT license.
4	//
5	// Microsoft Bot Framework: http://botframework.com
6	//
7	// Bot Framework Emulator Github:
8	// https://github.com/Microsoft/BotFramwork-Emulator
9	//
10	// Copyright (c) Microsoft Corporation
11	// All rights reserved.
12	//
13	// MIT License:
14	// Permission is hereby granted, free of charge, to any person obtaining
15	// a copy of this software and associated documentation files (the
16	// "Software"), to deal in the Software without restriction, including
17	// without limitation the rights to use, copy, modify, merge, publish,
18	// distribute, sublicense, and/or sell copies of the Software, and to
19	// permit persons to whom the Software is furnished to do so, subject to
20	// the following conditions:
21	//
22	// The above copyright notice and this permission notice shall be
23	// included in all copies or substantial portions of the Software.
24	//
25	// THE SOFTWARE IS PROVIDED ""AS IS"", WITHOUT WARRANTY OF ANY KIND,
26	// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
27	// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
28	// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
29	// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
30	// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
31	// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
32	//
33	import * as Electron from 'electron';
34	import { MenuItemConstructorOptions } from 'electron';
35	import { Activity } from 'botframework-schema';
36	import { SharedConstants, ValueTypes } from '@bfemulator/app-shared';
37	import { InspectableObjectLogItem, LogItem, LogItemType } from '@bfemulator/sdk-shared';
38	import { diff } from 'deep-diff';
39	import { IEndpointService } from 'botframework-config/lib/schema';
40	import { createCognitiveServicesBingSpeechPonyfillFactory } from 'botframework-webchat';
41	import { createStore as createWebChatStore } from 'botframework-webchat-core';
42	import { call, ForkEffect, put, select, takeEvery, takeLatest } from 'redux-saga/effects';
43
44	import {
45	ChatAction,
46	ChatActions,
47	closeDocument,
48	DocumentIdPayload,
49	NewChatPayload,
50	setHighlightedObjects,
51	setInspectorObjects,
52	updatePendingSpeechTokenRetrieval,
53	webChatStoreUpdated,
54	webSpeechFactoryUpdated,
55	} from '../action/chatActions';
56	import { CommandServiceImpl } from '../../platform/commands/commandServiceImpl';
57	import { RootState } from '../store';
58	import { isSpeechEnabled } from '../../utils';
59
60	const getConversationIdFromDocumentId = (state: RootState, documentId: string) => {	15✔
61	return (state.chat.chats[documentId] \|\| {}).conversationId;	1!
62	};
63
64	const getWebSpeechFactoryForDocumentId = (state: RootState, documentId: string): (() => any) => {	15✔
65	return state.chat.webSpeechFactories[documentId];	1✔
66	};
67
68	const getEndpointServiceByDocumentId = (state: RootState, documentId: string): IEndpointService => {	15✔
69	const chat = state.chat.chats[documentId];	1✔
70	return ((state.bot.activeBot && state.bot.activeBot.services) \|\| []).find(	1!
71	s => s.id === chat.endpointId	1✔
72	) as IEndpointService;
73	};
74
75	const getCurrentDocumentId = (state: RootState): string => {	15✔
76	const { editors, activeEditor } = state.editor;	1✔
77	const { activeDocumentId } = editors[activeEditor];	1✔
78	return activeDocumentId;	1✔
79	};
80
81	const getPreviousBotState = (state: RootState, selectedTrace: Activity): Activity => {	15✔
82	const { editors, activeEditor } = state.editor;	4✔
83	const { activeDocumentId } = editors[activeEditor];	4✔
84	const chat = state.chat.chats[activeDocumentId];	4✔
85	const entries = chat.log.entries as any[];	4✔
86
87	const allEntries: LogItem<InspectableObjectLogItem>[] = entries.reduce(	4✔
88	(agg: LogItem[], entry) => agg.concat(entry.items),	12✔
89	[]
90	);
91	const filteredLogItems: LogItem<InspectableObjectLogItem>[] = allEntries.filter(	4✔
92	(item: LogItem<InspectableObjectLogItem>) => {
93	const activity = item.payload.obj as Activity;	24✔
94	return item.type === LogItemType.InspectableObject && activity.valueType === ValueTypes.BotState;	24✔
95	}
96	);
97	const index = filteredLogItems.findIndex(logItem => logItem.payload.obj.id === selectedTrace.id) - 1;	12✔
98	const targetLogEntry = filteredLogItems[index];	4✔
99	return targetLogEntry && (targetLogEntry.payload.obj as Activity);	4✔
100	};
101
102	const getChatFromDocumentId = (state: RootState, documentId: string): any => {	15✔
103	return state.chat.chats[documentId];	1✔
104	};
105
106	export function* showContextMenuForActivity(action: ChatAction<Activity>): Iterable<any> {
107	const { payload: activity } = action;	3✔
108	const previousBotState = yield select(getPreviousBotState, activity);	3✔
109	const diffEnabled = activity.valueType.endsWith('botState') && !!previousBotState;	3✔
110	const menuItems = [	3✔
111	{ label: 'Copy text', id: 'copy' },
112	{ label: 'Copy json', id: 'json' },
113	{ type: 'separator' },
114	{ label: 'Compare with previous', id: 'diff', enabled: diffEnabled },
115	] as MenuItemConstructorOptions[];
116
117	const { DisplayContextMenu } = SharedConstants.Commands.Electron;	3✔
118	const response: { id: string } = yield call(	3✔
119	CommandServiceImpl.remoteCall.bind(CommandServiceImpl),
120	DisplayContextMenu,
121	menuItems
122	);
123
124	if (!response) {	3!
125	return; // canceled context menu	×
126	}
127	switch (response.id) {	3✔
128	case 'copy':
129	return Electron.clipboard.writeText(getTextFromActivity(activity));	1✔
130
131	case 'json':
132	return Electron.clipboard.writeText(JSON.stringify(activity, null, 2));	1✔
133
134	default:
135	yield* diffWithPreviousBotState(activity);	1✔
136	}
137	}
138
139	export function* closeConversation(action: ChatAction<DocumentIdPayload>): Iterable<any> {
140	const conversationId = yield select(getConversationIdFromDocumentId, action.payload.documentId);	1✔
141	const { DeleteConversation } = SharedConstants.Commands.Emulator;	1✔
142	const { documentId } = action.payload;	1✔
143	const chat = yield select(getChatFromDocumentId, documentId);	1✔
144	if (chat.directLine) {	1!
145	chat.directLine.end(); // stop polling	×
146	}
147	yield call([CommandServiceImpl, CommandServiceImpl.remoteCall], DeleteConversation, conversationId);	1✔
148	yield put(closeDocument(documentId));	1✔
149	// remove the webchat store when the document is closed
150	yield put(webChatStoreUpdated(documentId, null));	1✔
151	}
152
153	export function* newChat(action: ChatAction<NewChatPayload>): Iterable<any> {
154	const { documentId } = action.payload;	1✔
155	// Create a new webchat store for this documentId
156	yield put(webChatStoreUpdated(documentId, createWebChatStore()));	1✔
157	// Each time a new chat is open, retrieve the speech token
158	// if the endpoint is speech enabled and create a bind speech
159	// pony fill factory. This is consumed by WebChat...
160	yield put(webSpeechFactoryUpdated(documentId, null)); // remove the old factory	1✔
161	const endpoint: IEndpointService = yield select(getEndpointServiceByDocumentId, documentId);	1✔
162	if (!isSpeechEnabled(endpoint)) {	1!
163	return;	×
164	}
165	yield put(updatePendingSpeechTokenRetrieval(true));	1✔
166	// If an existing factory is found, refresh the token
167	const existingFactory: string = yield select(getWebSpeechFactoryForDocumentId, documentId);	1✔
168	const { GetSpeechToken: command } = SharedConstants.Commands.Emulator;	1✔
169	const token = yield call(	1✔
170	[CommandServiceImpl, CommandServiceImpl.remoteCall],
171	command,
172	endpoint.id,
173	!!existingFactory
174	);
175	if (token) {	1!
176	const factory = yield call(createCognitiveServicesBingSpeechPonyfillFactory, {	1✔
177	authorizationToken: token,
178	});
179	yield put(webSpeechFactoryUpdated(documentId, factory)); // Provide the new factory to the store	1✔
180	}
181	yield put(updatePendingSpeechTokenRetrieval(false));	1✔
182	}
183
184	export function* diffWithPreviousBotState(currentBotState: Activity): Iterable<any> {
185	const previousBotState: Activity = yield select(getPreviousBotState, currentBotState);	1✔
186
187	const lhs = [];	1✔
188	const rhs = [];	1✔
189	const deltas = diff(previousBotState.value, currentBotState.value);	1✔
190	(deltas \|\| []).forEach(diff => {	1!
191	switch (diff.kind) {	9✔
192	case 'A':
193	{
194	const { item, path } = diff;	1✔
195	path.push(diff.index);	1✔
196	if (item.kind === 'D') {	1!
197	lhs.push(path);	1✔
198	} else if (item.kind === 'E') {	×
199	rhs.push(path);	×
200	lhs.push(path);	×
201	} else {
202	rhs.push(path);	×
203	}
204	}
205	break;	1✔
206
207	case 'D':
208	lhs.push(diff.path);	2✔
209	break;	2✔
210
211	case 'E':
212	rhs.push(diff.path);	3✔
213	lhs.push(diff.path);	3✔
214	break;	3✔
215
216	case 'N':
217	rhs.push(diff.path);	3✔
218	break;	3✔
219	}
220	});
221
222	// Clone the bot state and update the keys to show changes
223	const botStateClone: Activity = JSON.parse(	1✔
224	JSON.stringify(currentBotState, (key: string, value: any) => {
225	if (value instanceof Array) {	53✔
226	return Object.keys(value).reduce((conversion: any, key) => {	1✔
227	conversion['' + key] = value[key];	3✔
228	return conversion;	3✔
229	}, {});
230	}
231	return value;	52✔
232	})
233	);
234	botStateClone.valueType = ValueTypes.Diff;	1✔
235	// values that were added
236	rhs.forEach(path => {	1✔
237	buildDiff('+', path, botStateClone.value, botStateClone.value);	6✔
238	});
239	// values that were removed
240	lhs.forEach(path => {	1✔
241	buildDiff('-', path, botStateClone.value, previousBotState.value);	6✔
242	});
243	const documentId = yield select(getCurrentDocumentId);	1✔
244	yield put(setHighlightedObjects(documentId, [previousBotState, currentBotState]));	1✔
245	yield put(setInspectorObjects(documentId, botStateClone));	1✔
246	}
247
248	function getTextFromActivity(activity: Activity): string {
249	if (activity.valueType === ValueTypes.Command) {	1!
250	return activity.value;	×
251	} else if (activity.valueType === ValueTypes.Activity) {	1!
252	return 'text' in activity.value ? activity.value.text : activity.label;	1!
253	}
254	return activity.text \|\| activity.label \|\| '';	×
255	}
256
257	function buildDiff(prependWith: string, path: (string \| number)[], target: any, source: any): void {
258	let key;
259	for (let i = 0; i < path.length; i++) {	12✔
260	key = path[i];	61✔
261	if (key in target && target[key] !== null && typeof target[key] === 'object') {	61✔
262	target = target[key];	52✔
263	source = source[key];	52✔
264	} else {
265	break;	9✔
266	}
267	}
268	const value = source[key];	12✔
269	delete target[key];	12✔
270	target[prependWith + key] = value;	12✔
271	}
272
273	export function* chatSagas(): IterableIterator<ForkEffect> {
274	yield takeEvery(ChatActions.showContextMenuForActivity, showContextMenuForActivity);	19✔
275	yield takeEvery(ChatActions.closeConversation, closeConversation);	19✔
276	yield takeLatest([ChatActions.newChat, ChatActions.clearLog], newChat);	19✔
277	}

Microsoft / BotFramework-Emulator / 58913

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