Skip to content

wip new jedi tryPylance banner #14697

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

Closed
Bill Schnurr (bschnurr) wants to merge 4 commits into from
Closed

wip new jedi tryPylance banner #14697

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 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
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
disabled eslint
  • Loading branch information
@bschnurr
bschnurr committed Nov 12, 2020
commit ee5d9f705230d45d7b04f407c6d0489b1c11f7ea
2 changes: 1 addition & 1 deletion src/client/languageServices/proposeLanguageServerBannerJedi.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ export class ProposePylanceBannerJedi implements IPythonExtensionBanner {
promptContent,
Pylance.tryItNow(),
Common.bannerLabelNo(),
Pylance.remindMeLater(),
Pylance.remindMeLater()
);

let userAction: string;
Expand Down
108 changes: 60 additions & 48 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 @@ -18,13 +18,13 @@ import {
IExtensions,
IPersistentState,
IPersistentStateFactory,
IPythonSettings,
IPythonSettings
} from '../../../client/common/types';
import { Common, Pylance } from '../../../client/common/utils/localize';
import {
getPylanceExtensionUri,
ProposeLSStateKeys,
ProposePylanceBannerJedi,
ProposePylanceBannerJedi
} from '../../../client/languageServices/proposeLanguageServerBannerJedi';

import * as Telemetry from '../../../client/telemetry';
Expand All @@ -43,7 +43,7 @@ const testData: IExperimentLsCombination[] = [
{ 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: false }
];

