Merge pull request #491 from sasjs/session-state-fix

fix(session): remove retry limit if could not get state

.all-contributorsrc

@@ -1,24 +1,103 @@
 {
+  "projectName": "adapter",
+  "projectOwner": "sasjs",
+  "repoType": "github",
+  "repoHost": "https://github.com",
   "files": [
     "README.md"
   ],
   "imageSize": 100,
   "commit": false,
+  "commitConvention": "angular",
   "contributors": [
+    {
+      "login": "krishna-acondy",
+      "name": "Krishna Acondy",
+      "avatar_url": "https://avatars.githubusercontent.com/u/2980428?v=4",
+      "profile": "https://krishna-acondy.io/",
+      "contributions": [
+        "code",
+        "infra",
+        "blog",
+        "content",
+        "ideas",
+        "video"
+      ]
+    },
+    {
+      "login": "YuryShkoda",
+      "name": "Yury Shkoda",
+      "avatar_url": "https://avatars.githubusercontent.com/u/25773492?v=4",
+      "profile": "https://www.erudicat.com/",
+      "contributions": [
+        "code",
+        "infra",
+        "ideas",
+        "test",
+        "video"
+      ]
+    },
     {
       "login": "medjedovicm",
       "name": "Mihajlo Medjedovic",
       "avatar_url": "https://avatars.githubusercontent.com/u/18329105?v=4",
       "profile": "https://github.com/medjedovicm",
       "contributions": [
-        "code"
+        "code",
+        "infra",
+        "test",
+        "review"
+      ]
+    },
+    {
+      "login": "allanbowe",
+      "name": "Allan Bowe",
+      "avatar_url": "https://avatars.githubusercontent.com/u/4420615?v=4",
+      "profile": "https://github.com/allanbowe",
+      "contributions": [
+        "code",
+        "review",
+        "test",
+        "mentoring",
+        "maintenance"
+      ]
+    },
+    {
+      "login": "saadjutt01",
+      "name": "Muhammad Saad ",
+      "avatar_url": "https://avatars.githubusercontent.com/u/8914650?v=4",
+      "profile": "https://github.com/saadjutt01",
+      "contributions": [
+        "code",
+        "review",
+        "test",
+        "mentoring",
+        "infra"
+      ]
+    },
+    {
+      "login": "sabhas",
+      "name": "Sabir Hassan",
+      "avatar_url": "https://avatars.githubusercontent.com/u/82647447?v=4",
+      "profile": "https://github.com/sabhas",
+      "contributions": [
+        "code",
+        "review",
+        "test",
+        "ideas"
+      ]
+    },
+    {
+      "login": "VladislavParhomchik",
+      "name": "VladislavParhomchik",
+      "avatar_url": "https://avatars.githubusercontent.com/u/83717836?v=4",
+      "profile": "https://github.com/VladislavParhomchik",
+      "contributions": [
+        "test",
+        "review"
       ]
     }
   ],
   "contributorsPerLine": 7,
-  "projectName": "adapter",
-  "projectOwner": "sasjs",
-  "repoType": "github",
-  "repoHost": "https://github.com",
   "skipCi": true
 }

.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

PULL_REQUEST_TEMPLATE.md

