Merge pull request #467 from sasjs/removed-url-package

fix: removed url package

.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

README.md

@@ -189,9 +189,13 @@ In this setup, all requests are routed through the JES web app, at `YOURSERVER/S
 }
 ```
 
+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.
 
+This approach (`useComputeApi: false`) also ensures that jobs are displayed in Environment Manager.
+
 ```
 {
   appLoc:"/Your/Path",
@@ -204,6 +208,8 @@ Here we are running Jobs using the Job Execution Service except this time we are
 ### 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.  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.
 
+With this approach (`useComputeApi: true`), the requests/logs will _not_ appear in the list in Environment manager.
+
 ```
 {
   appLoc:"/Your/Path",

package.json

@@ -3,8 +3,8 @@
   "description": "JavaScript adapter for SAS",
   "homepage": "https://adapter.sasjs.io",
   "scripts": {
-    "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",
+    "build": "rimraf build && rimraf node && mkdir node && copyfiles -u 1 \"./src/**/*\" ./node && webpack && rimraf build/src && rimraf node",
+    "package:lib": "npm run build && copyfiles ./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}\"",
@@ -13,7 +13,7 @@
     "postpublish": "git clean -fd",
     "semantic-release": "semantic-release",
     "typedoc": "typedoc",
-    "postinstall": "[ -d .git ] && git config core.hooksPath ./.git-hooks || true"
+    "prepare": "git rev-parse --git-dir && git config core.hooksPath ./.git-hooks && git config core.autocrlf false || true"
   },
   "publishConfig": {
     "access": "public"
@@ -41,35 +41,36 @@
     "@types/jest": "^26.0.23",
     "@types/mime": "^2.0.3",
     "@types/tough-cookie": "^4.0.0",
+    "copyfiles": "^2.4.1",
     "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",
+    "node-polyfill-webpack-plugin": "^1.1.4",
     "path": "^0.12.7",
     "process": "^0.11.10",
     "rimraf": "^3.0.2",
     "semantic-release": "^17.4.4",
-    "terser-webpack-plugin": "^5.1.3",
+    "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.23.2",
     "axios": "^0.21.1",
     "axios-cookiejar-support": "^1.0.1",
     "form-data": "^4.0.0",
     "https": "^1.0.0",
-    "tough-cookie": "^4.0.0",
-    "url": "^0.11.0"
+    "tough-cookie": "^4.0.0"
   }
 }

sasjs-tests/README.md

