Merge pull request #23 from unverbraucht/ftp-set-timeout

Allow to set FTP timeout through options.

Author: SamKirkland

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@samkirkland/ftp-deploy",
-  "version": "1.2.1",
+  "version": "1.2.2",
   "private": false,
   "description": "Deploy files to a ftp server",
   "main": "dist/module.js",

package.json

@@ -125,7 +125,7 @@ export async function deploy(args: IFtpDeployArgumentsWithDefaults, logger: ILog
 
     createLocalState(localFiles, logger, args);
 
-    const client = new ftp.Client();
+    const client = new ftp.Client(args.timeout);
 
     global.reconnect = async function () {
         timings.start("connecting");

src/deploy.ts

@@ -1,5 +1,5 @@
 import { HashDiff } from "./HashDiff";
-import { IFileList, currentSyncFileVersion, IFile } from "./types";
+import { IFileList, currentSyncFileVersion, IFile, IFtpDeployArgumentsWithDefaults } from "./types";
 import { Record } from "./types";
 import { applyExcludeFilter, getDefaultSettings, ILogger, Timings } from "./utilities";
 import path from "path";
@@ -589,6 +589,7 @@ describe("getLocalFiles", () => {
             exclude: [],
             "log-level": "standard",
             security: "loose",
+            timeout: 30000,
         });
 
         const mainYamlDiff = localDirDiffs.data.find(diff => diff.name === "workflows/main.yml")! as IFile;
@@ -703,6 +704,69 @@ describe("getLocalFiles", () => {
     });
 });
 
+
+describe("getDefaultSettings", () => {
+    test("path validation", async () => {
+        expect(() => getDefaultSettings({
+            server: "a",
+            username: "b",
+            password: "c",
+            "local-dir": "noEndingSlash"
+        })).toThrowError("local-dir should be a folder (must end with /)");
+
+        expect(() => getDefaultSettings({
+            server: "a",
+            username: "b",
+            password: "c",
+            "server-dir": "noEndingSlash"
+        })).toThrowError("server-dir should be a folder (must end with /)");
+    });
+
+    test("verify default settings", async () => {
+        expect(getDefaultSettings({
+            server: "a",
+            username: "b",
+            password: "c",
+        })).toEqual({
+            server: "a",
+            username: "b",
+            password: "c",
+            port: 21,
+            protocol: "ftp",
+            "local-dir": "./",
+            "server-dir": "./",
+            "state-name": ".ftp-deploy-sync-state.json",
+            "dry-run": false,
+            "dangerous-clean-slate": false,
+            exclude: excludeDefaults,
+            "log-level": "standard",
+            security: "loose",
+            timeout: 30000
+        });
+    });
+
+    test("verify default settings override", async () => {
+        const customSettings: IFtpDeployArgumentsWithDefaults = {
+            server: "a",
+            username: "b",
+            password: "c",
+            port: 54321,
+            protocol: "ftps-legacy",
+            "local-dir": "./client/",
+            "server-dir": "./server/",
+            "state-name": ".customState.json",
+            "dry-run": true,
+            "dangerous-clean-slate": true,
+            exclude: [],
+            "log-level": "verbose",
+            security: "strict",
+            timeout: 1234
+        };
+
+        expect(getDefaultSettings(customSettings)).toEqual(customSettings);
+    });
+});
+
 describe("error handling", () => {
     test("throws on error", async () => {
         const mockedLogger = new MockedLogger();

src/main.test.ts

@@ -57,10 +57,16 @@ export interface IFtpDeployArguments {
      * When using protocol "ftps" or "ftps-legacy" should the cert name need to match exactly?
      * Set this to "strict" to ensure your data is being encrypted
      * 
-     * Defautls to loose because of the sheer volume of shared hosts that give ftp domains a cert without a matching common name
+     * Defaults to loose because of the sheer volume of shared hosts that give ftp domains a cert without a matching common name
      * @default "loose"
      */
     security?: "strict" | "loose";
+
+    /**
+     * Timeout in milliseconds for FTP operations as handled by underlying basic-ftp connection library.
+     * @default 30000 (30 seconds)
+     */
+    timeout?: number;
 }
 
 export interface IFtpDeployArgumentsWithDefaults {
@@ -77,6 +83,7 @@ export interface IFtpDeployArgumentsWithDefaults {
     exclude: string[];
     "log-level": "minimal" | "standard" | "verbose";
     security: "strict" | "loose";
+    timeout: number;
 }
 
 export interface IFile {

src/types.ts

@@ -188,6 +188,7 @@ export function getDefaultSettings(withoutDefaults: IFtpDeployArguments): IFtpDe
         "exclude": withoutDefaults.exclude ?? excludeDefaults,
         "log-level": withoutDefaults["log-level"] ?? "standard",
         "security": withoutDefaults.security ?? "loose",
+        "timeout": withoutDefaults.timeout ?? 30000,
     };
 }