Cleanup closehandler and add timeout for testSFTPAuthentication

Author: varadarajan-tw

packages/destination-actions/src/destinations/sftp/client.ts

@@ -1,4 +1,10 @@
-import { PayloadValidationError, RequestTimeoutError, Logger, IntegrationError } from '@segment/actions-core'
+import {
+  PayloadValidationError,
+  RequestTimeoutError,
+  Logger,
+  IntegrationError,
+  DEFAULT_REQUEST_TIMEOUT
+} from '@segment/actions-core'
 import path from 'path'
 import Client from 'ssh2-sftp-client'
 import { SFTP_DEFAULT_PORT } from './constants'
@@ -160,7 +166,18 @@ function normalizeSSHKey(key = ''): string {
  */
 async function testSFTPConnection(settings: Settings): Promise<unknown> {
   const sftp = new Client()
-  let res
+  const timeoutPromise = new Promise((_, reject) => {
+    setTimeout(() => {
+      reject(new RequestTimeoutError('SFTP connection timed out'))
+    }, DEFAULT_REQUEST_TIMEOUT)
+  })
+  // Throws if connection or listing fails
+  // Otherwise resolves with the list of files in the root directory
+  return Promise.race([timeoutPromise, connectAndList(sftp, settings)])
+}
+
+async function connectAndList(sftp: Client, settings: Settings): Promise<Client.FileInfo[]> {
+  let res: Client.FileInfo[]
   try {
     await sftp.connect(createConnectionConfig(settings))
     res = await sftp.list('/')

packages/destination-actions/src/destinations/sftp/sftp-wrapper.ts

@@ -105,26 +105,17 @@ export class SFTPWrapper {
           await Promise.all(writeRequests)
         }
 
-        const closeHandle = (): Promise<void> => {
-          return new Promise((closeResolve) => {
+        processWrites()
+          .then(resolve)
+          .catch(resolve)
+          .finally(() => {
+            // we don't care if close fails here because we expect the caller to call sftp.end() eventually
             this.client?.close(handle, (closeErr) => {
               if (closeErr) {
                 this.logger?.warn('Error closing remote file handle:', String(closeErr.message))
               }
-              closeResolve()
             })
           })
-        }
-
-        processWrites()
-          .then(async () => {
-            await closeHandle()
-            resolve()
-          })
-          .catch(async (err) => {
-            await closeHandle()
-            reject(err)
-          })
       })
     })
   }