Cache full ZMQ check promise, not just the result of the import (#12610)

IanMatthewHuff · Ian Huff · web-flow · commit 08b8e5c8a2cb · 2020-06-29T08:33:10.000-07:00
* save ZMQ support check in a promise to prevent race condition

* remove old comment

Co-authored-by: Ian Huff &lt;ianhuff@BE-ADINAB-SB2.europe.corp.microsoft.com&gt;
diff --git a/news/2 Fixes/12585.md b/news/2 Fixes/12585.md
@@ -0,0 +1 @@
+Correctly check for ZMQ support, previously it could allow ZMQ to be supported when zmq could not be imported.
diff --git a/src/client/datascience/raw-kernel/rawNotebookSupportedService.ts b/src/client/datascience/raw-kernel/rawNotebookSupportedService.ts
@@ -13,7 +13,7 @@ import { IRawNotebookSupportedService } from '../types';
 @injectable()
 export class RawNotebookSupportedService implements IRawNotebookSupportedService {
     // Keep track of our ZMQ import check, this doesn't change with settings so we only want to do this once
-    private _zmqSupported: boolean | undefined;
+    private _zmqSupportedPromise: Promise<boolean> | undefined;
 
     constructor(
         @inject(IConfigurationService) private readonly configuration: IConfigurationService,
@@ -48,21 +48,24 @@ export class RawNotebookSupportedService implements IRawNotebookSupportedService
 
     // Check to see if this machine supports our local ZMQ launching
     private async zmqSupported(): Promise<boolean> {
-        if (this._zmqSupported !== undefined) {
-            return this._zmqSupported;
+        if (!this._zmqSupportedPromise) {
+            this._zmqSupportedPromise = this.zmqSupportedImpl();
         }
 
+        return this._zmqSupportedPromise;
+    }
+
+    private async zmqSupportedImpl(): Promise<boolean> {
         try {
             await import('zeromq');
             traceInfo(`ZMQ install verified.`);
             sendTelemetryEvent(Telemetry.ZMQSupported);
-            this._zmqSupported = true;
         } catch (e) {
             traceError(`Exception while attempting zmq :`, e);
             sendTelemetryEvent(Telemetry.ZMQNotSupported);
-            this._zmqSupported = false;
+            return false;
         }
 
-        return this._zmqSupported;
+        return true;
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+Correctly check for ZMQ support, previously it could allow ZMQ to be supported when zmq could not be imported.`