Make getAndUpdateModeHandler return undefined when there is no active editor

This means `vimState.editor` should never be undefined - now we should start using that instead of `vscode.window.activeTextEditor` to avoid a whole bunch of pesky race conditions.
Refs #5663

Author: J-Fields

extensionBase.ts

@@ -28,16 +28,22 @@ interface ICodeKeybinding {
   commands?: { command: string; args: any[] }[];
 }
 
-export async function getAndUpdateModeHandler(forceSyncAndUpdate = false): Promise<ModeHandler> {
+export async function getAndUpdateModeHandler(
+  forceSyncAndUpdate = false
+): Promise<ModeHandler | undefined> {
   const activeTextEditor = vscode.window.activeTextEditor;
+  if (activeTextEditor === undefined) {
+    return undefined;
+  }
+
   const activeEditorId = EditorIdentity.fromEditor(activeTextEditor);
 
   let [curHandler, isNew] = await ModeHandlerMap.getOrCreate(activeEditorId);
   if (isNew) {
     extensionContext.subscriptions.push(curHandler);
   }
 
-  curHandler.vimState.editor = activeTextEditor!;
+  curHandler.vimState.editor = activeTextEditor;
 
   if (
     forceSyncAndUpdate ||
@@ -250,9 +256,8 @@ export async function activate(
       Register.putByKey(filepathComponents[filepathComponents.length - 1], '%', undefined, true);
 
       taskQueue.enqueueTask(async () => {
-        if (vscode.window.activeTextEditor !== undefined) {
-          const mh: ModeHandler = await getAndUpdateModeHandler(true);
-
+        const mh = await getAndUpdateModeHandler(true);
+        if (mh) {
           globalState.jumpTracker.handleFileJump(
             lastClosedModeHandler ? Jump.fromStateNow(lastClosedModeHandler.vimState) : null,
             Jump.fromStateNow(mh.vimState)
@@ -272,12 +277,15 @@ export async function activate(
         vscode.window.activeTextEditor === undefined ||
         e.textEditor.document !== vscode.window.activeTextEditor.document
       ) {
-        // we don't care if there is no active editor
-        // or user selection changed in a paneled window (e.g debug console/terminal)
+        // We don't care if user selection changed in a paneled window (e.g debug console/terminal)
         return;
       }
 
       const mh = await getAndUpdateModeHandler();
+      if (mh === undefined) {
+        // We don't care if there is no active editor
+        return;
+      }
 
       if (e.kind !== vscode.TextEditorSelectionChangeKind.Mouse) {
         const selectionsHash = e.selections.reduce(
@@ -341,32 +349,34 @@ export async function activate(
   overrideCommand(context, 'type', async (args) => {
     taskQueue.enqueueTask(async () => {
       const mh = await getAndUpdateModeHandler();
-
-      if (compositionState.isInComposition) {
-        compositionState.composingText += args.text;
-      } else {
-        await mh.handleKeyEvent(args.text);
+      if (mh) {
+        if (compositionState.isInComposition) {
+          compositionState.composingText += args.text;
+        } else {
+          await mh.handleKeyEvent(args.text);
+        }
       }
     });
   });
 
   overrideCommand(context, 'replacePreviousChar', async (args) => {
     taskQueue.enqueueTask(async () => {
       const mh = await getAndUpdateModeHandler();
-
-      if (compositionState.isInComposition) {
-        compositionState.composingText =
-          compositionState.composingText.substr(
-            0,
-            compositionState.composingText.length - args.replaceCharCnt
-          ) + args.text;
-      } else {
-        await vscode.commands.executeCommand('default:replacePreviousChar', {
-          text: args.text,
-          replaceCharCnt: args.replaceCharCnt,
-        });
-        mh.vimState.cursorStopPosition = mh.vimState.editor.selection.start;
-        mh.vimState.cursorStartPosition = mh.vimState.editor.selection.start;
+      if (mh) {
+        if (compositionState.isInComposition) {
+          compositionState.composingText =
+            compositionState.composingText.substr(
+              0,
+              compositionState.composingText.length - args.replaceCharCnt
+            ) + args.text;
+        } else {
+          await vscode.commands.executeCommand('default:replacePreviousChar', {
+            text: args.text,
+            replaceCharCnt: args.replaceCharCnt,
+          });
+          mh.vimState.cursorStopPosition = mh.vimState.editor.selection.start;
+          mh.vimState.cursorStartPosition = mh.vimState.editor.selection.start;
+        }
       }
     });
   });
@@ -380,22 +390,30 @@ export async function activate(
   overrideCommand(context, 'compositionEnd', async () => {
     taskQueue.enqueueTask(async () => {
       const mh = await getAndUpdateModeHandler();
-      let text = compositionState.composingText;
-      compositionState.reset();
-      mh.handleMultipleKeyEvents(text.split(''));
+      if (mh) {
+        const text = compositionState.composingText;
+        compositionState.reset();
+        mh.handleMultipleKeyEvents(text.split(''));
+      }
     });
   });
 
   // Register extension commands
   registerCommand(context, 'vim.showQuickpickCmdLine', async () => {
     const mh = await getAndUpdateModeHandler();
-    await commandLine.PromptAndRun('', mh.vimState);
-    mh.updateView();
+    if (mh) {
+      await commandLine.PromptAndRun('', mh.vimState);
+      mh.updateView();
+    }
   });
 
   registerCommand(context, 'vim.remap', async (args: ICodeKeybinding) => {
     taskQueue.enqueueTask(async () => {
       const mh = await getAndUpdateModeHandler();
+      if (mh === undefined) {
+        return;
+      }
+
       if (args.after) {
         for (const key of args.after) {
           await mh.handleKeyEvent(Notation.NormalizeKey(key, configuration.leader));
@@ -443,11 +461,13 @@ export async function activate(
     });
   }
 
-  // Initialize mode handler for current active Text Editor at startup.
-  if (vscode.window.activeTextEditor) {
-    let mh = await getAndUpdateModeHandler();
-    // This is called last because getAndUpdateModeHandler() will change cursor
-    mh.updateView({ drawSelection: false, revealRange: false });
+  {
+    // Initialize mode handler for current active Text Editor at startup.
+    const modeHandler = await getAndUpdateModeHandler();
+    if (modeHandler) {
+      // This is called last because getAndUpdateModeHandler() will change cursor
+      modeHandler.updateView({ drawSelection: false, revealRange: false });
+    }
   }
 
   // Disable automatic keyboard navigation in lists, so it doesn't interfere
@@ -472,13 +492,15 @@ async function toggleExtension(isDisabled: boolean, compositionState: Compositio
     // If activate was called and no editor window is open, we can't properly initialize.
     return;
   }
-  let mh = await getAndUpdateModeHandler();
-  if (isDisabled) {
-    await mh.handleKeyEvent(SpecialKeys.ExtensionDisable);
-    compositionState.reset();
-    ModeHandlerMap.clear();
-  } else {
-    await mh.handleKeyEvent(SpecialKeys.ExtensionEnable);
+  const mh = await getAndUpdateModeHandler();
+  if (mh) {
+    if (isDisabled) {
+      await mh.handleKeyEvent(SpecialKeys.ExtensionDisable);
+      compositionState.reset();
+      ModeHandlerMap.clear();
+    } else {
+      await mh.handleKeyEvent(SpecialKeys.ExtensionEnable);
+    }
   }
 }
 
@@ -547,18 +569,21 @@ function registerEventListener<T>(
 
 async function handleKeyEvent(key: string): Promise<void> {
   const mh = await getAndUpdateModeHandler();
-
-  taskQueue.enqueueTask(async () => {
-    await mh.handleKeyEvent(key);
-  });
+  if (mh) {
+    taskQueue.enqueueTask(async () => {
+      await mh.handleKeyEvent(key);
+    });
+  }
 }
 
 async function checkIfRecursiveRemapping(key: string): Promise<void> {
   const mh = await getAndUpdateModeHandler();
-  if (mh.vimState.isCurrentlyPerformingRecursiveRemapping) {
-    mh.vimState.forceStopRecursiveRemapping = true;
-  } else {
-    handleKeyEvent(key);
+  if (mh) {
+    if (mh.vimState.isCurrentlyPerformingRecursiveRemapping) {
+      mh.vimState.forceStopRecursiveRemapping = true;
+    } else {
+      handleKeyEvent(key);
+    }
   }
 }
 

extensionWeb.ts

@@ -15,7 +15,6 @@ import './src/configuration/validators/vimrcValidator';
 
 import * as vscode from 'vscode';
 import { activate as activateFunc } from './extensionBase';
-export { getAndUpdateModeHandler } from './extensionBase';
 
 export async function activate(context: vscode.ExtensionContext) {
   activateFunc(context, false);

test/cmd_line/bang.test.ts

@@ -7,7 +7,7 @@ suite('bang (!) cmd_line', () => {
 
   setup(async () => {
     await setupWorkspace();
-    modeHandler = await getAndUpdateModeHandler();
+    modeHandler = (await getAndUpdateModeHandler())!;
   });
 
   teardown(cleanUpWorkspace);

test/cmd_line/command.test.ts

@@ -7,7 +7,7 @@ suite('cmd_line/search command', () => {
 
   setup(async () => {
     await setupWorkspace();
-    modeHandler = await getAndUpdateModeHandler();
+    modeHandler = (await getAndUpdateModeHandler())!;
   });
 
   teardown(cleanUpWorkspace);

test/cmd_line/cursorLocation.test.ts

@@ -10,7 +10,7 @@ suite('cursor location', () => {
 
   suiteSetup(async () => {
     await setupWorkspace();
-    modeHandler = await getAndUpdateModeHandler();
+    modeHandler = (await getAndUpdateModeHandler())!;
   });
 
   suiteTeardown(cleanUpWorkspace);

test/cmd_line/only.test.ts

@@ -37,7 +37,7 @@ suite(':only command', () => {
 
   setup(async () => {
     await setupWorkspace();
-    modeHandler = await getAndUpdateModeHandler();
+    modeHandler = (await getAndUpdateModeHandler())!;
   });
 
   teardown(cleanUpWorkspace);

test/cmd_line/put.test.ts

@@ -9,7 +9,7 @@ suite('put cmd_line', () => {
 
   setup(async () => {
     await setupWorkspace();
-    modeHandler = await getAndUpdateModeHandler();
+    modeHandler = (await getAndUpdateModeHandler())!;
   });
 
   teardown(cleanUpWorkspace);

test/cmd_line/smile.test.ts

@@ -17,7 +17,7 @@ suite('Smile command', () => {
 
   setup(async () => {
     await setupWorkspace();
-    modeHandler = await getAndUpdateModeHandler();
+    modeHandler = (await getAndUpdateModeHandler())!;
   });
 
   teardown(cleanUpWorkspace);

test/cmd_line/sort.test.ts

@@ -10,7 +10,7 @@ suite('Basic sort', () => {
 
   setup(async () => {
     await setupWorkspace();
-    modeHandler = await getAndUpdateModeHandler();
+    modeHandler = (await getAndUpdateModeHandler())!;
     vimState = modeHandler.vimState;
   });
 

test/cmd_line/split.test.ts

@@ -11,7 +11,7 @@ suite('Horizontal split', () => {
 
   setup(async () => {
     await setupWorkspace();
-    modeHandler = await getAndUpdateModeHandler();
+    modeHandler = (await getAndUpdateModeHandler())!;
   });
 
   teardown(cleanUpWorkspace);