Skip to content

Commit a049747

Browse files
DonJayamanneDonJayamanne
authored
Fixes to telemetry Keyboard and mouse nb telemetry (microsoft#11220)
1 parent 5cf8775 commit a049747

File tree

10 files changed

+68
-147
lines changed

10 files changed

+68
-147
lines changed

‎src/client/datascience/constants.ts‎

Lines changed: 4 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@
55
import { PYTHON_LANGUAGE } from '../common/constants';
66
import { IS_WINDOWS } from '../common/platform/constants';
77
import { IVariableQuery } from '../common/types';
8-
import { NativeCommandType } from './interactive-common/interactiveWindowTypes';
98

109
export const DefaultTheme = 'Default Light+';
1110
// Identifier for the output panel that will display the output from the Jupyter Server.
@@ -305,70 +304,40 @@ export enum Telemetry {
305304
}
306305

307306
export enum NativeKeyboardCommandTelemetry {
308-
AddToEnd = 'DATASCIENCE.NATIVE.KEYBOARD.ADD_TO_END',
309307
ArrowDown = 'DATASCIENCE.NATIVE.KEYBOARD.ARROW_DOWN',
310308
ArrowUp = 'DATASCIENCE.NATIVE.KEYBOARD.ARROW_UP',
311309
ChangeToCode = 'DATASCIENCE.NATIVE.KEYBOARD.CHANGE_TO_CODE',
312310
ChangeToMarkdown = 'DATASCIENCE.NATIVE.KEYBOARD.CHANGE_TO_MARKDOWN',
313-
CollapseInput = 'DATASCIENCE.NATIVE.KEYBOARD.COLLAPSE_INPUT',
314-
CollapseOutput = 'DATASCIENCE.NATIVE.KEYBOARD.COLLAPSE_OUTPUT',
315311
DeleteCell = 'DATASCIENCE.NATIVE.KEYBOARD.DELETE_CELL',
316312
InsertAbove = 'DATASCIENCE.NATIVE.KEYBOARD.INSERT_ABOVE',
317313
InsertBelow = 'DATASCIENCE.NATIVE.KEYBOARD.INSERT_BELOW',
318-
MoveCellDown = 'DATASCIENCE.NATIVE.KEYBOARD.MOVE_CELL_DOWN',
319-
MoveCellUp = 'DATASCIENCE.NATIVE.KEYBOARD.MOVE_CELL_UP',
314+
Redo = 'DATASCIENCE.NATIVE.KEYBOARD.REDO',
320315
Run = 'DATASCIENCE.NATIVE.KEYBOARD.RUN',
321316
Save = 'DATASCIENCE.NATIVE.KEYBOARD.SAVE',
322-
RunAbove = 'DATASCIENCE.NATIVE.KEYBOARD.RUN_ABOVE',
323-
RunAll = 'DATASCIENCE.NATIVE.KEYBOARD.RUN_ALL',
324317
RunAndAdd = 'DATASCIENCE.NATIVE.KEYBOARD.RUN_AND_ADD',
325318
RunAndMove = 'DATASCIENCE.NATIVE.KEYBOARD.RUN_AND_MOVE',
326-
RunBelow = 'DATASCIENCE.NATIVE.KEYBOARD.RUN_BELOW',
327319
ToggleLineNumbers = 'DATASCIENCE.NATIVE.KEYBOARD.TOGGLE_LINE_NUMBERS',
328320
ToggleOutput = 'DATASCIENCE.NATIVE.KEYBOARD.TOGGLE_OUTPUT',
329-
ToggleVariableExplorer = 'DATASCIENCE.NATIVE.KEYBOARD.TOGGLE_VARIABLE_EXPLORER',
330321
Undo = 'DATASCIENCE.NATIVE.KEYBOARD.UNDO',
331322
Unfocus = 'DATASCIENCE.NATIVE.KEYBOARD.UNFOCUS'
332323
}
333324

334-
export let NativeKeyboardCommandTelemetryLookup: { [id: number]: NativeKeyboardCommandTelemetry } = {};
335-
const keys = [...Object.keys(NativeCommandType)];
336-
const values1 = [...Object.values(NativeKeyboardCommandTelemetry)];
337-
for (let i = 0; i < keys.length; i += 1) {
338-
NativeKeyboardCommandTelemetryLookup[i] = values1[i];
339-
}
340-
341325
export enum NativeMouseCommandTelemetry {
342326
AddToEnd = 'DATASCIENCE.NATIVE.MOUSE.ADD_TO_END',
343-
ArrowDown = 'DATASCIENCE.NATIVE.MOUSE.ARROW_DOWN',
344-
ArrowUp = 'DATASCIENCE.NATIVE.MOUSE.ARROW_UP',
345327
ChangeToCode = 'DATASCIENCE.NATIVE.MOUSE.CHANGE_TO_CODE',
346328
ChangeToMarkdown = 'DATASCIENCE.NATIVE.MOUSE.CHANGE_TO_MARKDOWN',
347-
CollapseInput = 'DATASCIENCE.NATIVE.MOUSE.COLLAPSE_INPUT',
348-
CollapseOutput = 'DATASCIENCE.NATIVE.MOUSE.COLLAPSE_OUTPUT',
349329
DeleteCell = 'DATASCIENCE.NATIVE.MOUSE.DELETE_CELL',
350-
InsertAbove = 'DATASCIENCE.NATIVE.MOUSE.INSERT_ABOVE',
351330
InsertBelow = 'DATASCIENCE.NATIVE.MOUSE.INSERT_BELOW',
352331
MoveCellDown = 'DATASCIENCE.NATIVE.MOUSE.MOVE_CELL_DOWN',
353332
MoveCellUp = 'DATASCIENCE.NATIVE.MOUSE.MOVE_CELL_UP',
354333
Run = 'DATASCIENCE.NATIVE.MOUSE.RUN',
355334
RunAbove = 'DATASCIENCE.NATIVE.MOUSE.RUN_ABOVE',
356335
RunAll = 'DATASCIENCE.NATIVE.MOUSE.RUN_ALL',
357-
RunAndAdd = 'DATASCIENCE.NATIVE.MOUSE.RUN_AND_ADD',
358-
RunAndMove = 'DATASCIENCE.NATIVE.MOUSE.RUN_AND_MOVE',
359336
RunBelow = 'DATASCIENCE.NATIVE.MOUSE.RUN_BELOW',
337+
SelectKernel = 'DATASCIENCE.NATIVE.MOUSE.SELECT_KERNEL',
338+
SelectServer = 'DATASCIENCE.NATIVE.MOUSE.SELECT_SERVER',
360339
Save = 'DATASCIENCE.NATIVE.MOUSE.SAVE',
361-
ToggleLineNumbers = 'DATASCIENCE.NATIVE.MOUSE.TOGGLE_LINE_NUMBERS',
362-
ToggleOutput = 'DATASCIENCE.NATIVE.MOUSE.TOGGLE_OUTPUT',
363-
ToggleVariableExplorer = 'DATASCIENCE.NATIVE.MOUSE.TOGGLE_VARIABLE_EXPLORER',
364-
Undo = 'DATASCIENCE.NATIVE.MOUSE.UNDO',
365-
Unfocus = 'DATASCIENCE.NATIVE.MOUSE.UNFOCUS'
366-
}
367-
368-
export let NativeMouseCommandTelemetryLookup: { [id: number]: NativeMouseCommandTelemetry } = {};
369-
const values2 = [...Object.values(NativeMouseCommandTelemetry)];
370-
for (let i = 0; i < keys.length; i += 1) {
371-
NativeMouseCommandTelemetryLookup[i] = values2[i];
340+
ToggleVariableExplorer = 'DATASCIENCE.NATIVE.MOUSE.TOGGLE_VARIABLE_EXPLORER'
372341
}
373342

374343
export namespace HelpLinks {

‎src/client/datascience/interactive-common/interactiveWindowTypes.ts‎

Lines changed: 2 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ import {
1313
LoadIPyWidgetClassLoadAction
1414
} from '../../../datascience-ui/interactive-common/redux/reducers/types';
1515
import { PythonInterpreter } from '../../interpreter/contracts';
16+
import { NativeKeyboardCommandTelemetry, NativeMouseCommandTelemetry } from '../constants';
1617
import { WidgetScriptSource } from '../ipywidgets/types';
1718
import { LiveKernelModel } from '../jupyter/kernels/types';
1819
import { CssMessages, IGetCssRequest, IGetCssResponse, IGetMonacoThemeRequest, SharedMessages } from '../messages';
@@ -142,35 +143,6 @@ export enum IPyWidgetMessages {
142143
IPyWidgets_MessageHookResult = 'IPyWidgets_MessageHookResult',
143144
IPyWidgets_mirror_execute = 'IPyWidgets_mirror_execute'
144145
}
145-
export enum NativeCommandType {
146-
AddToEnd = 0,
147-
ArrowDown,
148-
ArrowUp,
149-
ChangeToCode,
150-
ChangeToMarkdown,
151-
CollapseInput,
152-
CollapseOutput,
153-
DeleteCell,
154-
Save,
155-
InsertAbove,
156-
InsertBelow,
157-
MoveCellDown,
158-
MoveCellUp,
159-
Redo,
160-
Run,
161-
RunAbove,
162-
RunAll,
163-
RunAndAdd,
164-
RunAndMove,
165-
RunBelow,
166-
SelectKernel,
167-
SelectServer,
168-
ToggleLineNumbers,
169-
ToggleOutput,
170-
ToggleVariableExplorer,
171-
Undo,
172-
Unfocus
173-
}
174146

175147
// These are the messages that will mirror'd to guest/hosts in
176148
// a live share session
@@ -338,8 +310,7 @@ export interface ISaveAll {
338310
}
339311

340312
export interface INativeCommand {
341-
command: NativeCommandType;
342-
source: 'keyboard' | 'mouse';
313+
command: NativeKeyboardCommandTelemetry | NativeMouseCommandTelemetry;
343314
}
344315

345316
export interface IRenderComplete {

‎src/client/datascience/interactive-ipynb/nativeEditor.ts‎

Lines changed: 2 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -44,13 +44,7 @@ import { StopWatch } from '../../common/utils/stopWatch';
4444
import { EXTENSION_ROOT_DIR } from '../../constants';
4545
import { PythonInterpreter } from '../../interpreter/contracts';
4646
import { captureTelemetry, sendTelemetryEvent } from '../../telemetry';
47-
import {
48-
EditorContexts,
49-
Identifiers,
50-
NativeKeyboardCommandTelemetryLookup,
51-
NativeMouseCommandTelemetryLookup,
52-
Telemetry
53-
} from '../constants';
47+
import { EditorContexts, Identifiers, Telemetry } from '../constants';
5448
import { InteractiveBase } from '../interactive-common/interactiveBase';
5549
import {
5650
INativeCommand,
@@ -672,11 +666,7 @@ export class NativeEditor extends InteractiveBase implements INotebookEditor {
672666
}
673667

674668
private logNativeCommand(args: INativeCommand) {
675-
const telemetryEvent =
676-
args.source === 'mouse'
677-
? NativeMouseCommandTelemetryLookup[args.command]
678-
: NativeKeyboardCommandTelemetryLookup[args.command];
679-
sendTelemetryEvent(telemetryEvent);
669+
sendTelemetryEvent(args.command);
680670
}
681671

682672
private async loadCellsComplete() {

‎src/client/telemetry/index.ts‎

Lines changed: 3 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1678,54 +1678,37 @@ export interface IEventNamePropertyMapping {
16781678
*/
16791679
result?: 'notSelected' | 'selected' | 'installationCancelled';
16801680
};
1681-
[NativeKeyboardCommandTelemetry.AddToEnd]: never | undefined;
16821681
[NativeKeyboardCommandTelemetry.ArrowDown]: never | undefined;
16831682
[NativeKeyboardCommandTelemetry.ArrowUp]: never | undefined;
16841683
[NativeKeyboardCommandTelemetry.ChangeToCode]: never | undefined;
16851684
[NativeKeyboardCommandTelemetry.ChangeToMarkdown]: never | undefined;
1686-
[NativeKeyboardCommandTelemetry.CollapseInput]: never | undefined;
1687-
[NativeKeyboardCommandTelemetry.CollapseOutput]: never | undefined;
16881685
[NativeKeyboardCommandTelemetry.DeleteCell]: never | undefined;
16891686
[NativeKeyboardCommandTelemetry.InsertAbove]: never | undefined;
16901687
[NativeKeyboardCommandTelemetry.InsertBelow]: never | undefined;
1691-
[NativeKeyboardCommandTelemetry.MoveCellDown]: never | undefined;
1692-
[NativeKeyboardCommandTelemetry.MoveCellUp]: never | undefined;
1688+
[NativeKeyboardCommandTelemetry.Redo]: never | undefined;
16931689
[NativeKeyboardCommandTelemetry.Run]: never | undefined;
1694-
[NativeKeyboardCommandTelemetry.RunAbove]: never | undefined;
1695-
[NativeKeyboardCommandTelemetry.RunAll]: never | undefined;
16961690
[NativeKeyboardCommandTelemetry.RunAndAdd]: never | undefined;
16971691
[NativeKeyboardCommandTelemetry.RunAndMove]: never | undefined;
1698-
[NativeKeyboardCommandTelemetry.RunBelow]: never | undefined;
16991692
[NativeKeyboardCommandTelemetry.Save]: never | undefined;
17001693
[NativeKeyboardCommandTelemetry.ToggleLineNumbers]: never | undefined;
17011694
[NativeKeyboardCommandTelemetry.ToggleOutput]: never | undefined;
1702-
[NativeKeyboardCommandTelemetry.ToggleVariableExplorer]: never | undefined;
17031695
[NativeKeyboardCommandTelemetry.Undo]: never | undefined;
17041696
[NativeKeyboardCommandTelemetry.Unfocus]: never | undefined;
17051697
[NativeMouseCommandTelemetry.AddToEnd]: never | undefined;
1706-
[NativeMouseCommandTelemetry.ArrowDown]: never | undefined;
1707-
[NativeMouseCommandTelemetry.ArrowUp]: never | undefined;
17081698
[NativeMouseCommandTelemetry.ChangeToCode]: never | undefined;
17091699
[NativeMouseCommandTelemetry.ChangeToMarkdown]: never | undefined;
1710-
[NativeMouseCommandTelemetry.CollapseInput]: never | undefined;
1711-
[NativeMouseCommandTelemetry.CollapseOutput]: never | undefined;
17121700
[NativeMouseCommandTelemetry.DeleteCell]: never | undefined;
1713-
[NativeMouseCommandTelemetry.InsertAbove]: never | undefined;
17141701
[NativeMouseCommandTelemetry.InsertBelow]: never | undefined;
17151702
[NativeMouseCommandTelemetry.MoveCellDown]: never | undefined;
17161703
[NativeMouseCommandTelemetry.MoveCellUp]: never | undefined;
17171704
[NativeMouseCommandTelemetry.Run]: never | undefined;
17181705
[NativeMouseCommandTelemetry.RunAbove]: never | undefined;
17191706
[NativeMouseCommandTelemetry.RunAll]: never | undefined;
1720-
[NativeMouseCommandTelemetry.RunAndAdd]: never | undefined;
1721-
[NativeMouseCommandTelemetry.RunAndMove]: never | undefined;
17221707
[NativeMouseCommandTelemetry.RunBelow]: never | undefined;
17231708
[NativeMouseCommandTelemetry.Save]: never | undefined;
1724-
[NativeMouseCommandTelemetry.ToggleLineNumbers]: never | undefined;
1725-
[NativeMouseCommandTelemetry.ToggleOutput]: never | undefined;
1709+
[NativeMouseCommandTelemetry.SelectKernel]: never | undefined;
1710+
[NativeMouseCommandTelemetry.SelectServer]: never | undefined;
17261711
[NativeMouseCommandTelemetry.ToggleVariableExplorer]: never | undefined;
1727-
[NativeMouseCommandTelemetry.Undo]: never | undefined;
1728-
[NativeMouseCommandTelemetry.Unfocus]: never | undefined;
17291712
/*
17301713
Telemetry event sent with details of Jedi Memory usage.
17311714
mem_use - Memory usage of Process in kb.

‎src/datascience-ui/interactive-common/redux/reducers/transfer.ts‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,8 +55,7 @@ export namespace Transfer {
5555

5656
export function sendCommand(arg: CommonReducerArg<CommonActionType, ISendCommandAction>): IMainState {
5757
postActionToExtension(arg, InteractiveWindowMessages.NativeCommand, {
58-
command: arg.payload.data.command,
59-
source: arg.payload.data.commandType
58+
command: arg.payload.data.command
6059
});
6160
return arg.prevState;
6261
}

‎src/datascience-ui/interactive-common/redux/reducers/types.ts‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22
// Licensed under the MIT License.
33
'use strict';
44

5+
import { NativeKeyboardCommandTelemetry, NativeMouseCommandTelemetry } from '../../../../client/datascience/constants';
56
import {
67
IEditorContentChange,
78
InteractiveWindowMessages,
8-
IShowDataViewer,
9-
NativeCommandType
9+
IShowDataViewer
1010
} from '../../../../client/datascience/interactive-common/interactiveWindowTypes';
1111
import { BaseReduxActionPayload } from '../../../../client/datascience/interactive-common/types';
1212
import { IJupyterVariablesRequest } from '../../../../client/datascience/types';
@@ -201,8 +201,7 @@ export interface IRefreshVariablesAction {
201201
export interface IShowDataViewerAction extends IShowDataViewer {}
202202

203203
export interface ISendCommandAction {
204-
commandType: 'mouse' | 'keyboard';
205-
command: NativeCommandType;
204+
command: NativeKeyboardCommandTelemetry | NativeMouseCommandTelemetry;
206205
}
207206

208207
export interface IChangeCellTypeAction {

0 commit comments

Comments
 (0)