chore: avoid process.nextTick() and setImmediate() COMPASS-7314 (#4974)

Replace, or where unused remove, usage of `process.nextTick()`
and `setImmediate()`, both of which are Node.js-specific APIs
for async deferral for which browser-compatible replacements with
near-identical behavior exist.

Add linting rules to prevent usage of these methods. There might be
a way to scope these linting rules to only the packages that we
intend to use in browser environments, or exclude them from applying
to test files. However, that seems unnecessary, given that the
replacements are no harder to use, so a consistent style across
the entire Compass codebase seems preferable.

Author: addaleax

configs/eslint-config-compass/index.js

@@ -60,6 +60,18 @@ module.exports = {
       'error',
       { root: path.resolve(__dirname, '..', '..') },
     ],
+    'no-restricted-syntax': [
+      'error',
+      {
+        selector: 'CallExpression[callee.name="setImmediate"]',
+        message: 'Use browser-compatible `setTimeout(...)` instead',
+      },
+      {
+        selector:
+          'CallExpression[callee.object.name="process"][callee.property.name="nextTick"]',
+        message: 'Use browser-compatible `queueMicrotask(...)` instead',
+      },
+    ],
   },
   env: {
     ...shared.env,

packages/atlas-service/src/store/atlas-signin-reducer.spec.ts

@@ -316,9 +316,16 @@ describe('atlasSignInReducer', function () {
     });
 
     it('should reject if provided signal was aborted', async function () {
+      let resolveSignInCalled = () => {};
+      const signInCalled: Promise<void> = new Promise(
+        (resolve) => (resolveSignInCalled = resolve)
+      );
       const mockAtlasService = {
         isAuthenticated: sandbox.stub().resolves(false),
-        signIn: sandbox.stub().resolves({ sub: '1234' }),
+        signIn: sandbox.stub().callsFake(() => {
+          resolveSignInCalled();
+          return { sub: '1234' };
+        }),
         getUserInfo: sandbox.stub().resolves({ sub: '1234' }),
         emit: sandbox.stub(),
       };
@@ -337,6 +344,9 @@ describe('atlasSignInReducer', function () {
         expect(err).to.have.property('message', 'Aborted from outside');
       }
       expect(store.getState()).to.have.property('state', 'canceled');
+
+      // Ensure that we are not leaving a dangling store operation that would conflict with our mocks being reset.
+      await signInCalled;
     });
   });
 });

packages/atlas-service/src/store/atlas-signin-reducer.ts

@@ -399,9 +399,7 @@ const startAttempt = (fn: () => void): AtlasSignInThunkAction<AttemptState> => {
         // noop for the promise created by `finally`, original promise rejection
         // should be handled by the service user
       });
-    setImmediate(function () {
-      fn();
-    });
+    setTimeout(fn);
     return attempt;
   };
 };

packages/compass-crud/src/components/editable-document.tsx

@@ -86,7 +86,7 @@ class EditableDocument extends React.Component<
       if (this.state.editing || this.state.deleting) {
         // If the underlying document changed, that means that the collection
         // contents have been refreshed. In that case, stop editing/deleting.
-        setImmediate(() => {
+        setTimeout(() => {
           this.setState({ editing: false, deleting: false });
         });
       }

packages/compass-crud/src/components/table-view/cell-editor.tsx

@@ -507,9 +507,9 @@ class CellEditor
   }
 
   onAddField(...args: Parameters<CellEditorProps['addColumn']>) {
-    // we have to setImmediate here otherwise there's an untraceable
+    // we have to setTimeout here otherwise there's an untraceable
     // setState on unmounted component error
-    setImmediate(() => {
+    setTimeout(() => {
       // we explicitly stop editing first to prevent breaking the UI
       this.props.api.stopEditing();
       this.props.addColumn(...args);

packages/compass-schema/src/stores/store.js

@@ -195,13 +195,6 @@ const configureStore = (options = {}) => {
 
     onSchemaSampled() {
       this.geoLayers = {};
-
-      process.nextTick(() => {
-        this.globalAppRegistry.emit('compass:schema:schema-sampled', {
-          ...this.state,
-          geo: this.geoLayers,
-        });
-      });
     },
 
     geoLayerAdded(field, layer) {

packages/compass-shell/src/plugin.spec.jsx

@@ -7,10 +7,9 @@ import { CompassShell } from './components/compass-shell';
 import createPlugin from './plugin';
 import CompassShellStore from './stores';
 
-function nextTick() {
-  return new Promise((resolve) => process.nextTick(resolve));
-}
-
+// Wait until a component is present that is rendered in a limited number
+// of microtask queue iterations. In particular, this does *not* wait for the
+// event loop itself to progress.
 async function waitForAsyncComponent(wrapper, Component, attempts = 10) {
   let current = 0;
   let result;
@@ -21,7 +20,7 @@ async function waitForAsyncComponent(wrapper, Component, attempts = 10) {
     if (result.length > 0) {
       return result;
     }
-    await nextTick();
+    await Promise.resolve(); // wait a microtask queue iteration
   }
   return result;
 }

packages/compass/src/main/window-manager.ts

@@ -296,7 +296,7 @@ function trackWindowEvents(electronApp: App) {
 
     // causes focus to be emitted after blur, allowing us to track
     // when the focus moves from a Compass window to the other
-    setImmediate(() => {
+    setTimeout(() => {
       const focusAt = windowFocusedAt.get(win.webContents.id);
       const movedToOtherCompassWin = windowFocusedAt.size === 2;
       windowFocusedAt.delete(win.webContents.id);

packages/ssh-tunnel/src/index.ts

@@ -90,7 +90,7 @@ export class SshTunnel extends EventEmitter {
               this.rawConfig.socks5Username === user &&
               this.rawConfig.socks5Password === pass;
             debug('validating auth parameters', success);
-            process.nextTick(cb, success);
+            queueMicrotask(() => cb(success));
           }
         )
       );