Merge pull request #836 from sasjs/issue-835

feat(auth): added multi-language support to logIn method

.all-contributorsrc

@@ -106,6 +106,16 @@
         "userTesting",
         "doc"
       ]
+    },
+    {
+      "login": "saramartinelli1992",
+      "name": "Sara",
+      "avatar_url": "https://avatars.githubusercontent.com/u/100193908?v=4",
+      "profile": "https://github.com/saramartinelli1992",
+      "contributions": [
+        "userTesting",
+        "platform"
+      ]
     }
   ],
   "contributorsPerLine": 7,

.github/PULL_REQUEST_TEMPLATE.md

@@ -14,7 +14,7 @@ What code changes have been made to achieve the intent.
 
 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.
 
-
+- [ ] Unit tests coverage has been increased and a new threshold is set.
 - [ ] All `sasjs-cli` unit tests are passing (`npm test`).
 - (CI Runs this) All `sasjs-tests` are passing. If you want to run it manually (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

.github/issue_template.md

@@ -0,0 +1,12 @@
+## Expected behaviour
+*Describe what should be happening*
+
+## Current behaviour
+*Describe what is actually happening* 
+
+## Environment info
+**Client tech stack**: *Angular, React, Vue, VanillaJS, NodeJS etc.*
+**Server type**: SASJS|SASVIYA|SAS9
+**Login mechanism**: Default|Redirected
+**Debug**: true|false
+**Use Compute Api (relevant only on VIYA)**: true|false

.github/reviewer-lottery.yml

@@ -5,7 +5,3 @@ groups:
       - YuryShkoda
       - medjedovicm
       - sabhas
-  - name: SASjs QA
-    reviewers: 1
-    usernames:
-      - VladislavParhomchik

.github/vpn/config.ovpn

@@ -1,30 +1,25 @@
-cipher AES-256-CBC
+# Client
-setenv FORWARD_COMPATIBLE 1
 client
-server-poll-timeout 4
+tls-client
-nobind
-remote vpn.analytium.co.uk 1194 udp
-remote vpn.analytium.co.uk 1194 udp
-remote vpn.analytium.co.uk 443 tcp
-remote vpn.analytium.co.uk 1194 udp
-remote vpn.analytium.co.uk 1194 udp
-remote vpn.analytium.co.uk 1194 udp
-remote vpn.analytium.co.uk 1194 udp
-remote vpn.analytium.co.uk 1194 udp
 dev tun
-dev-type tun
+# this will connect with whatever proto DNS tells us (https://community.openvpn.net/openvpn/ticket/934)
-ns-cert-type server
+proto tcp
-setenv opt tls-version-min 1.0 or-highest
+remote vpn.4gl.io 7494
-reneg-sec 604800
+resolv-retry infinite
-sndbuf 0
+cipher AES-256-CBC
-rcvbuf 0
+auth SHA256
-# NOTE: LZO commands are pushed by the Access Server at connect time.
+script-security 2
-# NOTE: The below line doesn't disable LZO.
+keepalive 10 120
-comp-lzo no
+remote-cert-tls server
-verb 3
-setenv PUSH_PEER_INFO
 
+# 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/assign-reviewer.yml

@@ -10,4 +10,4 @@ jobs:
       - uses: actions/checkout@v2
       - uses: uesteibar/reviewer-lottery@v1
         with:
-          repo-token: ${{ secrets.GH_TOKEN }}
+          repo-token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/build.yml

@@ -12,7 +12,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [lts/fermium]
+        node-version: [lts/hydrogen]
 
     steps:
       - uses: actions/checkout@v2
@@ -22,8 +22,9 @@ jobs:
           node-version: ${{ matrix.node-version }}
           cache: npm
 
-      - name: Check npm audit
+      # FIXME: uncomment 'Check npm audit' step after axios version bump
-        run: npm audit --production --audit-level=low
+      # - name: Check npm audit
+      #   run: npm audit --production --audit-level=low
 
       - name: Install Dependencies
         run: npm ci
@@ -39,12 +40,6 @@ 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
@@ -63,13 +58,16 @@ jobs:
           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-focal.list
+          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=16~beta+focal
+          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: |
           npm install -g replace-in-files-cli
@@ -80,12 +78,16 @@ 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
+          npm run update:adapter
-          scp -o stricthostkeychecking=no -r ./build/* ${{ secrets.DCGITLAB_DEPLOY_PATH_VIYA }}
+          pm2 start --name sasjs-test npm -- start
+
+      - name: Sleep for 10 seconds
+        run: sleep 10s
+        shell: bash
 
       - 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}}

.github/workflows/generateDocs.yml

@@ -11,7 +11,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [lts/fermium]
+        node-version: [lts/hydrogen]
 
     steps:
       - name: Checkout
@@ -37,8 +37,8 @@ jobs:
       - name: Push generated docs
         uses: peaceiris/actions-gh-pages@v3
         with:
-          github_token: ${{ secrets.GH_TOKEN }}
+          github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_branch: gh-pages
-          publish_dir: ./docs 
+          publish_dir: ./docs
           cname: adapter.sasjs.io
 

.github/workflows/npmpublish.yml

@@ -14,7 +14,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [lts/fermium]
+        node-version: [lts/hydrogen]
 
     steps:
       - uses: actions/checkout@v2
@@ -34,10 +34,10 @@ jobs:
         run: npm run build
 
       - name: Semantic Release
-        uses: cycjimmy/semantic-release-action@v2
+        uses: cycjimmy/semantic-release-action@v3
         env:
-          GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
 
       - name: Send Matrix message
-        run: curl -XPOST -d "{\"msgtype\":\"m.text\", \"body\":\"New version of @sasjs/adapter has been released! \n Please deploy and run 'dctests' with new adapter to make sure everything is still in place.\"}" https://matrix.4gl.io/_matrix/client/r0/rooms/!BDUPBPEGVvRLKLQUxY:4gl.io/send/m.room.message?access_token=${{ secrets.MATRIX_TOKEN }}
+        run: curl -XPOST -d "{\"msgtype\":\"m.text\", \"body\":\"New version of @sasjs/adapter has been released! \n Please deploy and run 'dctests' with new adapter to make sure everything is still in place.\"}" https://matrix.4gl.io/_matrix/client/r0/rooms/!jRebyiGmHZlpfDwYXN:4gl.io/send/m.room.message?access_token=${{ secrets.MATRIX_TOKEN }}

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+  "cSpell.words": ["SASVIYA"]
+}

README.md

@@ -20,7 +20,7 @@ SASjs is a open-source framework for building Web Apps on SAS® platforms. You c
 
 1 - `npm install @sasjs/adapter` - for use in a nodeJS project (recommended)
 
-2 - [Download](https://cdn.jsdelivr.net/npm/@sasjs/adapter@3/index.min.js) and use a copy of the latest JS file
+2 - [Download](https://cdn.jsdelivr.net/npm/@sasjs/adapter@4/index.min.js) and use a copy of the latest JS file
 
 3 - Reference directly from the CDN - in which case click [here](https://www.jsdelivr.com/package/npm/@sasjs/adapter?tab=collection) and select "SRI" to get the script tag with the integrity hash.
 
@@ -151,7 +151,19 @@ The `request()` method also has optional parameters such as a config object and
 
 The response object will contain returned tables and columns.  Table names are always lowercase, and column names uppercase.
 
-The adapter will also cache the logs (if debug enabled) and even the work tables.  For performance, it is best to keep debug mode off.
+The adapter will also cache the logs (if debug enabled) and even the work tables. For performance, it is best to keep debug mode off.
+
+### Verbose Mode
+
+Set `verbose` to `true` to enable verbose mode that logs a summary of every HTTP response. Verbose mode can be disabled by calling `disableVerboseMode` method or enabled by `enableVerboseMode` method. Verbose mode also supports `bleached` mode that disables extra colors in req/res summary. To enable `bleached` verbose mode, pass `verbose` equal to `bleached` while instantiating an instance of `RequestClient` or to `setVerboseMode` method. Verbose mode can also be enabled/disabled by `startComputeJob` method.
+
+### Session Manager
+
+To execute a script on Viya a session has to be created first which is time-consuming (~15sec). That is why a Session Manager has been created which is implementing the following logic:
+
+1. When the first session is requested, we also create one more session (hot session) for future requests. Please notice two pending POST requests to create a session within the same context: ![the first session request](./screenshots/session-manager-first-request.png)
+2. When a subsequent request for a session is received and there is a hot session available (not expired), this session is returned and an asynchronous request to create another hot session is sent. Please notice that there is a pending POST request to create a new session while a job has been already finished execution (POST request with status 201): ![subsequent session request](./screenshots/subsequent-session-request.png)
+3. When a subsequent request for a session is received and there is no available hot session, 2 requests are sent asynchronously to create a session. The first created session will be returned and another session will be reserved for future requests.
 
 ### Variable Types
 
@@ -265,6 +277,7 @@ Configuration on the client side involves passing an object on startup, which ca
 * `serverType` - either `SAS9`, `SASVIYA` or `SASJS`.  The `SASJS` server type is for use with [sasjs/server](https://github.com/sasjs/server).
 * `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.
+* `verbose` - optional, if `true` then a summary of every HTTP response is logged.
 * `loginMechanism` - either `Default` or `Redirected`.  See [SAS Logon](#sas-logon) section.
 * `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`.
@@ -332,7 +345,7 @@ If you find this library useful, help us grow our star graph!
 
 ## Contributors ✨
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
-[![All Contributors](https://img.shields.io/badge/all_contributors-8-orange.svg?style=flat-square)](#contributors-)
+[![All Contributors](https://img.shields.io/badge/all_contributors-9-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)):
@@ -341,18 +354,21 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
 <!-- prettier-ignore-start -->
 <!-- markdownlint-disable -->
 <table>
-  <tr>
+  <tbody>
-    <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>
+    <tr>
-    <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" valign="top" width="14.28%"><a href="https://krishna-acondy.io/"><img src="https://avatars.githubusercontent.com/u/2980428?v=4?s=100" width="100px;" alt="Krishna Acondy"/><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://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" valign="top" width="14.28%"><a href="https://www.erudicat.com/"><img src="https://avatars.githubusercontent.com/u/25773492?v=4?s=100" width="100px;" alt="Yury Shkoda"/><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/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" valign="top" width="14.28%"><a href="https://github.com/medjedovicm"><img src="https://avatars.githubusercontent.com/u/18329105?v=4?s=100" width="100px;" alt="Mihajlo Medjedovic"/><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/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" valign="top" width="14.28%"><a href="https://github.com/allanbowe"><img src="https://avatars.githubusercontent.com/u/4420615?v=4?s=100" width="100px;" alt="Allan Bowe"/><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/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" valign="top" width="14.28%"><a href="https://github.com/saadjutt01"><img src="https://avatars.githubusercontent.com/u/8914650?v=4?s=100" width="100px;" alt="Muhammad Saad "/><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/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>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/sabhas"><img src="https://avatars.githubusercontent.com/u/82647447?v=4?s=100" width="100px;" alt="Sabir Hassan"/><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>
-  </tr>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/VladislavParhomchik"><img src="https://avatars.githubusercontent.com/u/83717836?v=4?s=100" width="100px;" alt="VladislavParhomchik"/><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>
+    </tr>
-    <td align="center"><a href="http://rudvfaden.github.io/"><img src="https://avatars.githubusercontent.com/u/2445577?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Rud Faden</b></sub></a><br /><a href="#userTesting-rudvfaden" title="User Testing">📓</a> <a href="https://github.com/sasjs/adapter/commits?author=rudvfaden" title="Documentation">📖</a></td>
+    <tr>
-  </tr>
+      <td align="center" valign="top" width="14.28%"><a href="http://rudvfaden.github.io/"><img src="https://avatars.githubusercontent.com/u/2445577?v=4?s=100" width="100px;" alt="Rud Faden"/><br /><sub><b>Rud Faden</b></sub></a><br /><a href="#userTesting-rudvfaden" title="User Testing">📓</a> <a href="https://github.com/sasjs/adapter/commits?author=rudvfaden" title="Documentation">📖</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/saramartinelli1992"><img src="https://avatars.githubusercontent.com/u/100193908?v=4?s=100" width="100px;" alt="Sara"/><br /><sub><b>Sara</b></sub></a><br /><a href="#userTesting-saramartinelli1992" title="User Testing">📓</a> <a href="#platform-saramartinelli1992" title="Packaging/porting to new platform">📦</a></td>
+    </tr>
+  </tbody>
 </table>
 
 <!-- markdownlint-restore -->

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.wait(1000).then(() => {
-        cy.get('input[placeholder="User Name"]').type(username)
+        const startButton = $body.find(
-        cy.get('input[placeholder="Password"]').type(password)
+          '.ui.massive.icon.primary.left.labeled.button'
-        cy.get('.submit-button').click()
+        )[0]
-      }
 
-      cy.get('input[placeholder="User Name"]', { timeout: 40000 })
+        if (
-        .should('not.exist')
+          !startButton ||
-        .then(() => {
+          (startButton && !Cypress.dom.isVisible(startButton))
-          cy.get('.ui.massive.icon.primary.left.labeled.button')
+        ) {
-            .click()
+          cy.get('input[placeholder="User Name"]').type(username)
-            .then(() => {
+          cy.get('input[placeholder="Password"]').type(password)
-              cy.get('.ui.massive.loading.primary.button', {
+          cy.get('.submit-button').click()
-                timeout: testingFinishTimeout
+        }
-              })
+
-                .should('not.exist')
+        cy.get('input[placeholder="User Name"]', { timeout: 40000 })
-                .then(() => {
+          .should('not.exist')
-                  cy.get('span.icon.failed')
+          .then(() => {
-                    .should('not.exist')
+            cy.get('.ui.massive.icon.primary.left.labeled.button')
-                    .then(() => {
+              .click()
-                      done()
+              .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.wait(1000).then(() => {
-        cy.get('input[placeholder="User Name"]').type(username)
+        const startButton = $body.find(
-        cy.get('input[placeholder="Password"]').type(password)
+          '.ui.massive.icon.primary.left.labeled.button'
-        cy.get('.submit-button').click()
+        )[0]
-      }
 
-      cy.get('.ui.fitted.toggle.checkbox label')
+        if (
-        .click()
+          !startButton ||
-        .then(() => {
+          (startButton && !Cypress.dom.isVisible(startButton))
-          cy.get('input[placeholder="User Name"]', { timeout: 40000 })
+        ) {
-            .should('not.exist')
+          cy.get('input[placeholder="User Name"]').type(username)
-            .then(() => {
+          cy.get('input[placeholder="Password"]').type(password)
-              cy.get('.ui.massive.icon.primary.left.labeled.button')
+          cy.get('.submit-button').click()
-                .click()
+        }
-                .then(() => {
+
-                  cy.get('.ui.massive.loading.primary.button', {
+        cy.get('.ui.fitted.toggle.checkbox label')
-                    timeout: testingFinishTimeout
+          .click()
-                  })
+          .then(() => {
-                    .should('not.exist')
+            cy.get('input[placeholder="User Name"]', { timeout: 40000 })
-                    .then(() => {
+              .should('not.exist')
-                      cy.get('span.icon.failed')
+              .then(() => {
-                        .should('not.exist')
+                cy.get('.ui.massive.icon.primary.left.labeled.button')
-                        .then(() => {
+                  .click()
-                          done()
+                  .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"

jest.config.js

@@ -41,7 +41,14 @@ module.exports = {
   // ],
 
   // An object that configures minimum threshold enforcement for coverage results
-  // coverageThreshold: undefined,
+  coverageThreshold: {
+    global: {
+      statements: 64.03,
+      branches: 45.11,
+      functions: 54.18,
+      lines: 64.53
+    }
+  },
 
   // A path to a custom dependency extractor
   // dependencyExtractor: undefined,

package.json

@@ -45,13 +45,11 @@
   "license": "ISC",
   "devDependencies": {
     "@cypress/webpack-preprocessor": "5.9.1",
-    "@types/axios": "0.14.0",
     "@types/express": "4.17.13",
-    "@types/form-data": "2.5.0",
     "@types/jest": "27.4.0",
     "@types/mime": "2.0.3",
     "@types/pem": "1.9.6",
-    "@types/tough-cookie": "4.0.1",
+    "@types/tough-cookie": "4.0.2",
     "copyfiles": "2.4.1",
     "cp": "0.2.0",
     "cypress": "7.7.0",
@@ -61,29 +59,29 @@
     "jest-extended": "2.0.0",
     "node-polyfill-webpack-plugin": "1.1.4",
     "path": "0.12.7",
-    "pem": "1.14.6",
+    "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",
-    "terser-webpack-plugin": "5.3.1",
+    "terser-webpack-plugin": "5.3.6",
     "ts-jest": "27.1.3",
     "ts-loader": "9.4.0",
     "tslint": "6.1.3",
     "tslint-config-prettier": "1.18.0",
-    "typedoc": "0.23.15",
+    "typedoc": "0.23.24",
-    "typedoc-plugin-rename-defaults": "0.4.0",
+    "typedoc-plugin-rename-defaults": "0.6.4",
     "typescript": "4.8.3",
-    "webpack": "5.69.0",
+    "webpack": "5.76.2",
     "webpack-cli": "4.9.2"
   },
   "main": "index.js",
   "dependencies": {
-    "@sasjs/utils": "2.48.2",
+    "@sasjs/utils": "2.52.0",
-    "axios": "0.26.0",
+    "axios": "0.27.2",
     "axios-cookiejar-support": "1.0.1",
     "form-data": "4.0.0",
     "https": "1.0.0",
-    "tough-cookie": "4.0.0"
+    "tough-cookie": "4.1.3"
   }
 }

sasjs-tests/.gitignore

@@ -13,11 +13,11 @@
 
 # misc
 .DS_Store
-.env.local
+.env.*
-.env.development.local
-.env.test.local
-.env.production.local
 
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
+
+sasjsbuild
+sasjsresults

sasjs-tests/.sasjslint

@@ -0,0 +1,19 @@
+{
+  "lineEndings": "off",
+  "noTrailingSpaces": true,
+  "noEncodedPasswords": true,
+  "hasDoxygenHeader": true,
+  "noSpacesInFileNames": true,
+  "lowerCaseFileNames": true,
+  "maxLineLength": 80,
+  "maxHeaderLineLength": 80,
+  "maxDataLineLength": 80,
+  "noTabIndentation": true,
+  "indentationMultiple": 2,
+  "hasMacroNameInMend": true,
+  "noNestedMacros": true,
+  "hasMacroParentheses": true,
+  "strictMacroDefinition": true,
+  "noGremlins": true,
+  "defaultHeader": "/**{lineEnding}  @file{lineEnding}  @brief <Your brief here>{lineEnding}  <h4> SAS Macros </h4>{lineEnding}**/"
+}

sasjs-tests/README.md

@@ -65,6 +65,7 @@ The code below will work on ALL SAS platforms (Viya, SAS 9 EBI, SASjs Server).
 ```sas
 filename mc url "https://raw.githubusercontent.com/sasjs/core/main/all.sas";
 %inc mc;
+%let apploc=/Public/app/adapter-tests;
 filename ft15f001 temp lrecl=1000;
 parmcards4;
   %webout(FETCH)
@@ -80,7 +81,7 @@ parmcards4;
   %mend; %x()
   %webout(CLOSE)
 ;;;;
-%mx_createwebservice(path=/Public/app/common,name=sendObj)
+%mx_createwebservice(path=&apploc/services/common,name=sendObj)
 parmcards4;
   %webout(FETCH)
   %webout(OPEN)
@@ -95,7 +96,7 @@ parmcards4;
   %mend; %x()
   %webout(CLOSE)
 ;;;;
-%mx_createwebservice(path=/Public/app/common,name=sendArr)
+%mx_createwebservice(path=&apploc/services/common,name=sendArr)
 parmcards4;
   data work.macvars;
     set sashelp.vmacro;
@@ -104,14 +105,14 @@ parmcards4;
   %webout(OBJ,macvars) 
   %webout(CLOSE)
 ;;;;
-%mx_createwebservice(path=/Public/app/common,name=sendMacVars)
+%mx_createwebservice(path=&apploc/services/common,name=sendMacVars)
 parmcards4;
 If you can keep your head when all about you
     Are losing theirs and blaming it on you,
 If you can trust yourself when all men doubt you,
     But make allowance for their doubting too;
 ;;;;
-%mx_createwebservice(path=/Public/app/common,name=makeErr)
+%mx_createwebservice(path=&apploc/services/common,name=makeErr)
 parmcards4;
 %webout(OPEN)
 data _null_;
@@ -120,7 +121,7 @@ data _null_;
  run;
 %webout(CLOSE)
 ;;;;
-%mx_createwebservice(path=/Public/app/common,name=invalidJSON)
+%mx_createwebservice(path=&apploc/services/common,name=invalidJSON)
 ```
 
 You should now be able to access the tests in your browser at the deployed path on your server.

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",
-    "@sasjs/test-framework": "^1.5.6",
     "@types/jest": "^26.0.20",
     "@types/node": "^14.14.41",
-    "@types/react": "^17.0.1",
+    "@types/react": "^16.0.1",
-    "@types/react-dom": "^17.0.0",
+    "@types/react-dom": "^16.0.0",
     "@types/react-router-dom": "^5.1.7",
-    "react": "^17.0.1",
+    "react": "^16.0.1",
-    "react-dom": "^17.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.1"
+    "node-sass": "9.0.0"
   }
 }

sasjs-tests/public/config.json

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

sasjs-tests/sasjs-cypress-run.sh

@@ -4,7 +4,7 @@ if npm run cy:run -- --spec "cypress/integration/sasjs.tests.ts" ; then
     echo "Cypress sasjs testing passed!"
 else
     echo '{"msgtype":"m.text", "body":"Automated sasjs-tests failed on the @sasjs/adapter PR: '$2'"}'
-    curl -XPOST -d '{"msgtype":"m.text", "body":"Automated sasjs-tests failed on the @sasjs/adapter PR: '$2'"}' https://matrix.4gl.io/_matrix/client/r0/rooms/%21BDUPBPEGVvRLKLQUxY:4gl.io/send/m.room.message?access_token=$1
+    curl -XPOST -d '{"msgtype":"m.text", "body":"Automated sasjs-tests failed on the @sasjs/adapter PR: '$2'"}' https://matrix.4gl.io/_matrix/client/r0/rooms/%21jRebyiGmHZlpfDwYXN:4gl.io:4gl.io/send/m.room.message?access_token=$1
     echo "Cypress sasjs testing failed!"
     exit 1
 fi

sasjs-tests/sasjs/common/invalidJSON.sas

@@ -0,0 +1,13 @@
+/**
+  @file
+  @brief Makes an invalid JSON file
+
+  <h4> SAS Macros </h4>
+**/
+
+%webout(OPEN)
+data _null_;
+  file _webout;
+  put ' the discovery channel ';
+run;
+%webout(CLOSE)

sasjs-tests/sasjs/common/makeErr.sas

@@ -0,0 +1,11 @@
+/**
+  @file
+  @brief Makes an error
+
+  <h4> SAS Macros </h4>
+**/
+
+If you can keep your head when all about you
+    Are losing theirs and blaming it on you,
+If you can trust yourself when all men doubt you,
+    But make allowance for their doubting too;

sasjs-tests/sasjs/common/sendArr.sas

@@ -0,0 +1,21 @@
+/**
+  @file
+  @brief Returns JSON in Array format
+
+  <h4> SAS Macros </h4>
+**/
+
+%webout(FETCH)
+%webout(OPEN)
+%macro x();
+  %if %symexist(sasjs_tables) %then
+  %do i=1 %to %sysfunc(countw(&sasjs_tables));
+    %let table=%scan(&sasjs_tables,&i);
+    %webout(ARR,&table,missing=STRING,showmeta=YES)
+  %end;
+  %else %do i=1 %to &_webin_file_count;
+    %webout(ARR,&&_webin_name&i,missing=STRING,showmeta=YES)
+  %end;
+%mend x;
+%x()
+%webout(CLOSE)

sasjs-tests/sasjs/common/sendMacVars.sas

@@ -0,0 +1,13 @@
+/**
+  @file
+  @brief Returns Macro Variables
+
+  <h4> SAS Macros </h4>
+**/
+
+data work.macvars;
+  set sashelp.vmacro;
+run;
+%webout(OPEN)
+%webout(OBJ,macvars)
+%webout(CLOSE)

sasjs-tests/sasjs/common/sendObj.sas

@@ -0,0 +1,21 @@
+/**
+  @file
+  @brief Returns JSON in Object format
+
+  <h4> SAS Macros </h4>
+**/
+
+%webout(FETCH)
+%webout(OPEN)
+%macro x();
+  %if %symexist(sasjs_tables) %then
+  %do i=1 %to %sysfunc(countw(&sasjs_tables));
+    %let table=%scan(&sasjs_tables,&i);
+    %webout(OBJ,&table,missing=STRING,showmeta=YES)
+  %end;
+  %else %do i=1 %to &_webin_file_count;
+    %webout(OBJ,&&_webin_name&i,missing=STRING,showmeta=YES)
+  %end;
+%mend x;
+%x()
+%webout(CLOSE)

sasjs-tests/sasjs/doxy/Doxyfile

@@ -0,0 +1,40 @@
+ALPHABETICAL_INDEX     = NO
+
+ENABLE_PREPROCESSING   = NO
+EXTENSION_MAPPING      = sas=Java ddl=Java
+EXTRACT_LOCAL_CLASSES  = NO
+FILE_PATTERNS          = *.sas \
+                         *.ddl \
+                         *.dox
+GENERATE_LATEX         = NO
+GENERATE_TREEVIEW      = YES
+HIDE_FRIEND_COMPOUNDS  = YES
+HIDE_IN_BODY_DOCS      = YES
+HIDE_SCOPE_NAMES       = YES
+HIDE_UNDOC_CLASSES     = YES
+HIDE_UNDOC_MEMBERS     = YES
+HTML_OUTPUT            = $(DOXY_HTML_OUTPUT)
+HTML_HEADER            = $(HTML_HEADER)
+HTML_EXTRA_FILES       = $(HTML_EXTRA_FILES)
+HTML_FOOTER            = $(HTML_FOOTER)
+HTML_EXTRA_STYLESHEET  = $(HTML_EXTRA_STYLESHEET)
+INHERIT_DOCS           = NO
+INLINE_INFO            = NO
+INPUT                  = $(DOXY_INPUT)
+LAYOUT_FILE            = $(LAYOUT_FILE)
+USE_MDFILE_AS_MAINPAGE = README.md
+MAX_INITIALIZER_LINES  = 0
+PROJECT_NAME           = $(PROJECT_NAME)
+PROJECT_LOGO           = $(PROJECT_LOGO)
+PROJECT_BRIEF          = $(PROJECT_BRIEF)
+RECURSIVE              = YES
+REPEAT_BRIEF           = NO
+SHOW_NAMESPACES        = NO
+SHOW_USED_FILES        = NO
+SOURCE_BROWSER         = YES
+SOURCE_TOOLTIPS        = NO
+STRICT_PROTO_MATCHING  = YES
+STRIP_CODE_COMMENTS    = NO
+SUBGROUPING            = NO
+TAB_SIZE               = 2
+VERBATIM_HEADERS       = NO

