Skip to content
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.

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

feat: telemetry api #4968

Merged
merged 27 commits into from
Dec 3, 2020
Merged
Show file tree
Hide file tree
Changes from 16 commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
2dcce27
feat: telemetry api
tdurnford Nov 24, 2020
b3be74c
Merge branch 'main' into feature/telemetry
tdurnford Nov 24, 2020
d1074d8
lint
tdurnford Nov 24, 2020
8ba8d4c
persist machine id
tdurnford Nov 25, 2020
ab3fc90
Merge branch 'main' into feature/telemetry
tdurnford Nov 25, 2020
83eae7e
Merge branch 'main' into feature/telemetry
tdurnford Nov 29, 2020
a2dee47
move telemetry settings to user settings
tdurnford Nov 30, 2020
1973702
Merge branch 'main' into feature/telemetry
tdurnford Nov 30, 2020
eca7b6c
reverted changes to en-US
tdurnford Nov 30, 2020
e8c6998
pool telemetry events
tdurnford Nov 30, 2020
0d92815
Merge branch 'main' into feature/telemetry
tdurnford Nov 30, 2020
17e4956
changed batch size
tdurnford Nov 30, 2020
360b52f
Merge branch 'main' into feature/telemetry
tdurnford Nov 30, 2020
6bbc52c
Merge branch 'main' into feature/telemetry
tdurnford Dec 1, 2020
df7f772
Merge branch 'main' into feature/telemetry
tdurnford Dec 2, 2020
392293e
fix uuid
tdurnford Dec 2, 2020
7becbd9
Merge branch 'main' into feature/telemetry
tdurnford Dec 2, 2020
e5cc57c
add telemetry classes
tdurnford Dec 3, 2020
97127bb
Merge branch 'main' into feature/telemetry
tdurnford Dec 3, 2020
0f36e5f
Merge branch 'main' into feature/telemetry
tdurnford Dec 3, 2020
3a31333
requested changes
tdurnford Dec 3, 2020
9b68368
Merge branch 'main' into feature/telemetry
tdurnford Dec 3, 2020
d6ab6ef
shorted interval
tdurnford Dec 3, 2020
0591985
Merge branch 'main' into feature/telemetry
a-b-r-o-w-n Dec 3, 2020
c5f0858
fix integration test
tdurnford Dec 3, 2020
1377c3a
change parameter type
tdurnford Dec 3, 2020
0b84f0a
Merge branch 'main' into feature/telemetry
tdurnford Dec 3, 2020
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
11 changes: 1 addition & 10 deletions Composer/cypress/support/index.ts
Original file line number Diff line number Diff line change
@@ -1,22 +1,13 @@
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.

import axios from 'axios';

import './commands';

beforeEach(() => {

cy.exec('yarn test:integration:clean');
window.localStorage.setItem('composer:userSettings', JSON.stringify({ telemetry: { allowDataCollection: false } }));
window.localStorage.setItem('composer:OnboardingState', JSON.stringify({ complete: true }));
window.sessionStorage.setItem('composer:ProjectIdCache', '');
cy.request('post', '/api/settings', {
settings: {
telemetry: {
allowDataCollection: false
}
}
});
});

after(() => {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ describe('<CreationFlow/>', () => {
setCreationFlowStatus: jest.fn(),
navTo: jest.fn(),
saveTemplateId: jest.fn(),
setCurrentPageMode: jest.fn(),
});
set(creationFlowStatusState, CreationFlowStatus.NEW_FROM_TEMPLATE);
set(featureFlagsState, getDefaultFeatureFlags());
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ describe('<AppSettings /> & <ElectronSettings />', () => {
propertyEditorWidth: 400,
dialogNavWidth: 180,
appLocale: 'en-US',
telemetry: {},
});
});
getByText('Auto update');
Expand Down
6 changes: 4 additions & 2 deletions Composer/packages/client/src/App.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,13 @@ import { MainContainer } from './components/AppComponents/MainContainer';
import { userSettingsState } from './recoilModel';
import { loadLocale } from './utils/fileUtil';
import { dispatcherState } from './recoilModel/DispatcherWrapper';
import { useInitializeLogger } from './telemetry/hooks';

initializeIcons(undefined, { disableWarnings: true });