@@ -12,9 +12,9 @@ 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.
+No PR (that involves a non-trivial code change) should be merged, unless all 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`).
 - [ ] All `sasjs-tests` are passing (instructions available [here](https://github.com/sasjs/adapter/blob/master/sasjs-tests/README.md)).
+- [ ] [Data Controller](https://datacontroller.io) builds and is functional on both SAS 9 and Viya

README.md

@@ -172,7 +172,7 @@ 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` - 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.  
+* `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).
@@ -236,6 +236,9 @@ If you find this library useful, help us grow our star graph!
 ![](https://starchart.cc/sasjs/adapter.svg)
 
 ## Contributors ✨
+<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
+[![All Contributors](https://img.shields.io/badge/all_contributors-7-orange.svg?style=flat-square)](#contributors-)
+<!-- ALL-CONTRIBUTORS-BADGE:END -->
 
 Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
 
@@ -244,7 +247,13 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
 <!-- markdownlint-disable -->
 <table>
   <tr>
-    <td align="center"><a href="https://github.com/medjedovicm"><img src="https://avatars.githubusercontent.com/u/18329105?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Mihajlo Medjedovic</b></sub></a><br /><a href="https://github.com/sasjs/adapter/commits?author=medjedovicm" title="Code">💻</a></td>
+    <td align="center"><a href="https://krishna-acondy.io/"><img src="https://avatars.githubusercontent.com/u/2980428?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Krishna Acondy</b></sub></a><br /><a href="https://github.com/sasjs/adapter/commits?author=krishna-acondy" title="Code">💻</a> <a href="#infra-krishna-acondy" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="#blog-krishna-acondy" title="Blogposts">📝</a> <a href="#content-krishna-acondy" title="Content">🖋</a> <a href="#ideas-krishna-acondy" title="Ideas, Planning, & Feedback">🤔</a> <a href="#video-krishna-acondy" title="Videos">📹</a></td>
+    <td align="center"><a href="https://www.erudicat.com/"><img src="https://avatars.githubusercontent.com/u/25773492?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Yury Shkoda</b></sub></a><br /><a href="https://github.com/sasjs/adapter/commits?author=YuryShkoda" title="Code">💻</a> <a href="#infra-YuryShkoda" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="#ideas-YuryShkoda" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/sasjs/adapter/commits?author=YuryShkoda" title="Tests">⚠️</a> <a href="#video-YuryShkoda" title="Videos">📹</a></td>
+    <td align="center"><a href="https://github.com/medjedovicm"><img src="https://avatars.githubusercontent.com/u/18329105?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Mihajlo Medjedovic</b></sub></a><br /><a href="https://github.com/sasjs/adapter/commits?author=medjedovicm" title="Code">💻</a> <a href="#infra-medjedovicm" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="https://github.com/sasjs/adapter/commits?author=medjedovicm" title="Tests">⚠️</a> <a href="https://github.com/sasjs/adapter/pulls?q=is%3Apr+reviewed-by%3Amedjedovicm" title="Reviewed Pull Requests">👀</a></td>
+    <td align="center"><a href="https://github.com/allanbowe"><img src="https://avatars.githubusercontent.com/u/4420615?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Allan Bowe</b></sub></a><br /><a href="https://github.com/sasjs/adapter/commits?author=allanbowe" title="Code">💻</a> <a href="https://github.com/sasjs/adapter/pulls?q=is%3Apr+reviewed-by%3Aallanbowe" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/sasjs/adapter/commits?author=allanbowe" title="Tests">⚠️</a> <a href="#mentoring-allanbowe" title="Mentoring">🧑‍🏫</a> <a href="#maintenance-allanbowe" title="Maintenance">🚧</a></td>
+    <td align="center"><a href="https://github.com/saadjutt01"><img src="https://avatars.githubusercontent.com/u/8914650?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Muhammad Saad </b></sub></a><br /><a href="https://github.com/sasjs/adapter/commits?author=saadjutt01" title="Code">💻</a> <a href="https://github.com/sasjs/adapter/pulls?q=is%3Apr+reviewed-by%3Asaadjutt01" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/sasjs/adapter/commits?author=saadjutt01" title="Tests">⚠️</a> <a href="#mentoring-saadjutt01" title="Mentoring">🧑‍🏫</a> <a href="#infra-saadjutt01" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a></td>
+    <td align="center"><a href="https://github.com/sabhas"><img src="https://avatars.githubusercontent.com/u/82647447?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Sabir Hassan</b></sub></a><br /><a href="https://github.com/sasjs/adapter/commits?author=sabhas" title="Code">💻</a> <a href="https://github.com/sasjs/adapter/pulls?q=is%3Apr+reviewed-by%3Asabhas" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/sasjs/adapter/commits?author=sabhas" title="Tests">⚠️</a> <a href="#ideas-sabhas" title="Ideas, Planning, & Feedback">🤔</a></td>
+    <td align="center"><a href="https://github.com/VladislavParhomchik"><img src="https://avatars.githubusercontent.com/u/83717836?v=4?s=100" width="100px;" alt=""/><br /><sub><b>VladislavParhomchik</b></sub></a><br /><a href="https://github.com/sasjs/adapter/commits?author=VladislavParhomchik" title="Tests">⚠️</a> <a href="https://github.com/sasjs/adapter/pulls?q=is%3Apr+reviewed-by%3AVladislavParhomchik" title="Reviewed Pull Requests">👀</a></td>
   </tr>
 </table>
 

src/FileUploader.ts

@@ -1,4 +1,4 @@
-import { isUrl } from './utils'
+import { isUrl, getValidJson, parseSasViyaDebugResponse } from './utils'
 import { UploadFile } from './types/UploadFile'
 import { ErrorResponse, LoginRequiredError } from './types/errors'
 import { RequestClient } from './request/RequestClient'
@@ -63,13 +63,28 @@ export class FileUploader {
 
     return this.requestClient
       .post(uploadUrl, formData, undefined, 'application/json', headers)
-      .then((res) => {
-        let result
+      .then(async (res) => {
+        // for web approach on Viya
+        if (
+          this.sasjsConfig.debug &&
+          (this.sasjsConfig.useComputeApi === null ||
+            this.sasjsConfig.useComputeApi === undefined) &&
+          this.sasjsConfig.serverType === ServerType.SasViya
+        ) {
+          const jsonResponse = await parseSasViyaDebugResponse(
+            res.result as string,
+            this.requestClient,
+            this.sasjsConfig.serverUrl
+          )
+          return typeof jsonResponse === 'string'
+            ? getValidJson(jsonResponse)
+            : jsonResponse
+        }
 
-        result =
-          typeof res.result === 'string' ? JSON.parse(res.result) : res.result
+        return typeof res.result === 'string'
+          ? getValidJson(res.result)
+          : res.result
 
-        return result
         //TODO: append to SASjs requests
       })
       .catch((err: Error) => {

src/SASViyaApiClient.spec.ts

@@ -0,0 +1,51 @@
+import { Logger, LogLevel } from '@sasjs/utils/logger'
+import { RequestClient } from './request/RequestClient'
+import { SASViyaApiClient } from './SASViyaApiClient'
+import { Folder } from './types'
+import { RootFolderNotFoundError } from './types/errors'
+
+const mockFolder: Folder = {
+  id: '1',
+  uri: '/folder',
+  links: [],
+  memberCount: 1
+}
+
+const requestClient = new (<jest.Mock<RequestClient>>RequestClient)()
+const sasViyaApiClient = new SASViyaApiClient(
+  'https://test.com',
+  '/test',
+  'test context',
+  requestClient
+)
+
+describe('SASViyaApiClient', () => {
+  beforeEach(() => {
+    ;(process as any).logger = new Logger(LogLevel.Off)
+    setupMocks()
+  })
+
+  it('should throw an error when the root folder is not found on the server', async () => {
+    jest
+      .spyOn(requestClient, 'get')
+      .mockImplementation(() => Promise.reject('Not Found'))
+    const error = await sasViyaApiClient
+      .createFolder('test', '/foo')
+      .catch((e) => e)
+    expect(error).toBeInstanceOf(RootFolderNotFoundError)
+  })
+})
+
+const setupMocks = () => {
+  jest
+    .spyOn(requestClient, 'get')
+    .mockImplementation(() =>
+      Promise.resolve({ result: mockFolder, etag: '', status: 200 })
+    )
+
+  jest
+    .spyOn(requestClient, 'post')
+    .mockImplementation(() =>
+      Promise.resolve({ result: mockFolder, etag: '', status: 200 })
+    )
+}

src/SASViyaApiClient.ts

@@ -11,7 +11,7 @@ import {
   JobDefinition,
   PollOptions
 } from './types'
-import { JobExecutionError } from './types/errors'
+import { JobExecutionError, RootFolderNotFoundError } from './types/errors'
 import { SessionManager } from './SessionManager'
 import { ContextManager } from './ContextManager'
 import { SasAuthResponse, MacroVar, AuthConfig } from '@sasjs/utils/types'
@@ -381,7 +381,11 @@ export class SASViyaApiClient {
         )
         const newFolderName = `${parentFolderPath.split('/').pop()}`
         if (newParentFolderPath === '') {
-          throw new Error('Root folder has to be present on the server.')
+          throw new RootFolderNotFoundError(
+            parentFolderPath,
+            this.serverUrl,
+            accessToken
+          )
         }
         logger.info(
           `Creating parent folder:\n'${newFolderName}' in '${newParentFolderPath}'`

src/SASjs.ts

@@ -544,11 +544,22 @@ export default class SASjs {
    *  Process). Is prepended at runtime with the value of `appLoc`.
    * @param files - array of files to be uploaded, including File object and file name.
    * @param params - request URL parameters.
+   * @param overrideSasjsConfig - object to override existing config (optional)
    */
-  public uploadFile(sasJob: string, files: UploadFile[], params: any) {
-    const fileUploader =
-      this.fileUploader ||
-      new FileUploader(this.sasjsConfig, this.jobsPath, this.requestClient!)
+  public uploadFile(
+    sasJob: string,
+    files: UploadFile[],
+    params: any,
+    overrideSasjsConfig?: any
+  ) {
+    const fileUploader = overrideSasjsConfig
+      ? new FileUploader(
+          { ...this.sasjsConfig, ...overrideSasjsConfig },
+          this.jobsPath,
+          this.requestClient!
+        )
+      : this.fileUploader ||
+        new FileUploader(this.sasjsConfig, this.jobsPath, this.requestClient!)
 
     return fileUploader.uploadFile(sasJob, files, params)
   }

src/SessionManager.ts

@@ -5,10 +5,10 @@ import { prefixMessage } from '@sasjs/utils/error'
 import { RequestClient } from './request/RequestClient'
 
 const MAX_SESSION_COUNT = 1
-const RETRY_LIMIT: number = 3
-let RETRY_COUNT: number = 0
 
 export class SessionManager {
+  private loggedErrors: NoSessionStateError[] = []
+
   constructor(
     private serverUrl: string,
     private contextName: string,
@@ -154,69 +154,75 @@ export class SessionManager {
     session: Session,
     etag: string | null,
     accessToken?: string
-  ) {
+  ): Promise<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, reject) => {
-      if (
-        sessionState === 'pending' ||
-        sessionState === 'running' ||
-        sessionState === ''
-      ) {
-        if (stateLink) {
-          if (this.debug && !this.printedSessionState.printed) {
-            logger.info('Polling session status...')
+    if (
+      sessionState === 'pending' ||
+      sessionState === 'running' ||
+      sessionState === ''
+    ) {
+      if (stateLink) {
+        if (this.debug && !this.printedSessionState.printed) {
+          logger.info('Polling session status...')
 
-            this.printedSessionState.printed = true
-          }
-
-          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) {
-            logger.info(`Current session state is '${sessionState}'`)
-
-            this.printedSessionState.state = sessionState
-            this.printedSessionState.printed = false
-          }
-
-          // 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) {
-            if (RETRY_COUNT < RETRY_LIMIT) {
-              RETRY_COUNT++
-
-              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)
+          this.printedSessionState.printed = true
         }
+
+        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) {
+          logger.info(`Current session state is '${sessionState}'`)
+
+          this.printedSessionState.state = sessionState
+          this.printedSessionState.printed = false
+        }
+
+        if (!sessionState) {
+          const stateError = new NoSessionStateError(
+            responseStatus,
+            this.serverUrl + stateLink.href,
+            session.links.find((l: any) => l.rel === 'log')?.href as string
+          )
+
+          if (
+            !this.loggedErrors.find(
+              (err: NoSessionStateError) =>
+                err.serverResponseStatus === stateError.serverResponseStatus
+            )
+          ) {
+            this.loggedErrors.push(stateError)
+
+            logger.info(stateError.message)
+          }
+
+          return await this.waitForSession(session, etag, accessToken)
+        }
+
+        this.loggedErrors = []
+
+        return sessionState
       } else {
-        resolve(sessionState)
+        throw 'Error while getting session state link.'
       }
-    })
+    } else {
+      this.loggedErrors = []
+
+      return sessionState
+    }
   }
 
   private async getSessionState(

src/api/viya/getFileStream.ts

@@ -0,0 +1,17 @@
+import { isFolder } from '@sasjs/utils/file'
+import { generateTimestamp } from '@sasjs/utils/time'
+import { Job } from '../../types'
+
+export const getFileStream = async (job: Job, filePath?: string) => {
+  const { createWriteStream } = require('@sasjs/utils/file')
+  const logPath = filePath || process.cwd()
+  const isFolderPath = await isFolder(logPath)
+  if (isFolderPath) {
+    const logFileName = `${job.name || 'job'}-${generateTimestamp()}.log`
+    const path = require('path')
+    const logFilePath = path.join(filePath || process.cwd(), logFileName)
+    return await createWriteStream(logFilePath)
+  } else {
+    return await createWriteStream(logPath)
+  }
+}

src/api/viya/pollJobState.ts

@@ -3,11 +3,8 @@ import { Job, PollOptions } from '../..'
 import { getTokens } from '../../auth/getTokens'
 import { RequestClient } from '../../request/RequestClient'
 import { JobStatePollError } from '../../types/errors'
-import { generateTimestamp } from '@sasjs/utils/time'
-import { saveLog } from './saveLog'
-import { createWriteStream, isFolder } from '@sasjs/utils/file'
-import { WriteStream } from 'fs'
-import { Link } from '../../types'
+import { Link, WriteStream } from '../../types'
+import { isNode } from '../../utils'
 
 export async function pollJobState(
   requestClient: RequestClient,
@@ -55,21 +52,9 @@ export async function pollJobState(
   }
 
   let logFileStream
-  if (pollOptions.streamLog) {
-    const logPath = pollOptions?.logFolderPath || process.cwd()
-    const isFolderPath = await isFolder(logPath)
-    if (isFolderPath) {
-      const logFileName = `${
-        postedJob.name || 'job'
-      }-${generateTimestamp()}.log`
-      const logFilePath = `${
-        pollOptions?.logFolderPath || process.cwd()
-      }/${logFileName}`
-
-      logFileStream = await createWriteStream(logFilePath)
-    } else {
-      logFileStream = await createWriteStream(logPath)
-    }
+  if (pollOptions.streamLog && isNode()) {
+    const { getFileStream } = require('./getFileStream')
+    logFileStream = await getFileStream(postedJob, pollOptions.logFolderPath)
   }
 
   // Poll up to the first 100 times with the specified poll interval
@@ -230,14 +215,17 @@ const doPoll = async (
 
       const endLogLine = job.logStatistics?.lineCount ?? 1000000
 
-      await saveLog(
-        postedJob,
-        requestClient,
-        startLogLine,
-        endLogLine,
-        logStream,
-        authConfig?.access_token
-      )
+      const { saveLog } = isNode() ? require('./saveLog') : { saveLog: null }
+      if (saveLog) {
+        await saveLog(
+          postedJob,
+          requestClient,
+          startLogLine,
+          endLogLine,
+          logStream,
+          authConfig?.access_token
+        )
+      }
 
       startLogLine += endLogLine
     }

src/api/viya/saveLog.ts

@@ -1,7 +1,7 @@
 import { Job } from '../..'
 import { RequestClient } from '../../request/RequestClient'
 import { fetchLog } from '../../utils'
-import { WriteStream } from 'fs'
+import { WriteStream } from '../../types'
 import { writeStream } from './writeStream'
 
 /**

src/api/viya/spec/getFileStream.spec.ts

@@ -0,0 +1,41 @@
+import { Logger, LogLevel } from '@sasjs/utils/logger'
+import * as path from 'path'
+import * as fileModule from '@sasjs/utils/file'
+import { getFileStream } from '../getFileStream'
+import { mockJob } from './mockResponses'
+import { WriteStream } from '../../../types'
+
+describe('getFileStream', () => {
+  beforeEach(() => {
+    ;(process as any).logger = new Logger(LogLevel.Off)
+    setupMocks()
+  })
+  it('should use the given log path if it points to a file', async () => {
+    const { createWriteStream } = require('@sasjs/utils/file')
+
+    await getFileStream(mockJob, path.join(__dirname, 'test.log'))
+
+    expect(createWriteStream).toHaveBeenCalledWith(
+      path.join(__dirname, 'test.log')
+    )
+  })
+
+  it('should generate a log file path with a timestamp if it points to a folder', async () => {
+    const { createWriteStream } = require('@sasjs/utils/file')
+
+    await getFileStream(mockJob, __dirname)
+
+    expect(createWriteStream).not.toHaveBeenCalledWith(__dirname)
+    expect(createWriteStream).toHaveBeenCalledWith(
+      expect.stringContaining(path.join(__dirname, 'test job-20'))
+    )
+  })
+})
+
+const setupMocks = () => {
+  jest.restoreAllMocks()
+  jest.mock('@sasjs/utils/file/file')
+  jest
+    .spyOn(fileModule, 'createWriteStream')
+    .mockImplementation(() => Promise.resolve({} as unknown as WriteStream))
+}

src/api/viya/spec/pollJobState.spec.ts

@@ -1,11 +1,11 @@
 import { Logger, LogLevel } from '@sasjs/utils'
-import * as path from 'path'
-import * as fileModule from '@sasjs/utils/file'
 import { RequestClient } from '../../../request/RequestClient'
 import { mockAuthConfig, mockJob } from './mockResponses'
 import { pollJobState } from '../pollJobState'
 import * as getTokensModule from '../../../auth/getTokens'
 import * as saveLogModule from '../saveLog'
+import * as getFileStreamModule from '../getFileStream'
+import * as isNodeModule from '../../../utils/isNode'
 import { PollOptions } from '../../../types'
 import { WriteStream } from 'fs'
 
@@ -77,42 +77,43 @@ describe('pollJobState', () => {
 
   it('should attempt to fetch and save the log after each poll when streamLog is true', async () => {
     mockSimplePoll()
+    const { saveLog } = require('../saveLog')
 
     await pollJobState(requestClient, mockJob, false, mockAuthConfig, {
       ...defaultPollOptions,
       streamLog: true
     })
 
-    expect(saveLogModule.saveLog).toHaveBeenCalledTimes(2)
+    expect(saveLog).toHaveBeenCalledTimes(2)
   })
 
-  it('should use the given log path if it points to a file', async () => {
+  it('should create a write stream in Node.js environment when streamLog is true', async () => {
     mockSimplePoll()
+    const { getFileStream } = require('../getFileStream')
+    const { saveLog } = require('../saveLog')
 
     await pollJobState(requestClient, mockJob, false, mockAuthConfig, {
       ...defaultPollOptions,
-      streamLog: true,
-      logFolderPath: path.join(__dirname, 'test.log')
+      streamLog: true
     })
 
-    expect(fileModule.createWriteStream).toHaveBeenCalledWith(
-      path.join(__dirname, 'test.log')
-    )
+    expect(getFileStream).toHaveBeenCalled()
+    expect(saveLog).toHaveBeenCalledTimes(2)
   })
 
-  it('should generate a log file path with a timestamp if it points to a folder', async () => {
+  it('should not create a write stream in a non-Node.js environment', async () => {
     mockSimplePoll()
+    jest.spyOn(isNodeModule, 'isNode').mockImplementation(() => false)
+    const { saveLog } = require('../saveLog')
+    const { getFileStream } = require('../getFileStream')
 
     await pollJobState(requestClient, mockJob, false, mockAuthConfig, {
       ...defaultPollOptions,
-      streamLog: true,
-      logFolderPath: path.join(__dirname)
+      streamLog: true
     })
 
-    expect(fileModule.createWriteStream).not.toHaveBeenCalledWith(__dirname)
-    expect(fileModule.createWriteStream).toHaveBeenCalledWith(
-      expect.stringContaining(__dirname + '/test job-20')
-    )
+    expect(getFileStream).not.toHaveBeenCalled()
+    expect(saveLog).not.toHaveBeenCalled()
   })
 
   it('should not attempt to fetch and save the log after each poll when streamLog is false', async () => {
@@ -247,7 +248,8 @@ const setupMocks = () => {
   jest.mock('../../../request/RequestClient')
   jest.mock('../../../auth/getTokens')
   jest.mock('../saveLog')
-  jest.mock('@sasjs/utils/file')
+  jest.mock('../getFileStream')
+  jest.mock('../../../utils/isNode')
 
   jest
     .spyOn(requestClient, 'get')
@@ -261,8 +263,9 @@ const setupMocks = () => {
     .spyOn(saveLogModule, 'saveLog')
     .mockImplementation(() => Promise.resolve())
   jest
-    .spyOn(fileModule, 'createWriteStream')
+    .spyOn(getFileStreamModule, 'getFileStream')
     .mockImplementation(() => Promise.resolve({} as unknown as WriteStream))
+  jest.spyOn(isNodeModule, 'isNode').mockImplementation(() => true)
 }
 
 const mockSimplePoll = (runningCount = 2) => {
@@ -308,7 +311,7 @@ const mockLongPoll = () => {
       return Promise.resolve({ result: mockJob, etag: '', status: 200 })
     }
     return Promise.resolve({
-      result: count <= 101 ? 'running' : 'completed',
+      result: count <= 102 ? 'running' : 'completed',
       etag: '',
       status: 200
     })

src/api/viya/spec/saveLog.spec.ts

@@ -4,7 +4,7 @@ import * as fetchLogsModule from '../../../utils/fetchLogByChunks'
 import * as writeStreamModule from '../writeStream'
 import { saveLog } from '../saveLog'
 import { mockJob } from './mockResponses'
-import { WriteStream } from 'fs'
+import { WriteStream } from '../../../types'
 
 const requestClient = new (<jest.Mock<RequestClient>>RequestClient)()
 const stream = {} as unknown as WriteStream

src/api/viya/spec/writeStream.spec.ts

@@ -0,0 +1,25 @@
+import { WriteStream } from '../../../types'
+import { writeStream } from '../writeStream'
+import 'jest-extended'
+
+describe('writeStream', () => {
+  const stream: WriteStream = {
+    write: jest.fn(),
+    path: 'test'
+  }
+
+  it('should resolve when the stream is written successfully', async () => {
+    expect(writeStream(stream, 'test')).toResolve()
+
+    expect(stream.write).toHaveBeenCalledWith('test\n', expect.anything())
+  })
+
+  it('should reject when the write errors out', async () => {
+    jest
+      .spyOn(stream, 'write')
+      .mockImplementation((_, callback) => callback(new Error('Test Error')))
+    const error = await writeStream(stream, 'test').catch((e) => e)
+
+    expect(error.message).toEqual('Test Error')
+  })
+})

src/api/viya/writeStream.ts

@@ -1,11 +1,11 @@
-import { WriteStream } from 'fs'
+import { WriteStream } from '../../types'
 
 export const writeStream = async (
   stream: WriteStream,
   content: string
 ): Promise<void> => {
   return new Promise((resolve, reject) => {
-    stream.write(content + '\n\nnext chunk\n\n', (e) => {
+    stream.write(content + '\n', (e) => {
       if (e) {
         return reject(e)
       }

src/auth/getTokens.ts

@@ -1,9 +1,9 @@
 import {
-  AuthConfig,
   isAccessTokenExpiring,
   isRefreshTokenExpiring,
   hasTokenExpired
-} from '@sasjs/utils'
+} from '@sasjs/utils/auth'
+import { AuthConfig } from '@sasjs/utils/types'
 import { RequestClient } from '../request/RequestClient'
 import { refreshTokens } from './refreshTokens'
 

src/job-execution/WebJobExecutor.ts

@@ -8,7 +8,11 @@ import { generateFileUploadForm } from '../file/generateFileUploadForm'
 import { generateTableUploadForm } from '../file/generateTableUploadForm'
 import { RequestClient } from '../request/RequestClient'
 import { SASViyaApiClient } from '../SASViyaApiClient'
-import { isRelativePath, isValidJson } from '../utils'
+import {
+  isRelativePath,
+  getValidJson,
+  parseSasViyaDebugResponse
+} from '../utils'
 import { BaseJobExecutor } from './JobExecutor'
 import { parseWeboutResponse } from '../utils/parseWeboutResponse'
 
@@ -95,8 +99,10 @@ export class WebJobExecutor extends BaseJobExecutor {
       this.requestClient!.post(apiUrl, formData, undefined)
         .then(async (res) => {
           if (this.serverType === ServerType.SasViya && config.debug) {
-            const jsonResponse = await this.parseSasViyaDebugResponse(
-              res.result as string
+            const jsonResponse = await parseSasViyaDebugResponse(
+              res.result as string,
+              this.requestClient,
+              this.serverUrl
             )
             this.appendRequest(res, sasJob, config.debug)
             resolve(jsonResponse)
@@ -109,11 +115,11 @@ export class WebJobExecutor extends BaseJobExecutor {
               )
             }
 
-            isValidJson(jsonResponse)
+            getValidJson(jsonResponse)
             this.appendRequest(res, sasJob, config.debug)
             resolve(res.result)
           }
-          isValidJson(res.result as string)
+          getValidJson(res.result as string)
           this.appendRequest(res, sasJob, config.debug)
           resolve(res.result)
         })
@@ -151,20 +157,6 @@ export class WebJobExecutor extends BaseJobExecutor {
     return requestPromise
   }
 
-  private parseSasViyaDebugResponse = async (response: string) => {
-    const iframeStart = response.split(
-      '<iframe style="width: 99%; height: 500px" src="'
-    )[1]
-    const jsonUrl = iframeStart ? iframeStart.split('"></iframe>')[0] : null
-    if (!jsonUrl) {
-      throw new Error('Unable to find webout file URL.')
-    }
-
-    return this.requestClient
-      .get(this.serverUrl + jsonUrl, undefined)
-      .then((res) => res.result)
-  }
-
   private async getJobUri(sasJob: string) {
     if (!this.sasViyaApiClient) return ''
     let uri = ''

src/request/RequestClient.ts

@@ -11,7 +11,7 @@ import {
 import { parseWeboutResponse } from '../utils/parseWeboutResponse'
 import { prefixMessage } from '@sasjs/utils/error'
 import { SAS9AuthError } from '../types/errors/SAS9AuthError'
-import { isValidJson } from '../utils'
+import { getValidJson } from '../utils'
 
 export interface HttpClient {
   get<T>(
@@ -434,7 +434,7 @@ export class RequestClient implements HttpClient {
           throw new Error('Valid JSON could not be extracted from response.')
         }
 
-        const jsonResponse = isValidJson(weboutResponse)
+        const jsonResponse = getValidJson(weboutResponse)
         parsedResponse = jsonResponse
       } catch {
         parsedResponse = response.data

src/test/SessionManager.spec.ts

@@ -3,6 +3,8 @@ import { RequestClient } from '../request/RequestClient'
 import { NoSessionStateError } from '../types/errors'
 import * as dotenv from 'dotenv'
 import axios from 'axios'
+import { Logger, LogLevel } from '@sasjs/utils'
+import { Session } from '../types'
 
 jest.mock('axios')
 const mockedAxios = axios as jest.Mocked<typeof axios>
@@ -47,36 +49,91 @@ describe('SessionManager', () => {
   })
 
   describe('waitForSession', () => {
+    const session: Session = {
+      id: 'id',
+      state: '',
+      links: [{ rel: 'state', href: '', uri: '', type: '', method: 'GET' }],
+      attributes: {
+        sessionInactiveTimeout: 0
+      },
+      creationTimeStamp: ''
+    }
+
+    beforeEach(() => {
+      ;(process as any).logger = new Logger(LogLevel.Off)
+    })
+
     it('should reject with NoSessionStateError if SAS server did not provide session state', async () => {
-      const responseStatus = 304
+      let requestAttempt = 0
+      const requestAttemptLimit = 10
+      const sessionState = 'idle'
+
+      mockedAxios.get.mockImplementation(() => {
+        requestAttempt += 1
+
+        if (requestAttempt >= requestAttemptLimit) {
+          return Promise.resolve({ data: sessionState, status: 200 })
+        }
+
+        return Promise.resolve({ data: '', status: 304 })
+      })
+
+      jest.spyOn((process as any).logger, 'info')
+
+      sessionManager.debug = true
+
+      await expect(
+        sessionManager['waitForSession'](session, null, 'access_token')
+      ).resolves.toEqual(sessionState)
+
+      expect(mockedAxios.get).toHaveBeenCalledTimes(requestAttemptLimit)
+      expect((process as any).logger.info).toHaveBeenCalledTimes(3)
+      expect((process as any).logger.info).toHaveBeenNthCalledWith(
+        1,
+        'Polling session status...'
+      )
+      expect((process as any).logger.info).toHaveBeenNthCalledWith(
+        2,
+        `Could not get session state. Server responded with 304 whilst checking state: ${process.env.SERVER_URL}`
+      )
+      expect((process as any).logger.info).toHaveBeenNthCalledWith(
+        3,
+        `Current session state is '${sessionState}'`
+      )
+    })
+
+    it('should throw an error if there is no session link', async () => {
+      const customSession = JSON.parse(JSON.stringify(session))
+      customSession.links = []
 
       mockedAxios.get.mockImplementation(() =>
-        Promise.resolve({ data: '', status: responseStatus })
+        Promise.resolve({ data: customSession.state, status: 200 })
       )
 
       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'
-        )
+        sessionManager['waitForSession'](customSession, null, 'access_token')
+      ).rejects.toContain('Error while getting session state link.')
+    })
+
+    it('should throw an error if could not get session state', async () => {
+      mockedAxios.get.mockImplementation(() => Promise.reject('Mocked error'))
+
+      await expect(
+        sessionManager['waitForSession'](session, null, 'access_token')
+      ).rejects.toContain('Error while getting session state.')
+    })
+
+    it('should return session state', async () => {
+      const customSession = JSON.parse(JSON.stringify(session))
+      customSession.state = 'completed'
+
+      mockedAxios.get.mockImplementation(() =>
+        Promise.resolve({ data: customSession.state, status: 200 })
       )
+
+      await expect(
+        sessionManager['waitForSession'](customSession, null, 'access_token')
+      ).resolves.toEqual(customSession.state)
     })
   })
 })

src/test/utils/getValidJson.spec.ts

@@ -0,0 +1,41 @@
+import { getValidJson } from '../../utils'
+
+describe('jsonValidator', () => {
+  it('should not throw an error with a valid json', () => {
+    const json = {
+      test: 'test'
+    }
+
+    expect(getValidJson(json)).toBe(json)
+  })
+
+  it('should not throw an error with a valid json string', () => {
+    const json = {
+      test: 'test'
+    }
+
+    expect(getValidJson(JSON.stringify(json))).toStrictEqual(json)
+  })
+
+  it('should throw an error with an invalid json', () => {
+    const json = `{\"test\":\"test\"\"test2\":\"test\"}`
+    let errorThrown = false
+    try {
+      getValidJson(json)
+    } catch (error) {
+      errorThrown = true
+    }
+    expect(errorThrown).toBe(true)
+  })
+
+  it('should throw an error when an array is passed', () => {
+    const array = ['hello', 'world']
+    let errorThrown = false
+    try {
+      getValidJson(array)
+    } catch (error) {
+      errorThrown = true
+    }
+    expect(errorThrown).toBe(true)
+  })
+})

