Merge pull request #814 from sasjs/issue-811-fixed

Issue 811 fixed

.github/vpn/config.ovpn

@@ -0,0 +1,25 @@
+# Client
+client
+tls-client
+dev tun
+# this will connect with whatever proto DNS tells us (https://community.openvpn.net/openvpn/ticket/934)
+proto tcp
+remote vpn.4gl.io 7494
+resolv-retry infinite
+cipher AES-256-CBC
+auth SHA256
+script-security 2
+keepalive 10 120
+remote-cert-tls server
+
+# Keys
+ca ca.crt
+cert user.crt
+key user.key
+tls-auth tls.key 1
+
+# Security
+nobind
+persist-key
+persist-tun
+verb 3

.github/workflows/build.yml

@@ -12,7 +12,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [lts/fermium]
+        node-version: [lts/hydrogen]
 
     steps:
       - uses: actions/checkout@v2
@@ -39,11 +39,33 @@ jobs:
         env:
           CI: true
 
-      - name: Install SSH Key
-        uses: shimataro/ssh-key-action@v2
-        with:
-          key: ${{ secrets.DCGITLAB_KEY }}
-          known_hosts: 'placeholder'
+      - name: Write VPN Files
+        run: |
+          echo "$CA_CRT" > .github/vpn/ca.crt
+          echo "$USER_CRT" > .github/vpn/user.crt
+          echo "$USER_KEY" > .github/vpn/user.key
+          echo "$TLS_KEY" > .github/vpn/tls.key
+        shell: bash
+        env:
+          CA_CRT: ${{ secrets.CA_CRT}}
+          USER_CRT: ${{ secrets.USER_CRT }}
+          USER_KEY: ${{ secrets.USER_KEY }}
+          TLS_KEY: ${{ secrets.TLS_KEY }}
+
+      - name: Install Open VPN
+        run: |
+          sudo apt install apt-transport-https
+          sudo wget https://swupdate.openvpn.net/repos/openvpn-repo-pkg-key.pub
+          sudo apt-key add openvpn-repo-pkg-key.pub
+          sudo wget -O /etc/apt/sources.list.d/openvpn3.list https://swupdate.openvpn.net/community/openvpn3/repos/openvpn3-jammy.list
+          sudo apt update
+          sudo apt install openvpn3=17~betaUb22042+jammy
+
+      - name: Start Open VPN 3
+        run: openvpn3 session-start --config .github/vpn/config.ovpn
+
+      - name: install pm2
+        run: npm i -g pm2
 
       - name: Deploy sasjs-tests
         run: |
@@ -55,12 +77,12 @@ jobs:
           replace-in-files --regex='"userName".*' --replacement='"userName":"${{ secrets.SASJS_USERNAME }}",' ./public/config.json
           replace-in-files --regex='"password".*' --replacement='"password":"${{ secrets.SASJS_PASSWORD }}",' ./public/config.json
           replace-in-files --regex='"serverType".*' --replacement='"serverType":"SASJS",' ./public/config.json
