Merge pull request #432 from sasjs/job-refresh-tokens

fix(job-execution): refresh access token if it has expired during job status checks

.git-hooks/commit-msg

@@ -6,7 +6,7 @@ GREEN="\033[1;32m"
 # temporary file which holds the message).
 commit_message=$(cat "$1")
 
-if (echo "$commit_message" | grep -Eq "^(build|chore|ci|docs|feat|fix|perf|refactor|revert|style|test)(\([a-z0-9 \-]+\))?!?: .+$") then
+if (echo "$commit_message" | grep -Eq "^(build|chore|ci|docs|feat|fix|perf|refactor|revert|style|test)(\([a-z0-9 \-\*]+\))?!?: .+$") then
    echo "${GREEN} ✔ Commit message meets Conventional Commit standards"
    exit 0
 fi

.github/reviewer-lottery.yml

@@ -7,3 +7,8 @@ groups:
       - saadjutt01
       - medjedovicm
       - allanbowe
+      - sabhas
+  - name: SASjs QA
+    reviewers: 1
+    usernames:
+      - VladislavParhomchik

PULL_REQUEST_TEMPLATE.md

@@ -12,6 +12,8 @@ What code changes have been made to achieve the intent.
 
 ## Checks
 
+No PR (that involves a non-trivial code change) should be merged, unless all four of the items below are confirmed!  If an urgent fix is needed - use a tar file.
+
 - [ ] Code is formatted correctly (`npm run lint:fix`).
 - [ ] All unit tests are passing (`npm test`).
 - [ ] All `sasjs-cli` unit tests are passing (`npm test`).

README.md

@@ -172,35 +172,39 @@ Configuration on the client side involves passing an object on startup, which ca
 * `serverType` - either `SAS9` or `SASVIYA`.
 * `serverUrl` - the location (including http protocol and port) of the SAS Server. Can be omitted, eg if serving directly from the SAS Web Server, or in streaming mode.
 * `debug` - if `true` then SAS Logs and extra debug information is returned.