src/test/utils/isValidJson.spec.ts

@@ -1,31 +0,0 @@
-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/WriteStream.ts

@@ -0,0 +1,4 @@
+export interface WriteStream {
+  write: (content: string, callback: (err?: Error) => any) => void
+  path: string
+}

src/types/errors/RootFolderNotFoundError.spec.ts

@@ -0,0 +1,40 @@
+import { RootFolderNotFoundError } from './RootFolderNotFoundError'
+
+describe('RootFolderNotFoundError', () => {
+  it('when access token is provided, error message should contain the scopes in the token', () => {
+    const token =
+      'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJzY29wZS0xIiwic2NvcGUtMiJdfQ.ktqPL2ulln-8Asa2jSV9QCfDYmQuNk4tNKopxJR5xZs'
+
+    const error = new RootFolderNotFoundError(
+      '/myProject',
+      'https://analytium.co.uk',
+      token
+    )
+
+    expect(error).toBeInstanceOf(RootFolderNotFoundError)
+    expect(error.message).toContain('scope-1')
+    expect(error.message).toContain('scope-2')
+  })
+
+  it('when access token is not provided, error message should not contain scopes', () => {
+    const error = new RootFolderNotFoundError(
+      '/myProject',
+      'https://analytium.co.uk'
+    )
+
+    expect(error).toBeInstanceOf(RootFolderNotFoundError)
+    expect(error.message).not.toContain(
+      'Your access token contains the following scopes'
+    )
+  })
+
+  it('should include the folder path and SASDrive URL in the message', () => {
+    const folderPath = '/myProject'
+    const serverUrl = 'https://analytium.co.uk'
+    const error = new RootFolderNotFoundError(folderPath, serverUrl)
+
+    expect(error).toBeInstanceOf(RootFolderNotFoundError)
+    expect(error.message).toContain(folderPath)
+    expect(error.message).toContain(`${serverUrl}/SASDrive`)
+  })
+})

