fix: Allow the user to specify the timeout (Fixes #298)

pact-foundation · Jun 21, 2021 · 4c77ddb · 4c77ddb
1 parent a5c934a
commit 4c77ddb
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -189,6 +189,7 @@ var server = pact.createServer({
 | `pactFileWriteMode` | false     | `overwrite` OR `update` OR `merge` | Control how the pact file is created. Defaults to "overwrite"                                                                        |
 | `format`            | false     | `json` OR `xml`                    | Format to write the results as, either in JSON or XML, defaults to JSON                                                              |
 | `out`               | false     | string                             | Write output to a file instead of returning it in the promise, defaults to none                                                      |
+| `timeout`               | false     | number                             | How long to wait for the mock server to start up (in milliseconds). Defaults to 30000 (30 seconds)                                                      |
 
 #### List Mock Servers
 
@@ -418,6 +419,8 @@ var server = pact.createStub({
 | sslcert   | false     | string  | Path to a custom self-signed SSL cert file, 'ssl' option must be set to true to use this option. Defaults false                      | to none |
 | sslkey    | false     | string  | Path a custom key and self-signed SSL cert key file, 'ssl' option must be set to true to use this option false. Defaults to none     |
 | cors      | false     | boolean | Allow CORS OPTION requests to be accepted, defaults to 'false'                                                                       |
+| timeout               | false     | number                             | How long to wait for the stub server to start up (in milliseconds). Defaults to 30000 (30 seconds)                                                      |
+
 
 ### Message Pacts
 

diff --git a/src/server.ts b/src/server.ts
@@ -104,5 +104,6 @@ export interface ServerOptions {
   provider?: string;
   monkeypatch?: string;
   logLevel?: LogLevel;
+  timeout?: number;
   pactFileWriteMode?: 'overwrite' | 'update' | 'merge';
 }
diff --git a/src/service.ts b/src/service.ts
@@ -12,9 +12,13 @@ import checkTypes = require('check-types');
 // Get a reference to the global setTimeout object in case it is mocked by a testing library later
 const setTimeout = global.setTimeout;
 
-const CHECKTIME = 500;
 const RETRY_AMOUNT = 60;
-const PROCESS_TIMEOUT = 30000;
+
+const getTimeout = (options: ServiceOptions): number =>
+  options.timeout || 30000;
+
+const getRetryTickTime = (options: ServiceOptions): number =>
+  Math.round(getTimeout(options) / RETRY_AMOUNT);
 
 interface AbstractServiceEventInterface {
   START_EVENT: string;
@@ -73,7 +77,7 @@ export abstract class AbstractService extends events.EventEmitter {
       checkTypes.assert.number(options.port);
       checkTypes.assert.integer(options.port);
       checkTypes.assert.positive(options.port);
-      checkTypes.assert.inRange(options.port, 0, 65535);
+      checkTypes.inRange(options.port, 0, 65535);
 
       if (checkTypes.not.inRange(options.port, 1024, 49151)) {
         logger.warn(
@@ -180,7 +184,7 @@ export abstract class AbstractService extends events.EventEmitter {
     );
 
     // check service is available
-    return timeout(this.__waitForServiceUp(), PROCESS_TIMEOUT)
+    return timeout(this.__waitForServiceUp(), getTimeout(this.options))
       .then(() => {
         this.__running = true;
         this.emit(AbstractService.Events.START_EVENT, this);
@@ -205,7 +209,7 @@ export abstract class AbstractService extends events.EventEmitter {
       Promise.resolve(this.__instance)
         .then(spawn.killBinary)
         .then(() => this.__waitForServiceDown()),
-      PROCESS_TIMEOUT
+      getTimeout(this.options)
     )
       .catch((err: Error) => {
         if (err instanceof TimeoutError) {
@@ -252,7 +256,7 @@ export abstract class AbstractService extends events.EventEmitter {
           );
         }
         // eslint-disable-next-line @typescript-eslint/no-use-before-define
-        setTimeout(check.bind(this), CHECKTIME);
+        setTimeout(check.bind(this), getRetryTickTime(this.options));
       };
 
       const check = (): void => {
@@ -286,7 +290,7 @@ export abstract class AbstractService extends events.EventEmitter {
                 );
                 return;
               }
-              setTimeout(check, CHECKTIME);
+              setTimeout(check, getRetryTickTime(this.options));
             },
             () => resolve()
           );
@@ -337,6 +341,7 @@ export interface ServiceOptions {
   sslkey?: string;
   log?: string;
   logLevel?: LogLevel;
+  timeout?: number;
 }
 
 // This is the pact binary's log level, which is a subset of the log levels for pact-core

diff --git a/src/stub.ts b/src/stub.ts
@@ -45,4 +45,5 @@ export interface StubOptions {
   sslkey?: string;
   log?: string;
   logLevel?: LogLevel;
+  timeout?: number;
 }