Skip to content

Add new tryPylance banner experiments #14759

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
Jake Bailey (jakebailey) merged 14 commits into from
Nov 19, 2020
Merged

Add new tryPylance banner experiments #14759

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
10d245e
wip new jedi tryPylance banner
bschnurr Nov 11, 2020
8c6b70f
test updates
bschnurr Nov 12, 2020
ee5d9f7
disabled eslint
bschnurr Nov 12, 2020
836ce7c
updating tests to pass.
bschnurr Nov 13, 2020
6b7cc58
Merge remote-tracking branch 'bschnurr/jedi-tryplance' into jedi-banner
jakebailey Nov 17, 2020
c7fe1c7
Fix formatting
jakebailey Nov 17, 2020
170d029
Remove unused telemetry event name
jakebailey Nov 18, 2020
ac5fb56
Drop unneeded telemetry property, experiment system already does this
jakebailey Nov 18, 2020
9054c61
Drop whitespace changes
jakebailey Nov 18, 2020
69b1fcc
Undo style change
jakebailey Nov 18, 2020
a126451
Merge pylance propopsal banners
jakebailey Nov 18, 2020
a0f4224
Drop unneeded function
jakebailey Nov 18, 2020
d067421
Remove accidental test.only
jakebailey Nov 18, 2020
2014bb3
Fix failing tests
jakebailey Nov 18, 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
Prev Previous commit
Next Next commit
updating tests to pass. 
adding experimentName to old tryPlance test telemetry
  • Loading branch information