@@ -41,6 +41,19 @@ So you can run the script like so:
 SSH_ACCOUNT=me@my-sas-server.com DEPLOY_PATH=/var/www/html/my-folder/sasjs-tests npm run deploy
 ```
 
+If you are on `WINDOWS`, you will first need to install one dependency:
+```bash
+npm i -g copyfiles
+```
+and then run to build:
+```bash
+npm run update:adapter && npm run build 
+```
+when it finishes run to deploy:
+```bash
+scp -rp ./build/* me@my-sas-server.com:/var/www/html/my-folder/sasjs-tests
+```
+
 If you'd like to deploy just `sasjs-tests` without changing the adapter version, you can use the `deploy:tests` script, while also setting the same environment variables as above.
 
 ## 3. Creating the required SAS services

sasjs-tests/package.json

@@ -23,7 +23,8 @@
     "test": "react-scripts test",
     "eject": "react-scripts eject",
     "update:adapter": "cd .. && npm run package:lib && cd sasjs-tests && npm i ../build/sasjs-adapter-5.0.0.tgz",
-    "deploy:tests": "rsync -avhe ssh ./build/* --delete $SSH_ACCOUNT:$DEPLOY_PATH",
+    "deploy:tests": "rsync -avhe ssh ./build/* --delete $SSH_ACCOUNT:$DEPLOY_PATH || npm run deploy:tests-win",
+    "deploy:tests-win": "scp %DEPLOY_PATH% ./build/*",
     "deploy": "npm run update:adapter && npm run build && npm run deploy:tests"
   },
   "eslintConfig": {

sasjs-tests/src/testSuites/Compute.ts

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

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/SASViyaApiClient.ts

@@ -26,10 +26,14 @@ import { formatDataForRequest } from './utils/formatDataForRequest'
 import { SessionManager } from './SessionManager'
 import { ContextManager } from './ContextManager'
 import { timestampToYYYYMMDDHHMMSS } from '@sasjs/utils/time'
+import {
+  isAccessTokenExpiring,
+  isRefreshTokenExpiring
+} from '@sasjs/utils/auth'
 import { Logger, LogLevel } from '@sasjs/utils/logger'
+import { SasAuthResponse, MacroVar, AuthConfig } from '@sasjs/utils/types'
 import { isAuthorizeFormRequired } from './auth/isAuthorizeFormRequired'
 import { RequestClient } from './request/RequestClient'
-import { SasAuthResponse, MacroVar } from '@sasjs/utils/types'
 import { prefixMessage } from '@sasjs/utils/error'
 import * as mime from 'mime'
 
@@ -130,14 +134,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 +270,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 +283,7 @@ export class SASViyaApiClient {
     jobPath: string,
     linesOfCode: string[],
     contextName: string,
-    accessToken?: string,
+    authConfig?: AuthConfig,
     data = null,
     debug: boolean = false,
     expectWebout = false,
@@ -288,17 +292,18 @@ export class SASViyaApiClient {
     printPid = false,
     variables?: MacroVar
   ): Promise<any> {
+    let access_token = (authConfig || {}).access_token
+    if (authConfig) {
+      ;({ access_token } = await this.getTokens(authConfig))
+    }
+
+    const logger = process.logger || console
+
     try {
-      const headers: any = {
-        'Content-Type': 'application/json'
-      }
-
-      if (accessToken) headers.Authorization = `Bearer ${accessToken}`
-
       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. ')
           })
@@ -367,7 +372,7 @@ export class SASViyaApiClient {
 
       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. ')
           })
 
@@ -397,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. ')
@@ -406,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
           }'.`
@@ -417,7 +422,7 @@ export class SASViyaApiClient {
       const jobStatus = await this.pollJobState(
         postedJob,
         etag,
-        accessToken,
+        authConfig,
         pollOptions
       ).catch(async (err) => {
         const error = err?.response?.data
@@ -430,7 +435,7 @@ export class SASViyaApiClient {
           const logCount = 1000000
           err.log = await fetchLogByChunks(
             this.requestClient,
-            accessToken!,
+            access_token!,
             sessionLogUrl,
             logCount
           )
@@ -438,10 +443,14 @@ export class SASViyaApiClient {
         throw prefixMessage(err, 'Error while polling job status. ')
       })
 
+      if (authConfig) {
+        ;({ access_token } = await this.getTokens(authConfig))
+      }
+
       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. ')
@@ -457,7 +466,7 @@ export class SASViyaApiClient {
         const logCount = currentJob.logStatistics?.lineCount ?? 1000000
         log = await fetchLogByChunks(
           this.requestClient,
-          accessToken!,
+          access_token!,
           logUrl,
           logCount
         )
@@ -477,7 +486,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) {
@@ -485,7 +494,7 @@ export class SASViyaApiClient {
                 const logCount = currentJob.logStatistics?.lineCount ?? 1000000
                 log = await fetchLogByChunks(
                   this.requestClient,
-                  accessToken!,
+                  access_token!,
                   logUrl,
                   logCount
                 )
@@ -504,7 +513,7 @@ export class SASViyaApiClient {
       }
 
       await this.sessionManager
-        .clearSession(executionSessionId, accessToken)
+        .clearSession(executionSessionId, access_token)
         .catch((err) => {
           throw prefixMessage(err, 'Error while clearing session. ')
         })
@@ -516,7 +525,7 @@ export class SASViyaApiClient {
           jobPath,
           linesOfCode,
           contextName,
-          accessToken,
+          authConfig,
           data,
           debug,
           false,
@@ -603,6 +612,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.')
     }
@@ -610,7 +620,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.`
         )
 
@@ -622,7 +632,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(
@@ -631,7 +641,7 @@ export class SASViyaApiClient {
           undefined,
           accessToken
         )
-        console.log(
+        logger.info(
           `Parent folder '${newFolderName}' has been successfully created.`
         )
         parentFolderUri = `/folders/folders/${parentFolder.id}`
@@ -873,13 +883,18 @@ 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 || {}).access_token
+    if (authConfig) {
+      ;({ access_token } = await this.getTokens(authConfig))
+    }
+
     if (isRelativePath(sasJob) && !this.rootFolderName) {
       throw new Error(
         'Relative paths cannot be used without specifying a root folder name'
@@ -893,7 +908,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. ')
     })
 
@@ -905,12 +920,6 @@ export class SASViyaApiClient {
       )
     }
 
-    const headers: any = { 'Content-Type': 'application/json' }
-
-    if (!!accessToken) {
-      headers.Authorization = `Bearer ${accessToken}`
-    }
-
     const jobToExecute = jobFolder?.find((item) => item.name === jobName)
 
     if (!jobToExecute) {
@@ -931,7 +940,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. ')
@@ -951,7 +960,7 @@ export class SASViyaApiClient {
       sasJob,
       linesToExecute,
       contextName,
-      accessToken,
+      authConfig,
       data,
       debug,
       expectWebout,
@@ -975,8 +984,12 @@ export class SASViyaApiClient {
     contextName: string,
     debug: boolean,
     data?: any,
-    accessToken?: string
+    authConfig?: AuthConfig
   ) {
+    let access_token = (authConfig || {}).access_token
+    if (authConfig) {
+      ;({ access_token } = await this.getTokens(authConfig))
+    }
     if (isRelativePath(sasJob) && !this.rootFolderName) {
       throw new Error(
         'Relative paths cannot be used without specifying a root folder name.'
@@ -989,7 +1002,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) {
@@ -1002,7 +1015,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) {
@@ -1014,7 +1027,7 @@ export class SASViyaApiClient {
 
     const { result: jobDefinition } = await this.requestClient.get<Job>(
       `${this.serverUrl}${jobDefinitionLink}`,
-      accessToken
+      access_token
     )
 
     const jobArguments: { [key: string]: any } = {
@@ -1050,18 +1063,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
@@ -1072,13 +1085,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') {
@@ -1128,12 +1141,18 @@ 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 = (authConfig || {}).access_token
+    if (authConfig) {
+      ;({ access_token } = await this.getTokens(authConfig))
+    }
 
     if (pollOptions) {
       POLL_INTERVAL = pollOptions.POLL_INTERVAL || POLL_INTERVAL
@@ -1147,8 +1166,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) {
@@ -1158,7 +1177,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
@@ -1186,11 +1205,15 @@ export class SASViyaApiClient {
           postedJobState === 'pending' ||
           postedJobState === 'unavailable'
         ) {
+          if (authConfig) {
+            ;({ access_token } = await this.getTokens(authConfig))
+          }
+
           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
@@ -1219,8 +1242,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
             }
@@ -1410,6 +1433,9 @@ export class SASViyaApiClient {
       accessToken
     )
 
+    if (!sourceFolderUri) {
+      return undefined
+    }
     const sourceFolderId = sourceFolderUri?.split('/').pop()
 
     const { result: folder } = await this.requestClient
@@ -1464,4 +1490,21 @@ export class SASViyaApiClient {
 
     return movedFolder
   }
+
+  private async getTokens(authConfig: AuthConfig): Promise<AuthConfig> {
+    const logger = process.logger || console
+    let { access_token, refresh_token, client, secret } = authConfig
+    if (
+      isAccessTokenExpiring(access_token) ||
+      isRefreshTokenExpiring(refresh_token)
+    ) {
+      logger.info('Refreshing access and refresh tokens.')
+      ;({ access_token, refresh_token } = await this.refreshTokens(
+        client,
+        secret,
+        refresh_token
+      ))
+    }
+    return { access_token, refresh_token, client, secret }
+  }
 }

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,
@@ -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
     )
@@ -579,7 +579,7 @@ export default class SASjs {
     data: { [key: string]: any } | null,
     config: { [key: string]: any } = {},
     loginRequiredCallback?: () => any,
-    accessToken?: string,
+    authConfig?: AuthConfig,
     extraResponseAttributes: ExtraResponseAttributes[] = []
   ) {
     config = {
@@ -601,7 +601,7 @@ export default class SASjs {
             data,
             config,
             loginRequiredCallback,
-            accessToken
+            authConfig
           )
         } else {
           return await this.jesJobExecutor!.execute(
@@ -609,7 +609,7 @@ export default class SASjs {
             data,
             config,
             loginRequiredCallback,
-            accessToken,
+            authConfig,
             extraResponseAttributes
           )
         }
@@ -625,7 +625,7 @@ export default class SASjs {
           data,
           config,
           loginRequiredCallback,
-          accessToken,
+          authConfig,
           extraResponseAttributes
         )
       }
@@ -776,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 }.
@@ -787,7 +787,7 @@ export default class SASjs {
     sasJob: string,
     data: any,
     config: any = {},
-    accessToken?: string,
+    authConfig?: AuthConfig,
     waitForResult?: boolean,
     pollOptions?: PollOptions,
     printPid = false,
@@ -810,7 +810,7 @@ export default class SASjs {
       config.contextName,
       config.debug,
       data,
-      accessToken,
+      authConfig,
       !!waitForResult,
       false,
       pollOptions,

src/SessionManager.ts

@@ -1,4 +1,5 @@
-import { Session, Context, CsrfToken, SessionVariable } from './types'
+import { Session, Context, SessionVariable } from './types'
+import { NoSessionStateError } from './types/errors'
 import { asyncForEach, isUrl } from './utils'
 import { prefixMessage } from '@sasjs/utils/error'
 import { RequestClient } from './request/RequestClient'
@@ -6,10 +7,6 @@ import { RequestClient } from './request/RequestClient'
 const MAX_SESSION_COUNT = 1
 const RETRY_LIMIT: number = 3
 let RETRY_COUNT: number = 0
-const INTERNAL_SAS_ERROR = {
-  status: 304,
-  message: 'Not Modified'
-}
 
 export class SessionManager {
   constructor(
@@ -158,11 +155,13 @@ 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')
 
-    return new Promise(async (resolve, _) => {
+    return new Promise(async (resolve, reject) => {
       if (
         sessionState === 'pending' ||
         sessionState === 'running' ||
@@ -170,23 +169,24 @@ 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
           }
 
-          const state = await this.getSessionState(
-            `${this.serverUrl}${stateLink.href}?wait=30`,
-            etag!,
-            accessToken
-          ).catch((err) => {
-            throw err
-          })
+          const { result: state, responseStatus: responseStatus } =
+            await this.getSessionState(
+              `${this.serverUrl}${stateLink.href}?wait=30`,
+              etag!,
+              accessToken
+            ).catch((err) => {
+              throw prefixMessage(err, 'Error while getting session state.')
+            })
 
           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
@@ -194,13 +194,21 @@ export class SessionManager {
 
           // There is an internal error present in SAS Viya 3.5
           // Retry to wait for a session status in such case of SAS internal error
-          if (
-            sessionState === INTERNAL_SAS_ERROR.message &&
-            RETRY_COUNT < RETRY_LIMIT
-          ) {
-            RETRY_COUNT++
+          if (!sessionState) {
+            if (RETRY_COUNT < RETRY_LIMIT) {
+              RETRY_COUNT++
 
-            resolve(this.waitForSession(session, etag, accessToken))
+              resolve(this.waitForSession(session, etag, accessToken))
+            } else {
+              reject(
+                new NoSessionStateError(
+                  responseStatus,
+                  this.serverUrl + stateLink.href,
+                  session.links.find((l: any) => l.rel === 'log')
+                    ?.href as string
+                )
+              )
+            }
           }
 
           resolve(sessionState)
@@ -218,11 +226,11 @@ export class SessionManager {
   ) {
     return await this.requestClient
       .get(url, accessToken, 'text/plain', { 'If-None-Match': etag })
-      .then((res) => res.result as string)
+      .then((res) => ({
+        result: res.result as string,
+        responseStatus: res.status
+      }))
       .catch((err) => {
-        if (err.status === INTERNAL_SAS_ERROR.status)
-          return INTERNAL_SAS_ERROR.message
-
         throw err
       })
   }

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'
 

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>
 

src/job-execution/WebJobExecutor.ts

@@ -8,8 +8,9 @@ import { generateFileUploadForm } from '../file/generateFileUploadForm'
 import { generateTableUploadForm } from '../file/generateTableUploadForm'
 import { RequestClient } from '../request/RequestClient'
 import { SASViyaApiClient } from '../SASViyaApiClient'
-import { isRelativePath } from '../utils'
+import { isRelativePath, isValidJson } from '../utils'
 import { BaseJobExecutor } from './JobExecutor'
+import { parseWeboutResponse } from '../utils/parseWeboutResponse'
 
 export interface WaitingRequstPromise {
   promise: Promise<any> | null
@@ -100,6 +101,19 @@ export class WebJobExecutor extends BaseJobExecutor {
             this.appendRequest(res, sasJob, config.debug)
             resolve(jsonResponse)
           }
+          if (this.serverType === ServerType.Sas9 && config.debug) {
+            const jsonResponse = parseWeboutResponse(res.result as string)
+            if (jsonResponse === '') {
+              throw new Error(
+                'Valid JSON could not be extracted from response.'
+              )
+            }
+
+            isValidJson(jsonResponse)
+            this.appendRequest(res, sasJob, config.debug)
+            resolve(res.result)
+          }
+          isValidJson(res.result as string)
           this.appendRequest(res, sasJob, config.debug)
           resolve(res.result)
         })

src/request/RequestClient.ts

@@ -11,6 +11,7 @@ import {
 import { parseWeboutResponse } from '../utils/parseWeboutResponse'
 import { prefixMessage } from '@sasjs/utils/error'
 import { SAS9AuthError } from '../types/errors/SAS9AuthError'
+import { isValidJson } from '../utils'
 
 export interface HttpClient {
   get<T>(
@@ -63,6 +64,9 @@ export class RequestClient implements HttpClient {
         baseURL: baseUrl
       })
     }
+
+    this.httpClient.defaults.validateStatus = (status) =>
+      status >= 200 && status < 305
   }
 
   public getCsrfToken(type: 'general' | 'file' = 'general') {
@@ -80,7 +84,7 @@ export class RequestClient implements HttpClient {
     contentType: string = 'application/json',
     overrideHeaders: { [key: string]: string | number } = {},
     debug: boolean = false
-  ): Promise<{ result: T; etag: string }> {
+  ): Promise<{ result: T; etag: string; status: number }> {
     const headers = {
       ...this.getHeaders(accessToken, contentType),
       ...overrideHeaders
@@ -287,7 +291,8 @@ export class RequestClient implements HttpClient {
       })
       .then((res) => res.data)
       .catch((error) => {
-        console.log(error)
+        const logger = process.logger || console
+        logger.error(error)
       })
   }
 
@@ -419,7 +424,13 @@ export class RequestClient implements HttpClient {
       }
     } catch {
       try {
-        parsedResponse = JSON.parse(parseWeboutResponse(response.data))
+        const weboutResponse = parseWeboutResponse(response.data)
+        if (weboutResponse === '') {
+          throw new Error('Valid JSON could not be extracted from response.')
+        }
+
+        const jsonResponse = isValidJson(weboutResponse)
+        parsedResponse = jsonResponse
       } catch {
         parsedResponse = response.data
       }
@@ -427,9 +438,15 @@ export class RequestClient implements HttpClient {
       includeSAS9Log = true
     }
 
-    let responseToReturn: { result: T; etag: any; log?: string } = {
+    let responseToReturn: {
+      result: T
+      etag: any
+      log?: string
+      status: number
+    } = {
       result: parsedResponse as T,
-      etag
+      etag,
+      status: response.status
     }
 
     if (includeSAS9Log) {

src/request/Sas9RequestClient.ts

@@ -39,7 +39,7 @@ export class Sas9RequestClient extends RequestClient {
     contentType: string = 'application/json',
     overrideHeaders: { [key: string]: string | number } = {},
     debug: boolean = false
-  ): Promise<{ result: T; etag: string }> {
+  ): Promise<{ result: T; etag: string; status: number }> {
     const headers = {
       ...this.getHeaders(accessToken, contentType),
       ...overrideHeaders

src/test/SessionManager.spec.ts

@@ -1,7 +1,9 @@
 import { SessionManager } from '../SessionManager'
-import * as dotenv from 'dotenv'
 import { RequestClient } from '../request/RequestClient'
+import { NoSessionStateError } from '../types/errors'
+import * as dotenv from 'dotenv'
 import axios from 'axios'
+
 jest.mock('axios')
 const mockedAxios = axios as jest.Mocked<typeof axios>
 
@@ -43,4 +45,38 @@ describe('SessionManager', () => {
       ).resolves.toEqual(expectedResponse)
     })
   })
+
+  describe('waitForSession', () => {
+    it('should reject with NoSessionStateError if SAS server did not provide session state', async () => {
+      const responseStatus = 304
+
+      mockedAxios.get.mockImplementation(() =>
+        Promise.resolve({ data: '', status: responseStatus })
+      )
+
+      await expect(
+        sessionManager['waitForSession'](
+          {
+            id: 'id',
+            state: '',
+            links: [
+              { rel: 'state', href: '', uri: '', type: '', method: 'GET' }
+            ],
+            attributes: {
+              sessionInactiveTimeout: 0
+            },
+            creationTimeStamp: ''
+          },
+          null,
+          'access_token'
+        )
+      ).rejects.toEqual(
+        new NoSessionStateError(
+          responseStatus,
+          process.env.SERVER_URL as string,
+          'logUrl'
+        )
+      )
+    })
+  })
 })

src/test/utils/isValidJson.spec.ts

@@ -0,0 +1,31 @@
+import { isValidJson } from '../../utils'
+
+describe('jsonValidator', () => {
+  it('should not throw an error with an valid json', () => {
+    const json = {
+      test: 'test'
+    }
+
+    expect(isValidJson(json)).toBe(json)
+  })
+
+  it('should not throw an error with an valid json string', () => {
+    const json = {
+      test: 'test'
+    }
+
+    expect(isValidJson(JSON.stringify(json))).toStrictEqual(json)
+  })
+
+  it('should throw an error with an invalid json', () => {
+    const json = `{\"test\":\"test\"\"test2\":\"test\"}`
+
+    expect(() => {
+      try {
+        isValidJson(json)
+      } catch (err) {
+        throw new Error()
+      }
+    }).toThrowError
+  })
+})

src/types/Process.d.ts

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

src/types/errors/NoSessionStateError.ts

@@ -0,0 +1,15 @@
+export class NoSessionStateError extends Error {
+  constructor(
+    public serverResponseStatus: number,
+    public sessionStateUrl: string,
+    public logUrl: string
+  ) {
+    super(
+      `Could not get session state. Server responded with ${serverResponseStatus} whilst checking state: ${sessionStateUrl}`
+    )
+
+    this.name = 'NoSessionStatus'
+
+    Object.setPrototypeOf(this, NoSessionStateError.prototype)
+  }
+}

src/types/errors/index.ts

@@ -5,3 +5,4 @@ export * from './JobExecutionError'
 export * from './LoginRequiredError'
 export * from './NotFoundError'
 export * from './ErrorResponse'
+export * from './NoSessionStateError'

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

@@ -12,3 +12,4 @@ export * from './serialize'
 export * from './splitChunks'
 export * from './parseWeboutResponse'
 export * from './fetchLogByChunks'
+export * from './isValidJson'

src/utils/isValidJson.ts

@@ -0,0 +1,13 @@
+/**
+ * Checks if string is in valid JSON format else throw error.
+ * @param str - string to check.
+ */
+export const isValidJson = (str: string | object) => {
+  try {
+    if (typeof str === 'object') return str
+
+    return JSON.parse(str)
+  } catch (e) {
+    throw new Error('Invalid JSON response.')
+  }
+}

webpack.config.js

@@ -1,6 +1,7 @@
 const path = require('path')
 const webpack = require('webpack')
 const terserPlugin = require('terser-webpack-plugin')
+const nodePolyfillPlugin = require('node-polyfill-webpack-plugin')
 
 const defaultPlugins = [
   new webpack.ContextReplacementPlugin(/moment[\/\\]locale$/, /en/),
@@ -37,7 +38,7 @@ const browserConfig = {
   },
   resolve: {
     extensions: ['.ts', '.js'],
-    fallback: { https: false }
+    fallback: { https: false, fs: false, readline: false }
   },
   output: {
     filename: 'index.js',
@@ -49,7 +50,8 @@ const browserConfig = {
     ...defaultPlugins,
     new webpack.ProvidePlugin({
       process: 'process/browser'
-    })
+    }),
+    new nodePolyfillPlugin()
   ]
 }