fix(request-client): return Internal Server Error code in case of Stored Process Error

fix: handle sasjs server response

.github/workflows/build.yml

@@ -13,7 +13,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [lts/*]
+        node-version: [lts/fermium]
 
     steps:
       - uses: actions/checkout@v2

package.json

@@ -43,7 +43,7 @@
     "@types/axios": "^0.14.0",
     "@types/express": "^4.17.13",
     "@types/form-data": "^2.5.0",
-    "@types/jest": "^27.0.1",
+    "@types/jest": "^27.0.2",
     "@types/mime": "^2.0.3",
     "@types/pem": "^1.9.6",
     "@types/tough-cookie": "^4.0.1",
@@ -58,17 +58,17 @@
     "pem": "^1.14.4",
     "process": "^0.11.10",
     "rimraf": "^3.0.2",
-    "semantic-release": "^17.4.7",
+    "semantic-release": "^18.0.0",
     "terser-webpack-plugin": "^5.2.4",
     "ts-jest": "^27.0.3",
-    "ts-loader": "^9.2.2",
+    "ts-loader": "^9.2.6",
     "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.18.0",
-    "typedoc": "^0.22.3",
+    "typedoc": "0.19.2",
     "typedoc-neo-theme": "^1.1.1",
     "typedoc-plugin-external-module-name": "^4.0.6",
     "typescript": "4.3.5",
-    "webpack": "^5.52.1",
+    "webpack": "^5.56.0",
     "webpack-cli": "^4.7.2"
   },
   "main": "index.js",

src/SASjs.ts

@@ -33,6 +33,7 @@ import { LoginOptions, LoginResult } from './types/Login'
 
 const defaultConfig: SASjsConfig = {
   serverUrl: '',
+  pathSASJS: '/SASjsApi/stp/execute',
   pathSAS9: '/SASStoredProcess/do',
   pathSASViya: '/SASJobExecution',
   appLoc: '/Public/seedapp',
@@ -527,10 +528,11 @@ export default class SASjs {
 
   /**
    * Checks whether a session is active, or login is required.
+   * @param accessToken - an optional access token is required for SASjs server type.
    * @returns - a promise which resolves with an object containing two values - a boolean `isLoggedIn`, and a string `userName`.
    */
-  public async checkSession() {
+  public async checkSession(accessToken?: string) {
-    return this.authManager!.checkSession()
+    return this.authManager!.checkSession(accessToken)
   }
 
   /**
@@ -563,9 +565,10 @@ export default class SASjs {
 
   /**
    * Logs out of the configured SAS server.
+   * @param accessToken - an optional access token is required for SASjs server type.
    */
-  public logOut() {
+  public logOut(accessToken?: string) {
-    return this.authManager!.logOut()
+    return this.authManager!.logOut(accessToken)
   }
 
   /**
@@ -975,7 +978,9 @@ export default class SASjs {
     this.jobsPath =
       this.sasjsConfig.serverType === ServerType.SasViya
         ? this.sasjsConfig.pathSASViya
-        : this.sasjsConfig.pathSAS9
+        : this.sasjsConfig.serverType === ServerType.Sas9
+        ? this.sasjsConfig.pathSAS9
+        : this.sasjsConfig.pathSASJS || ''
 
     this.authManager = new AuthManager(
       this.sasjsConfig.serverUrl,
@@ -1044,6 +1049,7 @@ export default class SASjs {
       this.sasjsConfig.serverUrl,
       this.sasjsConfig.serverType!,
       this.jobsPath,
+      this.requestClient,
       this.sasjsConfig.httpsAgentOptions
     )
 

src/auth/AuthManager.ts

@@ -21,7 +21,9 @@ export class AuthManager {
     this.logoutUrl =
       this.serverType === ServerType.Sas9
         ? '/SASLogon/logout?'
-        : '/SASLogon/logout.do?'
+        : this.serverType === ServerType.SasViya
+        ? '/SASLogon/logout.do?'
+        : '/SASjsApi/auth/logout'
   }
 
   /**
@@ -180,20 +182,21 @@ export class AuthManager {
 
   /**
    * Checks whether a session is active, or login is required.
+   * @param accessToken - an optional access token is required for SASjs server type.
    * @returns - a promise which resolves with an object containing three values
    *  - a boolean `isLoggedIn`
    *  - a string `userName` and
    *  - a form `loginForm` if not loggedin.
    */
-  public async checkSession(): Promise<{
+  public async checkSession(accessToken?: string): Promise<{
     isLoggedIn: boolean
     userName: string
     loginForm?: any
   }> {
-    const { isLoggedIn, userName } = await this.fetchUserName()
+    const { isLoggedIn, userName } = await this.fetchUserName(accessToken)
     let loginForm = null
 
-    if (!isLoggedIn) {
+    if (!isLoggedIn && this.serverType !== ServerType.Sasjs) {
       //We will logout to make sure cookies are removed and login form is presented
       //Residue can happen in case of session expiration
       await this.logOut()
@@ -218,19 +221,20 @@ export class AuthManager {
     return await this.getLoginForm(formResponse)
   }
 
-  private async fetchUserName(): Promise<{
+  private async fetchUserName(accessToken?: string): Promise<{
     isLoggedIn: boolean
     userName: string
   }> {
-    //For VIYA we will send request on API endpoint. Which is faster then pinging SASJobExecution.
-    //For SAS9 we will send request on SASStoredProcess
     const url =
       this.serverType === ServerType.SasViya
         ? `${this.serverUrl}/identities/users/@currentUser`
-        : `${this.serverUrl}/SASStoredProcess`
+        : this.serverType === ServerType.Sas9
+        ? `${this.serverUrl}/SASStoredProcess`
+        : `${this.serverUrl}/SASjsApi/session`
 
+    // Access token is required for server type `SASjs`
     const { result: loginResponse } = await this.requestClient
-      .get<string>(url, undefined, 'text/plain')
+      .get<string>(url, accessToken, 'text/plain')
       .catch((err: any) => {
         return { result: 'authErr' }
       })
@@ -256,7 +260,12 @@ export class AuthManager {
           .split(' ')
           .map((name: string) => name.slice(0, 3).toLowerCase())
           .join('')
+
+      case ServerType.Sasjs:
+        return response?.username
+
       default:
+        console.error('Server Type not found in extractUserName function')
         return ''
     }
   }
@@ -304,8 +313,12 @@ export class AuthManager {
 
   /**
    * Logs out of the configured SAS server.
+   * @param accessToken - an optional access token is required for SASjs server type.
    */
-  public logOut() {
+  public logOut(accessToken?: string) {
+    if (this.serverType === ServerType.Sasjs) {
+      return this.requestClient.post(this.logoutUrl, undefined, accessToken)
+    }
     this.requestClient.clearCsrfTokens()
     return this.requestClient.get(this.logoutUrl, undefined).then(() => true)
   }

src/job-execution/Sas9JobExecutor.ts

@@ -5,6 +5,7 @@ import { ErrorResponse } from '../types/errors'
 import { convertToCSV, isRelativePath } from '../utils'
 import { BaseJobExecutor } from './JobExecutor'
 import { Sas9RequestClient } from '../request/Sas9RequestClient'
+import { RequestClient } from '../request/RequestClient'
 
 /**
  * Job executor for SAS9 servers for use in Node.js environments.
@@ -13,15 +14,16 @@ import { Sas9RequestClient } from '../request/Sas9RequestClient'
  * job execution requests.
  */
 export class Sas9JobExecutor extends BaseJobExecutor {
-  private requestClient: Sas9RequestClient
+  private sas9RequestClient: Sas9RequestClient
   constructor(
     serverUrl: string,
     serverType: ServerType,
     private jobsPath: string,
+    private requestClient: RequestClient,
     httpsAgentOptions?: https.AgentOptions
   ) {
     super(serverUrl, serverType)
-    this.requestClient = new Sas9RequestClient(serverUrl, httpsAgentOptions)
+    this.sas9RequestClient = new Sas9RequestClient(serverUrl, httpsAgentOptions)
   }
 
   async execute(sasJob: string, data: any, config: any) {
@@ -37,6 +39,8 @@ export class Sas9JobExecutor extends BaseJobExecutor {
         : ''
     }`
 
+    apiUrl = `${apiUrl}${config.debug ? '&_debug=131' : ''}`
+
     let requestParams = {
       ...this.getRequestParams(config)
     }
@@ -49,6 +53,8 @@ export class Sas9JobExecutor extends BaseJobExecutor {
       } catch (e: any) {
         return Promise.reject(new ErrorResponse(e?.message, e))
       }
+    } else {
+      data = ''
     }
 
     for (const key in requestParams) {
@@ -57,16 +63,18 @@ export class Sas9JobExecutor extends BaseJobExecutor {
       }
     }
 
-    await this.requestClient.login(
+    await this.sas9RequestClient.login(
       config.username,
       config.password,
       this.jobsPath
     )
+
     const contentType =
       data && Object.keys(data).length
         ? 'multipart/form-data; boundary=' + (formData as any)._boundary
         : 'text/plain'
-    return await this.requestClient!.post(
+
+    return await this.sas9RequestClient!.post(
       apiUrl,
       formData,
       undefined,
@@ -76,6 +84,28 @@ export class Sas9JobExecutor extends BaseJobExecutor {
         Connection: 'Keep-Alive'
       }
     )
+      .then((res: any) => {
+        let resString = res
+
+        if (typeof res === 'object') {
+          resString = JSON.stringify(res)
+        }
+
+        this.requestClient!.appendRequest(resString, sasJob, config.debug)
+
+        return res
+      })
+      .catch((err: any) => {
+        let errString = err
+
+        if (typeof err === 'object') {
+          errString = JSON.stringify(errString)
+        }
+
+        this.requestClient!.appendRequest(errString, sasJob, config.debug)
+
+        return err
+      })
   }
 
   private getRequestParams(config: any): any {

src/job-execution/WebJobExecutor.ts

@@ -15,7 +15,8 @@ import { SASViyaApiClient } from '../SASViyaApiClient'
 import {
   isRelativePath,
   parseSasViyaDebugResponse,
-  appendExtraResponseAttributes
+  appendExtraResponseAttributes,
+  getValidJson
 } from '../utils'
 import { BaseJobExecutor } from './JobExecutor'
 import { parseWeboutResponse } from '../utils/parseWeboutResponse'
@@ -113,6 +114,7 @@ export class WebJobExecutor extends BaseJobExecutor {
       const stringifiedData = JSON.stringify(data)
       if (
         config.serverType === ServerType.Sas9 ||
+        config.serverType === ServerType.Sasjs ||
         stringifiedData.length > 500000 ||
         stringifiedData.includes(';')
       ) {
@@ -142,12 +144,25 @@ export class WebJobExecutor extends BaseJobExecutor {
     }
 
     const requestPromise = new Promise((resolve, reject) => {
-      this.requestClient!.post(apiUrl, formData, undefined)
+      // Access token is required for server type `SASjs`
+      this.requestClient!.post(apiUrl, formData, authConfig?.access_token)
         .then(async (res: any) => {
-          this.requestClient!.appendRequest(res, sasJob, config.debug)
+          const resObj =
+            this.serverType === ServerType.Sasjs
+              ? {
+                  result: res.result._webout,
+                  log: res.result.log
+                }
+              : res
+          this.requestClient!.appendRequest(resObj, sasJob, config.debug)
 
           let jsonResponse = res.result
 
+          if (this.serverType === ServerType.Sasjs) {
+            const webout = parseWeboutResponse(res.result._webout, apiUrl)
+            jsonResponse = getValidJson(webout)
+          }
+
           if (config.debug) {
             switch (this.serverType) {
               case ServerType.SasViya:

src/request/RequestClient.ts

@@ -627,7 +627,7 @@ const parseError = (data: string) => {
       if (parts.length > 1) {
         const log = parts[1].split('<pre>')[1].split('</pre>')[0]
         const message = `This request completed with errors.`
-        return new JobExecutionError(404, message, log)
+        return new JobExecutionError(500, message, log)
       }
     }
   } catch (_) {}

src/types/SASjsConfig.ts

@@ -12,6 +12,11 @@ export class SASjsConfig {
    * streamed.
    */
   serverUrl: string = ''
+  /**
+   * The location of the STP Process Web Application.  By default the adapter
+   * will use '/SASjsApi/stp/execute' on SAS JS.
+   */
+  pathSASJS?: string = ''
   /**
    * The location of the Stored Process Web Application.  By default the adapter
    * will use '/SASStoredProcess/do' on SAS 9.

src/utils/getValidJson.ts

@@ -4,7 +4,7 @@ import { JsonParseArrayError, InvalidJsonError } from '../types/errors'
  * if string passed then parse the string to json else if throw error for all other types unless it is not a valid json object.
  * @param str - string to check.
  */
-export const getValidJson = (str: string | object) => {
+export const getValidJson = (str: string | object): object => {
   try {
     if (str === null || str === undefined) throw new InvalidJsonError()
 

src/utils/parseWeboutResponse.ts

@@ -1,6 +1,6 @@
 import { WeboutResponseError } from '../types/errors'
 
-export const parseWeboutResponse = (response: string, url?: string) => {
+export const parseWeboutResponse = (response: string, url?: string): string => {
   let sasResponse = ''
 
   if (response.includes('>>weboutBEGIN<<')) {