@sasjs/adapter 4.6.0 → 4.8.0

package/node/request/RequestClient.d.ts

@@ -36,10 +36,11 @@ export declare class RequestClient implements HttpClient {
     protected baseUrl: string;
     private requests;
     private requestsLimit;
+    private httpInterceptor?;
     protected csrfToken: CsrfToken;
     protected fileUploadCsrfToken: CsrfToken | undefined;
     protected httpClient: AxiosInstance;
-    constructor(baseUrl: string, httpsAgentOptions?: https.AgentOptions, requestsLimit?: number);
+    constructor(baseUrl: string, httpsAgentOptions?: https.AgentOptions, requestsLimit?: number, verboseMode?: boolean);
     setConfig(baseUrl: string, httpsAgentOptions?: https.AgentOptions): void;
     saveLocalStorageToken(accessToken: string, refreshToken: string): void;
     getCsrfToken(type?: 'general' | 'file'): CsrfToken | undefined;
@@ -93,6 +94,29 @@ export declare class RequestClient implements HttpClient {
     }>;
     uploadFile(url: string, content: string, accessToken?: string): Promise<any>;
     authorize: (response: string) => Promise<any>;
+    /**
+     * Adds colors to the string.
+     * @param str - string to be prettified.
+     * @returns - prettified string
+     */
+    private prettifyString;
+    /**
+     * Formats HTTP request/response body.
+     * @param body - HTTP request/response body.
+     * @returns - formatted string.
+     */
+    private parseInterceptedBody;
+    private defaultInterceptionCallBack;
+    /**
+     * Turns on verbose mode to log every HTTP response.
+     * @param successCallBack - function that should be triggered on every HTTP response with the status 2**.
+     * @param errorCallBack - function that should be triggered on every HTTP response with the status different from 2**.
+     */
+    enableVerboseMode: (successCallBack?: (response: AxiosResponse) => AxiosResponse<any, any>, errorCallBack?: (response: AxiosResponse) => AxiosResponse<any, any>) => void;
+    /**
+     * Turns off verbose mode to log every HTTP response.
+     */
+    disableVerboseMode: () => void;
     protected getHeaders: (accessToken: string | undefined, contentType: string) => any;
     protected parseAndSetFileUploadCsrfToken: (response: AxiosResponse) => void;
     protected parseAndSetCsrfToken: (response: AxiosResponse) => void;

package/node/types/SASjsConfig.d.ts

@@ -45,6 +45,10 @@ export declare class SASjsConfig {
      * Set to `true` to enable additional debugging.
      */
     debug: boolean;
+    /**
+     * Set to `true` to enable verbose mode that will log a summary of every HTTP response.
+     */
+    verbose?: boolean;
     /**
      * The name of the compute context to use when calling the Viya services directly.
      * Example value: 'SAS Job Execution compute context'

package/package.json

@@ -84,5 +84,5 @@
     "https": "1.0.0",
     "tough-cookie": "4.1.3"
   },
-  "version": "4.6.0"
+  "version": "4.8.0"
 }

package/request/RequestClient.d.ts

@@ -36,10 +36,11 @@ export declare class RequestClient implements HttpClient {
     protected baseUrl: string;
     private requests;
     private requestsLimit;
+    private httpInterceptor?;
     protected csrfToken: CsrfToken;
     protected fileUploadCsrfToken: CsrfToken | undefined;
     protected httpClient: AxiosInstance;
-    constructor(baseUrl: string, httpsAgentOptions?: https.AgentOptions, requestsLimit?: number);
+    constructor(baseUrl: string, httpsAgentOptions?: https.AgentOptions, requestsLimit?: number, verboseMode?: boolean);
     setConfig(baseUrl: string, httpsAgentOptions?: https.AgentOptions): void;
     saveLocalStorageToken(accessToken: string, refreshToken: string): void;
     getCsrfToken(type?: 'general' | 'file'): CsrfToken | undefined;
@@ -93,6 +94,29 @@ export declare class RequestClient implements HttpClient {
     }>;
     uploadFile(url: string, content: string, accessToken?: string): Promise<any>;
     authorize: (response: string) => Promise<any>;
+    /**
+     * Adds colors to the string.
+     * @param str - string to be prettified.
+     * @returns - prettified string
+     */
+    private prettifyString;
+    /**
+     * Formats HTTP request/response body.
+     * @param body - HTTP request/response body.
+     * @returns - formatted string.
+     */
+    private parseInterceptedBody;
+    private defaultInterceptionCallBack;
+    /**
+     * Turns on verbose mode to log every HTTP response.
+     * @param successCallBack - function that should be triggered on every HTTP response with the status 2**.
+     * @param errorCallBack - function that should be triggered on every HTTP response with the status different from 2**.
+     */
+    enableVerboseMode: (successCallBack?: (response: AxiosResponse) => AxiosResponse<any, any>, errorCallBack?: (response: AxiosResponse) => AxiosResponse<any, any>) => void;
+    /**
+     * Turns off verbose mode to log every HTTP response.
+     */
+    disableVerboseMode: () => void;
     protected getHeaders: (accessToken: string | undefined, contentType: string) => any;
     protected parseAndSetFileUploadCsrfToken: (response: AxiosResponse) => void;
     protected parseAndSetCsrfToken: (response: AxiosResponse) => void;

package/src/SASjs.ts

@@ -31,6 +31,7 @@ import {
 } from './job-execution'
 import { ErrorResponse } from './types/errors'
 import { LoginOptions, LoginResult } from './types/Login'
+import { AxiosResponse } from 'axios'
 
 interface ExecuteScriptParams {
   linesOfCode: string[]
@@ -854,6 +855,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).
    */
   public async startComputeJob(
     sasJob: string,
@@ -863,7 +865,8 @@ export default class SASjs {
     waitForResult?: boolean,
     pollOptions?: PollOptions,
     printPid = false,
-    variables?: MacroVar
+    variables?: MacroVar,
+    verboseMode?: boolean
   ) {
     config = {
       ...this.sasjsConfig,
@@ -877,6 +880,9 @@ export default class SASjs {
       )
     }
 
+    if (verboseMode) this.requestClient?.enableVerboseMode()
+    else if (verboseMode === false) this.requestClient?.disableVerboseMode()
+
     return this.sasViyaApiClient?.executeComputeJob(
       sasJob,
       config.contextName,
@@ -970,7 +976,8 @@ export default class SASjs {
       this.requestClient = new RequestClientClass(
         this.sasjsConfig.serverUrl,
         this.sasjsConfig.httpsAgentOptions,
-        this.sasjsConfig.requestHistoryLimit
+        this.sasjsConfig.requestHistoryLimit,
+        this.sasjsConfig.verbose
       )
     } else {
       this.requestClient.setConfig(
@@ -1134,4 +1141,23 @@ export default class SASjs {
       )
     }
   }
+
+  /**
+   * Enables verbose mode that will log a summary of every HTTP response.
+   * @param successCallBack - function that should be triggered on every HTTP response with the status 2**.
+   * @param errorCallBack - function that should be triggered on every HTTP response with the status different from 2**.
+   */
+  public enableVerboseMode(
+    successCallBack?: (response: AxiosResponse) => AxiosResponse,
+    errorCallBack?: (response: AxiosResponse) => AxiosResponse
+  ) {
+    this.requestClient?.enableVerboseMode(successCallBack, errorCallBack)
+  }
+
+  /**
+   * Turns off verbose mode to log every HTTP response.
+   */
+  public disableVerboseMode() {
+    this.requestClient?.disableVerboseMode()
+  }
 }

package/src/minified/sas9/SASjs.ts

@@ -233,7 +233,8 @@ export default class SASjs {
       this.requestClient = new RequestClient(
         this.sasjsConfig.serverUrl,
         this.sasjsConfig.httpsAgentOptions,
-        this.sasjsConfig.requestHistoryLimit
+        this.sasjsConfig.requestHistoryLimit,
+        this.sasjsConfig.verbose
       )
     } else {
       this.requestClient.setConfig(

package/src/minified/sas9/WebJobExecutor.ts

@@ -11,7 +11,6 @@ import {
 import { RequestClient } from '../../request/RequestClient'
 import {
   isRelativePath,
-  parseSasViyaDebugResponse,
   appendExtraResponseAttributes,
   convertToCSV
 } from '../../utils'

package/src/request/RequestClient.ts

@@ -20,6 +20,7 @@ import {
   createAxiosInstance
 } from '../utils'
 import { InvalidSASjsCsrfError } from '../types/errors/InvalidSASjsCsrfError'
+import { inspect } from 'util'
 
 export interface HttpClient {
   get<T>(
@@ -59,6 +60,7 @@ export interface HttpClient {
 export class RequestClient implements HttpClient {
   private requests: SASjsRequest[] = []
   private requestsLimit: number = 10
+  private httpInterceptor?: number
 
   protected csrfToken: CsrfToken = { headerName: '', value: '' }
   protected fileUploadCsrfToken: CsrfToken | undefined
@@ -67,10 +69,14 @@ export class RequestClient implements HttpClient {
   constructor(
     protected baseUrl: string,
     httpsAgentOptions?: https.AgentOptions,
-    requestsLimit?: number
+    requestsLimit?: number,
+    verboseMode?: boolean
   ) {
     this.createHttpClient(baseUrl, httpsAgentOptions)
+
     if (requestsLimit) this.requestsLimit = requestsLimit
+
+    if (verboseMode) this.enableVerboseMode()
   }
 
   public setConfig(baseUrl: string, httpsAgentOptions?: https.AgentOptions) {
@@ -180,6 +186,7 @@ export class RequestClient implements HttpClient {
       responseType: contentType === 'text/plain' ? 'text' : 'json',
       withCredentials: true
     }
+
     if (contentType === 'text/plain') {
       requestConfig.transformResponse = undefined
     }
@@ -389,6 +396,105 @@ export class RequestClient implements HttpClient {
       })
   }
 
+  /**
+   * Adds colors to the string.
+   * @param str - string to be prettified.
+   * @returns - prettified string
+   */
+  private prettifyString = (str: any) => inspect(str, { colors: true })
+
+  /**
+   * Formats HTTP request/response body.
+   * @param body - HTTP request/response body.
+   * @returns - formatted string.
+   */
+  private parseInterceptedBody = (body: any) => {
+    if (!body) return ''
+
+    let parsedBody
+
+    // Tries to parse body into JSON object.
+    if (typeof body === 'string') {
+      try {
+        parsedBody = JSON.parse(body)
+      } catch (error) {
+        parsedBody = body
+      }
+    } else {
+      parsedBody = body
+    }
+
+    const bodyLines = this.prettifyString(parsedBody).split('\n')
+
+    // Leaves first 50 lines
+    if (bodyLines.length > 51) {
+      bodyLines.splice(50)
+      bodyLines.push('...')
+    }
+
+    return bodyLines.join('\n')
+  }
+
+  private defaultInterceptionCallBack = (response: AxiosResponse) => {
+    const { status, config, request, data: resData } = response
+    const { data: reqData } = config
+    const { _header: reqHeaders, res } = request
+    const { rawHeaders } = res
+
+    // Converts an array of strings into a single string with the following format:
+    // <headerName>: <headerValue>
+    const resHeaders = rawHeaders.reduce(
+      (acc: string, value: string, i: number) => {
+        if (i % 2 === 0) {
+          acc += `${i === 0 ? '' : '\n'}${value}`
+        } else {
+          acc += `: ${value}`
+        }
+
+        return acc
+      },
+      ''
+    )
+
+    const parsedResBody = this.parseInterceptedBody(resData)
+
+    // HTTP response summary.
+    process.logger?.info(`HTTP Request (first 50 lines):
+${reqHeaders}${this.parseInterceptedBody(reqData)}
+
+HTTP Response Code: ${this.prettifyString(status)}
+
+HTTP Response (first 50 lines):
+${resHeaders}${parsedResBody ? `\n\n${parsedResBody}` : ''}
+`)
+
+    return response
+  }
+
+  /**
+   * Turns on verbose mode to log every HTTP response.
+   * @param successCallBack - function that should be triggered on every HTTP response with the status 2**.
+   * @param errorCallBack - function that should be triggered on every HTTP response with the status different from 2**.
+   */
+  public enableVerboseMode = (
+    successCallBack = this.defaultInterceptionCallBack,
+    errorCallBack = this.defaultInterceptionCallBack
+  ) => {
+    this.httpInterceptor = this.httpClient.interceptors.response.use(
+      successCallBack,
+      errorCallBack
+    )
+  }
+
+  /**
+   * Turns off verbose mode to log every HTTP response.
+   */
+  public disableVerboseMode = () => {
+    if (this.httpInterceptor) {
+      this.httpClient.interceptors.response.eject(this.httpInterceptor)
+    }
+  }
+
   protected getHeaders = (
     accessToken: string | undefined,
     contentType: string

package/src/types/SASjsConfig.ts

@@ -45,6 +45,10 @@ export class SASjsConfig {
    * Set to `true` to enable additional debugging.
    */
   debug: boolean = true
+  /**
+   * Set to `true` to enable verbose mode that will log a summary of every HTTP response.
+   */
+  verbose?: boolean = true
   /**
    * The name of the compute context to use when calling the Viya services directly.
    * Example value: 'SAS Job Execution compute context'

package/types/SASjsConfig.d.ts

@@ -45,6 +45,10 @@ export declare class SASjsConfig {
      * Set to `true` to enable additional debugging.
      */
     debug: boolean;
+    /**
+     * Set to `true` to enable verbose mode that will log a summary of every HTTP response.
+     */
+    verbose?: boolean;
     /**
      * The name of the compute context to use when calling the Viya services directly.
      * Example value: 'SAS Job Execution compute context'