Port gather survey and icon getting disabled while gathering (#13296)

* Add gather status bar and update survey link (#13225)

* add status bar

* add localization

* Added news file

* add a 2 second timeout

* updated the gather survey link

* Change the gather icon while gathering

* moved the gathering redux function to
interactive common
added a constant

* move css to common.css

* removed the status bar message

* changed noop import

* update changelog

Author: David Kutugata

CHANGELOG.md

@@ -28,6 +28,8 @@
    ([#13218](https://github.com/Microsoft/vscode-python/issues/13218))
 1. Use jupyter inspect to get signature of dynamic functions in notebook editor when language server doesn't provide enough hint.
    ([#13259](https://github.com/Microsoft/vscode-python/issues/13259))
+1. The gather icon will change and get disabled while gather is executing.
+   ([#13177](https://github.com/microsoft/vscode-python/issues/13177))
 
 ### Fixes
 
@@ -36,7 +38,7 @@
 1. Don't loop selection through all failed tests every time tests are run.
    ([#11743](https://github.com/Microsoft/vscode-python/issues/11743))
 1. Some tools (like pytest) rely on the existence of `sys.path[0]`, so
-   deleting it in the isolation script can sometimes cause problems.  The
+   deleting it in the isolation script can sometimes cause problems. The
    solution is to point `sys.path[0]` to a bogus directory that we know
    does not exist (assuming noone modifies the extension install dir).
    ([#11875](https://github.com/Microsoft/vscode-python/issues/11875))
@@ -47,7 +49,7 @@
 1. Make the data science variable explorer support high contrast color theme.
    ([#12766](https://github.com/Microsoft/vscode-python/issues/12766))
 1. The change in PR #12795 led to one particular test suite to take longer
-   to run.  Here we increase the timeout for that suite to get the test
+   to run. Here we increase the timeout for that suite to get the test
    passing.
    ([#12833](https://github.com/Microsoft/vscode-python/issues/12833))
 1. Refactor data science filesystem usage to correctly handle files which are potentially remote.
@@ -6793,4 +6795,4 @@ the following people who contributed code:
 
 ## Version 0.0.3
 
--   Added support for debugging using PDB
+-   Added support for debugging using PDB

package.nls.json

@@ -500,7 +500,7 @@
     "DataScience.findJupyterCommandProgressCheckInterpreter": "Checking {0}.",
     "DataScience.findJupyterCommandProgressSearchCurrentPath": "Searching current path.",
     "DataScience.gatherError": "Gather internal error",
-    "DataScience.gatheredScriptDescription": "# This file was generated by the Gather Extension.\n# It requires version 2020.7.94776 (or newer) of the Python Extension.\n#\n#     The intent is that it contains only the code required to produce\n#     the same results as the cell originally selected for gathering.\n#     Please note that the Python analysis is quite conservative, so if\n#     it is unsure whether a line of code is necessary for execution, it\n#     will err on the side of including it.\n#\n# Please let us know if you are satisfied with what was gathered here:\n# https://aka.ms/gathersurvey\n\n",
+    "DataScience.gatheredScriptDescription": "# This file was generated by the Gather Extension.\n# It requires version 2020.7.94776 (or newer) of the Python Extension.\n#\n#     The intent is that it contains only the code required to produce\n#     the same results as the cell originally selected for gathering.\n#     Please note that the Python analysis is quite conservative, so if\n#     it is unsure whether a line of code is necessary for execution, it\n#     will err on the side of including it.\n#\n# Please let us know if you are satisfied with what was gathered here:\n# https://aka.ms/gatherfeedback\n\n",
     "DataScience.gatheredNotebookDescriptionInMarkdown": "## Gathered Notebook\nGathered from ```{0}```\n\n|   |   |\n|---|---|\n|  &nbsp|This notebook was generated by the Gather Extension. It requires version 2020.7.94776 (or newer) of the Python Extension, please update [here](https://command:python.datascience.latestExtension). The intent is that it contains only the code and cells required to produce the same results as the cell originally selected for gathering. Please note that the Python analysis is quite conservative, so if it is unsure whether a line of code is necessary for execution, it will err on the side of including it.|\n\n**Are you satisfied with the code that was gathered?**\n\n[Yes](https://command:python.datascience.gatherquality?yes) [No](https://command:python.datascience.gatherquality?no)",
     "DataScience.savePngTitle": "Save Image",
     "DataScience.jupyterSelectURIQuickPickTitle": "Pick how to connect to Jupyter",
@@ -584,10 +584,10 @@
     "DataScienceRendererExtension.downloadCompletedOutputMessage": "Notebook Renderers extension download complete.",
     "DataScience.uriProviderDescriptionFormat": "{0} (From {1} extension)",
     "DataScience.unknownPackage": "unknown",
-    "DataScience.interactiveWindowTitle" : "Python Interactive",
-    "DataScience.interactiveWindowTitleFormat" : "Python Interactive - {0}",
-    "DataScience.interactiveWindowModeBannerTitle" : "Do you want to open a new Python Interactive window for this file? [More Information](command:workbench.action.openSettings?%5B%22python.dataScience.interactiveWindowMode%22%5D).",
-    "DataScience.interactiveWindowModeBannerSwitchYes" : "Yes",
-    "DataScience.interactiveWindowModeBannerSwitchAlways" : "Always",
-    "DataScience.interactiveWindowModeBannerSwitchNo" : "No"
+    "DataScience.interactiveWindowTitle": "Python Interactive",
+    "DataScience.interactiveWindowTitleFormat": "Python Interactive - {0}",
+    "DataScience.interactiveWindowModeBannerTitle": "Do you want to open a new Python Interactive window for this file? [More Information](command:workbench.action.openSettings?%5B%22python.dataScience.interactiveWindowMode%22%5D).",
+    "DataScience.interactiveWindowModeBannerSwitchYes": "Yes",
+    "DataScience.interactiveWindowModeBannerSwitchAlways": "Always",
+    "DataScience.interactiveWindowModeBannerSwitchNo": "No"
 }

src/client/common/utils/localize.ts

@@ -925,7 +925,7 @@ export namespace DataScience {
     export const gatherError = localize('DataScience.gatherError', 'Gather internal error');
     export const gatheredScriptDescription = localize(
         'DataScience.gatheredScriptDescription',
-        '# This file was generated by the Gather Extension.\n# It requires version 2020.7.94776 (or newer) of the Python Extension.\n#\n#     The intent is that it contains only the code required to produce\n#     the same results as the cell originally selected for gathering.\n#     Please note that the Python analysis is quite conservative, so if\n#     it is unsure whether a line of code is necessary for execution, it\n#     will err on the side of including it.\n#\n# Please let us know if you are satisfied with what was gathered here:\n# https://aka.ms/gathersurvey\n\n'
+        '# This file was generated by the Gather Extension.\n# It requires version 2020.7.94776 (or newer) of the Python Extension.\n#\n#     The intent is that it contains only the code required to produce\n#     the same results as the cell originally selected for gathering.\n#     Please note that the Python analysis is quite conservative, so if\n#     it is unsure whether a line of code is necessary for execution, it\n#     will err on the side of including it.\n#\n# Please let us know if you are satisfied with what was gathered here:\n# https://aka.ms/gatherfeedback\n\n'
     );
     export const gatheredNotebookDescriptionInMarkdown = localize(
         'DataScience.gatheredNotebookDescriptionInMarkdown',

src/client/datascience/commands/commandRegistry.ts

@@ -450,7 +450,7 @@ export class CommandRegistry implements IDisposable {
 
     private reportGatherQuality(val: string) {
         sendTelemetryEvent(Telemetry.GatherQualityReport, undefined, { result: val[0] === 'no' ? 'no' : 'yes' });
-        env.openExternal(Uri.parse(`https://aka.ms/gathersurvey?succeed=${val[0]}`));
+        env.openExternal(Uri.parse(`https://aka.ms/gatherfeedback?succeed=${val[0]}`));
     }
 
     private openPythonExtensionPage() {

src/client/datascience/gather/gatherListener.ts

@@ -74,10 +74,18 @@ export class GatherListener implements IInteractiveWindowListener {
                 break;
 
             case InteractiveWindowMessages.GatherCode:
+                this.postEmitter.fire({
+                    message: InteractiveWindowMessages.Gathering,
+                    payload: { cellId: payload.id, gathering: true }
+                });
                 this.handleMessage(message, payload, this.doGather);
                 break;
 
             case InteractiveWindowMessages.GatherCodeToScript:
+                this.postEmitter.fire({
+                    message: InteractiveWindowMessages.Gathering,
+                    payload: { cellId: payload.id, gathering: true }
+                });
                 this.handleMessage(message, payload, this.doGatherToScript);
                 break;
 
@@ -142,18 +150,32 @@ export class GatherListener implements IInteractiveWindowListener {
         }
     }
 
-    private doGather(payload: ICell): void {
-        this.gatherCodeInternal(payload).catch((err) => {
-            traceError(`Gather to Notebook error: ${err}`);
-            this.applicationShell.showErrorMessage(err);
-        });
+    private doGather(payload: ICell): Promise<void> {
+        return this.gatherCodeInternal(payload)
+            .catch((err) => {
+                traceError(`Gather to Notebook error: ${err}`);
+                this.applicationShell.showErrorMessage(err);
+            })
+            .finally(() =>
+                this.postEmitter.fire({
+                    message: InteractiveWindowMessages.Gathering,
+                    payload: { cellId: payload.id, gathering: false }
+                })
+            );
     }
 
-    private doGatherToScript(payload: ICell): void {
-        this.gatherCodeInternal(payload, true).catch((err) => {
-            traceError(`Gather to Script error: ${err}`);
-            this.applicationShell.showErrorMessage(err);
-        });
+    private doGatherToScript(payload: ICell): Promise<void> {
+        return this.gatherCodeInternal(payload, true)
+            .catch((err) => {
+                traceError(`Gather to Script error: ${err}`);
+                this.applicationShell.showErrorMessage(err);
+            })
+            .finally(() =>
+                this.postEmitter.fire({
+                    message: InteractiveWindowMessages.Gathering,
+                    payload: { cellId: payload.id, gathering: false }
+                })
+            );
     }
 
     private gatherCodeInternal = async (cell: ICell, toScript: boolean = false) => {

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

@@ -10,6 +10,7 @@ import { DebugProtocol } from 'vscode-debugprotocol';
 import {
     CommonActionType,
     IAddCellAction,
+    IChangeGatherStatus,
     ILoadIPyWidgetClassFailureAction,
     IVariableExplorerHeight,
     LoadIPyWidgetClassLoadAction,
@@ -98,6 +99,7 @@ export enum InteractiveWindowMessages {
     StopDebugging = 'stop_debugging',
     GatherCode = 'gather_code',
     GatherCodeToScript = 'gather_code_to_script',
+    Gathering = 'gathering',
     LaunchNotebookTrustPrompt = 'launch_notebook_trust_prompt',
     TrustNotebookComplete = 'trust_notebook_complete',
     LoadAllCells = 'load_all_cells',
@@ -630,6 +632,7 @@ export class IInteractiveWindowMapping {
     public [InteractiveWindowMessages.StopDebugging]: never | undefined;
     public [InteractiveWindowMessages.GatherCode]: ICell;
     public [InteractiveWindowMessages.GatherCodeToScript]: ICell;
+    public [InteractiveWindowMessages.Gathering]: IChangeGatherStatus;
     public [InteractiveWindowMessages.LaunchNotebookTrustPrompt]: never | undefined;
     public [InteractiveWindowMessages.TrustNotebookComplete]: never | undefined;
     public [InteractiveWindowMessages.LoadAllCells]: ILoadAllCells;

src/client/datascience/interactive-common/synchronization.ts

@@ -129,6 +129,7 @@ const messageWithMessageTypes: MessageMapping<IInteractiveWindowMapping> & Messa
     [InteractiveWindowMessages.FocusedCellEditor]: MessageType.syncWithLiveShare,
     [InteractiveWindowMessages.GatherCode]: MessageType.other,
     [InteractiveWindowMessages.GatherCodeToScript]: MessageType.other,
+    [InteractiveWindowMessages.Gathering]: MessageType.other,
     [InteractiveWindowMessages.GetAllCells]: MessageType.other,
     [InteractiveWindowMessages.ForceVariableRefresh]: MessageType.other,
     [InteractiveWindowMessages.GetVariablesRequest]: MessageType.other,

src/datascience-ui/history-react/interactiveCell.tsx

@@ -195,8 +195,13 @@ export class InteractiveCell extends React.Component<IInteractiveCellProps> {
                         !this.props.settings.gatherIsInstalled
                     }
                     tooltip={getLocString('DataScience.gatherCodeTooltip', 'Gather code')}
+                    disabled={this.props.cellVM.gathering}
                 >
-                    <Image baseTheme={this.props.baseTheme} class="image-button-image" image={ImageName.GatherCode} />
+                    <Image
+                        baseTheme={this.props.baseTheme}
+                        class="image-button-image"
+                        image={this.props.cellVM.gathering ? ImageName.Sync : ImageName.GatherCode}
+                    />
                 </ImageButton>
                 <ImageButton
                     baseTheme={this.props.baseTheme}

src/datascience-ui/history-react/interactivePanel.less

@@ -1,5 +1,5 @@
 /* Import common styles and then override them below */
-@import "../interactive-common/common.css";
+@import '../interactive-common/common.css';
 
 .toolbar-menu-bar-child {
     background: var(--override-background, var(--vscode-editor-background));
@@ -37,27 +37,26 @@
 }
 
 .cell-outer {
-    display:grid;
+    display: grid;
     grid-template-columns: auto minmax(0, 1fr) 8px;
     grid-column-gap: 3px;
     width: 100%;
 }
 
-
 .cell-output {
     margin: 0px;
     width: 100%;
     overflow-x: scroll;
     background: transparent;
 }
 
-.cell-output>div {
+.cell-output > div {
     background: var(--override-widget-background, var(--vscode-notifications-background));
 }
 
 xmp {
     margin: 0px;
-} 
+}
 
 .cell-input {
     margin: 0;
@@ -72,4 +71,4 @@ xmp {
     white-space: pre-wrap;
     word-break: break-all;
     overflow-x: hidden;
-}
+}

src/datascience-ui/history-react/redux/reducers/index.ts

@@ -71,5 +71,6 @@ export const reducerMap: Partial<IInteractiveActionMapping> = {
     [InteractiveWindowMessages.UpdateKernel]: Kernel.updateStatus,
     [SharedMessages.LocInit]: CommonEffects.handleLocInit,
     [InteractiveWindowMessages.UpdateDisplayData]: CommonEffects.handleUpdateDisplayData,
-    [InteractiveWindowMessages.HasCell]: Transfer.hasCell
+    [InteractiveWindowMessages.HasCell]: Transfer.hasCell,
+    [InteractiveWindowMessages.Gathering]: Transfer.gathering
 };