server listen is async, so it isn't bound yet. fix tests

snowflakedb · Feb 11, 2025 · 315e534 · 315e534
1 parent 30c7f76
commit 315e534
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 6 deletions.
diff --git a/lib/authentication/auth_web.js b/lib/authentication/auth_web.js
@@ -55,6 +55,24 @@ function AuthWeb(connectionConfig, httpClient, webbrowser) {
     body['data']['AUTHENTICATOR'] = 'EXTERNALBROWSER';
   };
 
+  /**
+   * net's server.listen is async, so it isn't ready until after the 'listening' event is emitted
+   * @param {*} server 
+   * @param {*} port 
+   * @param {*} host 
+   * @returns 
+   */
+  function listenAsync(server, port, host) {  
+    return new Promise((resolve, reject) => {
+      // When custom parameters are not provided, the port will be set to 0.
+      // That means it will use a random port and fallback to localhost
+      server.listen(port, host);
+
+      server.on('listening', () => resolve(server.address()));
+      server.on('error', reject);
+    });
+  }
+
   /**
    * Obtain SAML token through SSO URL.
    *
@@ -77,9 +95,8 @@ function AuthWeb(connectionConfig, httpClient, webbrowser) {
     });
 
     try {
-      // When custom parameters are not provided, localServerPort and localServerHost will both be 0
-      // That means it will use a random port and fallback to localhost
-      server.listen(URLUtil.parseAddress(samlRedirectUri));
+      const address = URLUtil.parseAddress(samlRedirectUri);
+      await listenAsync(server, address.port, address.host);
     } catch (err) {
       throw new Error(util.format('Error while creating server, samlRedirectUri likely incorrect: %s', err));
     }

diff --git a/test/unit/authentication/authentication_test.js b/test/unit/authentication/authentication_test.js
@@ -123,7 +123,7 @@ describe('external browser authentication', function () {
     getAuthenticator: () => credentials.authenticator,
     getServiceName: () => '',
     getDisableConsoleLogin: () => true,
-    getSamlRedirectUri: () => 'localhost:0',
+    getSamlRedirectUri: () => credentials.samlRedirectUri,
     host: 'fakehost'
   };
 
@@ -211,6 +211,7 @@ describe('external browser authentication', function () {
       getAuthenticator: () => credentials.authenticator,
       getServiceName: () => '',
       getDisableConsoleLogin: () => true,
+      getSamlRedirectUri: () => credentials.samlRedirectUri,
       host: 'fakehost'
     };
 
@@ -688,6 +689,7 @@ describe('okta authentication', function () {
           getClientStoreTemporaryCredential: () => true,
           getPasscode: () => '',
           getPasscodeInPassword: () => false,
+          getSamlRedirectUri: () => '127.0.0.1:8080',
           idToken: idToken || null,
           host: 'host',
         };

diff --git a/test/unit/mock/mock_test_util.js b/test/unit/mock/mock_test_util.js
@@ -105,7 +105,8 @@ const connectionOptionsExternalBrowser =
   accessUrl: 'http://fakeaccount.snowflakecomputing.com',
   username: 'fakeusername',
   account: 'fakeaccount',
-  authenticator: 'EXTERNALBROWSER'
+  authenticator: 'EXTERNALBROWSER',
+  samlRedirectUri: 'localhost:3000'
 };
 
 const connectionOptionsidToken =
@@ -165,7 +166,8 @@ const connectionOptionsOkta =
   getTimeout: () => 90,
   getRetryTimeout: () => 300,
   getRetrySfMaxLoginRetries: () => 7,
-  getDisableSamlURLCheck: () => false
+  getDisableSamlURLCheck: () => false,
+  getSamlRedirectUri: () => 'localhost:3000'
 };
 
 exports.connectionOptions =