chore/improve result analyz

Author: potapovDim

lib/exec.proc.ts

@@ -1,5 +1,5 @@
 /* eslint-disable sonarjs/cognitive-complexity */
-import { isFunction, isAsyncFunction, isNumber, millisecondsToMinutes } from 'sat-utils';
+import { isFunction, isAsyncFunction, isNumber, millisecondsToMinutes, isString, isBoolean } from 'sat-utils';
 import { internalLogProcessResult } from './logger.execution';
 import { execute } from './exec';
 import { logger } from './logger';
@@ -83,19 +83,30 @@ function buildExecRunner(notRetriable, runOpts) {
         if (isFunction(processResultAnalyzer)) {
           const countInNotRetriableBeforeAnalyzation = notRetriable.length;
 
-          const processResultAnalyzerResultCommandOrNull = processResultAnalyzer(
-            cmd,
-            executionHolder.stackTrace,
-            notRetriable,
-          );
+          const analyzationResult = processResultAnalyzer(cmd, executionHolder.stackTrace, notRetriable);
+
+          if (!isString(analyzationResult) && !isBoolean(analyzationResult)) {
+            logger.warn('processResultAnalyzer should return boolean or string');
+          }
+
+          // if analyzationResult is string - we want to re-execute command
+          if (isString(analyzationResult)) {
+            return resolve(analyzationResult);
+          }
+
+          // if analyzationResult is true - we make assumption that process was finished successfully
+          if (isBoolean(analyzationResult) && analyzationResult) {
+            return resolve(null);
+          }
 
           if (
-            !processResultAnalyzerResultCommandOrNull &&
-            countInNotRetriableBeforeAnalyzation === notRetriable.length
+            countInNotRetriableBeforeAnalyzation === notRetriable.length ||
+            (isBoolean(analyzationResult) && !analyzationResult)
           ) {
             notRetriable.push(cmd);
           }
-          return resolve(processResultAnalyzerResultCommandOrNull);
+
+          return resolve(null);
         }
 
         return resolve(cmd);

lib/index.ts

@@ -11,14 +11,14 @@ function reRunnerBuilder(runOptions) {
   return intime ? intimeExecutor.bind(this, executorOptions) : circleExecutor.bind(this, executorOptions);
 }
 
-type IBuildOpts = {
+export type TBuildOpts = {
   logLevel?: 'ERROR' | 'WARN' | 'INFO' | 'VERBOSE' | 'MUTE';
   maxThreads?: number;
   attemptsCount?: number;
   longestProcessTime?: number;
   successExitCode?: number;
   pollTime?: number;
-  processResultAnalyzer?: (originalCommand: string, stack: string, notRetriable: any[]) => string | null | void;
+  processResultAnalyzer?: (originalCommand: string, stack: string, notRetriable: any[]) => string | boolean;
   everyCycleCallback?: () => void;
   watcher?: () => void;
   currentExecutionVariable?: string;
@@ -32,7 +32,7 @@ type IBuildOpts = {
   onErrorProcess?: (execProc, error) => void;
 };
 
-type IRunner = {
+export type TRunner = {
   (commands: string[]): Promise<{ notRetriable: string[]; retriable: string[] }>;
 };
 
@@ -43,7 +43,7 @@ const getReruner = ({
   pollTime = 1000,
   successExitCode = 0,
   ...rest
-}: IBuildOpts = {}): IRunner => {
+}: TBuildOpts = {}): TRunner => {
   const reformattedArgs = {
     longestProcessTime,
     maxThreads,
@@ -56,6 +56,6 @@ const getReruner = ({
   return reRunnerBuilder(reformattedArgs);
 };
 
-export { getReruner, IBuildOpts, IRunner };
+export { getReruner };
 
 export { getFilesList } from './helpers';

package.json

@@ -1,6 +1,6 @@
 {
   "name": "process-rerun",
-  "version": "0.2.9",
+  "version": "0.3.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/potapovDim/protractor-rerun.git"

readme.md

@@ -25,7 +25,7 @@ arguments | description
 **`buildOpts.logLevel`** | Type: `string`, one of 'ERROR', 'WARN', 'INFO', 'VERBOSE', 'MUTE' <br> ERROR - only errors, WARN -  errors and warnings, INFO - errors, warnings and information, VERBOSE - full logging, MUTE - mute execution output <br> **Default is 'ERROR'**
 **`buildOpts.currentExecutionVariable`** | **Optional** Type: `string`, will be execution variable with execution index for every cycle will be ++<br>
 **`buildOpts.everyCycleCallback`** | **Optional** Type: `function`, <br> Optional. everyCycleCallback will be executed after cycle, before next execution cycle.<br> **Default is false**
-**`buildOpts.processResultAnalyzer`** | **Optional** Type: `function`, <br> Optional. processResultAnalyzer is a function where arguments are original command, execution stack trace and notRetriable array processResultAnalyzer should return a new command what will be executed in next cycle or **null** - if satisfactory result <br>
+**`buildOpts.processResultAnalyzer`** | **Optional** Type: `function`, <br> Optional. processResultAnalyzer is a function where arguments are original command, execution stack trace and notRetriable array processResultAnalyzer should return a new command what will be executed in next cycle or **boolean** - if satisfactory result <br>
 **`buildOpts.longestProcessTime`** | **Optional** Type: `number`, <br> In case if command execution time is longer than longest Process Time - executor will kill it automatically and will try to execute this command again. <br> **Default time is 45 seconds**
 
 ## Usage