sasjs-tests/sasjs/doxy/DoxygenLayout.xml

@@ -0,0 +1,112 @@
+<doxygenlayout version="1.0">
+  <!-- Generated by doxygen 1.8.14 -->
+  <!-- Navigation index tabs for HTML output -->
+  <navindex>
+    <tab type="mainpage" visible="yes" title="Home"/>
+    <tab type="pages" visible="no" title="" intro=""/>
+    <tab type="modules" visible="no" title="" intro=""/>
+    <tab type="namespaces" visible="no" title="">
+      <tab type="namespacelist" visible="no" title="" intro=""/>
+      <tab type="namespacemembers" visible="no" title="" intro=""/>
+    </tab>
+    <tab type="classes" visible="no" title="">
+      <tab type="classlist" visible="no" title="" intro=""/>
+      <tab type="classindex" visible="no" title=""/>
+      <tab type="hierarchy" visible="no" title="" intro=""/>
+      <tab type="classmembers" visible="no" title="" intro=""/>
+    </tab>
+
+    <tab type="filelist" visible="yes" title="" intro="List of Files"/>
+
+    <tab type="examples" visible="no" title="" intro=""/>
+    <tab type="user" url="data_lineage.svg" title="Lineage"/>
+  </navindex>
+
+
+  <!-- Layout definition for a file page -->
+  <file>
+    <briefdescription visible="yes"/>
+    <includes visible="$SHOW_INCLUDE_FILES"/>
+    <includegraph visible="$INCLUDE_GRAPH"/>
+    <includedbygraph visible="$INCLUDED_BY_GRAPH"/>
+    <sourcelink visible="yes"/>
+    <memberdecl>
+      <classes visible="no" title=""/>
+      <namespaces visible="no" title=""/>
+      <constantgroups visible="no" title=""/>
+      <defines title=""/>
+      <typedefs title=""/>
+      <enums title=""/>
+      <functions title=""/>
+      <variables title=""/>
+      <membergroups visible="no"/>
+    </memberdecl>
+    <detaileddescription title=""/>
+    <memberdef>
+      <inlineclasses title=""/>
+      <defines title=""/>
+      <typedefs title=""/>
+      <enums title=""/>
+      <functions title=""/>
+      <variables title=""/>
+    </memberdef>
+    <authorsection/>
+  </file>
+
+  <!-- Layout definition for a group page -->
+  <group>
+    <briefdescription visible="no"/>
+    <groupgraph visible="$GROUP_GRAPHS"/>
+    <memberdecl>
+      <nestedgroups visible="no" title=""/>
+      <dirs visible="yes" title=""/>
+      <files visible="yes" title=""/>
+      <namespaces visible="no" title=""/>
+      <classes visible="no" title=""/>
+      <defines title=""/>
+      <typedefs title=""/>
+      <enums title=""/>
+      <enumvalues title=""/>
+      <functions title=""/>
+      <variables title=""/>
+      <signals title=""/>
+      <publicslots title=""/>
+      <protectedslots title=""/>
+      <privateslots title=""/>
+      <events title=""/>
+      <properties title=""/>
+      <friends title=""/>
+      <membergroups visible="yes"/>
+    </memberdecl>
+    <detaileddescription title=""/>
+    <memberdef>
+      <pagedocs/>
+      <inlineclasses title=""/>
+      <defines title=""/>
+      <typedefs title=""/>
+      <enums title=""/>
+      <enumvalues title=""/>
+      <functions title=""/>
+      <variables title=""/>
+      <signals title=""/>
+      <publicslots title=""/>
+      <protectedslots title=""/>
+      <privateslots title=""/>
+      <events title=""/>
+      <properties title=""/>
+      <friends title=""/>
+    </memberdef>
+    <authorsection visible="yes"/>
+  </group>
+
+  <!-- Layout definition for a directory page -->
+  <directory>
+    <briefdescription visible="yes"/>
+    <detaileddescription visible="yes" title=""/>
+    <directorygraph visible="yes"/>
+    <memberdecl>
+      <dirs visible="yes"/>
+      <files visible="yes"/>
+    </memberdecl>
+  </directory>
+</doxygenlayout>

sasjs-tests/sasjs/doxy/new_footer.html

@@ -0,0 +1,33 @@
+<!-- HTML footer for doxygen 1.8.17-->
+<!-- start footer part -->
+<!--BEGIN GENERATE_TREEVIEW-->
+<div id="nav-path" class="navpath">
+  <!-- id is needed for treeview function! -->
+  <ul>
+    $navpath
+    <li class="footer">
+      $generatedby
+      <a href="https://www.doxygen.org/index.html">
+        <img class="footer" src="$relpath^doxygen.svg" alt="doxygen"
+      /></a>
+      $doxygenversion
+    </li>
+    <li>
+      <i> For more information visit the </i>
+      <a href="https://cli.sasjs.io">SASjs cli</a> documentation.
+    </li>
+  </ul>
+</div>
+<!--END GENERATE_TREEVIEW-->
+<!--BEGIN !GENERATE_TREEVIEW-->
+<hr class="footer" />
+<address class="footer">
+  <small>
+    $generatedby &#160;<a href="http://www.doxygen.org/index.html">
+      <img class="footer" src="$relpath^doxygen.svg" alt="doxygen" />
+    </a>
+    $doxygenversion
+  </small>
+</address>
+
+<!--END !GENERATE_TREEVIEW-->

sasjs-tests/sasjs/doxy/new_header.html

@@ -0,0 +1,57 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<!-- HTML header for doxygen 1.8.17-->
+<html xmlns="https://www.w3.org/1999/xhtml" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8" />
+    <meta http-equiv="X-UA-Compatible" content="IE=9" />
+    <meta name="generator" content="Doxygen $doxygenversion" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <!--BEGIN PROJECT_NAME-->
+    <title>$projectname: $title</title>
+    <meta name="description" content="$projectbrief" />
+    <!--END PROJECT_NAME-->
+    <!--BEGIN !PROJECT_NAME-->
+    <title>$title</title>
+    <!--END !PROJECT_NAME-->
+    <link href="$relpath^tabs.css" rel="stylesheet" type="text/css" />
+    <script type="text/javascript" src="$relpath^jquery.js"></script>
+    <script type="text/javascript" src="$relpath^dynsections.js"></script>
+    $treeview $search $mathjax
+    <link href="$relpath^$stylesheet" rel="stylesheet" type="text/css" />
+    <link rel="shortcut icon" href="$relpath^favicon.ico" type="image/x-icon" />
+    $extrastylesheet
+  </head>
+  <body>
+    <div id="top">
+      <!-- do not remove this div, it is closed by doxygen! -->
+
+      <!--BEGIN TITLEAREA-->
+      <div id="titlearea">
+        <table cellspacing="0" cellpadding="0">
+          <tbody>
+            <tr style="height: 56px">
+              <!--BEGIN PROJECT_LOGO-->
+              <td id="projectlogo">
+                <a href="$relpath^"
+                  ><img alt="Logo" src="$relpath^$projectlogo"
+                /></a>
+              </td>
+              <!--END PROJECT_LOGO-->
+              <td id="projectalign" style="padding-left: 0.5em">
+                <div id="projectname">$projectname</div>
+                <div id="projectbrief">$projectbrief</div>
+              </td>
+              <!--BEGIN DISABLE_INDEX-->
+              <!--BEGIN SEARCHENGINE-->
+              <td>$searchbox</td>
+              <!--END SEARCHENGINE-->
+              <!--END DISABLE_INDEX-->
+            </tr>
+          </tbody>
+        </table>
+      </div>
+      <!--END TITLEAREA-->
+      <!-- end header part -->
+    </div>
+  </body>
+</html>

sasjs-tests/sasjs/doxy/new_stylesheet.css

@@ -0,0 +1,4 @@
+#projectlogo img {
+  border: 0px none;
+  max-height: 70px;
+}

sasjs-tests/sasjs/sasjsconfig.json

@@ -0,0 +1,29 @@
+{
+  "$schema": "https://cli.sasjs.io/sasjsconfig-schema.json",
+  "serviceConfig": {
+    "serviceFolders": ["sasjs/common"]
+  },
+  "defaultTarget": "4gl",
+  "targets": [
+    {
+      "name": "4gl",
+      "serverUrl": "https://sas9.4gl.io",
+      "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": []
+      }
+    }
+  ]
+}

sasjs-tests/src/testSuites/Compute.ts