-* `useComputeApi` - if `true` and the serverType is `SASVIYA` then the REST APIs will be called directly (rather than using the JES web service).
-* `contextName` - if missing or blank, and `useComputeApi` is `true` and `serverType` is `SASVIYA` then the JES API will be used.
+* `useComputeApi` - Only relevant when the serverType is `SASVIYA`. If `true` the [Compute API](#using-the-compute-api) is used.  If `false` the [JES API](#using-the-jes-api) is used.  If `null` or `undefined` the [Web](#using-jes-web-app) approach is used.  
+* `contextName` - Compute context on which the requests will be called.  If missing or not provided, defaults to `Job Execution Compute context`.
 
 The adapter supports a number of approaches for interfacing with Viya (`serverType` is `SASVIYA`).  For maximum performance, be sure to [configure your compute context](https://sasjs.io/guide-viya/#shared-account-and-server-re-use) with `reuseServerProcesses` as `true` and a system account in `runServerAs`.  This functionality is available since Viya 3.5.  This configuration is supported when [creating contexts using the CLI](https://sasjs.io/sasjs-cli-context/#sasjs-context-create).
 
 ### Using JES Web App
 
-In this setup, all requests are routed through the JES web app, at `YOURSERVER/SASJobExecution`.  This is the most reliable method, and also the slowest.  One request is made to the JES app, and remaining requests (getting job uri, session spawning, passing parameters, running the program, fetching the log) are made on the SAS server by the JES app.
-
-```
-{
-  appLoc:"/Your/Path",
-  serverType:"SASVIYA"
-}
-```
-
-### Using the JES API
-Here we are running Jobs using the Job Execution Service except this time we are making the requests directly using the REST API instead of through the JES Web App.  This is helpful when we need to call web services outside of a browser (eg with the SASjs CLI or other commandline tools).  To save one network request, the adapter prefetches the JOB URIs and passes them in the `__job` parameter.
+In this setup, all requests are routed through the JES web app, at `YOURSERVER/SASJobExecution?_program=/your/program`.  This is the most reliable method, and also the slowest.  One request is made to the JES app, and remaining requests (getting job uri, session spawning, passing parameters, running the program, fetching the log) are handled by the SAS server inside the JES app.
 
 ```
 {
   appLoc:"/Your/Path",
   serverType:"SASVIYA",
-  useComputeApi: true
+  contextName: 'yourComputeContext'
+}
+```
+
+Note - to use the web approach, the `useComputeApi` property must be `undefined` or `null`.
+
+### Using the JES API
+Here we are running Jobs using the Job Execution Service except this time we are making the requests directly using the REST API instead of through the JES Web App.  This is helpful when we need to call web services outside of a browser (eg with the SASjs CLI or other commandline tools).  To save one network request, the adapter prefetches the JOB URIs and passes them in the `__job` parameter.  Depending on your network bandwidth, it may or may not be faster than the JES Web approach.
+
+```
+{
+  appLoc:"/Your/Path",
+  serverType:"SASVIYA",
+  useComputeApi: false,
+  contextName: 'yourComputeContext'
 }
 ```
 
 ### Using the Compute API
-This approach is by far the fastest, as a result of the optimisations we have built into the adapter.  With this configuration, in the first sasjs request, we take a URI map of the services in the target folder, and create a session manager - which spawns an extra session.  The next time a request is made, the adapter will use the 'hot' session.  Sessions are deleted after every use, which actually makes this _less_ resource intensive than a typical JES web app, in which all sessions are kept alive by default for 15 minutes.
+This approach is by far the fastest, as a result of the optimisations we have built into the adapter.  With this configuration, in the first sasjs request, we take a URI map of the services in the target folder, and create a session manager.  This manager will spawn a additional session every time a request is made. Subsequent requests will use the existing 'hot' session, if it exists.  Sessions are always deleted after every use, which actually makes this _less_ resource intensive than a typical JES web app, in which all sessions are kept alive by default for 15 minutes.
 
 ```
 {
@@ -225,4 +229,4 @@ If you are a SAS 9 or SAS Viya customer you can also request a copy of [Data Con
 
 If you find this library useful, help us grow our star graph!
 
-![](https://starchart.cc/sasjs/adapter.svg)
+![](https://starchart.cc/sasjs/adapter.svg)

package.json

@@ -6,8 +6,8 @@
     "build": "rimraf build && rimraf node && mkdir node && cp -r src/* node && webpack && rimraf build/src && rimraf node",
     "package:lib": "npm run build && cp ./package.json build && cd build && npm version \"5.0.0\" && npm pack",
     "publish:lib": "npm run build && cd build && npm publish",
-    "lint:fix": "npx prettier --write 'src/**/*.{ts,tsx,js,jsx,html,css,sass,less,json,yml,md,graphql}' && npx prettier --write 'sasjs-tests/src/**/*.{ts,tsx,js,jsx,html,css,sass,less,json,yml,md,graphql}'",
-    "lint": "npx prettier --check 'src/**/*.{ts,tsx,js,jsx,html,css,sass,less,json,yml,md,graphql}' && npx prettier --check 'sasjs-tests/src/**/*.{ts,tsx,js,jsx,html,css,sass,less,json,yml,md,graphql}'",
+    "lint:fix": "npx prettier --write \"src/**/*.{ts,tsx,js,jsx,html,css,sass,less,json,yml,md,graphql}\" && npx prettier --write \"sasjs-tests/src/**/*.{ts,tsx,js,jsx,html,css,sass,less,json,yml,md,graphql}\"",
+    "lint": "npx prettier --check \"src/**/*.{ts,tsx,js,jsx,html,css,sass,less,json,yml,md,graphql}\" && npx prettier --check \"sasjs-tests/src/**/*.{ts,tsx,js,jsx,html,css,sass,less,json,yml,md,graphql}\"",
     "test": "jest --silent --coverage",
     "prepublishOnly": "cp -r ./build/* . && rm -rf ./build",
     "postpublish": "git clean -fd",
@@ -43,32 +43,33 @@
     "@types/tough-cookie": "^4.0.0",
     "cp": "^0.2.0",
     "dotenv": "^10.0.0",
-    "jest": "^27.0.4",
+    "jest": "^27.0.6",
     "jest-extended": "^0.11.5",
     "mime": "^2.5.2",
     "path": "^0.12.7",
     "process": "^0.11.10",
     "rimraf": "^3.0.2",
-    "semantic-release": "^17.4.3",
-    "terser-webpack-plugin": "^5.1.3",
+    "semantic-release": "^17.4.4",
+    "terser-webpack-plugin": "^5.1.4",
     "ts-jest": "^27.0.3",
     "ts-loader": "^9.2.2",
     "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.18.0",
-    "typedoc": "^0.20.36",
+    "typedoc": "^0.21.2",
     "typedoc-neo-theme": "^1.1.1",
     "typedoc-plugin-external-module-name": "^4.0.6",
-    "typescript": "^4.3.2",
-    "webpack": "^5.38.1",
+    "typescript": "^4.3.4",
+    "webpack": "^5.41.1",
     "webpack-cli": "^4.7.2"
   },
   "main": "index.js",
   "dependencies": {
-    "@sasjs/utils": "^2.20.1",
+    "@sasjs/utils": "^2.21.0",
     "axios": "^0.21.1",
     "axios-cookiejar-support": "^1.0.1",
     "form-data": "^4.0.0",
     "https": "^1.0.0",
+    "jwt-decode": "^3.1.2",
     "tough-cookie": "^4.0.0",
     "url": "^0.11.0"
   }

sasjs-tests/README.md

@@ -6,7 +6,7 @@ When developing on `@sasjs/adapter`, it's good practice to run the test suite ag
 
 You can use the provided `update:adapter` NPM script for this.
 
-```
+```bash
     npm run update:adapter
 ```
 
@@ -37,7 +37,7 @@ To be able to run the `deploy` script, two environment variables need to be set:
 
 So you can run the script like so:
 
-```
+```bash
 SSH_ACCOUNT=me@my-sas-server.com DEPLOY_PATH=/var/www/html/my-folder/sasjs-tests npm run deploy
 ```
 
@@ -49,8 +49,7 @@ The below services need to be created on your SAS server, at the location specif
 
 ### SAS 9
 
-```
-
+```sas
 filename mc url "https://raw.githubusercontent.com/sasjs/core/main/all.sas";
 %inc mc;
 filename ft15f001 temp;
@@ -76,11 +75,20 @@ parmcards4;
 let he who hath understanding, reckon the number of the beast
 ;;;;
 %mm_createwebservice(path=/Public/app/common,name=makeErr)
+parmcards4;
+%webout(OPEN)
+data _null_;
+  file _webout;
+  put ' the discovery channel ';
+ run;
+%webout(CLOSE)
+;;;;
+%mm_createwebservice(path=/Public/app/common,name=invalidJSON)
 ```
 
 ### SAS Viya
 
-```
+```sas
 filename mc url "https://raw.githubusercontent.com/sasjs/core/main/all.sas";
 %inc mc;
 filename ft15f001 temp;
@@ -119,6 +127,15 @@ If you can trust yourself when all men doubt you,
     But make allowance for their doubting too;
 ;;;;
 %mp_createwebservice(path=/Public/app/common,name=makeErr)
+parmcards4;
+%webout(OPEN)
+data _null_;
+  file _webout;
+  put ' the discovery channel ';
+ run;
+%webout(CLOSE)
+;;;;
+%mp_createwebservice(path=/Public/app/common,name=invalidJSON)
 ```
 
 You should now be able to access the tests in your browser at the deployed path on your server.

sasjs-tests/src/testSuites/Basic.ts

@@ -161,16 +161,12 @@ export const basicTests = (
           config,
           undefined,
           undefined,
-          ['output', 'file', 'data']
+          ['file', 'data']
         )
       },
       assertion: (response: any) => {
         const responseKeys: any = Object.keys(response)
-        return (
-          responseKeys.includes('file') &&
-          responseKeys.includes('output') &&
-          responseKeys.includes('data')
-        )
+        return responseKeys.includes('file') && responseKeys.includes('data')
       }
     }
   ]

sasjs-tests/src/testSuites/Compute.ts

@@ -25,7 +25,7 @@ export const computeTests = (adapter: SASjs): TestSuite => ({
           '/Public/app/common/sendArr',
           data,
           {},
-          '',
+          undefined,
           true
         )
       },

sasjs-tests/src/testSuites/RequestData.ts

@@ -176,11 +176,59 @@ export const sendObjTests = (adapter: SASjs): TestSuite => ({
   name: 'sendObj',
   tests: [
     {
-      title: 'Invalid column name',
+      title: 'Table name starts with numeric',
       description: 'Should throw an error',
       test: async () => {
         const invalidData: any = {
-          '1 invalid table': [{ col1: 42 }]
+          '1InvalidTable': [{ col1: 42 }]
+        }
+        return adapter.request('common/sendObj', invalidData).catch((e) => e)
+      },
+      assertion: (error: any) =>
+        !!error && !!error.error && !!error.error.message
+    },
+    {
+      title: 'Table name contains a space',
+      description: 'Should throw an error',
+      test: async () => {
+        const invalidData: any = {
+          'an invalidTable': [{ col1: 42 }]
+        }
+        return adapter.request('common/sendObj', invalidData).catch((e) => e)
+      },
+      assertion: (error: any) =>
+        !!error && !!error.error && !!error.error.message
+    },
+    {
+      title: 'Table name contains a special character',
+      description: 'Should throw an error',
+      test: async () => {
+        const invalidData: any = {
+          'anInvalidTable#': [{ col1: 42 }]
+        }
+        return adapter.request('common/sendObj', invalidData).catch((e) => e)
+      },
+      assertion: (error: any) =>
+        !!error && !!error.error && !!error.error.message
+    },
+    {
+      title: 'Table name exceeds max length of 32 characters',
+      description: 'Should throw an error',
+      test: async () => {
+        const invalidData: any = {
+          xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx: [{ col1: 42 }]
+        }
+        return adapter.request('common/sendObj', invalidData).catch((e) => e)
+      },
+      assertion: (error: any) =>
+        !!error && !!error.error && !!error.error.message
+    },
+    {
+      title: "Invalid data object's structure",
+      description: 'Should throw an error',
+      test: async () => {
+        const invalidData: any = {
+          inData: [[{ data: 'value' }]]
         }
         return adapter.request('common/sendObj', invalidData).catch((e) => e)
       },

src/ContextManager.ts

@@ -2,6 +2,7 @@ import { Context, EditContextInput, ContextAllAttributes } from './types'
 import { isUrl } from './utils'
 import { prefixMessage } from '@sasjs/utils/error'
 import { RequestClient } from './request/RequestClient'
+import { AuthConfig } from '@sasjs/utils/types'
 
 export class ContextManager {
   private defaultComputeContexts = [
@@ -328,12 +329,12 @@ export class ContextManager {
 
   public async getExecutableContexts(
     executeScript: Function,
-    accessToken?: string
+    authConfig?: AuthConfig
   ) {
     const { result: contexts } = await this.requestClient
       .get<{ items: Context[] }>(
         `${this.serverUrl}/compute/contexts?limit=10000`,
-        accessToken
+        authConfig?.access_token
       )
       .catch((err) => {
         throw prefixMessage(err, 'Error while fetching compute contexts.')
@@ -350,7 +351,7 @@ export class ContextManager {
           `test-${context.name}`,
           linesOfCode,
           context.name,
-          accessToken,
+          authConfig,
           null,
           false,
           true,

src/FileUploader.ts

@@ -2,15 +2,19 @@ import { isUrl } from './utils'
 import { UploadFile } from './types/UploadFile'
 import { ErrorResponse, LoginRequiredError } from './types/errors'
 import { RequestClient } from './request/RequestClient'
+import { ServerType } from '@sasjs/utils/types'
+import SASjs from './SASjs'
+import { Server } from 'https'
+import { SASjsConfig } from './types'
+import { config } from 'process'
 
 export class FileUploader {
   constructor(
-    private appLoc: string,
-    serverUrl: string,
+    private sasjsConfig: SASjsConfig,
     private jobsPath: string,
     private requestClient: RequestClient
   ) {
-    if (serverUrl) isUrl(serverUrl)
+    if (this.sasjsConfig.serverUrl) isUrl(this.sasjsConfig.serverUrl)
   }
 
   public uploadFile(sasJob: string, files: UploadFile[], params: any) {
@@ -29,8 +33,8 @@ export class FileUploader {
       }
     }
 
-    const program = this.appLoc
-      ? this.appLoc.replace(/\/?$/, '/') + sasJob.replace(/^\//, '')
+    const program = this.sasjsConfig.appLoc
+      ? this.sasjsConfig.appLoc.replace(/\/?$/, '/') + sasJob.replace(/^\//, '')
       : sasJob
     const uploadUrl = `${this.jobsPath}/?${
       '_program=' + program
@@ -44,6 +48,12 @@ export class FileUploader {
 
     const csrfToken = this.requestClient.getCsrfToken('file')
     if (csrfToken) formData.append('_csrf', csrfToken.value)
+    if (this.sasjsConfig.debug) formData.append('_debug', '131')
+    if (
+      this.sasjsConfig.serverType === ServerType.SasViya &&
+      this.sasjsConfig.contextName
+    )
+      formData.append('_contextname', this.sasjsConfig.contextName)
 
     const headers = {
       'cache-control': 'no-cache',
@@ -53,9 +63,15 @@ export class FileUploader {
 
     return this.requestClient
       .post(uploadUrl, formData, undefined, 'application/json', headers)
-      .then((res) =>
-        typeof res.result === 'string' ? JSON.parse(res.result) : res.result
-      )
+      .then((res) => {
+        let result
+
+        result =
+          typeof res.result === 'string' ? JSON.parse(res.result) : res.result
+
+        return result
+        //TODO: append to SASjs requests
+      })
       .catch((err: Error) => {
         if (err instanceof LoginRequiredError) {
           return Promise.reject(

src/SAS9ApiClient.ts

@@ -45,7 +45,16 @@ export class SAS9ApiClient {
   ) {
     await this.requestClient.login(userName, password, this.jobsPath)
 
-    const formData = generateFileUploadForm(linesOfCode.join('\n'))
+    // This piece of code forces a webout to prevent Stored Process Errors.
+    const forceOutputCode = [
+      'data _null_;',
+      'file _webout;',
+      `put 'Executed sasjs run';`,
+      'run;'
+    ]
+    const formData = generateFileUploadForm(
+      [...linesOfCode, ...forceOutputCode].join('\n')
+    )
 
     const codeInjectorPath = `/User Folders/${userName}/My Folder/sasjs/runner`
     const contentType =

src/SASViyaApiClient.ts

@@ -3,7 +3,9 @@ import {
   isRelativePath,
   isUri,
   isUrl,
-  fetchLogByChunks
+  fetchLogByChunks,
+  isAccessTokenExpiring,
+  isRefreshTokenExpiring
 } from './utils'
 import * as NodeFormData from 'form-data'
 import {
@@ -29,7 +31,7 @@ import { timestampToYYYYMMDDHHMMSS } from '@sasjs/utils/time'
 import { Logger, LogLevel } from '@sasjs/utils/logger'
 import { isAuthorizeFormRequired } from './auth/isAuthorizeFormRequired'
 import { RequestClient } from './request/RequestClient'
-import { SasAuthResponse, MacroVar } from '@sasjs/utils/types'
+import { SasAuthResponse, MacroVar, AuthConfig } from '@sasjs/utils/types'
 import { prefixMessage } from '@sasjs/utils/error'
 import * as mime from 'mime'
 
@@ -130,14 +132,14 @@ export class SASViyaApiClient {
 
   /**
    * Returns all compute contexts on this server that the user has access to.
-   * @param accessToken - an access token for an authorized user.
+   * @param authConfig - an access token, refresh token, client and secret for an authorized user.
    */
-  public async getExecutableContexts(accessToken?: string) {
+  public async getExecutableContexts(authConfig?: AuthConfig) {
     const bindedExecuteScript = this.executeScript.bind(this)
 
     return await this.contextManager.getExecutableContexts(
       bindedExecuteScript,
-      accessToken
+      authConfig
     )
   }
 
@@ -266,7 +268,7 @@ export class SASViyaApiClient {
    * @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.
-   * @param accessToken - an access token for an authorized user.
+   * @param authConfig - an object containing an access token, refresh token, client ID and secret.
    * @param data - execution data.
    * @param debug - when set to true, the log will be returned.
    * @param expectWebout - when set to true, the automatic _webout fileref will be checked for content, and that content returned. This fileref is used when the Job contains a SASjs web request (as opposed to executing arbitrary SAS code).
@@ -279,7 +281,7 @@ export class SASViyaApiClient {
     jobPath: string,
     linesOfCode: string[],
     contextName: string,
-    accessToken?: string,
+    authConfig?: AuthConfig,
     data = null,
     debug: boolean = false,
     expectWebout = false,
@@ -288,17 +290,20 @@ export class SASViyaApiClient {
     printPid = false,
     variables?: MacroVar
   ): Promise<any> {
+    const { access_token } = authConfig || {}
+    const logger = process.logger || console
+
     try {
       const headers: any = {
         'Content-Type': 'application/json'
       }
 
-      if (accessToken) headers.Authorization = `Bearer ${accessToken}`
+      if (access_token) headers.Authorization = `Bearer ${access_token}`
 
       let executionSessionId: string
 
       const session = await this.sessionManager
-        .getSession(accessToken)
+        .getSession(access_token)
         .catch((err) => {
           throw prefixMessage(err, 'Error while getting session. ')
         })
@@ -307,7 +312,7 @@ export class SASViyaApiClient {
 
       if (printPid) {
         const { result: jobIdVariable } = await this.sessionManager
-          .getVariable(executionSessionId, 'SYSJOBID', accessToken)
+          .getVariable(executionSessionId, 'SYSJOBID', access_token)
           .catch((err) => {
             throw prefixMessage(err, 'Error while getting session variable. ')
           })
@@ -339,7 +344,6 @@ export class SASViyaApiClient {
       if (debug) {
         jobArguments['_OMITTEXTLOG'] = false
         jobArguments['_OMITSESSIONRESULTS'] = false
-        jobArguments['_DEBUG'] = 131
       }
 
       let fileName
@@ -362,11 +366,13 @@ export class SASViyaApiClient {
 
       if (variables) jobVariables = { ...jobVariables, ...variables }
 
+      if (debug) jobVariables = { ...jobVariables, _DEBUG: 131 }
+
       let files: any[] = []
 
       if (data) {
         if (JSON.stringify(data).includes(';')) {
-          files = await this.uploadTables(data, accessToken).catch((err) => {
+          files = await this.uploadTables(data, access_token).catch((err) => {
             throw prefixMessage(err, 'Error while uploading tables. ')
           })
 
@@ -396,7 +402,7 @@ export class SASViyaApiClient {
         .post<Job>(
           `/compute/sessions/${executionSessionId}/jobs`,
           jobRequestBody,
-          accessToken
+          access_token
         )
         .catch((err) => {
           throw prefixMessage(err, 'Error while posting job. ')
@@ -405,8 +411,8 @@ export class SASViyaApiClient {
       if (!waitForResult) return session
 
       if (debug) {
-        console.log(`Job has been submitted for '${fileName}'.`)
-        console.log(
+        logger.info(`Job has been submitted for '${fileName}'.`)
+        logger.info(
           `You can monitor the job progress at '${this.serverUrl}${
             postedJob.links.find((l: any) => l.rel === 'state')!.href
           }'.`
@@ -416,7 +422,7 @@ export class SASViyaApiClient {
       const jobStatus = await this.pollJobState(
         postedJob,
         etag,
-        accessToken,
+        authConfig,
         pollOptions
       ).catch(async (err) => {
         const error = err?.response?.data
@@ -429,7 +435,7 @@ export class SASViyaApiClient {
           const logCount = 1000000
           err.log = await fetchLogByChunks(
             this.requestClient,
-            accessToken!,
+            access_token!,
             sessionLogUrl,
             logCount
           )
@@ -440,7 +446,7 @@ export class SASViyaApiClient {
       const { result: currentJob } = await this.requestClient
         .get<Job>(
           `/compute/sessions/${executionSessionId}/jobs/${postedJob.id}`,
-          accessToken
+          access_token
         )
         .catch((err) => {
           throw prefixMessage(err, 'Error while getting job. ')
@@ -456,7 +462,7 @@ export class SASViyaApiClient {
         const logCount = currentJob.logStatistics?.lineCount ?? 1000000
         log = await fetchLogByChunks(
           this.requestClient,
-          accessToken!,
+          access_token!,
           logUrl,
           logCount
         )
@@ -476,7 +482,7 @@ export class SASViyaApiClient {
 
       if (resultLink) {
         jobResult = await this.requestClient
-          .get<any>(resultLink, accessToken, 'text/plain')
+          .get<any>(resultLink, access_token, 'text/plain')
           .catch(async (e) => {
             if (e instanceof NotFoundError) {
               if (logLink) {
@@ -484,7 +490,7 @@ export class SASViyaApiClient {
                 const logCount = currentJob.logStatistics?.lineCount ?? 1000000
                 log = await fetchLogByChunks(
                   this.requestClient,
-                  accessToken!,
+                  access_token!,
                   logUrl,
                   logCount
                 )
@@ -503,7 +509,7 @@ export class SASViyaApiClient {
       }
 
       await this.sessionManager
-        .clearSession(executionSessionId, accessToken)
+        .clearSession(executionSessionId, access_token)
         .catch((err) => {
           throw prefixMessage(err, 'Error while clearing session. ')
         })
@@ -515,7 +521,7 @@ export class SASViyaApiClient {
           jobPath,
           linesOfCode,
           contextName,
-          accessToken,
+          authConfig,
           data,
           debug,
           false,
@@ -602,6 +608,7 @@ export class SASViyaApiClient {
     accessToken?: string,
     isForced?: boolean
   ): Promise<Folder> {
+    const logger = process.logger || console
     if (!parentFolderPath && !parentFolderUri) {
       throw new Error('Path or URI of the parent folder is required.')
     }
@@ -609,7 +616,7 @@ export class SASViyaApiClient {
     if (!parentFolderUri && parentFolderPath) {
       parentFolderUri = await this.getFolderUri(parentFolderPath, accessToken)
       if (!parentFolderUri) {
-        console.log(
+        logger.info(
           `Parent folder at path '${parentFolderPath}' is not present.`
         )
 
@@ -621,7 +628,7 @@ export class SASViyaApiClient {
         if (newParentFolderPath === '') {
           throw new Error('Root folder has to be present on the server.')
         }
-        console.log(
+        logger.info(
           `Creating parent folder:\n'${newFolderName}' in '${newParentFolderPath}'`
         )
         const parentFolder = await this.createFolder(
@@ -630,7 +637,7 @@ export class SASViyaApiClient {
           undefined,
           accessToken
         )
-        console.log(
+        logger.info(
           `Parent folder '${newFolderName}' has been successfully created.`
         )
         parentFolderUri = `/folders/folders/${parentFolder.id}`
@@ -872,13 +879,15 @@ export class SASViyaApiClient {
     contextName: string,
     debug?: boolean,
     data?: any,
-    accessToken?: string,
+    authConfig?: AuthConfig,
     waitForResult = true,
     expectWebout = false,
     pollOptions?: PollOptions,
     printPid = false,
     variables?: MacroVar
   ) {
+    let { access_token } = authConfig || {}
+
     if (isRelativePath(sasJob) && !this.rootFolderName) {
       throw new Error(
         'Relative paths cannot be used without specifying a root folder name'
@@ -892,7 +901,7 @@ export class SASViyaApiClient {
       ? `${this.rootFolderName}/${folderPath}`
       : folderPath
 
-    await this.populateFolderMap(fullFolderPath, accessToken).catch((err) => {
+    await this.populateFolderMap(fullFolderPath, access_token).catch((err) => {
       throw prefixMessage(err, 'Error while populating folder map. ')
     })
 
@@ -906,8 +915,8 @@ export class SASViyaApiClient {
 
     const headers: any = { 'Content-Type': 'application/json' }
 
-    if (!!accessToken) {
-      headers.Authorization = `Bearer ${accessToken}`
+    if (!!access_token) {
+      headers.Authorization = `Bearer ${access_token}`
     }
 
     const jobToExecute = jobFolder?.find((item) => item.name === jobName)
@@ -930,7 +939,7 @@ export class SASViyaApiClient {
       const { result: jobDefinition } = await this.requestClient
         .get<JobDefinition>(
           `${this.serverUrl}${jobDefinitionLink.href}`,
-          accessToken
+          access_token
         )
         .catch((err) => {
           throw prefixMessage(err, 'Error while getting job definition. ')
@@ -950,7 +959,7 @@ export class SASViyaApiClient {
       sasJob,
       linesToExecute,
       contextName,
-      accessToken,
+      authConfig,
       data,
       debug,
       expectWebout,
@@ -974,8 +983,9 @@ export class SASViyaApiClient {
     contextName: string,
     debug: boolean,
     data?: any,
-    accessToken?: string
+    authConfig?: AuthConfig
   ) {
+    let { access_token } = authConfig || {}
     if (isRelativePath(sasJob) && !this.rootFolderName) {
       throw new Error(
         'Relative paths cannot be used without specifying a root folder name.'
@@ -988,7 +998,7 @@ export class SASViyaApiClient {
     const fullFolderPath = isRelativePath(sasJob)
       ? `${this.rootFolderName}/${folderPath}`
       : folderPath
-    await this.populateFolderMap(fullFolderPath, accessToken)
+    await this.populateFolderMap(fullFolderPath, access_token)
 
     const jobFolder = this.folderMap.get(fullFolderPath)
     if (!jobFolder) {
@@ -1001,7 +1011,7 @@ export class SASViyaApiClient {
 
     let files: any[] = []
     if (data && Object.keys(data).length) {
-      files = await this.uploadTables(data, accessToken)
+      files = await this.uploadTables(data, access_token)
     }
 
     if (!jobToExecute) {
@@ -1013,7 +1023,7 @@ export class SASViyaApiClient {
 
     const { result: jobDefinition } = await this.requestClient.get<Job>(
       `${this.serverUrl}${jobDefinitionLink}`,
-      accessToken
+      access_token
     )
 
     const jobArguments: { [key: string]: any } = {
@@ -1049,18 +1059,18 @@ export class SASViyaApiClient {
     const { result: postedJob, etag } = await this.requestClient.post<Job>(
       `${this.serverUrl}/jobExecution/jobs?_action=wait`,
       postJobRequestBody,
-      accessToken
+      access_token
     )
     const jobStatus = await this.pollJobState(
       postedJob,
       etag,
-      accessToken
+      authConfig
     ).catch((err) => {
       throw prefixMessage(err, 'Error while polling job status. ')
     })
     const { result: currentJob } = await this.requestClient.get<Job>(
       `${this.serverUrl}/jobExecution/jobs/${postedJob.id}`,
-      accessToken
+      access_token
     )
 
     let jobResult
@@ -1071,13 +1081,13 @@ export class SASViyaApiClient {
     if (resultLink) {
       jobResult = await this.requestClient.get<any>(
         `${this.serverUrl}${resultLink}/content`,
-        accessToken,
+        access_token,
         'text/plain'
       )
     }
     if (debug && logLink) {
       log = await this.requestClient
-        .get<any>(`${this.serverUrl}${logLink.href}/content`, accessToken)
+        .get<any>(`${this.serverUrl}${logLink.href}/content`, access_token)
         .then((res: any) => res.result.items.map((i: any) => i.line).join('\n'))
     }
     if (jobStatus === 'failed') {
@@ -1127,12 +1137,30 @@ export class SASViyaApiClient {
   private async pollJobState(
     postedJob: any,
     etag: string | null,
-    accessToken?: string,
+    authConfig?: AuthConfig,
     pollOptions?: PollOptions
   ) {
+    const logger = process.logger || console
+
     let POLL_INTERVAL = 300
     let MAX_POLL_COUNT = 1000
     let MAX_ERROR_COUNT = 5
+    let { access_token, refresh_token, client, secret } = authConfig || {}
+    if (access_token && refresh_token) {
+      if (
+        client &&
+        secret &&
+        refresh_token &&
+        (isAccessTokenExpiring(access_token) ||
+          isRefreshTokenExpiring(refresh_token))
+      ) {
+        ;({ access_token, refresh_token } = await this.refreshTokens(
+          client,
+          secret,
+          refresh_token
+        ))
+      }
+    }
 
     if (pollOptions) {
       POLL_INTERVAL = pollOptions.POLL_INTERVAL || POLL_INTERVAL
@@ -1146,8 +1174,8 @@ export class SASViyaApiClient {
       'Content-Type': 'application/json',
       'If-None-Match': etag
     }
-    if (accessToken) {
-      headers.Authorization = `Bearer ${accessToken}`
+    if (access_token) {
+      headers.Authorization = `Bearer ${access_token}`
     }
     const stateLink = postedJob.links.find((l: any) => l.rel === 'state')
     if (!stateLink) {
@@ -1157,7 +1185,7 @@ export class SASViyaApiClient {
     const { result: state } = await this.requestClient
       .get<string>(
         `${this.serverUrl}${stateLink.href}?_action=wait&wait=300`,
-        accessToken,
+        access_token,
         'text/plain',
         {},
         this.debug
@@ -1185,11 +1213,27 @@ export class SASViyaApiClient {
           postedJobState === 'pending' ||
           postedJobState === 'unavailable'
         ) {
+          if (access_token && refresh_token) {
+            if (
+              client &&
+              secret &&
+              refresh_token &&
+              (isAccessTokenExpiring(access_token) ||
+                isRefreshTokenExpiring(refresh_token))
+            ) {
+              ;({ access_token, refresh_token } = await this.refreshTokens(
+                client,
+                secret,
+                refresh_token
+              ))
+            }
+          }
+
           if (stateLink) {
             const { result: jobState } = await this.requestClient
               .get<string>(
                 `${this.serverUrl}${stateLink.href}?_action=wait&wait=300`,
-                accessToken,
+                access_token,
                 'text/plain',
                 {},
                 this.debug
@@ -1218,8 +1262,8 @@ export class SASViyaApiClient {
             }
 
             if (this.debug && printedState !== postedJobState) {
-              console.log('Polling job status...')
-              console.log(`Current job state: ${postedJobState}`)
+              logger.info('Polling job status...')
+              logger.info(`Current job state: ${postedJobState}`)
 
               printedState = postedJobState
             }
@@ -1409,6 +1453,9 @@ export class SASViyaApiClient {
       accessToken
     )
 
+    if (!sourceFolderUri) {
+      return undefined
+    }
     const sourceFolderId = sourceFolderUri?.split('/').pop()
 
     const { result: folder } = await this.requestClient

src/SASjs.ts

@@ -4,7 +4,7 @@ import { SASViyaApiClient } from './SASViyaApiClient'
 import { SAS9ApiClient } from './SAS9ApiClient'
 import { FileUploader } from './FileUploader'
 import { AuthManager } from './auth'
-import { ServerType, MacroVar } from '@sasjs/utils/types'
+import { ServerType, MacroVar, AuthConfig } from '@sasjs/utils/types'
 import { RequestClient } from './request/RequestClient'
 import {
   JobExecutor,
@@ -24,7 +24,7 @@ const defaultConfig: SASjsConfig = {
   serverType: ServerType.SasViya,
   debug: false,
   contextName: 'SAS Job Execution compute context',
-  useComputeApi: false,
+  useComputeApi: null,
   allowInsecureRequests: false
 }
 
@@ -103,12 +103,12 @@ export default class SASjs {
 
   /**
    * Gets executable compute contexts.
-   * @param accessToken - an access token for an authorized user.
+   * @param authConfig - an access token, refresh token, client and secret for an authorized user.
    */
-  public async getExecutableContexts(accessToken: string) {
+  public async getExecutableContexts(authConfig: AuthConfig) {
     this.isMethodSupported('getExecutableContexts', ServerType.SasViya)
 
-    return await this.sasViyaApiClient!.getExecutableContexts(accessToken)
+    return await this.sasViyaApiClient!.getExecutableContexts(authConfig)
   }
 
   /**
@@ -240,14 +240,14 @@ export default class SASjs {
    * @param fileName - name of the file to run. It will be converted to path to the file being submitted for execution.
    * @param linesOfCode - lines of sas code from the file to run.
    * @param contextName - context name on which code will be run on the server.
-   * @param accessToken - (optional) the access token for authorizing the request.
+   * @param authConfig - (optional) the access token, refresh token, client and secret for authorizing the request.
    * @param debug - (optional) if true, global debug config will be overriden
    */
   public async executeScriptSASViya(
     fileName: string,
     linesOfCode: string[],
     contextName: string,
-    accessToken?: string,
+    authConfig?: AuthConfig,
     debug?: boolean
   ) {
     this.isMethodSupported('executeScriptSASViya', ServerType.SasViya)
@@ -261,7 +261,7 @@ export default class SASjs {
       fileName,
       linesOfCode,
       contextName,
-      accessToken,
+      authConfig,
       null,
       debug ? debug : this.sasjsConfig.debug
     )
@@ -544,12 +544,7 @@ export default class SASjs {
   public uploadFile(sasJob: string, files: UploadFile[], params: any) {
     const fileUploader =
       this.fileUploader ||
-      new FileUploader(
-        this.sasjsConfig.appLoc,
-        this.sasjsConfig.serverUrl,
-        this.jobsPath,
-        this.requestClient!
-      )
+      new FileUploader(this.sasjsConfig, this.jobsPath, this.requestClient!)
 
     return fileUploader.uploadFile(sasJob, files, params)
   }
@@ -581,10 +576,10 @@ export default class SASjs {
    */
   public async request(
     sasJob: string,
-    data: { [key: string]: any },
+    data: { [key: string]: any } | null,
     config: { [key: string]: any } = {},
     loginRequiredCallback?: () => any,
-    accessToken?: string,
+    authConfig?: AuthConfig,
     extraResponseAttributes: ExtraResponseAttributes[] = []
   ) {
     config = {
@@ -592,38 +587,113 @@ export default class SASjs {
       ...config
     }
 
-    if (config.serverType === ServerType.SasViya && config.contextName) {
-      if (config.useComputeApi) {
-        return await this.computeJobExecutor!.execute(
-          sasJob,
-          data,
-          config,
-          loginRequiredCallback,
-          accessToken
-        )
+    const validationResult = this.validateInput(data)
+
+    if (validationResult.status) {
+      if (
+        config.serverType !== ServerType.Sas9 &&
+        config.useComputeApi !== undefined &&
+        config.useComputeApi !== null
+      ) {
+        if (config.useComputeApi) {
+          return await this.computeJobExecutor!.execute(
+            sasJob,
+            data,
+            config,
+            loginRequiredCallback,
+            authConfig
+          )
+        } else {
+          return await this.jesJobExecutor!.execute(
+            sasJob,
+            data,
+            config,
+            loginRequiredCallback,
+            authConfig,
+            extraResponseAttributes
+          )
+        }
+      } else if (
+        config.serverType === ServerType.Sas9 &&
+        config.username &&
+        config.password
+      ) {
+        return await this.sas9JobExecutor!.execute(sasJob, data, config)
       } else {
-        return await this.jesJobExecutor!.execute(
+        return await this.webJobExecutor!.execute(
           sasJob,
           data,
           config,
           loginRequiredCallback,
-          accessToken,
+          authConfig,
           extraResponseAttributes
         )
       }
-    } else if (
-      config.serverType === ServerType.Sas9 &&
-      config.username &&
-      config.password
-    ) {
-      return await this.sas9JobExecutor!.execute(sasJob, data, config)
     } else {
-      return await this.webJobExecutor!.execute(
-        sasJob,
-        data,
-        config,
-        loginRequiredCallback
-      )
+      return Promise.reject(new ErrorResponse(validationResult.msg))
+    }
+  }
+
+  /**
+   * This function validates the input data structure and table naming convention
+   *
+   * @param data A json object that contains one or more tables, it can also be null
+   * @returns An object which contains two attributes: 1) status: boolean, 2) msg: string
+   */
+  private validateInput(data: { [key: string]: any } | null): {
+    status: boolean
+    msg: string
+  } {
+    if (data === null) return { status: true, msg: '' }
+    for (const key in data) {
+      if (!key.match(/^[a-zA-Z_]/)) {
+        return {
+          status: false,
+          msg: 'First letter of table should be alphabet or underscore.'
+        }
+      }
+
+      if (!key.match(/^[a-zA-Z_][a-zA-Z0-9_]*$/)) {
+        return { status: false, msg: 'Table name should be alphanumeric.' }
+      }
+
+      if (key.length > 32) {
+        return {
+          status: false,
+          msg: 'Maximum length for table name could be 32 characters.'
+        }
+      }
+
+      if (this.getType(data[key]) !== 'Array') {
+        return {
+          status: false,
+          msg: 'Parameter data contains invalid table structure.'
+        }
+      }
+
+      for (let i = 0; i < data[key].length; i++) {
+        if (this.getType(data[key][i]) !== 'object') {
+          return {
+            status: false,
+            msg: `Table ${key} contains invalid structure.`
+          }
+        }
+      }
+    }
+    return { status: true, msg: '' }
+  }
+
+  /**
+   * this function returns the type of variable
+   *
+   * @param data it could be anything, like string, array, object etc.
+   * @returns a string which tells the type of input parameter
+   */
+  private getType(data: any): string {
+    if (Array.isArray(data)) {
+      return 'Array'
+    } else {
+      return typeof data
     }
   }
 
@@ -706,7 +776,7 @@ export default class SASjs {
    * @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 accessToken - a valid access token that is authorised to execute compute jobs.
+   * @param authConfig - a valid client, secret, refresh and access tokens that are authorised to execute compute jobs.
    * The access token is not required when the user is authenticated via the browser.
    * @param waitForResult - a boolean that indicates whether the function needs to wait for execution to complete.
    * @param pollOptions - an object that represents poll interval(milliseconds) and maximum amount of attempts. Object example: { MAX_POLL_COUNT: 24 * 60 * 60, POLL_INTERVAL: 1000 }.
@@ -717,7 +787,7 @@ export default class SASjs {
     sasJob: string,
     data: any,
     config: any = {},
-    accessToken?: string,
+    authConfig?: AuthConfig,
     waitForResult?: boolean,
     pollOptions?: PollOptions,
     printPid = false,
@@ -740,7 +810,7 @@ export default class SASjs {
       config.contextName,
       config.debug,
       data,
-      accessToken,
+      authConfig,
       !!waitForResult,
       false,
       pollOptions,
@@ -864,8 +934,7 @@ export default class SASjs {
     }
 
     this.fileUploader = new FileUploader(
-      this.sasjsConfig.appLoc,
-      this.sasjsConfig.serverUrl,
+      this.sasjsConfig,
       this.jobsPath,
       this.requestClient
     )

src/SessionManager.ts

@@ -158,6 +158,8 @@ export class SessionManager {
     etag: string | null,
     accessToken?: string
   ) {
+    const logger = process.logger || console
+
     let sessionState = session.state
 
     const stateLink = session.links.find((l: any) => l.rel === 'state')
@@ -170,7 +172,7 @@ export class SessionManager {
       ) {
         if (stateLink) {
           if (this.debug && !this.printedSessionState.printed) {
-            console.log('Polling session status...')
+            logger.info('Polling session status...')
 
             this.printedSessionState.printed = true
           }
@@ -186,7 +188,7 @@ export class SessionManager {
           sessionState = state.trim()
 
           if (this.debug && this.printedSessionState.state !== sessionState) {
-            console.log(`Current session state is '${sessionState}'`)
+            logger.info(`Current session state is '${sessionState}'`)
 
             this.printedSessionState.state = sessionState
             this.printedSessionState.printed = false

src/auth/AuthManager.ts

@@ -1,5 +1,4 @@
 import { ServerType } from '@sasjs/utils/types'
-import { isAuthorizeFormRequired } from '.'
 import { RequestClient } from '../request/RequestClient'
 import { serialize } from '../utils'
 
@@ -61,6 +60,15 @@ export class AuthManager {
     }
 
     if (loggedIn) {
+      if (this.serverType === ServerType.Sas9) {
+        const casAuthenticationUrl = `${this.serverUrl}/SASStoredProcess/j_spring_cas_security_check`
+
+        await this.requestClient.get<string>(
+          `/SASLogon/login?service=${casAuthenticationUrl}`,
+          undefined
+        )
+      }
+
       this.loginCallback()
     }
 

src/job-execution/ComputeJobExecutor.ts

@@ -1,4 +1,4 @@
-import { ServerType } from '@sasjs/utils/types'
+import { AuthConfig, ServerType } from '@sasjs/utils/types'
 import { SASViyaApiClient } from '../SASViyaApiClient'
 import {
   ErrorResponse,
@@ -17,7 +17,7 @@ export class ComputeJobExecutor extends BaseJobExecutor {
     data: any,
     config: any,
     loginRequiredCallback?: any,
-    accessToken?: string
+    authConfig?: AuthConfig
   ) {
     const loginCallback = loginRequiredCallback || (() => Promise.resolve())
     const waitForResult = true
@@ -30,7 +30,7 @@ export class ComputeJobExecutor extends BaseJobExecutor {
           config.contextName,
           config.debug,
           data,
-          accessToken,
+          authConfig,
           waitForResult,
           expectWebout
         )

src/job-execution/JesJobExecutor.ts

@@ -1,4 +1,4 @@
-import { ServerType } from '@sasjs/utils/types'
+import { AuthConfig, ServerType } from '@sasjs/utils/types'
 import { SASViyaApiClient } from '../SASViyaApiClient'
 import {
   ErrorResponse,
@@ -18,20 +18,14 @@ export class JesJobExecutor extends BaseJobExecutor {
     data: any,
     config: any,
     loginRequiredCallback?: any,
-    accessToken?: string,
+    authConfig?: AuthConfig,
     extraResponseAttributes: ExtraResponseAttributes[] = []
   ) {
     const loginCallback = loginRequiredCallback || (() => Promise.resolve())
 
     const requestPromise = new Promise((resolve, reject) => {
       this.sasViyaApiClient
-        ?.executeJob(
-          sasJob,
-          config.contextName,
-          config.debug,
-          data,
-          accessToken
-        )
+        ?.executeJob(sasJob, config.contextName, config.debug, data, authConfig)
         .then((response: any) => {
           this.appendRequest(response, sasJob, config.debug)
 
@@ -69,7 +63,7 @@ export class JesJobExecutor extends BaseJobExecutor {
                 data,
                 config,
                 loginRequiredCallback,
-                accessToken,
+                authConfig,
                 extraResponseAttributes
               ).then(
                 (res: any) => {

src/job-execution/JobExecutor.ts

@@ -1,4 +1,4 @@
-import { ServerType } from '@sasjs/utils/types'
+import { AuthConfig, ServerType } from '@sasjs/utils/types'
 import { SASjsRequest } from '../types'
 import { ExtraResponseAttributes } from '@sasjs/utils/types'
 import { asyncForEach, parseGeneratedCode, parseSourceCode } from '../utils'
@@ -11,7 +11,7 @@ export interface JobExecutor {
     data: any,
     config: any,
     loginRequiredCallback?: any,
-    accessToken?: string,
+    authConfig?: AuthConfig,
     extraResponseAttributes?: ExtraResponseAttributes[]
   ) => Promise<any>
   resendWaitingRequests: () => Promise<void>
@@ -30,7 +30,7 @@ export abstract class BaseJobExecutor implements JobExecutor {
     data: any,
     config: any,
     loginRequiredCallback?: any,
-    accessToken?: string | undefined,
+    authConfig?: AuthConfig | undefined,
     extraResponseAttributes?: ExtraResponseAttributes[]
   ): Promise<any>
 
@@ -62,14 +62,14 @@ export abstract class BaseJobExecutor implements JobExecutor {
     let sasWork = null
 
     if (debug) {
-      if (response?.result && response?.log) {
+      if (response?.log) {
         sourceCode = parseSourceCode(response.log)
         generatedCode = parseGeneratedCode(response.log)
 
-        if (response.log) {
-          sasWork = response.log
-        } else {
+        if (response?.result) {
           sasWork = response.result.WORK
+        } else {
+          sasWork = response.log
         }
       } else if (response?.result) {
         sourceCode = parseSourceCode(response.result)

src/job-execution/WebJobExecutor.ts

@@ -39,15 +39,18 @@ export class WebJobExecutor extends BaseJobExecutor {
         ? config.appLoc.replace(/\/?$/, '/') + sasJob.replace(/^\//, '')
         : sasJob
       : sasJob
-    const jobUri =
-      config.serverType === ServerType.SasViya
-        ? await this.getJobUri(sasJob)
-        : ''
-    const apiUrl = `${config.serverUrl}${this.jobsPath}/?${
-      jobUri.length > 0
-        ? '__program=' + program + '&_job=' + jobUri
-        : '_program=' + program
-    }`
+    let apiUrl = `${config.serverUrl}${this.jobsPath}/?${'_program=' + program}`
+
+    if (config.serverType === ServerType.SasViya) {
+      const jobUri =
+        config.serverType === ServerType.SasViya
+          ? await this.getJobUri(sasJob)
+          : ''
+
+      apiUrl += jobUri.length > 0 ? '&_job=' + jobUri : ''
+
+      apiUrl += config.contextName ? `&_contextname=${config.contextName}` : ''
+    }
 
     let requestParams = {
       ...this.getRequestParams(config)

src/request/RequestClient.ts

@@ -287,7 +287,8 @@ export class RequestClient implements HttpClient {
       })
       .then((res) => res.data)
       .catch((error) => {
-        console.log(error)
+        const logger = process.logger || console
+        logger.error(error)
       })
   }
 

src/test/FileUploader.spec.ts

@@ -3,7 +3,7 @@
  */
 
 import { FileUploader } from '../FileUploader'
-import { UploadFile } from '../types'
+import { SASjsConfig, UploadFile } from '../types'
 import { RequestClient } from '../request/RequestClient'
 import axios from 'axios'
 jest.mock('axios')
@@ -32,9 +32,13 @@ const prepareFilesAndParams = () => {
 }
 
 describe('FileUploader', () => {
+  const config: SASjsConfig = {
+    ...new SASjsConfig(),
+    appLoc: '/sample/apploc'
+  }
+
   const fileUploader = new FileUploader(
-    '/sample/apploc',
-    'https://sample.server.com',
+    config,
     '/jobs/path',
     new RequestClient('https://sample.server.com')
   )

src/types/Process.d.ts

@@ -0,0 +1,5 @@
+declare namespace NodeJS {
+  export interface Process {
+    logger?: import('@sasjs/utils/logger').Logger
+  }
+}

src/types/SASjsConfig.ts

@@ -40,23 +40,19 @@ export class SASjsConfig {
    */
   debug: boolean = true
   /**
-   * The name of the compute context to use when calling the Viya APIs directly.
+   * The name of the compute context to use when calling the Viya services directly.
    * Example value: 'SAS Job Execution compute context'
-   * If set to missing or empty, and useComputeApi is true, the adapter will use
-   * the JES APIs.  If provided, the Job Code will be executed in pooled
-   * compute sessions on this named context.
    */
   contextName: string = ''
   /**
-   * Set to `false` to use the Job Execution Web Service.  To enhance VIYA
+   * If it's `false` adapter will use the JES API as connection approach.  To enhance VIYA
    * performance, set to `true` and provide a `contextName` on which to run
    * the code.  When running on a named context, the code executes under the
    * user identity.  When running as a Job Execution service, the code runs
-   * under the identity in the JES context.  If no `contextName` is provided,
-   * and `useComputeApi` is `true`, then the service will run as a Job, except
+   * under the identity in the JES context.  If `useComputeApi` is `null` or `undefined`, the service will run as a Job, except
    * triggered using the APIs instead of the Job Execution Web Service broker.
    */
-  useComputeApi = false
+  useComputeApi: boolean | null = null
   /**
    * Defaults to `false`.
    * When set to `true`, the adapter will allow requests to SAS servers that use a self-signed SSL certificate.

src/utils/auth.ts

@@ -0,0 +1,35 @@
+import jwtDecode from 'jwt-decode'
+
+/**
+ * Checks if the Access Token is expired or is expiring in 1 hour.  A default Access Token
+ * lasts 12 hours. If the Access Token expires, the Refresh Token is used to fetch a new
+ * Access Token. In the case that the Refresh Token is expired, 1 hour is enough to let
+ * most jobs finish.
+ * @param {string} token- token string that will be evaluated
+ */
+export function isAccessTokenExpiring(token: string): boolean {
+  if (!token) {
+    return true
+  }
+  const payload = jwtDecode<{ exp: number }>(token)
+  const timeToLive = payload.exp - new Date().valueOf() / 1000
+
+  return timeToLive <= 60 * 60 // 1 hour
+}
+
+/**
+ * Checks if the Refresh Token is expired or expiring in 30 secs. A default Refresh Token
+ * lasts 30 days.  Once the Refresh Token expires, the user must re-authenticate (provide
+ * credentials in a browser to obtain an authorisation code). 30 seconds is enough time
+ * to make a request for a final Access Token.
+ * @param {string} token- token string that will be evaluated
+ */
+export function isRefreshTokenExpiring(token?: string): boolean {
+  if (!token) {
+    return true
+  }
+  const payload = jwtDecode<{ exp: number }>(token)
+  const timeToLive = payload.exp - new Date().valueOf() / 1000
+
+  return timeToLive <= 30 // 30 seconds
+}

src/utils/fetchLogByChunks.ts

@@ -15,12 +15,14 @@ export const fetchLogByChunks = async (
   logUrl: string,
   logCount: number
 ): Promise<string> => {
+  const logger = process.logger || console
+
   let log: string = ''
 
   const loglimit = logCount < 10000 ? logCount : 10000
   let start = 0
   do {
-    console.log(
+    logger.info(
       `Fetching logs from line no: ${start + 1} to ${
         start + loglimit
       } of ${logCount}.`

src/utils/index.ts

@@ -1,4 +1,5 @@
 export * from './asyncForEach'
+export * from './auth'
 export * from './compareTimestamps'
 export * from './convertToCsv'
 export * from './isRelativePath'