fix functional test for update metadata (#8887)

Author: IanMatthewHuff

src/client/datascience/interactive-ipynb/nativeEditor.ts

@@ -39,6 +39,7 @@ export class NativeEditor extends InteractiveBase implements INotebookEditor {
     private executedEvent: EventEmitter<INotebookEditor> = new EventEmitter<INotebookEditor>();
     private modifiedEvent: EventEmitter<INotebookEditor> = new EventEmitter<INotebookEditor>();
     private savedEvent: EventEmitter<INotebookEditor> = new EventEmitter<INotebookEditor>();
+    private metadataUpdatedEvent: EventEmitter<INotebookEditor> = new EventEmitter<INotebookEditor>();
     private loadedPromise: Deferred<void> = createDeferred<void>();
     private _file: Uri = Uri.file('');
     private _dirty: boolean = false;
@@ -172,6 +173,10 @@ export class NativeEditor extends InteractiveBase implements INotebookEditor {
         return this.savedEvent.event;
     }
 
+    public get metadataUpdated(): Event<INotebookEditor> {
+        return this.metadataUpdatedEvent.event;
+    }
+
     public get isDirty(): boolean {
         return this._dirty;
     }
@@ -284,7 +289,11 @@ export class NativeEditor extends InteractiveBase implements INotebookEditor {
     protected submitCode(code: string, file: string, line: number, id?: string, editor?: TextEditor, debug?: boolean): Promise<boolean> {
         // When code is executed, update the version number in the metadata.
         return super.submitCode(code, file, line, id, editor, debug).then((value) => {
-            this.updateVersionInfoInNotebook().ignoreErrors();
+            this.updateVersionInfoInNotebook().then(() => {
+                this.metadataUpdatedEvent.fire(this);
+            }).catch(ex => {
+                traceError('Failed to update version info in notebook file metadata', ex);
+            });
             return value;
         });
     }

src/client/datascience/jupyter/jupyterNotebook.ts

@@ -146,7 +146,7 @@ export class JupyterNotebookBase implements INotebook {
     private _disposed: boolean = false;
     private _workingDirectory: string | undefined;
     private _loggers: INotebookExecutionLogger[] = [];
-    private interpreter: PythonInterpreter | undefined;
+    private interpreterPromise: Promise<PythonInterpreter | undefined>;
 
     constructor(
         _liveShare: ILiveShareApi, // This is so the liveshare mixin works
@@ -167,7 +167,7 @@ export class JupyterNotebookBase implements INotebook {
         this._loggers = [...loggers];
         // Save our interpreter and don't change it. Later on when kernel changes
         // are possible, recompute it.
-        this.interpreterService.getActiveInterpreter(resource).then(i => this.interpreter = i).ignoreErrors();
+        this.interpreterPromise = this.interpreterService.getActiveInterpreter(resource);
     }
 
     public get server(): INotebookServer {
@@ -468,7 +468,7 @@ export class JupyterNotebookBase implements INotebook {
     }
 
     public async getMatchingInterpreter(): Promise<PythonInterpreter | undefined> {
-        return this.interpreter;
+        return this.interpreterPromise;
     }
 
     public async getKernelSpec(): Promise<IJupyterKernelSpec | undefined> {

src/client/datascience/types.ts

@@ -281,6 +281,7 @@ export interface INotebookEditor extends IInteractiveBase {
     executed: Event<INotebookEditor>;
     modified: Event<INotebookEditor>;
     saved: Event<INotebookEditor>;
+    metadataUpdated: Event<INotebookEditor>;
     /**
      * Is this notebook representing an untitled file which has never been saved yet.
      */

src/test/datascience/nativeEditor.functional.test.tsx

@@ -1429,16 +1429,25 @@ for _ in range(50):
                 const editor = notebookProvider.editors[0];
                 assert.ok(editor, 'No editor when saving');
                 const savedPromise = createDeferred();
-                const disp = editor.saved(() => savedPromise.resolve());
+                const metadataUpdatedPromise = createDeferred();
+                const disposeSaved = editor.saved(() => savedPromise.resolve());
+                const disposeMetadataUpdated = editor.metadataUpdated(() => metadataUpdatedPromise.resolve());
 
                 // add cells, run them and save
                 await addCell(wrapper, ioc, 'a=1\na');
                 const runAllButton = findButton(wrapper, NativeEditor, 0);
+                const threeCellsUpdated = waitForMessage(ioc, InteractiveWindowMessages.ExecutionRendered, { numberOfTimes: 3 });
                 await waitForMessageResponse(ioc, () => runAllButton!.simulate('click'));
+                await threeCellsUpdated;
+
+                // Make sure metadata has updated before we save
+                await metadataUpdatedPromise.promise;
+                disposeMetadataUpdated.dispose();
+
                 simulateKeyPressOnCell(1, { code: 's', ctrlKey: true });
 
                 await savedPromise.promise;
-                disp.dispose();
+                disposeSaved.dispose();
 
                 // the file has output and execution count
                 const fileContent = await fs.readFile(notebookFile.filePath, 'utf8');