export const App: React.FC = () => {
const { appLocale } = useRecoilValue(userSettingsState);
const { fetchExtensions, fetchFeatureFlags, fetchServerSettings } = useRecoilValue(dispatcherState);
const { fetchExtensions, fetchFeatureFlags } = useRecoilValue(dispatcherState);

useEffect(() => {
loadLocale(appLocale);
Expand All @@ -25,9 +26,10 @@ export const App: React.FC = () => {
useEffect(() => {
fetchExtensions();
fetchFeatureFlags();
fetchServerSettings();
}, []);

useInitializeLogger();

return (
<Fragment key={appLocale}>
<Announcement />
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,18 @@ import { Suspense, Fragment } from 'react';
import React from 'react';

import { isElectron } from './../../utils/electronUtil';
import { ServerSettingsState, onboardingState } from './../../recoilModel';
import { userSettingsState, onboardingState } from './../../recoilModel';

const Onboarding = React.lazy(() => import('./../../Onboarding/Onboarding'));
const AppUpdater = React.lazy(() => import('./../AppUpdater').then((module) => ({ default: module.AppUpdater })));
const DataCollectionDialog = React.lazy(() => import('./../DataCollectionDialog'));

export const Assistant = () => {
const { telemetry } = useRecoilValue(ServerSettingsState);
const { telemetry } = useRecoilValue(userSettingsState);
const onboarding = useRecoilValue(onboardingState);
const renderAppUpdater = isElectron();

const renderDataCollectionDialog = typeof telemetry?.allowDataCollection === 'undefined';
const renderDataCollectionDialog = typeof telemetry.allowDataCollection === 'undefined';
const renderOnboarding = !renderDataCollectionDialog && !onboarding.complete;

return (
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@ import { useRecoilValue } from 'recoil';
import { dispatcherState } from '../recoilModel';

const DataCollectionDialog: React.FC = () => {
const { updateServerSettings } = useRecoilValue(dispatcherState);
const { updateUserSettings } = useRecoilValue(dispatcherState);

const handleDataCollectionChange = (allowDataCollection: boolean) => () => {
updateServerSettings({
updateUserSettings({
telemetry: {
allowDataCollection,
},
Expand Down
16 changes: 12 additions & 4 deletions Composer/packages/client/src/pages/home/Home.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

/** @jsx jsx */
import { jsx } from '@emotion/core';
import React, { useCallback } from 'react';
import React, { useCallback, useEffect } from 'react';
import formatMessage from 'format-message';
import { Link } from 'office-ui-fabric-react/lib/Link';
import { Icon } from 'office-ui-fabric-react/lib/Icon';
Expand Down Expand Up @@ -60,11 +60,19 @@ const Home: React.FC<RouteComponentProps> = () => {
const botName = useRecoilValue(botDisplayNameState(projectId));
const recentProjects = useRecoilValue(recentProjectsState);
const templateId = useRecoilValue(templateIdState);
const { openProject, setCreationFlowStatus, onboardingAddCoachMarkRef, saveTemplateId } = useRecoilValue(
dispatcherState
);
const {
openProject,
setCreationFlowStatus,
onboardingAddCoachMarkRef,
saveTemplateId,
setCurrentPageMode,
} = useRecoilValue(dispatcherState);
const filteredTemplates = useRecoilValue(filteredTemplatesSelector);

useEffect(() => {
setCurrentPageMode('home');
}, []);

const onItemChosen = async (item) => {
if (item && item.path) {
openProject(item.path);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import { RouteComponentProps } from '@reach/router';
import { useRecoilValue } from 'recoil';

import { isElectron } from '../../../utils/electronUtil';
import { onboardingState, userSettingsState, dispatcherState, ServerSettingsState } from '../../../recoilModel';
import { onboardingState, userSettingsState, dispatcherState } from '../../../recoilModel';

import { container, section } from './styles';
import { SettingToggle } from './SettingToggle';
Expand All @@ -28,8 +28,7 @@ const ElectronSettings = lazy(() =>
const AppSettings: React.FC<RouteComponentProps> = () => {
const [calloutIsShown, showCallout] = useState(false);

const { onboardingSetComplete, updateUserSettings, updateServerSettings } = useRecoilValue(dispatcherState);
const { telemetry } = useRecoilValue(ServerSettingsState);
const { onboardingSetComplete, updateUserSettings } = useRecoilValue(dispatcherState);
const userSettings = useRecoilValue(userSettingsState);
const { complete } = useRecoilValue(onboardingState);
const onOnboardingChange = useCallback(
Expand All @@ -49,8 +48,8 @@ const AppSettings: React.FC<RouteComponentProps> = () => {
updateUserSettings({ appLocale });
};

const handleDataCollectionChange = (allowDataCollection) => {
updateServerSettings({
const handleDataCollectionChange = (allowDataCollection: boolean) => {
updateUserSettings({
telemetry: {
allowDataCollection,
},
Expand Down Expand Up @@ -196,7 +195,7 @@ const AppSettings: React.FC<RouteComponentProps> = () => {
<section css={section}>
<h2>{formatMessage('Data Collection')}</h2>
<SettingToggle
checked={!!telemetry?.allowDataCollection}
checked={!!userSettings.telemetry.allowDataCollection}
description={formatMessage(
'Composer includes a telemetry feature that collects usage information. It is important that the Composer team understands how the tool is being used so that it can be improved.'
)}
Expand Down
11 changes: 1 addition & 10 deletions Composer/packages/client/src/recoilModel/atoms/appState.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
// Licensed under the MIT License.

import { atom, atomFamily } from 'recoil';
import { FormDialogSchemaTemplate, FeatureFlagMap, BotTemplate, UserSettings, ServerSettings } from '@bfc/shared';
import { FormDialogSchemaTemplate, FeatureFlagMap, BotTemplate, UserSettings } from '@bfc/shared';
import { ExtensionMetadata } from '@bfc/extension-client';
import formatMessage from 'format-message';

Expand Down Expand Up @@ -237,12 +237,3 @@ export const pageElementState = atom<{ [page in PageMode]?: { [key: string]: any
qna: {},
},
});

export const ServerSettingsState = atom<ServerSettings>({
key: getFullyQualifiedKey('serverSettings'),
default: {
telemetry: {
allowDataCollection: false,
},
},
});

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,7 @@ describe('user dispatcher', () => {
propertyEditorWidth: 400,
dialogNavWidth: 555,
appLocale: 'en-US',
telemetry: {},
});
});

Expand Down
2 changes: 0 additions & 2 deletions Composer/packages/client/src/recoilModel/dispatchers/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ import { formDialogsDispatcher } from './formDialogs';
import { botProjectFileDispatcher } from './botProjectFile';
import { zoomDispatcher } from './zoom';
import { recognizerDispatcher } from './recognizers';
import { serverSettingsDispatcher } from './serverSettings';

const createDispatchers = () => {
return {
Expand All @@ -51,7 +50,6 @@ const createDispatchers = () => {
...botProjectFileDispatcher(),
...zoomDispatcher(),
...recognizerDispatcher(),
...serverSettingsDispatcher(),
};
};

Expand Down

This file was deleted.

Loading