@@ -48,7 +48,7 @@ export const computeTests = (adapter: SASjs, appLoc: string): TestSuite => ({
       test: () => {
         const data: any = { table1: [{ col1: 'first col value' }] }
         return adapter.startComputeJob(
-          '/Public/app/common/sendArr',
+          '/Public/app/adapter-tests/services/common/sendArr',
           data,
           {},
           undefined,

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

@@ -25,10 +25,16 @@ import { prefixMessage } from '@sasjs/utils/error'
 import { pollJobState } from './api/viya/pollJobState'
 import { getTokens } from './auth/getTokens'
 import { uploadTables } from './api/viya/uploadTables'
-import { executeScript } from './api/viya/executeScript'
+import { executeOnComputeApi } from './api/viya/executeOnComputeApi'
 import { getAccessTokenForViya } from './auth/getAccessTokenForViya'
 import { refreshTokensForViya } from './auth/refreshTokensForViya'
 
+interface JobExecutionResult {
+  result?: { result: object }
+  log?: string
+  error?: object
+}
+
 /**
  * A client for interfacing with the SAS Viya REST API.
  *
@@ -270,7 +276,7 @@ export class SASViyaApiClient {
    * @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).
    * @param waitForResult - when set to true, function will return the session
-   * @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 }.
+   * @param pollOptions - an object that represents poll interval(milliseconds) and maximum amount of attempts. Object example: { maxPollCount: 24 * 60 * 60, pollInterval: 1000 }. More information available at src/api/viya/pollJobState.ts.
    * @param printPid - a boolean that indicates whether the function should print (PID) of the started job.
    * @param variables - an object that represents macro variables.
    */
@@ -287,7 +293,7 @@ export class SASViyaApiClient {
     printPid = false,
     variables?: MacroVar
   ): Promise<any> {
-    return executeScript(
+    return executeOnComputeApi(
       this.requestClient,
       this.sessionManager,
       this.rootFolderName,
@@ -378,12 +384,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 +402,7 @@ export class SASViyaApiClient {
           parentFolderPath.lastIndexOf('/')
         )
         const newFolderName = `${parentFolderPath.split('/').pop()}`
+
         if (newParentFolderPath === '') {
           throw new RootFolderNotFoundError(
             parentFolderPath,
@@ -401,20 +410,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 +440,8 @@ export class SASViyaApiClient {
       }
     }
 
-    const { result: createFolderResponse } =
+    const { result: createFolderResponse } = await this.requestClient
-      await this.requestClient.post<Folder>(
+      .post<Folder>(
         `/folders/folders?parentFolderUri=${parentFolderUri}`,
         {
           name: folderName,
@@ -436,12 +449,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
   }
 
@@ -548,6 +583,7 @@ export class SASViyaApiClient {
 
   /**
    * Exchanges the refresh token for an access token for the given client.
+   * This method can only be used by Node.
    * @param clientId - the client ID to authenticate with.
    * @param clientSecret - the client secret to authenticate with.
    * @param refreshToken - the refresh token received from the server.
@@ -591,7 +627,7 @@ export class SASViyaApiClient {
    * @param accessToken - an optional access token for an authorized user.
    * @param waitForResult - a boolean indicating if the function should wait for a result.
    * @param expectWebout - a boolean indicating whether to expect a _webout response.
-   * @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 }.
+   * @param pollOptions - an object that represents poll interval(milliseconds) and maximum amount of attempts. Object example: { maxPollCount: 24 * 60 * 60, pollInterval: 1000 }. More information available at src/api/viya/pollJobState.ts.
    * @param printPid - a boolean that indicates whether the function should print (PID) of the started job.
    * @param variables - an object that represents macro variables.
    */
@@ -702,11 +738,13 @@ export class SASViyaApiClient {
     debug: boolean,
     data?: any,
     authConfig?: AuthConfig
-  ) {
+  ): Promise<JobExecutionResult> {
     let access_token = (authConfig || {}).access_token
+
     if (authConfig) {
       ;({ access_token } = await getTokens(this.requestClient, authConfig))
     }
+
     if (isRelativePath(sasJob) && !this.rootFolderName) {
       throw new Error(
         'Relative paths cannot be used without specifying a root folder name.'
@@ -719,6 +757,7 @@ export class SASViyaApiClient {
     const fullFolderPath = isRelativePath(sasJob)
       ? `${this.rootFolderName}/${folderPath}`
       : folderPath
+
     await this.populateFolderMap(fullFolderPath, access_token)
 
     const jobFolder = this.folderMap.get(fullFolderPath)
@@ -735,9 +774,8 @@ export class SASViyaApiClient {
       files = await this.uploadTables(data, access_token)
     }
 
-    if (!jobToExecute) {
+    if (!jobToExecute) throw new Error(`Job was not found.`)
-      throw new Error(`Job was not found.`)
+
-    }
     const jobDefinitionLink = jobToExecute?.links.find(
       (l) => l.rel === 'getResource'
     )?.href
@@ -777,16 +815,19 @@ export class SASViyaApiClient {
       jobDefinition,
       arguments: jobArguments
     }
+
     const { result: postedJob } = await this.requestClient.post<Job>(
       `${this.serverUrl}/jobExecution/jobs?_action=wait`,
       postJobRequestBody,
       access_token
     )
+
     const jobStatus = await this.pollJobState(postedJob, 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}`,
       access_token
@@ -797,6 +838,7 @@ export class SASViyaApiClient {
 
     const resultLink = currentJob.results['_webout.json']
     const logLink = currentJob.links.find((l) => l.rel === 'log')
+
     if (resultLink) {
       jobResult = await this.requestClient.get<any>(
         `${this.serverUrl}${resultLink}/content`,
@@ -804,11 +846,13 @@ export class SASViyaApiClient {
         'text/plain'
       )
     }
+
     if (debug && logLink) {
       log = await this.requestClient
         .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') {
       throw new JobExecutionError(
         currentJob.error?.errorCode,
@@ -816,7 +860,16 @@ export class SASViyaApiClient {
         log
       )
     }
-    return { result: jobResult?.result, log }
+
+    const executionResult: JobExecutionResult = {
+      result: jobResult?.result,
+      log
+    }
+
+    const { error } = currentJob
+    if (error) executionResult.error = error
+
+    return executionResult
   }
 
   private async populateFolderMap(folderPath: string, accessToken?: string) {
@@ -899,7 +952,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
@@ -983,7 +1036,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
@@ -1050,7 +1103,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

@@ -5,6 +5,10 @@ import {
   EditContextInput,
   PollOptions,
   LoginMechanism,
+  VerboseMode,
+  ErrorResponse,
+  LoginOptions,
+  LoginResult,
   ExecutionQuery
 } from './types'
 import { SASViyaApiClient } from './SASViyaApiClient'
@@ -17,7 +21,6 @@ import {
   AuthConfig,
   ExtraResponseAttributes,
   SasAuthResponse,
-  ServicePackSASjs,
   AuthConfigSas9
 } from '@sasjs/utils/types'
 import { RequestClient } from './request/RequestClient'
@@ -31,8 +34,7 @@ import {
   Sas9JobExecutor,
   FileUploader
 } from './job-execution'
-import { ErrorResponse } from './types/errors'
+import { AxiosResponse, AxiosError } from 'axios'
-import { LoginOptions, LoginResult } from './types/Login'
 
 interface ExecuteScriptParams {
   linesOfCode: string[]
@@ -159,6 +161,23 @@ export default class SASjs {
     }
   }
 
+  /**
+   * Executes job on SASJS server.
+   * @param query - an object containing job path and debug level.
+   * @param appLoc - an application path.
+   * @param authConfig - an object for authentication.
+   * @returns a promise that resolves into job execution result and log.
+   */
+  public async executeJob(
+    query: ExecutionQuery,
+    appLoc: string,
+    authConfig?: AuthConfig
+  ) {
+    this.isMethodSupported('executeScript', [ServerType.Sasjs])
+
+    return await this.sasJSApiClient?.executeJob(query, appLoc, authConfig)
+  }
+
   /**
    * Gets compute contexts.
    * @param accessToken - an access token for an authorised user.
@@ -339,13 +358,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,
@@ -785,13 +807,11 @@ export default class SASjs {
     this.isMethodSupported('deployServicePack', [ServerType.SasViya])
 
     let sasApiClient: any = null
+
     if (serverUrl || appLoc) {
-      if (!serverUrl) {
+      if (!serverUrl) serverUrl = this.sasjsConfig.serverUrl
-        serverUrl = this.sasjsConfig.serverUrl
+      if (!appLoc) appLoc = this.sasjsConfig.appLoc
-      }
+
-      if (!appLoc) {
-        appLoc = this.sasjsConfig.appLoc
-      }
       if (this.sasjsConfig.serverType === ServerType.SasViya) {
         sasApiClient = new SASViyaApiClient(
           serverUrl,
@@ -809,11 +829,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
     }
@@ -850,9 +872,10 @@ export default class SASjs {
    * @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 }.
+   * @param pollOptions - an object that represents poll interval(milliseconds) and maximum amount of attempts. Object example: { maxPollCount: 24 * 60 * 60, pollInterval: 1000 }. More information available at src/api/viya/pollJobState.ts.
    * @param printPid - a boolean that indicates whether the function should print (PID) of the started job.
    * @param variables - an object that represents macro variables.
+   * @param verboseMode - boolean or a string equal to 'bleached' to enable verbose mode (log every HTTP response).
    */
   public async startComputeJob(
     sasJob: string,
@@ -862,7 +885,8 @@ export default class SASjs {
     waitForResult?: boolean,
     pollOptions?: PollOptions,
     printPid = false,
-    variables?: MacroVar
+    variables?: MacroVar,
+    verboseMode?: VerboseMode
   ) {
     config = {
       ...this.sasjsConfig,
@@ -876,6 +900,11 @@ export default class SASjs {
       )
     }
 
+    if (verboseMode) {
+      this.requestClient?.setVerboseMode(verboseMode)
+      this.requestClient?.enableVerboseMode()
+    } else if (verboseMode === false) this.requestClient?.disableVerboseMode()
+
     return this.sasViyaApiClient?.executeComputeJob(
       sasJob,
       config.contextName,
@@ -895,6 +924,7 @@ export default class SASjs {
     await this.computeJobExecutor?.resendWaitingRequests()
     await this.jesJobExecutor?.resendWaitingRequests()
     await this.fileUploader?.resendWaitingRequests()
+    await this.sasjsJobExecutor?.resendWaitingRequests()
   }
 
   /**
@@ -968,7 +998,8 @@ export default class SASjs {
       this.requestClient = new RequestClientClass(
         this.sasjsConfig.serverUrl,
         this.sasjsConfig.httpsAgentOptions,
-        this.sasjsConfig.requestHistoryLimit
+        this.sasjsConfig.requestHistoryLimit,
+        this.sasjsConfig.verbose
       )
     } else {
       this.requestClient.setConfig(
@@ -1132,4 +1163,31 @@ export default class SASjs {
       )
     }
   }
+
+  /**
+   * Enables verbose mode that will log a summary of every HTTP response.
+   * @param successCallBack - function that should be triggered on every HTTP response with the status 2**.
+   * @param errorCallBack - function that should be triggered on every HTTP response with the status different from 2**.
+   */
+  public enableVerboseMode(
+    successCallBack?: (response: AxiosResponse | AxiosError) => AxiosResponse,
+    errorCallBack?: (response: AxiosResponse | AxiosError) => AxiosResponse
+  ) {
+    this.requestClient?.enableVerboseMode(successCallBack, errorCallBack)
+  }
+
+  /**
+   * Turns off verbose mode to log every HTTP response.
+   */
+  public disableVerboseMode() {
+    this.requestClient?.disableVerboseMode()
+  }
+
+  /**
+   * Sets verbose mode.
+   * @param verboseMode - value of the verbose mode, can be true, false or bleached(without extra colors).
+   */
+  public setVerboseMode = (verboseMode: VerboseMode) => {
+    this.requestClient?.setVerboseMode(verboseMode)
+  }
 }

src/SASjsApiClient.ts

@@ -1,13 +1,39 @@
+import * as NodeFormData from 'form-data'
 import { AuthConfig, ServerType, ServicePackSASjs } from '@sasjs/utils/types'
+import { prefixMessage } from '@sasjs/utils/error'
 import { ExecutionQuery } from './types'
 import { RequestClient } from './request/RequestClient'
 import { getAccessTokenForSasjs } from './auth/getAccessTokenForSasjs'
 import { refreshTokensForSasjs } from './auth/refreshTokensForSasjs'
 import { getTokens } from './auth/getTokens'
 
+// TODO: move to sasjs/utils
+export interface SASjsAuthResponse {
+  access_token: string
+  refresh_token: string
+}
+
+export interface ScriptExecutionResult {
+  log: string
+  webout?: string
+  printOutput?: string
+}
+
 export class SASjsApiClient {
   constructor(private requestClient: RequestClient) {}
 
+  private async getAccessTokenForRequest(authConfig?: AuthConfig) {
+    if (authConfig) {
+      const { access_token } = await getTokens(
+        this.requestClient,
+        authConfig,
+        ServerType.Sasjs
+      )
+
+      return access_token
+    }
+  }
+
   /**
    * Creates the folders and services at the given location `appLoc` on the given server `serverUrl`.
    * @param dataJson - the JSON specifying the folders and files to be created, can also includes
@@ -20,15 +46,7 @@ export class SASjsApiClient {
     appLoc: string,
     authConfig?: AuthConfig
   ) {
-    let access_token = (authConfig || {}).access_token
+    const access_token = await this.getAccessTokenForRequest(authConfig)
-    if (authConfig) {
-      ;({ access_token } = await getTokens(
-        this.requestClient,
-        authConfig,
-        ServerType.Sasjs
-      ))
-    }
-
     dataJson.appLoc = dataJson.appLoc || appLoc
 
     const { result } = await this.requestClient.post<{
@@ -48,6 +66,40 @@ export class SASjsApiClient {
     return Promise.resolve(result)
   }
 
+  /**
+   * Creates/updates files within SASjs drive using uploaded json compressed file.
+   * @param zipFilePath - Compressed file path; file should only contain one JSON file and
+   * should have same name as of compressed file e.g. deploy.JSON should be compressed to deploy.JSON.zip
+   * Any other file or JSON file in zipped will be ignored!
+   * @param authConfig - (optional) a valid client, secret, refresh and access tokens that are authorised to execute compute jobs.
+   */
+  public async deployZipFile(zipFilePath: string, authConfig?: AuthConfig) {
+    const { createReadStream } = require('@sasjs/utils/file')
+    const access_token = await this.getAccessTokenForRequest(authConfig)
+
+    const file = await createReadStream(zipFilePath)
+    const formData = new NodeFormData()
+    formData.append('file', file)
+
+    const contentType = `multipart/form-data; boundary=${formData.getBoundary()}`
+
+    const { result } = await this.requestClient.post<{
+      status: string
+      message: string
+      streamServiceName?: string
+      example?: {}
+    }>(
+      'SASjsApi/drive/deploy/upload',
+      formData,
+      access_token,
+      contentType,
+      {},
+      { maxContentLength: Infinity, maxBodyLength: Infinity }
+    )
+
+    return Promise.resolve(result)
+  }
+
   public async executeJob(
     query: ExecutionQuery,
     appLoc: string,
@@ -79,25 +131,28 @@ export class SASjsApiClient {
     code: string,
     runTime: string = 'sas',
     authConfig?: AuthConfig
-  ) {
+  ): Promise<ScriptExecutionResult> {
-    let access_token = (authConfig || {}).access_token
+    const access_token = await this.getAccessTokenForRequest(authConfig)
-    if (authConfig) {
+    const executionResult: ScriptExecutionResult = { log: '' }
-      ;({ access_token } = await getTokens(
-        this.requestClient,
-        authConfig,
-        ServerType.Sasjs
-      ))
-    }
-
-    let parsedSasjsServerLog = ''
 
     await this.requestClient
       .post('SASjsApi/code/execute', { code, runTime }, access_token)
       .then((res: any) => {
-        if (res.log) parsedSasjsServerLog = res.log
+        const { log, printOutput, result: webout } = res
+
+        executionResult.log = log
+
+        if (printOutput) executionResult.printOutput = printOutput
+        if (webout) executionResult.webout = webout
+      })
+      .catch((err) => {
+        throw prefixMessage(
+          err,
+          'Error while sending POST request to execute code. '
+        )
       })
 
-    return parsedSasjsServerLog
+    return executionResult
   }
 
   /**
@@ -120,9 +175,3 @@ export class SASjsApiClient {
     return refreshTokensForSasjs(this.requestClient, refreshToken)
   }
 }
-
-// todo move to sasjs/utils
-export interface SASjsAuthResponse {
-  access_token: string
-  refresh_token: string
-}

src/SessionManager.ts

@@ -1,4 +1,4 @@
-import { Session, Context, SessionVariable } from './types'
+import { Session, Context, SessionVariable, SessionState } from './types'
 import { NoSessionStateError } from './types/errors'
 import { asyncForEach, isUrl } from './utils'
 import { prefixMessage } from '@sasjs/utils/error'
@@ -6,8 +6,13 @@ import { RequestClient } from './request/RequestClient'
 
 const MAX_SESSION_COUNT = 1
 
+interface ApiErrorResponse {
+  response: { status: number | string; data: { message: string } }
+}
+
 export class SessionManager {
   private loggedErrors: NoSessionStateError[] = []
+  private sessionStateLinkError = 'Error while getting session state link. '
 
   constructor(
     private serverUrl: string,
@@ -17,12 +22,14 @@ export class SessionManager {
     if (serverUrl) isUrl(serverUrl)
   }
 
+  // INFO: session pool
   private sessions: Session[] = []
   private currentContext: Context | null = null
+  private settingContext: boolean = false
   private _debug: boolean = false
   private printedSessionState = {
     printed: false,
-    state: ''
+    state: SessionState.NoState
   }
 
   public get debug() {
@@ -33,73 +40,244 @@ export class SessionManager {
     this._debug = value
   }
 
-  async getSession(accessToken?: string) {
+  /**
-    await this.createSessions(accessToken)
+   * Checks if session is valid. Session is considered valid if time since it's creation is less than 'sessionInactiveTimeout' attribute.
-    await this.createAndWaitForSession(accessToken)
+   * @param session - session object.
-    const session = this.sessions.pop()
+   * @returns - boolean indicating if session is valid.
+   */
+  private isSessionValid(session: Session): boolean {
+    if (!session) return false
+
     const secondsSinceSessionCreation =
-      (new Date().getTime() - new Date(session!.creationTimeStamp).getTime()) /
+      (new Date().getTime() - new Date(session.creationTimeStamp).getTime()) /
       1000
 
     if (
       !session!.attributes ||
       secondsSinceSessionCreation >= session!.attributes.sessionInactiveTimeout
     ) {
-      await this.createSessions(accessToken)
+      return false
-      const freshSession = this.sessions.pop()
+    } else {
-
+      return true
-      return freshSession
     }
-
-    return session
   }
 
-  async clearSession(id: string, accessToken?: string) {
+  /**
+   * Removes session from pool of hot sessions.
+   * @param session - session object.
+   * @returns - void.
+   */
+  private removeSessionFromPool(session: Session): void {
+    this.sessions = this.sessions.filter((ses) => ses.id !== session.id)
+  }
+
+  /**
+   * Filters session pool to keep only valid sessions.
+   * @param session - session object.
+   * @returns - void.
+   */
+  private removeExpiredSessions(): void {
+    this.sessions = this.sessions.filter((session) =>
+      this.isSessionValid(session)
+    )
+  }
+
+  /**
+   * Throws set of errors as a single error.
+   * @param errors - array of errors or string.
+   * @param prefix - an optional final error prefix.
+   * @returns - never.
+   */
+  private throwErrors(errors: (Error | string)[], prefix?: string): never {
+    throw prefix
+      ? prefixMessage(new Error(errors.join('. ')), prefix)
+      : new Error(
+          errors
+            .map((err) =>
+              (err as Error).message ? (err as Error).message : err
+            )
+            .join('. ')
+        )
+  }
+
+  /**
+   * Returns session.
+   * If there is a hot session available, it will be returned immediately and an asynchronous request to create new hot session will be submitted.
+   * If there is no available session, 2 session creation requests will be submitted. The session is returned once it is created and ready.
+   * @param accessToken - an optional access token.
+   * @returns - a promise which resolves with a session.
+   */
+  async getSession(accessToken?: string) {
+    const errors: (Error | string)[] = []
+    let isErrorThrown = false
+
+    const throwIfError = () => {
+      if (errors.length && !isErrorThrown) {
+        isErrorThrown = true
+
+        this.throwErrors(errors)
+      }
+    }
+
+    this.removeExpiredSessions()
+
+    if (this.sessions.length) {
+      const session = this.sessions[0]
+
+      this.removeSessionFromPool(session)
+
+      this.createSessions(accessToken).catch((err) => {
+        errors.push(err)
+      })
+
+      this.createAndWaitForSession(accessToken).catch((err) => {
+        errors.push(err)
+      })
+
+      throwIfError()
+
+      return session
+    } else {
+      this.createSessions(accessToken).catch((err) => {
+        errors.push(err)
+      })
+
+      await this.createAndWaitForSession(accessToken).catch((err) => {
+        errors.push(err)
+      })
+
+      this.removeExpiredSessions()
+
+      const session = this.sessions.pop()!
+
+      this.removeSessionFromPool(session)
+
+      throwIfError()
+
+      return session
+    }
+  }
+
+  /**
+   * Returns error message based on the response from SAS API.
+   * @param err - an optional access token.
+   * @param accessToken - an optional access token.
+   * @returns - an error message.
+   */
+  private getErrorMessage(
+    err: ApiErrorResponse,
+    url: string,
+    method: 'GET' | 'POST' | 'DELETE'
+  ) {
+    return (
+      `${method} request to ${url} failed with status code ${
+        err.response.status || 'unknown'
+      }. ` + err.response.data.message || ''
+    )
+  }
+
+  /**
+   * Deletes session.
+   * @param id - a session id.
+   * @param accessToken - an optional access token.
+   * @returns - a promise which resolves when session is deleted.
+   */
+  async clearSession(id: string, accessToken?: string): Promise<void> {
+    const url = `/compute/sessions/${id}`
+
     return await this.requestClient
-      .delete<Session>(`/compute/sessions/${id}`, accessToken)
+      .delete<Session>(url, accessToken)
       .then(() => {
         this.sessions = this.sessions.filter((s) => s.id !== id)
       })
-      .catch((err) => {
+      .catch((err: ApiErrorResponse) => {
-        throw prefixMessage(err, 'Error while deleting session. ')
+        throw prefixMessage(
+          this.getErrorMessage(err, url, 'DELETE'),
+          'Error while deleting session. '
+        )
       })
   }
 
-  private async createSessions(accessToken?: string) {
+  /**
+   * Creates sessions in amount equal to MAX_SESSION_COUNT.
+   * @param accessToken - an optional access token.
+   * @returns - a promise which resolves when required amount of sessions is created.
+   */
+  private async createSessions(accessToken?: string): Promise<void> {
+    const errors: (Error | string)[] = []
+
     if (!this.sessions.length) {
-      if (!this.currentContext) {
-        await this.setCurrentContext(accessToken).catch((err) => {
-          throw err
-        })
-      }
-
       await asyncForEach(new Array(MAX_SESSION_COUNT), async () => {
-        const createdSession = await this.createAndWaitForSession(
+        await this.createAndWaitForSession(accessToken).catch((err) => {
-          accessToken
+          errors.push(err)
-        ).catch((err) => {
-          throw err
         })
-
-        this.sessions.push(createdSession)
-      }).catch((err) => {
-        throw err
       })
     }
+
+    if (errors.length) {
+      this.throwErrors(errors, 'Error while creating session. ')
+    }
   }
 
-  private async createAndWaitForSession(accessToken?: string) {
+  /**
+   * Waits for the current context to be set.
+   * @returns - a promise which resolves when current context is set.
+   */
+  private async waitForCurrentContext(): Promise<void> {
+    return new Promise((resolve) => {
+      const timer = setInterval(() => {
+        if (this.currentContext) {
+          this.settingContext = false
+
+          clearInterval(timer)
+
+          resolve()
+        }
+      }, 100)
+    })
+  }
+
+  /**
+   * Creates and waits for session to be ready.
+   * @param accessToken - an optional access token.
+   * @returns - a promise which resolves with a session.
+   */
+  private async createAndWaitForSession(
+    accessToken?: string
+  ): Promise<Session> {
+    if (!this.currentContext) {
+      if (!this.settingContext) {
+        await this.setCurrentContext(accessToken)
+      } else {
+        await this.waitForCurrentContext()
+      }
+    }
+
+    const url = `${this.serverUrl}/compute/contexts/${
+      this.currentContext!.id
+    }/sessions`
+
     const { result: createdSession, etag } = await this.requestClient
-      .post<Session>(
+      .post<Session>(url, {}, accessToken)
-        `${this.serverUrl}/compute/contexts/${
+      .catch((err: ApiErrorResponse) => {
-          this.currentContext!.id
+        throw prefixMessage(
-        }/sessions`,
+          this.getErrorMessage(err, url, 'POST'),
-        {},
+          `Error while creating session. `
-        accessToken
+        )
-      )
-      .catch((err) => {
-        throw err
       })
 
+    // Add response etag to Session object.
+    createdSession.etag = etag
+
+    // Get session state link.
+    const stateLink = createdSession.links.find((link) => link.rel === 'state')
+
+    // Throw error if session state link is not present.
+    if (!stateLink) throw this.sessionStateLinkError
+
+    // Add session state link to Session object.
+    createdSession.stateUrl = stateLink.href
+
     await this.waitForSession(createdSession, etag, accessToken)
 
     this.sessions.push(createdSession)
@@ -107,14 +285,26 @@ export class SessionManager {
     return createdSession
   }
 
-  private async setCurrentContext(accessToken?: string) {
+  /**
+   * Sets current context.
+   * @param accessToken - an optional access token.
+   * @returns - a promise which resolves when current context is set.
+   */
+  private async setCurrentContext(accessToken?: string): Promise<void> {
     if (!this.currentContext) {
+      const url = `${this.serverUrl}/compute/contexts?limit=10000`
+
+      this.settingContext = true
+
       const { result: contexts } = await this.requestClient
         .get<{
           items: Context[]
-        }>(`${this.serverUrl}/compute/contexts?limit=10000`, accessToken)
+        }>(url, accessToken)
-        .catch((err) => {
+        .catch((err: ApiErrorResponse) => {
-          throw err
+          throw prefixMessage(
+            this.getErrorMessage(err, url, 'GET'),
+            `Error while getting list of contexts. `
+          )
         })
 
       const contextsList =
@@ -138,51 +328,42 @@ export class SessionManager {
     }
   }
 
-  private getHeaders(accessToken?: string) {
+  /**
-    const headers: any = {
+   * Waits for session to be ready.
-      'Content-Type': 'application/json'
+   * @param session - a session object.
-    }
+   * @param etag - an etag that can be a string or null.
-
+   * @param accessToken - an optional access token.
-    if (accessToken) {
+   * @returns - a promise which resolves with a session state.
-      headers.Authorization = `Bearer ${accessToken}`
+   */
-    }
-
-    return headers
-  }
-
   private async waitForSession(
     session: Session,
     etag: string | null,
     accessToken?: string
   ): Promise<string> {
+    let { state: sessionState } = session
+    const { stateUrl } = session
     const logger = process.logger || console
 
-    let sessionState = session.state
-
-    const stateLink = session.links.find((l: any) => l.rel === 'state')
-
     if (
-      sessionState === 'pending' ||
+      sessionState === SessionState.Pending ||
-      sessionState === 'running' ||
+      sessionState === SessionState.Running ||
-      sessionState === ''
+      sessionState === SessionState.NoState
     ) {
-      if (stateLink) {
+      if (stateUrl) {
         if (this.debug && !this.printedSessionState.printed) {
-          logger.info(`Polling: ${this.serverUrl + stateLink.href}`)
+          logger.info(`Polling: ${this.serverUrl + stateUrl}`)
 
           this.printedSessionState.printed = true
         }
 
+        const url = `${this.serverUrl}${stateUrl}?wait=30`
+
         const { result: state, responseStatus: responseStatus } =
-          await this.getSessionState(
+          await this.getSessionState(url, etag!, accessToken).catch((err) => {
-            `${this.serverUrl}${stateLink.href}?wait=30`,
+            throw prefixMessage(err, 'Error while waiting for session. ')
-            etag!,
-            accessToken
-          ).catch((err) => {
-            throw prefixMessage(err, 'Error while getting session state.')
           })
 
-        sessionState = state.trim()
+        sessionState = state.trim() as SessionState
 
         if (this.debug && this.printedSessionState.state !== sessionState) {
           logger.info(`Current session state is '${sessionState}'`)
@@ -194,7 +375,7 @@ export class SessionManager {
         if (!sessionState) {
           const stateError = new NoSessionStateError(
             responseStatus,
-            this.serverUrl + stateLink.href,
+            this.serverUrl + stateUrl,
             session.links.find((l: any) => l.rel === 'log')?.href as string
           )
 
@@ -216,7 +397,7 @@ export class SessionManager {
 
         return sessionState
       } else {
-        throw 'Error while getting session state link.'
+        throw this.sessionStateLinkError
       }
     } else {
       this.loggedErrors = []
@@ -225,32 +406,59 @@ export class SessionManager {
     }
   }
 
+  /**
+   * Gets session state.
+   * @param url - a URL to get session state.
+   * @param etag - an etag string.
+   * @param accessToken - an optional access token.
+   * @returns - a promise which resolves with a result string and response status.
+   */
   private async getSessionState(
     url: string,
     etag: string,
     accessToken?: string
-  ) {
+  ): Promise<{
+    result: string
+    responseStatus: number
+  }> {
     return await this.requestClient
       .get(url, accessToken, 'text/plain', { 'If-None-Match': etag })
       .then((res) => ({
-        result: res.result as string,
+        result: res.result as SessionState,
         responseStatus: res.status
       }))
       .catch((err) => {
-        throw err
+        throw prefixMessage(
+          this.getErrorMessage(err, url, 'GET'),
+          'Error while getting session state. '
+        )
       })
   }
 
-  async getVariable(sessionId: string, variable: string, accessToken?: string) {
+  /**
+   * Gets variable.
+   * @param sessionId - a session id.
+   * @param variable - a variable string.
+   * @param accessToken - an optional access token.
+   * @returns - a promise which resolves with a result that confirms to SessionVariable interface, etag string and status code.
+   */
+  async getVariable(
+    sessionId: string,
+    variable: string,
+    accessToken?: string
+  ): Promise<{
+    result: SessionVariable
+    etag: string
+    status: number
+  }> {
+    const url = `${this.serverUrl}/compute/sessions/${sessionId}/variables/${variable}`
+
     return await this.requestClient
-      .get<SessionVariable>(
+      .get<SessionVariable>(url, accessToken)
-        `${this.serverUrl}/compute/sessions/${sessionId}/variables/${variable}`,
-        accessToken
-      )
       .catch((err) => {
         throw prefixMessage(
-          err,
+          this.getErrorMessage(err, url, 'GET'),
-          `Error while fetching session variable '${variable}'.`
+          `Error while fetching session variable '${variable}'. `
         )
       })
   }

src/api/viya/executeOnComputeApi.ts

@@ -12,11 +12,15 @@ import { RequestClient } from '../../request/RequestClient'
 import { SessionManager } from '../../SessionManager'
 import { isRelativePath, fetchLogByChunks } from '../../utils'
 import { formatDataForRequest } from '../../utils/formatDataForRequest'
-import { pollJobState } from './pollJobState'
+import { pollJobState, JobState } from './pollJobState'
 import { uploadTables } from './uploadTables'
 
+interface JobRequestBody {
+  [key: string]: number | string | string[]
+}
+
 /**
- * Executes code on the current SAS Viya server.
+ * Executes SAS program on the current SAS Viya server using Compute API.
  * @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.
@@ -25,11 +29,11 @@ import { uploadTables } from './uploadTables'
  * @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).
  * @param waitForResult - when set to true, function will return the session
- * @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 }.
+ * @param pollOptions - an object that represents poll interval(milliseconds) and maximum amount of attempts. Object example: { maxPollCount: 24 * 60 * 60, pollInterval: 1000 }. More information available at src/api/viya/pollJobState.ts.
  * @param printPid - a boolean that indicates whether the function should print (PID) of the started job.
  * @param variables - an object that represents macro variables.
  */
-export async function executeScript(
+export async function executeOnComputeApi(
   requestClient: RequestClient,
   sessionManager: SessionManager,
   rootFolderName: string,
@@ -46,6 +50,7 @@ export async function executeScript(
   variables?: MacroVar
 ): Promise<any> {
   let access_token = (authConfig || {}).access_token
+
   if (authConfig) {
     ;({ access_token } = await getTokens(requestClient, authConfig))
   }
@@ -78,27 +83,13 @@ export async function executeScript(
         const logger = process.logger || console
 
         logger.info(
-          `Triggered '${relativeJobPath}' with PID ${
+          `Triggering '${relativeJobPath}' with PID ${
             jobIdVariable.value
           } at ${timestampToYYYYMMDDHHMMSS()}`
         )
       }
     }
 
-    const jobArguments: { [key: string]: any } = {
-      _contextName: contextName,
-      _OMITJSONLISTING: true,
-      _OMITJSONLOG: true,
-      _OMITSESSIONRESULTS: true,
-      _OMITTEXTLISTING: true,
-      _OMITTEXTLOG: true
-    }
-
-    if (debug) {
-      jobArguments['_OMITTEXTLOG'] = false
-      jobArguments['_OMITSESSIONRESULTS'] = false
-    }
-
     let fileName
 
     if (isRelativePath(jobPath)) {
@@ -107,6 +98,7 @@ export async function executeScript(
       }`
     } else {
       const jobPathParts = jobPath.split('/')
+
       fileName = jobPathParts.pop()
     }
 
@@ -118,7 +110,6 @@ export async function executeScript(
     }
 
     if (variables) jobVariables = { ...jobVariables, ...variables }
-
     if (debug) jobVariables = { ...jobVariables, _DEBUG: 131 }
 
     let files: any[] = []
@@ -145,12 +136,12 @@ export async function executeScript(
     }
 
     // Execute job in session
-    const jobRequestBody = {
+    const jobRequestBody: JobRequestBody = {
-      name: fileName,
+      name: fileName || 'Default Job Name',
       description: 'Powered by SASjs',
       code: linesOfCode,
       variables: jobVariables,
-      arguments: jobArguments
+      version: 2
     }
 
     const { result: postedJob, etag } = await requestClient
@@ -179,16 +170,21 @@ export async function executeScript(
       postedJob,
       debug,
       authConfig,
-      pollOptions
+      pollOptions,
+      {
+        session,
+        sessionManager
+      }
     ).catch(async (err) => {
       const error = err?.response?.data
       const result = /err=[0-9]*,/.exec(error)
-
       const errorCode = '5113'
+
       if (result?.[0]?.slice(4, -1) === errorCode) {
+        const logCount = 1000000
         const sessionLogUrl =
           postedJob.links.find((l: any) => l.rel === 'up')!.href + '/log'
-        const logCount = 1000000
+
         err.log = await fetchLogByChunks(
           requestClient,
           access_token!,
@@ -196,6 +192,7 @@ export async function executeScript(
           logCount
         )
       }
+
       throw prefixMessage(err, 'Error while polling job status. ')
     })
 
@@ -214,12 +211,12 @@ export async function executeScript(
 
     let jobResult
     let log = ''
-
     const logLink = currentJob.links.find((l) => l.rel === 'log')
 
     if (debug && logLink) {
       const logUrl = `${logLink.href}/content`
       const logCount = currentJob.logStatistics?.lineCount ?? 1000000
+
       log = await fetchLogByChunks(
         requestClient,
         access_token!,
@@ -228,13 +225,11 @@ export async function executeScript(
       )
     }
 
-    if (jobStatus === 'failed' || jobStatus === 'error') {
+    if (jobStatus === JobState.Failed || jobStatus === JobState.Error) {
       throw new ComputeJobExecutionError(currentJob, log)
     }
 
-    if (!expectWebout) {
+    if (!expectWebout) return { job: currentJob, log }
-      return { job: currentJob, log }
-    }
 
     const resultLink = `/compute/sessions/${executionSessionId}/filerefs/_webout/content`
 
@@ -245,6 +240,7 @@ export async function executeScript(
           if (logLink) {
             const logUrl = `${logLink.href}/content`
             const logCount = currentJob.logStatistics?.lineCount ?? 1000000
+
             log = await fetchLogByChunks(
               requestClient,
               access_token!,
@@ -279,7 +275,7 @@ export async function executeScript(
     const error = e as HttpError
 
     if (error.status === 404) {
-      return executeScript(
+      return executeOnComputeApi(
         requestClient,
         sessionManager,
         rootFolderName,

src/api/viya/pollJobState.ts

@@ -1,29 +1,90 @@
 import { AuthConfig } from '@sasjs/utils/types'
-import { Job, PollOptions } from '../..'
+import { Job, PollOptions, PollStrategy } from '../..'
 import { getTokens } from '../../auth/getTokens'
 import { RequestClient } from '../../request/RequestClient'
 import { JobStatePollError } from '../../types/errors'
-import { Link, WriteStream } from '../../types'
+import { Link, WriteStream, SessionState, JobSessionManager } from '../../types'
 import { delay, isNode } from '../../utils'
 
+export enum JobState {
+  Completed = 'completed',
+  Running = 'running',
+  Pending = 'pending',
+  Unavailable = 'unavailable',
+  NoState = '',
+  Failed = 'failed',
+  Error = 'error'
+}
+
+/**
+ * Polls job status using default or provided poll options.
+ * @param requestClient - the pre-configured HTTP request client.
+ * @param postedJob - the relative or absolute path to the job.
+ * @param debug - sets the _debug flag in the job arguments.
+ * @param authConfig - an access token, refresh token, client and secret for an authorized user.
+ * @param pollOptions - an object containing maxPollCount, pollInterval, streamLog and logFolderPath. It will override the first default poll options in poll strategy if provided.
+ * Example pollOptions:
+ * {
+ *    maxPollCount: 200,
+ *    pollInterval: 300,
+ *    streamLog: true, // optional, equals to false by default.
+ *    pollStrategy?: // optional array of poll options that should be applied after 'maxPollCount' of the provided poll options is reached. If not provided the default (see example below) poll strategy will be used.
+ * }
+ * Example pollStrategy (values used from default poll strategy):
+ * [
+ *    { maxPollCount: 200, pollInterval: 300 }, // approximately ~2 mins (including time to get response (~300ms))
+ *    { maxPollCount: 300, pollInterval: 3000 }, // approximately ~5.5 mins (including time to get response (~300ms))
+ *    { maxPollCount: 500, pollInterval: 30000 }, // approximately ~50.5 mins (including time to get response (~300ms))
+ *    { maxPollCount: 3400, pollInterval: 60000 } // approximately ~3015 mins (~125 hours) (including time to get response (~300ms))
+ * ]
+ * @param jobSessionManager - job session object containing session object and an instance of Session Manager. Job session object is used to periodically (every 10th job state poll) check parent session state.
+ * @returns - a promise which resolves with a job state
+ */
 export async function pollJobState(
   requestClient: RequestClient,
   postedJob: Job,
   debug: boolean,
   authConfig?: AuthConfig,
-  pollOptions?: PollOptions
+  pollOptions?: PollOptions,
-) {
+  jobSessionManager?: JobSessionManager
+): Promise<JobState> {
   const logger = process.logger || console
 
-  let pollInterval = 300
+  const streamLog = pollOptions?.streamLog || false
-  let maxPollCount = 1000
 
-  const defaultPollOptions: PollOptions = {
+  const defaultPollStrategy: PollStrategy = [
-    maxPollCount,
+    { maxPollCount: 200, pollInterval: 300 },
-    pollInterval,
+    { maxPollCount: 300, pollInterval: 3000 },
-    streamLog: false
+    { maxPollCount: 500, pollInterval: 30000 },
+    { maxPollCount: 3400, pollInterval: 60000 }
+  ]
+
+  let pollStrategy: PollStrategy
+
+  if (pollOptions !== undefined) {
+    pollStrategy = [pollOptions]
+
+    let { pollStrategy: providedPollStrategy } = pollOptions
+
+    if (providedPollStrategy !== undefined) {
+      validatePollStrategies(providedPollStrategy)
+
+      // INFO: sort by 'maxPollCount'
+      providedPollStrategy = providedPollStrategy.sort(
+        (strategyA: PollOptions, strategyB: PollOptions) =>
+          strategyA.maxPollCount - strategyB.maxPollCount
+      )
+
+      pollStrategy = [...pollStrategy, ...providedPollStrategy]
+    } else {
+      pollStrategy = [...pollStrategy, ...defaultPollStrategy]
+    }
+  } else {
+    pollStrategy = defaultPollStrategy
   }
 
+  let defaultPollOptions: PollOptions = pollStrategy.splice(0, 1)[0]
+
   pollOptions = { ...defaultPollOptions, ...(pollOptions || {}) }
 
   const stateLink = postedJob.links.find((l: any) => l.rel === 'state')
@@ -31,10 +92,10 @@ export async function pollJobState(
     throw new Error(`Job state link was not found.`)
   }
 
-  let currentState = await getJobState(
+  let currentState: JobState = await getJobState(
     requestClient,
     postedJob,
-    '',
+    JobState.NoState,
     debug,
     authConfig
   ).catch((err) => {
@@ -42,73 +103,73 @@ export async function pollJobState(
       `Error fetching job state from ${stateLink.href}. Starting poll, assuming job to be running.`,
       err
     )
-    return 'unavailable'
+
+    return JobState.Unavailable
   })
 
   let pollCount = 0
 
-  if (currentState === 'completed') {
+  if (currentState === JobState.Completed) {
     return Promise.resolve(currentState)
   }
 
   let logFileStream
-  if (pollOptions.streamLog && isNode()) {
+  if (streamLog && isNode()) {
     const { getFileStream } = require('./getFileStream')
+
     logFileStream = await getFileStream(postedJob, pollOptions.logFolderPath)
   }
 
-  // Poll up to the first 100 times with the specified poll interval
   let result = await doPoll(
     requestClient,
     postedJob,
     currentState,
     debug,
     pollCount,
+    pollOptions,
     authConfig,
-    {
+    streamLog,
-      ...pollOptions,
+    logFileStream,
-      maxPollCount:
+    jobSessionManager
-        pollOptions.maxPollCount <= 100 ? pollOptions.maxPollCount : 100
-    },
-    logFileStream
   )
 
   currentState = result.state
   pollCount = result.pollCount
 
-  if (!needsRetry(currentState) || pollCount >= pollOptions.maxPollCount) {
+  if (
+    !needsRetry(currentState) ||
+    (pollCount >= pollOptions.maxPollCount && !pollStrategy.length)
+  ) {
     return currentState
   }
 
-  // If we get to this point, this is a long-running job that needs longer polling.
+  // INFO: If we get to this point, this is a long-running job that needs longer polling.
-  // We will resume polling with a bigger interval of 1 minute
+  // We will resume polling with a bigger interval according to the next polling strategy
-  let longJobPollOptions: PollOptions = {
+  while (pollStrategy.length && needsRetry(currentState)) {
-    maxPollCount: 24 * 60,
+    defaultPollOptions = pollStrategy.splice(0, 1)[0]
-    pollInterval: 60000,
+
-    streamLog: false
+    if (pollOptions) {
-  }
+      defaultPollOptions.logFolderPath = pollOptions.logFolderPath
-  if (pollOptions) {
+    }
-    longJobPollOptions.streamLog = pollOptions.streamLog
+
-    longJobPollOptions.logFolderPath = pollOptions.logFolderPath
+    result = await doPoll(
+      requestClient,
+      postedJob,
+      currentState,
+      debug,
+      pollCount,
+      defaultPollOptions,
+      authConfig,
+      streamLog,
+      logFileStream,
+      jobSessionManager
+    )
+
+    currentState = result.state
+    pollCount = result.pollCount
   }
 
-  result = await doPoll(
+  if (logFileStream) logFileStream.end()
-    requestClient,
-    postedJob,
-    currentState,
-    debug,
-    pollCount,
-    authConfig,
-    longJobPollOptions,
-    logFileStream
-  )
-
-  currentState = result.state
-  pollCount = result.pollCount
-
-  if (logFileStream) {
-    logFileStream.end()
-  }
 
   return currentState
 }
@@ -119,17 +180,13 @@ const getJobState = async (
   currentState: string,
   debug: boolean,
   authConfig?: AuthConfig
-) => {
+): Promise<JobState> => {
-  const stateLink = job.links.find((l: any) => l.rel === 'state')
+  const stateLink = job.links.find((l: any) => l.rel === 'state')!
-  if (!stateLink) {
-    throw new Error(`Job state link was not found.`)
-  }
 
   if (needsRetry(currentState)) {
     let tokens
-    if (authConfig) {
+
-      tokens = await getTokens(requestClient, authConfig)
+    if (authConfig) tokens = await getTokens(requestClient, authConfig)
-    }
 
     const { result: jobState } = await requestClient
       .get<string>(
@@ -143,49 +200,88 @@ const getJobState = async (
         throw new JobStatePollError(job.id, err)
       })
 
-    return jobState.trim()
+    return jobState.trim() as JobState
   } else {
-    return currentState
+    return currentState as JobState
   }
 }
 
 const needsRetry = (state: string) =>
-  state === 'running' ||
+  state === JobState.Running ||
-  state === '' ||
+  state === JobState.NoState ||
-  state === 'pending' ||
+  state === JobState.Pending ||
-  state === 'unavailable'
+  state === JobState.Unavailable
 
-const doPoll = async (
+/**
+ * Polls job state.
+ * @param requestClient - the pre-configured HTTP request client.
+ * @param postedJob - the relative or absolute path to the job.
+ * @param currentState - current job state.
+ * @param debug - sets the _debug flag in the job arguments.
+ * @param pollCount - current poll count.
+ * @param pollOptions - an object containing maxPollCount, pollInterval, streamLog and logFolderPath.
+ * @param authConfig - an access token, refresh token, client and secret for an authorized user.
+ * @param streamLog - indicates if job log should be streamed.
+ * @param logStream - job log stream.
+ * @param jobSessionManager - job session object containing session object and an instance of Session Manager. Job session object is used to periodically (every 10th job state poll) check parent session state. Session state is considered healthy if it is equal to 'running' or 'idle'.
+ * @returns - a promise which resolves with a job state
+ */
+export const doPoll = async (
   requestClient: RequestClient,
   postedJob: Job,
-  currentState: string,
+  currentState: JobState,
   debug: boolean,
   pollCount: number,
+  pollOptions: PollOptions,
   authConfig?: AuthConfig,
-  pollOptions?: PollOptions,
+  streamLog?: boolean,
-  logStream?: WriteStream
+  logStream?: WriteStream,
-): Promise<{ state: string; pollCount: number }> => {
+  jobSessionManager?: JobSessionManager
-  let pollInterval = 300
+): Promise<{ state: JobState; pollCount: number }> => {
-  let maxPollCount = 1000
+  const { maxPollCount, pollInterval } = pollOptions
+  const logger = process.logger || console
+  const stateLink = postedJob.links.find((l: Link) => l.rel === 'state')!
   let maxErrorCount = 5
   let errorCount = 0
   let state = currentState
-  let printedState = ''
+  let printedState = JobState.NoState
   let startLogLine = 0
 
-  const logger = process.logger || console
-
-  if (pollOptions) {
-    pollInterval = pollOptions.pollInterval || pollInterval
-    maxPollCount = pollOptions.maxPollCount || maxPollCount
-  }
-
-  const stateLink = postedJob.links.find((l: Link) => l.rel === 'state')
-  if (!stateLink) {
-    throw new Error(`Job state link was not found.`)
-  }
-
   while (needsRetry(state) && pollCount <= maxPollCount) {
+    // Check parent session state on every 10th job state poll.
+    if (jobSessionManager && pollCount && pollCount % 10 === 0 && authConfig) {
+      const { session, sessionManager } = jobSessionManager
+      const { stateUrl, etag, id: sessionId } = session
+      const { access_token } = authConfig
+      const { id: jobId } = postedJob
+
+      // Get session state.
+      const { result: sessionState, responseStatus } = await sessionManager[
+        'getSessionState'
+      ](stateUrl, etag, access_token).catch((err) => {
+        // Handle error while getting session state.
+        throw new JobStatePollError(jobId, err)
+      })
+
+      // Checks if session state is equal to 'running' or 'idle'.
+      const isSessionStatesHealthy = (state: string) =>
+        [SessionState.Running, SessionState.Idle].includes(
+          state as SessionState
+        )
+
+      // Clear parent session and throw an error if session state is not
+      // 'running', 'idle' or response status is not 200.
+      if (!isSessionStatesHealthy(sessionState) || responseStatus !== 200) {
+        sessionManager.clearSession(sessionId, access_token)
+
+        const sessionError = isSessionStatesHealthy(sessionState)
+          ? `Session response status is not 200. Session response status is ${responseStatus}.`
+          : `Session state of the job is not 'running' or 'idle'. Session state is '${sessionState}'`
+
+        throw new JobStatePollError(jobId, new Error(sessionError))
+      }
+    }
+
     state = await getJobState(
       requestClient,
       postedJob,
@@ -194,21 +290,24 @@ const doPoll = async (
       authConfig
     ).catch((err) => {
       errorCount++
+
       if (pollCount >= maxPollCount || errorCount >= maxErrorCount) {
         throw err
       }
+
       logger.error(
         `Error fetching job state from ${stateLink.href}. Resuming poll, assuming job to be running.`,
         err
       )
-      return 'unavailable'
+
+      return JobState.Unavailable
     })
 
     pollCount++
 
     const jobHref = postedJob.links.find((l: Link) => l.rel === 'self')!.href
 
-    if (pollOptions?.streamLog) {
+    if (streamLog) {
       const { result: job } = await requestClient.get<Job>(
         jobHref,
         authConfig?.access_token
@@ -238,12 +337,45 @@ const doPoll = async (
       printedState = state
     }
 
-    if (state != 'unavailable' && errorCount > 0) {
+    if (state !== JobState.Unavailable && errorCount > 0) {
       errorCount = 0
     }
 
-    await delay(pollInterval)
+    if (state !== JobState.Completed) {
+      await delay(pollInterval)
+    }
   }
 
   return { state, pollCount }
 }
+
+const validatePollStrategies = (strategy: PollStrategy) => {
+  const throwError = (message?: string, pollOptions?: PollOptions) => {
+    throw new Error(
+      `Poll strategies are not valid.${message ? ` ${message}` : ''}${
+        pollOptions
+          ? ` Invalid poll strategy: \n${JSON.stringify(pollOptions, null, 2)}`
+          : ''
+      }`
+    )
+  }
+
+  strategy.forEach((pollOptions: PollOptions, i: number) => {
+    const { maxPollCount, pollInterval } = pollOptions
+
+    if (maxPollCount < 1) {
+      throwError(`'maxPollCount' has to be greater than 0.`, pollOptions)
+    } else if (i !== 0) {
+      const previousPollOptions = strategy[i - 1]
+
+      if (maxPollCount <= previousPollOptions.maxPollCount) {
+        throwError(
+          `'maxPollCount' has to be greater than 'maxPollCount' in previous poll strategy.`,
+          pollOptions
+        )
+      }
+    } else if (pollInterval < 1) {
+      throwError(`'pollInterval' has to be greater than 0.`, pollOptions)
+    }
+  })
+}

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

@@ -1,22 +1,21 @@
 import { RequestClient } from '../../../request/RequestClient'
 import { SessionManager } from '../../../SessionManager'
-import { executeScript } from '../executeScript'
+import { executeOnComputeApi } from '../executeOnComputeApi'
 import { mockSession, mockAuthConfig, mockJob } from './mockResponses'
 import * as pollJobStateModule from '../pollJobState'
 import * as uploadTablesModule from '../uploadTables'
 import * as getTokensModule from '../../../auth/getTokens'
 import * as formatDataModule from '../../../utils/formatDataForRequest'
 import * as fetchLogsModule from '../../../utils/fetchLogByChunks'
-import { PollOptions } from '../../../types'
+import { PollOptions, JobSessionManager } 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)()
 const defaultPollOptions: PollOptions = {
   maxPollCount: 100,
-  pollInterval: 500,
+  pollInterval: 500
-  streamLog: false
 }
 
 describe('executeScript', () => {
@@ -26,7 +25,7 @@ describe('executeScript', () => {
   })
 
   it('should not try to get fresh tokens if an authConfig is not provided', async () => {
-    await executeScript(
+    await executeOnComputeApi(
       requestClient,
       sessionManager,
       'test',
@@ -39,7 +38,7 @@ describe('executeScript', () => {
   })
 
   it('should try to get fresh tokens if an authConfig is provided', async () => {
-    await executeScript(
+    await executeOnComputeApi(
       requestClient,
       sessionManager,
       'test',
@@ -56,7 +55,7 @@ describe('executeScript', () => {
   })
 
   it('should get a session from the session manager before executing', async () => {
-    await executeScript(
+    await executeOnComputeApi(
       requestClient,
       sessionManager,
       'test',
@@ -73,7 +72,7 @@ describe('executeScript', () => {
       .spyOn(sessionManager, 'getSession')
       .mockImplementation(() => Promise.reject('Test Error'))
 
-    const error = await executeScript(
+    const error = await executeOnComputeApi(
       requestClient,
       sessionManager,
       'test',
@@ -86,7 +85,7 @@ describe('executeScript', () => {
   })
 
   it('should fetch the PID when printPid is true', async () => {
-    await executeScript(
+    await executeOnComputeApi(
       requestClient,
       sessionManager,
       'test',
@@ -114,7 +113,7 @@ describe('executeScript', () => {
       .spyOn(sessionManager, 'getVariable')
       .mockImplementation(() => Promise.reject('Test Error'))
 
-    const error = await executeScript(
+    const error = await executeOnComputeApi(
       requestClient,
       sessionManager,
       'test',
@@ -140,7 +139,7 @@ describe('executeScript', () => {
         Promise.resolve([{ tableName: 'test', file: { id: 1 } }])
       )
 
-    await executeScript(
+    await executeOnComputeApi(
       requestClient,
       sessionManager,
       'test',
@@ -164,7 +163,7 @@ describe('executeScript', () => {
   })
 
   it('should format data as CSV when it does not contain semicolons', async () => {
-    await executeScript(
+    await executeOnComputeApi(
       requestClient,
       sessionManager,
       'test',
@@ -190,7 +189,7 @@ describe('executeScript', () => {
       .spyOn(formatDataModule, 'formatDataForRequest')
       .mockImplementation(() => ({ sasjs_tables: 'foo', sasjs0data: 'bar' }))
 
-    await executeScript(
+    await executeOnComputeApi(
       requestClient,
       sessionManager,
       'test',
@@ -218,14 +217,7 @@ describe('executeScript', () => {
           sasjs_tables: 'foo',
           sasjs0data: 'bar'
         },
-        arguments: {
+        version: 2
-          _contextName: 'test context',
-          _OMITJSONLISTING: true,
-          _OMITJSONLOG: true,
-          _OMITSESSIONRESULTS: true,
-          _OMITTEXTLISTING: true,
-          _OMITTEXTLOG: true
-        }
       },
       mockAuthConfig.access_token
     )
@@ -236,7 +228,7 @@ describe('executeScript', () => {
       .spyOn(formatDataModule, 'formatDataForRequest')
       .mockImplementation(() => ({ sasjs_tables: 'foo', sasjs0data: 'bar' }))
 
-    await executeScript(
+    await executeOnComputeApi(
       requestClient,
       sessionManager,
       'test',
@@ -265,14 +257,7 @@ describe('executeScript', () => {
           sasjs0data: 'bar',
           _DEBUG: 131
         },
-        arguments: {
+        version: 2
-          _contextName: 'test context',
-          _OMITJSONLISTING: true,
-          _OMITJSONLOG: true,
-          _OMITSESSIONRESULTS: false,
-          _OMITTEXTLISTING: true,
-          _OMITTEXTLOG: false
-        }
       },
       mockAuthConfig.access_token
     )
@@ -283,7 +268,7 @@ describe('executeScript', () => {
       .spyOn(requestClient, 'post')
       .mockImplementation(() => Promise.reject('Test Error'))
 
-    const error = await executeScript(
+    const error = await executeOnComputeApi(
       requestClient,
       sessionManager,
       'test',
@@ -303,7 +288,7 @@ describe('executeScript', () => {
   })
 
   it('should immediately return the session when waitForResult is false', async () => {
-    const result = await executeScript(
+    const result = await executeOnComputeApi(
       requestClient,
       sessionManager,
       'test',
@@ -323,7 +308,12 @@ describe('executeScript', () => {
   })
 
   it('should poll for job completion when waitForResult is true', async () => {
-    await executeScript(
+    const jobSessionManager: JobSessionManager = {
+      session: mockSession,
+      sessionManager: sessionManager
+    }
+
+    await executeOnComputeApi(
       requestClient,
       sessionManager,
       'test',
@@ -344,7 +334,8 @@ describe('executeScript', () => {
       mockJob,
       false,
       mockAuthConfig,
-      defaultPollOptions
+      defaultPollOptions,
+      jobSessionManager
     )
   })
 
@@ -353,7 +344,7 @@ describe('executeScript', () => {
       .spyOn(pollJobStateModule, 'pollJobState')
       .mockImplementation(() => Promise.reject('Poll Error'))
 
-    const error = await executeScript(
+    const error = await executeOnComputeApi(
       requestClient,
       sessionManager,
       'test',
@@ -379,7 +370,7 @@ describe('executeScript', () => {
         Promise.reject({ response: { data: 'err=5113,' } })
       )
 
-    const error = await executeScript(
+    const error = await executeOnComputeApi(
       requestClient,
       sessionManager,
       'test',
@@ -405,7 +396,7 @@ describe('executeScript', () => {
   })
 
   it('should fetch the logs for the job if debug is true and a log URL is available', async () => {
-    await executeScript(
+    await executeOnComputeApi(
       requestClient,
       sessionManager,
       'test',
@@ -430,7 +421,7 @@ describe('executeScript', () => {
   })
 
   it('should not fetch the logs for the job if debug is false', async () => {
-    await executeScript(
+    await executeOnComputeApi(
       requestClient,
       sessionManager,
       'test',
@@ -452,9 +443,11 @@ describe('executeScript', () => {
   it('should throw a ComputeJobExecutionError if the job has failed', async () => {
     jest
       .spyOn(pollJobStateModule, 'pollJobState')
-      .mockImplementation(() => Promise.resolve('failed'))
+      .mockImplementation(() =>
+        Promise.resolve(pollJobStateModule.JobState.Failed)
+      )
 
-    const error: ComputeJobExecutionError = await executeScript(
+    const error: ComputeJobExecutionError = await executeOnComputeApi(
       requestClient,
       sessionManager,
       'test',
@@ -485,9 +478,11 @@ describe('executeScript', () => {
   it('should throw a ComputeJobExecutionError if the job has errored out', async () => {
     jest
       .spyOn(pollJobStateModule, 'pollJobState')
-      .mockImplementation(() => Promise.resolve('error'))
+      .mockImplementation(() =>
+        Promise.resolve(pollJobStateModule.JobState.Error)
+      )
 
-    const error: ComputeJobExecutionError = await executeScript(
+    const error: ComputeJobExecutionError = await executeOnComputeApi(
       requestClient,
       sessionManager,
       'test',
@@ -516,7 +511,7 @@ describe('executeScript', () => {
   })
 
   it('should fetch the result if expectWebout is true', async () => {
-    await executeScript(
+    await executeOnComputeApi(
       requestClient,
       sessionManager,
       'test',
@@ -547,7 +542,7 @@ describe('executeScript', () => {
       return Promise.resolve({ result: mockJob, etag: '', status: 200 })
     })
 
-    const error = await executeScript(
+    const error = await executeOnComputeApi(
       requestClient,
       sessionManager,
       'test',
@@ -581,7 +576,7 @@ describe('executeScript', () => {
   })
 
   it('should clear the session after execution is complete', async () => {
-    await executeScript(
+    await executeOnComputeApi(
       requestClient,
       sessionManager,
       'test',
@@ -608,7 +603,7 @@ describe('executeScript', () => {
       .spyOn(sessionManager, 'clearSession')
       .mockImplementation(() => Promise.reject('Clear Session Error'))
 
-    const error = await executeScript(
+    const error = await executeOnComputeApi(
       requestClient,
       sessionManager,
       'test',
@@ -654,7 +649,9 @@ const setupMocks = () => {
     .mockImplementation(() => Promise.resolve(mockAuthConfig))
   jest
     .spyOn(pollJobStateModule, 'pollJobState')
-    .mockImplementation(() => Promise.resolve('completed'))
+    .mockImplementation(() =>
+      Promise.resolve(pollJobStateModule.JobState.Completed)
+    )
   jest
     .spyOn(sessionManager, 'getVariable')
     .mockImplementation(() =>

src/api/viya/spec/mockResponses.ts

@@ -1,14 +1,16 @@
 import { AuthConfig } from '@sasjs/utils/types'
-import { Job, Session } from '../../../types'
+import { Job, Session, SessionState } from '../../../types'
 
 export const mockSession: Session = {
   id: 's35510n',
-  state: 'idle',
+  state: SessionState.Idle,
+  stateUrl: '',
   links: [],
   attributes: {
     sessionInactiveTimeout: 1
   },
-  creationTimeStamp: new Date().valueOf().toString()
+  creationTimeStamp: new Date().valueOf().toString(),
+  etag: 'etag-string'
 }
 
 export const mockJob: Job = {

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

@@ -1,22 +1,31 @@
-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'
+import { pollJobState, doPoll, JobState } 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 * as delayModule from '../../../utils/delay'
+import {
+  PollOptions,
+  PollStrategy,
+  SessionState,
+  JobSessionManager
+} from '../../../types'
 import { WriteStream } from 'fs'
+import { SessionManager } from '../../../SessionManager'
+import { JobStatePollError } from '../../../types'
 
 const baseUrl = 'http://localhost'
 const requestClient = new (<jest.Mock<RequestClient>>RequestClient)()
+const sessionManager = new (<jest.Mock<SessionManager>>SessionManager)()
 requestClient['httpClient'].defaults.baseURL = baseUrl
 
-const defaultPollOptions: PollOptions = {
+const defaultStreamLog = false
+const defaultPollStrategy: PollOptions = {
   maxPollCount: 100,
-  pollInterval: 500,
+  pollInterval: 500
-  streamLog: false
 }
 
 describe('pollJobState', () => {
@@ -26,13 +35,10 @@ describe('pollJobState', () => {
   })
 
   it('should get valid tokens if the authConfig has been provided', async () => {
-    await pollJobState(
+    await pollJobState(requestClient, mockJob, false, mockAuthConfig, {
-      requestClient,
+      ...defaultPollStrategy,
-      mockJob,
+      streamLog: defaultStreamLog
-      false,
+    })
-      mockAuthConfig,
-      defaultPollOptions
-    )
 
     expect(getTokensModule.getTokens).toHaveBeenCalledWith(
       requestClient,
@@ -46,7 +52,7 @@ describe('pollJobState', () => {
       mockJob,
       false,
       undefined,
-      defaultPollOptions
+      defaultPollStrategy
     )
 
     expect(getTokensModule.getTokens).not.toHaveBeenCalled()
@@ -58,7 +64,7 @@ describe('pollJobState', () => {
       { ...mockJob, links: mockJob.links.filter((l) => l.rel !== 'state') },
       false,
       undefined,
-      defaultPollOptions
+      defaultPollStrategy
     ).catch((e: any) => e)
 
     expect((error as Error).message).toContain('Job state link was not found.')
@@ -72,7 +78,7 @@ describe('pollJobState', () => {
       mockJob,
       false,
       mockAuthConfig,
-      defaultPollOptions
+      defaultPollStrategy
     )
 
     expect(getTokensModule.getTokens).toHaveBeenCalledTimes(3)
@@ -83,7 +89,7 @@ describe('pollJobState', () => {
     const { saveLog } = require('../saveLog')
 
     await pollJobState(requestClient, mockJob, false, mockAuthConfig, {
-      ...defaultPollOptions,
+      ...defaultPollStrategy,
       streamLog: true
     })
 
@@ -96,7 +102,7 @@ describe('pollJobState', () => {
     const { saveLog } = require('../saveLog')
 
     await pollJobState(requestClient, mockJob, false, mockAuthConfig, {
-      ...defaultPollOptions,
+      ...defaultPollStrategy,
       streamLog: true
     })
 
@@ -111,7 +117,7 @@ describe('pollJobState', () => {
     const { getFileStream } = require('../getFileStream')
 
     await pollJobState(requestClient, mockJob, false, mockAuthConfig, {
-      ...defaultPollOptions,
+      ...defaultPollStrategy,
       streamLog: true
     })
 
@@ -127,7 +133,7 @@ describe('pollJobState', () => {
       mockJob,
       false,
       mockAuthConfig,
-      defaultPollOptions
+      defaultPollStrategy
     )
 
     expect(saveLogModule.saveLog).not.toHaveBeenCalled()
@@ -136,15 +142,18 @@ describe('pollJobState', () => {
   it('should return the current status when the max poll count is reached', async () => {
     mockRunningPoll()
 
+    const pollOptions: PollOptions = {
+      ...defaultPollStrategy,
+      maxPollCount: 1,
+      pollStrategy: []
+    }
+
     const state = await pollJobState(
       requestClient,
       mockJob,
       false,
       mockAuthConfig,
-      {
+      pollOptions
-        ...defaultPollOptions,
-        maxPollCount: 1
-      }
     )
 
     expect(state).toEqual('running')
@@ -159,7 +168,7 @@ describe('pollJobState', () => {
       false,
       mockAuthConfig,
       {
-        ...defaultPollOptions,
+        ...defaultPollStrategy,
         maxPollCount: 200,
         pollInterval: 10
       }
@@ -176,7 +185,7 @@ describe('pollJobState', () => {
       mockJob,
       false,
       undefined,
-      defaultPollOptions
+      defaultPollStrategy
     )
 
     expect(requestClient.get).toHaveBeenCalledTimes(2)
@@ -192,7 +201,7 @@ describe('pollJobState', () => {
       mockJob,
       true,
       undefined,
-      defaultPollOptions
+      defaultPollStrategy
     )
 
     expect((process as any).logger.info).toHaveBeenCalledTimes(4)
@@ -222,7 +231,7 @@ describe('pollJobState', () => {
       mockJob,
       false,
       undefined,
-      defaultPollOptions
+      defaultPollStrategy
     )
 
     expect(requestClient.get).toHaveBeenCalledTimes(2)
@@ -237,13 +246,401 @@ describe('pollJobState', () => {
       mockJob,
       false,
       undefined,
-      defaultPollOptions
+      defaultPollStrategy
     ).catch((e: any) => e)
 
     expect(error.message).toEqual(
       'Error while polling job state for job j0b: Status Error'
     )
   })
+
+  it('should change poll strategies', async () => {
+    mockSimplePoll(6)
+
+    const delays: number[] = []
+
+    jest.spyOn(delayModule, 'delay').mockImplementation((ms: number) => {
+      delays.push(ms)
+
+      return Promise.resolve()
+    })
+
+    const pollIntervals = [3, 4, 5, 6]
+
+    const pollStrategy = [
+      { maxPollCount: 2, pollInterval: pollIntervals[1] },
+      { maxPollCount: 3, pollInterval: pollIntervals[2] },
+      { maxPollCount: 4, pollInterval: pollIntervals[3] }
+    ]
+
+    const pollOptions: PollOptions = {
+      maxPollCount: 1,
+      pollInterval: pollIntervals[0],
+      pollStrategy: pollStrategy
+    }
+
+    await pollJobState(requestClient, mockJob, false, undefined, pollOptions)
+
+    expect(delays).toEqual([pollIntervals[0], ...pollIntervals])
+  })
+
+  it('should change default poll strategies after completing provided poll options', async () => {
+    const delays: number[] = []
+
+    jest.spyOn(delayModule, 'delay').mockImplementation((ms: number) => {
+      delays.push(ms)
+
+      return Promise.resolve()
+    })
+
+    const customPollOptions: PollOptions = {
+      maxPollCount: 0,
+      pollInterval: 0
+    }
+
+    const requests = [
+      { maxPollCount: 202, pollInterval: 300 },
+      { maxPollCount: 300, pollInterval: 3000 },
+      { maxPollCount: 500, pollInterval: 30000 },
+      { maxPollCount: 3400, pollInterval: 60000 }
+    ]
+
+    // ~200 requests with delay 300ms
+    let request = requests.splice(0, 1)[0]
+    let { maxPollCount, pollInterval } = request
+
+    // should be only one interval because maxPollCount is equal to 0
+    const pollIntervals = [customPollOptions.pollInterval]
+
+    pollIntervals.push(...Array(maxPollCount - 2).fill(pollInterval))
+
+    // ~300 requests with delay 3000
+    request = requests.splice(0, 1)[0]
+    let newAmount = request.maxPollCount
+    pollInterval = request.pollInterval
+
+    pollIntervals.push(...Array(newAmount - maxPollCount).fill(pollInterval))
+    pollIntervals.push(...Array(2).fill(pollInterval))
+
+    // ~500 requests with delay 30000
+    request = requests.splice(0, 1)[0]
+
+    let oldAmount = newAmount
+    newAmount = request.maxPollCount
+    pollInterval = request.pollInterval
+
+    pollIntervals.push(...Array(newAmount - oldAmount - 2).fill(pollInterval))
+    pollIntervals.push(...Array(2).fill(pollInterval))
+
+    // ~3400 requests with delay 60000
+    request = requests.splice(0, 1)[0]
+
+    oldAmount = newAmount
+    newAmount = request.maxPollCount
+    pollInterval = request.pollInterval
+
+    mockSimplePoll(newAmount)
+
+    pollIntervals.push(...Array(newAmount - oldAmount - 2).fill(pollInterval))
+
+    await pollJobState(
+      requestClient,
+      mockJob,
+      false,
+      undefined,
+      customPollOptions
+    )
+
+    expect(delays).toEqual(pollIntervals)
+  })
+
+  it('should throw an error if not valid poll strategies provided', async () => {
+    // INFO: 'maxPollCount' has to be > 0
+    let invalidPollStrategy = {
+      maxPollCount: 0,
+      pollInterval: 3
+    }
+
+    let pollStrategy: PollStrategy = [invalidPollStrategy]
+
+    let expectedError = new Error(
+      `Poll strategies are not valid. 'maxPollCount' has to be greater than 0. Invalid poll strategy: \n${JSON.stringify(
+        invalidPollStrategy,
+        null,
+        2
+      )}`
+    )
+
+    await expect(
+      pollJobState(requestClient, mockJob, false, undefined, {
+        ...defaultPollStrategy,
+        pollStrategy: pollStrategy
+      })
+    ).rejects.toThrow(expectedError)
+
+    // INFO: 'maxPollCount' has to be > than 'maxPollCount' of the previous strategy
+    const validPollStrategy = {
+      maxPollCount: 5,
+      pollInterval: 2
+    }
+
+    invalidPollStrategy = {
+      maxPollCount: validPollStrategy.maxPollCount,
+      pollInterval: 3
+    }
+
+    pollStrategy = [validPollStrategy, invalidPollStrategy]
+
+    expectedError = new Error(
+      `Poll strategies are not valid. 'maxPollCount' has to be greater than 'maxPollCount' in previous poll strategy. Invalid poll strategy: \n${JSON.stringify(
+        invalidPollStrategy,
+        null,
+        2
+      )}`
+    )
+
+    await expect(
+      pollJobState(requestClient, mockJob, false, undefined, {
+        ...defaultPollStrategy,
+        pollStrategy: pollStrategy
+      })
+    ).rejects.toThrow(expectedError)
+
+    // INFO: invalid 'pollInterval'
+    invalidPollStrategy = {
+      maxPollCount: 1,
+      pollInterval: 0
+    }
+
+    pollStrategy = [invalidPollStrategy]
+
+    expectedError = new Error(
+      `Poll strategies are not valid. 'pollInterval' has to be greater than 0. Invalid poll strategy: \n${JSON.stringify(
+        invalidPollStrategy,
+        null,
+        2
+      )}`
+    )
+
+    await expect(
+      pollJobState(requestClient, mockJob, false, undefined, {
+        ...defaultPollStrategy,
+        pollStrategy: pollStrategy
+      })
+    ).rejects.toThrow(expectedError)
+  })
+})
+
+describe('doPoll', () => {
+  const sessionStateLink = '/compute/sessions/session-id-ses0000/state'
+  const jobSessionManager: JobSessionManager = {
+    sessionManager,
+    session: {
+      id: ['id', new Date().getTime(), Math.random()].join('-'),
+      state: SessionState.NoState,
+      links: [
+        {
+          href: sessionStateLink,
+          method: 'GET',
+          rel: 'state',
+          type: 'text/plain',
+          uri: sessionStateLink
+        }
+      ],
+      attributes: {
+        sessionInactiveTimeout: 900
+      },
+      creationTimeStamp: `${new Date(new Date().getTime()).toISOString()}`,
+      stateUrl: '',
+      etag: ''
+    }
+  }
+
+  beforeEach(() => {
+    setupMocks()
+  })
+
+  it('should check session state on every 10th job state poll', async () => {
+    const mockedGetSessionState = jest
+      .spyOn(sessionManager as any, 'getSessionState')
+      .mockImplementation(() => {
+        return Promise.resolve({
+          result: SessionState.Idle,
+          responseStatus: 200
+        })
+      })
+
+    let getSessionStateCount = 0
+    jest.spyOn(requestClient, 'get').mockImplementation(() => {
+      getSessionStateCount++
+
+      return Promise.resolve({
+        result:
+          getSessionStateCount < 20 ? JobState.Running : JobState.Completed,
+        etag: 'etag-string',
+        status: 200
+      })
+    })
+
+    await doPoll(
+      requestClient,
+      mockJob,
+      JobState.Running,
+      false,
+      1,
+      defaultPollStrategy,
+      mockAuthConfig,
+      undefined,
+      undefined,
+      jobSessionManager
+    )
+
+    expect(mockedGetSessionState).toHaveBeenCalledTimes(2)
+  })
+
+  it('should handle error while checking session state', async () => {
+    const sessionStateError = 'Error while getting session state.'
+
+    jest
+      .spyOn(sessionManager as any, 'getSessionState')
+      .mockImplementation(() => {
+        return Promise.reject(sessionStateError)
+      })
+
+    jest.spyOn(requestClient, 'get').mockImplementation(() => {
+      return Promise.resolve({
+        result: JobState.Running,
+        etag: 'etag-string',
+        status: 200
+      })
+    })
+
+    await expect(
+      doPoll(
+        requestClient,
+        mockJob,
+        JobState.Running,
+        false,
+        1,
+        defaultPollStrategy,
+        mockAuthConfig,
+        undefined,
+        undefined,
+        jobSessionManager
+      )
+    ).rejects.toEqual(
+      new JobStatePollError(mockJob.id, new Error(sessionStateError))
+    )
+  })
+
+  it('should throw an error if session state is not healthy', async () => {
+    const filteredSessionStates = Object.values(SessionState).filter(
+      (state) => state !== SessionState.Running && state !== SessionState.Idle
+    )
+    const randomSessionState =
+      filteredSessionStates[
+        Math.floor(Math.random() * filteredSessionStates.length)
+      ]
+
+    jest
+      .spyOn(sessionManager as any, 'getSessionState')
+      .mockImplementation(() => {
+        return Promise.resolve({
+          result: randomSessionState,
+          responseStatus: 200
+        })
+      })
+
+    jest.spyOn(requestClient, 'get').mockImplementation(() => {
+      return Promise.resolve({
+        result: JobState.Running,
+        etag: 'etag-string',
+        status: 200
+      })
+    })
+
+    const mockedClearSession = jest
+      .spyOn(sessionManager, 'clearSession')
+      .mockImplementation(() => Promise.resolve())
+
+    await expect(
+      doPoll(
+        requestClient,
+        mockJob,
+        JobState.Running,
+        false,
+        1,
+        defaultPollStrategy,
+        mockAuthConfig,
+        undefined,
+        undefined,
+        jobSessionManager
+      )
+    ).rejects.toEqual(
+      new JobStatePollError(
+        mockJob.id,
+        new Error(
+          `Session state of the job is not 'running' or 'idle'. Session state is '${randomSessionState}'`
+        )
+      )
+    )
+
+    expect(mockedClearSession).toHaveBeenCalledWith(
+      jobSessionManager.session.id,
+      mockAuthConfig.access_token
+    )
+  })
+
+  it('should handle throw an error if response status of session state is not 200', async () => {
+    const sessionStateResponseStatus = 500
+    jest
+      .spyOn(sessionManager as any, 'getSessionState')
+      .mockImplementation(() => {
+        return Promise.resolve({
+          result: SessionState.Running,
+          responseStatus: sessionStateResponseStatus
+        })
+      })
+
+    jest.spyOn(requestClient, 'get').mockImplementation(() => {
+      return Promise.resolve({
+        result: JobState.Running,
+        etag: 'etag-string',
+        status: 200
+      })
+    })
+
+    const mockedClearSession = jest
+      .spyOn(sessionManager, 'clearSession')
+      .mockImplementation(() => Promise.resolve())
+
+    await expect(
+      doPoll(
+        requestClient,
+        mockJob,
+        JobState.Running,
+        false,
+        1,
+        defaultPollStrategy,
+        mockAuthConfig,
+        undefined,
+        undefined,
+        jobSessionManager
+      )
+    ).rejects.toEqual(
+      new JobStatePollError(
+        mockJob.id,
+        new Error(
+          `Session response status is not 200. Session response status is ${sessionStateResponseStatus}.`
+        )
+      )
+    )
+
+    expect(mockedClearSession).toHaveBeenCalledWith(
+      jobSessionManager.session.id,
+      mockAuthConfig.access_token
+    )
+  })
 })
 
 const setupMocks = () => {
@@ -273,11 +670,14 @@ const setupMocks = () => {
 
 const mockSimplePoll = (runningCount = 2) => {
   let count = 0
+
   jest.spyOn(requestClient, 'get').mockImplementation((url) => {
     count++
+
     if (url.includes('job')) {
       return Promise.resolve({ result: mockJob, etag: '', status: 200 })
     }
+
     return Promise.resolve({
       result:
         count === 0
@@ -293,11 +693,14 @@ const mockSimplePoll = (runningCount = 2) => {
 
 const mockRunningPoll = () => {
   let count = 0
+
   jest.spyOn(requestClient, 'get').mockImplementation((url) => {
     count++
+
     if (url.includes('job')) {
       return Promise.resolve({ result: mockJob, etag: '', status: 200 })
     }
+
     return Promise.resolve({
       result: count === 0 ? 'pending' : 'running',
       etag: '',
@@ -308,11 +711,14 @@ const mockRunningPoll = () => {
 
 const mockLongPoll = () => {
   let count = 0
+
   jest.spyOn(requestClient, 'get').mockImplementation((url) => {
     count++
+
     if (url.includes('job')) {
       return Promise.resolve({ result: mockJob, etag: '', status: 200 })
     }
+
     return Promise.resolve({
       result: count <= 102 ? 'running' : 'completed',
       etag: '',
@@ -323,14 +729,18 @@ const mockLongPoll = () => {
 
 const mockPollWithSingleError = () => {
   let count = 0
+
   jest.spyOn(requestClient, 'get').mockImplementation((url) => {
     count++
+
     if (url.includes('job')) {
       return Promise.resolve({ result: mockJob, etag: '', status: 200 })
     }
+
     if (count === 1) {
       return Promise.reject('Status Error')
     }
+
     return Promise.resolve({
       result: count === 0 ? 'pending' : 'completed',
       etag: '',
@@ -344,6 +754,7 @@ const mockErroredPoll = () => {
     if (url.includes('job')) {
       return Promise.resolve({ result: mockJob, etag: '', status: 200 })
     }
+
     return Promise.reject('Status Error')
   })
 }

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

@@ -1,18 +1,21 @@
 import { ServerType } from '@sasjs/utils/types'
 import { RequestClient } from '../request/RequestClient'
+import { NotFoundError } from '../types/errors'
 import { LoginOptions, LoginResult, LoginResultInternal } from '../types/Login'
 import { serialize } from '../utils'
 import { extractUserLongNameSas9 } from '../utils/sas9/extractUserLongNameSas9'
 import { openWebPage } from './openWebPage'
 import { verifySas9Login } from './verifySas9Login'
 import { verifySasViyaLogin } from './verifySasViyaLogin'
+import { isLogInSuccessHeaderPresent } from './'
 
 export class AuthManager {
   public userName = ''
   public userLongName = ''
   private loginUrl: string
   private logoutUrl: string
-  private redirectedLoginUrl = `/SASLogon/home`
+  private redirectedLoginUrl = `/SASLogon` //SAS 9 M8 no longer redirects from `/SASLogon/home` to the login page. `/SASLogon` seems to be stable enough across SAS versions
+
   constructor(
     private serverUrl: string,
     private serverType: ServerType,
@@ -26,6 +29,8 @@ export class AuthManager {
         : this.serverType === ServerType.SasViya
         ? '/SASLogon/logout.do?'
         : '/SASLogon/logout'
+
+    this.redirectedLoginUrl = this.serverUrl + this.redirectedLoginUrl
   }
 
   /**
@@ -42,6 +47,9 @@ export class AuthManager {
     } = await this.fetchUserName()
 
     if (isLoggedInAlready) {
+      const logger = process.logger || console
+      logger.log('login was not attempted as a valid session already exists')
+
       await this.loginCallback()
 
       return {
@@ -109,6 +117,9 @@ export class AuthManager {
     } = await this.checkSession()
 
     if (isLoggedInAlready) {
+      const logger = process.logger || console
+      logger.log('login was not attempted as a valid session already exists')
+
       await this.loginCallback()
 
       this.userName = loginParams.username
@@ -122,7 +133,7 @@ export class AuthManager {
 
     let loginResponse = await this.sendLoginRequest(loginForm, loginParams)
 
-    let isLoggedIn = isLogInSuccess(this.serverType, loginResponse)
+    let isLoggedIn = isLogInSuccessHeaderPresent(this.serverType, loginResponse)
 
     if (!isLoggedIn) {
       if (isCredentialsVerifyError(loginResponse)) {
@@ -131,6 +142,10 @@ export class AuthManager {
         loginResponse = await this.sendLoginRequest(newLoginForm, loginParams)
       }
 
+      // Sometimes due to redirection on SAS9 and SASViya we don't get the login response that says
+      // You have signed in. Therefore, we have to make an extra request for checking session to
+      // ensure either user is logged in or not.
+
       const res = await this.checkSession()
       isLoggedIn = res.isLoggedIn
       this.userLongName = res.userLongName
@@ -155,10 +170,12 @@ export class AuthManager {
   private async performCASSecurityCheck() {
     const casAuthenticationUrl = `${this.serverUrl}/SASStoredProcess/j_spring_cas_security_check`
 
-    await this.requestClient.get<string>(
+    await this.requestClient
-      `/SASLogon/login?service=${casAuthenticationUrl}`,
+      .get<string>(`/SASLogon/login?service=${casAuthenticationUrl}`, undefined)
-      undefined
+      .catch((err) => {
-    )
+        // ignore if resource not found error
+        if (!(err instanceof NotFoundError)) throw err
+      })
   }
 
   private async sendLoginRequest(
@@ -201,7 +218,7 @@ export class AuthManager {
    *  - a boolean `isLoggedIn`
    *  - a string `userName`,
    *  - a string `userFullName` and
-   *  - a form `loginForm` if not loggedin.
+   *  - a form `loginForm` if not loggedIn.
    */
   public async checkSession(): Promise<LoginResultInternal> {
     const { isLoggedIn, userName, userLongName } = await this.fetchUserName()
@@ -239,7 +256,7 @@ export class AuthManager {
     }
 
     const { result: formResponse } = await this.requestClient.get<string>(
-      this.loginUrl.replace('.do', ''),
+      this.loginUrl.replace('/SASLogon/login.do', '/SASLogon/login'),
       undefined,
       'text/plain'
     )
@@ -312,12 +329,13 @@ export class AuthManager {
   }
 
   private getLoginForm(response: any) {
-    const pattern: RegExp = /<form.+action="(.*Logon[^"]*).*>/
+    const pattern: RegExp = /<form.+action="(.*(Logon|login)[^"]*).*>/
     const matches = pattern.exec(response)
     const formInputs: any = {}
 
     if (matches && matches.length) {
       this.setLoginUrl(matches)
+      response = response.replace(/<input/g, '\n<input')
       const inputs = response.match(/<input.*"hidden"[^>]*>/g)
 
       if (inputs) {
@@ -348,7 +366,7 @@ export class AuthManager {
       this.loginUrl =
         this.serverType === ServerType.SasViya
           ? tempLoginLink
-          : loginUrl.replace('.do', '')
+          : loginUrl.replace('/SASLogon/login.do', '/SASLogon/login')
     }
   }
 
@@ -367,9 +385,3 @@ const isCredentialsVerifyError = (response: string): boolean =>
   /An error occurred while the system was verifying your credentials. Please enter your credentials again./gm.test(
     response
   )
-
-const isLogInSuccess = (serverType: ServerType, response: any): boolean => {
-  if (serverType === ServerType.Sasjs) return response?.loggedin
-
-  return /You have signed in/gm.test(response)
-}

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.
+ * Exchange the auth code for access / refresh tokens for the given client / secret pair.
- * @param requestClient - the pre-configured HTTP request client
+ * @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

@@ -10,6 +10,7 @@ import { refreshTokensForSasjs } from './refreshTokensForSasjs'
 
 /**
  * Returns the auth configuration, refreshing the tokens if necessary.
+ * This function can only be used by Node, if a server type is SASVIYA.
  * @param requestClient - the pre-configured HTTP request client
  * @param authConfig - an object containing a client ID, secret, access token and refresh token
  * @param serverType - server type for which refreshing the tokens, defaults to SASVIYA
@@ -21,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)
@@ -28,10 +30,14 @@ 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)
     }
+
     logger.info('Refreshing access and refresh tokens.')
+
     const tokens =
       serverType === ServerType.SasViya
         ? await refreshTokensForViya(
@@ -43,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/index.ts

@@ -1,3 +1,4 @@
 export * from './AuthManager'
 export * from './isAuthorizeFormRequired'
 export * from './isLoginRequired'
+export * from './loginHeader'

src/auth/isLoginRequired.ts

@@ -1,5 +1,5 @@
 export const isLogInRequired = (response: string): boolean => {
-  const pattern: RegExp = /<form.+action="(.*Logon[^"]*).*>/gm
+  const pattern: RegExp = /<form.+action="(.*(Logon)|(login)[^"]*).*>/gm
   const matches = pattern.test(response)
   return matches
 }

src/auth/loginHeader.ts

@@ -0,0 +1,97 @@
+import { ServerType } from '@sasjs/utils/types'
+import { getUserLanguage } from '../utils'
+
+const enLoginSuccessHeader = 'You have signed in.'
+
+export const defaultSuccessHeaderKey = 'default'
+
+// The following headers provided by https://github.com/sasjs/adapter/issues/835#issuecomment-2177818601
+export const loginSuccessHeaders: { [key: string]: string } = {
+  es: `Ya se ha iniciado la sesi\u00f3n.`,
+  th: `\u0e04\u0e38\u0e13\u0e25\u0e07\u0e0a\u0e37\u0e48\u0e2d\u0e40\u0e02\u0e49\u0e32\u0e43\u0e0a\u0e49\u0e41\u0e25\u0e49\u0e27`,
+  ja: `\u30b5\u30a4\u30f3\u30a4\u30f3\u3057\u307e\u3057\u305f\u3002`,
+  nb: `Du har logget deg p\u00e5.`,
+  sl: `Prijavili ste se.`,
+  ar: `\u0644\u0642\u062f \u0642\u0645\u062a `,
+  sk: `Prihl\u00e1sili ste sa.`,
+  zh_HK: `\u60a8\u5df2\u767b\u5165\u3002`,
+  zh_CN: `\u60a8\u5df2\u767b\u5f55\u3002`,
+  it: `L'utente si \u00e8 connesso.`,
+  sv: `Du har loggat in.`,
+  he: `\u05e0\u05db\u05e0\u05e1\u05ea `,
+  nl: `U hebt zich aangemeld.`,
+  pl: `Zosta\u0142e\u015b zalogowany.`,
+  ko: `\ub85c\uadf8\uc778\ud588\uc2b5\ub2c8\ub2e4.`,
+  zh_TW: `\u60a8\u5df2\u767b\u5165\u3002`,
+  tr: `Oturum a\u00e7t\u0131n\u0131z.`,
+  iw: `\u05e0\u05db\u05e0\u05e1\u05ea `,
+  fr: `Vous \u00eates connect\u00e9.`,
+  uk: `\u0412\u0438 \u0432\u0432\u0456\u0439\u0448\u043b\u0438 \u0432 \u043e\u0431\u043b\u0456\u043a\u043e\u0432\u0438\u0439 \u0437\u0430\u043f\u0438\u0441.`,
+  pt_BR: `Voc\u00ea se conectou.`,
+  no: `Du har logget deg p\u00e5.`,
+  cs: `Jste p\u0159ihl\u00e1\u0161eni.`,
+  fi: `Olet kirjautunut sis\u00e4\u00e4n.`,
+  ru: `\u0412\u044b \u0432\u044b\u043f\u043e\u043b\u043d\u0438\u043b\u0438 \u0432\u0445\u043e\u0434 \u0432 \u0441\u0438\u0441\u0442\u0435\u043c\u0443.`,
+  el: `\u0388\u03c7\u03b5\u03c4\u03b5 \u03c3\u03c5\u03bd\u03b4\u03b5\u03b8\u03b5\u03af.`,
+  hr: `Prijavili ste se.`,
+  da: `Du er logget p\u00e5.`,
+  de: `Sie sind jetzt angemeldet.`,
+  sh: `Prijavljeni ste.`,
+  pt: `Iniciou sess\u00e3o.`,
+  hu: `Bejelentkezett.`,
+  sr: `Prijavljeni ste.`,
+  en: enLoginSuccessHeader,
+  [defaultSuccessHeaderKey]: enLoginSuccessHeader
+}
+
+/**
+ * Provides expected login header based on language settings of the browser.
+ * @returns - expected header as a string.
+ */
+export const getExpectedLogInSuccessHeader = (): string => {
+  // get default success header
+  let successHeader = loginSuccessHeaders[defaultSuccessHeaderKey]
+
+  // get user language based on language settings of the browser
+  const userLang = getUserLanguage()
+
+  if (userLang) {
+    // get success header on exact match of the language code
+    let userLangSuccessHeader = loginSuccessHeaders[userLang]
+
+    // handle case when there is no exact match of the language code
+    if (!userLangSuccessHeader) {
+      // get all supported language codes
+      const headerLanguages = Object.keys(loginSuccessHeaders)
+
+      // find language code on partial match
+      const headerLanguage = headerLanguages.find((language) =>
+        new RegExp(language, 'i').test(userLang)
+      )
+
+      // reassign success header if partial match was found
+      if (headerLanguage) {
+        successHeader = loginSuccessHeaders[headerLanguage]
+      }
+    } else {
+      successHeader = userLangSuccessHeader
+    }
+  }
+
+  return successHeader
+}
+
+/**
+ * Checks if Login success header is present in the response based on language settings of the browser.
+ * @param serverType - server type.
+ * @param response - response object.
+ * @returns - boolean indicating if Login success header is present.
+ */
+export const isLogInSuccessHeaderPresent = (
+  serverType: ServerType,
+  response: any
+): boolean => {
+  if (serverType === ServerType.Sasjs) return response?.loggedIn
+
+  return new RegExp(getExpectedLogInSuccessHeader(), 'gm').test(response)
+}

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,10 +1,13 @@
-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.
+ * This function can only be used by Node.
  * @param requestClient - the pre-configured HTTP request client
  * @param clientId - the client ID to authenticate with.
  * @param clientSecret - the client secret to authenticate with.
@@ -16,9 +19,12 @@ export async function refreshTokensForViya(
   clientSecret: string,
   refreshToken: string
 ) {
+  if (!isNode()) {
+    throw new Error(`Method 'refreshTokensForViya' can only be used by Node.`)
+  }
+
   const url = '/SASLogon/oauth/token'
-  let token
+  const token =
-  token =
     typeof Buffer === 'undefined'
       ? btoa(clientId + ':' + clientSecret)
       : Buffer.from(clientId + ':' + clientSecret).toString('base64')
@@ -27,8 +33,7 @@ export async function refreshTokensForViya(
     Authorization: 'Basic ' + token
   }
 
-  const formData =
+  const formData = new NodeFormData()
-    typeof FormData === 'undefined' ? new NodeFormData() : new FormData()
   formData.append('grant_type', 'refresh_token')
   formData.append('refresh_token', refreshToken)
 
@@ -42,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/AuthManager.spec.ts

@@ -1,17 +1,22 @@
+/**
+ * @jest-environment jsdom
+ */
+
 import { AuthManager } from '../AuthManager'
 import * as dotenv from 'dotenv'
 import { ServerType } from '@sasjs/utils/types'
 import axios from 'axios'
 import {
   mockedCurrentUserApi,
-  mockLoginAuthoriseRequiredResponse,
+  mockLoginAuthoriseRequiredResponse
-  mockLoginSuccessResponse
 } from './mockResponses'
 import { serialize } from '../../utils'
 import * as openWebPageModule from '../openWebPage'
 import * as verifySasViyaLoginModule from '../verifySasViyaLogin'
 import * as verifySas9LoginModule from '../verifySas9Login'
 import { RequestClient } from '../../request/RequestClient'
+import { getExpectedLogInSuccessHeader } from '../'
+
 jest.mock('axios')
 const mockedAxios = axios as jest.Mocked<typeof axios>
 
@@ -125,6 +130,7 @@ describe('AuthManager', () => {
         requestClient,
         authCallback
       )
+
       jest.spyOn(authManager, 'checkSession').mockImplementation(() =>
         Promise.resolve({
           isLoggedIn: false,
@@ -133,8 +139,9 @@ describe('AuthManager', () => {
           loginForm: { name: 'test' }
         })
       )
+
       mockedAxios.post.mockImplementation(() =>
-        Promise.resolve({ data: mockLoginSuccessResponse })
+        Promise.resolve({ data: getExpectedLogInSuccessHeader() })
       )
 
       const loginResponse = await authManager.logIn(userName, password)
@@ -170,6 +177,7 @@ describe('AuthManager', () => {
         requestClient,
         authCallback
       )
+
       jest.spyOn(authManager, 'checkSession').mockImplementation(() =>
         Promise.resolve({
           isLoggedIn: false,
@@ -178,8 +186,9 @@ describe('AuthManager', () => {
           loginForm: { name: 'test' }
         })
       )
+
       mockedAxios.post.mockImplementation(() =>
-        Promise.resolve({ data: mockLoginSuccessResponse })
+        Promise.resolve({ data: getExpectedLogInSuccessHeader() })
       )
       mockedAxios.get.mockImplementation(() => Promise.resolve({ status: 200 }))
 
@@ -365,7 +374,7 @@ describe('AuthManager', () => {
       expect(loginResponse.userName).toEqual(userName)
 
       expect(openWebPageModule.openWebPage).toHaveBeenCalledWith(
-        `/SASLogon/home`,
+        `${serverUrl}/SASLogon`,
         'SASLogon',
         {
           width: 500,
@@ -409,7 +418,7 @@ describe('AuthManager', () => {
       expect(loginResponse.userName).toEqual(userName)
 
       expect(openWebPageModule.openWebPage).toHaveBeenCalledWith(
-        `/SASLogon/home`,
+        `${serverUrl}/SASLogon`,
         'SASLogon',
         {
           width: 500,
@@ -453,7 +462,7 @@ describe('AuthManager', () => {
       expect(loginResponse.userName).toEqual('')
 
       expect(openWebPageModule.openWebPage).toHaveBeenCalledWith(
-        `/SASLogon/home`,
+        `${serverUrl}/SASLogon`,
         'SASLogon',
         {
           width: 500,
@@ -497,7 +506,7 @@ describe('AuthManager', () => {
       expect(loginResponse.userName).toEqual('')
 
       expect(openWebPageModule.openWebPage).toHaveBeenCalledWith(
-        `/SASLogon/home`,
+        `${serverUrl}/SASLogon`,
         'SASLogon',
         {
           width: 500,

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/loginHeader.spec.ts

@@ -0,0 +1,82 @@
+/**
+ * @jest-environment jsdom
+ */
+
+import { ServerType } from '@sasjs/utils/types'
+import {
+  loginSuccessHeaders,
+  isLogInSuccessHeaderPresent,
+  defaultSuccessHeaderKey
+} from '../'
+
+describe('isLogInSuccessHeaderPresent', () => {
+  let languageGetter: any
+
+  beforeEach(() => {
+    languageGetter = jest.spyOn(window.navigator, 'language', 'get')
+  })
+
+  it('should check SASVIYA and SAS9 login success header based on language preferences of the browser', () => {
+    // test SASVIYA server type
+    Object.keys(loginSuccessHeaders).forEach((key) => {
+      languageGetter.mockReturnValue(key)
+
+      expect(
+        isLogInSuccessHeaderPresent(
+          ServerType.SasViya,
+          loginSuccessHeaders[key]
+        )
+      ).toBeTruthy()
+    })
+
+    // test SAS9 server type
+    Object.keys(loginSuccessHeaders).forEach((key) => {
+      languageGetter.mockReturnValue(key)
+
+      expect(
+        isLogInSuccessHeaderPresent(ServerType.Sas9, loginSuccessHeaders[key])
+      ).toBeTruthy()
+    })
+
+    // test possible longer language codes
+    const possibleLanguageCodes = [
+      { short: 'en', long: 'en-US' },
+      { short: 'fr', long: 'fr-FR' },
+      { short: 'es', long: 'es-ES' }
+    ]
+
+    possibleLanguageCodes.forEach((key) => {
+      const { short, long } = key
+      languageGetter.mockReturnValue(long)
+
+      expect(
+        isLogInSuccessHeaderPresent(
+          ServerType.SasViya,
+          loginSuccessHeaders[short]
+        )
+      ).toBeTruthy()
+    })
+
+    // test falling back to default language code
+    languageGetter.mockReturnValue('WRONG-LANGUAGE')
+
+    expect(
+      isLogInSuccessHeaderPresent(
+        ServerType.Sas9,
+        loginSuccessHeaders[defaultSuccessHeaderKey]
+      )
+    ).toBeTruthy()
+  })
+
+  it('should check SASVJS login success header', () => {
+    expect(
+      isLogInSuccessHeaderPresent(ServerType.Sasjs, { loggedIn: true })
+    ).toBeTruthy()
+
+    expect(
+      isLogInSuccessHeaderPresent(ServerType.Sasjs, { loggedIn: false })
+    ).toBeFalsy()
+
+    expect(isLogInSuccessHeaderPresent(ServerType.Sasjs, undefined)).toBeFalsy()
+  })
+})

src/auth/spec/mockResponses.ts

@@ -1,7 +1,6 @@
 import { SasAuthResponse } from '@sasjs/utils/types'
 
 export const mockLoginAuthoriseRequiredResponse = `<form id="application_authorization" action="/SASLogon/oauth/authorize" method="POST"><input type="hidden" name="X-Uaa-Csrf" value="2nfuxIn6WaOURWL7tzTXCe"/>`
-export const mockLoginSuccessResponse = `You have signed in`
 
 export const mockAuthResponse: SasAuthResponse = {
   access_token: 'acc355',

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,8 +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)()
 
@@ -66,9 +68,23 @@ 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 () => {
+    jest.spyOn(IsNodeModule, 'isNode').mockImplementation(() => false)
+
+    const expectedError = new Error(
+      `Method 'refreshTokensForViya' can only be used by Node.`
+    )
+
+    expect(
+      refreshTokensForViya(requestClient, 'client', 'secret', 'token')
+    ).rejects.toEqual(expectedError)
   })
 })
 

src/auth/spec/verifySas9Login.spec.ts

@@ -3,6 +3,7 @@
  */
 import { verifySas9Login } from '../verifySas9Login'
 import * as delayModule from '../../utils/delay'
+import { getExpectedLogInSuccessHeader } from '../'
 
 describe('verifySas9Login', () => {
   const serverUrl = 'http://test-server.com'
@@ -17,8 +18,10 @@ describe('verifySas9Login', () => {
   it('should return isLoggedIn true by checking state of popup', async () => {
     const popup = {
       window: {
-        location: { href: serverUrl + `/SASLogon/home` },
+        location: { href: serverUrl + `/SASLogon` },
-        document: { body: { innerText: '<h3>You have signed in.</h3>' } }
+        document: {
+          body: { innerText: `<h3>${getExpectedLogInSuccessHeader()}</h3>` }
+        }
       }
     } as unknown as Window
 

src/auth/spec/verifySasViyaLogin.spec.ts

@@ -3,6 +3,7 @@
  */
 import { verifySasViyaLogin } from '../verifySasViyaLogin'
 import * as delayModule from '../../utils/delay'
+import { getExpectedLogInSuccessHeader } from '../'
 
 describe('verifySasViyaLogin', () => {
   const serverUrl = 'http://test-server.com'
@@ -18,8 +19,10 @@ describe('verifySasViyaLogin', () => {
   it('should return isLoggedIn true by checking state of popup', async () => {
     const popup = {
       window: {
-        location: { href: serverUrl + `/SASLogon/home` },
+        location: { href: serverUrl + `/SASLogon` },
-        document: { body: { innerText: '<h3>You have signed in.</h3>' } }
+        document: {
+          body: { innerText: `<h3>${getExpectedLogInSuccessHeader()}</h3>` }
+        }
       }
     } as unknown as Window
 

src/auth/verifySas9Login.ts

@@ -1,4 +1,5 @@
 import { delay } from '../utils'
+import { getExpectedLogInSuccessHeader } from './'
 
 export async function verifySas9Login(loginPopup: Window): Promise<{
   isLoggedIn: boolean
@@ -6,13 +7,17 @@ export async function verifySas9Login(loginPopup: Window): Promise<{
   let isLoggedIn = false
   let startTime = new Date()
   let elapsedSeconds = 0
+
   do {
     await delay(1000)
     if (loginPopup.closed) break
 
     isLoggedIn =
       loginPopup.window.location.href.includes('SASLogon') &&
-      loginPopup.window.document.body.innerText.includes('You have signed in.')
+      loginPopup.window.document.body.innerText.includes(
+        getExpectedLogInSuccessHeader()
+      )
+
     elapsedSeconds = (new Date().valueOf() - startTime.valueOf()) / 1000
   } while (!isLoggedIn && elapsedSeconds < 5 * 60)
 

src/auth/verifySasViyaLogin.ts

@@ -1,4 +1,5 @@
 import { delay } from '../utils'
+import { getExpectedLogInSuccessHeader } from './'
 
 export async function verifySasViyaLogin(loginPopup: Window): Promise<{
   isLoggedIn: boolean
@@ -6,23 +7,32 @@ export async function verifySasViyaLogin(loginPopup: Window): Promise<{
   let isLoggedIn = false
   let startTime = new Date()
   let elapsedSeconds = 0
+
   do {
     await delay(1000)
+
     if (loginPopup.closed) break
+
     isLoggedIn = isLoggedInSASVIYA()
+
     elapsedSeconds = (new Date().valueOf() - startTime.valueOf()) / 1000
   } while (!isLoggedIn && elapsedSeconds < 5 * 60)
 
   let isAuthorized = false
+
   startTime = new Date()
+
   do {
     await delay(1000)
+
     if (loginPopup.closed) break
+
     isAuthorized =
       loginPopup.window.location.href.includes('SASLogon') ||
       loginPopup.window.document.body?.innerText?.includes(
-        'You have signed in.'
+        getExpectedLogInSuccessHeader()
       )
+
     elapsedSeconds = (new Date().valueOf() - startTime.valueOf()) / 1000
   } while (!isAuthorized && elapsedSeconds < 5 * 60)
 

src/file/generateFileUploadForm.ts

@@ -1,5 +1,6 @@
 import * as NodeFormData from 'form-data'
 import { convertToCSV } from '../utils/convertToCsv'
+import { isNode } from '../utils'
 
 /**
  * One of the approaches SASjs takes to send tables-formatted JSON (see README)
@@ -26,12 +27,15 @@ export const generateFileUploadForm = (
       )
     }
 
-    if (typeof FormData === 'undefined' && formData instanceof NodeFormData) {
+    // INFO: unfortunately it is not possible to check if formData is instance of NodeFormData or FormData because it will return true for both
-      formData.append(name, csv, {
+    if (isNode()) {
+      // INFO: environment is Node and formData is instance of NodeFormData
+      ;(formData as NodeFormData).append(name, csv, {
         filename: `${name}.csv`,
         contentType: 'application/csv'
       })
     } else {
+      // INFO: environment is Browser and formData is instance of FormData
       const file = new Blob([csv], {
         type: 'application/csv'
       })

src/file/spec/generateFileUploadForm.spec.ts

@@ -1,4 +1,7 @@
 import { generateFileUploadForm } from '../generateFileUploadForm'
+import { convertToCSV } from '../../utils/convertToCsv'
+import * as NodeFormData from 'form-data'
+import * as isNodeModule from '../../utils/isNode'
 
 describe('generateFileUploadForm', () => {
   beforeAll(() => {
@@ -11,44 +14,94 @@ describe('generateFileUploadForm', () => {
     ;(global as any).Blob = BlobMock
   })
 
-  it('should generate file upload form from data', () => {
+  describe('browser', () => {
-    const formData = new FormData()
+    afterAll(() => {
-    const testTable = 'sometable'
+      jest.restoreAllMocks()
-    const testTableWithNullVars: { [key: string]: any } = {
+    })
-      [testTable]: [
-        { var1: 'string', var2: 232, nullvar: 'A' },
-        { var1: 'string', var2: 232, nullvar: 'B' },
-        { var1: 'string', var2: 232, nullvar: '_' },
-        { var1: 'string', var2: 232, nullvar: 0 },
-        { var1: 'string', var2: 232, nullvar: 'z' },
-        { var1: 'string', var2: 232, nullvar: null }
-      ],
-      [`$${testTable}`]: { formats: { var1: '$char12.', nullvar: 'best.' } }
-    }
-    const tableName = Object.keys(testTableWithNullVars).filter((key: string) =>
-      Array.isArray(testTableWithNullVars[key])
-    )[0]
 
-    jest.spyOn(formData, 'append').mockImplementation(() => {})
+    it('should generate file upload form from data', () => {
+      const formData = new FormData()
+      const testTable = 'sometable'
+      const testTableWithNullVars: { [key: string]: any } = {
+        [testTable]: [
+          { var1: 'string', var2: 232, nullvar: 'A' },
+          { var1: 'string', var2: 232, nullvar: 'B' },
+          { var1: 'string', var2: 232, nullvar: '_' },
+          { var1: 'string', var2: 232, nullvar: 0 },
+          { var1: 'string', var2: 232, nullvar: 'z' },
+          { var1: 'string', var2: 232, nullvar: null }
+        ],
+        [`$${testTable}`]: { formats: { var1: '$char12.', nullvar: 'best.' } }
+      }
+      const tableName = Object.keys(testTableWithNullVars).filter(
+        (key: string) => Array.isArray(testTableWithNullVars[key])
+      )[0]
 
-    generateFileUploadForm(formData, testTableWithNullVars)
+      jest.spyOn(formData, 'append').mockImplementation(() => {})
+      jest.spyOn(isNodeModule, 'isNode').mockImplementation(() => false)
 
-    expect(formData.append).toHaveBeenCalledOnce()
+      generateFileUploadForm(formData, testTableWithNullVars)
-    expect(formData.append).toHaveBeenCalledWith(
+
-      tableName,
+      expect(formData.append).toHaveBeenCalledOnce()
-      {},
+      expect(formData.append).toHaveBeenCalledWith(
-      `${tableName}.csv`
+        tableName,
-    )
+        {},
+        `${tableName}.csv`
+      )
+    })
+
+    it('should throw an error if too large string was provided', () => {
+      const formData = new FormData()
+      const data = { testTable: [{ var1: 'z'.repeat(32765 + 1) }] }
+
+      expect(() => generateFileUploadForm(formData, data)).toThrow(
+        new Error(
+          'The max length of a string value in SASjs is 32765 characters.'
+        )
+      )
+    })
   })
 
-  it('should throw an error if too large string was provided', () => {
+  describe('node', () => {
-    const formData = new FormData()
+    it('should generate file upload form from data', () => {
-    const data = { testTable: [{ var1: 'z'.repeat(32765 + 1) }] }
+      const formData = new NodeFormData()
+      const testTable = 'sometable'
+      const testTableWithNullVars: { [key: string]: any } = {
+        [testTable]: [
+          { var1: 'string', var2: 232, nullvar: 'A' },
+          { var1: 'string', var2: 232, nullvar: 'B' },
+          { var1: 'string', var2: 232, nullvar: '_' },
+          { var1: 'string', var2: 232, nullvar: 0 },
+          { var1: 'string', var2: 232, nullvar: 'z' },
+          { var1: 'string', var2: 232, nullvar: null }
+        ],
+        [`$${testTable}`]: { formats: { var1: '$char12.', nullvar: 'best.' } }
+      }
+      const tableName = Object.keys(testTableWithNullVars).filter(
+        (key: string) => Array.isArray(testTableWithNullVars[key])
+      )[0]
+      const csv = convertToCSV(testTableWithNullVars, tableName)
 
-    expect(() => generateFileUploadForm(formData, data)).toThrow(
+      jest.spyOn(formData, 'append').mockImplementation(() => {})
-      new Error(
+
-        'The max length of a string value in SASjs is 32765 characters.'
+      generateFileUploadForm(formData, testTableWithNullVars)
+
+      expect(formData.append).toHaveBeenCalledOnce()
+      expect(formData.append).toHaveBeenCalledWith(tableName, csv, {
+        contentType: 'application/csv',
+        filename: `${tableName}.csv`
+      })
+    })
+
+    it('should throw an error if too large string was provided', () => {
+      const formData = new NodeFormData()
+      const data = { testTable: [{ var1: 'z'.repeat(32765 + 1) }] }
+
+      expect(() => generateFileUploadForm(formData, data)).toThrow(
+        new Error(
+          'The max length of a string value in SASjs is 32765 characters.'
+        )
       )
-    )
+    })
   })
 })

src/job-execution/FileUploader.ts

@@ -1,8 +1,7 @@
 import {
   getValidJson,
   parseSasViyaDebugResponse,
-  parseWeboutResponse,
+  parseWeboutResponse
-  SASJS_LOGS_SEPARATOR
 } from '../utils'
 import { UploadFile } from '../types/UploadFile'
 import {
@@ -93,15 +92,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

@@ -10,10 +10,14 @@ import {
   LoginRequiredError
 } from '../types/errors'
 import { generateFileUploadForm } from '../file/generateFileUploadForm'
-
 import { RequestClient } from '../request/RequestClient'
+import { getFormData } from '../utils'
 
-import { isRelativePath, appendExtraResponseAttributes } from '../utils'
+import {
+  isRelativePath,
+  appendExtraResponseAttributes,
+  getValidJson
+} from '../utils'
 import { BaseJobExecutor } from './JobExecutor'
 
 export class SasjsJobExecutor extends BaseJobExecutor {
@@ -49,8 +53,7 @@ export class SasjsJobExecutor extends BaseJobExecutor {
      * Use the available form data object (FormData in Browser, NodeFormData in
      *  Node)
      */
-    let formData =
+    let formData = getFormData()
-      typeof FormData === 'undefined' ? new NodeFormData() : new FormData()
 
     if (data) {
       // file upload approach
@@ -89,12 +92,18 @@ export class SasjsJobExecutor extends BaseJobExecutor {
             )
           }
 
+          const { result } = res
+
+          if (result && typeof result === 'string' && result.trim())
+            res.result = getValidJson(result)
+
           this.requestClient!.appendRequest(res, sasJob, config.debug)
 
           const responseObject = appendExtraResponseAttributes(
             res,
             extraResponseAttributes
           )
+
           resolve(responseObject)
         })
         .catch(async (e: Error) => {

src/job-execution/WebJobExecutor.ts

@@ -16,10 +16,11 @@ import { SASViyaApiClient } from '../SASViyaApiClient'
 import {
   isRelativePath,
   parseSasViyaDebugResponse,
-  appendExtraResponseAttributes
+  appendExtraResponseAttributes,
+  parseWeboutResponse,
+  getFormData
 } from '../utils'
 import { BaseJobExecutor } from './JobExecutor'
-import { parseWeboutResponse } from '../utils/parseWeboutResponse'
 
 export interface WaitingRequstPromise {
   promise: Promise<any> | null
@@ -112,8 +113,7 @@ export class WebJobExecutor extends BaseJobExecutor {
      * Use the available form data object (FormData in Browser, NodeFormData in
      *  Node)
      */
-    let formData =
+    let formData = getFormData()
-      typeof FormData === 'undefined' ? new NodeFormData() : new FormData()
 
     if (data) {
       const stringifiedData = JSON.stringify(data)

src/minified/sas9/SASjs.ts

@@ -0,0 +1,274 @@
+import { validateInput, compareTimestamps } from '../../utils'
+import { SASjsConfig, UploadFile, LoginMechanism } from '../../types'
+import { AuthManager } from '../../auth'
+import {
+  ServerType,
+  AuthConfig,
+  ExtraResponseAttributes
+} from '@sasjs/utils/types'
+import { RequestClient } from '../../request/RequestClient'
+import { FileUploader } from '../../job-execution/FileUploader'
+import { WebJobExecutor } from './WebJobExecutor'
+import { ErrorResponse } from '../../types/errors/ErrorResponse'
+import { LoginOptions, LoginResult } from '../../types/Login'
+
+const defaultConfig: SASjsConfig = {
+  serverUrl: '',
+  pathSASJS: '/SASjsApi/stp/execute',
+  pathSAS9: '/SASStoredProcess/do',
+  pathSASViya: '/SASJobExecution',
+  appLoc: '/Public/seedapp',
+  serverType: ServerType.Sas9,
+  debug: false,
+  contextName: 'SAS Job Execution compute context',
+  useComputeApi: null,
+  loginMechanism: LoginMechanism.Default
+}
+
+/**
+ * SASjs is a JavaScript adapter for SAS.
+ *
+ */
+export default class SASjs {
+  private sasjsConfig: SASjsConfig = new SASjsConfig()
+  private jobsPath: string = ''
+  private fileUploader: FileUploader | null = null
+  private authManager: AuthManager | null = null
+  private requestClient: RequestClient | null = null
+  private webJobExecutor: WebJobExecutor | null = null
+
+  constructor(config?: Partial<SASjsConfig>) {
+    this.sasjsConfig = {
+      ...defaultConfig,
+      ...config
+    }
+
+    this.setupConfiguration()
+  }
+
+  /**
+   * Logs into the SAS server with the supplied credentials.
+   * @param username - a string representing the username.
+   * @param password - a string representing the password.
+   * @param clientId - a string representing the client ID.
+   */
+  public async logIn(
+    username?: string,
+    password?: string,
+    clientId?: string,
+    options: LoginOptions = {}
+  ): Promise<LoginResult> {
+    if (this.sasjsConfig.loginMechanism === LoginMechanism.Default) {
+      if (!username || !password)
+        throw new Error(
+          'A username and password are required when using the default login mechanism.'
+        )
+
+      return this.authManager!.logIn(username, password)
+    }
+
+    if (typeof window === typeof undefined) {
+      throw new Error(
+        'The redirected login mechanism is only available for use in the browser.'
+      )
+    }
+
+    return this.authManager!.redirectedLogIn(options)
+  }
+
+  /**
+   * Logs out of the configured SAS server.
+   */
+  public logOut() {
+    return this.authManager!.logOut()
+  }
+
+  /**
+   * Returns the current SASjs configuration.
+   *
+   */
+  public getSasjsConfig() {
+    return this.sasjsConfig
+  }
+
+  /**
+   * this method returns an array of SASjsRequest
+   * @returns SASjsRequest[]
+   */
+  public getSasRequests() {
+    const requests = [...this.requestClient!.getRequests()]
+    const sortedRequests = requests.sort(compareTimestamps)
+    return sortedRequests
+  }
+
+  /**
+   * Sets the debug state. Turning this on will enable additional logging in the adapter.
+   * @param value - boolean indicating debug state (on/off).
+   */
+  public setDebugState(value: boolean) {
+    this.sasjsConfig.debug = value
+  }
+
+  /**
+   * Uploads a file to the given service.
+   * @param sasJob - the path to the SAS program (ultimately resolves to
+   *  the SAS `_program` parameter to run a Job Definition or SAS 9 Stored
+   *  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 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 loginRequiredCallback - a function that is called if the
+   * user is not logged in (eg to display a login form). The request will be
+   * resubmitted after successful login.
+   */
+  public async uploadFile(
+    sasJob: string,
+    files: UploadFile[],
+    params: { [key: string]: any } | null,
+    config: { [key: string]: any } = {},
+    loginRequiredCallback?: () => any
+  ) {
+    config = {
+      ...this.sasjsConfig,
+      ...config
+    }
+    const data = { files, params }
+
+    return await this.fileUploader!.execute(
+      sasJob,
+      data,
+      config,
+      loginRequiredCallback
+    )
+  }
+
+  /**
+   * Makes a request to program specified in `SASjob` (could be a Viya Job, a
+   * SAS 9 Stored Process, or a SASjs Server Stored Program). The response
+   * object will always contain table names in lowercase, and column names in
+   * uppercase. Values are returned formatted by default, unformatted
+   * values can be configured as an option in the `%webout` macro.
+   *
+   * @param sasJob - the path to the SAS program (ultimately resolves to
+   *  the SAS `_program` parameter to run a Job Definition or SAS 9 Stored
+   *  Process). Is prepended at runtime with the value of `appLoc`.
+   * @param data - a JSON object containing one or more tables to be sent to
+   * SAS.  For an example of the table structure, see the project README. This
+   * value can be `null` if no inputs are required.
+   * @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 loginRequiredCallback - a function that is called if the
+   * user is not logged in (eg to display a login form). The request will be
+   * resubmitted after successful login.
+   * When using a `loginRequiredCallback`, the call to the request will look, for example, like so:
+   * `await request(sasJobPath, data, config, () => setIsLoggedIn(false))`
+   * If you are not passing in any data and configuration, it will look like so:
+   * `await request(sasJobPath, {}, {}, () => setIsLoggedIn(false))`
+   * @param extraResponseAttributes - a array of predefined values that are used
+   * to provide extra attributes (same names as those values) to be added in response
+   * Supported values are declared in ExtraResponseAttributes type.
+   */
+  public async request(
+    sasJob: string,
+    data: { [key: string]: any } | null,
+    config: { [key: string]: any } = {},
+    loginRequiredCallback?: () => any,
+    authConfig?: AuthConfig,
+    extraResponseAttributes: ExtraResponseAttributes[] = []
+  ) {
+    config = {
+      ...this.sasjsConfig,
+      ...config
+    }
+
+    const validationResult = validateInput(data)
+
+    // status is true if the data passes validation checks above
+    if (validationResult.status) {
+      return await this.webJobExecutor!.execute(
+        sasJob,
+        data,
+        config,
+        loginRequiredCallback,
+        authConfig,
+        extraResponseAttributes
+      )
+    } else {
+      return Promise.reject(new ErrorResponse(validationResult.msg))
+    }
+  }
+
+  /**
+   * Checks whether a session is active, or login is required.
+   * @returns - a promise which resolves with an object containing two values - a boolean `isLoggedIn`, and a string `userName`.
+   */
+  public async checkSession() {
+    return this.authManager!.checkSession()
+  }
+
+  private setupConfiguration() {
+    if (
+      this.sasjsConfig.serverUrl === undefined ||
+      this.sasjsConfig.serverUrl === ''
+    ) {
+      if (typeof location !== 'undefined') {
+        let url = `${location.protocol}//${location.hostname}`
+
+        if (location.port) url = `${url}:${location.port}`
+
+        this.sasjsConfig.serverUrl = url
+      } else {
+        this.sasjsConfig.serverUrl = ''
+      }
+    }
+
+    if (this.sasjsConfig.serverUrl.slice(-1) === '/') {
+      this.sasjsConfig.serverUrl = this.sasjsConfig.serverUrl.slice(0, -1)
+    }
+
+    if (!this.requestClient) {
+      this.requestClient = new RequestClient(
+        this.sasjsConfig.serverUrl,
+        this.sasjsConfig.httpsAgentOptions,
+        this.sasjsConfig.requestHistoryLimit,
+        this.sasjsConfig.verbose
+      )
+    } else {
+      this.requestClient.setConfig(
+        this.sasjsConfig.serverUrl,
+        this.sasjsConfig.httpsAgentOptions
+      )
+    }
+
+    this.jobsPath = this.sasjsConfig.pathSAS9
+
+    this.authManager = new AuthManager(
+      this.sasjsConfig.serverUrl,
+      this.sasjsConfig.serverType!,
+      this.requestClient,
+      this.resendWaitingRequests
+    )
+
+    this.fileUploader = new FileUploader(
+      this.sasjsConfig.serverUrl,
+      this.sasjsConfig.serverType!,
+      this.jobsPath,
+      this.requestClient
+    )
+
+    this.webJobExecutor = new WebJobExecutor(
+      this.sasjsConfig.serverUrl,
+      this.sasjsConfig.serverType!,
+      this.jobsPath,
+      this.requestClient
+    )
+  }
+
+  private resendWaitingRequests = async () => {
+    await this.webJobExecutor?.resendWaitingRequests()
+    await this.fileUploader?.resendWaitingRequests()
+  }
+}

src/minified/sas9/WebJobExecutor.ts

@@ -0,0 +1,156 @@
+import {
+  AuthConfig,
+  ExtraResponseAttributes,
+  ServerType
+} from '@sasjs/utils/types'
+import {
+  ErrorResponse,
+  JobExecutionError,
+  LoginRequiredError
+} from '../../types/errors'
+import { RequestClient } from '../../request/RequestClient'
+import {
+  isRelativePath,
+  appendExtraResponseAttributes,
+  convertToCSV
+} from '../../utils'
+import { BaseJobExecutor } from '../../job-execution/JobExecutor'
+import { parseWeboutResponse } from '../../utils/parseWeboutResponse'
+
+export interface WaitingRequstPromise {
+  promise: Promise<any> | null
+  resolve: any
+  reject: any
+}
+export class WebJobExecutor extends BaseJobExecutor {
+  constructor(
+    serverUrl: string,
+    serverType: ServerType,
+    private jobsPath: string,
+    private requestClient: RequestClient
+  ) {
+    super(serverUrl, serverType)
+  }
+
+  async execute(
+    sasJob: string,
+    data: any,
+    config: any,
+    loginRequiredCallback?: any,
+    authConfig?: AuthConfig,
+    extraResponseAttributes: ExtraResponseAttributes[] = []
+  ) {
+    const loginCallback = loginRequiredCallback
+    const program = isRelativePath(sasJob)
+      ? config.appLoc
+        ? config.appLoc.replace(/\/?$/, '/') + sasJob.replace(/^\//, '')
+        : sasJob
+      : sasJob
+    let apiUrl = `${config.serverUrl}${this.jobsPath}/?${'_program=' + program}`
+
+    let requestParams = {
+      ...this.getRequestParams(config)
+    }
+
+    let formData = new FormData()
+
+    if (data) {
+      try {
+        formData = generateFileUploadForm(formData, data)
+      } catch (e: any) {
+        return Promise.reject(new ErrorResponse(e?.message, e))
+      }
+    }
+
+    for (const key in requestParams) {
+      if (requestParams.hasOwnProperty(key)) {
+        formData.append(key, requestParams[key])
+      }
+    }
+
+    const requestPromise = new Promise((resolve, reject) => {
+      this.requestClient!.post(apiUrl, formData, authConfig?.access_token)
+        .then(async (res: any) => {
+          this.requestClient!.appendRequest(res, sasJob, config.debug)
+
+          const jsonResponse =
+            config.debug && typeof res.result === 'string'
+              ? parseWeboutResponse(res.result, apiUrl)
+              : res.result
+
+          const responseObject = appendExtraResponseAttributes(
+            { result: jsonResponse, log: res.log },
+            extraResponseAttributes
+          )
+          resolve(responseObject)
+        })
+        .catch(async (e: Error) => {
+          if (e instanceof JobExecutionError) {
+            this.requestClient!.appendRequest(e, sasJob, config.debug)
+            reject(new ErrorResponse(e?.message, e))
+          }
+
+          if (e instanceof LoginRequiredError) {
+            if (!loginRequiredCallback) {
+              reject(
+                new ErrorResponse(
+                  'Request is not authenticated. Make sure .env file exists with valid credentials.',
+                  e
+                )
+              )
+            }
+
+            this.appendWaitingRequest(() => {
+              return this.execute(
+                sasJob,
+                data,
+                config,
+                loginRequiredCallback,
+                authConfig,
+                extraResponseAttributes
+              ).then(
+                (res: any) => {
+                  resolve(res)
+                },
+                (err: any) => {
+                  reject(err)
+                }
+              )
+            })
+
+            if (loginCallback) await loginCallback()
+          } else reject(new ErrorResponse(e?.message, e))
+        })
+    })
+
+    return requestPromise
+  }
+}
+
+/**
+ * One of the approaches SASjs takes to send tables-formatted JSON (see README)
+ * to SAS is as multipart form data, where each table is provided as a specially
+ * formatted CSV file.
+ */
+const generateFileUploadForm = (formData: FormData, data: any): FormData => {
+  for (const tableName in data) {
+    if (!Array.isArray(data[tableName])) continue
+
+    const name = tableName
+    const csv = convertToCSV(data, tableName)
+
+    if (csv === 'ERROR: LARGE STRING LENGTH') {
+      throw new Error(
+        'The max length of a string value in SASjs is 32765 characters.'
+      )
+    }
+
+    const file = new Blob([csv], {
+      type: 'application/csv'
+    })
+
+    formData.append(name, file, `${name}.csv`)
+  }
+
+  return formData
+}

src/minified/sas9/index.ts

@@ -0,0 +1,3 @@
+import SASjs from './SASjs'
+export * from '../../types'
+export default SASjs

src/request/RequestClient.ts

@@ -1,4 +1,10 @@
-import { AxiosInstance, AxiosRequestConfig, AxiosResponse } from 'axios'
+import {
+  AxiosError,
+  AxiosInstance,
+  AxiosRequestConfig,
+  AxiosResponse
+} from 'axios'
+import axios from 'axios'
 import * as https from 'https'
 import { CsrfToken } from '..'
 import { isAuthorizeFormRequired, isLogInRequired } from '../auth'
@@ -10,7 +16,7 @@ import {
   JobExecutionError,
   CertificateError
 } from '../types/errors'
-import { SASjsRequest } from '../types'
+import { SASjsRequest, HttpClient, VerboseMode } from '../types'
 import { parseWeboutResponse } from '../utils/parseWeboutResponse'
 import { prefixMessage } from '@sasjs/utils/error'
 import { SAS9AuthError } from '../types/errors/SAS9AuthError'
@@ -20,45 +26,13 @@ import {
   createAxiosInstance
 } from '../utils'
 import { InvalidSASjsCsrfError } from '../types/errors/InvalidSASjsCsrfError'
-
+import { inspect } from 'util'
-export interface HttpClient {
-  get<T>(
-    url: string,
-    accessToken: string | undefined,
-    contentType: string,
-    overrideHeaders: { [key: string]: string | number }
-  ): Promise<{ result: T; etag: string }>
-
-  post<T>(
-    url: string,
-    data: any,
-    accessToken: string | undefined,
-    contentType: string,
-    overrideHeaders: { [key: string]: string | number }
-  ): Promise<{ result: T; etag: string }>
-
-  put<T>(
-    url: string,
-    data: any,
-    accessToken: string | undefined,
-    overrideHeaders: { [key: string]: string | number }
-  ): Promise<{ result: T; etag: string }>
-
-  delete<T>(
-    url: string,
-    accessToken: string | undefined
-  ): Promise<{ result: T; etag: string }>
-
-  getCsrfToken(type: 'general' | 'file'): CsrfToken | undefined
-  saveLocalStorageToken(accessToken: string, refreshToken: string): void
-  clearCsrfTokens(): void
-  clearLocalStorageTokens(): void
-  getBaseUrl(): string
-}
 
 export class RequestClient implements HttpClient {
   private requests: SASjsRequest[] = []
   private requestsLimit: number = 10
+  private httpInterceptor?: number
+  private verboseMode: VerboseMode = false
 
   protected csrfToken: CsrfToken = { headerName: '', value: '' }
   protected fileUploadCsrfToken: CsrfToken | undefined
@@ -67,10 +41,17 @@ export class RequestClient implements HttpClient {
   constructor(
     protected baseUrl: string,
     httpsAgentOptions?: https.AgentOptions,
-    requestsLimit?: number
+    requestsLimit?: number,
+    verboseMode?: VerboseMode
   ) {
     this.createHttpClient(baseUrl, httpsAgentOptions)
+
     if (requestsLimit) this.requestsLimit = requestsLimit
+
+    if (verboseMode) {
+      this.setVerboseMode(verboseMode)
+      this.enableVerboseMode()
+    }
   }
 
   public setConfig(baseUrl: string, httpsAgentOptions?: https.AgentOptions) {
@@ -90,6 +71,7 @@ export class RequestClient implements HttpClient {
     this.csrfToken = { headerName: '', value: '' }
     this.fileUploadCsrfToken = { headerName: '', value: '' }
   }
+
   public clearLocalStorageTokens() {
     localStorage.setItem('accessToken', '')
     localStorage.setItem('refreshToken', '')
@@ -180,6 +162,7 @@ export class RequestClient implements HttpClient {
       responseType: contentType === 'text/plain' ? 'text' : 'json',
       withCredentials: true
     }
+
     if (contentType === 'text/plain') {
       requestConfig.transformResponse = undefined
     }
@@ -389,6 +372,181 @@ export class RequestClient implements HttpClient {
       })
   }
 
+  /**
+   * Adds colors to the string.
+   * If verboseMode is set to 'bleached', colors should be disabled
+   * @param str - string to be prettified.
+   * @returns - prettified string
+   */
+  private prettifyString = (str: any) =>
+    inspect(str, { colors: this.verboseMode !== 'bleached' })
+
+  /**
+   * Formats HTTP request/response body.
+   * @param body - HTTP request/response body.
+   * @returns - formatted string.
+   */
+  private parseInterceptedBody = (body: any) => {
+    if (!body) return ''
+
+    let parsedBody
+
+    // Tries to parse body into JSON object.
+    if (typeof body === 'string') {
+      try {
+        parsedBody = JSON.parse(body)
+      } catch (error) {
+        parsedBody = body
+      }
+    } else {
+      parsedBody = body
+    }
+
+    const bodyLines = this.prettifyString(parsedBody).split('\n')
+
+    // Leaves first 50 lines
+    if (bodyLines.length > 51) {
+      bodyLines.splice(50)
+      bodyLines.push('...')
+    }
+
+    return bodyLines.join('\n')
+  }
+
+  private defaultInterceptionCallBack = (
+    axiosResponse: AxiosResponse | AxiosError
+  ) => {
+    // Message indicating absent value.
+    const noValueMessage = 'Not provided'
+
+    // Fallback request object that can be safely used to form request summary.
+    type FallbackRequest = { _header?: string; res: { rawHeaders: string[] } }
+    // _header is not present in responses with status 1**
+    // rawHeaders are not present in responses with status 1**
+    let fallbackRequest: FallbackRequest = {
+      _header: `${noValueMessage}\n`,
+      res: { rawHeaders: [noValueMessage] }
+    }
+
+    // Fallback response object that can be safely used to form response summary.
+    type FallbackResponse = {
+      status?: number | string
+      request?: FallbackRequest
+      config: { data?: string }
+      data?: unknown
+    }
+    let fallbackResponse: FallbackResponse = axiosResponse
+
+    if (axios.isAxiosError(axiosResponse)) {
+      const { response, request, config } = axiosResponse
+
+      // Try to use axiosResponse.response to form response summary.
+      if (response) {
+        fallbackResponse = response
+      } else {
+        // Try to use axiosResponse.request to form request summary.
+        if (request) {
+          const { _header, _currentRequest } = request
+
+          // Try to use axiosResponse.request._header to form request summary.
+          if (_header) {
+            fallbackRequest._header = _header
+          }
+          // Try to use axiosResponse.request._currentRequest._header to form request summary.
+          else if (_currentRequest && _currentRequest._header) {
+            fallbackRequest._header = _currentRequest._header
+          }
+
+          const { res } = request
+
+          // Try to use axiosResponse.request.res.rawHeaders to form request summary.
+          if (res && res.rawHeaders) {
+            fallbackRequest.res.rawHeaders = res.rawHeaders
+          }
+        }
+
+        // Fallback config that can be safely used to form response summary.
+        const fallbackConfig = { data: noValueMessage }
+
+        fallbackResponse = {
+          status: noValueMessage,
+          request: fallbackRequest,
+          config: config || fallbackConfig,
+          data: noValueMessage
+        }
+      }
+    }
+
+    const { status, config, request, data: resData } = fallbackResponse
+    const { data: reqData } = config
+    const { _header: reqHeaders, res } = request || fallbackRequest
+    const { rawHeaders } = res
+
+    // Converts an array of strings into a single string with the following format:
+    // <headerName>: <headerValue>
+    const resHeaders = rawHeaders.reduce(
+      (acc: string, value: string, i: number) => {
+        if (i % 2 === 0) {
+          acc += `${i === 0 ? '' : '\n'}${value}`
+        } else {
+          acc += `: ${value}`
+        }
+
+        return acc
+      },
+      ''
+    )
+
+    const parsedResBody = this.parseInterceptedBody(resData)
+
+    // HTTP response summary.
+    process.logger?.info(`HTTP Request (first 50 lines):
+${reqHeaders}${this.parseInterceptedBody(reqData)}
+
+HTTP Response Code: ${this.prettifyString(status)}
+
+HTTP Response (first 50 lines):
+${resHeaders}${parsedResBody ? `\n\n${parsedResBody}` : ''}
+`)
+
+    return axiosResponse
+  }
+
+  /**
+   * Sets verbose mode.
+   * @param verboseMode - value of the verbose mode, can be true, false or bleached(without extra colors).
+   */
+  public setVerboseMode = (verboseMode: VerboseMode) => {
+    this.verboseMode = verboseMode
+
+    if (this.verboseMode) this.enableVerboseMode()
+    else this.disableVerboseMode()
+  }
+
+  /**
+   * Turns on verbose mode to log every HTTP response.
+   * @param successCallBack - function that should be triggered on every HTTP response with the status 2**.
+   * @param errorCallBack - function that should be triggered on every HTTP response with the status different from 2**.
+   */
+  public enableVerboseMode = (
+    successCallBack = this.defaultInterceptionCallBack,
+    errorCallBack = this.defaultInterceptionCallBack
+  ) => {
+    this.httpInterceptor = this.httpClient.interceptors.response.use(
+      successCallBack,
+      errorCallBack
+    )
+  }
+
+  /**
+   * Turns off verbose mode to log every HTTP response.
+   */
+  public disableVerboseMode = () => {
+    if (this.httpInterceptor) {
+      this.httpClient.interceptors.response.eject(this.httpInterceptor)
+    }
+  }
+
   protected getHeaders = (
     accessToken: string | undefined,
     contentType: string
@@ -691,7 +849,9 @@ const parseError = (data: string) => {
       const parts = data.split(/stored process not found: /i)
       if (parts.length > 1) {
         const storedProcessPath = parts[1].split('<i>')[1].split('</i>')[0]
-        const message = `Stored process not found: ${storedProcessPath}`
+        const message = storedProcessPath.endsWith('runner')
+          ? `SASJS runner not found. Here's the link (https://cli.sasjs.io/auth/#sasjs-runner) to the SAS code for registering the SASjs runner`
+          : `Stored process not found: ${storedProcessPath}`
         return new JobExecutionError(500, message, '')
       }
     }

src/request/Sas9RequestClient.ts

@@ -4,6 +4,7 @@ import axiosCookieJarSupport from 'axios-cookiejar-support'
 import * as tough from 'tough-cookie'
 import { prefixMessage } from '@sasjs/utils/error'
 import { RequestClient, throwIfError } from './RequestClient'
+import { JobExecutionError } from '../types/errors'
 
 /**
  * Specific request client for SAS9 in Node.js environments.
@@ -69,6 +70,8 @@ export class Sas9RequestClient extends RequestClient {
         return this.parseResponse<T>(response)
       })
       .catch(async (e: any) => {
+        if (e instanceof JobExecutionError) throw e
+
         return await this.handleError(
           e,
           () =>

src/request/SasjsRequestClient.ts

@@ -1,12 +1,11 @@
 import { RequestClient } from './RequestClient'
 import { AxiosResponse } from 'axios'
-import { SASJS_LOGS_SEPARATOR, getValidJson } from '../utils'
+import { SasjsParsedResponse } from '../types'
 
 /**
  * Specific request client for SASJS.
  * Append tokens in headers.
  */
-
 export class SasjsRequestClient extends RequestClient {
   getHeaders = (accessToken: string | undefined, contentType: string) => {
     const headers: any = {}
@@ -27,7 +26,7 @@ export class SasjsRequestClient extends RequestClient {
   protected parseResponse<T>(response: AxiosResponse<any>) {
     const etag = response?.headers ? response.headers['etag'] : ''
     let parsedResponse = {}
-    let log
+    let webout, log, printOutput
 
     try {
       if (typeof response.data === 'string') {
@@ -37,18 +36,47 @@ export class SasjsRequestClient extends RequestClient {
       }
     } catch {
       if (response.data.includes(SASJS_LOGS_SEPARATOR)) {
-        const splittedResponse = response.data.split(SASJS_LOGS_SEPARATOR)
+        const { data } = response
-        log = splittedResponse[1]
+        const splittedResponse: string[] = data.split(SASJS_LOGS_SEPARATOR)
-        if (splittedResponse[0].trim())
+
-          parsedResponse = getValidJson(splittedResponse[0])
+        webout = splittedResponse.splice(0, 1)[0]
-      } else parsedResponse = response.data
+        if (webout !== undefined) parsedResponse = webout
+
+        // log can contain nested logs
+        const logs = splittedResponse.splice(0, splittedResponse.length - 1)
+
+        // tests if string ends with SASJS_LOGS_SEPARATOR
+        const endingWithLogSepRegExp = new RegExp(`${SASJS_LOGS_SEPARATOR}$`)
+
+        // at this point splittedResponse can contain only one item
+        const lastChunk = splittedResponse[0]
+
+        if (lastChunk) {
+          // if the last chunk doesn't end with SASJS_LOGS_SEPARATOR, then it is a printOutput
+          // else the last chunk is part of the log and has to be joined
+          if (!endingWithLogSepRegExp.test(data)) printOutput = lastChunk
+          else if (logs.length > 1) logs.push(lastChunk)
+        }
+
+        // join logs into single log with SASJS_LOGS_SEPARATOR
+        log = logs.join(SASJS_LOGS_SEPARATOR)
+      } else {
+        parsedResponse = response.data
+      }
     }
 
-    return {
+    const returnResult: SasjsParsedResponse<T> = {
       result: parsedResponse as T,
-      log,
+      log: log || '',
       etag,
       status: response.status
     }
+
+    if (printOutput) returnResult.printOutput = printOutput
+
+    return returnResult
   }
 }
+
+export const SASJS_LOGS_SEPARATOR =
+  'SASJS_LOGS_SEPARATOR_163ee17b6ff24f028928972d80a26784'

src/request/spec/SasjsRequestClient.spec.ts

@@ -0,0 +1,169 @@
+import { SASJS_LOGS_SEPARATOR, SasjsRequestClient } from '../SasjsRequestClient'
+import { SasjsParsedResponse } from '../../types'
+import { AxiosResponse } from 'axios'
+
+describe('SasjsRequestClient', () => {
+  const requestClient = new SasjsRequestClient('')
+  const etag = 'etag'
+  const status = 200
+
+  const webout = `hello`
+  const log = `1                                                          The SAS System                             Tuesday, 25 July 2023 12:51:00
+
+
+PROC MIGRATE will preserve current SAS file attributes and is 
+recommended for converting all your SAS libraries from any 
+SAS 8 release to SAS 9.  For details and examples, please see
+http://support.sas.com/rnd/migration/index.html
+
+
+
+NOTE: SAS initialization used:
+    real time           0.01 seconds
+    cpu time            0.02 seconds
+    
+
+`
+  const printOutput = 'printOutPut'
+
+  describe('parseResponse', () => {})
+
+  it('should parse response with 1 log', () => {
+    const response: AxiosResponse<any> = {
+      data: `${webout}
+${SASJS_LOGS_SEPARATOR}
+${log}
+${SASJS_LOGS_SEPARATOR}`,
+      status,
+      statusText: 'ok',
+      headers: { etag },
+      config: {}
+    }
+
+    const expectedParsedResponse: SasjsParsedResponse<string> = {
+      result: `${webout}
+`,
+      log: `
+${log}
+`,
+      etag,
+      status
+    }
+
+    expect(requestClient['parseResponse'](response)).toEqual(
+      expectedParsedResponse
+    )
+  })
+
+  it('should parse response with 1 log and printOutput', () => {
+    const response: AxiosResponse<any> = {
+      data: `${webout}
+${SASJS_LOGS_SEPARATOR}
+${log}
+${SASJS_LOGS_SEPARATOR}
+${printOutput}`,
+      status,
+      statusText: 'ok',
+      headers: { etag },
+      config: {}
+    }
+
+    const expectedParsedResponse: SasjsParsedResponse<string> = {
+      result: `${webout}
+`,
+      log: `
+${log}
+`,
+      etag,
+      status,
+      printOutput: `
+${printOutput}`
+    }
+
+    expect(requestClient['parseResponse'](response)).toEqual(
+      expectedParsedResponse
+    )
+  })
+
+  it('should parse response with nested logs', () => {
+    const logWithNestedLog = `root log start
+${SASJS_LOGS_SEPARATOR}
+${log}
+${SASJS_LOGS_SEPARATOR}
+root log end`
+
+    const response: AxiosResponse<any> = {
+      data: `${webout}
+${SASJS_LOGS_SEPARATOR}
+${logWithNestedLog}
+${SASJS_LOGS_SEPARATOR}`,
+      status,
+      statusText: 'ok',
+      headers: { etag },
+      config: {}
+    }
+
+    const expectedParsedResponse: SasjsParsedResponse<string> = {
+      result: `${webout}
+`,
+      log: `
+${logWithNestedLog}
+`,
+      etag,
+      status
+    }
+
+    expect(requestClient['parseResponse'](response)).toEqual(
+      expectedParsedResponse
+    )
+  })
+
+  it('should parse response with nested logs and printOutput', () => {
+    const logWithNestedLog = `root log start
+${SASJS_LOGS_SEPARATOR}
+${log}
+${SASJS_LOGS_SEPARATOR}
+log with indentation
+  ${SASJS_LOGS_SEPARATOR}
+  ${log}
+  ${SASJS_LOGS_SEPARATOR}
+some SAS code containing ${SASJS_LOGS_SEPARATOR}
+root log end`
+
+    const response: AxiosResponse<any> = {
+      data: `${webout}
+${SASJS_LOGS_SEPARATOR}
+${logWithNestedLog}
+${SASJS_LOGS_SEPARATOR}
+${printOutput}`,
+      status,
+      statusText: 'ok',
+      headers: { etag },
+      config: {}
+    }
+
+    const expectedParsedResponse: SasjsParsedResponse<string> = {
+      result: `${webout}
+`,
+      log: `
+${logWithNestedLog}
+`,
+      etag,
+      status,
+      printOutput: `
+${printOutput}`
+    }
+
+    expect(requestClient['parseResponse'](response)).toEqual(
+      expectedParsedResponse
+    )
+  })
+})
+
+describe('SASJS_LOGS_SEPARATOR', () => {
+  it('SASJS_LOGS_SEPARATOR should be hardcoded', () => {
+    expect(SASJS_LOGS_SEPARATOR).toEqual(
+      'SASJS_LOGS_SEPARATOR_163ee17b6ff24f028928972d80a26784'
+    )
+  })
+})

src/test/RequestClient.spec.ts

@@ -2,17 +2,22 @@ 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 axios from 'axios'
 import {
   LoginRequiredError,
   AuthorizeError,
   NotFoundError,
-  InternalServerError
+  InternalServerError,
-} from '../types/errors'
+  VerboseMode
-import { prefixMessage } from '@sasjs/utils/error'
+} from '../types'
 import { RequestClient } from '../request/RequestClient'
+import { getTokenRequestErrorPrefixResponse } from '../auth/getTokenRequestErrorPrefix'
+import { AxiosResponse, AxiosError } from 'axios'
+import { Logger, LogLevel } from '@sasjs/utils/logger'
+import * as UtilsModule from 'util'
 
 const axiosActual = jest.requireActual('axios')
 
@@ -25,16 +30,6 @@ jest
 const PORT = 8000
 const SERVER_URL = `https://localhost:${PORT}/`
 
-const ERROR_MESSAGES = {
-  selfSigned: 'self signed certificate',
-  CCA: 'unable to verify the first certificate'
-}
-
-const incorrectAuthCodeErr = {
-  error: 'unauthorized',
-  error_description: 'Bad credentials'
-}
-
 describe('RequestClient', () => {
   let server: http.Server
 
@@ -66,14 +61,423 @@ describe('RequestClient', () => {
   })
 
   it('should response the POST method with Unauthorized', async () => {
-    await expect(
+    const expectedError = new LoginRequiredError({
-      adapter.getAccessToken('clientId', 'clientSecret', 'incorrect')
+      error: 'unauthorized',
-    ).rejects.toEqual(
+      error_description: 'Bad credentials'
-      prefixMessage(
+    })
-        new LoginRequiredError(incorrectAuthCodeErr),
+
-        'Error while getting access token. '
+    const rejectionErrorMessage = await adapter
+      .getAccessToken('clientId', 'clientSecret', 'incorrect')
+      .catch((err) =>
+        getTokenRequestErrorPrefixResponse(err.message, ServerType.SasViya)
       )
-    )
+
+    expect(rejectionErrorMessage).toEqual(expectedError.message)
+  })
+
+  describe('defaultInterceptionCallBack', () => {
+    const reqHeaders = `POST https://sas.server.com/compute/sessions/session_id/jobs HTTP/1.1
+Accept: application/json
+Content-Type: application/json
+User-Agent: axios/0.27.2
+Content-Length: 334
+host: sas.server.io
+Connection: close
+`
+    const reqData = `{
+          name: 'test_job',
+          description: 'Powered by SASjs',
+          code: ['test_code'],
+          variables: {
+            SYS_JES_JOB_URI: '',
+            _program: '/Public/sasjs/jobs/jobs/test_job'
+          },
+          arguments: {
+            _contextName: 'SAS Job Execution compute context',
+            _OMITJSONLISTING: true,
+            _OMITJSONLOG: true,
+            _OMITSESSIONRESULTS: true,
+            _OMITTEXTLISTING: true,
+            _OMITTEXTLOG: true
+          }
+        }`
+
+    const resHeaders = ['content-type', 'application/json']
+    const resData = {
+      id: 'id_string',
+      name: 'name_string',
+      uri: 'uri_string',
+      createdBy: 'createdBy_string',
+      code: 'TEST CODE',
+      links: [
+        {
+          method: 'method_string',
+          rel: 'state',
+          href: 'state_href_string',
+          uri: 'uri_string',
+          type: 'type_string'
+        },
+        {
+          method: 'method_string',
+          rel: 'state',
+          href: 'state_href_string',
+          uri: 'uri_string',
+          type: 'type_string'
+        },
+        {
+          method: 'method_string',
+          rel: 'state',
+          href: 'state_href_string',
+          uri: 'uri_string',
+          type: 'type_string'
+        },
+        {
+          method: 'method_string',
+          rel: 'state',
+          href: 'state_href_string',
+          uri: 'uri_string',
+          type: 'type_string'
+        },
+        {
+          method: 'method_string',
+          rel: 'state',
+          href: 'state_href_string',
+          uri: 'uri_string',
+          type: 'type_string'
+        },
+        {
+          method: 'method_string',
+          rel: 'self',
+          href: 'self_href_string',
+          uri: 'uri_string',
+          type: 'type_string'
+        }
+      ],
+      results: { '_webout.json': '_webout.json_string' },
+      logStatistics: {
+        lineCount: 1,
+        modifiedTimeStamp: 'modifiedTimeStamp_string'
+      }
+    }
+    beforeAll(() => {
+      ;(process as any).logger = new Logger(LogLevel.Off)
+      jest.spyOn((process as any).logger, 'info')
+    })
+
+    it('should log parsed response with status 1**', () => {
+      const spyIsAxiosError = jest
+        .spyOn(axios, 'isAxiosError')
+        .mockImplementation(() => true)
+
+      const mockedAxiosError = {
+        config: {
+          data: reqData
+        },
+        request: {
+          _currentRequest: {
+            _header: reqHeaders
+          }
+        }
+      } as AxiosError
+
+      const requestClient = new RequestClient('')
+      requestClient['defaultInterceptionCallBack'](mockedAxiosError)
+
+      const noValueMessage = 'Not provided'
+      const expectedLog = `HTTP Request (first 50 lines):
+${reqHeaders}${requestClient['parseInterceptedBody'](reqData)}
+
+HTTP Response Code: ${requestClient['prettifyString'](noValueMessage)}
+
+HTTP Response (first 50 lines):
+${noValueMessage}
+\n${requestClient['parseInterceptedBody'](noValueMessage)}
+`
+
+      expect((process as any).logger.info).toHaveBeenCalledWith(expectedLog)
+
+      spyIsAxiosError.mockReset()
+    })
+
+    it('should log parsed response with status 2**', () => {
+      const status = getRandomStatus([
+        200, 201, 202, 203, 204, 205, 206, 207, 208, 226
+      ])
+
+      const mockedResponse: AxiosResponse = {
+        data: resData,
+        status,
+        statusText: '',
+        headers: {},
+        config: { data: reqData },
+        request: { _header: reqHeaders, res: { rawHeaders: resHeaders } }
+      }
+
+      const requestClient = new RequestClient('')
+      requestClient['defaultInterceptionCallBack'](mockedResponse)
+
+      const expectedLog = `HTTP Request (first 50 lines):
+${reqHeaders}${requestClient['parseInterceptedBody'](reqData)}
+
+HTTP Response Code: ${requestClient['prettifyString'](status)}
+
+HTTP Response (first 50 lines):
+${resHeaders[0]}: ${resHeaders[1]}${
+        requestClient['parseInterceptedBody'](resData)
+          ? `\n\n${requestClient['parseInterceptedBody'](resData)}`
+          : ''
+      }
+`
+
+      expect((process as any).logger.info).toHaveBeenCalledWith(expectedLog)
+    })
+
+    it('should log parsed response with status 3**', () => {
+      const status = getRandomStatus([300, 301, 302, 303, 304, 307, 308])
+
+      const mockedResponse: AxiosResponse = {
+        data: resData,
+        status,
+        statusText: '',
+        headers: {},
+        config: { data: reqData },
+        request: { _header: reqHeaders, res: { rawHeaders: resHeaders } }
+      }
+
+      const requestClient = new RequestClient('')
+      requestClient['defaultInterceptionCallBack'](mockedResponse)
+
+      const expectedLog = `HTTP Request (first 50 lines):
+${reqHeaders}${requestClient['parseInterceptedBody'](reqData)}
+
+HTTP Response Code: ${requestClient['prettifyString'](status)}
+
+HTTP Response (first 50 lines):
+${resHeaders[0]}: ${resHeaders[1]}${
+        requestClient['parseInterceptedBody'](resData)
+          ? `\n\n${requestClient['parseInterceptedBody'](resData)}`
+          : ''
+      }
+`
+
+      expect((process as any).logger.info).toHaveBeenCalledWith(expectedLog)
+    })
+
+    it('should log parsed response with status 4**', () => {
+      const spyIsAxiosError = jest
+        .spyOn(axios, 'isAxiosError')
+        .mockImplementation(() => true)
+
+      const status = getRandomStatus([
+        400, 401, 402, 403, 404, 407, 408, 409, 410, 411, 412, 413, 414, 415,
+        416, 417, 418, 421, 422, 423, 424, 425, 426, 428, 429, 431, 451
+      ])
+
+      const mockedResponse: AxiosResponse = {
+        data: resData,
+        status,
+        statusText: '',
+        headers: {},
+        config: { data: reqData },
+        request: { _header: reqHeaders, res: { rawHeaders: resHeaders } }
+      }
+      const mockedAxiosError = {
+        config: {
+          data: reqData
+        },
+        request: {
+          _currentRequest: {
+            _header: reqHeaders
+          }
+        },
+        response: mockedResponse
+      } as AxiosError
+
+      const requestClient = new RequestClient('')
+      requestClient['defaultInterceptionCallBack'](mockedAxiosError)
+
+      const expectedLog = `HTTP Request (first 50 lines):
+${reqHeaders}${requestClient['parseInterceptedBody'](reqData)}
+
+HTTP Response Code: ${requestClient['prettifyString'](status)}
+
+HTTP Response (first 50 lines):
+${resHeaders[0]}: ${resHeaders[1]}${
+        requestClient['parseInterceptedBody'](resData)
+          ? `\n\n${requestClient['parseInterceptedBody'](resData)}`
+          : ''
+      }
+`
+
+      expect((process as any).logger.info).toHaveBeenCalledWith(expectedLog)
+
+      spyIsAxiosError.mockReset()
+    })
+
+    it('should log parsed response with status 5**', () => {
+      const spyIsAxiosError = jest
+        .spyOn(axios, 'isAxiosError')
+        .mockImplementation(() => true)
+
+      const status = getRandomStatus([
+        500, 501, 502, 503, 504, 505, 506, 507, 508, 510, 511
+      ])
+
+      const mockedResponse: AxiosResponse = {
+        data: resData,
+        status,
+        statusText: '',
+        headers: {},
+        config: { data: reqData },
+        request: { _header: reqHeaders, res: { rawHeaders: resHeaders } }
+      }
+      const mockedAxiosError = {
+        config: {
+          data: reqData
+        },
+        request: {
+          _currentRequest: {
+            _header: reqHeaders
+          }
+        },
+        response: mockedResponse
+      } as AxiosError
+
+      const requestClient = new RequestClient('')
+      requestClient['defaultInterceptionCallBack'](mockedAxiosError)
+
+      const expectedLog = `HTTP Request (first 50 lines):
+${reqHeaders}${requestClient['parseInterceptedBody'](reqData)}
+
+HTTP Response Code: ${requestClient['prettifyString'](status)}
+
+HTTP Response (first 50 lines):
+${resHeaders[0]}: ${resHeaders[1]}${
+        requestClient['parseInterceptedBody'](resData)
+          ? `\n\n${requestClient['parseInterceptedBody'](resData)}`
+          : ''
+      }
+`
+
+      expect((process as any).logger.info).toHaveBeenCalledWith(expectedLog)
+
+      spyIsAxiosError.mockReset()
+    })
+  })
+
+  describe('enableVerboseMode', () => {
+    it('should add defaultInterceptionCallBack functions to response interceptors', () => {
+      const requestClient = new RequestClient('')
+      const interceptorSpy = jest.spyOn(
+        requestClient['httpClient'].interceptors.response,
+        'use'
+      )
+
+      requestClient.enableVerboseMode()
+
+      expect(interceptorSpy).toHaveBeenCalledWith(
+        requestClient['defaultInterceptionCallBack'],
+        requestClient['defaultInterceptionCallBack']
+      )
+    })
+
+    it('should add callback functions to response interceptors', () => {
+      const requestClient = new RequestClient('')
+      const interceptorSpy = jest.spyOn(
+        requestClient['httpClient'].interceptors.response,
+        'use'
+      )
+
+      const successCallback = (response: AxiosResponse | AxiosError) => {
+        console.log('success')
+
+        return response
+      }
+      const failureCallback = (response: AxiosResponse | AxiosError) => {
+        console.log('failure')
+
+        return response
+      }
+
+      requestClient.enableVerboseMode(successCallback, failureCallback)
+
+      expect(interceptorSpy).toHaveBeenCalledWith(
+        successCallback,
+        failureCallback
+      )
+    })
+  })
+
+  describe('setVerboseMode', () => {
+    it(`should set verbose mode`, () => {
+      const requestClient = new RequestClient('')
+      let verbose: VerboseMode = false
+      requestClient.setVerboseMode(verbose)
+
+      expect(requestClient['verboseMode']).toEqual(verbose)
+
+      verbose = true
+      requestClient.setVerboseMode(verbose)
+
+      expect(requestClient['verboseMode']).toEqual(verbose)
+
+      verbose = 'bleached'
+      requestClient.setVerboseMode(verbose)
+
+      expect(requestClient['verboseMode']).toEqual(verbose)
+    })
+  })
+
+  describe('prettifyString', () => {
+    it(`should call inspect without colors when verbose mode is set to 'bleached'`, () => {
+      const requestClient = new RequestClient('')
+      let verbose: VerboseMode = 'bleached'
+      requestClient.setVerboseMode(verbose)
+
+      jest.spyOn(UtilsModule, 'inspect')
+
+      const testStr = JSON.stringify({ test: 'test' })
+
+      requestClient['prettifyString'](testStr)
+
+      expect(UtilsModule.inspect).toHaveBeenCalledWith(testStr, {
+        colors: false
+      })
+    })
+
+    it(`should call inspect with colors when verbose mode is set to 'true'`, () => {
+      const requestClient = new RequestClient('')
+      let verbose: VerboseMode = true
+      requestClient.setVerboseMode(verbose)
+
+      jest.spyOn(UtilsModule, 'inspect')
+
+      const testStr = JSON.stringify({ test: 'test' })
+
+      requestClient['prettifyString'](testStr)
+
+      expect(UtilsModule.inspect).toHaveBeenCalledWith(testStr, {
+        colors: true
+      })
+    })
+  })
+
+  describe('disableVerboseMode', () => {
+    it('should eject interceptor', () => {
+      const requestClient = new RequestClient('')
+
+      const interceptorSpy = jest.spyOn(
+        requestClient['httpClient'].interceptors.response,
+        'eject'
+      )
+
+      const interceptorId = 100
+
+      requestClient['httpInterceptor'] = interceptorId
+      requestClient.disableVerboseMode()
+
+      expect(interceptorSpy).toHaveBeenCalledWith(interceptorId)
+    })
   })
 
   describe('handleError', () => {
@@ -209,15 +613,15 @@ describe('RequestClient - Self Signed Server', () => {
       serverType: ServerType.SasViya
     })
 
-    await expect(
+    const expectedError = 'self-signed certificate'
-      adapterWithoutCertificate.getAccessToken(
+
-        'clientId',
+    const rejectionErrorMessage = await adapterWithoutCertificate
-        'clientSecret',
+      .getAccessToken('clientId', 'clientSecret', 'authCode')
-        '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 +651,18 @@ describe('RequestClient - Self Signed Server', () => {
   })
 
   it('should response the POST method with Unauthorized', async () => {
-    await expect(
+    const expectedError = new LoginRequiredError({
-      adapter.getAccessToken('clientId', 'clientSecret', 'incorrect')
+      error: 'unauthorized',
-    ).rejects.toEqual(
+      error_description: 'Bad credentials'
-      prefixMessage(
+    })
-        new LoginRequiredError(incorrectAuthCodeErr),
+
-        'Error while getting access token. '
+    const rejectionErrorMessage = await adapter
+      .getAccessToken('clientId', 'clientSecret', 'incorrect')
+      .catch((err) =>
+        getTokenRequestErrorPrefixResponse(err.message, ServerType.SasViya)
       )
-    )
+
+    expect(rejectionErrorMessage).toEqual(expectedError.message)
   })
 })
 
@@ -285,3 +693,11 @@ const createCertificate = async (): Promise<pem.CertificateCreationResult> => {
     )
   })
 }
+
+/**
+ * Returns a random status code.
+ * @param statuses - an array of available statuses.
+ * @returns - random item from an array of statuses.
+ */
+const getRandomStatus = (statuses: number[]) =>
+  statuses[Math.floor(Math.random() * statuses.length)]

src/test/SessionManager.spec.ts

@@ -2,20 +2,48 @@ 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 } from '../types'
+import { Session, SessionState, Context } from '../types'
 
 jest.mock('axios')
 const mockedAxios = axios as jest.Mocked<typeof axios>
+const requestClient = new (<jest.Mock<RequestClient>>RequestClient)()
 
 describe('SessionManager', () => {
   dotenv.config()
+  process.env.SERVER_URL = 'https://server.com'
 
   const sessionManager = new SessionManager(
     process.env.SERVER_URL as string,
     process.env.DEFAULT_COMPUTE_CONTEXT as string,
-    new RequestClient('https://sample.server.com')
+    requestClient
   )
+  const sessionStateLink = '/compute/sessions/session-id-ses0000/state'
+  const sessionEtag = 'etag-string'
+
+  const getMockSession = (): Session => ({
+    id: ['id', new Date().getTime(), Math.random()].join('-'),
+    state: SessionState.NoState,
+    links: [
+      {
+        href: sessionStateLink,
+        method: 'GET',
+        rel: 'state',
+        type: 'text/plain',
+        uri: sessionStateLink
+      }
+    ],
+    attributes: {
+      sessionInactiveTimeout: 900
+    },
+    creationTimeStamp: `${new Date(new Date().getTime()).toISOString()}`,
+    stateUrl: sessionStateLink,
+    etag: sessionEtag
+  })
+
+  afterEach(() => {
+    jest.restoreAllMocks()
+  })
 
   describe('getVariable', () => {
     it('should fetch session variable', async () => {
@@ -45,24 +73,50 @@ describe('SessionManager', () => {
         )
       ).resolves.toEqual(expectedResponse)
     })
+
+    it('should throw an error if GET request failed', async () => {
+      const responseStatus = 500
+      const responseErrorMessage = `The process timed out after 60 seconds. Request failed with status code ${responseStatus}`
+      const response = {
+        status: responseStatus,
+        data: {
+          message: responseErrorMessage
+        }
+      }
+      const testVariable = 'testVariable'
+
+      jest.spyOn(requestClient, 'get').mockImplementation(() =>
+        Promise.reject({
+          response
+        })
+      )
+
+      const expectedError = `Error while fetching session variable '${testVariable}'. GET request to ${process.env.SERVER_URL}/compute/sessions/testId/variables/${testVariable} failed with status code ${responseStatus}. ${responseErrorMessage}`
+
+      await expect(
+        sessionManager.getVariable('testId', testVariable)
+      ).rejects.toEqual(expectedError)
+    })
   })
 
   describe('waitForSession', () => {
     const session: Session = {
       id: 'id',
-      state: '',
+      state: SessionState.NoState,
       links: [{ rel: 'state', href: '', uri: '', type: '', method: 'GET' }],
       attributes: {
         sessionInactiveTimeout: 0
       },
-      creationTimeStamp: ''
+      creationTimeStamp: '',
+      stateUrl: sessionStateLink,
+      etag: sessionEtag
     }
 
     beforeEach(() => {
       ;(process as any).logger = new Logger(LogLevel.Off)
     })
 
-    it('should reject with NoSessionStateError if SAS server did not provide session state', async () => {
+    it('should log http response code and session state if SAS server did not provide session state', async () => {
       let requestAttempt = 0
       const requestAttemptLimit = 10
       const sessionState = 'idle'
@@ -85,15 +139,17 @@ describe('SessionManager', () => {
         sessionManager['waitForSession'](session, null, 'access_token')
       ).resolves.toEqual(sessionState)
 
+      const sessionStateUrl = process.env.SERVER_URL + session.stateUrl
+
       expect(mockedAxios.get).toHaveBeenCalledTimes(requestAttemptLimit)
       expect((process as any).logger.info).toHaveBeenCalledTimes(3)
       expect((process as any).logger.info).toHaveBeenNthCalledWith(
         1,
-        `Polling: ${process.env.SERVER_URL}`
+        `Polling: ${sessionStateUrl}`
       )
       expect((process as any).logger.info).toHaveBeenNthCalledWith(
         2,
-        `Could not get session state. Server responded with 304 whilst checking state: ${process.env.SERVER_URL}`
+        `Could not get session state. Server responded with 304 whilst checking state: ${sessionStateUrl}`
       )
       expect((process as any).logger.info).toHaveBeenNthCalledWith(
         3,
@@ -103,7 +159,7 @@ describe('SessionManager', () => {
 
     it('should throw an error if there is no session link', async () => {
       const customSession = JSON.parse(JSON.stringify(session))
-      customSession.links = []
+      customSession.stateUrl = ''
 
       mockedAxios.get.mockImplementation(() =>
         Promise.resolve({ data: customSession.state, status: 200 })
@@ -115,11 +171,26 @@ describe('SessionManager', () => {
     })
 
     it('should throw an error if could not get session state', async () => {
-      mockedAxios.get.mockImplementation(() => Promise.reject('Mocked error'))
+      const gettingSessionStatus = 500
+      const sessionStatusError = `Getting session status timed out after 60 seconds. Request failed with status code ${gettingSessionStatus}`
+      const sessionStateUrl = process.env.SERVER_URL + session.stateUrl
+
+      mockedAxios.get.mockImplementation(() =>
+        Promise.reject({
+          response: {
+            status: gettingSessionStatus,
+            data: {
+              message: sessionStatusError
+            }
+          }
+        })
+      )
+
+      const expectedError = `Error while waiting for session. Error while getting session state. GET request to ${sessionStateUrl}?wait=30 failed with status code ${gettingSessionStatus}. ${sessionStatusError}`
 
       await expect(
         sessionManager['waitForSession'](session, null, 'access_token')
-      ).rejects.toContain('Error while getting session state.')
+      ).rejects.toEqual(expectedError)
     })
 
     it('should return session state', async () => {
@@ -135,4 +206,284 @@ describe('SessionManager', () => {
       ).resolves.toEqual(customSession.state)
     })
   })
+
+  describe('isSessionValid', () => {
+    const session: Session = getMockSession()
+
+    it('should return false if not a session provided', () => {
+      expect(sessionManager['isSessionValid'](undefined as any)).toEqual(false)
+    })
+
+    it('should return true if session is not expired', () => {
+      expect(sessionManager['isSessionValid'](session)).toEqual(true)
+    })
+
+    it('should return false if session is expired', () => {
+      session.creationTimeStamp = `${new Date(
+        new Date().getTime() -
+          (session.attributes.sessionInactiveTimeout * 1000 + 1000)
+      ).toISOString()}`
+      expect(sessionManager['isSessionValid'](session)).toEqual(false)
+    })
+  })
+
+  describe('removeSessionFromPool', () => {
+    it('should remove session from the pool of sessions', () => {
+      const session: Session = getMockSession()
+      const sessions: Session[] = [getMockSession(), session]
+
+      sessionManager['sessions'] = sessions
+      sessionManager['removeSessionFromPool'](session)
+
+      expect(sessionManager['sessions'].length).toEqual(1)
+    })
+  })
+
+  describe('getSession', () => {
+    it('should return session if there is a valid session and create new session', async () => {
+      jest
+        .spyOn(sessionManager as any, 'createAndWaitForSession')
+        .mockImplementation(async () => Promise.resolve(getMockSession()))
+
+      const session = getMockSession()
+      sessionManager['sessions'] = [session]
+
+      await expect(sessionManager.getSession()).resolves.toEqual(session)
+      expect(sessionManager['createAndWaitForSession']).toHaveBeenCalled()
+    })
+
+    it('should return a session and keep one session if there is no sessions available', async () => {
+      jest
+        .spyOn(sessionManager as any, 'createAndWaitForSession')
+        .mockImplementation(async () => {
+          const session = getMockSession()
+          sessionManager['sessions'].push(session)
+
+          return Promise.resolve(session)
+        })
+
+      const session = await sessionManager.getSession()
+
+      expect(Object.keys(session)).toEqual(Object.keys(getMockSession()))
+      expect(sessionManager['createAndWaitForSession']).toHaveBeenCalledTimes(2)
+      expect(sessionManager['sessions'].length).toEqual(1)
+    })
+
+    it.concurrent(
+      'should throw an error if session creation request returned 500',
+      async () => {
+        const sessionCreationStatus = 500
+        const sessionCreationError = `The process initialization for the Compute server with the ID 'ed40398a-ec8a-422b-867a-61493ee8a57f' timed out after 60 seconds. Request failed with status code ${sessionCreationStatus}`
+
+        jest.spyOn(requestClient, 'post').mockImplementation(() =>
+          Promise.reject({
+            response: {
+              status: sessionCreationStatus,
+              data: {
+                message: sessionCreationError
+              }
+            }
+          })
+        )
+
+        const contextId = 'testContextId'
+        const context: Context = {
+          name: 'testContext',
+          id: contextId,
+          createdBy: 'createdBy',
+          version: 1
+        }
+
+        sessionManager['currentContext'] = context
+
+        const expectedError = new Error(
+          `Error while creating session. POST request to ${process.env.SERVER_URL}/compute/contexts/${contextId}/sessions failed with status code ${sessionCreationStatus}. ${sessionCreationError}`
+        )
+
+        await expect(sessionManager.getSession()).rejects.toEqual(expectedError)
+      }
+    )
+  })
+
+  describe('clearSession', () => {
+    it('should clear session', async () => {
+      jest
+        .spyOn(requestClient, 'delete')
+        .mockImplementation(() =>
+          Promise.resolve({ result: '', etag: '', status: 200 })
+        )
+
+      const sessionToBeCleared = getMockSession()
+      const sessionToStay = getMockSession()
+
+      sessionManager['sessions'] = [sessionToBeCleared, sessionToStay]
+
+      await sessionManager.clearSession(sessionToBeCleared.id)
+
+      expect(sessionManager['sessions']).toEqual([sessionToStay])
+    })
+
+    it('should throw error if DELETE request failed', async () => {
+      const sessionCreationStatus = 500
+      const sessionDeleteError = `The process timed out after 60 seconds. Request failed with status code ${sessionCreationStatus}`
+
+      jest.spyOn(requestClient, 'delete').mockImplementation(() =>
+        Promise.reject({
+          response: {
+            status: sessionCreationStatus,
+            data: {
+              message: sessionDeleteError
+            }
+          }
+        })
+      )
+
+      const session = getMockSession()
+
+      sessionManager['sessions'] = [session]
+
+      const expectedError = `Error while deleting session. DELETE request to /compute/sessions/${session.id} failed with status code ${sessionCreationStatus}. ${sessionDeleteError}`
+
+      await expect(sessionManager.clearSession(session.id)).rejects.toEqual(
+        expectedError
+      )
+    })
+  })
+
+  describe('waitForCurrentContext', () => {
+    it('should resolve when current context is ready', async () => {
+      sessionManager['settingContext'] = true
+      sessionManager['contextName'] = 'test context'
+
+      await expect(sessionManager['waitForCurrentContext']()).toResolve()
+      expect(sessionManager['settingContext']).toEqual(false)
+    })
+  })
+
+  describe('setCurrentContext', () => {
+    it('should set current context', async () => {
+      const contextName = 'test context'
+      const testContext: Context = {
+        name: contextName,
+        id: 'string',
+        createdBy: 'string',
+        version: 1
+      }
+
+      jest.spyOn(requestClient, 'get').mockImplementation(() => {
+        return Promise.resolve({
+          result: {
+            items: [testContext]
+          },
+          etag: '',
+          status: 200
+        })
+      })
+
+      sessionManager['currentContext'] = null
+      sessionManager['contextName'] = contextName
+      sessionManager['settingContext'] = false
+
+      await expect(sessionManager['setCurrentContext']()).toResolve()
+      expect(sessionManager['currentContext']).toEqual(testContext)
+    })
+
+    it('should throw error if GET request failed', async () => {
+      const responseStatus = 500
+      const responseErrorMessage = `The process timed out after 60 seconds. Request failed with status code ${responseStatus}`
+      const response = {
+        status: responseStatus,
+        data: {
+          message: responseErrorMessage
+        }
+      }
+
+      jest.spyOn(requestClient, 'get').mockImplementation(() =>
+        Promise.reject({
+          response
+        })
+      )
+
+      const expectedError = `Error while getting list of contexts. GET request to ${process.env.SERVER_URL}/compute/contexts?limit=10000 failed with status code ${responseStatus}. ${responseErrorMessage}`
+
+      sessionManager['currentContext'] = null
+
+      await expect(sessionManager['setCurrentContext']()).rejects.toEqual(
+        expectedError
+      )
+    })
+
+    it('should throw an error if current context is not in the list of contexts', async () => {
+      const contextName = 'test context'
+      const testContext: Context = {
+        name: `${contextName} does not exist`,
+        id: 'string',
+        createdBy: 'string',
+        version: 1
+      }
+
+      jest.spyOn(requestClient, 'get').mockImplementation(() => {
+        return Promise.resolve({
+          result: {
+            items: [testContext]
+          },
+          etag: '',
+          status: 200
+        })
+      })
+
+      sessionManager['currentContext'] = null
+      sessionManager['contextName'] = contextName
+      sessionManager['settingContext'] = false
+
+      const expectedError = new Error(
+        `The context '${contextName}' was not found on the server ${process.env.SERVER_URL}.`
+      )
+
+      await expect(sessionManager['setCurrentContext']()).rejects.toEqual(
+        expectedError
+      )
+    })
+  })
+
+  describe('createAndWaitForSession', () => {
+    it('should create session with etag and stateUrl', async () => {
+      const etag = sessionEtag
+      const customSession: any = getMockSession()
+      delete customSession.etag
+      delete customSession.stateUrl
+
+      jest.spyOn(requestClient, 'post').mockImplementation(() =>
+        Promise.resolve({
+          result: customSession,
+          etag
+        })
+      )
+
+      jest
+        .spyOn(sessionManager as any, 'setCurrentContext')
+        .mockImplementation(() => Promise.resolve())
+
+      sessionManager['currentContext'] = {
+        name: 'context name',
+        id: 'string',
+        createdBy: 'string',
+        version: 1
+      }
+
+      jest
+        .spyOn(sessionManager as any, 'getSessionState')
+        .mockImplementation(() =>
+          Promise.resolve({ result: SessionState.Idle, responseStatus: 200 })
+        )
+
+      const expectedSession = await sessionManager['createAndWaitForSession']()
+
+      expect(customSession.id).toEqual(expectedSession.id)
+      expect(
+        customSession.links.find((l: any) => l.rel === 'state').href
+      ).toEqual(expectedSession.stateUrl)
+      expect(expectedSession.etag).toEqual(etag)
+    })
+  })
 })

src/types/PollOptions.ts

@@ -1,6 +1,9 @@
 export interface PollOptions {
   maxPollCount: number
-  pollInterval: number
+  pollInterval: number // milliseconds
-  streamLog: boolean
+  pollStrategy?: PollStrategy
+  streamLog?: boolean
   logFolderPath?: string
 }
+
+export type PollStrategy = PollOptions[]

src/types/RequestClient.ts

@@ -0,0 +1,55 @@
+import { CsrfToken } from '..'
+
+export interface HttpClient {
+  get<T>(
+    url: string,
+    accessToken: string | undefined,
+    contentType: string,
+    overrideHeaders: { [key: string]: string | number }
+  ): Promise<{ result: T; etag: string }>
+
+  post<T>(
+    url: string,
+    data: any,
+    accessToken: string | undefined,
+    contentType: string,
+    overrideHeaders: { [key: string]: string | number }
+  ): Promise<{ result: T; etag: string }>
+
+  put<T>(
+    url: string,
+    data: any,
+    accessToken: string | undefined,
+    overrideHeaders: { [key: string]: string | number }
+  ): Promise<{ result: T; etag: string }>
+
+  delete<T>(
+    url: string,
+    accessToken: string | undefined
+  ): Promise<{ result: T; etag: string }>
+
+  getCsrfToken(type: 'general' | 'file'): CsrfToken | undefined
+  saveLocalStorageToken(accessToken: string, refreshToken: string): void
+  clearCsrfTokens(): void
+  clearLocalStorageTokens(): void
+  getBaseUrl(): string
+}
+
+export interface SASjsRequest {
+  serviceLink: string
+  timestamp: Date
+  sourceCode: string
+  generatedCode: string
+  logFile: string
+  SASWORK: any
+}
+
+export interface SasjsParsedResponse<T> {
+  result: T
+  log: string
+  etag: string
+  status: number
+  printOutput?: string
+}
+
+export type VerboseMode = boolean | 'bleached'

src/types/SASjsConfig.ts

@@ -1,5 +1,6 @@
 import * as https from 'https'
 import { ServerType } from '@sasjs/utils/types'
+import { VerboseMode } from '../types'
 
 /**
  * Specifies the configuration for the SASjs instance - eg where and how to
@@ -45,6 +46,10 @@ export class SASjsConfig {
    * Set to `true` to enable additional debugging.
    */
   debug: boolean = true
+  /**
+   * Set to `true` to enable verbose mode that will log a summary of every HTTP response.
+   */
+  verbose?: VerboseMode = true
   /**
    * The name of the compute context to use when calling the Viya services directly.
    * Example value: 'SAS Job Execution compute context'

src/types/SASjsRequest.ts

@@ -1,12 +0,0 @@
-/**
- * Represents a SASjs request, its response and logs.
- *
- */
-export interface SASjsRequest {
-  serviceLink: string
-  timestamp: Date
-  sourceCode: string
-  generatedCode: string
-  logFile: string
-  SASWORK: any
-}

src/types/Session.ts

@@ -1,15 +1,34 @@
 import { Link } from './Link'
+import { SessionManager } from '../SessionManager'
+
+export enum SessionState {
+  Completed = 'completed',
+  Running = 'running',
+  Pending = 'pending',
+  Idle = 'idle',
+  Unavailable = 'unavailable',
+  NoState = '',
+  Failed = 'failed',
+  Error = 'error'
+}
 
 export interface Session {
   id: string
-  state: string
+  state: SessionState
+  stateUrl: string
   links: Link[]
   attributes: {
     sessionInactiveTimeout: number
   }
   creationTimeStamp: string
+  etag: string
 }
 
 export interface SessionVariable {
   value: string
 }
+
+export interface JobSessionManager {
+  session: Session
+  sessionManager: SessionManager
+}

src/types/errors/ErrorResponse.ts

@@ -21,8 +21,8 @@ export class ErrorResponse {
   }
 }
 
-interface ErrorBody {
+export interface ErrorBody {
   message: string
-  details: string
+  details: any
   raw: any
 }

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)

src/types/index.ts

@@ -6,10 +6,12 @@ export * from './Job'
 export * from './JobDefinition'
 export * from './JobResult'
 export * from './Link'
+export * from './Login'
 export * from './SASjsConfig'
-export * from './SASjsRequest'
+export * from './RequestClient'
 export * from './Session'
 export * from './UploadFile'
 export * from './PollOptions'
 export * from './WriteStream'
 export * from './ExecuteScript'
+export * from './errors'

src/utils/compareTimestamps.ts

@@ -1,4 +1,4 @@
-import { SASjsRequest } from '../types/SASjsRequest'
+import { SASjsRequest } from '../types'
 
 /**
  * Comparator for SASjs request timestamps.