suite('Propose Pylance Banner To Jedi', () => {
Expand Down Expand Up @@ -73,7 +73,7 @@ suite('Propose Pylance Banner To Jedi', () => {
.callsFake((eventName: EventName, _, properties: { userAction: string; experimentName: string }) => {
telemetryEvent = {
eventName,
properties,
properties
};
});
});
Expand Down Expand Up @@ -104,32 +104,36 @@ suite('Propose Pylance Banner To Jedi', () => {
});
test('Do not show banner when it is disabled', async () => {
appShell
.setup((a) => a.showInformationMessage(
anything(),
typemoq.It.isValue(yes),
typemoq.It.isValue(no),
typemoq.It.isValue(later),
))
.setup((a) =>
a.showInformationMessage(
anything(),
typemoq.It.isValue(yes),
typemoq.It.isValue(no),
typemoq.It.isValue(later)
)
)
.verifiable(typemoq.Times.never());
const testBanner = preparePopup(
false,
appShell.object,
appEnv.object,
config.object,
TryPylance.jediPrompt1,
false,
false
);
await testBanner.showBanner();
appShell.verifyAll();
});
test('Clicking No should disable the banner', async () => {
appShell
.setup((a) => a.showInformationMessage(
anything(),
typemoq.It.isValue(yes),
typemoq.It.isValue(no),
typemoq.It.isValue(later),
))
.setup((a) =>
a.showInformationMessage(
anything(),
typemoq.It.isValue(yes),
typemoq.It.isValue(no),
typemoq.It.isValue(later)
)
)
.returns(async () => no)
.verifiable(typemoq.Times.once());
appShell.setup((a) => a.openUrl(getPylanceExtensionUri(appEnv.object))).verifiable(typemoq.Times.never());
Expand All @@ -140,7 +144,7 @@ suite('Propose Pylance Banner To Jedi', () => {
appEnv.object,
config.object,
TryPylance.jediPrompt1,
false,
false
);
await testBanner.showBanner();

Expand All @@ -150,17 +154,19 @@ suite('Propose Pylance Banner To Jedi', () => {
sinon.assert.calledOnce(sendTelemetryStub);
assert.deepEqual(telemetryEvent, {
eventName: EventName.LANGUAGE_SERVER_TRY_PYLANCE,
properties: { userAction: 'no', experimentName: TryPylance.jediPrompt1 },
properties: { userAction: 'no', experimentName: TryPylance.jediPrompt1 }
});
});
test('Clicking Later should disable banner in session', async () => {
appShell
.setup((a) => a.showInformationMessage(
anything(),
typemoq.It.isValue(yes),
typemoq.It.isValue(no),
typemoq.It.isValue(later),
))
.setup((a) =>
a.showInformationMessage(
anything(),
typemoq.It.isValue(yes),
typemoq.It.isValue(no),
typemoq.It.isValue(later)
)
)
.returns(async () => later)
.verifiable(typemoq.Times.once());
appShell.setup((a) => a.openUrl(getPylanceExtensionUri(appEnv.object))).verifiable(typemoq.Times.never());
Expand All @@ -171,13 +177,13 @@ suite('Propose Pylance Banner To Jedi', () => {
appEnv.object,
config.object,
TryPylance.jediPrompt1,
false,
false
);
await testBanner.showBanner();

expect(testBanner.enabled).to.be.equal(
true,
'Banner should not be permanently disabled when user clicked Later',
'Banner should not be permanently disabled when user clicked Later'
);
appShell.verifyAll();

Expand All @@ -186,18 +192,20 @@ suite('Propose Pylance Banner To Jedi', () => {
eventName: EventName.BANNER_NAME_PROPOSE_LS_FOR_JEDI_USERS,
properties: {
userAction: 'later',
experimentName: TryPylance.jediPrompt1,
},
experimentName: TryPylance.jediPrompt1
}
});
});
test('Clicking Yes opens the extension marketplace entry', async () => {
appShell
.setup((a) => a.showInformationMessage(
anything(),
typemoq.It.isValue(yes),
typemoq.It.isValue(no),
typemoq.It.isValue(later),
))
.setup((a) =>
a.showInformationMessage(
anything(),
typemoq.It.isValue(yes),
typemoq.It.isValue(no),
typemoq.It.isValue(later)
)
)
.returns(async () => yes)
.verifiable(typemoq.Times.once());
appShell.setup((a) => a.openUrl(getPylanceExtensionUri(appEnv.object))).verifiable(typemoq.Times.once());
Expand All @@ -208,7 +216,7 @@ suite('Propose Pylance Banner To Jedi', () => {
appEnv.object,
config.object,
TryPylance.jediPrompt1,
false,
false
);
await testBanner.showBanner();

Expand All @@ -220,8 +228,8 @@ suite('Propose Pylance Banner To Jedi', () => {
eventName: EventName.BANNER_NAME_PROPOSE_LS_FOR_JEDI_USERS,
properties: {
userAction: 'yes',
experimentName: TryPylance.jediPrompt1,
},
experimentName: TryPylance.jediPrompt1
}
});
});
});
Expand All @@ -232,7 +240,7 @@ function preparePopup(
appEnv: IApplicationEnvironment,
config: IConfigurationService,
experiment: TryPylance,
pylanceInstalled: boolean,
pylanceInstalled: boolean
): ProposePylanceBannerJedi {
const myfactory = typemoq.Mock.ofType<IPersistentStateFactory>();
const val = typemoq.Mock.ofType<IPersistentState<boolean>>();
Expand All @@ -246,16 +254,20 @@ function preparePopup(
});
val.setup((a) => a.value).returns(() => enabledValue);
myfactory
.setup((a) => a.createGlobalPersistentState(
typemoq.It.isValue(ProposeLSStateKeys.ShowBannerJedi),
typemoq.It.isValue(true),
))
.setup((a) =>
a.createGlobalPersistentState(
typemoq.It.isValue(ProposeLSStateKeys.ShowBannerJedi),
typemoq.It.isValue(true)
)
)
.returns(() => val.object);
myfactory
.setup((a) => a.createGlobalPersistentState(
typemoq.It.isValue(ProposeLSStateKeys.ShowBannerJedi),
typemoq.It.isValue(false),
))
.setup((a) =>
a.createGlobalPersistentState(
typemoq.It.isValue(ProposeLSStateKeys.ShowBannerJedi),
typemoq.It.isValue(false)
)
)
.returns(() => val.object);

const experiments = typemoq.Mock.ofType<IExperimentService>();
Expand Down Expand Up @@ -287,6 +299,6 @@ function preparePopup(
myfactory.object,
config,
experiments.object,
extensions.object,
extensions.object
);
}