src/types/errors/RootFolderNotFoundError.ts

@@ -0,0 +1,24 @@
+import { decodeToken } from '@sasjs/utils/auth'
+
+export class RootFolderNotFoundError extends Error {
+  constructor(
+    parentFolderPath: string,
+    serverUrl: string,
+    accessToken?: string
+  ) {
+    let message: string =
+      `Root folder ${parentFolderPath} was not found.` +
+      `\nPlease check ${serverUrl}/SASDrive.` +
+      `\nIf the folder DOES exist then it is likely a permission problem.\n`
+    if (accessToken) {
+      const decodedToken = decodeToken(accessToken)
+      let scope = decodedToken.scope
+      scope = scope.map((element) => '* ' + element)
+      message +=
+        `Your access token contains the following scopes:\n` + scope.join('\n')
+    }
+    super(message)
+    this.name = 'RootFolderNotFoundError'
+    Object.setPrototypeOf(this, RootFolderNotFoundError.prototype)
+  }
+}

src/types/errors/index.ts

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

src/types/index.ts

@@ -11,3 +11,4 @@ export * from './SASjsRequest'
 export * from './Session'
 export * from './UploadFile'
 export * from './PollOptions'
+export * from './WriteStream'

src/utils/getValidJson.ts

@@ -0,0 +1,16 @@
+/**
+ * if string passed then parse the string to json else if throw error for all other types unless it is not a valid json object.
+ * @param str - string to check.
+ */
+export const getValidJson = (str: string | object) => {
+  try {
+    if (Array.isArray(str)) {
+      throw new Error('Can not parse array object to json.')
+    }
+    if (typeof str === 'object') return str
+
+    return JSON.parse(str)
+  } catch (e) {
+    throw new Error('Invalid JSON response.')
+  }
+}