-          npm run update:adapter && npm run build
-          scp -o stricthostkeychecking=no -r ./build/* ${{ secrets.DCGITLAB_DEPLOY_PATH_VIYA }}
+          npm run update:adapter
+          pm2 start --name sasjs-test npm -- start
 
       - name: Run cypress on sasjs
         run: |
-          replace-in-files --regex='"sasjsTestsUrl".*' --replacement='"sasjsTestsUrl":"${{ secrets.SASJS_TEST_URL_VIYA }}",' ./cypress.json
+          replace-in-files --regex='"sasjsTestsUrl".*' --replacement='"sasjsTestsUrl":"http://localhost:3000",' ./cypress.json
           replace-in-files --regex='"username".*' --replacement='"username":"${{ secrets.SASJS_USERNAME }}",' ./cypress.json
           replace-in-files --regex='"password".*' --replacement='"password":"${{ secrets.SASJS_PASSWORD }}",' ./cypress.json
           sh ./sasjs-tests/sasjs-cypress-run.sh ${{ secrets.MATRIX_TOKEN }} https://github.com/${{github.repository}}/actions/runs/${{github.run_id}}

cypress/integration/sasjs.tests.ts

@@ -14,65 +14,83 @@ context('sasjs-tests', function () {
 
   it('Should have all tests successfull', (done) => {
     cy.get('body').then(($body) => {
-      if ($body.find('input[placeholder="User Name"]').length > 0) {
-        cy.get('input[placeholder="User Name"]').type(username)
-        cy.get('input[placeholder="Password"]').type(password)
-        cy.get('.submit-button').click()
-      }
+      cy.wait(1000).then(() => {
+        const startButton = $body.find(
+          '.ui.massive.icon.primary.left.labeled.button'
+        )[0]
 
-      cy.get('input[placeholder="User Name"]', { timeout: 40000 })
-        .should('not.exist')
-        .then(() => {
-          cy.get('.ui.massive.icon.primary.left.labeled.button')
-            .click()
-            .then(() => {
-              cy.get('.ui.massive.loading.primary.button', {
-                timeout: testingFinishTimeout
-              })
-                .should('not.exist')
-                .then(() => {
-                  cy.get('span.icon.failed')
-                    .should('not.exist')
-                    .then(() => {
-                      done()
-                    })
+        if (
+          !startButton ||
+          (startButton && !Cypress.dom.isVisible(startButton))
+        ) {
+          cy.get('input[placeholder="User Name"]').type(username)
+          cy.get('input[placeholder="Password"]').type(password)
+          cy.get('.submit-button').click()
+        }
+
+        cy.get('input[placeholder="User Name"]', { timeout: 40000 })
+          .should('not.exist')
+          .then(() => {
+            cy.get('.ui.massive.icon.primary.left.labeled.button')
+              .click()
+              .then(() => {
+                cy.get('.ui.massive.loading.primary.button', {
+                  timeout: testingFinishTimeout
                 })
-            })
-        })
+                  .should('not.exist')
+                  .then(() => {
+                    cy.get('span.icon.failed')
+                      .should('not.exist')
+                      .then(() => {
+                        done()
+                      })
+                  })
+              })
+          })
+      })
     })
   })
 
   it('Should have all tests successfull with debug on', (done) => {
     cy.get('body').then(($body) => {
-      if ($body.find('input[placeholder="User Name"]').length > 0) {
-        cy.get('input[placeholder="User Name"]').type(username)
-        cy.get('input[placeholder="Password"]').type(password)
-        cy.get('.submit-button').click()
-      }
+      cy.wait(1000).then(() => {
+        const startButton = $body.find(
+          '.ui.massive.icon.primary.left.labeled.button'
+        )[0]
 
-      cy.get('.ui.fitted.toggle.checkbox label')
-        .click()
-        .then(() => {
-          cy.get('input[placeholder="User Name"]', { timeout: 40000 })
-            .should('not.exist')
-            .then(() => {
-              cy.get('.ui.massive.icon.primary.left.labeled.button')
-                .click()
-                .then(() => {
-                  cy.get('.ui.massive.loading.primary.button', {
-                    timeout: testingFinishTimeout
-                  })
-                    .should('not.exist')
-                    .then(() => {
-                      cy.get('span.icon.failed')
-                        .should('not.exist')
-                        .then(() => {
-                          done()
-                        })
+        if (
+          !startButton ||
+          (startButton && !Cypress.dom.isVisible(startButton))
+        ) {
+          cy.get('input[placeholder="User Name"]').type(username)
+          cy.get('input[placeholder="Password"]').type(password)
+          cy.get('.submit-button').click()
+        }
+
+        cy.get('.ui.fitted.toggle.checkbox label')
+          .click()
+          .then(() => {
+            cy.get('input[placeholder="User Name"]', { timeout: 40000 })
+              .should('not.exist')
+              .then(() => {
+                cy.get('.ui.massive.icon.primary.left.labeled.button')
+                  .click()
+                  .then(() => {
+                    cy.get('.ui.massive.loading.primary.button', {
+                      timeout: testingFinishTimeout
                     })
-                })
-            })
-        })
+                      .should('not.exist')
+                      .then(() => {
+                        cy.get('span.icon.failed')
+                          .should('not.exist')
+                          .then(() => {
+                            done()
+                          })
+                      })
+                  })
+              })
+          })
+      })
     })
   })
 })

cypress/support/commands.js

@@ -0,0 +1,25 @@
+// ***********************************************
+// This example commands.js shows you how to
+// create various custom commands and overwrite
+// existing commands.
+//
+// For more comprehensive examples of custom
+// commands please read more here:
+// https://on.cypress.io/custom-commands
+// ***********************************************
+//
+//
+// -- This is a parent command --
+// Cypress.Commands.add('login', (email, password) => { ... })
+//
+//
+// -- This is a child command --
+// Cypress.Commands.add('drag', { prevSubject: 'element'}, (subject, options) => { ... })
+//
+//
+// -- This is a dual command --
+// Cypress.Commands.add('dismiss', { prevSubject: 'optional'}, (subject, options) => { ... })
+//
+//
+// -- This will overwrite an existing command --
+// Cypress.Commands.overwrite('visit', (originalFn, url, options) => { ... })

cypress/support/index.js

@@ -0,0 +1,20 @@
+// ***********************************************************
+// This example support/index.js is processed and
+// loaded automatically before your test files.
+//
+// This is a great place to put global configuration and
+// behavior that modifies Cypress.
+//
+// You can change the location of this file or turn off
+// automatically serving support files with the
+// 'supportFile' configuration option.
+//
+// You can read more here:
+// https://on.cypress.io/configuration
+// ***********************************************************
+
+// Import commands.js using ES2015 syntax:
+import './commands'
+
+// Alternatively you can use CommonJS syntax:
+// require('./commands')

example.html

@@ -1,7 +1,7 @@
 <!DOCTYPE html>
 <html>
   <head>
-    <script src="https://cdn.jsdelivr.net/combine/npm/chart.js@2.9.3,npm/jquery@3.5.1,npm/@sasjs/adapter@1"></script> 
+    <script src="https://cdn.jsdelivr.net/combine/npm/chart.js@2.9.3,npm/jquery@3.5.1,npm/@sasjs/adapter@4"></script> 
     <script>
       var sasJs = new SASjs.default({
          appLoc: "/Public/app/readme"

package-lock.json

@@ -32,7 +32,7 @@
         "node-polyfill-webpack-plugin": "1.1.4",
         "path": "0.12.7",
         "pem": "1.14.5",
-        "prettier": "2.7.1",
+        "prettier": "2.8.7",
         "process": "0.11.10",
         "rimraf": "3.0.2",
         "semantic-release": "19.0.3",
@@ -13925,9 +13925,9 @@
       }
     },
     "node_modules/prettier": {
-      "version": "2.7.1",
-      "resolved": "https://registry.npmjs.org/prettier/-/prettier-2.7.1.tgz",
-      "integrity": "sha512-ujppO+MkdPqoVINuDFDRLClm7D78qbDt0/NR+wp5FqEZOoTNAjPHWj17QRhu7geIHJfcNhRk1XVQmF8Bp3ye+g==",
+      "version": "2.8.7",
+      "resolved": "https://registry.npmjs.org/prettier/-/prettier-2.8.7.tgz",
+      "integrity": "sha512-yPngTo3aXUUmyuTjeTUT75txrf+aMh9FiD7q9ZE/i6r0bPb22g4FsE6Y338PQX1bmfy08i9QQCB7/rcUAVntfw==",
       "dev": true,
       "bin": {
         "prettier": "bin-prettier.js"
@@ -27416,9 +27416,9 @@
       "dev": true
     },
     "prettier": {
-      "version": "2.7.1",
-      "resolved": "https://registry.npmjs.org/prettier/-/prettier-2.7.1.tgz",
-      "integrity": "sha512-ujppO+MkdPqoVINuDFDRLClm7D78qbDt0/NR+wp5FqEZOoTNAjPHWj17QRhu7geIHJfcNhRk1XVQmF8Bp3ye+g==",
+      "version": "2.8.7",
+      "resolved": "https://registry.npmjs.org/prettier/-/prettier-2.8.7.tgz",
+      "integrity": "sha512-yPngTo3aXUUmyuTjeTUT75txrf+aMh9FiD7q9ZE/i6r0bPb22g4FsE6Y338PQX1bmfy08i9QQCB7/rcUAVntfw==",
       "dev": true
     },
     "pretty-bytes": {

package.json

@@ -60,7 +60,7 @@
     "node-polyfill-webpack-plugin": "1.1.4",
     "path": "0.12.7",
     "pem": "1.14.5",
-    "prettier": "2.7.1",
+    "prettier": "2.8.7",
     "process": "0.11.10",
     "rimraf": "3.0.2",
     "semantic-release": "19.0.3",

sasjs-tests/.gitignore

@@ -13,10 +13,7 @@
 
 # misc
 .DS_Store
-.env.local
-.env.development.local
-.env.test.local
-.env.production.local
+.env.*
 
 npm-debug.log*
 yarn-debug.log*

sasjs-tests/package.json

@@ -4,15 +4,14 @@
   "homepage": ".",
   "private": true,
   "dependencies": {
-    "@sasjs/adapter": "file:../build/sasjs-adapter-5.0.0.tgz",
     "@sasjs/test-framework": "1.5.7",
     "@types/jest": "^26.0.20",
     "@types/node": "^14.14.41",
-    "@types/react": "^17.0.1",
-    "@types/react-dom": "^17.0.0",
+    "@types/react": "^16.0.1",
+    "@types/react-dom": "^16.0.0",
     "@types/react-router-dom": "^5.1.7",
-    "react": "^17.0.1",
-    "react-dom": "^17.0.1",
+    "react": "^16.0.1",
+    "react-dom": "^16.0.1",
     "react-router-dom": "^5.2.0",
     "react-scripts": "^5.0.1",
     "typescript": "^4.1.3"
@@ -22,7 +21,7 @@
     "build": "react-scripts build",
     "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 --legacy-peer-deps",
+    "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 || npm run deploy:tests-win",
     "deploy:tests-win": "scp %DEPLOY_PATH% ./build/*",
     "deploy": "npm run update:adapter && npm run build && npm run deploy:tests"
@@ -43,6 +42,6 @@
     ]
   },
   "devDependencies": {
-    "node-sass": "7.0.3"
+    "node-sass": "9.0.0"
   }
-}
+}

sasjs-tests/public/config.json

@@ -3,10 +3,10 @@
   "password": "",
   "sasJsConfig": {
     "serverUrl": "",
-    "appLoc": "/Public/app/adapter-tests",
+    "appLoc": "/Public/app/adapter-tests/services",
     "serverType": "SASJS",
     "debug": false,
     "contextName": "sasjs adapter compute context",
     "useComputeApi": true
   }
-}
+}

sasjs-tests/sasjs/sasjsconfig.json

@@ -1,17 +1,29 @@
 {
   "$schema": "https://cli.sasjs.io/sasjsconfig-schema.json",
   "serviceConfig": {
-    "serviceFolders": [
-      "sasjs/common"
-    ]
+    "serviceFolders": ["sasjs/common"]
   },
   "defaultTarget": "4gl",
   "targets": [
     {
       "name": "4gl",
-      "serverType": "SASJS",
       "serverUrl": "https://sas9.4gl.io",
-      "appLoc": "/Public/app/adapter-tests"
+      "serverType": "SASJS",
+      "httpsAgentOptions": {
+        "allowInsecureRequests": false
+      },
+      "appLoc": "/Public/app/adapter-tests",
+      "deployConfig": {
+        "deployServicePack": true,
+        "deployScripts": []
+      },
+      "streamConfig": {
+        "streamWeb": true,
+        "streamWebFolder": "webv",
+        "webSourcePath": "build",
+        "streamServiceName": "adapter-tests",
+        "assetPaths": []
+      }
     }
   ]
-}
+}

src/SASViyaApiClient.spec.ts

@@ -29,11 +29,33 @@ describe('SASViyaApiClient', () => {
     jest
       .spyOn(requestClient, 'get')
       .mockImplementation(() => Promise.reject('Not Found'))
+
     const error = await sasViyaApiClient
       .createFolder('test', '/foo')
       .catch((e: any) => e)
+
     expect(error).toBeInstanceOf(RootFolderNotFoundError)
   })
+
+  it('should throw an error when ', async () => {
+    const testMessage1 = 'test message 1'
+    const testMessage2 = 'test message 2.'
+
+    jest.spyOn(requestClient, 'post').mockImplementation(() => {
+      return Promise.reject({
+        message: testMessage1,
+        response: { data: { message: testMessage2 }, status: 409 }
+      })
+    })
+
+    const error = await sasViyaApiClient
+      .createFolder('test', '/foo')
+      .catch((e: any) => e)
+
+    const expectedError = `${testMessage1}. ${testMessage2} To override, please set "isForced" to "true".`
+
+    expect(error).toEqual(expectedError)
+  })
 })
 
 const setupMocks = () => {

src/SASViyaApiClient.ts

@@ -378,12 +378,14 @@ export class SASViyaApiClient {
     isForced?: boolean
   ): Promise<Folder> {
     const logger = process.logger || console
+
     if (!parentFolderPath && !parentFolderUri) {
       throw new Error('Path or URI of the parent folder is required.')
     }
 
     if (!parentFolderUri && parentFolderPath) {
       parentFolderUri = await this.getFolderUri(parentFolderPath, accessToken)
+
       if (!parentFolderUri) {
         logger.info(
           `Parent folder at path '${parentFolderPath}' is not present.`
@@ -394,6 +396,7 @@ export class SASViyaApiClient {
           parentFolderPath.lastIndexOf('/')
         )
         const newFolderName = `${parentFolderPath.split('/').pop()}`
+
         if (newParentFolderPath === '') {
           throw new RootFolderNotFoundError(
             parentFolderPath,
@@ -401,20 +404,24 @@ export class SASViyaApiClient {
             accessToken
           )
         }
+
         logger.info(
           `Creating parent folder:\n'${newFolderName}' in '${newParentFolderPath}'`
         )
+
         const parentFolder = await this.createFolder(
           newFolderName,
           newParentFolderPath,
           undefined,
           accessToken
         )
+
         logger.info(
           `Parent folder '${newFolderName}' has been successfully created.`
         )
+
         parentFolderUri = `/folders/folders/${parentFolder.id}`
-      } else if (isForced && accessToken) {
+      } else if (isForced) {
         const folderPath = parentFolderPath + '/' + folderName
         const folderUri = await this.getFolderUri(folderPath, accessToken)
 
@@ -427,8 +434,8 @@ export class SASViyaApiClient {
       }
     }
 
-    const { result: createFolderResponse } =
-      await this.requestClient.post<Folder>(
+    const { result: createFolderResponse } = await this.requestClient
+      .post<Folder>(
         `/folders/folders?parentFolderUri=${parentFolderUri}`,
         {
           name: folderName,
@@ -436,12 +443,34 @@ export class SASViyaApiClient {
         },
         accessToken
       )
+      .catch((err) => {
+        const { message, response } = err
+
+        if (message && response && response.data && response.data.message) {
+          const { status } = response
+          const { message: responseMessage } = response.data
+          const messages = [message, responseMessage].map((mes: string) =>
+            /\.$/.test(mes) ? mes : `${mes}.`
+          )
+
+          if (!isForced && status === 409) {
+            messages.push(`To override, please set "isForced" to "true".`)
+          }
+
+          const errMessage = messages.join(' ')
+
+          throw errMessage
+        }
+
+        throw err
+      })
 
     // update folder map with newly created folder.
     await this.populateFolderMap(
       `${parentFolderPath}/${folderName}`,
       accessToken
     )
+
     return createFolderResponse
   }
 
@@ -900,7 +929,7 @@ export class SASViyaApiClient {
     return `/folders/folders/${folderDetails.id}`
   }
 
-  private async getRecycleBinUri(accessToken: string) {
+  private async getRecycleBinUri(accessToken?: string) {
     const url = '/folders/folders/@myRecycleBin'
 
     const { result: folder } = await this.requestClient
@@ -984,7 +1013,7 @@ export class SASViyaApiClient {
     sourceFolder: string,
     targetParentFolder: string,
     targetFolderName: string,
-    accessToken: string
+    accessToken?: string
   ) {
     // If target path is an existing folder, than keep source folder name, othervise rename it with given target folder name
     const sourceFolderName = sourceFolder.split('/').pop() as string
@@ -1051,7 +1080,7 @@ export class SASViyaApiClient {
    * @param folderPath - the full path (eg `/Public/example/deleteThis`) of the folder to be deleted.
    * @param accessToken - an access token for authorizing the request.
    */
