Merge pull request #830 from sasjs/issue-829

fix(execute-script): fixed executing jobs on viya using compute api

.github/PULL_REQUEST_TEMPLATE.md

@@ -14,7 +14,7 @@ What code changes have been made to achieve the intent.
 
 No PR (that involves a non-trivial code change) should be merged, unless all items below are confirmed!  If an urgent fix is needed - use a tar file.
 
-
+- [ ] Unit tests coverage has been increased and a new threshold is set.
 - [ ] All `sasjs-cli` unit tests are passing (`npm test`).
 - (CI Runs this) All `sasjs-tests` are passing. If you want to run it manually (instructions available [here](https://github.com/sasjs/adapter/blob/master/sasjs-tests/README.md)).
 - [ ] [Data Controller](https://datacontroller.io) builds and is functional on both SAS 9 and Viya

.github/workflows/assign-reviewer.yml

@@ -10,4 +10,4 @@ jobs:
       - uses: actions/checkout@v2
       - uses: uesteibar/reviewer-lottery@v1
         with:
-          repo-token: ${{ secrets.GH_TOKEN }}
+          repo-token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/build.yml

@@ -80,6 +80,10 @@ jobs:
           npm run update:adapter
           pm2 start --name sasjs-test npm -- start
 
+      - name: Sleep for 10 seconds
+        run: sleep 10s
+        shell: bash
+
       - name: Run cypress on sasjs
         run: |
           replace-in-files --regex='"sasjsTestsUrl".*' --replacement='"sasjsTestsUrl":"http://localhost:3000",' ./cypress.json

.github/workflows/generateDocs.yml

@@ -37,8 +37,8 @@ jobs:
       - name: Push generated docs
         uses: peaceiris/actions-gh-pages@v3
         with:
-          github_token: ${{ secrets.GH_TOKEN }}
+          github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_branch: gh-pages
-          publish_dir: ./docs 
+          publish_dir: ./docs
           cname: adapter.sasjs.io
 

.github/workflows/npmpublish.yml

@@ -36,7 +36,7 @@ jobs:
       - name: Semantic Release
         uses: cycjimmy/semantic-release-action@v3
         env:
-          GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
 
       - name: Send Matrix message

README.md

@@ -155,7 +155,7 @@ The adapter will also cache the logs (if debug enabled) and even the work tables
 
 ### Verbose Mode
 
-Set `verbose` to `true` to enable verbose mode that logs a summary of every HTTP response. Verbose mode can be disabled by calling `disableVerboseMode` method or enabled by `enableVerboseMode` method. Verbose mode can also be enabled/disabled by `startComputeJob` method.
+Set `verbose` to `true` to enable verbose mode that logs a summary of every HTTP response. Verbose mode can be disabled by calling `disableVerboseMode` method or enabled by `enableVerboseMode` method. Verbose mode also supports `bleached` mode that disables extra colors in req/res summary. To enable `bleached` verbose mode, pass `verbose` equal to `bleached` while instantiating an instance of `RequestClient` or to `setVerboseMode` method. Verbose mode can also be enabled/disabled by `startComputeJob` method.
 
 ### Session Manager
 

jest.config.js

@@ -41,7 +41,14 @@ module.exports = {
   // ],
 
   // An object that configures minimum threshold enforcement for coverage results
-  // coverageThreshold: undefined,
+  coverageThreshold: {
+    global: {
+      statements: 63.61,
+      branches: 44.72,
+      functions: 53.94,
+      lines: 64.07
+    }
+  },
 
   // A path to a custom dependency extractor
   // dependencyExtractor: undefined,

src/SASViyaApiClient.ts

@@ -25,7 +25,7 @@ import { prefixMessage } from '@sasjs/utils/error'
 import { pollJobState } from './api/viya/pollJobState'
 import { getTokens } from './auth/getTokens'
 import { uploadTables } from './api/viya/uploadTables'
-import { executeScript } from './api/viya/executeScript'
+import { executeOnComputeApi } from './api/viya/executeOnComputeApi'
 import { getAccessTokenForViya } from './auth/getAccessTokenForViya'
 import { refreshTokensForViya } from './auth/refreshTokensForViya'
 
@@ -293,7 +293,7 @@ export class SASViyaApiClient {
     printPid = false,
     variables?: MacroVar
   ): Promise<any> {
-    return executeScript(
+    return executeOnComputeApi(
       this.requestClient,
       this.sessionManager,
       this.rootFolderName,

src/SASjs.ts

@@ -4,7 +4,12 @@ import {
   UploadFile,
   EditContextInput,
   PollOptions,
-  LoginMechanism
+  LoginMechanism,
+  VerboseMode,
+  ErrorResponse,
+  LoginOptions,
+  LoginResult,
+  ExecutionQuery
 } from './types'
 import { SASViyaApiClient } from './SASViyaApiClient'
 import { SAS9ApiClient } from './SAS9ApiClient'
@@ -29,9 +34,7 @@ import {
   Sas9JobExecutor,
   FileUploader
 } from './job-execution'
-import { ErrorResponse } from './types/errors'
+import { AxiosResponse, AxiosError } from 'axios'
-import { LoginOptions, LoginResult } from './types/Login'
-import { AxiosResponse } from 'axios'
 
 interface ExecuteScriptParams {
   linesOfCode: string[]
@@ -158,6 +161,23 @@ export default class SASjs {
     }
   }
 
+  /**
+   * Executes job on SASJS server.
+   * @param query - an object containing job path and debug level.
+   * @param appLoc - an application path.
+   * @param authConfig - an object for authentication.
+   * @returns a promise that resolves into job execution result and log.
+   */
+  public async executeJob(
+    query: ExecutionQuery,
+    appLoc: string,
+    authConfig?: AuthConfig
+  ) {
+    this.isMethodSupported('executeScript', [ServerType.Sasjs])
+
+    return await this.sasJSApiClient?.executeJob(query, appLoc, authConfig)
+  }
+
   /**
    * Gets compute contexts.
    * @param accessToken - an access token for an authorised user.
@@ -855,7 +875,7 @@ export default class SASjs {
    * @param pollOptions - an object that represents poll interval(milliseconds) and maximum amount of attempts. Object example: { maxPollCount: 24 * 60 * 60, pollInterval: 1000 }. More information available at src/api/viya/pollJobState.ts.
    * @param printPid - a boolean that indicates whether the function should print (PID) of the started job.
    * @param variables - an object that represents macro variables.
-   * @param verboseMode - boolean to enable verbose mode (log every HTTP response).
+   * @param verboseMode - boolean or a string equal to 'bleached' to enable verbose mode (log every HTTP response).
    */
   public async startComputeJob(
     sasJob: string,
@@ -866,7 +886,7 @@ export default class SASjs {
     pollOptions?: PollOptions,
     printPid = false,
     variables?: MacroVar,
-    verboseMode?: boolean
+    verboseMode?: VerboseMode
   ) {
     config = {
       ...this.sasjsConfig,
@@ -880,8 +900,10 @@ export default class SASjs {
       )
     }
 
-    if (verboseMode) this.requestClient?.enableVerboseMode()
+    if (verboseMode) {
-    else if (verboseMode === false) this.requestClient?.disableVerboseMode()
+      this.requestClient?.setVerboseMode(verboseMode)
+      this.requestClient?.enableVerboseMode()
+    } else if (verboseMode === false) this.requestClient?.disableVerboseMode()
 
     return this.sasViyaApiClient?.executeComputeJob(
       sasJob,
@@ -1148,8 +1170,8 @@ export default class SASjs {
    * @param errorCallBack - function that should be triggered on every HTTP response with the status different from 2**.
    */
   public enableVerboseMode(
-    successCallBack?: (response: AxiosResponse) => AxiosResponse,
+    successCallBack?: (response: AxiosResponse | AxiosError) => AxiosResponse,
-    errorCallBack?: (response: AxiosResponse) => AxiosResponse
+    errorCallBack?: (response: AxiosResponse | AxiosError) => AxiosResponse
   ) {
     this.requestClient?.enableVerboseMode(successCallBack, errorCallBack)
   }
@@ -1160,4 +1182,12 @@ export default class SASjs {
   public disableVerboseMode() {
     this.requestClient?.disableVerboseMode()
   }
+
+  /**
+   * Sets verbose mode.
+   * @param verboseMode - value of the verbose mode, can be true, false or bleached(without extra colors).
+   */
+  public setVerboseMode = (verboseMode: VerboseMode) => {
+    this.requestClient?.setVerboseMode(verboseMode)
+  }
 }

src/api/viya/executeOnComputeApi.ts

@@ -15,8 +15,12 @@ import { formatDataForRequest } from '../../utils/formatDataForRequest'
 import { pollJobState, JobState } from './pollJobState'
 import { uploadTables } from './uploadTables'
 
+interface JobRequestBody {
+  [key: string]: number | string | string[]
+}
+
 /**
- * Executes code on the current SAS Viya server.
+ * Executes SAS program on the current SAS Viya server using Compute API.
  * @param jobPath - the path to the file being submitted for execution.
  * @param linesOfCode - an array of code lines to execute.
  * @param contextName - the context to execute the code in.
@@ -29,7 +33,7 @@ import { uploadTables } from './uploadTables'
  * @param printPid - a boolean that indicates whether the function should print (PID) of the started job.
  * @param variables - an object that represents macro variables.
  */
-export async function executeScript(
+export async function executeOnComputeApi(
   requestClient: RequestClient,
   sessionManager: SessionManager,
   rootFolderName: string,
@@ -46,6 +50,7 @@ export async function executeScript(
   variables?: MacroVar
 ): Promise<any> {
   let access_token = (authConfig || {}).access_token
+
   if (authConfig) {
     ;({ access_token } = await getTokens(requestClient, authConfig))
   }
@@ -78,27 +83,13 @@ export async function executeScript(
         const logger = process.logger || console
 
         logger.info(
-          `Triggered '${relativeJobPath}' with PID ${
+          `Triggering '${relativeJobPath}' with PID ${
             jobIdVariable.value
           } at ${timestampToYYYYMMDDHHMMSS()}`
         )
       }
     }
 
-    const jobArguments: { [key: string]: any } = {
-      _contextName: contextName,
-      _OMITJSONLISTING: true,
-      _OMITJSONLOG: true,
-      _OMITSESSIONRESULTS: true,
-      _OMITTEXTLISTING: true,
-      _OMITTEXTLOG: true
-    }
-
-    if (debug) {
-      jobArguments['_OMITTEXTLOG'] = false
-      jobArguments['_OMITSESSIONRESULTS'] = false
-    }
-
     let fileName
 
     if (isRelativePath(jobPath)) {
@@ -107,6 +98,7 @@ export async function executeScript(
       }`
     } else {
       const jobPathParts = jobPath.split('/')
+
       fileName = jobPathParts.pop()
     }
 
@@ -118,7 +110,6 @@ export async function executeScript(
     }
 
     if (variables) jobVariables = { ...jobVariables, ...variables }
-
     if (debug) jobVariables = { ...jobVariables, _DEBUG: 131 }
 
     let files: any[] = []
@@ -145,12 +136,12 @@ export async function executeScript(
     }
 
     // Execute job in session
-    const jobRequestBody = {
+    const jobRequestBody: JobRequestBody = {
-      name: fileName,
+      name: fileName || 'Default Job Name',
       description: 'Powered by SASjs',
       code: linesOfCode,
       variables: jobVariables,
-      arguments: jobArguments
+      version: 2
     }
 
     const { result: postedJob, etag } = await requestClient
@@ -279,7 +270,7 @@ export async function executeScript(
     const error = e as HttpError
 
     if (error.status === 404) {
-      return executeScript(
+      return executeOnComputeApi(
         requestClient,
         sessionManager,
         rootFolderName,

src/api/viya/spec/executeScript.spec.ts

@@ -1,6 +1,6 @@
 import { RequestClient } from '../../../request/RequestClient'
 import { SessionManager } from '../../../SessionManager'
-import { executeScript } from '../executeScript'
+import { executeOnComputeApi } from '../executeOnComputeApi'
 import { mockSession, mockAuthConfig, mockJob } from './mockResponses'
 import * as pollJobStateModule from '../pollJobState'
 import * as uploadTablesModule from '../uploadTables'
@@ -25,7 +25,7 @@ describe('executeScript', () => {
   })
 
   it('should not try to get fresh tokens if an authConfig is not provided', async () => {
-    await executeScript(
+    await executeOnComputeApi(
       requestClient,
       sessionManager,
       'test',
@@ -38,7 +38,7 @@ describe('executeScript', () => {
   })
 
   it('should try to get fresh tokens if an authConfig is provided', async () => {
-    await executeScript(
+    await executeOnComputeApi(
       requestClient,
       sessionManager,
       'test',
@@ -55,7 +55,7 @@ describe('executeScript', () => {
   })
 
   it('should get a session from the session manager before executing', async () => {
-    await executeScript(
+    await executeOnComputeApi(
       requestClient,
       sessionManager,
       'test',
@@ -72,7 +72,7 @@ describe('executeScript', () => {
       .spyOn(sessionManager, 'getSession')
       .mockImplementation(() => Promise.reject('Test Error'))
 
-    const error = await executeScript(
+    const error = await executeOnComputeApi(
       requestClient,
       sessionManager,
       'test',
@@ -85,7 +85,7 @@ describe('executeScript', () => {
   })
 
   it('should fetch the PID when printPid is true', async () => {
-    await executeScript(
+    await executeOnComputeApi(
       requestClient,
       sessionManager,
       'test',
@@ -113,7 +113,7 @@ describe('executeScript', () => {
       .spyOn(sessionManager, 'getVariable')
       .mockImplementation(() => Promise.reject('Test Error'))
 
-    const error = await executeScript(
+    const error = await executeOnComputeApi(
       requestClient,
       sessionManager,
       'test',
@@ -139,7 +139,7 @@ describe('executeScript', () => {
         Promise.resolve([{ tableName: 'test', file: { id: 1 } }])
       )
 
-    await executeScript(
+    await executeOnComputeApi(
       requestClient,
       sessionManager,
       'test',
@@ -163,7 +163,7 @@ describe('executeScript', () => {
   })
 
   it('should format data as CSV when it does not contain semicolons', async () => {
-    await executeScript(
+    await executeOnComputeApi(
       requestClient,
       sessionManager,
       'test',
@@ -189,7 +189,7 @@ describe('executeScript', () => {
       .spyOn(formatDataModule, 'formatDataForRequest')
       .mockImplementation(() => ({ sasjs_tables: 'foo', sasjs0data: 'bar' }))
 
-    await executeScript(
+    await executeOnComputeApi(
       requestClient,
       sessionManager,
       'test',
@@ -217,14 +217,7 @@ describe('executeScript', () => {
           sasjs_tables: 'foo',
           sasjs0data: 'bar'
         },
-        arguments: {
+        version: 2
-          _contextName: 'test context',
-          _OMITJSONLISTING: true,
-          _OMITJSONLOG: true,
-          _OMITSESSIONRESULTS: true,
-          _OMITTEXTLISTING: true,
-          _OMITTEXTLOG: true
-        }
       },
       mockAuthConfig.access_token
     )
@@ -235,7 +228,7 @@ describe('executeScript', () => {
       .spyOn(formatDataModule, 'formatDataForRequest')
       .mockImplementation(() => ({ sasjs_tables: 'foo', sasjs0data: 'bar' }))
 
-    await executeScript(
+    await executeOnComputeApi(
       requestClient,
       sessionManager,
       'test',
@@ -264,14 +257,7 @@ describe('executeScript', () => {
           sasjs0data: 'bar',
           _DEBUG: 131
         },
-        arguments: {
+        version: 2
-          _contextName: 'test context',
-          _OMITJSONLISTING: true,
-          _OMITJSONLOG: true,
-          _OMITSESSIONRESULTS: false,
-          _OMITTEXTLISTING: true,
-          _OMITTEXTLOG: false
-        }
       },
       mockAuthConfig.access_token
     )
@@ -282,7 +268,7 @@ describe('executeScript', () => {
       .spyOn(requestClient, 'post')
       .mockImplementation(() => Promise.reject('Test Error'))
 
-    const error = await executeScript(
+    const error = await executeOnComputeApi(
       requestClient,
       sessionManager,
       'test',
@@ -302,7 +288,7 @@ describe('executeScript', () => {
   })
 
   it('should immediately return the session when waitForResult is false', async () => {
-    const result = await executeScript(
+    const result = await executeOnComputeApi(
       requestClient,
       sessionManager,
       'test',
@@ -322,7 +308,7 @@ describe('executeScript', () => {
   })
 
   it('should poll for job completion when waitForResult is true', async () => {
-    await executeScript(
+    await executeOnComputeApi(
       requestClient,
       sessionManager,
       'test',
@@ -352,7 +338,7 @@ describe('executeScript', () => {
       .spyOn(pollJobStateModule, 'pollJobState')
       .mockImplementation(() => Promise.reject('Poll Error'))
 
-    const error = await executeScript(
+    const error = await executeOnComputeApi(
       requestClient,
       sessionManager,
       'test',
@@ -378,7 +364,7 @@ describe('executeScript', () => {
         Promise.reject({ response: { data: 'err=5113,' } })
       )
 
-    const error = await executeScript(
+    const error = await executeOnComputeApi(
       requestClient,
       sessionManager,
       'test',
@@ -404,7 +390,7 @@ describe('executeScript', () => {
   })
 
   it('should fetch the logs for the job if debug is true and a log URL is available', async () => {
-    await executeScript(
+    await executeOnComputeApi(
       requestClient,
       sessionManager,
       'test',
@@ -429,7 +415,7 @@ describe('executeScript', () => {
   })
 
   it('should not fetch the logs for the job if debug is false', async () => {
-    await executeScript(
+    await executeOnComputeApi(
       requestClient,
       sessionManager,
       'test',
@@ -455,7 +441,7 @@ describe('executeScript', () => {
         Promise.resolve(pollJobStateModule.JobState.Failed)
       )
 
-    const error: ComputeJobExecutionError = await executeScript(
+    const error: ComputeJobExecutionError = await executeOnComputeApi(
       requestClient,
       sessionManager,
       'test',
@@ -490,7 +476,7 @@ describe('executeScript', () => {
         Promise.resolve(pollJobStateModule.JobState.Error)
       )
 
-    const error: ComputeJobExecutionError = await executeScript(
+    const error: ComputeJobExecutionError = await executeOnComputeApi(
       requestClient,
       sessionManager,
       'test',
@@ -519,7 +505,7 @@ describe('executeScript', () => {
   })
 
   it('should fetch the result if expectWebout is true', async () => {
-    await executeScript(
+    await executeOnComputeApi(
       requestClient,
       sessionManager,
       'test',
@@ -550,7 +536,7 @@ describe('executeScript', () => {
       return Promise.resolve({ result: mockJob, etag: '', status: 200 })
     })
 
-    const error = await executeScript(
+    const error = await executeOnComputeApi(
       requestClient,
       sessionManager,
       'test',
@@ -584,7 +570,7 @@ describe('executeScript', () => {
   })
 
   it('should clear the session after execution is complete', async () => {
-    await executeScript(
+    await executeOnComputeApi(
       requestClient,
       sessionManager,
       'test',
@@ -611,7 +597,7 @@ describe('executeScript', () => {
       .spyOn(sessionManager, 'clearSession')
       .mockImplementation(() => Promise.reject('Clear Session Error'))
 
-    const error = await executeScript(
+    const error = await executeOnComputeApi(
       requestClient,
       sessionManager,
       'test',

src/api/viya/spec/pollJobState.spec.ts

@@ -276,6 +276,76 @@ describe('pollJobState', () => {
     expect(delays).toEqual([pollIntervals[0], ...pollIntervals])
   })
 
+  it('should change default poll strategies after completing provided poll options', async () => {
+    const delays: number[] = []
+
+    jest.spyOn(delayModule, 'delay').mockImplementation((ms: number) => {
+      delays.push(ms)
+
+      return Promise.resolve()
+    })
+
+    const customPollOptions: PollOptions = {
+      maxPollCount: 0,
+      pollInterval: 0
+    }
+
+    const requests = [
+      { maxPollCount: 202, pollInterval: 300 },
+      { maxPollCount: 300, pollInterval: 3000 },
+      { maxPollCount: 500, pollInterval: 30000 },
+      { maxPollCount: 3400, pollInterval: 60000 }
+    ]
+
+    // ~200 requests with delay 300ms
+    let request = requests.splice(0, 1)[0]
+    let { maxPollCount, pollInterval } = request
+
+    // should be only one interval because maxPollCount is equal to 0
+    const pollIntervals = [customPollOptions.pollInterval]
+
+    pollIntervals.push(...Array(maxPollCount - 2).fill(pollInterval))
+
+    // ~300 requests with delay 3000
+    request = requests.splice(0, 1)[0]
+    let newAmount = request.maxPollCount
+    pollInterval = request.pollInterval
+
+    pollIntervals.push(...Array(newAmount - maxPollCount).fill(pollInterval))
+    pollIntervals.push(...Array(2).fill(pollInterval))
+
+    // ~500 requests with delay 30000
+    request = requests.splice(0, 1)[0]
+
+    let oldAmount = newAmount
+    newAmount = request.maxPollCount
+    pollInterval = request.pollInterval
+
+    pollIntervals.push(...Array(newAmount - oldAmount - 2).fill(pollInterval))
+    pollIntervals.push(...Array(2).fill(pollInterval))
+
+    // ~3400 requests with delay 60000
+    request = requests.splice(0, 1)[0]
+
+    oldAmount = newAmount
+    newAmount = request.maxPollCount
+    pollInterval = request.pollInterval
+
+    mockSimplePoll(newAmount)
+
+    pollIntervals.push(...Array(newAmount - oldAmount - 2).fill(pollInterval))
+
+    await pollJobState(
+      requestClient,
+      mockJob,
+      false,
+      undefined,
+      customPollOptions
+    )
+
+    expect(delays).toEqual(pollIntervals)
+  })
+
   it('should throw an error if not valid poll strategies provided', async () => {
     // INFO: 'maxPollCount' has to be > 0
     let invalidPollStrategy = {

src/request/RequestClient.ts

@@ -1,4 +1,10 @@
-import { AxiosInstance, AxiosRequestConfig, AxiosResponse } from 'axios'
+import {
+  AxiosError,
+  AxiosInstance,
+  AxiosRequestConfig,
+  AxiosResponse
+} from 'axios'
+import axios from 'axios'
 import * as https from 'https'
 import { CsrfToken } from '..'
 import { isAuthorizeFormRequired, isLogInRequired } from '../auth'
@@ -10,7 +16,7 @@ import {
   JobExecutionError,
   CertificateError
 } from '../types/errors'
-import { SASjsRequest } from '../types'
+import { SASjsRequest, HttpClient, VerboseMode } from '../types'
 import { parseWeboutResponse } from '../utils/parseWeboutResponse'
 import { prefixMessage } from '@sasjs/utils/error'
 import { SAS9AuthError } from '../types/errors/SAS9AuthError'
@@ -22,45 +28,11 @@ import {
 import { InvalidSASjsCsrfError } from '../types/errors/InvalidSASjsCsrfError'
 import { inspect } from 'util'
 
-export interface HttpClient {
-  get<T>(
-    url: string,
-    accessToken: string | undefined,
-    contentType: string,
-    overrideHeaders: { [key: string]: string | number }
-  ): Promise<{ result: T; etag: string }>
-
-  post<T>(
-    url: string,
-    data: any,
-    accessToken: string | undefined,
-    contentType: string,
-    overrideHeaders: { [key: string]: string | number }
-  ): Promise<{ result: T; etag: string }>
-
-  put<T>(
-    url: string,
-    data: any,
-    accessToken: string | undefined,
-    overrideHeaders: { [key: string]: string | number }
-  ): Promise<{ result: T; etag: string }>
-
-  delete<T>(
-    url: string,
-    accessToken: string | undefined
-  ): Promise<{ result: T; etag: string }>
-
-  getCsrfToken(type: 'general' | 'file'): CsrfToken | undefined
-  saveLocalStorageToken(accessToken: string, refreshToken: string): void
-  clearCsrfTokens(): void
-  clearLocalStorageTokens(): void
-  getBaseUrl(): string
-}
-
 export class RequestClient implements HttpClient {
   private requests: SASjsRequest[] = []
   private requestsLimit: number = 10
   private httpInterceptor?: number
+  private verboseMode: VerboseMode = false
 
   protected csrfToken: CsrfToken = { headerName: '', value: '' }
   protected fileUploadCsrfToken: CsrfToken | undefined
@@ -70,13 +42,16 @@ export class RequestClient implements HttpClient {
     protected baseUrl: string,
     httpsAgentOptions?: https.AgentOptions,
     requestsLimit?: number,
-    verboseMode?: boolean
+    verboseMode?: VerboseMode
   ) {
     this.createHttpClient(baseUrl, httpsAgentOptions)
 
     if (requestsLimit) this.requestsLimit = requestsLimit
 
-    if (verboseMode) this.enableVerboseMode()
+    if (verboseMode) {
+      this.setVerboseMode(verboseMode)
+      this.enableVerboseMode()
+    }
   }
 
   public setConfig(baseUrl: string, httpsAgentOptions?: https.AgentOptions) {
@@ -96,6 +71,7 @@ export class RequestClient implements HttpClient {
     this.csrfToken = { headerName: '', value: '' }
     this.fileUploadCsrfToken = { headerName: '', value: '' }
   }
+
   public clearLocalStorageTokens() {
     localStorage.setItem('accessToken', '')
     localStorage.setItem('refreshToken', '')
@@ -398,10 +374,12 @@ export class RequestClient implements HttpClient {
 
   /**
    * Adds colors to the string.
+   * If verboseMode is set to 'bleached', colors should be disabled
    * @param str - string to be prettified.
    * @returns - prettified string
    */
-  private prettifyString = (str: any) => inspect(str, { colors: true })
+  private prettifyString = (str: any) =>
+    inspect(str, { colors: this.verboseMode !== 'bleached' })
 
   /**
    * Formats HTTP request/response body.
@@ -435,10 +413,73 @@ export class RequestClient implements HttpClient {
     return bodyLines.join('\n')
   }
 
-  private defaultInterceptionCallBack = (response: AxiosResponse) => {
+  private defaultInterceptionCallBack = (
-    const { status, config, request, data: resData } = response
+    axiosResponse: AxiosResponse | AxiosError
+  ) => {
+    // Message indicating absent value.
+    const noValueMessage = 'Not provided'
+
+    // Fallback request object that can be safely used to form request summary.
+    type FallbackRequest = { _header?: string; res: { rawHeaders: string[] } }
+    // _header is not present in responses with status 1**
+    // rawHeaders are not present in responses with status 1**
+    let fallbackRequest: FallbackRequest = {
+      _header: `${noValueMessage}\n`,
+      res: { rawHeaders: [noValueMessage] }
+    }
+
+    // Fallback response object that can be safely used to form response summary.
+    type FallbackResponse = {
+      status?: number | string
+      request?: FallbackRequest
+      config: { data?: string }
+      data?: unknown
+    }
+    let fallbackResponse: FallbackResponse = axiosResponse
+
+    if (axios.isAxiosError(axiosResponse)) {
+      const { response, request, config } = axiosResponse
+
+      // Try to use axiosResponse.response to form response summary.
+      if (response) {
+        fallbackResponse = response
+      } else {
+        // Try to use axiosResponse.request to form request summary.
+        if (request) {
+          const { _header, _currentRequest } = request
+
+          // Try to use axiosResponse.request._header to form request summary.
+          if (_header) {
+            fallbackRequest._header = _header
+          }
+          // Try to use axiosResponse.request._currentRequest._header to form request summary.
+          else if (_currentRequest && _currentRequest._header) {
+            fallbackRequest._header = _currentRequest._header
+          }
+
+          const { res } = request
+
+          // Try to use axiosResponse.request.res.rawHeaders to form request summary.
+          if (res && res.rawHeaders) {
+            fallbackRequest.res.rawHeaders = res.rawHeaders
+          }
+        }
+
+        // Fallback config that can be safely used to form response summary.
+        const fallbackConfig = { data: noValueMessage }
+
+        fallbackResponse = {
+          status: noValueMessage,
+          request: fallbackRequest,
+          config: config || fallbackConfig,
+          data: noValueMessage
+        }
+      }
+    }
+
+    const { status, config, request, data: resData } = fallbackResponse
     const { data: reqData } = config
-    const { _header: reqHeaders, res } = request
+    const { _header: reqHeaders, res } = request || fallbackRequest
     const { rawHeaders } = res
 
     // Converts an array of strings into a single string with the following format:
@@ -468,7 +509,18 @@ HTTP Response (first 50 lines):
 ${resHeaders}${parsedResBody ? `\n\n${parsedResBody}` : ''}
 `)
 
-    return response
+    return axiosResponse
+  }
+
+  /**
+   * Sets verbose mode.
+   * @param verboseMode - value of the verbose mode, can be true, false or bleached(without extra colors).
+   */
+  public setVerboseMode = (verboseMode: VerboseMode) => {
+    this.verboseMode = verboseMode
+
+    if (this.verboseMode) this.enableVerboseMode()
+    else this.disableVerboseMode()
   }
 
   /**

src/request/SasjsRequestClient.ts

@@ -1,19 +1,11 @@
 import { RequestClient } from './RequestClient'
 import { AxiosResponse } from 'axios'
-
+import { SasjsParsedResponse } from '../types'
-export interface SasjsParsedResponse<T> {
-  result: T
-  log: string
-  etag: string
-  status: number
-  printOutput?: string
-}
 
 /**
  * Specific request client for SASJS.
  * Append tokens in headers.
  */
-
 export class SasjsRequestClient extends RequestClient {
   getHeaders = (accessToken: string | undefined, contentType: string) => {
     const headers: any = {}

src/request/spec/SasjsRequestClient.spec.ts

@@ -1,8 +1,5 @@
-import {
+import { SASJS_LOGS_SEPARATOR, SasjsRequestClient } from '../SasjsRequestClient'
-  SASJS_LOGS_SEPARATOR,
+import { SasjsParsedResponse } from '../../types'
-  SasjsRequestClient,
-  SasjsParsedResponse
-} from '../SasjsRequestClient'
 import { AxiosResponse } from 'axios'
 
 describe('SasjsRequestClient', () => {

src/test/RequestClient.spec.ts

@@ -5,16 +5,19 @@ import { app, mockedAuthResponse } from './SAS_server_app'
 import { ServerType } from '@sasjs/utils/types'
 import SASjs from '../SASjs'
 import * as axiosModules from '../utils/createAxiosInstance'
+import axios from 'axios'
 import {
   LoginRequiredError,
   AuthorizeError,
   NotFoundError,
-  InternalServerError
+  InternalServerError,
-} from '../types/errors'
+  VerboseMode
+} from '../types'
 import { RequestClient } from '../request/RequestClient'
 import { getTokenRequestErrorPrefixResponse } from '../auth/getTokenRequestErrorPrefix'
-import { AxiosResponse } from 'axios'
+import { AxiosResponse, AxiosError } from 'axios'
 import { Logger, LogLevel } from '@sasjs/utils/logger'
+import * as UtilsModule from 'util'
 
 const axiosActual = jest.requireActual('axios')
 
@@ -73,88 +76,7 @@ describe('RequestClient', () => {
   })
 
   describe('defaultInterceptionCallBack', () => {
-    beforeAll(() => {
+    const reqHeaders = `POST https://sas.server.com/compute/sessions/session_id/jobs HTTP/1.1
-      ;(process as any).logger = new Logger(LogLevel.Off)
-    })
-
-    it('should log parsed response', () => {
-      jest.spyOn((process as any).logger, 'info')
-
-      const status = 200
-      const reqData = `{
-        name: 'test_job',
-        description: 'Powered by SASjs',
-        code: ['test_code'],
-        variables: {
-          SYS_JES_JOB_URI: '',
-          _program: '/Public/sasjs/jobs/jobs/test_job'
-        },
-        arguments: {
-          _contextName: 'SAS Job Execution compute context',
-          _OMITJSONLISTING: true,
-          _OMITJSONLOG: true,
-          _OMITSESSIONRESULTS: true,
-          _OMITTEXTLISTING: true,
-          _OMITTEXTLOG: true
-        }
-      }`
-      const resData = {
-        id: 'id_string',
-        name: 'name_string',
-        uri: 'uri_string',
-        createdBy: 'createdBy_string',
-        code: 'TEST CODE',
-        links: [
-          {
-            method: 'method_string',
-            rel: 'state',
-            href: 'state_href_string',
-            uri: 'uri_string',
-            type: 'type_string'
-          },
-          {
-            method: 'method_string',
-            rel: 'state',
-            href: 'state_href_string',
-            uri: 'uri_string',
-            type: 'type_string'
-          },
-          {
-            method: 'method_string',
-            rel: 'state',
-            href: 'state_href_string',
-            uri: 'uri_string',
-            type: 'type_string'
-          },
-          {
-            method: 'method_string',
-            rel: 'state',
-            href: 'state_href_string',
-            uri: 'uri_string',
-            type: 'type_string'
-          },
-          {
-            method: 'method_string',
-            rel: 'state',
-            href: 'state_href_string',
-            uri: 'uri_string',
-            type: 'type_string'
-          },
-          {
-            method: 'method_string',
-            rel: 'self',
-            href: 'self_href_string',
-            uri: 'uri_string',
-            type: 'type_string'
-          }
-        ],
-        results: { '_webout.json': '_webout.json_string' },
-        logStatistics: {
-          lineCount: 1,
-          modifiedTimeStamp: 'modifiedTimeStamp_string'
-        }
-      }
-      const reqHeaders = `POST https://sas.server.com/compute/sessions/session_id/jobs HTTP/1.1
 Accept: application/json
 Content-Type: application/json
 User-Agent: axios/0.27.2
@@ -162,7 +84,126 @@ Content-Length: 334
 host: sas.server.io
 Connection: close
 `
-      const resHeaders = ['content-type', 'application/json']
+    const reqData = `{
+          name: 'test_job',
+          description: 'Powered by SASjs',
+          code: ['test_code'],
+          variables: {
+            SYS_JES_JOB_URI: '',
+            _program: '/Public/sasjs/jobs/jobs/test_job'
+          },
+          arguments: {
+            _contextName: 'SAS Job Execution compute context',
+            _OMITJSONLISTING: true,
+            _OMITJSONLOG: true,
+            _OMITSESSIONRESULTS: true,
+            _OMITTEXTLISTING: true,
+            _OMITTEXTLOG: true
+          }
+        }`
+
+    const resHeaders = ['content-type', 'application/json']
+    const resData = {
+      id: 'id_string',
+      name: 'name_string',
+      uri: 'uri_string',
+      createdBy: 'createdBy_string',
+      code: 'TEST CODE',
+      links: [
+        {
+          method: 'method_string',
+          rel: 'state',
+          href: 'state_href_string',
+          uri: 'uri_string',
+          type: 'type_string'
+        },
+        {
+          method: 'method_string',
+          rel: 'state',
+          href: 'state_href_string',
+          uri: 'uri_string',
+          type: 'type_string'
+        },
+        {
+          method: 'method_string',
+          rel: 'state',
+          href: 'state_href_string',
+          uri: 'uri_string',
+          type: 'type_string'
+        },
+        {
+          method: 'method_string',
+          rel: 'state',
+          href: 'state_href_string',
+          uri: 'uri_string',
+          type: 'type_string'
+        },
+        {
+          method: 'method_string',
+          rel: 'state',
+          href: 'state_href_string',
+          uri: 'uri_string',
+          type: 'type_string'
+        },
+        {
+          method: 'method_string',
+          rel: 'self',
+          href: 'self_href_string',
+          uri: 'uri_string',
+          type: 'type_string'
+        }
+      ],
+      results: { '_webout.json': '_webout.json_string' },
+      logStatistics: {
+        lineCount: 1,
+        modifiedTimeStamp: 'modifiedTimeStamp_string'
+      }
+    }
+    beforeAll(() => {
+      ;(process as any).logger = new Logger(LogLevel.Off)
+      jest.spyOn((process as any).logger, 'info')
+    })
+
+    it('should log parsed response with status 1**', () => {
+      const spyIsAxiosError = jest
+        .spyOn(axios, 'isAxiosError')
+        .mockImplementation(() => true)
+
+      const mockedAxiosError = {
+        config: {
+          data: reqData
+        },
+        request: {
+          _currentRequest: {
+            _header: reqHeaders
+          }
+        }
+      } as AxiosError
+
+      const requestClient = new RequestClient('')
+      requestClient['defaultInterceptionCallBack'](mockedAxiosError)
+
+      const noValueMessage = 'Not provided'
+      const expectedLog = `HTTP Request (first 50 lines):
+${reqHeaders}${requestClient['parseInterceptedBody'](reqData)}
+
+HTTP Response Code: ${requestClient['prettifyString'](noValueMessage)}
+
+HTTP Response (first 50 lines):
+${noValueMessage}
+\n${requestClient['parseInterceptedBody'](noValueMessage)}
+`
+
+      expect((process as any).logger.info).toHaveBeenCalledWith(expectedLog)
+
+      spyIsAxiosError.mockReset()
+    })
+
+    it('should log parsed response with status 2**', () => {
+      const status = getRandomStatus([
+        200, 201, 202, 203, 204, 205, 206, 207, 208, 226
+      ])
+
       const mockedResponse: AxiosResponse = {
         data: resData,
         status,
@@ -190,6 +231,138 @@ ${resHeaders[0]}: ${resHeaders[1]}${
 
       expect((process as any).logger.info).toHaveBeenCalledWith(expectedLog)
     })
+
+    it('should log parsed response with status 3**', () => {
+      const status = getRandomStatus([300, 301, 302, 303, 304, 307, 308])
+
+      const mockedResponse: AxiosResponse = {
+        data: resData,
+        status,
+        statusText: '',
+        headers: {},
+        config: { data: reqData },
+        request: { _header: reqHeaders, res: { rawHeaders: resHeaders } }
+      }
+
+      const requestClient = new RequestClient('')
+      requestClient['defaultInterceptionCallBack'](mockedResponse)
+
+      const expectedLog = `HTTP Request (first 50 lines):
+${reqHeaders}${requestClient['parseInterceptedBody'](reqData)}
+
+HTTP Response Code: ${requestClient['prettifyString'](status)}
+
+HTTP Response (first 50 lines):
+${resHeaders[0]}: ${resHeaders[1]}${
+        requestClient['parseInterceptedBody'](resData)
+          ? `\n\n${requestClient['parseInterceptedBody'](resData)}`
+          : ''
+      }
+`
+
+      expect((process as any).logger.info).toHaveBeenCalledWith(expectedLog)
+    })
+
+    it('should log parsed response with status 4**', () => {
+      const spyIsAxiosError = jest
+        .spyOn(axios, 'isAxiosError')
+        .mockImplementation(() => true)
+
+      const status = getRandomStatus([
+        400, 401, 402, 403, 404, 407, 408, 409, 410, 411, 412, 413, 414, 415,
+        416, 417, 418, 421, 422, 423, 424, 425, 426, 428, 429, 431, 451
+      ])
+
+      const mockedResponse: AxiosResponse = {
+        data: resData,
+        status,
+        statusText: '',
+        headers: {},
+        config: { data: reqData },
+        request: { _header: reqHeaders, res: { rawHeaders: resHeaders } }
+      }
+      const mockedAxiosError = {
+        config: {
+          data: reqData
+        },
+        request: {
+          _currentRequest: {
+            _header: reqHeaders
+          }
+        },
+        response: mockedResponse
+      } as AxiosError
+
+      const requestClient = new RequestClient('')
+      requestClient['defaultInterceptionCallBack'](mockedAxiosError)
+
+      const expectedLog = `HTTP Request (first 50 lines):
+${reqHeaders}${requestClient['parseInterceptedBody'](reqData)}
+
+HTTP Response Code: ${requestClient['prettifyString'](status)}
+
+HTTP Response (first 50 lines):
+${resHeaders[0]}: ${resHeaders[1]}${
+        requestClient['parseInterceptedBody'](resData)
+          ? `\n\n${requestClient['parseInterceptedBody'](resData)}`
+          : ''
+      }
+`
+
+      expect((process as any).logger.info).toHaveBeenCalledWith(expectedLog)
+
+      spyIsAxiosError.mockReset()
+    })
+
+    it('should log parsed response with status 5**', () => {
+      const spyIsAxiosError = jest
+        .spyOn(axios, 'isAxiosError')
+        .mockImplementation(() => true)
+
+      const status = getRandomStatus([
+        500, 501, 502, 503, 504, 505, 506, 507, 508, 510, 511
+      ])
+
+      const mockedResponse: AxiosResponse = {
+        data: resData,
+        status,
+        statusText: '',
+        headers: {},
+        config: { data: reqData },
+        request: { _header: reqHeaders, res: { rawHeaders: resHeaders } }
+      }
+      const mockedAxiosError = {
+        config: {
+          data: reqData
+        },
+        request: {
+          _currentRequest: {
+            _header: reqHeaders
+          }
+        },
+        response: mockedResponse
+      } as AxiosError
+
+      const requestClient = new RequestClient('')
+      requestClient['defaultInterceptionCallBack'](mockedAxiosError)
+
+      const expectedLog = `HTTP Request (first 50 lines):
+${reqHeaders}${requestClient['parseInterceptedBody'](reqData)}
+
+HTTP Response Code: ${requestClient['prettifyString'](status)}
+
+HTTP Response (first 50 lines):
+${resHeaders[0]}: ${resHeaders[1]}${
+        requestClient['parseInterceptedBody'](resData)
+          ? `\n\n${requestClient['parseInterceptedBody'](resData)}`
+          : ''
+      }
+`
+
+      expect((process as any).logger.info).toHaveBeenCalledWith(expectedLog)
+
+      spyIsAxiosError.mockReset()
+    })
   })
 
   describe('enableVerboseMode', () => {
@@ -215,12 +388,12 @@ ${resHeaders[0]}: ${resHeaders[1]}${
         'use'
       )
 
-      const successCallback = (response: AxiosResponse) => {
+      const successCallback = (response: AxiosResponse | AxiosError) => {
         console.log('success')
 
         return response
       }
-      const failureCallback = (response: AxiosResponse) => {
+      const failureCallback = (response: AxiosResponse | AxiosError) => {
         console.log('failure')
 
         return response
@@ -235,6 +408,60 @@ ${resHeaders[0]}: ${resHeaders[1]}${
     })
   })
 
+  describe('setVerboseMode', () => {
+    it(`should set verbose mode`, () => {
+      const requestClient = new RequestClient('')
+      let verbose: VerboseMode = false
+      requestClient.setVerboseMode(verbose)
+
+      expect(requestClient['verboseMode']).toEqual(verbose)
+
+      verbose = true
+      requestClient.setVerboseMode(verbose)
+
+      expect(requestClient['verboseMode']).toEqual(verbose)
+
+      verbose = 'bleached'
+      requestClient.setVerboseMode(verbose)
+
+      expect(requestClient['verboseMode']).toEqual(verbose)
+    })
+  })
+
+  describe('prettifyString', () => {
+    it(`should call inspect without colors when verbose mode is set to 'bleached'`, () => {
+      const requestClient = new RequestClient('')
+      let verbose: VerboseMode = 'bleached'
+      requestClient.setVerboseMode(verbose)
+
+      jest.spyOn(UtilsModule, 'inspect')
+
+      const testStr = JSON.stringify({ test: 'test' })
+
+      requestClient['prettifyString'](testStr)
+
+      expect(UtilsModule.inspect).toHaveBeenCalledWith(testStr, {
+        colors: false
+      })
+    })
+
+    it(`should call inspect with colors when verbose mode is set to 'true'`, () => {
+      const requestClient = new RequestClient('')
+      let verbose: VerboseMode = true
+      requestClient.setVerboseMode(verbose)
+
+      jest.spyOn(UtilsModule, 'inspect')
+
+      const testStr = JSON.stringify({ test: 'test' })
+
+      requestClient['prettifyString'](testStr)
+
+      expect(UtilsModule.inspect).toHaveBeenCalledWith(testStr, {
+        colors: true
+      })
+    })
+  })
+
   describe('disableVerboseMode', () => {
     it('should eject interceptor', () => {
       const requestClient = new RequestClient('')
@@ -466,3 +693,11 @@ const createCertificate = async (): Promise<pem.CertificateCreationResult> => {
     )
   })
 }
+
+/**
+ * Returns a random status code.
+ * @param statuses - an array of available statuses.
+ * @returns - random item from an array of statuses.
+ */
+const getRandomStatus = (statuses: number[]) =>
+  statuses[Math.floor(Math.random() * statuses.length)]

src/types/RequestClient.ts

@@ -0,0 +1,55 @@
+import { CsrfToken } from '..'
+
+export interface HttpClient {
+  get<T>(
+    url: string,
+    accessToken: string | undefined,
+    contentType: string,
+    overrideHeaders: { [key: string]: string | number }
+  ): Promise<{ result: T; etag: string }>
+
+  post<T>(
+    url: string,
+    data: any,
+    accessToken: string | undefined,
+    contentType: string,
+    overrideHeaders: { [key: string]: string | number }
+  ): Promise<{ result: T; etag: string }>
+
+  put<T>(
+    url: string,
+    data: any,
+    accessToken: string | undefined,
+    overrideHeaders: { [key: string]: string | number }
+  ): Promise<{ result: T; etag: string }>
+
+  delete<T>(
+    url: string,
+    accessToken: string | undefined
+  ): Promise<{ result: T; etag: string }>
+
+  getCsrfToken(type: 'general' | 'file'): CsrfToken | undefined
+  saveLocalStorageToken(accessToken: string, refreshToken: string): void
+  clearCsrfTokens(): void
+  clearLocalStorageTokens(): void
+  getBaseUrl(): string
+}
+
+export interface SASjsRequest {
+  serviceLink: string
+  timestamp: Date
+  sourceCode: string
+  generatedCode: string
+  logFile: string
+  SASWORK: any
+}
+
+export interface SasjsParsedResponse<T> {
+  result: T
+  log: string
+  etag: string
+  status: number
+  printOutput?: string
+}
+
+export type VerboseMode = boolean | 'bleached'

src/types/SASjsConfig.ts

@@ -1,5 +1,6 @@
 import * as https from 'https'
 import { ServerType } from '@sasjs/utils/types'
+import { VerboseMode } from '../types'
 
 /**
  * Specifies the configuration for the SASjs instance - eg where and how to
@@ -48,7 +49,7 @@ export class SASjsConfig {
   /**
    * Set to `true` to enable verbose mode that will log a summary of every HTTP response.
    */
-  verbose?: boolean = true
+  verbose?: VerboseMode = true
   /**
    * The name of the compute context to use when calling the Viya services directly.
    * Example value: 'SAS Job Execution compute context'

src/types/SASjsRequest.ts

@@ -1,12 +0,0 @@
-/**
- * Represents a SASjs request, its response and logs.
- *
- */
-export interface SASjsRequest {
-  serviceLink: string
-  timestamp: Date
-  sourceCode: string
-  generatedCode: string
-  logFile: string
-  SASWORK: any
-}

src/types/index.ts

@@ -6,10 +6,12 @@ export * from './Job'
 export * from './JobDefinition'
 export * from './JobResult'
 export * from './Link'
+export * from './Login'
 export * from './SASjsConfig'
-export * from './SASjsRequest'
+export * from './RequestClient'
 export * from './Session'
 export * from './UploadFile'
 export * from './PollOptions'
 export * from './WriteStream'
 export * from './ExecuteScript'
+export * from './errors'

src/utils/compareTimestamps.ts

@@ -1,4 +1,4 @@
-import { SASjsRequest } from '../types/SASjsRequest'
+import { SASjsRequest } from '../types'
 
 /**
  * Comparator for SASjs request timestamps.