src/utils/index.ts

@@ -1,6 +1,7 @@
 export * from './asyncForEach'
 export * from './compareTimestamps'
 export * from './convertToCsv'
+export * from './isNode'
 export * from './isRelativePath'
 export * from './isUri'
 export * from './isUrl'
@@ -12,4 +13,5 @@ export * from './serialize'
 export * from './splitChunks'
 export * from './parseWeboutResponse'
 export * from './fetchLogByChunks'
-export * from './isValidJson'
+export * from './getValidJson'
+export * from './parseViyaDebugResponse'

src/utils/isNode.ts

@@ -0,0 +1,4 @@
+export const isNode = () =>
+  typeof process !== 'undefined' &&
+  process.versions != null &&
+  process.versions.node != null

src/utils/isValidJson.ts

@@ -1,13 +0,0 @@
-/**
- * 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.')
-  }
-}

src/utils/parseViyaDebugResponse.ts

@@ -0,0 +1,29 @@
+import { RequestClient } from '../request/RequestClient'
+
+/**
+ * When querying a Viya job using the Web approach (as opposed to using the APIs) with _DEBUG enabled,
+ * the first response contains the log with the content in an iframe. Therefore when debug is enabled,
+ * and the serverType is VIYA, and useComputeApi is null (WEB), we call this function to extract the
+ * (_webout) content from the iframe.
+ * @param response - first response from viya job
+ * @param requestClient
+ * @param serverUrl
+ * @returns
+ */
+export const parseSasViyaDebugResponse = async (
+  response: string,
+  requestClient: RequestClient,
+  serverUrl: string
+) => {
+  const iframeStart = response.split(
+    '<iframe style="width: 99%; height: 500px" src="'
+  )[1]
+  const jsonUrl = iframeStart ? iframeStart.split('"></iframe>')[0] : null
+  if (!jsonUrl) {
+    throw new Error('Unable to find webout file URL.')
+  }
+
+  return requestClient
+    .get(serverUrl + jsonUrl, undefined)
+    .then((res) => res.result)
+}