-  public async deleteFolder(folderPath: string, accessToken: string) {
+  public async deleteFolder(folderPath: string, accessToken?: string) {
     const recycleBinUri = await this.getRecycleBinUri(accessToken)
     const folderName = folderPath.split('/').pop() || ''
     const date = new Date()

src/SASjs.ts

@@ -337,13 +337,16 @@ export default class SASjs {
     sasApiClient?: SASViyaApiClient,
     isForced?: boolean
   ) {
-    if (sasApiClient)
+    if (sasApiClient) {
       return await sasApiClient.createFolder(
         folderName,
         parentFolderPath,
         parentFolderUri,
-        accessToken
+        accessToken,
+        isForced
       )
+    }
+
     return await this.sasViyaApiClient!.createFolder(
       folderName,
       parentFolderPath,
@@ -783,13 +786,11 @@ export default class SASjs {
     this.isMethodSupported('deployServicePack', [ServerType.SasViya])
 
     let sasApiClient: any = null
+
     if (serverUrl || appLoc) {
-      if (!serverUrl) {
-        serverUrl = this.sasjsConfig.serverUrl
-      }
-      if (!appLoc) {
-        appLoc = this.sasjsConfig.appLoc
-      }
+      if (!serverUrl) serverUrl = this.sasjsConfig.serverUrl
+      if (!appLoc) appLoc = this.sasjsConfig.appLoc
+
       if (this.sasjsConfig.serverType === ServerType.SasViya) {
         sasApiClient = new SASViyaApiClient(
           serverUrl,
@@ -807,11 +808,13 @@ export default class SASjs {
       }
     } else {
       let sasClientConfig: any = null
+
       if (this.sasjsConfig.serverType === ServerType.SasViya) {
         sasClientConfig = this.sasViyaApiClient!.getConfig()
       } else if (this.sasjsConfig.serverType === ServerType.Sas9) {
         sasClientConfig = this.sas9ApiClient!.getConfig()
       }
+
       serverUrl = sasClientConfig.serverUrl
       appLoc = sasClientConfig.rootFolderName as string
     }

src/api/viya/spec/executeScript.spec.ts

@@ -9,7 +9,7 @@ import * as formatDataModule from '../../../utils/formatDataForRequest'
 import * as fetchLogsModule from '../../../utils/fetchLogByChunks'
 import { PollOptions } from '../../../types'
 import { ComputeJobExecutionError, NotFoundError } from '../../../types/errors'
-import { Logger, LogLevel } from '@sasjs/utils'
+import { Logger, LogLevel } from '@sasjs/utils/logger'
 
 const sessionManager = new (<jest.Mock<SessionManager>>SessionManager)()
 const requestClient = new (<jest.Mock<RequestClient>>RequestClient)()

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

@@ -1,4 +1,4 @@
-import { Logger, LogLevel } from '@sasjs/utils'
+import { Logger, LogLevel } from '@sasjs/utils/logger'
 import { RequestClient } from '../../../request/RequestClient'
 import { mockAuthConfig, mockJob } from './mockResponses'
 import { pollJobState } from '../pollJobState'

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

@@ -1,4 +1,4 @@
-import { Logger, LogLevel } from '@sasjs/utils'
+import { Logger, LogLevel } from '@sasjs/utils/logger'
 import { RequestClient } from '../../../request/RequestClient'
 import * as fetchLogsModule from '../../../utils/fetchLogByChunks'
 import * as writeStreamModule from '../writeStream'

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

@@ -5,7 +5,7 @@ import {
   fileExists,
   readFile,
   deleteFile
-} from '@sasjs/utils'
+} from '@sasjs/utils/file'
 
 describe('writeStream', () => {
   const filename = 'test.txt'

src/auth/getAccessTokenForSasjs.ts

@@ -1,5 +1,7 @@
 import { prefixMessage } from '@sasjs/utils/error'
 import { RequestClient } from '../request/RequestClient'
+import { getTokenRequestErrorPrefix } from './getTokenRequestErrorPrefix'
+import { ServerType } from '@sasjs/utils/types'
 
 /**
  * Exchanges the auth code for an access token for the given client.
@@ -31,6 +33,16 @@ export async function getAccessTokenForSasjs(
       }
     })
     .catch((err) => {
-      throw prefixMessage(err, 'Error while getting access token. ')
+      throw prefixMessage(
+        err,
+        getTokenRequestErrorPrefix(
+          'fetching access token',
+          'getAccessTokenForSasjs',
+          ServerType.Sasjs,
+          url,
+          data,
+          clientId
+        )
+      )
     })
 }

src/auth/getAccessTokenForViya.ts

@@ -1,11 +1,12 @@
-import { SasAuthResponse } from '@sasjs/utils/types'
+import { SasAuthResponse, ServerType } from '@sasjs/utils/types'
 import { prefixMessage } from '@sasjs/utils/error'
 import { RequestClient } from '../request/RequestClient'
 import { CertificateError } from '../types/errors'
+import { getTokenRequestErrorPrefix } from './getTokenRequestErrorPrefix'
 
 /**
- * Exchanges the auth code for an access token for the given client.
- * @param requestClient - the pre-configured HTTP request client
+ * Exchange the auth code for access / refresh tokens for the given client / secret pair.
+ * @param requestClient - the pre-configured HTTP request client.
  * @param clientId - the client ID to authenticate with.
  * @param clientSecret - the client secret to authenticate with.
  * @param authCode - the auth code received from the server.
@@ -16,29 +17,44 @@ export async function getAccessTokenForViya(
   clientSecret: string,
   authCode: string
 ): Promise<SasAuthResponse> {
-  const url = '/SASLogon/oauth/token'
   let token
+
   if (typeof Buffer === 'undefined') {
     token = btoa(clientId + ':' + clientSecret)
   } else {
     token = Buffer.from(clientId + ':' + clientSecret).toString('base64')
   }
+
+  const url = '/SASLogon/oauth/token'
   const headers = {
     Authorization: 'Basic ' + token,
     Accept: 'application/json'
   }
 
-  const data = new URLSearchParams({
+  const dataJson = new URLSearchParams({
     grant_type: 'authorization_code',
     code: authCode
   })
+  const data = new URLSearchParams(dataJson)
 
   const authResponse = await requestClient
     .post(url, data, undefined, 'application/x-www-form-urlencoded', headers)
     .then((res) => res.result as SasAuthResponse)
     .catch((err) => {
       if (err instanceof CertificateError) throw err
-      throw prefixMessage(err, 'Error while getting access token. ')
+      throw prefixMessage(
+        err,
+        getTokenRequestErrorPrefix(
+          'fetching access token',
+          'getAccessTokenForViya',
+          ServerType.SasViya,
+          url,
+          dataJson,
+          headers,
+          clientId,
+          clientSecret
+        )
+      )
     })
 
   return authResponse

src/auth/getTokenRequestErrorPrefix.ts

@@ -0,0 +1,88 @@
+import { ServerType } from '@sasjs/utils/types'
+
+type Server = ServerType.SasViya | ServerType.Sasjs
+type Operation = 'fetching access token' | 'refreshing tokens'
+
+const getServerName = (server: Server) =>
+  server === ServerType.SasViya ? 'Viya' : 'Sasjs'
+
+const getResponseTitle = (server: Server) =>
+  `Response from ${getServerName(server)} is below.`
+
+/**
+ * Forms error prefix for requests related to token operations.
+ * @param operation - string describing operation ('fetching access token' or 'refreshing tokens').
+ * @param funcName - name of the function sent the request.
+ * @param server - server type (SASVIYA or SASJS).
+ * @param url - endpoint used to send the request.
+ * @param data - request payload.
+ * @param headers - request headers.
+ * @param clientId - client ID to authenticate with.
+ * @param clientSecret - client secret to authenticate with.
+ * @returns - string containing request information. Example:
+ * Error while fetching access token from /SASLogon/oauth/token
+ * Thrown by the @sasjs/adapter getAccessTokenForViya function.
+ * Payload:
+ * {
+ *   "grant_type": "authorization_code",
+ *   "code": "example_code"
+ * }
+ * Headers:
+ * {
+ *   "Authorization": "Basic NEdMQXBwOjRHTEFwcDE=",
+ *   "Accept": "application/json"
+ * }
+ * ClientId: exampleClientId
+ * ClientSecret: exampleClientSecret
+ *
+ * Response from Viya is below.
+ * Auth error: {
+ *   "error": "invalid_token",
+ *   "error_description": "No scopes were granted"
+ * }
+ */
+export const getTokenRequestErrorPrefix = (
+  operation: Operation,
+  funcName: string,
+  server: Server,
+  url: string,
+  data?: {},
+  headers?: {},
+  clientId?: string,
+  clientSecret?: string
+) => {
+  const stringify = (obj: {}) => JSON.stringify(obj, null, 2)
+
+  const lines = [
+    `Error while ${operation} from ${url}`,
+    `Thrown by the @sasjs/adapter ${funcName} function.`
+  ]
+
+  if (data) {
+    lines.push('Payload:')
+    lines.push(stringify(data))
+  }
+  if (headers) {
+    lines.push('Headers:')
+    lines.push(stringify(headers))
+  }
+  if (clientId) lines.push(`ClientId: ${clientId}`)
+  if (clientSecret) lines.push(`ClientSecret: ${clientSecret}`)
+
+  lines.push('')
+  lines.push(`${getResponseTitle(server)}`)
+  lines.push('')
+
+  return lines.join(`\n`)
+}
+
+/**
+ * Parse error prefix to get response payload.
+ * @param prefix - error prefix generated by getTokenRequestErrorPrefix function.
+ * @param server - server type (SASVIYA or SASJS).
+ * @returns - response payload.
+ */
+export const getTokenRequestErrorPrefixResponse = (
+  prefix: string,
+  server: ServerType.SasViya | ServerType.Sasjs
+) => prefix.split(`${getResponseTitle(server)}\n`).pop() as string

src/auth/getTokens.ts

@@ -22,6 +22,7 @@ export async function getTokens(
 ): Promise<AuthConfig> {
   const logger = process.logger || console
   let { access_token, refresh_token, client, secret } = authConfig
+
   if (
     isAccessTokenExpiring(access_token) ||
     isRefreshTokenExpiring(refresh_token)
@@ -29,6 +30,7 @@ export async function getTokens(
     if (hasTokenExpired(refresh_token)) {
       const error =
         'Unable to obtain new access token. Your refresh token has expired.'
+
       logger.error(error)
 
       throw new Error(error)
@@ -47,5 +49,6 @@ export async function getTokens(
         : await refreshTokensForSasjs(requestClient, refresh_token)
     ;({ access_token, refresh_token } = tokens)
   }
+
   return { access_token, refresh_token, client, secret }
 }

src/auth/refreshTokensForSasjs.ts

@@ -1,5 +1,7 @@
 import { prefixMessage } from '@sasjs/utils/error'
 import { RequestClient } from '../request/RequestClient'
+import { getTokenRequestErrorPrefix } from './getTokenRequestErrorPrefix'
+import { ServerType } from '@sasjs/utils/types'
 
 /**
  * Exchanges the refresh token for an access token for the given client.
@@ -28,7 +30,15 @@ export async function refreshTokensForSasjs(
       }
     })
     .catch((err) => {
-      throw prefixMessage(err, 'Error while refreshing tokens: ')
+      throw prefixMessage(
+        err,
+        getTokenRequestErrorPrefix(
+          'refreshing tokens',
+          'refreshTokensForSasjs',
+          ServerType.Sasjs,
+          url
+        )
+      )
     })
 
   return authResponse

src/auth/refreshTokensForViya.ts

@@ -1,8 +1,9 @@
-import { SasAuthResponse } from '@sasjs/utils/types'
+import { SasAuthResponse, ServerType } from '@sasjs/utils/types'
 import { prefixMessage } from '@sasjs/utils/error'
 import * as NodeFormData from 'form-data'
 import { RequestClient } from '../request/RequestClient'
 import { isNode } from '../utils'
+import { getTokenRequestErrorPrefix } from './getTokenRequestErrorPrefix'
 
 /**
  * Exchanges the refresh token for an access token for the given client.
@@ -46,7 +47,19 @@ export async function refreshTokensForViya(
     )
     .then((res) => res.result)
     .catch((err) => {
-      throw prefixMessage(err, 'Error while refreshing tokens: ')
+      throw prefixMessage(
+        err,
+        getTokenRequestErrorPrefix(
+          'refreshing tokens',
+          'refreshTokensForViya',
+          ServerType.SasViya,
+          url,
+          formData,
+          headers,
+          clientId,
+          clientSecret
+        )
+      )
     })
 
   return authResponse

src/auth/spec/getAccessTokenForSasjs.spec.ts

@@ -1,4 +1,4 @@
-import { AuthConfig } from '@sasjs/utils'
+import { AuthConfig } from '@sasjs/utils/types'
 import { generateToken, mockSasjsAuthResponse } from './mockResponses'
 import { RequestClient } from '../../request/RequestClient'
 import { getAccessTokenForSasjs } from '../getAccessTokenForSasjs'
@@ -55,7 +55,7 @@ describe('getAccessTokenForSasjs', () => {
       authConfig.refresh_token
     ).catch((e: any) => e)
 
-    expect(error).toContain('Error while getting access token')
+    expect(error).toContain('Error while fetching access token')
   })
 })
 

src/auth/spec/getAccessTokenForViya.spec.ts

@@ -1,4 +1,4 @@
-import { AuthConfig } from '@sasjs/utils'
+import { AuthConfig } from '@sasjs/utils/types'
 import * as NodeFormData from 'form-data'
 import { generateToken, mockAuthResponse } from './mockResponses'
 import { RequestClient } from '../../request/RequestClient'
@@ -66,7 +66,7 @@ describe('getAccessTokenForViya', () => {
       authConfig.refresh_token
     ).catch((e: any) => e)
 
-    expect(error).toContain('Error while getting access token')
+    expect(error).toContain('Error while fetching access token')
   })
 })
 

src/auth/spec/getTokenRequestErrorPrefix.spec.ts

@@ -0,0 +1,81 @@
+import { ServerType } from '@sasjs/utils/types'
+import { getTokenRequestErrorPrefix } from '../getTokenRequestErrorPrefix'
+
+describe('getTokenRequestErrorPrefix', () => {
+  it('should return error prefix', () => {
+    // INFO: Viya with only required attributes
+    let operation: 'fetching access token' = 'fetching access token'
+    const funcName = 'testFunc'
+    const url = '/SASjsApi/auth/token'
+
+    let expectedPrefix = `Error while ${operation} from ${url}
+Thrown by the @sasjs/adapter ${funcName} function.
+
+Response from Viya is below.
+`
+
+    expect(
+      getTokenRequestErrorPrefix(operation, funcName, ServerType.SasViya, url)
+    ).toEqual(expectedPrefix)
+
+    // INFO: Sasjs with data and headers
+    const data = {
+      grant_type: 'authorization_code',
+      code: 'testCode'
+    }
+    const headers = {
+      Authorization: 'Basic test=',
+      Accept: 'application/json'
+    }
+
+    expectedPrefix = `Error while ${operation} from ${url}
+Thrown by the @sasjs/adapter ${funcName} function.
+Payload:
+${JSON.stringify(data, null, 2)}
+Headers:
+${JSON.stringify(headers, null, 2)}
+
+Response from Sasjs is below.
+`
+
+    expect(
+      getTokenRequestErrorPrefix(
+        operation,
+        funcName,
+        ServerType.Sasjs,
+        url,
+        data,
+        headers
+      )
+    ).toEqual(expectedPrefix)
+
+    // INFO: Viya with all attributes
+    const clientId = 'testId'
+    const clientSecret = 'testSecret'
+
+    expectedPrefix = `Error while ${operation} from ${url}
+Thrown by the @sasjs/adapter ${funcName} function.
+Payload:
+${JSON.stringify(data, null, 2)}
+Headers:
+${JSON.stringify(headers, null, 2)}
+ClientId: ${clientId}
+ClientSecret: ${clientSecret}
+
+Response from Viya is below.
+`
+
+    expect(
+      getTokenRequestErrorPrefix(
+        operation,
+        funcName,
+        ServerType.SasViya,
+        url,
+        data,
+        headers,
+        clientId,
+        clientSecret
+      )
+    ).toEqual(expectedPrefix)
+  })
+})

src/auth/spec/getTokens.spec.ts

@@ -1,4 +1,4 @@
-import { AuthConfig } from '@sasjs/utils'
+import { AuthConfig } from '@sasjs/utils/types'
 import * as refreshTokensModule from '../refreshTokensForViya'
 import { generateToken, mockAuthResponse } from './mockResponses'
 import { getTokens } from '../getTokens'

src/auth/spec/refreshTokensForSasjs.spec.ts

@@ -1,6 +1,8 @@
+import { ServerType } from '@sasjs/utils/types'
 import { generateToken, mockAuthResponse } from './mockResponses'
 import { RequestClient } from '../../request/RequestClient'
 import { refreshTokensForSasjs } from '../refreshTokensForSasjs'
+import { getTokenRequestErrorPrefixResponse } from '../getTokenRequestErrorPrefix'
 
 const requestClient = new (<jest.Mock<RequestClient>>RequestClient)()
 
@@ -38,9 +40,9 @@ describe('refreshTokensForSasjs', () => {
     const error = await refreshTokensForSasjs(
       requestClient,
       refresh_token
-    ).catch((e: any) => e)
+    ).catch((e: any) => getTokenRequestErrorPrefixResponse(e, ServerType.Sasjs))
 
-    expect(error).toEqual(`Error while refreshing tokens: ${tokenError}`)
+    expect(error).toEqual(tokenError)
   })
 })
 

src/auth/spec/refreshTokensForViya.spec.ts

@@ -1,9 +1,10 @@
-import { AuthConfig } from '@sasjs/utils'
+import { AuthConfig, ServerType } from '@sasjs/utils/types'
 import * as NodeFormData from 'form-data'
 import { generateToken, mockAuthResponse } from './mockResponses'
 import { RequestClient } from '../../request/RequestClient'
 import { refreshTokensForViya } from '../refreshTokensForViya'
 import * as IsNodeModule from '../../utils/isNode'
+import { getTokenRequestErrorPrefixResponse } from '../getTokenRequestErrorPrefix'
 
 const requestClient = new (<jest.Mock<RequestClient>>RequestClient)()
 
@@ -67,9 +68,11 @@ describe('refreshTokensForViya', () => {
       authConfig.client,
       authConfig.secret,
       authConfig.refresh_token
-    ).catch((e: any) => e)
+    ).catch((e: any) =>
+      getTokenRequestErrorPrefixResponse(e, ServerType.SasViya)
+    )
 
-    expect(error).toEqual(`Error while refreshing tokens: ${tokenError}`)
+    expect(error).toEqual(tokenError)
   })
 
   it('should throw an error if environment is not Node', async () => {

src/job-execution/FileUploader.ts

@@ -93,15 +93,24 @@ export class FileUploader extends BaseJobExecutor {
                   this.requestClient,
                   config.serverUrl
                 )
+
                 break
               case ServerType.Sas9:
                 jsonResponse =
                   typeof res.result === 'string'
                     ? parseWeboutResponse(res.result, uploadUrl)
                     : res.result
+
+                break
+              case ServerType.Sasjs:
+                jsonResponse =
+                  typeof res.result === 'string'
+                    ? getValidJson(res.result)
+                    : res.result
+
                 break
             }
-          } else if (this.serverType !== ServerType.Sasjs) {
+          } else {
             jsonResponse =
               typeof res.result === 'string'
                 ? getValidJson(res.result)

src/job-execution/SasjsJobExecutor.ts

@@ -93,8 +93,10 @@ export class SasjsJobExecutor extends BaseJobExecutor {
             )
           }
 
-          const { result } = res.result
-          if (result && result.trim()) res.result = getValidJson(result)
+          const { result } = res
+
+          if (result && typeof result === 'string' && result.trim())
+            res.result = getValidJson(result)
 
           this.requestClient!.appendRequest(res, sasJob, config.debug)
 

src/request/SasjsRequestClient.ts

@@ -48,7 +48,7 @@ export class SasjsRequestClient extends RequestClient {
         const splittedResponse = response.data.split(SASJS_LOGS_SEPARATOR)
 
         webout = splittedResponse[0]
-        if (webout) parsedResponse = webout
+        if (webout !== undefined) parsedResponse = webout
 
         log = splittedResponse[1]
         printOutput = splittedResponse[2]

src/test/RequestClient.spec.ts

@@ -2,7 +2,7 @@ import * as pem from 'pem'
 import * as http from 'http'
 import * as https from 'https'
 import { app, mockedAuthResponse } from './SAS_server_app'
-import { ServerType } from '@sasjs/utils'
+import { ServerType } from '@sasjs/utils/types'
 import SASjs from '../SASjs'
 import * as axiosModules from '../utils/createAxiosInstance'
 import {
@@ -11,8 +11,8 @@ import {
   NotFoundError,
   InternalServerError
 } from '../types/errors'
-import { prefixMessage } from '@sasjs/utils/error'
 import { RequestClient } from '../request/RequestClient'
+import { getTokenRequestErrorPrefixResponse } from '../auth/getTokenRequestErrorPrefix'
 
 const axiosActual = jest.requireActual('axios')
 
@@ -66,14 +66,18 @@ describe('RequestClient', () => {
   })
 
   it('should response the POST method with Unauthorized', async () => {
-    await expect(
-      adapter.getAccessToken('clientId', 'clientSecret', 'incorrect')
-    ).rejects.toEqual(
-      prefixMessage(
-        new LoginRequiredError(incorrectAuthCodeErr),
-        'Error while getting access token. '
+    const expectedError = new LoginRequiredError({
+      error: 'unauthorized',
+      error_description: 'Bad credentials'
+    })
+
+    const rejectionErrorMessage = await adapter
+      .getAccessToken('clientId', 'clientSecret', 'incorrect')
+      .catch((err) =>
+        getTokenRequestErrorPrefixResponse(err.message, ServerType.SasViya)
       )
-    )
+
+    expect(rejectionErrorMessage).toEqual(expectedError.message)
   })
 
   describe('handleError', () => {
@@ -209,15 +213,15 @@ describe('RequestClient - Self Signed Server', () => {
       serverType: ServerType.SasViya
     })
 
-    await expect(
-      adapterWithoutCertificate.getAccessToken(
-        'clientId',
-        'clientSecret',
-        'authCode'
+    const expectedError = 'self-signed certificate'
+
+    const rejectionErrorMessage = await adapterWithoutCertificate
+      .getAccessToken('clientId', 'clientSecret', 'authCode')
+      .catch((err) =>
+        getTokenRequestErrorPrefixResponse(err.message, ServerType.SasViya)
       )
-    ).rejects.toThrow(
-      `Error while getting access token. ${ERROR_MESSAGES.selfSigned}`
-    )
+
+    expect(rejectionErrorMessage).toEqual(expectedError)
   })
 
   it('should response the POST method using insecure flag', async () => {
@@ -247,14 +251,18 @@ describe('RequestClient - Self Signed Server', () => {
   })
 
   it('should response the POST method with Unauthorized', async () => {
-    await expect(
-      adapter.getAccessToken('clientId', 'clientSecret', 'incorrect')
-    ).rejects.toEqual(
-      prefixMessage(
-        new LoginRequiredError(incorrectAuthCodeErr),
-        'Error while getting access token. '
+    const expectedError = new LoginRequiredError({
+      error: 'unauthorized',
+      error_description: 'Bad credentials'
+    })
+
+    const rejectionErrorMessage = await adapter
+      .getAccessToken('clientId', 'clientSecret', 'incorrect')
+      .catch((err) =>
+        getTokenRequestErrorPrefixResponse(err.message, ServerType.SasViya)
       )
-    )
+
+    expect(rejectionErrorMessage).toEqual(expectedError.message)
   })
 })
 

src/test/SessionManager.spec.ts

@@ -2,7 +2,7 @@ import { SessionManager } from '../SessionManager'
 import { RequestClient } from '../request/RequestClient'
 import * as dotenv from 'dotenv'
 import axios from 'axios'
-import { Logger, LogLevel } from '@sasjs/utils'
+import { Logger, LogLevel } from '@sasjs/utils/logger'
 import { Session, Context } from '../types'
 
 jest.mock('axios')

src/types/errors/RootFolderNotFoundError.spec.ts

@@ -7,7 +7,7 @@ describe('RootFolderNotFoundError', () => {
 
     const error = new RootFolderNotFoundError(
       '/myProject',
-      'https://analytium.co.uk',
+      'https://sas.4gl.io',
       token
     )
 
@@ -19,7 +19,7 @@ describe('RootFolderNotFoundError', () => {
   it('when access token is not provided, error message should not contain scopes', () => {
     const error = new RootFolderNotFoundError(
       '/myProject',
-      'https://analytium.co.uk'
+      'https://sas.4gl.io'
     )
 
     expect(error).toBeInstanceOf(RootFolderNotFoundError)
@@ -30,7 +30,7 @@ describe('RootFolderNotFoundError', () => {
 
   it('should include the folder path and SASDrive URL in the message', () => {
     const folderPath = '/myProject'
-    const serverUrl = 'https://analytium.co.uk'
+    const serverUrl = 'https://sas.4gl.io'
     const error = new RootFolderNotFoundError(folderPath, serverUrl)
 
     expect(error).toBeInstanceOf(RootFolderNotFoundError)