@sasjs/adapter 2.11.0 → 2.11.4

package/node/job-execution/FileUploader.d.ts

@@ -0,0 +1,9 @@
+import { RequestClient } from '../request/RequestClient';
+import { ServerType } from '@sasjs/utils/types';
+import { BaseJobExecutor } from './JobExecutor';
+export declare class FileUploader extends BaseJobExecutor {
+    private jobsPath;
+    private requestClient;
+    constructor(serverUrl: string, serverType: ServerType, jobsPath: string, requestClient: RequestClient);
+    execute(sasJob: string, data: any, config: any, loginRequiredCallback?: any): Promise<unknown>;
+}

package/node/job-execution/JobExecutor.d.ts

@@ -1,23 +1,16 @@
 import { AuthConfig, ServerType } from '@sasjs/utils/types';
-import { SASjsRequest } from '../types';
 import { ExtraResponseAttributes } from '@sasjs/utils/types';
 export declare type ExecuteFunction = () => Promise<any>;
 export interface JobExecutor {
     execute: (sasJob: string, data: any, config: any, loginRequiredCallback?: any, authConfig?: AuthConfig, extraResponseAttributes?: ExtraResponseAttributes[]) => Promise<any>;
     resendWaitingRequests: () => Promise<void>;
-    getRequests: () => SASjsRequest[];
-    clearRequests: () => void;
 }
 export declare abstract class BaseJobExecutor implements JobExecutor {
     protected serverUrl: string;
     protected serverType: ServerType;
     constructor(serverUrl: string, serverType: ServerType);
     private waitingRequests;
-    private requests;
     abstract execute(sasJob: string, data: any, config: any, loginRequiredCallback?: any, authConfig?: AuthConfig | undefined, extraResponseAttributes?: ExtraResponseAttributes[]): Promise<any>;
     resendWaitingRequests: () => Promise<void>;
-    getRequests: () => SASjsRequest[];
-    clearRequests: () => void;
     protected appendWaitingRequest(request: ExecuteFunction): void;
-    protected appendRequest(response: any, program: string, debug: boolean): void;
 }

package/node/job-execution/index.d.ts

@@ -3,3 +3,4 @@ export * from './JesJobExecutor';
 export * from './JobExecutor';
 export * from './Sas9JobExecutor';
 export * from './WebJobExecutor';
+export * from './FileUploader';

package/node/request/RequestClient.d.ts

@@ -1,5 +1,6 @@
 import { AxiosInstance, AxiosResponse } from 'axios';
 import { CsrfToken } from '..';