@bschnurr
bschnurr committed Nov 13, 2020
commit 836ce7c7d6aaa13b83279a9a94def1113eb93d7e
13 changes: 8 additions & 5 deletions src/test/testing/banners/proposeNewLanguageServerBanner.unit.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,9 @@ suite('Propose Pylance Banner', () => {
let appEnv: typemoq.IMock<IApplicationEnvironment>;
let settings: typemoq.IMock<IPythonSettings>;
let sendTelemetryStub: sinon.SinonStub;
let telemetryEvent: { eventName: EventName; properties: { userAction: string } } | undefined;
let telemetryEvent:
| { eventName: EventName; properties: { userAction: string; experimentName: string } }
| undefined;

const message = Pylance.proposePylanceMessage();
const yes = Pylance.tryItNow();
Expand All @@ -66,7 +68,7 @@ suite('Propose Pylance Banner', () => {

sendTelemetryStub = sinon
.stub(Telemetry, 'sendTelemetryEvent')
.callsFake((eventName: EventName, _, properties: { userAction: string }) => {
.callsFake((eventName: EventName, _, properties: { userAction: string; experimentName: string }) => {
telemetryEvent = {
eventName,
properties
Expand Down Expand Up @@ -136,7 +138,7 @@ suite('Propose Pylance Banner', () => {
sinon.assert.calledOnce(sendTelemetryStub);
assert.deepEqual(telemetryEvent, {
eventName: EventName.LANGUAGE_SERVER_TRY_PYLANCE,
properties: { userAction: 'no' }
properties: { userAction: 'no', experimentName: TryPylance.experiment }
});
});
test('Clicking Later should disable banner in session', async () => {
Expand Down Expand Up @@ -166,7 +168,7 @@ suite('Propose Pylance Banner', () => {
assert.deepEqual(telemetryEvent, {
eventName: EventName.LANGUAGE_SERVER_TRY_PYLANCE,
properties: {
userAction: 'later'
userAction: 'later', experimentName: TryPylance.experiment
}
});
});
Expand Down Expand Up @@ -194,7 +196,8 @@ suite('Propose Pylance Banner', () => {
assert.deepEqual(telemetryEvent, {
eventName: EventName.LANGUAGE_SERVER_TRY_PYLANCE,
properties: {
userAction: 'yes'
userAction: 'yes',
experimentName: TryPylance.experiment
}
});
});
Expand Down
33 changes: 20 additions & 13 deletions src/test/testing/banners/proposeNewLanguageServerBannerJedi.unit.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@

import { assert, expect } from 'chai';
import * as sinon from 'sinon';
import { anything } from 'ts-mockito';
import * as typemoq from 'typemoq';
import { Extension } from 'vscode';
import { LanguageServerType } from '../../../client/activation/types';
Expand All @@ -31,22 +30,23 @@ import * as Telemetry from '../../../client/telemetry';
import { EventName } from '../../../client/telemetry/constants';

interface IExperimentLsCombination {
experiment: TryPylance;
experiment: TryPylance ;
lsType: LanguageServerType;
shouldShowBanner: boolean;
}
const testData: IExperimentLsCombination[] = [
{ experiment: TryPylance.jediPrompt1, lsType: LanguageServerType.None, shouldShowBanner: true },
{ experiment: TryPylance.jediPrompt1, lsType: LanguageServerType.Microsoft, shouldShowBanner: true },
// Expected Result is shouldShowBanner
{ experiment: TryPylance.jediPrompt1, lsType: LanguageServerType.None, shouldShowBanner: false },
{ experiment: TryPylance.jediPrompt1, lsType: LanguageServerType.Microsoft, shouldShowBanner: false },
{ experiment: TryPylance.jediPrompt1, lsType: LanguageServerType.Node, shouldShowBanner: false },
{ experiment: TryPylance.jediPrompt1, lsType: LanguageServerType.Jedi, shouldShowBanner: false },
{ experiment: TryPylance.jediPrompt1, lsType: LanguageServerType.Jedi, shouldShowBanner: true },
{ experiment: TryPylance.jediPrompt2, lsType: LanguageServerType.None, shouldShowBanner: false },
{ experiment: TryPylance.jediPrompt2, lsType: LanguageServerType.Microsoft, shouldShowBanner: false },
{ experiment: TryPylance.jediPrompt2, lsType: LanguageServerType.Node, shouldShowBanner: false },
{ experiment: TryPylance.jediPrompt2, lsType: LanguageServerType.Jedi, shouldShowBanner: false }
{ experiment: TryPylance.jediPrompt2, lsType: LanguageServerType.Jedi, shouldShowBanner: true }
];

suite('Propose Pylance Banner To Jedi', () => {
suite('Jedi Propose Pylance Banner', () => {
let config: typemoq.IMock<IConfigurationService>;
let appShell: typemoq.IMock<IApplicationShell>;
let appEnv: typemoq.IMock<IApplicationEnvironment>;
Expand All @@ -56,6 +56,7 @@ suite('Propose Pylance Banner To Jedi', () => {
| { eventName: EventName; properties: { userAction: string; experimentName: string } }
| undefined;

const message = 'Sample value1';
const yes = Pylance.tryItNow();
const no = Common.bannerLabelNo();
const later = Pylance.remindMeLater();
Expand Down Expand Up @@ -106,7 +107,7 @@ suite('Propose Pylance Banner To Jedi', () => {
appShell
.setup((a) =>
a.showInformationMessage(
anything(),
typemoq.It.isValue(message),
typemoq.It.isValue(yes),
typemoq.It.isValue(no),
typemoq.It.isValue(later)
Expand All @@ -128,7 +129,7 @@ suite('Propose Pylance Banner To Jedi', () => {
appShell
.setup((a) =>
a.showInformationMessage(
anything(),
typemoq.It.isValue(message),
typemoq.It.isValue(yes),
typemoq.It.isValue(no),
typemoq.It.isValue(later)
Expand All @@ -138,6 +139,8 @@ suite('Propose Pylance Banner To Jedi', () => {
.verifiable(typemoq.Times.once());
appShell.setup((a) => a.openUrl(getPylanceExtensionUri(appEnv.object))).verifiable(typemoq.Times.never());

settings.setup((x) => x.languageServer).returns(() => LanguageServerType.Jedi);

const testBanner = preparePopup(
true,
appShell.object,
Expand All @@ -161,7 +164,7 @@ suite('Propose Pylance Banner To Jedi', () => {
appShell
.setup((a) =>
a.showInformationMessage(
anything(),
typemoq.It.isValue(message),
typemoq.It.isValue(yes),
typemoq.It.isValue(no),
typemoq.It.isValue(later)
Expand All @@ -171,6 +174,8 @@ suite('Propose Pylance Banner To Jedi', () => {
.verifiable(typemoq.Times.once());
appShell.setup((a) => a.openUrl(getPylanceExtensionUri(appEnv.object))).verifiable(typemoq.Times.never());

settings.setup((x) => x.languageServer).returns(() => LanguageServerType.Jedi);

const testBanner = preparePopup(
true,
appShell.object,
Expand All @@ -189,7 +194,7 @@ suite('Propose Pylance Banner To Jedi', () => {

sinon.assert.calledOnce(sendTelemetryStub);
assert.deepEqual(telemetryEvent, {
eventName: EventName.BANNER_NAME_PROPOSE_LS_FOR_JEDI_USERS,
eventName: EventName.LANGUAGE_SERVER_TRY_PYLANCE,
properties: {
userAction: 'later',
experimentName: TryPylance.jediPrompt1
Expand All @@ -200,7 +205,7 @@ suite('Propose Pylance Banner To Jedi', () => {
appShell
.setup((a) =>
a.showInformationMessage(
anything(),
typemoq.It.isValue(message),
typemoq.It.isValue(yes),
typemoq.It.isValue(no),
typemoq.It.isValue(later)
Expand All @@ -210,6 +215,8 @@ suite('Propose Pylance Banner To Jedi', () => {
.verifiable(typemoq.Times.once());
appShell.setup((a) => a.openUrl(getPylanceExtensionUri(appEnv.object))).verifiable(typemoq.Times.once());

settings.setup((x) => x.languageServer).returns(() => LanguageServerType.Jedi);

const testBanner = preparePopup(
true,
appShell.object,
Expand All @@ -225,7 +232,7 @@ suite('Propose Pylance Banner To Jedi', () => {

sinon.assert.calledOnce(sendTelemetryStub);
assert.deepEqual(telemetryEvent, {
eventName: EventName.BANNER_NAME_PROPOSE_LS_FOR_JEDI_USERS,
eventName: EventName.LANGUAGE_SERVER_TRY_PYLANCE,
properties: {
userAction: 'yes',
experimentName: TryPylance.jediPrompt1
Expand Down