Point release with fix for survey prompt (#4113)

DonJayamanne · web-flow · commit 5ee5bce9e0da · 2020-12-03T12:55:07.000-08:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,13 @@
 # Changelog
 
+
+## 2020.11.3 (03 December 2020)
+
+### Fixes
+
+1. Display survey prompt once per session.
+   ([#4077](https://github.com/Microsoft/vscode-jupyter/issues/4077))
+
 ## 2020.11.2 (30 November 2020)
 
 ### Fixes
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
     "name": "jupyter",
     "displayName": "Jupyter",
-    "version": "2020.11.2",
+    "version": "2020.11.3",
     "description": "Jupyter notebook support, interactive programming and computing that supports Intellisense, debugging and more.",
     "featureFlags": {
         "usingNewInterpreterStorage": true
diff --git a/src/client/datascience/dataScienceSurveyBanner.ts b/src/client/datascience/dataScienceSurveyBanner.ts
@@ -136,11 +136,12 @@ export class DataScienceSurveyBanner implements IJupyterExtensionBanner {
         }
         const executionCount: number = this.getExecutionCount();
         const notebookCount: number = this.getOpenNotebookCount();
-        const show = await this.shouldShowBanner(executionCount, notebookCount);
+        const show = this.shouldShowBanner(executionCount, notebookCount);
         if (!show) {
             return;
         }
-
+        // Disable for the current session.
+        this.disabledInCurrentSession = true;
         const response = await this.appShell.showInformationMessage(this.bannerMessage, ...this.bannerLabels);
         switch (response) {
             case this.bannerLabels[DSSurveyLabelIndex.Yes]: {
@@ -154,14 +155,11 @@ export class DataScienceSurveyBanner implements IJupyterExtensionBanner {
                 await this.disable(3);
                 break;
             }
-            default: {
-                // Disable for the current session.
-                this.disabledInCurrentSession = true;
-            }
+            default:
         }
     }
 
-    public async shouldShowBanner(executionCount: number, notebookOpenCount: number): Promise<boolean> {
+    public shouldShowBanner(executionCount: number, notebookOpenCount: number) {
         if (!this.enabled || this.disabledInCurrentSession) {
             return false;
         }
diff --git a/src/client/datascience/insidersNativeNotebookSurveyBanner.ts b/src/client/datascience/insidersNativeNotebookSurveyBanner.ts
@@ -85,13 +85,17 @@ export class InsidersNativeNotebooksSurveyBanner implements IJupyterExtensionBan
     }
 
     public async showBanner(): Promise<void> {
+        if (this.disabledInCurrentSession) {
+            return;
+        }
+        // Disable for the current session.
+        this.disabledInCurrentSession = true;
         const executionCount: number = this.getExecutionCount();
         const notebookCount: number = this.getOpenNotebookCount();
         const show = await this.shouldShowBanner(executionCount, notebookCount);
         if (!show) {
             return;
         }
-
         const response = await this.appShell.showInformationMessage(this.bannerMessage, ...this.bannerLabels);
         switch (response) {
             case this.bannerLabels[DSSurveyLabelIndex.Yes]: {
@@ -105,15 +109,12 @@ export class InsidersNativeNotebooksSurveyBanner implements IJupyterExtensionBan
                 await this.disable(3);
                 break;
             }
-            default: {
-                // Disable for the current session.
-                this.disabledInCurrentSession = true;
-            }
+            default:
         }
     }
 
     public async shouldShowBanner(executionCount: number, notebookOpenCount: number): Promise<boolean> {
-        if (!this.enabled || this.disabledInCurrentSession) {
+        if (!this.enabled) {
             return false;
         }
 
diff --git a/src/test/datascience/datascienceSurveyBanner.vscode.test.ts b/src/test/datascience/datascienceSurveyBanner.vscode.test.ts
@@ -74,14 +74,17 @@ suite('DataScience Survey Banner', () => {
             persistentStateFactory.createGlobalPersistentState(DSSurveyStateKeys.ShowBanner, anything(), anything())
         ).thenReturn(showBannerState);
 
-        bannerService = new DataScienceSurveyBanner(
+        bannerService = createBannerService();
+    });
+    function createBannerService() {
+        return new DataScienceSurveyBanner(
             instance(appShell),
             instance(persistentStateFactory),
             instance(browser),
             instance(editorProvider),
             instance(appEnv)
         );
-    });
+    }
     test('Confirm prompt is displayed & only once per session', async () => {
         when(appShell.showInformationMessage(anything(), anything(), anything())).thenResolve();
         await showBannerState.updateValue({ data: true });
@@ -106,18 +109,21 @@ suite('DataScience Survey Banner', () => {
         resetCalls(appShell);
 
         // Attempt to display again & it won't.
+        bannerService = createBannerService();
         await bannerService.showBanner();
         verify(browser.launch(anything())).never();
         verify(appShell.showInformationMessage(anything(), anything(), anything())).never();
 
         // Advance time by 1 month & still not displayed.
         clock.tick(MillisecondsInADay * 30);
+        bannerService = createBannerService();
         await bannerService.showBanner();
         verify(browser.launch(anything())).never();
         verify(appShell.showInformationMessage(anything(), anything(), anything())).never();
 
         // Advance time by 3.5 month & it will be displayed.
         clock.tick(MillisecondsInADay * 30 * 3.5);
+        bannerService = createBannerService();
         await bannerService.showBanner();
         verify(browser.launch(anything())).never();
         verify(appShell.showInformationMessage(anything(), anything(), anything())).once();
@@ -137,12 +143,14 @@ suite('DataScience Survey Banner', () => {
         resetCalls(appShell);
 
         // Attempt to display again & it won't.
+        bannerService = createBannerService();
         await bannerService.showBanner();
         verify(browser.launch(anything())).never();
         verify(appShell.showInformationMessage(anything(), anything(), anything())).never();
 
         // Advance time by 1 month & still not displayed.
         clock.tick(MillisecondsInADay * 30);
+        bannerService = createBannerService();
         await bannerService.showBanner();
         verify(browser.launch(anything())).never();
         verify(appShell.showInformationMessage(anything(), anything(), anything())).never();
@@ -152,6 +160,7 @@ suite('DataScience Survey Banner', () => {
         when(appShell.showInformationMessage(anything(), anything(), anything())).thenResolve(
             localize.DataScienceSurveyBanner.bannerLabelNo() as any
         );
+        bannerService = createBannerService();
         await bannerService.showBanner();
         verify(browser.launch(anything())).never();
         verify(appShell.showInformationMessage(anything(), anything(), anything())).once();

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "jupyter",`
`3`	`3`	`"displayName": "Jupyter",`
`4`		`- "version": "2020.11.2",`
	`4`	`+ "version": "2020.11.3",`
`5`	`5`	`"description": "Jupyter notebook support, interactive programming and computing that supports Intellisense, debugging and more.",`
`6`	`6`	`"featureFlags": {`
`7`	`7`	`"usingNewInterpreterStorage": true`
Original file line number	Diff line number	Diff line change
`@@ -136,11 +136,12 @@ export class DataScienceSurveyBanner implements IJupyterExtensionBanner {`
`136`	`136`	`}`
`137`	`137`	`const executionCount: number = this.getExecutionCount();`
`138`	`138`	`const notebookCount: number = this.getOpenNotebookCount();`
`139`		`- const show = await this.shouldShowBanner(executionCount, notebookCount);`
	`139`	`+ const show = this.shouldShowBanner(executionCount, notebookCount);`
`140`	`140`	`if (!show) {`
`141`	`141`	`return;`
`142`	`142`	`}`
`143`		`-`
	`143`	`+ // Disable for the current session.`
	`144`	`+ this.disabledInCurrentSession = true;`
`144`	`145`	`const response = await this.appShell.showInformationMessage(this.bannerMessage, ...this.bannerLabels);`
`145`	`146`	`switch (response) {`
`146`	`147`	`case this.bannerLabels[DSSurveyLabelIndex.Yes]: {`
`@@ -154,14 +155,11 @@ export class DataScienceSurveyBanner implements IJupyterExtensionBanner {`
`154`	`155`	`await this.disable(3);`
`155`	`156`	`break;`
`156`	`157`	`}`
`157`		`- default: {`
`158`		`- // Disable for the current session.`
`159`		`- this.disabledInCurrentSession = true;`
`160`		`- }`
	`158`	`+ default:`
`161`	`159`	`}`
`162`	`160`	`}`
`163`	`161`
`164`		`- public async shouldShowBanner(executionCount: number, notebookOpenCount: number): Promise<boolean> {`
	`162`	`+ public shouldShowBanner(executionCount: number, notebookOpenCount: number) {`
`165`	`163`	`if (!this.enabled \|\| this.disabledInCurrentSession) {`
`166`	`164`	`return false;`
`167`	`165`	`}`
Original file line number	Diff line number	Diff line change
`@@ -85,13 +85,17 @@ export class InsidersNativeNotebooksSurveyBanner implements IJupyterExtensionBan`
`85`	`85`	`}`
`86`	`86`
`87`	`87`	`public async showBanner(): Promise<void> {`
	`88`	`+ if (this.disabledInCurrentSession) {`
	`89`	`+ return;`
	`90`	`+ }`
	`91`	`+ // Disable for the current session.`
	`92`	`+ this.disabledInCurrentSession = true;`
`88`	`93`	`const executionCount: number = this.getExecutionCount();`
`89`	`94`	`const notebookCount: number = this.getOpenNotebookCount();`
`90`	`95`	`const show = await this.shouldShowBanner(executionCount, notebookCount);`
`91`	`96`	`if (!show) {`
`92`	`97`	`return;`
`93`	`98`	`}`
`94`		`-`
`95`	`99`	`const response = await this.appShell.showInformationMessage(this.bannerMessage, ...this.bannerLabels);`
`96`	`100`	`switch (response) {`
`97`	`101`	`case this.bannerLabels[DSSurveyLabelIndex.Yes]: {`
`@@ -105,15 +109,12 @@ export class InsidersNativeNotebooksSurveyBanner implements IJupyterExtensionBan`
`105`	`109`	`await this.disable(3);`
`106`	`110`	`break;`
`107`	`111`	`}`
`108`		`- default: {`
`109`		`- // Disable for the current session.`
`110`		`- this.disabledInCurrentSession = true;`
`111`		`- }`
	`112`	`+ default:`
`112`	`113`	`}`
`113`	`114`	`}`
`114`	`115`
`115`	`116`	`public async shouldShowBanner(executionCount: number, notebookOpenCount: number): Promise<boolean> {`
`116`		`- if (!this.enabled \|\| this.disabledInCurrentSession) {`
	`117`	`+ if (!this.enabled) {`
`117`	`118`	`return false;`
`118`	`119`	`}`
`119`	`120`