+import { SASjsRequest } from '../types';
 export interface HttpClient {
     get<T>(url: string, accessToken: string | undefined, contentType: string, overrideHeaders: {
         [key: string]: string | number;
@@ -29,13 +30,31 @@ export interface HttpClient {
 }
 export declare class RequestClient implements HttpClient {
     protected baseUrl: string;
+    private requests;
     protected csrfToken: CsrfToken;
     protected fileUploadCsrfToken: CsrfToken | undefined;
     protected httpClient: AxiosInstance;
     constructor(baseUrl: string, allowInsecure?: boolean);
+    setConfig(baseUrl: string, allowInsecure?: boolean): void;
     getCsrfToken(type?: 'general' | 'file'): CsrfToken | undefined;
     clearCsrfTokens(): void;
     getBaseUrl(): string;
+    /**
+     * this method returns all requests, an array of SASjsRequest type
+     * @returns SASjsRequest[]
+     */
+    getRequests: () => SASjsRequest[];
+    /**
+     * this method clears the requests array, i.e set to empty
+     */
+    clearRequests: () => void;
+    /**
+     * this method appends the response from sasjs request to requests array
+     * @param response - response from sasjs request
+     * @param program - name of program
+     * @param debug - a boolean that indicates whether debug was enabled or not
+     */
+    appendRequest(response: any, program: string, debug: boolean): void;
     get<T>(url: string, accessToken: string | undefined, contentType?: string, overrideHeaders?: {
         [key: string]: string | number;
     }, debug?: boolean): Promise<{
@@ -76,5 +95,6 @@ export declare class RequestClient implements HttpClient {
         log?: string | undefined;
         status: number;
     };
+    private createHttpClient;
 }
 export declare const throwIfError: (response: AxiosResponse) => void;

package/package.json

@@ -48,33 +48,33 @@
     "copyfiles": "^2.4.1",
     "cp": "^0.2.0",
     "dotenv": "^10.0.0",
-    "jest": "^27.1.0",
+    "jest": "^27.2.0",
     "jest-extended": "^0.11.5",
     "node-polyfill-webpack-plugin": "^1.1.4",
     "path": "^0.12.7",
     "process": "^0.11.10",
     "rimraf": "^3.0.2",
     "semantic-release": "^17.4.7",
-    "terser-webpack-plugin": "^5.2.0",
+    "terser-webpack-plugin": "^5.2.4",
     "ts-jest": "^27.0.3",
     "ts-loader": "^9.2.2",
     "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.18.0",
-    "typedoc": "^0.21.9",
+    "typedoc": "^0.22.3",
     "typedoc-neo-theme": "^1.1.1",
     "typedoc-plugin-external-module-name": "^4.0.6",
     "typescript": "4.3.5",
-    "webpack": "^5.44.0",
+    "webpack": "^5.52.1",
     "webpack-cli": "^4.7.2"
   },
   "main": "index.js",
   "dependencies": {
     "@sasjs/utils": "^2.30.0",
-    "axios": "^0.21.1",
+    "axios": "^0.21.4",
     "axios-cookiejar-support": "^1.0.1",
     "form-data": "^4.0.0",
     "https": "^1.0.0",
     "tough-cookie": "^4.0.0"
   },
-  "version": "2.11.0"
+  "version": "2.11.4"
 }

package/request/RequestClient.d.ts

@@ -1,5 +1,6 @@
 import { AxiosInstance, AxiosResponse } from 'axios';
 import { CsrfToken } from '..';
+import { SASjsRequest } from '../types';
 export interface HttpClient {
     get<T>(url: string, accessToken: string | undefined, contentType: string, overrideHeaders: {
         [key: string]: string | number;
@@ -29,13 +30,31 @@ export interface HttpClient {
 }
 export declare class RequestClient implements HttpClient {
     protected baseUrl: string;
+    private requests;
     protected csrfToken: CsrfToken;
     protected fileUploadCsrfToken: CsrfToken | undefined;
     protected httpClient: AxiosInstance;
     constructor(baseUrl: string, allowInsecure?: boolean);
+    setConfig(baseUrl: string, allowInsecure?: boolean): void;
     getCsrfToken(type?: 'general' | 'file'): CsrfToken | undefined;
     clearCsrfTokens(): void;
     getBaseUrl(): string;
+    /**
+     * this method returns all requests, an array of SASjsRequest type
+     * @returns SASjsRequest[]
+     */
+    getRequests: () => SASjsRequest[];
+    /**
+     * this method clears the requests array, i.e set to empty
+     */
+    clearRequests: () => void;
+    /**
+     * this method appends the response from sasjs request to requests array
+     * @param response - response from sasjs request
+     * @param program - name of program
+     * @param debug - a boolean that indicates whether debug was enabled or not
+     */
+    appendRequest(response: any, program: string, debug: boolean): void;
     get<T>(url: string, accessToken: string | undefined, contentType?: string, overrideHeaders?: {
         [key: string]: string | number;
     }, debug?: boolean): Promise<{
@@ -76,5 +95,6 @@ export declare class RequestClient implements HttpClient {
         log?: string | undefined;
         status: number;
     };
+    private createHttpClient;
 }
 export declare const throwIfError: (response: AxiosResponse) => void;

package/src/SASViyaApiClient.ts

@@ -51,6 +51,16 @@ export class SASViyaApiClient {
   )
   private folderMap = new Map<string, Job[]>()
 
+  /**
+   * A helper method used to call appendRequest method of RequestClient
+   * @param response - response from sasjs request
+   * @param program - name of program
+   * @param debug - a boolean that indicates whether debug was enabled or not
+   */
+  public appendRequest(response: any, program: string, debug: boolean) {
+    this.requestClient!.appendRequest(response, program, debug)
+  }
+
   public get debug() {
     return this._debug
   }

package/src/SASjs.ts

@@ -8,7 +8,6 @@ import {
 } from './types'
 import { SASViyaApiClient } from './SASViyaApiClient'
 import { SAS9ApiClient } from './SAS9ApiClient'
-import { FileUploader } from './FileUploader'
 import { AuthManager } from './auth'
 import {
   ServerType,
@@ -22,7 +21,8 @@ import {
   WebJobExecutor,
   ComputeJobExecutor,
   JesJobExecutor,
-  Sas9JobExecutor
+  Sas9JobExecutor,
+  FileUploader
 } from './job-execution'
 import { ErrorResponse } from './types/errors'
 import { LoginOptions, LoginResult } from './types/Login'
@@ -507,7 +507,7 @@ export default class SASjs {
       ...this.sasjsConfig,
       ...config
     }
-    await this.setupConfiguration()
+    this.setupConfiguration()
   }
 
   /**
@@ -571,24 +571,32 @@ export default class SASjs {
    *  Process). Is prepended at runtime with the value of `appLoc`.
    * @param files - array of files to be uploaded, including File object and file name.
    * @param params - request URL parameters.
-   * @param overrideSasjsConfig - object to override existing config (optional)
+   * @param config - provide any changes to the config here, for instance to
+   * enable/disable `debug`. Any change provided will override the global config,
+   * for that particular function call.
+   * @param loginRequiredCallback - a function that is called if the
+   * user is not logged in (eg to display a login form). The request will be
+   * resubmitted after successful login.
    */
-  public uploadFile(
+  public async uploadFile(
     sasJob: string,
     files: UploadFile[],
-    params: any,
-    overrideSasjsConfig?: any
+    params: { [key: string]: any } | null,
+    config: { [key: string]: any } = {},
+    loginRequiredCallback?: () => any
   ) {
-    const fileUploader = overrideSasjsConfig
-      ? new FileUploader(
-          { ...this.sasjsConfig, ...overrideSasjsConfig },
-          this.jobsPath,
-          this.requestClient!
-        )
-      : this.fileUploader ||
-        new FileUploader(this.sasjsConfig, this.jobsPath, this.requestClient!)
+    config = {
+      ...this.sasjsConfig,
+      ...config
+    }
+    const data = { files, params }
 
-    return fileUploader.uploadFile(sasJob, files, params)
+    return await this.fileUploader!.execute(
+      sasJob,
+      data,
+      config,
+      loginRequiredCallback
+    )
   }
 
   /**
@@ -874,6 +882,7 @@ export default class SASjs {
     await this.webJobExecutor?.resendWaitingRequests()
     await this.computeJobExecutor?.resendWaitingRequests()
     await this.jesJobExecutor?.resendWaitingRequests()
+    await this.fileUploader?.resendWaitingRequests()
   }
 
   /**
@@ -905,20 +914,18 @@ export default class SASjs {
     })
   }
 
+  /**
+   * this method returns an array of SASjsRequest
+   * @returns SASjsRequest[]
+   */
   public getSasRequests() {
-    const requests = [
-      ...this.webJobExecutor!.getRequests(),
-      ...this.computeJobExecutor!.getRequests(),
-      ...this.jesJobExecutor!.getRequests()
-    ]
+    const requests = [...this.requestClient!.getRequests()]
     const sortedRequests = requests.sort(compareTimestamps)
     return sortedRequests
   }
 
   public clearSasRequests() {
-    this.webJobExecutor!.clearRequests()
-    this.computeJobExecutor!.clearRequests()
-    this.jesJobExecutor!.clearRequests()
+    this.requestClient!.clearRequests()
   }
 
   private setupConfiguration() {
@@ -941,10 +948,17 @@ export default class SASjs {
       this.sasjsConfig.serverUrl = this.sasjsConfig.serverUrl.slice(0, -1)
     }
 
-    this.requestClient = new RequestClient(
-      this.sasjsConfig.serverUrl,
-      this.sasjsConfig.allowInsecureRequests
-    )
+    if (!this.requestClient) {
+      this.requestClient = new RequestClient(
+        this.sasjsConfig.serverUrl,
+        this.sasjsConfig.allowInsecureRequests
+      )
+    } else {
+      this.requestClient.setConfig(
+        this.sasjsConfig.serverUrl,
+        this.sasjsConfig.allowInsecureRequests
+      )
+    }
 
     this.jobsPath =
       this.sasjsConfig.serverType === ServerType.SasViya
@@ -986,7 +1000,8 @@ export default class SASjs {
     }
 
     this.fileUploader = new FileUploader(
-      this.sasjsConfig,
+      this.sasjsConfig.serverUrl,
+      this.sasjsConfig.serverType!,
       this.jobsPath,
       this.requestClient
     )

package/src/job-execution/ComputeJobExecutor.ts

@@ -35,19 +35,16 @@ export class ComputeJobExecutor extends BaseJobExecutor {
           expectWebout
         )
         .then((response) => {
-          this.appendRequest(response, sasJob, config.debug)
-
+          this.sasViyaApiClient.appendRequest(response, sasJob, config.debug)
           resolve(response.result)
         })
         .catch(async (e: Error) => {
           if (e instanceof ComputeJobExecutionError) {
-            this.appendRequest(e, sasJob, config.debug)
-
+            this.sasViyaApiClient.appendRequest(e, sasJob, config.debug)
             reject(new ErrorResponse(e?.message, e))
           }
 
           if (e instanceof LoginRequiredError) {
-            await loginCallback()
             this.appendWaitingRequest(() => {
               return this.execute(
                 sasJob,
@@ -63,6 +60,8 @@ export class ComputeJobExecutor extends BaseJobExecutor {
                 }
               )
             })
+
+            await loginCallback()
           } else {
             reject(new ErrorResponse(e?.message, e))
           }

package/src/job-execution/FileUploader.ts

@@ -0,0 +1,143 @@
+import {
+  getValidJson,
+  parseSasViyaDebugResponse,
+  parseWeboutResponse
+} from '../utils'
+import { UploadFile } from '../types/UploadFile'
+import {
+  ErrorResponse,
+  JobExecutionError,
+  LoginRequiredError
+} from '../types/errors'
+import { RequestClient } from '../request/RequestClient'
+import { ServerType } from '@sasjs/utils/types'
+import { BaseJobExecutor } from './JobExecutor'
+
+interface dataFileUpload {
+  files: UploadFile[]
+  params: { [key: string]: any } | null
+}
+
+export class FileUploader extends BaseJobExecutor {
+  constructor(
+    serverUrl: string,
+    serverType: ServerType,
+    private jobsPath: string,
+    private requestClient: RequestClient
+  ) {
+    super(serverUrl, serverType)
+  }
+
+  public async execute(
+    sasJob: string,
+    data: any,
+    config: any,
+    loginRequiredCallback?: any
+  ) {
+    const { files, params }: dataFileUpload = data
+    const loginCallback = loginRequiredCallback || (() => Promise.resolve())
+
+    if (!files?.length)
+      throw new ErrorResponse('At least one file must be provided.')
+
+    if (!sasJob || sasJob === '')
+      throw new ErrorResponse('sasJob must be provided.')
+
+    let paramsString = ''
+
+    for (let param in params)
+      if (params.hasOwnProperty(param))
+        paramsString += `&${param}=${params[param]}`
+
+    const program = config.appLoc
+      ? config.appLoc.replace(/\/?$/, '/') + sasJob.replace(/^\//, '')
+      : sasJob
+    const uploadUrl = `${this.jobsPath}/?${
+      '_program=' + program
+    }${paramsString}`
+
+    const formData = new FormData()
+
+    for (let file of files) {
+      formData.append('file', file.file, file.fileName)
+    }
+
+    const csrfToken = this.requestClient.getCsrfToken('file')
+    if (csrfToken) formData.append('_csrf', csrfToken.value)
+    if (config.debug) formData.append('_debug', '131')
+    if (config.serverType === ServerType.SasViya && config.contextName)
+      formData.append('_contextname', config.contextName)
+
+    const headers = {
+      'cache-control': 'no-cache',
+      Accept: '*/*',
+      'Content-Type': 'text/plain'
+    }
+
+    // currently only web approach is supported for file upload
+    // therefore log is part of response with debug enabled and must be parsed
+    const requestPromise = new Promise((resolve, reject) => {
+      this.requestClient
+        .post(uploadUrl, formData, undefined, 'application/json', headers)
+        .then(async (res: any) => {
+          this.requestClient.appendRequest(res, sasJob, config.debug)
+
+          let jsonResponse = res.result
+
+          if (config.debug) {
+            switch (this.serverType) {
+              case ServerType.SasViya:
+                jsonResponse = await parseSasViyaDebugResponse(
+                  res.result,
+                  this.requestClient,
+                  config.serverUrl
+                )
+                break
+              case ServerType.Sas9:
+                jsonResponse =
+                  typeof res.result === 'string'
+                    ? parseWeboutResponse(res.result, uploadUrl)
+                    : res.result
+                break
+            }
+          } else {
+            jsonResponse =
+              typeof res.result === 'string'
+                ? getValidJson(res.result)
+                : res.result
+          }
+
+          resolve(jsonResponse)
+        })
+        .catch(async (e: Error) => {
+          if (e instanceof JobExecutionError) {
+            this.requestClient!.appendRequest(e, sasJob, config.debug)
+            reject(new ErrorResponse(e?.message, e))
+          }
+
+          if (e instanceof LoginRequiredError) {
+            this.appendWaitingRequest(() => {
+              return this.execute(
+                sasJob,
+                data,
+                config,
+                loginRequiredCallback
+              ).then(
+                (res: any) => {
+                  resolve(res)
+                },
+                (err: any) => {
+                  reject(err)
+                }
+              )
+            })
+
+            await loginCallback()
+          } else {
+            reject(new ErrorResponse('File upload request failed.', e))
+          }
+        })
+    })
+    return requestPromise
+  }
+}

package/src/job-execution/JesJobExecutor.ts

@@ -28,7 +28,7 @@ export class JesJobExecutor extends BaseJobExecutor {
       this.sasViyaApiClient
         ?.executeJob(sasJob, config.contextName, config.debug, data, authConfig)
         .then((response: any) => {
-          this.appendRequest(response, sasJob, config.debug)
+          this.sasViyaApiClient.appendRequest(response, sasJob, config.debug)
 
           const responseObject = appendExtraResponseAttributes(
             response,
@@ -39,14 +39,12 @@ export class JesJobExecutor extends BaseJobExecutor {
         })
         .catch(async (e: Error) => {
           if (e instanceof JobExecutionError) {
-            this.appendRequest(e, sasJob, config.debug)
+            this.sasViyaApiClient.appendRequest(e, sasJob, config.debug)
 
             reject(new ErrorResponse(e?.message, e))
           }
 
           if (e instanceof LoginRequiredError) {
-            await loginCallback()
-
             this.appendWaitingRequest(() => {
               return this.execute(
                 sasJob,
@@ -64,6 +62,8 @@ export class JesJobExecutor extends BaseJobExecutor {
                 }
               )
             })
+
+            await loginCallback()
           } else {
             reject(new ErrorResponse(e?.message, e))
           }

package/src/job-execution/JobExecutor.ts

@@ -1,7 +1,6 @@
 import { AuthConfig, ServerType } from '@sasjs/utils/types'
-import { SASjsRequest } from '../types'
 import { ExtraResponseAttributes } from '@sasjs/utils/types'
-import { asyncForEach, parseGeneratedCode, parseSourceCode } from '../utils'
+import { asyncForEach } from '../utils'
 
 export type ExecuteFunction = () => Promise<any>
 
@@ -15,15 +14,12 @@ export interface JobExecutor {
     extraResponseAttributes?: ExtraResponseAttributes[]
   ) => Promise<any>
   resendWaitingRequests: () => Promise<void>
-  getRequests: () => SASjsRequest[]
-  clearRequests: () => void
 }
 
 export abstract class BaseJobExecutor implements JobExecutor {
   constructor(protected serverUrl: string, protected serverType: ServerType) {}
 
   private waitingRequests: ExecuteFunction[] = []
-  private requests: SASjsRequest[] = []
 
   abstract execute(
     sasJob: string,
@@ -46,54 +42,7 @@ export abstract class BaseJobExecutor implements JobExecutor {
     return
   }
 
-  getRequests = () => this.requests
-
-  clearRequests = () => {
-    this.requests = []
-  }
-
   protected appendWaitingRequest(request: ExecuteFunction) {
     this.waitingRequests.push(request)
   }
-
-  protected appendRequest(response: any, program: string, debug: boolean) {
-    let sourceCode = ''
-    let generatedCode = ''
-    let sasWork = null
-
-    if (debug) {
-      if (response?.log) {
-        sourceCode = parseSourceCode(response.log)
-        generatedCode = parseGeneratedCode(response.log)
-
-        if (response?.result) {
-          sasWork = response.result.WORK
-        } else {
-          sasWork = response.log
-        }
-      } else if (response?.result) {
-        sourceCode = parseSourceCode(response.result)
-        generatedCode = parseGeneratedCode(response.result)
-        sasWork = response.result.WORK
-      }
-    }
-
-    const stringifiedResult =
-      typeof response?.result === 'string'
-        ? response?.result
-        : JSON.stringify(response?.result, null, 2)
-
-    this.requests.push({
-      logFile: response?.log || stringifiedResult || response,
-      serviceLink: program,
-      timestamp: new Date(),
-      sourceCode,
-      generatedCode,
-      SASWORK: sasWork
-    })
-
-    if (this.requests.length > 20) {
-      this.requests.splice(0, 1)
-    }
-  }
 }

package/src/job-execution/Sas9JobExecutor.ts

@@ -45,7 +45,7 @@ export class Sas9JobExecutor extends BaseJobExecutor {
     if (data) {
       try {
         formData = generateFileUploadForm(formData, data)
-      } catch (e) {
+      } catch (e: any) {
         return Promise.reject(new ErrorResponse(e?.message, e))
       }
     }