Merge branch 'master' into snyk-upgrade-f3e7f573ad5222a75980dcffc4381458

sasjs server type - request and job execution auth fix

package-lock.json

@@ -8,7 +8,7 @@
       "hasInstallScript": true,
       "license": "ISC",
       "dependencies": {
-        "@sasjs/utils": "2.42.0",
+        "@sasjs/utils": "2.44.0",
         "axios": "0.26.0",
         "axios-cookiejar-support": "1.0.1",
         "form-data": "4.0.0",
@@ -1142,9 +1142,9 @@
       }
     },
     "node_modules/@sasjs/utils": {
-      "version": "2.42.0",
-      "resolved": "https://registry.npmjs.org/@sasjs/utils/-/utils-2.42.0.tgz",
-      "integrity": "sha512-Y69l89PYNF/h9xvVH72om/39xA+cY80bhiVLzp/fJb3BlvzCf4RNswBBanUOv2I5JNa7gPpJuE7mEiXOlhD3eg==",
+      "version": "2.44.0",
+      "resolved": "https://registry.npmjs.org/@sasjs/utils/-/utils-2.44.0.tgz",
+      "integrity": "sha512-hpC4erHYA8Mcb38mzxFEP0cXehfa0iKeqSW2d9MmxZ9g2qpy0BU6xyZJohN9kOiafXo5H359ndNKsg4DOq5YgA==",
       "hasInstallScript": true,
       "dependencies": {
         "@types/fs-extra": "9.0.13",
@@ -13870,9 +13870,9 @@
       }
     },
     "@sasjs/utils": {
-      "version": "2.42.0",
-      "resolved": "https://registry.npmjs.org/@sasjs/utils/-/utils-2.42.0.tgz",
-      "integrity": "sha512-Y69l89PYNF/h9xvVH72om/39xA+cY80bhiVLzp/fJb3BlvzCf4RNswBBanUOv2I5JNa7gPpJuE7mEiXOlhD3eg==",
+      "version": "2.44.0",
+      "resolved": "https://registry.npmjs.org/@sasjs/utils/-/utils-2.44.0.tgz",
+      "integrity": "sha512-hpC4erHYA8Mcb38mzxFEP0cXehfa0iKeqSW2d9MmxZ9g2qpy0BU6xyZJohN9kOiafXo5H359ndNKsg4DOq5YgA==",
       "requires": {
         "@types/fs-extra": "9.0.13",
         "@types/prompts": "2.0.13",

package.json

@@ -72,7 +72,7 @@
   },
   "main": "index.js",
   "dependencies": {
-    "@sasjs/utils": "2.42.0",
+    "@sasjs/utils": "2.44.0",
     "axios": "0.26.0",
     "axios-cookiejar-support": "1.0.1",
     "form-data": "4.0.0",

sasjs-tests/README.md

@@ -65,7 +65,7 @@ The below services need to be created on your SAS server, at the location specif
 ```sas
 filename mc url "https://raw.githubusercontent.com/sasjs/core/main/all.sas";
 %inc mc;
-filename ft15f001 temp;
+filename ft15f001 temp lrecl=1000;
 parmcards4;
   %webout(FETCH)
   %webout(OPEN)
@@ -113,7 +113,7 @@ data _null_;
 ```sas
 filename mc url "https://raw.githubusercontent.com/sasjs/core/main/all.sas";
 %inc mc;
-filename ft15f001 temp;
+filename ft15f001 temp lrecl=1000;
 parmcards4;
   %webout(FETCH)
   %webout(OPEN)

src/SASViyaApiClient.ts

@@ -11,7 +11,11 @@ import {
   JobDefinition,
   PollOptions
 } from './types'
-import { JobExecutionError, RootFolderNotFoundError } from './types/errors'
+import {
+  CertificateError,
+  JobExecutionError,
+  RootFolderNotFoundError
+} from './types/errors'
 import { SessionManager } from './SessionManager'
 import { ContextManager } from './ContextManager'
 import { SasAuthResponse, MacroVar, AuthConfig } from '@sasjs/utils/types'
@@ -878,7 +882,8 @@ export class SASViyaApiClient {
 
     const { result: folder } = await this.requestClient
       .get<Folder>(`${this.serverUrl}${url}`, accessToken)
-      .catch(() => {
+      .catch((err) => {
+        if (err instanceof CertificateError) throw err
         return { result: null }
       })
 
@@ -899,7 +904,8 @@ export class SASViyaApiClient {
 
     const { result: folder } = await this.requestClient
       .get<Folder>(`${this.serverUrl}${url}`, accessToken)
-      .catch(() => {
+      .catch((err) => {
+        if (err instanceof CertificateError) throw err
         return { result: null }
       })
 

src/SASjs.ts

@@ -77,7 +77,7 @@ export default class SASjs {
   }
 
   /**
-   * Executes code against a SAS 9 server.  Requires a runner to be present in
+   * Executes SAS code on a SAS 9 server.  Requires a runner to be present in
    * the users home directory in metadata.
    * @param linesOfCode - lines of sas code from the file to run.
    * @param username - a string representing the username.
@@ -97,6 +97,17 @@ export default class SASjs {
     )
   }
 
+  /**
+   * Executes SAS code on a SASJS server
+   * @param code - a string of code from the file to run.
+   * @param authConfig - (optional) a valid client, secret, refresh and access tokens that are authorised to execute scripts.
+   */
+  public async executeScriptSASjs(code: string, authConfig?: AuthConfig) {
+    this.isMethodSupported('executeScriptSASJS', [ServerType.Sasjs])
+
+    return await this.sasJSApiClient?.executeScript(code, authConfig)
+  }
+
   /**
    * Executes sas code in a SAS Viya compute session.
    * @param fileName - name of the file to run. It will be converted to path to the file being submitted for execution.
@@ -905,8 +916,8 @@ export default class SASjs {
     return await this.sasJSApiClient?.deploy(dataJson, appLoc, authConfig)
   }
 
-  public async executeJobSASjs(query: ExecutionQuery) {
-    return await this.sasJSApiClient?.executeJob(query)
+  public async executeJobSASjs(query: ExecutionQuery, authConfig?: AuthConfig) {
+    return await this.sasJSApiClient?.executeJob(query, authConfig)
   }
 
   /**

src/SASjsApiClient.ts

@@ -43,7 +43,9 @@ export class SASjsApiClient {
     return Promise.resolve(result)
   }
 
-  public async executeJob(query: ExecutionQuery) {
+  public async executeJob(query: ExecutionQuery, authConfig?: AuthConfig) {
+    const access_token = authConfig ? authConfig.access_token : undefined
+
     const { result } = await this.requestClient.post<{
       status: string
       message: string
@@ -51,7 +53,7 @@ export class SASjsApiClient {
       logPath?: string
       error?: {}
       _webout?: string
-    }>('SASjsApi/stp/execute', query, undefined)
+    }>('SASjsApi/stp/execute', query, access_token)
 
     if (Object.keys(result).includes('_webout')) {
       result._webout = parseWeboutResponse(result._webout!)
@@ -60,6 +62,39 @@ export class SASjsApiClient {
     return Promise.resolve(result)
   }
 
+  /**
+   * Executes code on a SASJS server.
+   * @param code - a string of code to execute.
+   * @param authConfig - an object for authentication.
+   */
+  public async executeScript(code: string, authConfig?: AuthConfig) {
+    let access_token = (authConfig || {}).access_token
+    if (authConfig) {
+      ;({ access_token } = await getTokens(
+        this.requestClient,
+        authConfig,
+        ServerType.Sasjs
+      ))
+    }
+
+    let parsedSasjsServerLog = ''
+
+    await this.requestClient
+      .post('SASjsApi/code/execute', { code }, access_token)
+      .then((res: any) => {
+        if (res.result?.log) {
+          parsedSasjsServerLog = res.result.log
+            .map((logLine: any) => logLine.line)
+            .join('\n')
+        }
+      })
+      .catch((err) => {
+        parsedSasjsServerLog = err
+      })
+
+    return parsedSasjsServerLog
+  }
+
   /**
    * Exchanges the auth code for an access token for the given client.
    * @param clientId - the client ID to authenticate with.

src/auth/getAccessTokenForViya.ts

@@ -1,6 +1,7 @@
 import { SasAuthResponse } from '@sasjs/utils/types'
 import { prefixMessage } from '@sasjs/utils/error'
 import { RequestClient } from '../request/RequestClient'
+import { CertificateError } from '../types/errors'
 
 /**
  * Exchanges the auth code for an access token for the given client.
@@ -36,6 +37,7 @@ export async function getAccessTokenForViya(
     .post(url, data, undefined, 'application/x-www-form-urlencoded', headers)
     .then((res) => res.result as SasAuthResponse)
     .catch((err) => {
+      if (err instanceof CertificateError) throw err
       throw prefixMessage(err, 'Error while getting access token. ')
     })
 

src/job-execution/WebJobExecutor.ts

@@ -21,6 +21,7 @@ import {
 } from '../utils'
 import { BaseJobExecutor } from './JobExecutor'
 import { parseWeboutResponse } from '../utils/parseWeboutResponse'
+import { Server } from 'https'
 
 export interface WaitingRequstPromise {
   promise: Promise<any> | null
@@ -46,7 +47,7 @@ export class WebJobExecutor extends BaseJobExecutor {
     authConfig?: AuthConfig,
     extraResponseAttributes: ExtraResponseAttributes[] = []
   ) {
-    const loginCallback = loginRequiredCallback || (() => Promise.resolve())
+    const loginCallback = loginRequiredCallback
     const program = isRelativePath(sasJob)
       ? config.appLoc
         ? config.appLoc.replace(/\/?$/, '/') + sasJob.replace(/^\//, '')
@@ -79,7 +80,7 @@ export class WebJobExecutor extends BaseJobExecutor {
               )
             })
 
-            await loginCallback()
+            if (loginCallback) await loginCallback()
           } else {
             reject(new ErrorResponse(e?.message, e))
           }
@@ -220,6 +221,15 @@ export class WebJobExecutor extends BaseJobExecutor {
           }
 
           if (e instanceof LoginRequiredError) {
+            if (!loginRequiredCallback) {
+              reject(
+                new ErrorResponse(
+                  'Request is not authenticated. Make sure .env file exists with valid credentials.',
+                  e
+                )
+              )
+            }
+
             this.appendWaitingRequest(() => {
               return this.execute(
                 sasJob,
@@ -238,7 +248,7 @@ export class WebJobExecutor extends BaseJobExecutor {
               )
             })
 
-            await loginCallback()
+            if (loginCallback) await loginCallback()
           } else {
             reject(new ErrorResponse(e?.message, e))
           }

src/request/RequestClient.ts

@@ -7,7 +7,8 @@ import {
   LoginRequiredError,
   NotFoundError,
   InternalServerError,
-  JobExecutionError
+  JobExecutionError,
+  CertificateError
 } from '../types/errors'
 import { SASjsRequest } from '../types'
 import { parseWeboutResponse } from '../utils/parseWeboutResponse'
@@ -517,6 +518,10 @@ export class RequestClient implements HttpClient {
       else return
     }
 
+    if (e.isAxiosError && e.code === 'UNABLE_TO_VERIFY_LEAF_SIGNATURE') {
+      throw new CertificateError(e.message)
+    }
+
     if (e.message) throw e
     else throw prefixMessage(e, 'Error while handling error. ')
   }

src/test/utils/formatDataForRequest.spec.ts

@@ -62,7 +62,7 @@ describe('formatDataForRequest', () => {
 
     expect(() => formatDataForRequest(tableWithMissingValues)).toThrow(
       new Error(
-        'Special missing value can only be a single character from A to Z or _'
+        `A Special missing value can only be a single character from 'A' to 'Z', '_', '.[a-z]', '._'`
       )
     )
   })

src/types/errors/CertificateError.ts

@@ -0,0 +1,12 @@
+const instructionsToFix =
+  'https://github.com/sasjs/cli/issues/1181#issuecomment-1090638584'
+
+export class CertificateError extends Error {
+  constructor(message: string) {
+    super(
+      `${message}\nPlease visit the link below for further information on this issue:\n- ${instructionsToFix}\n`
+    )
+    this.name = 'CertificateError'
+    Object.setPrototypeOf(this, CertificateError.prototype)
+  }
+}

src/types/errors/index.ts

@@ -1,13 +1,14 @@
 export * from './AuthorizeError'
+export * from './CertificateError'
 export * from './ComputeJobExecutionError'
+export * from './ErrorResponse'
 export * from './InternalServerError'
+export * from './InvalidJsonError'
 export * from './JobExecutionError'
 export * from './JobStatePollError'
-export * from './LoginRequiredError'
-export * from './NotFoundError'
-export * from './ErrorResponse'
-export * from './NoSessionStateError'
-export * from './RootFolderNotFoundError'
 export * from './JsonParseArrayError'
+export * from './LoginRequiredError'
+export * from './NoSessionStateError'
+export * from './NotFoundError'
+export * from './RootFolderNotFoundError'
 export * from './WeboutResponseError'
-export * from './InvalidJsonError'

src/utils/convertToCsv.ts

@@ -1,3 +1,5 @@
+import { isSpecialMissing } from '@sasjs/utils'
+
 /**
  * Converts the given JSON object array to a CSV string.
  * @param data - the array of JSON objects to convert.
@@ -18,7 +20,6 @@ export const convertToCSV = (
   let headers: string[] = []
   let csvTest
   let invalidString = false
-  const specialMissingValueRegExp = /^[a-z_]{1}$/i
 
   if (formats) {
     headers = Object.keys(formats).map((key) => `${key}:${formats![key]}`)
@@ -36,7 +37,7 @@ export const convertToCSV = (
           hasNullOrNumber = true
         } else if (
           typeof row[field] === 'string' &&
-          specialMissingValueRegExp.test(row[field])
+          isSpecialMissing(row[field])
         ) {
           hasSpecialMissingString = true
         }
@@ -130,10 +131,9 @@ export const convertToCSV = (
       value = currentCell === null ? '' : currentCell
 
       if (formats && formats[fieldName] === 'best.') {
-        if (value && !specialMissingValueRegExp.test(value)) {
-          console.log(`🤖[value]🤖`, value)
+        if (value && !isSpecialMissing(value)) {
           throw new Error(
-            'Special missing value can only be a single character from A to Z or _'
+            `A Special missing value can only be a single character from 'A' to 'Z', '_', '.[a-z]', '._'`
           )
         }