Merge pull request #549 from sasjs/improvements-file-uploader

fix: FileUploader extends BaseJobExecutor

.all-contributorsrc

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

.git-hooks/commit-msg

@@ -0,0 +1,18 @@
+#!/bin/sh
+RED="\033[1;31m"
+GREEN="\033[1;32m"
+
+# Get the commit message (the parameter we're given is just the path to the
+# temporary file which holds the message).
+commit_message=$(cat "$1")
+
+if (echo "$commit_message" | grep -Eq "^(build|chore|ci|docs|feat|fix|perf|refactor|revert|style|test)(\([a-z0-9 -\*]+\))?!?: .+$") then
+   echo "${GREEN} ✔ Commit message meets Conventional Commit standards"
+   exit 0
+fi
+
+echo "${RED}❌ Commit message does not meet the Conventional Commit standard!"
+echo "An example of a valid message is:"
+echo "  feat(login): add the 'remember me' button"
+echo "ℹ More details at: https://www.conventionalcommits.org/en/v1.0.0/#summary"
+exit 1

.github/dependabot.yml

@@ -0,0 +1,7 @@
+version: 2
+updates:
+- package-ecosystem: npm
+  directory: "/"
+  schedule:
+    interval: daily
+  open-pull-requests-limit: 10

.github/reviewer-lottery.yml

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

.github/workflows/build.yml

@@ -13,7 +13,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [12.x]
+        node-version: [15.x]
 
     steps:
       - uses: actions/checkout@v2
@@ -27,6 +27,10 @@ jobs:
         run: npm run lint
       - name: Run unit tests
         run: npm test
+      - name: Generate coverage report
+        uses: artiomtr/jest-coverage-report-action@v2.0-rc.2
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
       - name: Build Package
         run: npm run package:lib
         env:

.npmignore

@@ -0,0 +1,5 @@
+sasjs-tests/
+docs/
+.github/
+*.md
+*.spec.ts

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Change Log
 
+Since March 2020 the changelog is managed by github releases - see [https://github.com/sasjs/adapter/releases](https://github.com/sasjs/adapter/releases).
+
+## Changes up to 5th March 2020
+
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
 <a name="1.9.0"></a>

CODE_OF_CONDUCT.md

@@ -2,75 +2,127 @@
 
 ## Our Pledge
 
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, sex characteristics, gender identity and expression,
-level of experience, education, socio-economic status, nationality, personal
-appearance, race, religion, or sexual identity and orientation.
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
 
 ## Our Standards
 
-Examples of behavior that contributes to creating a positive environment
-include:
+Examples of behavior that contributes to a positive environment for our
+community include:
 
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
 
-Examples of unacceptable behavior by participants include:
+Examples of unacceptable behavior include:
 
-* The use of sexualized language or imagery and unwelcome sexual attention or
- advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
 * Public or private harassment
-* Publishing others' private information, such as a physical or electronic
- address, without explicit permission
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
 * Other conduct which could reasonably be considered inappropriate in a
- professional setting
+  professional setting
 
-## Our Responsibilities
+## Enforcement Responsibilities
 
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
 
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
 
 ## Scope
 
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
 
 ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at support@macropeople.com. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
+reported to the community leaders responsible for enforcement at
+https://sasapps.io/contact-us.
+All complaints will be reviewed and investigated promptly and fairly.
 
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
 
 ## Attribution
 
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
 
 [homepage]: https://www.contributor-covenant.org
 
-For answers to common questions about this code of conduct, see
-https://www.contributor-covenant.org/faq
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 Macro People
+Copyright (c) 2021 Macro People
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

PULL_REQUEST_TEMPLATE.md

@@ -12,7 +12,9 @@ What code changes have been made to achieve the intent.
 
 ## Checks
 
-- [ ] Code is formatted correctly (`npm run lint:fix`).
-- [ ] All unit tests are passing (`npm test`).
+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.
+
+
 - [ ] All `sasjs-cli` unit tests are passing (`npm test`).
 - [ ] All `sasjs-tests` are passing (instructions available [here](https://github.com/sasjs/adapter/blob/master/sasjs-tests/README.md)).
+- [ ] [Data Controller](https://datacontroller.io) builds and is functional on both SAS 9 and Viya

README.md

@@ -1,7 +1,23 @@
-[![](https://data.jsdelivr.com/v1/package/npm/@sasjs/adapter/badge)](https://www.jsdelivr.com/package/npm/@sasjs/adapter)
-
 # @sasjs/adapter
 
+[![npm package][npm-image]][npm-url]
+[![Github Workflow][githubworkflow-image]][githubworkflow-url]
+[![Dependency Status][dependency-image]][dependency-url]
+[![npm](https://img.shields.io/npm/dt/@sasjs/adapter)]()
+![Snyk Vulnerabilities for npm package](https://img.shields.io/snyk/vulnerabilities/npm/@sasjs/adapter)
+[![License](https://img.shields.io/apm/l/atomic-design-ui.svg)](/LICENSE)
+![GitHub top language](https://img.shields.io/github/languages/top/sasjs/adapter)
+![GitHub issues](https://img.shields.io/github/issues/sasjs/adapter)
+[![Gitpod ready-to-code](https://img.shields.io/badge/Gitpod-ready--to--code-908a85?logo=gitpod)](https://gitpod.io/#https://github.com/sasjs/adapter)
+
+
+[npm-image]:https://img.shields.io/npm/v/@sasjs/adapter.svg
+[npm-url]:http://npmjs.org/package/@sasjs/adapter
+[githubworkflow-image]:https://github.com/sasjs/adapter/actions/workflows/build.yml/badge.svg
+[githubworkflow-url]:https://github.com/sasjs/adapter/blob/main/.github/workflows/build.yml
+[dependency-image]:https://david-dm.org/sasjs/adapter.svg
+[dependency-url]:https://github.com/sasjs/adapter/blob/main/package.json
+
 SASjs is a open-source framework for building Web Apps on SAS® platforms. You can use as much or as little of it as you like. This repository contains the JS adapter, the part that handles the to/from SAS communication on the client side. There are 3 ways to install it:
 
 1 - `npm install @sasjs/adapter` - for use in a node project
@@ -156,35 +172,43 @@ Configuration on the client side involves passing an object on startup, which ca
 * `serverType` - either `SAS9` or `SASVIYA`.
 * `serverUrl` - the location (including http protocol and port) of the SAS Server. Can be omitted, eg if serving directly from the SAS Web Server, or in streaming mode.
 * `debug` - if `true` then SAS Logs and extra debug information is returned.
-* `useComputeApi` - if `true` and the serverType is `SASVIYA` then the REST APIs will be called directly (rather than using the JES web service).
-* `contextName` - if missing or blank, and `useComputeApi` is `true` and `serverType` is `SASVIYA` then the JES API will be used.
+* `useComputeApi` - Only relevant when the serverType is `SASVIYA`. If `true` the [Compute API](#using-the-compute-api) is used.  If `false` the [JES API](#using-the-jes-api) is used.  If `null` or `undefined` the [Web](#using-jes-web-app) approach is used.
+* `contextName` - Compute context on which the requests will be called.  If missing or not provided, defaults to `Job Execution Compute context`.
 
 The adapter supports a number of approaches for interfacing with Viya (`serverType` is `SASVIYA`).  For maximum performance, be sure to [configure your compute context](https://sasjs.io/guide-viya/#shared-account-and-server-re-use) with `reuseServerProcesses` as `true` and a system account in `runServerAs`.  This functionality is available since Viya 3.5.  This configuration is supported when [creating contexts using the CLI](https://sasjs.io/sasjs-cli-context/#sasjs-context-create).
 
 ### Using JES Web App
 
-In this setup, all requests are routed through the JES web app, at `YOURSERVER/SASJobExecution`.  This is the most reliable method, and also the slowest.  One request is made to the JES app, and remaining requests (getting job uri, session spawning, passing parameters, running the program, fetching the log) are made on the SAS server by the JES app.
-
-```
-{
-  appLoc:"/Your/Path",
-  serverType:"SASVIYA"
-}
-```
-
-### Using the JES API
-Here we are running Jobs using the Job Execution Service except this time we are making the requests directly using the REST API instead of through the JES Web App.  This is helpful when we need to call web services outside of a browser (eg with the SASjs CLI or other commandline tools).  To save one network request, the adapter prefetches the JOB URIs and passes them in the `__job` parameter.
+In this setup, all requests are routed through the JES web app, at `YOURSERVER/SASJobExecution?_program=/your/program`.  This is the most reliable method, and also the slowest.  One request is made to the JES app, and remaining requests (getting job uri, session spawning, passing parameters, running the program, fetching the log) are handled by the SAS server inside the JES app.
 
 ```
 {
   appLoc:"/Your/Path",
   serverType:"SASVIYA",
-  useComputeApi: true
+  contextName: 'yourComputeContext'
+}
+```
+
+Note - to use the web approach, the `useComputeApi` property must be `undefined` or `null`.
+
+### Using the JES API
+Here we are running Jobs using the Job Execution Service except this time we are making the requests directly using the REST API instead of through the JES Web App.  This is helpful when we need to call web services outside of a browser (eg with the SASjs CLI or other commandline tools).  To save one network request, the adapter prefetches the JOB URIs and passes them in the `__job` parameter.  Depending on your network bandwidth, it may or may not be faster than the JES Web approach.
+
+This approach (`useComputeApi: false`) also ensures that jobs are displayed in Environment Manager.
+
+```
+{
+  appLoc:"/Your/Path",
+  serverType:"SASVIYA",
+  useComputeApi: false,
+  contextName: 'yourComputeContext'
 }
 ```
 
 ### Using the Compute API
-This approach is by far the fastest, as a result of the optimisations we have built into the adapter.  With this configuration, in the first sasjs request, we take a URI map of the services in the target folder, and create a session manager - which spawns an extra session.  The next time a request is made, the adapter will use the 'hot' session.  Sessions are deleted after every use, which actually makes this _less_ resource intensive than a typical JES web app, in which all sessions are kept alive by default for 15 minutes.
+This approach is by far the fastest, as a result of the optimisations we have built into the adapter.  With this configuration, in the first sasjs request, we take a URI map of the services in the target folder, and create a session manager.  This manager will spawn a additional session every time a request is made. Subsequent requests will use the existing 'hot' session, if it exists.  Sessions are always deleted after every use, which actually makes this _less_ resource intensive than a typical JES web app, in which all sessions are kept alive by default for 15 minutes.
+
+With this approach (`useComputeApi: true`), the requests/logs will _not_ appear in the list in Environment manager.
 
 ```
 {
@@ -198,8 +222,44 @@ This approach is by far the fastest, as a result of the optimisations we have bu
 
 # More resources
 
-For more information and examples specific to this adapter you can check out the [user guide](https://sasjs.io/sasjs-adapter/) or the [technical](http://adapter.sasjs.io/) documentation. 
+For more information and examples specific to this adapter you can check out the [user guide](https://sasjs.io/sasjs-adapter/) or the [technical](http://adapter.sasjs.io/) documentation.
 
 For more information on building web apps in general, check out these [resources](https://sasjs.io/training/resources/) or contact the [author](https://www.linkedin.com/in/allanbowe/) directly.
 
 If you are a SAS 9 or SAS Viya customer you can also request a copy of [Data Controller](https://datacontroller.io) - free for up to 5 users, this tool makes use of all parts of the SASjs framework.
+
+
+## Star Gazing
+
+If you find this library useful, help us grow our star graph!
+
+![](https://starchart.cc/sasjs/adapter.svg)
+
+## Contributors ✨
+<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
+[![All Contributors](https://img.shields.io/badge/all_contributors-7-orange.svg?style=flat-square)](#contributors-)
+<!-- ALL-CONTRIBUTORS-BADGE:END -->
+
+Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
+
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+<table>
+  <tr>
+    <td align="center"><a href="https://krishna-acondy.io/"><img src="https://avatars.githubusercontent.com/u/2980428?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Krishna Acondy</b></sub></a><br /><a href="https://github.com/sasjs/adapter/commits?author=krishna-acondy" title="Code">💻</a> <a href="#infra-krishna-acondy" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="#blog-krishna-acondy" title="Blogposts">📝</a> <a href="#content-krishna-acondy" title="Content">🖋</a> <a href="#ideas-krishna-acondy" title="Ideas, Planning, & Feedback">🤔</a> <a href="#video-krishna-acondy" title="Videos">📹</a></td>
+    <td align="center"><a href="https://www.erudicat.com/"><img src="https://avatars.githubusercontent.com/u/25773492?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Yury Shkoda</b></sub></a><br /><a href="https://github.com/sasjs/adapter/commits?author=YuryShkoda" title="Code">💻</a> <a href="#infra-YuryShkoda" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="#ideas-YuryShkoda" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/sasjs/adapter/commits?author=YuryShkoda" title="Tests">⚠️</a> <a href="#video-YuryShkoda" title="Videos">📹</a></td>
+    <td align="center"><a href="https://github.com/medjedovicm"><img src="https://avatars.githubusercontent.com/u/18329105?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Mihajlo Medjedovic</b></sub></a><br /><a href="https://github.com/sasjs/adapter/commits?author=medjedovicm" title="Code">💻</a> <a href="#infra-medjedovicm" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="https://github.com/sasjs/adapter/commits?author=medjedovicm" title="Tests">⚠️</a> <a href="https://github.com/sasjs/adapter/pulls?q=is%3Apr+reviewed-by%3Amedjedovicm" title="Reviewed Pull Requests">👀</a></td>
+    <td align="center"><a href="https://github.com/allanbowe"><img src="https://avatars.githubusercontent.com/u/4420615?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Allan Bowe</b></sub></a><br /><a href="https://github.com/sasjs/adapter/commits?author=allanbowe" title="Code">💻</a> <a href="https://github.com/sasjs/adapter/pulls?q=is%3Apr+reviewed-by%3Aallanbowe" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/sasjs/adapter/commits?author=allanbowe" title="Tests">⚠️</a> <a href="#mentoring-allanbowe" title="Mentoring">🧑‍🏫</a> <a href="#maintenance-allanbowe" title="Maintenance">🚧</a></td>
+    <td align="center"><a href="https://github.com/saadjutt01"><img src="https://avatars.githubusercontent.com/u/8914650?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Muhammad Saad </b></sub></a><br /><a href="https://github.com/sasjs/adapter/commits?author=saadjutt01" title="Code">💻</a> <a href="https://github.com/sasjs/adapter/pulls?q=is%3Apr+reviewed-by%3Asaadjutt01" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/sasjs/adapter/commits?author=saadjutt01" title="Tests">⚠️</a> <a href="#mentoring-saadjutt01" title="Mentoring">🧑‍🏫</a> <a href="#infra-saadjutt01" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a></td>
+    <td align="center"><a href="https://github.com/sabhas"><img src="https://avatars.githubusercontent.com/u/82647447?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Sabir Hassan</b></sub></a><br /><a href="https://github.com/sasjs/adapter/commits?author=sabhas" title="Code">💻</a> <a href="https://github.com/sasjs/adapter/pulls?q=is%3Apr+reviewed-by%3Asabhas" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/sasjs/adapter/commits?author=sabhas" title="Tests">⚠️</a> <a href="#ideas-sabhas" title="Ideas, Planning, & Feedback">🤔</a></td>
+    <td align="center"><a href="https://github.com/VladislavParhomchik"><img src="https://avatars.githubusercontent.com/u/83717836?v=4?s=100" width="100px;" alt=""/><br /><sub><b>VladislavParhomchik</b></sub></a><br /><a href="https://github.com/sasjs/adapter/commits?author=VladislavParhomchik" title="Tests">⚠️</a> <a href="https://github.com/sasjs/adapter/pulls?q=is%3Apr+reviewed-by%3AVladislavParhomchik" title="Reviewed Pull Requests">👀</a></td>
+  </tr>
+</table>
+
+<!-- markdownlint-restore -->
+<!-- prettier-ignore-end -->
+
+<!-- ALL-CONTRIBUTORS-LIST:END -->
+
+This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

checkNodeVersion.js

@@ -0,0 +1,16 @@
+const result = process.versions
+if (result && result.node) {
+  if (parseInt(result.node) < 14) {
+    console.log(
+      '\x1b[31m%s\x1b[0m',
+      `❌ Process failed due to Node Version,\nPlease install and use Node Version >= 14\nYour current Node Version is: ${result.node}`
+    )
+    process.exit(1)
+  }
+} else {
+  console.log(
+    '\x1b[31m%s\x1b[0m',
+    'Something went wrong while checking Node version'
+  )
+  process.exit(1)
+}

package.json

@@ -1,17 +1,21 @@
 {
   "name": "@sasjs/adapter",
   "description": "JavaScript adapter for SAS",
+  "homepage": "https://adapter.sasjs.io",
   "scripts": {
-    "build": "rimraf build && rimraf node && mkdir node && cp -r src/* node && webpack && rimraf build/src && rimraf node",
-    "package:lib": "npm run build && cp ./package.json build && cd build && npm version \"5.0.0\" && npm pack",
+    "preinstall": "node checkNodeVersion",
+    "prebuild": "node checkNodeVersion",
+    "build": "rimraf build && rimraf node && mkdir node && copyfiles -u 1 \"./src/**/*\" ./node && webpack && rimraf build/src && rimraf node",
+    "package:lib": "npm run build && copyfiles ./package.json ./checkNodeVersion.js build && cd build && npm version \"5.0.0\" && npm pack",
     "publish:lib": "npm run build && cd build && npm publish",
-    "lint:fix": "npx prettier --write 'src/**/*.{ts,tsx,js,jsx,html,css,sass,less,json,yml,md,graphql}'",
-    "lint": "npx prettier --check 'src/**/*.{ts,tsx,js,jsx,html,css,sass,less,json,yml,md,graphql}'",
+    "lint:fix": "npx prettier --write \"src/**/*.{ts,tsx,js,jsx,html,css,sass,less,json,yml,md,graphql}\" && npx prettier --write \"sasjs-tests/src/**/*.{ts,tsx,js,jsx,html,css,sass,less,json,yml,md,graphql}\"",
+    "lint": "npx prettier --check \"src/**/*.{ts,tsx,js,jsx,html,css,sass,less,json,yml,md,graphql}\" && npx prettier --check \"sasjs-tests/src/**/*.{ts,tsx,js,jsx,html,css,sass,less,json,yml,md,graphql}\"",
     "test": "jest --silent --coverage",
     "prepublishOnly": "cp -r ./build/* . && rm -rf ./build",
     "postpublish": "git clean -fd",
     "semantic-release": "semantic-release",
-    "typedoc": "typedoc"
+    "typedoc": "typedoc",
+    "prepare": "git rev-parse --git-dir && git config core.hooksPath ./.git-hooks && git config core.autocrlf false || true"
   },
   "publishConfig": {
     "access": "public"
@@ -36,31 +40,40 @@
   },
   "license": "ISC",
   "devDependencies": {
-    "@types/jest": "^26.0.22",
+    "@types/axios": "^0.14.0",
+    "@types/form-data": "^2.5.0",
+    "@types/jest": "^27.0.1",
+    "@types/mime": "^2.0.3",
+    "@types/tough-cookie": "^4.0.1",
+    "copyfiles": "^2.4.1",
     "cp": "^0.2.0",
-    "dotenv": "^8.2.0",
-    "jest": "^26.6.3",
+    "dotenv": "^10.0.0",
+    "jest": "^27.1.0",
     "jest-extended": "^0.11.5",
+    "node-polyfill-webpack-plugin": "^1.1.4",
     "path": "^0.12.7",
+    "process": "^0.11.10",
     "rimraf": "^3.0.2",
-    "semantic-release": "^17.4.2",
-    "terser-webpack-plugin": "^4.2.3",
-    "ts-jest": "^25.5.1",
-    "ts-loader": "^8.1.0",
+    "semantic-release": "^17.4.7",
+    "terser-webpack-plugin": "^5.2.0",
+    "ts-jest": "^27.0.3",
+    "ts-loader": "^9.2.2",
     "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.18.0",
-    "typedoc": "^0.20.35",
-    "typedoc-neo-theme": "^1.1.0",
+    "typedoc": "^0.21.9",
+    "typedoc-neo-theme": "^1.1.1",
     "typedoc-plugin-external-module-name": "^4.0.6",
-    "typescript": "^3.9.9",
-    "webpack": "^5.33.2",
-    "webpack-cli": "^4.5.0"
+    "typescript": "4.3.5",
+    "webpack": "^5.44.0",
+    "webpack-cli": "^4.7.2"
   },
   "main": "index.js",
   "dependencies": {
-    "@sasjs/utils": "^2.10.2",
+    "@sasjs/utils": "^2.30.0",
     "axios": "^0.21.1",
+    "axios-cookiejar-support": "^1.0.1",
     "form-data": "^4.0.0",
-    "https": "^1.0.0"
+    "https": "^1.0.0",
+    "tough-cookie": "^4.0.0"
   }
 }

sasjs-tests/.prettierrc

@@ -1,6 +1,6 @@
 {
   "trailingComma": "none",
   "tabWidth": 2,
-  "semi": true,
-  "singleQuote": false
+  "semi": false,
+  "singleQuote": true
 }

sasjs-tests/README.md

@@ -6,7 +6,7 @@ When developing on `@sasjs/adapter`, it's good practice to run the test suite ag
 
 You can use the provided `update:adapter` NPM script for this.
 
-```
+```bash
     npm run update:adapter
 ```
 
@@ -37,10 +37,23 @@ To be able to run the `deploy` script, two environment variables need to be set:
 
 So you can run the script like so:
 
-```
+```bash
 SSH_ACCOUNT=me@my-sas-server.com DEPLOY_PATH=/var/www/html/my-folder/sasjs-tests npm run deploy
 ```
 
+If you are on `WINDOWS`, you will first need to install one dependency:
+```bash
+npm i -g copyfiles
+```
+and then run to build:
+```bash
+npm run update:adapter && npm run build 
+```
+when it finishes run to deploy:
+```bash
+scp -rp ./build/* me@my-sas-server.com:/var/www/html/my-folder/sasjs-tests
+```
+
 If you'd like to deploy just `sasjs-tests` without changing the adapter version, you can use the `deploy:tests` script, while also setting the same environment variables as above.
 
 ## 3. Creating the required SAS services
@@ -49,12 +62,12 @@ The below services need to be created on your SAS server, at the location specif
 
 ### SAS 9
 
-```
-
+```sas
 filename mc url "https://raw.githubusercontent.com/sasjs/core/main/all.sas";
 %inc mc;
 filename ft15f001 temp;
 parmcards4;
+  %webout(FETCH)
   %webout(OPEN)
   %macro x();
   %do i=1 %to &_webin_file_count; %webout(OBJ,&&_webin_name&i) %end;
@@ -63,6 +76,7 @@ parmcards4;
 ;;;;
 %mm_createwebservice(path=/Public/app/common,name=sendObj)
 parmcards4;
+  %webout(FETCH)
   %webout(OPEN)
   %macro x();
   %do i=1 %to &_webin_file_count; %webout(ARR,&&_webin_name&i) %end;
@@ -70,11 +84,24 @@ parmcards4;
   %webout(CLOSE)
 ;;;;
 %mm_createwebservice(path=/Public/app/common,name=sendArr)
+parmcards4;
+let he who hath understanding, reckon the number of the beast
+;;;;
+%mm_createwebservice(path=/Public/app/common,name=makeErr)
+parmcards4;
+%webout(OPEN)
+data _null_;
+  file _webout;
+  put ' the discovery channel ';
+ run;
+%webout(CLOSE)
+;;;;
+%mm_createwebservice(path=/Public/app/common,name=invalidJSON)
 ```
 
 ### SAS Viya
 
-```
+```sas
 filename mc url "https://raw.githubusercontent.com/sasjs/core/main/all.sas";
 %inc mc;
 filename ft15f001 temp;
@@ -113,6 +140,15 @@ If you can trust yourself when all men doubt you,
     But make allowance for their doubting too;
 ;;;;
 %mp_createwebservice(path=/Public/app/common,name=makeErr)
+parmcards4;
+%webout(OPEN)
+data _null_;
+  file _webout;
+  put ' the discovery channel ';
+ run;
+%webout(CLOSE)
+;;;;
+%mp_createwebservice(path=/Public/app/common,name=invalidJSON)
 ```
 
 You should now be able to access the tests in your browser at the deployed path on your server.

sasjs-tests/package-lock.json

@@ -2005,23 +2005,40 @@
     },
     "@sasjs/adapter": {
       "version": "file:../build/sasjs-adapter-5.0.0.tgz",
-      "integrity": "sha512-1t+3LIL2BFw8HpZUPI9QM24801+JH4DCAu4eHoLLmytYhN72asMi1aVtgSDb1xiJYgpbTG7EK3qRpHIV8cEN8w==",
+      "integrity": "sha512-mK8jwmu3QR4l1MI6wcLTcJyjMKfC3OnLwdcyCUCvECPyVDSTYLPGsWru8yPfe9z6G/bmsMbOFGfjCauzMTKCyA==",
       "requires": {
-        "@sasjs/utils": "^2.5.0",
+        "@sasjs/utils": "^2.27.1",
         "axios": "^0.21.1",
-        "form-data": "^3.0.0",
-        "https": "^1.0.0"
+        "axios-cookiejar-support": "^1.0.1",
+        "form-data": "^4.0.0",
+        "https": "^1.0.0",
+        "tough-cookie": "^4.0.0"
       },
       "dependencies": {
         "form-data": {
-          "version": "3.0.1",
-          "resolved": "https://registry.npmjs.org/form-data/-/form-data-3.0.1.tgz",
-          "integrity": "sha512-RHkBKtLWUVwd7SqRIvCZMEvAMoGUp0XU+seQiZejj0COz3RI3hWP4sCv3gZWWLjJTd7rGwcsF5eKZGii0r/hbg==",
+          "version": "4.0.0",
+          "resolved": "https://registry.npmjs.org/form-data/-/form-data-4.0.0.tgz",
+          "integrity": "sha512-ETEklSGi5t0QMZuiXoA/Q6vcnxcLQP5vdugSpuAyi6SVGi2clPPp+xgEhuMaHC+zGgn31Kd235W35f7Hykkaww==",
           "requires": {
             "asynckit": "^0.4.0",
             "combined-stream": "^1.0.8",
             "mime-types": "^2.1.12"
           }
+        },
+        "tough-cookie": {
+          "version": "4.0.0",
+          "resolved": "https://registry.npmjs.org/tough-cookie/-/tough-cookie-4.0.0.tgz",
+          "integrity": "sha512-tHdtEpQCMrc1YLrMaqXXcj6AxhYi/xgit6mZu1+EDWUn+qhUf8wMQoFIy9NXuq23zAwtcB0t/MjACGR18pcRbg==",
+          "requires": {
+            "psl": "^1.1.33",
+            "punycode": "^2.1.1",
+            "universalify": "^0.1.2"
+          }
+        },
+        "universalify": {
+          "version": "0.1.2",
+          "resolved": "https://registry.npmjs.org/universalify/-/universalify-0.1.2.tgz",
+          "integrity": "sha512-rBJeI5CXAlmy1pV+617WB9J63U6XcazHHF2f2dbJix4XzpUF0RS3Zbj0FGIOCAva5P/d/GBOYaACQ1w+0azUkg=="
         }
       }
     },
@@ -2036,24 +2053,95 @@
         "react-highlight.js": "^1.0.7",
         "semantic-ui-css": "^2.4.1",
         "semantic-ui-react": "^1.0.0"
-      },
-      "dependencies": {
-        "immer": {
-          "version": "7.0.7",
-          "resolved": "https://registry.npmjs.org/immer/-/immer-7.0.7.tgz",
-          "integrity": "sha512-Q8yYwVADJXrNfp1ZUAh4XDHkcoE3wpdpb4mC5abDSajs2EbW8+cGdPyAnglMyLnm7EF6ojD2xBFX7L5i4TIytw=="
-        }
       }
     },
     "@sasjs/utils": {
-      "version": "2.5.1",
-      "resolved": "https://registry.npmjs.org/@sasjs/utils/-/utils-2.5.1.tgz",
-      "integrity": "sha512-a3ISiUX8Yz7au4XYxq2KWf9ODT6nsIDbE4FEqS+AQ3McxZkfuAk4v+REXjOmIlcyQd4R4bufEK8XoB6AROn9sA==",
+      "version": "2.28.0",
+      "resolved": "https://registry.npmjs.org/@sasjs/utils/-/utils-2.28.0.tgz",
+      "integrity": "sha512-aZAbBDSjvW2TCY1lkuGqqiyWtR4W8GFpCNCUKa72VIkl4zwTE/pnSHQ+v8QilGDSHSPbPEsJGaBaldMGwoI12w==",
       "requires": {
-        "@types/prompts": "^2.0.9",
+        "@types/fs-extra": "^9.0.11",
+        "@types/prompts": "^2.0.13",
+        "chalk": "^4.1.1",
+        "cli-table": "^0.3.6",
         "consola": "^2.15.0",
-        "prompts": "^2.4.0",
+        "fs-extra": "^10.0.0",
+        "jwt-decode": "^3.1.2",
+        "prompts": "^2.4.1",
+        "rimraf": "^3.0.2",
         "valid-url": "^1.0.9"
+      },
+      "dependencies": {
+        "ansi-styles": {
+          "version": "4.3.0",
+          "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz",
+          "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==",
+          "requires": {
+            "color-convert": "^2.0.1"
+          }
+        },
+        "chalk": {
+          "version": "4.1.2",
+          "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.2.tgz",
+          "integrity": "sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA==",
+          "requires": {
+            "ansi-styles": "^4.1.0",
+            "supports-color": "^7.1.0"
+          }
+        },
+        "color-convert": {
+          "version": "2.0.1",
+          "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz",
+          "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==",
+          "requires": {
+            "color-name": "~1.1.4"
+          }
+        },
+        "color-name": {
+          "version": "1.1.4",
+          "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz",
+          "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA=="
+        },
+        "fs-extra": {
+          "version": "10.0.0",
+          "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-10.0.0.tgz",
+          "integrity": "sha512-C5owb14u9eJwizKGdchcDUQeFtlSHHthBk8pbX9Vc1PFZrLombudjDnNns88aYslCyF6IY5SUw3Roz6xShcEIQ==",
+          "requires": {
+            "graceful-fs": "^4.2.0",
+            "jsonfile": "^6.0.1",
+            "universalify": "^2.0.0"
+          }
+        },
+        "has-flag": {
+          "version": "4.0.0",
+          "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz",
+          "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ=="
+        },
+        "prompts": {
+          "version": "2.4.1",
+          "resolved": "https://registry.npmjs.org/prompts/-/prompts-2.4.1.tgz",
+          "integrity": "sha512-EQyfIuO2hPDsX1L/blblV+H7I0knhgAd82cVneCwcdND9B8AuCDuRcBH6yIcG4dFzlOUqbazQqwGjx5xmsNLuQ==",
+          "requires": {
+            "kleur": "^3.0.3",
+            "sisteransi": "^1.0.5"
+          }
+        },
+        "rimraf": {
+          "version": "3.0.2",
+          "resolved": "https://registry.npmjs.org/rimraf/-/rimraf-3.0.2.tgz",
+          "integrity": "sha512-JZkJMZkAGFFPP2YqXZXPbMlMBgsxzE8ILs4lMIX/2o0L9UBw9O/Y3o6wFw/i9YLapcUJWwqbi3kdxIPdC62TIA==",
+          "requires": {
+            "glob": "^7.1.3"
+          }
+        },
+        "supports-color": {
+          "version": "7.2.0",
+          "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz",
+          "integrity": "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==",
+          "requires": {
+            "has-flag": "^4.0.0"
+          }
+        }
       }
     },
     "@semantic-ui-react/event-stack": {
@@ -2281,6 +2369,14 @@
       "resolved": "https://registry.npmjs.org/@types/estree/-/estree-0.0.46.tgz",
       "integrity": "sha512-laIjwTQaD+5DukBZaygQ79K1Z0jb1bPEMRrkXSLjtCcZm+abyp5YbrqpSLzD42FwWW6gK/aS4NYpJ804nG2brg=="
     },
+    "@types/fs-extra": {
+      "version": "9.0.12",
+      "resolved": "https://registry.npmjs.org/@types/fs-extra/-/fs-extra-9.0.12.tgz",
+      "integrity": "sha512-I+bsBr67CurCGnSenZZ7v94gd3tc3+Aj2taxMT4yu4ABLuOgOjeFxX3dokG24ztSRg5tnT00sL8BszO7gSMoIw==",
+      "requires": {
+        "@types/node": "*"
+      }
+    },
     "@types/glob": {
       "version": "7.1.3",
       "resolved": "https://registry.npmjs.org/@types/glob/-/glob-7.1.3.tgz",
@@ -2346,9 +2442,9 @@
       "integrity": "sha512-tHq6qdbT9U1IRSGf14CL0pUlULksvY9OZ+5eEgl1N7t+OA3tGvNpxJCzuKQlsNgCVwbAs670L1vcVQi8j9HjnA=="
     },
     "@types/node": {
-      "version": "14.14.25",
-      "resolved": "https://registry.npmjs.org/@types/node/-/node-14.14.25.tgz",
-      "integrity": "sha512-EPpXLOVqDvisVxtlbvzfyqSsFeQxltFbluZNRndIb8tr9KiBnYNLzrc1N3pyKUCww2RNrfHDViqDWWE1LCJQtQ=="
+      "version": "14.14.41",
+      "resolved": "https://registry.npmjs.org/@types/node/-/node-14.14.41.tgz",
+      "integrity": "sha512-dueRKfaJL4RTtSa7bWeTK1M+VH+Gns73oCgzvYfHZywRCoPSd8EkXBL0mZ9unPTveBn+D9phZBaxuzpwjWkW0g=="
     },
     "@types/normalize-package-data": {
       "version": "2.4.0",
@@ -2366,9 +2462,9 @@
       "integrity": "sha512-6gOkRe7OIioWAXfnO/2lFiv+SJichKVSys1mSsgyrYHSEjk8Ctv4tSR/Odvnu+HWlH2C8j53dahU03XmQdd5fA=="
     },
     "@types/prompts": {
-      "version": "2.0.9",
-      "resolved": "https://registry.npmjs.org/@types/prompts/-/prompts-2.0.9.tgz",
-      "integrity": "sha512-TORZP+FSjTYMWwKadftmqEn6bziN5RnfygehByGsjxoK5ydnClddtv6GikGWPvCm24oI+YBwck5WDxIIyNxUrA==",
+      "version": "2.0.14",
+      "resolved": "https://registry.npmjs.org/@types/prompts/-/prompts-2.0.14.tgz",
+      "integrity": "sha512-HZBd99fKxRWpYCErtm2/yxUZv6/PBI9J7N4TNFffl5JbrYMHBwF25DjQGTW3b3jmXq+9P6/8fCIb2ee57BFfYA==",
       "requires": {
         "@types/node": "*"
       }
@@ -3411,6 +3507,22 @@
         "follow-redirects": "^1.10.0"
       }
     },
+    "axios-cookiejar-support": {
+      "version": "1.0.1",
+      "resolved": "https://registry.npmjs.org/axios-cookiejar-support/-/axios-cookiejar-support-1.0.1.tgz",
+      "integrity": "sha512-IZJxnAJ99XxiLqNeMOqrPbfR7fRyIfaoSLdPUf4AMQEGkH8URs0ghJK/xtqBsD+KsSr3pKl4DEQjCn834pHMig==",
+      "requires": {
+        "is-redirect": "^1.0.0",
+        "pify": "^5.0.0"
+      },
+      "dependencies": {
+        "pify": {
+          "version": "5.0.0",
+          "resolved": "https://registry.npmjs.org/pify/-/pify-5.0.0.tgz",
+          "integrity": "sha512-eW/gHNMlxdSP6dmG6uJip6FXN0EQBwm2clYYd8Wul42Cwu/DK8HEftzsapcNdYe2MfLiIwZqsDk2RDEsTE79hA=="
+        }
+      }
+    },
     "axobject-query": {
       "version": "2.2.0",
       "resolved": "https://registry.npmjs.org/axobject-query/-/axobject-query-2.2.0.tgz",
@@ -4209,19 +4321,6 @@
           "requires": {
             "glob": "^7.1.3"
           }
-        },
-        "tar": {
-          "version": "6.1.0",
-          "resolved": "https://registry.npmjs.org/tar/-/tar-6.1.0.tgz",
-          "integrity": "sha512-DUCttfhsnLCjwoDoFcI+B2iJgYa93vBnDUATYEeRx6sntCTdN01VnqsIuTlALXla/LWooNg0yEGeB+Y8WdFxGA==",
-          "requires": {
-            "chownr": "^2.0.0",
-            "fs-minipass": "^2.0.0",
-            "minipass": "^3.0.0",
-            "minizlib": "^2.1.1",
-            "mkdirp": "^1.0.3",
-            "yallist": "^4.0.0"
-          }
         }
       }
     },
@@ -4329,9 +4428,9 @@
       }
     },
     "caniuse-lite": {
-      "version": "1.0.30001185",
-      "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001185.tgz",
-      "integrity": "sha512-Fpi4kVNtNvJ15H0F6vwmXtb3tukv3Zg3qhKkOGUq7KJ1J6b9kf4dnNgtEAFXhRsJo0gNj9W60+wBvn0JcTvdTg=="
+      "version": "1.0.30001251",
+      "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001251.tgz",
+      "integrity": "sha512-HOe1r+9VkU4TFmnU70z+r7OLmtR+/chB1rdcJUeQlAinjEeb0cKL20tlAtOagNZhbrtLnCvV19B4FmF1rgzl6A=="
     },
     "capture-exit": {
       "version": "2.0.0",
@@ -4460,6 +4559,14 @@
       "resolved": "https://registry.npmjs.org/clean-stack/-/clean-stack-2.2.0.tgz",
       "integrity": "sha512-4diC9HaTE+KRAMWhDhrGOECgWZxoevMc5TlkObMqNSsVU62PYzXZ/SMTjzyGAFF1YusgxGcSWTEXBhp0CPwQ1A=="
     },
+    "cli-table": {
+      "version": "0.3.6",
+      "resolved": "https://registry.npmjs.org/cli-table/-/cli-table-0.3.6.tgz",
+      "integrity": "sha512-ZkNZbnZjKERTY5NwC2SeMeLeifSPq/pubeRoTpdr3WchLlnZg6hEgvHkK5zL7KNFdd9PmHN8lxrENUwI3cE8vQ==",
+      "requires": {
+        "colors": "1.0.3"
+      }
+    },
     "cliui": {
       "version": "5.0.0",
       "resolved": "https://registry.npmjs.org/cliui/-/cliui-5.0.0.tgz",
@@ -4568,6 +4675,11 @@
       "resolved": "https://registry.npmjs.org/colorette/-/colorette-1.2.1.tgz",
       "integrity": "sha512-puCDz0CzydiSYOrnXpz/PKd69zRrribezjtE9yd4zvytoRc8+RY/KJPvtPFKZS3E3wP6neGyMe0vOTlHO5L3Pw=="
     },
+    "colors": {
+      "version": "1.0.3",
+      "resolved": "https://registry.npmjs.org/colors/-/colors-1.0.3.tgz",
+      "integrity": "sha1-BDP0TYCWgP3rYO0mDxsMJi6CpAs="
+    },
     "combined-stream": {
       "version": "1.0.8",
       "resolved": "https://registry.npmjs.org/combined-stream/-/combined-stream-1.0.8.tgz",
@@ -5622,11 +5734,6 @@
         "is-obj": "^2.0.0"
       }
     },
-    "dotenv": {
-      "version": "8.2.0",
-      "resolved": "https://registry.npmjs.org/dotenv/-/dotenv-8.2.0.tgz",
-      "integrity": "sha512-8sJ78ElpbDJBHNeBzUbUVLsqKdccaa/BXF1uPTw3GrvQTBgrQrtObr2mUrE38vzYd8cEv+m/JBfDLioYcfXoaw=="
-    },
     "dotenv-expand": {
       "version": "5.1.0",
       "resolved": "https://registry.npmjs.org/dotenv-expand/-/dotenv-expand-5.1.0.tgz",
@@ -8488,6 +8595,11 @@
       "resolved": "https://registry.npmjs.org/is-potential-custom-element-name/-/is-potential-custom-element-name-1.0.0.tgz",
       "integrity": "sha1-DFLlS8yjkbssSUsh6GJtczbG45c="
     },
+    "is-redirect": {
+      "version": "1.0.0",
+      "resolved": "https://registry.npmjs.org/is-redirect/-/is-redirect-1.0.0.tgz",
+      "integrity": "sha1-HQPd7VO9jbDzDCbk+V02/HyH3CQ="
+    },
     "is-regex": {
       "version": "1.1.0",
       "resolved": "https://registry.npmjs.org/is-regex/-/is-regex-1.1.0.tgz",
@@ -10635,6 +10747,11 @@
         }
       }
     },
+    "jwt-decode": {
+      "version": "3.1.2",
+      "resolved": "https://registry.npmjs.org/jwt-decode/-/jwt-decode-3.1.2.tgz",
+      "integrity": "sha512-UfpWE/VZn0iP50d8cz9NrZLM9lSWhcJ+0Gt/nm4by88UL+J1SiKN8/5dkjMmbEzwL2CAe+67GsegCbIKtbp75A=="
+    },
     "keyboard-key": {
       "version": "1.1.0",
       "resolved": "https://registry.npmjs.org/keyboard-key/-/keyboard-key-1.1.0.tgz",
@@ -14173,6 +14290,11 @@
           "resolved": "https://registry.npmjs.org/camelcase/-/camelcase-6.2.0.tgz",
           "integrity": "sha512-c7wVvbw3f37nuobQNtgsgG9POC9qMbNuMQmTCqZv23b6MIz0fcYpBiOlv9gEN/hdLdnZTDQhg6e9Dq5M1vKvfg=="
         },
+        "dotenv": {
+          "version": "8.2.0",
+          "resolved": "https://registry.npmjs.org/dotenv/-/dotenv-8.2.0.tgz",
+          "integrity": "sha512-8sJ78ElpbDJBHNeBzUbUVLsqKdccaa/BXF1uPTw3GrvQTBgrQrtObr2mUrE38vzYd8cEv+m/JBfDLioYcfXoaw=="
+        },
         "resolve": {
           "version": "1.18.1",
           "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.18.1.tgz",
@@ -16215,7 +16337,6 @@
       "version": "6.1.0",
       "resolved": "https://registry.npmjs.org/tar/-/tar-6.1.0.tgz",
       "integrity": "sha512-DUCttfhsnLCjwoDoFcI+B2iJgYa93vBnDUATYEeRx6sntCTdN01VnqsIuTlALXla/LWooNg0yEGeB+Y8WdFxGA==",
-      "dev": true,
       "requires": {
         "chownr": "^2.0.0",
         "fs-minipass": "^2.0.0",
@@ -16228,8 +16349,7 @@
         "mkdirp": {
           "version": "1.0.4",
           "resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-1.0.4.tgz",
-          "integrity": "sha512-vVqVZQyf3WLx2Shd0qJ9xuvqgAyKPLAiqITEtqW0oIUjzo3PePDd6fW9iFz30ef7Ysp/oiWqbhszeGWW2T6Gzw==",
-          "dev": true
+          "integrity": "sha512-vVqVZQyf3WLx2Shd0qJ9xuvqgAyKPLAiqITEtqW0oIUjzo3PePDd6fW9iFz30ef7Ysp/oiWqbhszeGWW2T6Gzw=="
         }
       }
     },

sasjs-tests/package.json

@@ -4,10 +4,10 @@
   "homepage": ".",
   "private": true,
   "dependencies": {
-    "@sasjs/adapter": "^2.2.4",
+    "@sasjs/adapter": "file:../build/sasjs-adapter-5.0.0.tgz",
     "@sasjs/test-framework": "^1.4.0",
     "@types/jest": "^26.0.20",
-    "@types/node": "^14.14.25",
+    "@types/node": "^14.14.41",
     "@types/react": "^17.0.1",
     "@types/react-dom": "^17.0.0",
     "@types/react-router-dom": "^5.1.7",
@@ -23,8 +23,9 @@
     "test": "react-scripts test",
     "eject": "react-scripts eject",
     "update:adapter": "cd .. && npm run package:lib && cd sasjs-tests && npm i ../build/sasjs-adapter-5.0.0.tgz",
-    "deploy:tests": "npm run build && rsync -avhe ssh ./build/* --delete $SSH_ACCOUNT:$DEPLOY_PATH",
-    "deploy": "npm run update:adapter && npm run deploy:tests"
+    "deploy:tests": "rsync -avhe ssh ./build/* --delete $SSH_ACCOUNT:$DEPLOY_PATH || npm run deploy:tests-win",
+    "deploy:tests-win": "scp %DEPLOY_PATH% ./build/*",
+    "deploy": "npm run update:adapter && npm run build && npm run deploy:tests"
   },
   "eslintConfig": {
     "extends": "react-app"

sasjs-tests/src/App.tsx

@@ -1,34 +1,39 @@
-import React, { ReactElement, useState, useContext, useEffect } from "react";
-import { TestSuiteRunner, TestSuite, AppContext } from "@sasjs/test-framework";
-import { basicTests } from "./testSuites/Basic";
-import { sendArrTests, sendObjTests } from "./testSuites/RequestData";
-import { specialCaseTests } from "./testSuites/SpecialCases";
-import { sasjsRequestTests } from "./testSuites/SasjsRequests";
-import "@sasjs/test-framework/dist/index.css";
-import { computeTests } from "./testSuites/Compute";
+import React, { ReactElement, useState, useContext, useEffect } from 'react'
+import { TestSuiteRunner, TestSuite, AppContext } from '@sasjs/test-framework'
+import { basicTests } from './testSuites/Basic'
+import { sendArrTests, sendObjTests } from './testSuites/RequestData'
+import { specialCaseTests } from './testSuites/SpecialCases'
+import { sasjsRequestTests } from './testSuites/SasjsRequests'
+import '@sasjs/test-framework/dist/index.css'
+import { computeTests } from './testSuites/Compute'
 
 const App = (): ReactElement<{}> => {
-  const { adapter, config } = useContext(AppContext);
-  const [testSuites, setTestSuites] = useState<TestSuite[]>([]);
+  const { adapter, config } = useContext(AppContext)
+  const [testSuites, setTestSuites] = useState<TestSuite[]>([])
 
   useEffect(() => {
     if (adapter) {
-      setTestSuites([
+      const testSuites = [
         basicTests(adapter, config.userName, config.password),
         sendArrTests(adapter),
         sendObjTests(adapter),
         specialCaseTests(adapter),
-        sasjsRequestTests(adapter),
-        computeTests(adapter)
-      ]);
+        sasjsRequestTests(adapter)
+      ]
+
+      if (adapter.getSasjsConfig().serverType === 'SASVIYA') {
+        testSuites.push(computeTests(adapter))
+      }
+
+      setTestSuites(testSuites)
     }
-  }, [adapter, config]);
+  }, [adapter, config])
 
   return (
     <div className="app">
       {adapter && testSuites && <TestSuiteRunner testSuites={testSuites} />}
     </div>
-  );
-};
+  )
+}
 
-export default App;
+export default App

sasjs-tests/src/Login.tsx

@@ -1,22 +1,22 @@
-import React, { ReactElement, useState, useCallback, useContext } from "react";
-import "./Login.scss";
-import { AppContext } from "@sasjs/test-framework";
-import { Redirect } from "react-router-dom";
+import React, { ReactElement, useState, useCallback, useContext } from 'react'
+import './Login.scss'
+import { AppContext } from '@sasjs/test-framework'
+import { Redirect } from 'react-router-dom'
 
 const Login = (): ReactElement<{}> => {
-  const [username, setUsername] = useState("");
-  const [password, setPassword] = useState("");
-  const appContext = useContext(AppContext);
+  const [username, setUsername] = useState('')
+  const [password, setPassword] = useState('')
+  const appContext = useContext(AppContext)
 
   const handleSubmit = useCallback(
     (e) => {
-      e.preventDefault();
+      e.preventDefault()
       appContext.adapter.logIn(username, password).then((res) => {
-        appContext.setIsLoggedIn(res.isLoggedIn);
-      });
+        appContext.setIsLoggedIn(res.isLoggedIn)
+      })
     },
     [username, password, appContext]
-  );
+  )
 
   return !appContext.isLoggedIn ? (
     <div className="login-container">
@@ -48,7 +48,7 @@ const Login = (): ReactElement<{}> => {
     </div>
   ) : (
     <Redirect to="/" />
-  );
-};
+  )
+}
 
-export default Login;
+export default Login

sasjs-tests/src/PrivateRoute.tsx

@@ -1,23 +1,23 @@
-import React, { ReactElement, useContext, FunctionComponent } from "react";
-import { Redirect, Route } from "react-router-dom";
-import { AppContext } from "@sasjs/test-framework";
+import React, { ReactElement, useContext, FunctionComponent } from 'react'
+import { Redirect, Route } from 'react-router-dom'
+import { AppContext } from '@sasjs/test-framework'
 
 interface PrivateRouteProps {
-  component: FunctionComponent;
-  exact?: boolean;
-  path: string;
+  component: FunctionComponent
+  exact?: boolean
+  path: string
 }
 
 const PrivateRoute = (
   props: PrivateRouteProps
 ): ReactElement<PrivateRouteProps> => {
-  const { component, path, exact } = props;
-  const appContext = useContext(AppContext);
+  const { component, path, exact } = props
+  const appContext = useContext(AppContext)
   return appContext.isLoggedIn ? (
     <Route component={component} path={path} exact={exact} />
   ) : (
     <Redirect to="/login" />
-  );
-};
+  )
+}
 
-export default PrivateRoute;
+export default PrivateRoute

sasjs-tests/src/index.tsx

@@ -1,12 +1,12 @@
-import React from "react";
-import ReactDOM from "react-dom";
-import { Route, HashRouter, Switch } from "react-router-dom";
-import "./index.scss";
-import * as serviceWorker from "./serviceWorker";
-import { AppProvider } from "@sasjs/test-framework";
-import PrivateRoute from "./PrivateRoute";
-import Login from "./Login";
-import App from "./App";
+import React from 'react'
+import ReactDOM from 'react-dom'
+import { Route, HashRouter, Switch } from 'react-router-dom'
+import './index.scss'
+import * as serviceWorker from './serviceWorker'
+import { AppProvider } from '@sasjs/test-framework'
+import PrivateRoute from './PrivateRoute'
+import Login from './Login'
+import App from './App'
 
 ReactDOM.render(
   <AppProvider>
@@ -17,10 +17,10 @@ ReactDOM.render(
       </Switch>
     </HashRouter>
   </AppProvider>,
-  document.getElementById("root")
-);
+  document.getElementById('root')
+)
 
 // If you want your app to work offline and load faster, you can change
 // unregister() to register() below. Note this comes with some pitfalls.
 // Learn more about service workers: https://bit.ly/CRA-PWA
-serviceWorker.unregister();
+serviceWorker.unregister()

sasjs-tests/src/serviceWorker.js

@@ -11,46 +11,46 @@
 // opt-in, read https://bit.ly/CRA-PWA
 
 const isLocalhost = Boolean(
-  window.location.hostname === "localhost" ||
+  window.location.hostname === 'localhost' ||
     // [::1] is the IPv6 localhost address.
-    window.location.hostname === "[::1]" ||
+    window.location.hostname === '[::1]' ||
     // 127.0.0.0/8 are considered localhost for IPv4.
     window.location.hostname.match(
       /^127(?:\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}$/
     )
-);
+)
 
 export function register(config) {
-  if (process.env.NODE_ENV === "production" && "serviceWorker" in navigator) {
+  if (process.env.NODE_ENV === 'production' && 'serviceWorker' in navigator) {
     // The URL constructor is available in all browsers that support SW.
-    const publicUrl = new URL(process.env.PUBLIC_URL, window.location.href);
+    const publicUrl = new URL(process.env.PUBLIC_URL, window.location.href)
     if (publicUrl.origin !== window.location.origin) {
       // Our service worker won't work if PUBLIC_URL is on a different origin
       // from what our page is served on. This might happen if a CDN is used to
       // serve assets; see https://github.com/facebook/create-react-app/issues/2374
-      return;
+      return
     }
 
-    window.addEventListener("load", () => {
-      const swUrl = `${process.env.PUBLIC_URL}/service-worker.js`;
+    window.addEventListener('load', () => {
+      const swUrl = `${process.env.PUBLIC_URL}/service-worker.js`
 
       if (isLocalhost) {
         // This is running on localhost. Let's check if a service worker still exists or not.
-        checkValidServiceWorker(swUrl, config);
+        checkValidServiceWorker(swUrl, config)
 
         // Add some additional logging to localhost, pointing developers to the
         // service worker/PWA documentation.
         navigator.serviceWorker.ready.then(() => {
           console.log(
-            "This web app is being served cache-first by a service " +
-              "worker. To learn more, visit https://bit.ly/CRA-PWA"
-          );
-        });
+            'This web app is being served cache-first by a service ' +
+              'worker. To learn more, visit https://bit.ly/CRA-PWA'
+          )
+        })
       } else {
         // Is not localhost. Just register service worker
-        registerValidSW(swUrl, config);
+        registerValidSW(swUrl, config)
       }
-    });
+    })
   }
 }
 
@@ -59,83 +59,83 @@ function registerValidSW(swUrl, config) {
     .register(swUrl)
     .then((registration) => {
       registration.onupdatefound = () => {
-        const installingWorker = registration.installing;
+        const installingWorker = registration.installing
         if (installingWorker == null) {
-          return;
+          return
         }
         installingWorker.onstatechange = () => {
-          if (installingWorker.state === "installed") {
+          if (installingWorker.state === 'installed') {
             if (navigator.serviceWorker.controller) {
               // At this point, the updated precached content has been fetched,
               // but the previous service worker will still serve the older
               // content until all client tabs are closed.
               console.log(
-                "New content is available and will be used when all " +
-                  "tabs for this page are closed. See https://bit.ly/CRA-PWA."
-              );
+                'New content is available and will be used when all ' +
+                  'tabs for this page are closed. See https://bit.ly/CRA-PWA.'
+              )
 
               // Execute callback
               if (config && config.onUpdate) {
-                config.onUpdate(registration);
+                config.onUpdate(registration)
               }
             } else {
               // At this point, everything has been precached.
               // It's the perfect time to display a
               // "Content is cached for offline use." message.
-              console.log("Content is cached for offline use.");
+              console.log('Content is cached for offline use.')
 
               // Execute callback
               if (config && config.onSuccess) {
-                config.onSuccess(registration);
+                config.onSuccess(registration)
               }
             }
           }
-        };
-      };
+        }
+      }
     })
     .catch((error) => {
-      console.error("Error during service worker registration:", error);
-    });
+      console.error('Error during service worker registration:', error)
+    })
 }
 
 function checkValidServiceWorker(swUrl, config) {
   // Check if the service worker can be found. If it can't reload the page.
   fetch(swUrl, {
-    headers: { "Service-Worker": "script" }
+    headers: { 'Service-Worker': 'script' }
   })
     .then((response) => {
       // Ensure service worker exists, and that we really are getting a JS file.
-      const contentType = response.headers.get("content-type");
+      const contentType = response.headers.get('content-type')
       if (
         response.status === 404 ||
-        (contentType != null && contentType.indexOf("javascript") === -1)
+        (contentType != null && contentType.indexOf('javascript') === -1)
       ) {
         // No service worker found. Probably a different app. Reload the page.
         navigator.serviceWorker.ready.then((registration) => {
           registration.unregister().then(() => {
-            window.location.reload();
-          });
-        });
+            window.location.reload()
+          })
+        })
       } else {
         // Service worker found. Proceed as normal.
-        registerValidSW(swUrl, config);
+        registerValidSW(swUrl, config)
       }
     })
     .catch(() => {
       console.log(
-        "No internet connection found. App is running in offline mode."
-      );
-    });
+        'No internet connection found. App is running in offline mode.'
+      )
+    })
 }
 
 export function unregister() {
-  if ("serviceWorker" in navigator) {
+  if ('serviceWorker' in navigator) {
     navigator.serviceWorker.ready
       .then((registration) => {
-        registration.unregister();
+        registration.unregister()
       })
       .catch((error) => {
-        console.error(error.message);
-      });
+        console.error(error.message)
+      })
   }
 }

sasjs-tests/src/setupTests.js

@@ -2,4 +2,4 @@
 // allows you to do things like:
 // expect(element).toHaveTextContent(/react/i)
 // learn more: https://github.com/testing-library/jest-dom
-import "@testing-library/jest-dom/extend-expect";
+import '@testing-library/jest-dom/extend-expect'

sasjs-tests/src/testSuites/Basic.ts

@@ -1,97 +1,116 @@
-import SASjs, { SASjsConfig } from "@sasjs/adapter";
-import { TestSuite } from "@sasjs/test-framework";
-import { ServerType } from "@sasjs/utils/types";
+import SASjs, { LoginMechanism, SASjsConfig } from '@sasjs/adapter'
+import { TestSuite } from '@sasjs/test-framework'
+import { ServerType } from '@sasjs/utils/types'
 
-const stringData: any = { table1: [{ col1: "first col value" }] };
+const stringData: any = { table1: [{ col1: 'first col value' }] }
 
 const defaultConfig: SASjsConfig = {
   serverUrl: window.location.origin,
-  pathSAS9: "/SASStoredProcess/do",
-  pathSASViya: "/SASJobExecution",
-  appLoc: "/Public/seedapp",
+  pathSAS9: '/SASStoredProcess/do',
+  pathSASViya: '/SASJobExecution',
+  appLoc: '/Public/seedapp',
   serverType: ServerType.SasViya,
   debug: false,
-  contextName: "SAS Job Execution compute context",
+  contextName: 'SAS Job Execution compute context',
   useComputeApi: false,
-  allowInsecureRequests: false
-};
+  allowInsecureRequests: false,
+  loginMechanism: LoginMechanism.Default
+}
 
 const customConfig = {
-  serverUrl: "http://url.com",
-  pathSAS9: "sas9",
-  pathSASViya: "viya",
-  appLoc: "/Public/seedapp",
+  serverUrl: 'http://url.com',
+  pathSAS9: 'sas9',
+  pathSASViya: 'viya',
+  appLoc: '/Public/seedapp',
   serverType: ServerType.Sas9,
   debug: false
-};
+}
 
 export const basicTests = (
   adapter: SASjs,
   userName: string,
   password: string
 ): TestSuite => ({
-  name: "Basic Tests",
+  name: 'Basic Tests',
   tests: [
     {
-      title: "Log in",
-      description: "Should log the user in",
+      title: 'Log in',
+      description: 'Should log the user in',
       test: async () => {
-        return adapter.logIn(userName, password);
+        return adapter.logIn(userName, password)
       },
       assertion: (response: any) =>
         response && response.isLoggedIn && response.userName === userName
     },
     {
-      title: "Multiple Log in attempts",
-      description:
-        "Should fail on first attempt and should log the user in on second attempt",
+      title: 'Fetch username for already logged in user',
+      description: 'Should log the user in',
       test: async () => {
-        await adapter.logOut();
-        await adapter.logIn("invalid", "invalid");
-        return adapter.logIn(userName, password);
+        await adapter.logIn(userName, password)
+
+        const newAdapterIns = new SASjs(adapter.getSasjsConfig())
+
+        return await newAdapterIns.checkSession()
+      },
+      assertion: (response: any) =>
+        response?.isLoggedIn && response?.userName === userName
+    },
+    {
+      title: 'Multiple Log in attempts',
+      description:
+        'Should fail on first attempt and should log the user in on second attempt',
+      test: async () => {
+        await adapter.logOut()
+        await adapter.logIn('invalid', 'invalid')
+        return await adapter.logIn(userName, password)
       },
       assertion: (response: any) =>
         response && response.isLoggedIn && response.userName === userName
     },
     {
-      title: "Trigger login callback",
+      title: 'Trigger login callback',
       description:
-        "Should trigger required login callback and after successful login, it should finish the request",
+        'Should trigger required login callback and after successful login, it should finish the request',
       test: async () => {
-        await adapter.logOut();
-        
-        return await adapter.request("common/sendArr", stringData, null, () => {
-          adapter.logIn(userName, password);
-        });
+        await adapter.logOut()
+
+        return await adapter.request(
+          'common/sendArr',
+          stringData,
+          undefined,
+          () => {
+            adapter.logIn(userName, password)
+          }
+        )
       },
       assertion: (response: any) => {
-        return response.table1[0][0] === stringData.table1[0].col1;
+        return response.table1[0][0] === stringData.table1[0].col1
       }
     },
     {
-      title: "Request with debug on",
+      title: 'Request with debug on',
       description:
-        "Should complete successful request with debugging switched on",
+        'Should complete successful request with debugging switched on',
       test: async () => {
         const config = {
           debug: true
         }
 
-        return await adapter.request("common/sendArr", stringData, config)
+        return await adapter.request('common/sendArr', stringData, config)
       },
       assertion: (response: any) => {
-        return response.table1[0][0] === stringData.table1[0].col1;
+        return response.table1[0][0] === stringData.table1[0].col1
       }
     },
     {
-      title: "Default config",
+      title: 'Default config',
       description:
-        "Should instantiate with default config when none is provided",
+        'Should instantiate with default config when none is provided',
       test: async () => {
-        return Promise.resolve(new SASjs());
+        return Promise.resolve(new SASjs())
       },
       assertion: (sasjsInstance: SASjs) => {
-        const sasjsConfig = sasjsInstance.getSasjsConfig();
+        const sasjsConfig = sasjsInstance.getSasjsConfig()
 
         return (
           sasjsConfig.serverUrl === defaultConfig.serverUrl &&
@@ -100,17 +119,17 @@ export const basicTests = (
           sasjsConfig.appLoc === defaultConfig.appLoc &&
           sasjsConfig.serverType === defaultConfig.serverType &&
           sasjsConfig.debug === defaultConfig.debug
-        );
+        )
       }
     },
     {
-      title: "Custom config",
-      description: "Should use fully custom config whenever supplied",
+      title: 'Custom config',
+      description: 'Should use fully custom config whenever supplied',
       test: async () => {
-        return Promise.resolve(new SASjs(customConfig));
+        return Promise.resolve(new SASjs(customConfig))
       },
       assertion: (sasjsInstance: SASjs) => {
-        const sasjsConfig = sasjsInstance.getSasjsConfig();
+        const sasjsConfig = sasjsInstance.getSasjsConfig()
         return (
           sasjsConfig.serverUrl === customConfig.serverUrl &&
           sasjsConfig.pathSAS9 === customConfig.pathSAS9 &&
@@ -118,28 +137,51 @@ export const basicTests = (
           sasjsConfig.appLoc === customConfig.appLoc &&
           sasjsConfig.serverType === customConfig.serverType &&
           sasjsConfig.debug === customConfig.debug
-        );
+        )
       }
     },
     {
-      title: "Config overrides",
-      description: "Should override default config with supplied properties",
+      title: 'Config overrides',
+      description: 'Should override default config with supplied properties',
       test: async () => {
         return Promise.resolve(
-          new SASjs({ serverUrl: "http://test.com", debug: false })
-        );
+          new SASjs({ serverUrl: 'http://test.com', debug: false })
+        )
       },
       assertion: (sasjsInstance: SASjs) => {
-        const sasjsConfig = sasjsInstance.getSasjsConfig();
+        const sasjsConfig = sasjsInstance.getSasjsConfig()
         return (
-          sasjsConfig.serverUrl === "http://test.com" &&
+          sasjsConfig.serverUrl === 'http://test.com' &&
           sasjsConfig.pathSAS9 === defaultConfig.pathSAS9 &&
           sasjsConfig.pathSASViya === defaultConfig.pathSASViya &&
           sasjsConfig.appLoc === defaultConfig.appLoc &&
           sasjsConfig.serverType === defaultConfig.serverType &&
           sasjsConfig.debug === false
-        );
+        )
+      }
+    },
+    {
+      title: 'Request with extra attributes on JES approach',
+      description:
+        'Should complete successful request with extra attributes present in response',
+      test: async () => {
+        const config: Partial<SASjsConfig> = {
+          useComputeApi: false
+        }
+
+        return await adapter.request(
+          'common/sendArr',
+          stringData,
+          config,
+          undefined,
+          undefined,
+          ['file', 'data']
+        )
+      },
+      assertion: (response: any) => {
+        const responseKeys: any = Object.keys(response)
+        return responseKeys.includes('file') && responseKeys.includes('data')
       }
     }
   ]
-});
+})

sasjs-tests/src/testSuites/Compute.ts

@@ -1,106 +1,100 @@
-import SASjs from "@sasjs/adapter";
-import { TestSuite } from "@sasjs/test-framework";
+import SASjs from '@sasjs/adapter'
+import { TestSuite } from '@sasjs/test-framework'
 
 export const computeTests = (adapter: SASjs): TestSuite => ({
-  name: "Compute",
+  name: 'Compute',
   tests: [
     {
-      title: "Start Compute Job - not waiting for result",
-      description: "Should start a compute job and return the session",
+      title: 'Start Compute Job - not waiting for result',
+      description: 'Should start a compute job and return the session',
       test: () => {
-        const data: any = { table1: [{ col1: "first col value" }] };
-        return adapter.startComputeJob("/Public/app/common/sendArr", data);
+        const data: any = { table1: [{ col1: 'first col value' }] }
+        return adapter.startComputeJob('/Public/app/common/sendArr', data)
       },
       assertion: (res: any) => {
-        const expectedProperties = ["id", "applicationName", "attributes"];
-        return validate(expectedProperties, res);
+        const expectedProperties = ['id', 'applicationName', 'attributes']
+        return validate(expectedProperties, res)
       }
     },
     {
-      title: "Start Compute Job - waiting for result",
-      description: "Should start a compute job and return the job",
+      title: 'Start Compute Job - waiting for result',
+      description: 'Should start a compute job and return the job',
       test: () => {
-        const data: any = { table1: [{ col1: "first col value" }] };
+        const data: any = { table1: [{ col1: 'first col value' }] }
         return adapter.startComputeJob(
-          "/Public/app/common/sendArr",
+          '/Public/app/common/sendArr',
           data,
           {},
-          "",
+          undefined,
           true
-        );
+        )
       },
       assertion: (res: any) => {
         const expectedProperties = [
-          "id",
-          "state",
-          "creationTimeStamp",
-          "jobConditionCode"
-        ];
-        return validate(expectedProperties, res.job);
+          'id',
+          'state',
+          'creationTimeStamp',
+          'jobConditionCode'
+        ]
+        return validate(expectedProperties, res.job)
       }
     },
     {
-      title: "Execute Script Viya - complete job",
-      description: "Should execute sas file and return log",
+      title: 'Execute Script Viya - complete job',
+      description: 'Should execute sas file and return log',
       test: () => {
-        const fileLines = [
-          `data;`,
-          `do x=1 to 100;`,
-          `output;`,
-          `end;`,
-          `run;`
-        ];
+        const fileLines = [`data;`, `do x=1 to 100;`, `output;`, `end;`, `run;`]
 
         return adapter.executeScriptSASViya(
-          "sasCode.sas",
+          'sasCode.sas',
           fileLines,
-          "SAS Studio compute context",
+          'SAS Studio compute context',
           undefined,
           true
-        );
+        )
       },
       assertion: (res: any) => {
-        const expectedLogContent = `1    data;\\n2    do x=1 to 100;\\n3    output;\\n4    end;\\n5    run;\\n\\n`;
+        const expectedLogContent = `1    data;\\n2    do x=1 to 100;\\n3    output;\\n4    end;\\n5    run;\\n\\n`
 
-        return validateLog(expectedLogContent, res.log);
+        return validateLog(expectedLogContent, res.log)
       }
     },
     {
-      title: "Execute Script Viya - failed job",
-      description: "Should execute sas file and return log",
+      title: 'Execute Script Viya - failed job',
+      description: 'Should execute sas file and return log',
       test: () => {
-        const fileLines = [`%abort;`];
+        const fileLines = [`%abort;`]
 
         return adapter
           .executeScriptSASViya(
-            "sasCode.sas",
+            'sasCode.sas',
             fileLines,
-            "SAS Studio compute context",
+            'SAS Studio compute context',
             undefined,
             true
           )
-          .catch((err: any) => err);
+          .catch((err: any) => err)
       },
       assertion: (res: any) => {
-        const expectedLogContent = `1    %abort;\\nERROR: The %ABORT statement is not valid in open code.\\n`;
+        const expectedLogContent = `1    %abort;\\nERROR: The %ABORT statement is not valid in open code.\\n`
 
-        return validateLog(expectedLogContent, res.log);
+        return validateLog(expectedLogContent, res.log)
       }
     }
   ]
-});
+})
 
 const validateLog = (text: string, log: string): boolean => {
-  const isValid = JSON.stringify(log).includes(text);
+  const isValid = JSON.stringify(log).includes(text)
 
-  return isValid;
-};
+  return isValid
+}
 
 const validate = (expectedProperties: string[], data: any): boolean => {
-  const actualProperties = Object.keys(data);
+  const actualProperties = Object.keys(data)
 
   const isValid = expectedProperties.every((property) =>
     actualProperties.includes(property)
-  );
-  return isValid;
-};
+  )
+  return isValid
+}

sasjs-tests/src/testSuites/RequestData.ts

@@ -1,111 +1,112 @@
-import SASjs from "@sasjs/adapter";
-import { TestSuite } from "@sasjs/test-framework";
+import SASjs from '@sasjs/adapter'
+import { TestSuite } from '@sasjs/test-framework'
 
-const stringData: any = { table1: [{ col1: "first col value" }] };
-const numericData: any = { table1: [{ col1: 3.14159265 }] };
+const stringData: any = { table1: [{ col1: 'first col value' }] }
+const numericData: any = { table1: [{ col1: 3.14159265 }] }
 const multiColumnData: any = {
-  table1: [{ col1: 42, col2: 1.618, col3: "x", col4: "x" }]
-};
+  table1: [{ col1: 42, col2: 1.618, col3: 'x', col4: 'x' }]
+}
 const multipleRowsWithNulls: any = {
   table1: [
-    { col1: 42, col2: null, col3: "x", col4: "" },
-    { col1: 42, col2: null, col3: "x", col4: "" },
-    { col1: 42, col2: null, col3: "x", col4: "" },
-    { col1: 42, col2: 1.62, col3: "x", col4: "x" },
-    { col1: 42, col2: 1.62, col3: "x", col4: "x" }
+    { col1: 42, col2: null, col3: 'x', col4: '' },
+    { col1: 42, col2: null, col3: 'x', col4: '' },
+    { col1: 42, col2: null, col3: 'x', col4: '' },
+    { col1: 42, col2: 1.62, col3: 'x', col4: 'x' },
+    { col1: 42, col2: 1.62, col3: 'x', col4: 'x' }
   ]
-};
+}
+
 const multipleColumnsWithNulls: any = {
   table1: [
-    { col1: 42, col2: null, col3: "x", col4: null },
-    { col1: 42, col2: null, col3: "x", col4: null },
-    { col1: 42, col2: null, col3: "x", col4: null },
-    { col1: 42, col2: null, col3: "x", col4: "" },
-    { col1: 42, col2: null, col3: "x", col4: "" }
+    { col1: 42, col2: null, col3: 'x', col4: null },
+    { col1: 42, col2: null, col3: 'x', col4: null },
+    { col1: 42, col2: null, col3: 'x', col4: null },
+    { col1: 42, col2: null, col3: 'x', col4: '' },
+    { col1: 42, col2: null, col3: 'x', col4: '' }
   ]
-};
+}
 
 const getLongStringData = (length = 32764) => {
-  let x = "X";
+  let x = 'X'
   for (let i = 1; i <= length; i++) {
-    x = x + "X";
+    x = x + 'X'
   }
-  const data: any = { table1: [{ col1: x }] };
-  return data;
-};
+  const data: any = { table1: [{ col1: x }] }
+  return data
+}
 
 const getLargeObjectData = () => {
-  const data = { table1: [{ big: "data" }] };
+  const data = { table1: [{ big: 'data' }] }
 
   for (let i = 1; i < 10000; i++) {
-    data.table1.push(data.table1[0]);
+    data.table1.push(data.table1[0])
   }
 
-  return data;
-};
+  return data
+}
 
 export const sendArrTests = (adapter: SASjs): TestSuite => ({
-  name: "sendArr",
+  name: 'sendArr',
   tests: [
     {
-      title: "Absolute paths",
-      description: "Should work with absolute paths to SAS jobs",
+      title: 'Absolute paths',
+      description: 'Should work with absolute paths to SAS jobs',
       test: () => {
-        return adapter.request("/Public/app/common/sendArr", stringData);
+        return adapter.request('/Public/app/common/sendArr', stringData)
       },
       assertion: (res: any) => {
-        return res.table1[0][0] === stringData.table1[0].col1;
+        return res.table1[0][0] === stringData.table1[0].col1
       }
     },
     {
-      title: "Single string value",
-      description: "Should send an array with a single string value",
+      title: 'Single string value',
+      description: 'Should send an array with a single string value',
       test: () => {
-        return adapter.request("common/sendArr", stringData);
+        return adapter.request('common/sendArr', stringData)
       },
       assertion: (res: any) => {
-        return res.table1[0][0] === stringData.table1[0].col1;
+        return res.table1[0][0] === stringData.table1[0].col1
       }
     },
     {
-      title: "Long string value",
+      title: 'Long string value',
       description:
-        "Should send an array with a long string value under 32765 characters",
+        'Should send an array with a long string value under 32765 characters',
       test: () => {
-        return adapter.request("common/sendArr", getLongStringData());
+        return adapter.request('common/sendArr', getLongStringData())
       },
       assertion: (res: any) => {
-        const longStringData = getLongStringData();
-        return res.table1[0][0] === longStringData.table1[0].col1;
+        const longStringData = getLongStringData()
+        return res.table1[0][0] === longStringData.table1[0].col1
       }
     },
     {
-      title: "Overly long string value",
+      title: 'Overly long string value',
       description:
-        "Should error out with long string values over 32765 characters",
+        'Should error out with long string values over 32765 characters',
       test: () => {
-        const data = getLongStringData(32767);
-        return adapter.request("common/sendArr", data).catch((e) => e);
+        const data = getLongStringData(32767)
+        return adapter.request('common/sendArr', data).catch((e) => e)
       },
       assertion: (error: any) => {
-        return !!error && !!error.error && !!error.error.message;
+        return !!error && !!error.error && !!error.error.message
       }
     },
     {
-      title: "Single numeric value",
-      description: "Should send an array with a single numeric value",
+      title: 'Single numeric value',
+      description: 'Should send an array with a single numeric value',
       test: () => {
-        return adapter.request("common/sendArr", numericData);
+        return adapter.request('common/sendArr', numericData)
       },
       assertion: (res: any) => {
-        return res.table1[0][0] === numericData.table1[0].col1;
+        return res.table1[0][0] === numericData.table1[0].col1
       }
     },
     {
-      title: "Multiple columns",
-      description: "Should handle data with multiple columns",
+      title: 'Multiple columns',
+      description: 'Should handle data with multiple columns',
       test: () => {
-        return adapter.request("common/sendArr", multiColumnData);
+        return adapter.request('common/sendArr', multiColumnData)
       },
       assertion: (res: any) => {
         return (
@@ -113,143 +114,189 @@ export const sendArrTests = (adapter: SASjs): TestSuite => ({
           res.table1[0][1] === multiColumnData.table1[0].col2 &&
           res.table1[0][2] === multiColumnData.table1[0].col3 &&
           res.table1[0][3] === multiColumnData.table1[0].col4
-        );
+        )
       }
     },
     {
-      title: "Multiple rows with nulls",
-      description: "Should handle data with multiple rows with null values",
+      title: 'Multiple rows with nulls',
+      description: 'Should handle data with multiple rows with null values',
       test: () => {
-        return adapter.request("common/sendArr", multipleRowsWithNulls);
+        return adapter.request('common/sendArr', multipleRowsWithNulls)
       },
       assertion: (res: any) => {
-        let result = true;
+        let result = true
         multipleRowsWithNulls.table1.forEach((_: any, index: number) => {
           result =
             result &&
-            res.table1[index][0] === multipleRowsWithNulls.table1[index].col1;
+            res.table1[index][0] === multipleRowsWithNulls.table1[index].col1
           result =
             result &&
-            res.table1[index][1] === multipleRowsWithNulls.table1[index].col2;
+            res.table1[index][1] === multipleRowsWithNulls.table1[index].col2
           result =
             result &&
-            res.table1[index][2] === multipleRowsWithNulls.table1[index].col3;
-          result =
-            result &&
-            res.table1[index][3] === multipleRowsWithNulls.table1[index].col4;
-        });
-        return result;
-      }
-    },
-    {
-      title: "Multiple columns with nulls",
-      description: "Should handle data with multiple columns with null values",
-      test: () => {
-        return adapter.request("common/sendArr", multipleColumnsWithNulls);
-      },
-      assertion: (res: any) => {
-        let result = true;
-        multipleColumnsWithNulls.table1.forEach((_: any, index: number) => {
-          result =
-            result &&
-            res.table1[index][0] ===
-              multipleColumnsWithNulls.table1[index].col1;
-          result =
-            result &&
-            res.table1[index][1] ===
-              multipleColumnsWithNulls.table1[index].col2;
-          result =
-            result &&
-            res.table1[index][2] ===
-              multipleColumnsWithNulls.table1[index].col3;
+            res.table1[index][2] === multipleRowsWithNulls.table1[index].col3
           result =
             result &&
             res.table1[index][3] ===
-              (multipleColumnsWithNulls.table1[index].col4 || "");
-        });
-        return result;
+              (multipleRowsWithNulls.table1[index].col4 || ' ')
+        })
+        return result
+      }
+    },
+    {
+      title: 'Multiple columns with nulls',
+      description: 'Should handle data with multiple columns with null values',
+      test: () => {
+        return adapter.request('common/sendArr', multipleColumnsWithNulls)
+      },
+      assertion: (res: any) => {
+        let result = true
+        multipleColumnsWithNulls.table1.forEach((_: any, index: number) => {
+          result =
+            result &&
+            res.table1[index][0] === multipleColumnsWithNulls.table1[index].col1
+          result =
+            result &&
+            res.table1[index][1] === multipleColumnsWithNulls.table1[index].col2
+          result =
+            result &&
+            res.table1[index][2] === multipleColumnsWithNulls.table1[index].col3
+          result =
+            result &&
+            res.table1[index][3] ===
+              (multipleColumnsWithNulls.table1[index].col4 || ' ')
+        })
+        return result
       }
     }
   ]
-});
+})
 
 export const sendObjTests = (adapter: SASjs): TestSuite => ({
-  name: "sendObj",
+  name: 'sendObj',
   tests: [
     {
-      title: "Invalid column name",
-      description: "Should throw an error",
+      title: 'Table name starts with numeric',
+      description: 'Should throw an error',
       test: async () => {
         const invalidData: any = {
-          "1 invalid table": [{ col1: 42 }]
-        };
-        return adapter.request("common/sendObj", invalidData).catch((e) => e);
+          '1InvalidTable': [{ col1: 42 }]
+        }
+        return adapter.request('common/sendObj', invalidData).catch((e) => e)
       },
       assertion: (error: any) =>
         !!error && !!error.error && !!error.error.message
     },
     {
-      title: "Single string value",
-      description: "Should send an object with a single string value",
+      title: 'Table name contains a space',
+      description: 'Should throw an error',
+      test: async () => {
+        const invalidData: any = {
+          'an invalidTable': [{ col1: 42 }]
+        }
+        return adapter.request('common/sendObj', invalidData).catch((e) => e)
+      },
+      assertion: (error: any) =>
+        !!error && !!error.error && !!error.error.message
+    },
+    {
+      title: 'Table name contains a special character',
+      description: 'Should throw an error',
+      test: async () => {
+        const invalidData: any = {
+          'anInvalidTable#': [{ col1: 42 }]
+        }
+        return adapter.request('common/sendObj', invalidData).catch((e) => e)
+      },
+      assertion: (error: any) =>
+        !!error && !!error.error && !!error.error.message
+    },
+    {
+      title: 'Table name exceeds max length of 32 characters',
+      description: 'Should throw an error',
+      test: async () => {
+        const invalidData: any = {
+          xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx: [{ col1: 42 }]
+        }
+        return adapter.request('common/sendObj', invalidData).catch((e) => e)
+      },
+      assertion: (error: any) =>
+        !!error && !!error.error && !!error.error.message
+    },
+    {
+      title: "Invalid data object's structure",
+      description: 'Should throw an error',
+      test: async () => {
+        const invalidData: any = {
+          inData: [[{ data: 'value' }]]
+        }
+        return adapter.request('common/sendObj', invalidData).catch((e) => e)
+      },
+      assertion: (error: any) =>
+        !!error && !!error.error && !!error.error.message
+    },
+    {
+      title: 'Single string value',
+      description: 'Should send an object with a single string value',
       test: () => {
-        return adapter.request("common/sendObj", stringData);
+        return adapter.request('common/sendObj', stringData)
       },
       assertion: (res: any) => {
-        return res.table1[0].COL1 === stringData.table1[0].col1;
+        return res.table1[0].COL1 === stringData.table1[0].col1
       }
     },
     {
-      title: "Long string value",
+      title: 'Long string value',
       description:
-        "Should send an object with a long string value under 32765 characters",
+        'Should send an object with a long string value under 32765 characters',
       test: () => {
-        return adapter.request("common/sendObj", getLongStringData());
+        return adapter.request('common/sendObj', getLongStringData())
       },
       assertion: (res: any) => {
-        const longStringData = getLongStringData();
-        return res.table1[0].COL1 === longStringData.table1[0].col1;
+        const longStringData = getLongStringData()
+        return res.table1[0].COL1 === longStringData.table1[0].col1
       }
     },
     {
-      title: "Overly long string value",
+      title: 'Overly long string value',
       description:
-        "Should error out with long string values over 32765 characters",
+        'Should error out with long string values over 32765 characters',
       test: () => {
         return adapter
-          .request("common/sendObj", getLongStringData(32767))
-          .catch((e) => e);
+          .request('common/sendObj', getLongStringData(32767))
+          .catch((e) => e)
       },
       assertion: (error: any) => {
-        return !!error && !!error.error && !!error.error.message;
+        return !!error && !!error.error && !!error.error.message
       }
     },
     {
-      title: "Single numeric value",
-      description: "Should send an object with a single numeric value",
+      title: 'Single numeric value',
+      description: 'Should send an object with a single numeric value',
       test: () => {
-        return adapter.request("common/sendObj", numericData);
+        return adapter.request('common/sendObj', numericData)
       },
       assertion: (res: any) => {
-        return res.table1[0].COL1 === numericData.table1[0].col1;
+        return res.table1[0].COL1 === numericData.table1[0].col1
       }
     },
 
     {
-      title: "Large data volume",
-      description: "Should send an object with a large amount of data",
+      title: 'Large data volume',
+      description: 'Should send an object with a large amount of data',
       test: () => {
-        return adapter.request("common/sendObj", getLargeObjectData());
+        return adapter.request('common/sendObj', getLargeObjectData())
       },
       assertion: (res: any) => {
-        const data = getLargeObjectData();
-        return res.table1[9000].BIG === data.table1[9000].big;
+        const data = getLargeObjectData()
+        return res.table1[9000].BIG === data.table1[9000].big
       }
     },
     {
-      title: "Multiple columns",
-      description: "Should handle data with multiple columns",
+      title: 'Multiple columns',
+      description: 'Should handle data with multiple columns',
       test: () => {
-        return adapter.request("common/sendObj", multiColumnData);
+        return adapter.request('common/sendObj', multiColumnData)
       },
       assertion: (res: any) => {
         return (
@@ -257,62 +304,63 @@ export const sendObjTests = (adapter: SASjs): TestSuite => ({
           res.table1[0].COL2 === multiColumnData.table1[0].col2 &&
           res.table1[0].COL3 === multiColumnData.table1[0].col3 &&
           res.table1[0].COL4 === multiColumnData.table1[0].col4
-        );
+        )
       }
     },
     {
-      title: "Multiple rows with nulls",
-      description: "Should handle data with multiple rows with null values",
+      title: 'Multiple rows with nulls',
+      description: 'Should handle data with multiple rows with null values',
       test: () => {
-        return adapter.request("common/sendObj", multipleRowsWithNulls);
+        return adapter.request('common/sendObj', multipleRowsWithNulls)
       },
       assertion: (res: any) => {
-        let result = true;
+        let result = true
         multipleRowsWithNulls.table1.forEach((_: any, index: number) => {
           result =
             result &&
-            res.table1[index].COL1 === multipleRowsWithNulls.table1[index].col1;
+            res.table1[index].COL1 === multipleRowsWithNulls.table1[index].col1
           result =
             result &&
-            res.table1[index].COL2 === multipleRowsWithNulls.table1[index].col2;
+            res.table1[index].COL2 === multipleRowsWithNulls.table1[index].col2
           result =
             result &&
-            res.table1[index].COL3 === multipleRowsWithNulls.table1[index].col3;
+            res.table1[index].COL3 === multipleRowsWithNulls.table1[index].col3
           result =
             result &&
-            res.table1[index].COL4 === multipleRowsWithNulls.table1[index].col4;
-        });
-        return result;
+            res.table1[index].COL4 ===
+              (multipleRowsWithNulls.table1[index].col4 || ' ')
+        })
+        return result
       }
     },
     {
-      title: "Multiple columns with nulls",
-      description: "Should handle data with multiple columns with null values",
+      title: 'Multiple columns with nulls',
+      description: 'Should handle data with multiple columns with null values',
       test: () => {
-        return adapter.request("common/sendObj", multipleColumnsWithNulls);
+        return adapter.request('common/sendObj', multipleColumnsWithNulls)
       },
       assertion: (res: any) => {
-        let result = true;
+        let result = true
         multipleColumnsWithNulls.table1.forEach((_: any, index: number) => {
           result =
             result &&
             res.table1[index].COL1 ===
-              multipleColumnsWithNulls.table1[index].col1;
+              multipleColumnsWithNulls.table1[index].col1
           result =
             result &&
             res.table1[index].COL2 ===
-              multipleColumnsWithNulls.table1[index].col2;
+              multipleColumnsWithNulls.table1[index].col2
           result =
             result &&
             res.table1[index].COL3 ===
-              multipleColumnsWithNulls.table1[index].col3;
+              multipleColumnsWithNulls.table1[index].col3
           result =
             result &&
             res.table1[index].COL4 ===
-              (multipleColumnsWithNulls.table1[index].col4 || "");
-        });
-        return result;
+              (multipleColumnsWithNulls.table1[index].col4 || ' ')
+        })
+        return result
       }
     }
   ]
-});
+})

sasjs-tests/src/testSuites/SasjsRequests.ts

@@ -1,49 +1,49 @@
-import SASjs from "@sasjs/adapter";
-import { TestSuite } from "@sasjs/test-framework";
+import SASjs from '@sasjs/adapter'
+import { TestSuite } from '@sasjs/test-framework'
 
-const data: any = { table1: [{ col1: "first col value" }] };
+const data: any = { table1: [{ col1: 'first col value' }] }
 
 export const sasjsRequestTests = (adapter: SASjs): TestSuite => ({
-  name: "SASjs Requests",
+  name: 'SASjs Requests',
   tests: [
     {
-      title: "WORK tables",
-      description: "Should get WORK tables after request",
+      title: 'WORK tables',
+      description: 'Should get WORK tables after request',
       test: async () => {
-        return adapter.request("common/sendArr", data);
+        return adapter.request('common/sendArr', data)
       },
       assertion: () => {
-        const requests = adapter.getSasRequests();
+        const requests = adapter.getSasRequests()
         if (adapter.getSasjsConfig().debug) {
-          return requests[0].SASWORK !== null;
+          return requests[0].SASWORK !== null
         } else {
-          return requests[0].SASWORK === null;
+          return requests[0].SASWORK === null
         }
       }
     },
     {
-      title: "Make error and capture log",
+      title: 'Make error and capture log',
       description:
-        "Should make an error and capture log, in the same time it is testing if debug override is working",
+        'Should make an error and capture log, in the same time it is testing if debug override is working',
       test: async () => {
         return adapter
-          .request("common/makeErr", data, { debug: true })
+          .request('common/makeErr', data, { debug: true })
           .catch(() => {
-            const sasRequests = adapter.getSasRequests();
+            const sasRequests = adapter.getSasRequests()
             const makeErrRequest: any =
-              sasRequests.find((req) => req.serviceLink.includes("makeErr")) ||
-              null;
+              sasRequests.find((req) => req.serviceLink.includes('makeErr')) ||
+              null
 
-            if (!makeErrRequest) return false;
+            if (!makeErrRequest) return false
 
             return !!(
               makeErrRequest.logFile && makeErrRequest.logFile.length > 0
-            );
-          });
+            )
+          })
       },
       assertion: (response) => {
-        return response;
+        return response
       }
     }
   ]
-});
+})

sasjs-tests/src/testSuites/SpecialCases.ts

@@ -1,91 +1,92 @@
-import SASjs from "@sasjs/adapter";
-import { TestSuite } from "@sasjs/test-framework";
+import SASjs from '@sasjs/adapter'
+import { TestSuite } from '@sasjs/test-framework'
 
 const specialCharData: any = {
   table1: [
     {
-      tab: "\t",
-      lf: "\n",
-      cr: "\r",
-      semicolon: ";semi",
-      percent: "%",
+      tab: '\t',
+      lf: '\n',
+      cr: '\r',
+      semicolon: ';semi',
+      percent: '%',
       singleQuote: "'",
       doubleQuote: '"',
-      crlf: "\r\n",
-      euro: "€euro",
-      banghash: "!#banghash"
+      crlf: '\r\n',
+      euro: '€euro',
+      banghash: '!#banghash',
+      dot: '.'
     }
   ]
-};
+}
 
 const moreSpecialCharData: any = {
   table1: [
     {
       speech0: '"speech',
-      pct: "%percent",
+      pct: '%percent',
       speech: '"speech',
-      slash: "\\slash",
-      slashWithSpecial: "\\\tslash",
-      macvar: "&sysuserid",
-      chinese: "传/傳chinese",
-      sigma: "Σsigma",
-      at: "@at",
-      serbian: "Српски",
-      dollar: "$"
+      slash: '\\slash',
+      slashWithSpecial: '\\\tslash',
+      macvar: '&sysuserid',
+      chinese: '传/傳chinese',
+      sigma: 'Σsigma',
+      at: '@at',
+      serbian: 'Српски',
+      dollar: '$'
     }
   ]
-};
+}
 
 const getWideData = () => {
-  const cols: any = {};
+  const cols: any = {}
   for (let i = 1; i <= 10000; i++) {
-    cols["col" + i] = "test" + i;
+    cols['col' + i] = 'test' + i
   }
 
   const data: any = {
     table1: [cols]
-  };
+  }
 
-  return data;
-};
+  return data
+}
 
 const getTables = () => {
-  const tables: any = {};
+  const tables: any = {}
 
   for (let i = 1; i <= 100; i++) {
-    tables["table" + i] = [{ col1: "x", col2: "x", col3: "x", col4: "x" }];
+    tables['table' + i] = [{ col1: 'x', col2: 'x', col3: 'x', col4: 'x' }]
   }
-  return tables;
-};
+  return tables
+}
 
 const getLargeDataset = () => {
-  const rows: any = [];
+  const rows: any = []
   const colData: string =
-    "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx";
+    'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
   for (let i = 1; i <= 10000; i++) {
-    rows.push({ col1: colData, col2: colData, col3: colData, col4: colData });
+    rows.push({ col1: colData, col2: colData, col3: colData, col4: colData })
   }
 
   const data: any = {
     table1: rows
-  };
+  }
 
-  return data;
-};
+  return data
+}
 
 const errorAndCsrfData: any = {
-  error: [{ col1: "q", col2: "w", col3: "e", col4: "r" }],
-  _csrf: [{ col1: "q", col2: "w", col3: "e", col4: "r" }]
-};
+  error: [{ col1: 'q', col2: 'w', col3: 'e', col4: 'r' }],
+  _csrf: [{ col1: 'q', col2: 'w', col3: 'e', col4: 'r' }]
+}
 
 export const specialCaseTests = (adapter: SASjs): TestSuite => ({
-  name: "Special Cases",
+  name: 'Special Cases',
   tests: [
     {
-      title: "Common special characters",
-      description: "Should handle common special characters",
+      title: 'Common special characters',
+      description: 'Should handle common special characters',
       test: () => {
-        return adapter.request("common/sendArr", specialCharData);
+        return adapter.request('common/sendArr', specialCharData)
       },
       assertion: (res: any) => {
         return (
@@ -96,17 +97,18 @@ export const specialCaseTests = (adapter: SASjs): TestSuite => ({
           res.table1[0][4] === specialCharData.table1[0].percent &&
           res.table1[0][5] === specialCharData.table1[0].singleQuote &&
           res.table1[0][6] === specialCharData.table1[0].doubleQuote &&
-          res.table1[0][7] === "\n" &&
+          res.table1[0][7] === '\n' &&
           res.table1[0][8] === specialCharData.table1[0].euro &&
-          res.table1[0][9] === specialCharData.table1[0].banghash
-        );
+          res.table1[0][9] === specialCharData.table1[0].banghash &&
+          res.table1[0][10] === specialCharData.table1[0].dot
+        )
       }
     },
     {
-      title: "Other special characters",
-      description: "Should handle other special characters",
+      title: 'Other special characters',
+      description: 'Should handle other special characters',
       test: () => {
-        return adapter.request("common/sendArr", moreSpecialCharData);
+        return adapter.request('common/sendArr', moreSpecialCharData)
       },
       assertion: (res: any) => {
         return (
@@ -121,50 +123,50 @@ export const specialCaseTests = (adapter: SASjs): TestSuite => ({
           res.table1[0][8] === moreSpecialCharData.table1[0].at &&
           res.table1[0][9] === moreSpecialCharData.table1[0].serbian &&
           res.table1[0][10] === moreSpecialCharData.table1[0].dollar
-        );
+        )
       }
     },
     {
-      title: "Wide table with sendArr",
-      description: "Should handle data with 10000 columns",
+      title: 'Wide table with sendArr',
+      description: 'Should handle data with 10000 columns',
       test: () => {
-        return adapter.request("common/sendArr", getWideData());
+        return adapter.request('common/sendArr', getWideData())
       },
       assertion: (res: any) => {
-        const data = getWideData();
-        let result = true;
+        const data = getWideData()
+        let result = true
         for (let i = 0; i <= 10; i++) {
           result =
-            result && res.table1[0][i] === data.table1[0]["col" + (i + 1)];
+            result && res.table1[0][i] === data.table1[0]['col' + (i + 1)]
         }
-        return result;
+        return result
       }
     },
     {
-      title: "Wide table with sendObj",
-      description: "Should handle data with 10000 columns",
+      title: 'Wide table with sendObj',
+      description: 'Should handle data with 10000 columns',
       test: () => {
-        return adapter.request("common/sendObj", getWideData());
+        return adapter.request('common/sendObj', getWideData())
       },
       assertion: (res: any) => {
-        const data = getWideData();
-        let result = true;
+        const data = getWideData()
+        let result = true
         for (let i = 0; i <= 10; i++) {
           result =
             result &&
-            res.table1[0]["COL" + (i + 1)] === data.table1[0]["col" + (i + 1)];
+            res.table1[0]['COL' + (i + 1)] === data.table1[0]['col' + (i + 1)]
         }
-        return result;
+        return result
       }
     },
     {
-      title: "Multiple tables",
-      description: "Should handle data with 100 tables",
+      title: 'Multiple tables',
+      description: 'Should handle data with 100 tables',
       test: () => {
-        return adapter.request("common/sendArr", getTables());
+        return adapter.request('common/sendArr', getTables())
       },
       assertion: (res: any) => {
-        const data = getTables();
+        const data = getTables()
         return (
           res.table1[0][0] === data.table1[0].col1 &&
           res.table1[0][1] === data.table1[0].col2 &&
@@ -174,45 +176,45 @@ export const specialCaseTests = (adapter: SASjs): TestSuite => ({
           res.table50[0][1] === data.table50[0].col2 &&
           res.table50[0][2] === data.table50[0].col3 &&
           res.table50[0][3] === data.table50[0].col4
-        );
+        )
       }
     },
     {
-      title: "Large dataset with sendObj",
-      description: "Should handle 5mb of data",
+      title: 'Large dataset with sendObj',
+      description: 'Should handle 5mb of data',
       test: () => {
-        return adapter.request("common/sendObj", getLargeDataset());
+        return adapter.request('common/sendObj', getLargeDataset())
       },
       assertion: (res: any) => {
-        const data = getLargeDataset();
-        let result = true;
+        const data = getLargeDataset()
+        let result = true
         for (let i = 0; i <= 10; i++) {
-          result = result && res.table1[i][0] === data.table1[i][0];
+          result = result && res.table1[i][0] === data.table1[i][0]
         }
-        return result;
+        return result
       }
     },
     {
-      title: "Large dataset with sendArr",
-      description: "Should handle 5mb of data",
+      title: 'Large dataset with sendArr',
+      description: 'Should handle 5mb of data',
       test: () => {
-        return adapter.request("common/sendArr", getLargeDataset());
+        return adapter.request('common/sendArr', getLargeDataset())
       },
       assertion: (res: any) => {
-        const data = getLargeDataset();
-        let result = true;
+        const data = getLargeDataset()
+        let result = true
         for (let i = 0; i <= 10; i++) {
           result =
-            result && res.table1[i][0] === Object.values(data.table1[i])[0];
+            result && res.table1[i][0] === Object.values(data.table1[i])[0]
         }
-        return result;
+        return result
       }
     },
     {
-      title: "Error and _csrf tables with sendArr",
-      description: "Should handle error and _csrf tables",
+      title: 'Error and _csrf tables with sendArr',
+      description: 'Should handle error and _csrf tables',
       test: () => {
-        return adapter.request("common/sendArr", errorAndCsrfData);
+        return adapter.request('common/sendArr', errorAndCsrfData)
       },
       assertion: (res: any) => {
         return (
@@ -224,14 +226,14 @@ export const specialCaseTests = (adapter: SASjs): TestSuite => ({
           res._csrf[0][1] === errorAndCsrfData._csrf[0].col2 &&
           res._csrf[0][2] === errorAndCsrfData._csrf[0].col3 &&
           res._csrf[0][3] === errorAndCsrfData._csrf[0].col4
-        );
+        )
       }
     },
     {
-      title: "Error and _csrf tables with sendObj",
-      description: "Should handle error and _csrf tables",
+      title: 'Error and _csrf tables with sendObj',
+      description: 'Should handle error and _csrf tables',
       test: () => {
-        return adapter.request("common/sendObj", errorAndCsrfData);
+        return adapter.request('common/sendObj', errorAndCsrfData)
       },
       assertion: (res: any) => {
         return (
@@ -243,8 +245,8 @@ export const specialCaseTests = (adapter: SASjs): TestSuite => ({
           res._csrf[0].COL2 === errorAndCsrfData._csrf[0].col2 &&
           res._csrf[0].COL3 === errorAndCsrfData._csrf[0].col3 &&
           res._csrf[0].COL4 === errorAndCsrfData._csrf[0].col4
-        );
+        )
       }
     }
   ]
-});
+})

sasjs-tests/src/utils/Assert.ts

@@ -1,22 +1,22 @@
 export const assert = (
   expression: boolean | (() => boolean),
-  message = "Assertion failed"
+  message = 'Assertion failed'
 ) => {
-  let result;
+  let result
   try {
-    if (typeof expression === "boolean") {
-      result = expression;
+    if (typeof expression === 'boolean') {
+      result = expression
     } else {
-      result = expression();
+      result = expression()
     }
   } catch (e) {
-    console.error(message);
-    throw new Error(message);
+    console.error(message)
+    throw new Error(message)
   }
   if (!!result) {
-    return;
+    return
   } else {
-    console.error(message);
-    throw new Error(message);
+    console.error(message)
+    throw new Error(message)
   }
-};
+}

src/ContextManager.ts

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

src/FileUploader.ts

@@ -1,70 +0,0 @@
-import { isUrl } from './utils'
-import { UploadFile } from './types/UploadFile'
-import { ErrorResponse, LoginRequiredError } from './types/errors'
-import { RequestClient } from './request/RequestClient'
-
-export class FileUploader {
-  constructor(
-    private appLoc: string,
-    serverUrl: string,
-    private jobsPath: string,
-    private requestClient: RequestClient
-  ) {
-    if (serverUrl) isUrl(serverUrl)
-  }
-
-  public uploadFile(sasJob: string, files: UploadFile[], params: any) {
-    if (files?.length < 1)
-      return Promise.reject(
-        new ErrorResponse('At least one file must be provided.')
-      )
-    if (!sasJob || sasJob === '')
-      return Promise.reject(new ErrorResponse('sasJob must be provided.'))
-
-    let paramsString = ''
-
-    for (let param in params) {
-      if (params.hasOwnProperty(param)) {
-        paramsString += `&${param}=${params[param]}`
-      }
-    }
-
-    const program = this.appLoc
-      ? this.appLoc.replace(/\/?$/, '/') + sasJob.replace(/^\//, '')
-      : sasJob
-    const uploadUrl = `${this.jobsPath}/?${
-      '_program=' + program
-    }${paramsString}`
-
-    const formData = new FormData()
-
-    for (let file of files) {
-      formData.append('file', file.file, file.fileName)
-    }
-
-    const csrfToken = this.requestClient.getCsrfToken('file')
-    if (csrfToken) formData.append('_csrf', csrfToken.value)
-
-    const headers = {
-      'cache-control': 'no-cache',
-      Accept: '*/*',
-      'Content-Type': 'text/plain'
-    }
-
-    return this.requestClient
-      .post(uploadUrl, formData, undefined, 'application/json', headers)
-      .then((res) =>
-        typeof res.result === 'string' ? JSON.parse(res.result) : res.result
-      )
-      .catch((err: Error) => {
-        if (err instanceof LoginRequiredError) {
-          return Promise.reject(
-            new ErrorResponse('You must be logged in to upload a file.', err)
-          )
-        }
-        return Promise.reject(
-          new ErrorResponse('File upload request failed.', err)
-        )
-      })
-  }
-}

src/SAS9ApiClient.ts

@@ -1,4 +1,6 @@
-import axios, { AxiosInstance } from 'axios'
+import { generateTimestamp } from '@sasjs/utils/time'
+import * as NodeFormData from 'form-data'
+import { Sas9RequestClient } from './request/Sas9RequestClient'
 import { isUrl } from './utils'
 
 /**
@@ -6,11 +8,15 @@ import { isUrl } from './utils'
  *
  */
 export class SAS9ApiClient {
-  private httpClient: AxiosInstance
+  private requestClient: Sas9RequestClient
 
-  constructor(private serverUrl: string) {
+  constructor(
+    private serverUrl: string,
+    private jobsPath: string,
+    allowInsecureRequests: boolean
+  ) {
     if (serverUrl) isUrl(serverUrl)
-    this.httpClient = axios.create({ baseURL: this.serverUrl })
+    this.requestClient = new Sas9RequestClient(serverUrl, allowInsecureRequests)
   }
 
   /**
@@ -33,27 +39,61 @@ export class SAS9ApiClient {
   /**
    * Executes code on a SAS9 server.
    * @param linesOfCode - an array of code lines to execute.
-   * @param serverName - the server to execute the code on.
-   * @param repositoryName - the repository to execute the code in.
+   * @param userName - the user name to log into the current SAS server.
+   * @param password - the password to log into the current SAS server.
    */
   public async executeScript(
     linesOfCode: string[],
-    serverName: string,
-    repositoryName: string
+    userName: string,
+    password: string
   ) {
-    const requestPayload = linesOfCode.join('\n')
+    await this.requestClient.login(userName, password, this.jobsPath)
 
-    const executeScriptResponse = await this.httpClient.put(
-      `/sas/servers/${serverName}/cmd?repositoryName=${repositoryName}`,
-      `command=${requestPayload}`,
-      {
-        headers: {
-          Accept: 'application/json'
-        },
-        responseType: 'text'
-      }
+    // This piece of code forces a webout to prevent Stored Process Errors.
+    const forceOutputCode = [
+      'data _null_;',
+      'file _webout;',
+      `put 'Executed sasjs run';`,
+      'run;'
+    ]
+    const formData = generateFileUploadForm(
+      [...linesOfCode, ...forceOutputCode].join('\n')
     )
 
-    return executeScriptResponse.data
+    const codeInjectorPath = `/User Folders/${userName}/My Folder/sasjs/runner`
+    const contentType =
+      'multipart/form-data; boundary=' + formData.getBoundary()
+    const contentLength = formData.getLengthSync()
+
+    const headers = {
+      'cache-control': 'no-cache',
+      Accept: '*/*',
+      'Content-Type': contentType,
+      'Content-Length': contentLength,
+      Connection: 'keep-alive'
+    }
+    const storedProcessUrl = `${this.jobsPath}/?${
+      '_program=' + codeInjectorPath + '&_debug=log'
+    }`
+    const response = await this.requestClient.post(
+      storedProcessUrl,
+      formData,
+      undefined,
+      contentType,
+      headers
+    )
+
+    return response.result as string
   }
 }
+
+const generateFileUploadForm = (data: any): NodeFormData => {
+  const formData = new NodeFormData()
+  const filename = `sasjs-execute-sas9-${generateTimestamp('')}.sas`
+  formData.append(filename, data, {
+    filename,
+    contentType: 'text/plain'
+  })
+
+  return formData
+}

src/SASViyaApiClient.spec.ts

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

src/SASViyaApiClient.ts

@@ -1,10 +1,4 @@
-import {
-  convertToCSV,
-  isRelativePath,
-  isUri,
-  isUrl,
-  fetchLogByChunks
-} from './utils'
+import { isRelativePath, isUri, isUrl } from './utils'
 import * as NodeFormData from 'form-data'
 import {
   Job,
@@ -12,24 +6,24 @@ import {
   Context,
   ContextAllAttributes,
   Folder,
+  File,
   EditContextInput,
   JobDefinition,
   PollOptions
 } from './types'
-import {
-  ComputeJobExecutionError,
-  JobExecutionError,
-  NotFoundError
-} from './types/errors'
-import { formatDataForRequest } from './utils/formatDataForRequest'
+import { JobExecutionError, RootFolderNotFoundError } from './types/errors'
 import { SessionManager } from './SessionManager'
 import { ContextManager } from './ContextManager'
-import { timestampToYYYYMMDDHHMMSS } from '@sasjs/utils/time'
-import { Logger, LogLevel } from '@sasjs/utils/logger'
+import { SasAuthResponse, MacroVar, AuthConfig } from '@sasjs/utils/types'
 import { isAuthorizeFormRequired } from './auth/isAuthorizeFormRequired'
 import { RequestClient } from './request/RequestClient'
-import { SasAuthResponse } from '@sasjs/utils/types'
 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 { getAccessToken } from './auth/getAccessToken'
+import { refreshTokens } from './auth/refreshTokens'
 
 /**
  * A client for interfacing with the SAS Viya REST API.
@@ -57,6 +51,16 @@ export class SASViyaApiClient {
   )
   private folderMap = new Map<string, Job[]>()
 
+  /**
+   * A helper method used to call appendRequest method of RequestClient
+   * @param response - response from sasjs request
+   * @param program - name of program
+   * @param debug - a boolean that indicates whether debug was enabled or not
+   */
+  public appendRequest(response: any, program: string, debug: boolean) {
+    this.requestClient!.appendRequest(response, program, debug)
+  }
+
   public get debug() {
     return this._debug
   }
@@ -128,14 +132,14 @@ export class SASViyaApiClient {
 
   /**
    * Returns all compute contexts on this server that the user has access to.
-   * @param accessToken - an access token for an authorized user.
+   * @param authConfig - an access token, refresh token, client and secret for an authorized user.
    */
-  public async getExecutableContexts(accessToken?: string) {
+  public async getExecutableContexts(authConfig?: AuthConfig) {
     const bindedExecuteScript = this.executeScript.bind(this)
 
     return await this.contextManager.getExecutableContexts(
       bindedExecuteScript,
-      accessToken
+      authConfig
     )
   }
 
@@ -165,13 +169,6 @@ export class SASViyaApiClient {
       throw new Error(`Execution context ${contextName} not found.`)
     }
 
-    const createSessionRequest = {
-      method: 'POST',
-      headers: {
-        Authorization: `Bearer ${accessToken}`,
-        'Content-Type': 'application/json'
-      }
-    }
     const { result: createdSession } = await this.requestClient.post<Session>(
       `/compute/contexts/${executionContext.id}/sessions`,
       {},
@@ -264,261 +261,44 @@ export class SASViyaApiClient {
    * @param jobPath - the path to the file being submitted for execution.
    * @param linesOfCode - an array of code lines to execute.
    * @param contextName - the context to execute the code in.
-   * @param accessToken - an access token for an authorized user.
+   * @param authConfig - an object containing an access token, refresh token, client ID and secret.
    * @param data - execution data.
    * @param debug - when set to true, the log will be returned.
    * @param expectWebout - when set to true, the automatic _webout fileref will be checked for content, and that content returned. This fileref is used when the Job contains a SASjs web request (as opposed to executing arbitrary SAS code).
    * @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 printPid - a boolean that indicates whether the function should print (PID) of the started job.
+   * @param variables - an object that represents macro variables.
    */
   public async executeScript(
     jobPath: string,
     linesOfCode: string[],
     contextName: string,
-    accessToken?: string,
+    authConfig?: AuthConfig,
     data = null,
     debug: boolean = false,
     expectWebout = false,
     waitForResult = true,
     pollOptions?: PollOptions,
-    printPid = false
+    printPid = false,
+    variables?: MacroVar
   ): Promise<any> {
-    try {
-      const headers: any = {
-        'Content-Type': 'application/json'
-      }
-
-      if (accessToken) headers.Authorization = `Bearer ${accessToken}`
-
-      let executionSessionId: string
-
-      const session = await this.sessionManager
-        .getSession(accessToken)
-        .catch((err) => {
-          throw prefixMessage(err, 'Error while getting session. ')
-        })
-
-      executionSessionId = session!.id
-
-      if (printPid) {
-        const { result: jobIdVariable } = await this.sessionManager
-          .getVariable(executionSessionId, 'SYSJOBID', accessToken)
-          .catch((err) => {
-            throw prefixMessage(err, 'Error while getting session variable. ')
-          })
-
-        if (jobIdVariable && jobIdVariable.value) {
-          const relativeJobPath = this.rootFolderName
-            ? jobPath.split(this.rootFolderName).join('').replace(/^\//, '')
-            : jobPath
-
-          const logger = new Logger(debug ? LogLevel.Debug : LogLevel.Info)
-
-          logger.info(
-            `Triggered '${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
-        jobArguments['_DEBUG'] = 131
-      }
-
-      let fileName
-
-      if (isRelativePath(jobPath)) {
-        fileName = `exec-${
-          jobPath.includes('/') ? jobPath.split('/')[1] : jobPath
-        }`
-      } else {
-        const jobPathParts = jobPath.split('/')
-        fileName = jobPathParts.pop()
-      }
-
-      let jobVariables: any = {
-        SYS_JES_JOB_URI: '',
-        _program: isRelativePath(jobPath)
-          ? this.rootFolderName + '/' + jobPath
-          : jobPath
-      }
-
-      let files: any[] = []
-
-      if (data) {
-        if (JSON.stringify(data).includes(';')) {
-          files = await this.uploadTables(data, accessToken).catch((err) => {
-            throw prefixMessage(err, 'Error while uploading tables. ')
-          })
-
-          jobVariables['_webin_file_count'] = files.length
-
-          files.forEach((fileInfo, index) => {
-            jobVariables[
-              `_webin_fileuri${index + 1}`
-            ] = `/files/files/${fileInfo.file.id}`
-            jobVariables[`_webin_name${index + 1}`] = fileInfo.tableName
-          })
-        } else {
-          jobVariables = { ...jobVariables, ...formatDataForRequest(data) }
-        }
-      }
-
-      // Execute job in session
-      const jobRequestBody = {
-        name: fileName,
-        description: 'Powered by SASjs',
-        code: linesOfCode,
-        variables: jobVariables,
-        arguments: jobArguments
-      }
-
-      const { result: postedJob, etag } = await this.requestClient
-        .post<Job>(
-          `/compute/sessions/${executionSessionId}/jobs`,
-          jobRequestBody,
-          accessToken
-        )
-        .catch((err) => {
-          throw prefixMessage(err, 'Error while posting job. ')
-        })
-
-      if (!waitForResult) return session
-
-      if (debug) {
-        console.log(`Job has been submitted for '${fileName}'.`)
-        console.log(
-          `You can monitor the job progress at '${this.serverUrl}${
-            postedJob.links.find((l: any) => l.rel === 'state')!.href
-          }'.`
-        )
-      }
-
-      const jobStatus = await this.pollJobState(
-        postedJob,
-        etag,
-        accessToken,
-        pollOptions
-      ).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 sessionLogUrl =
-            postedJob.links.find((l: any) => l.rel === 'up')!.href + '/log'
-          const logCount = 1000000
-          err.log = await fetchLogByChunks(
-            this.requestClient,
-            accessToken!,
-            sessionLogUrl,
-            logCount
-          )
-        }
-        throw prefixMessage(err, 'Error while polling job status. ')
-      })
-
-      const { result: currentJob } = await this.requestClient
-        .get<Job>(
-          `/compute/sessions/${executionSessionId}/jobs/${postedJob.id}`,
-          accessToken
-        )
-        .catch((err) => {
-          throw prefixMessage(err, 'Error while getting job. ')
-        })
-
-      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(
-          this.requestClient,
-          accessToken!,
-          logUrl,
-          logCount
-        )
-      }
-
-      if (jobStatus === 'failed' || jobStatus === 'error') {
-        return Promise.reject(new ComputeJobExecutionError(currentJob, log))
-      }
-
-      let resultLink
-
-      if (expectWebout) {
-        resultLink = `/compute/sessions/${executionSessionId}/filerefs/_webout/content`
-      } else {
-        return { job: currentJob, log }
-      }
-
-      if (resultLink) {
-        jobResult = await this.requestClient
-          .get<any>(resultLink, accessToken, 'text/plain')
-          .catch(async (e) => {
-            if (e instanceof NotFoundError) {
-              if (logLink) {
-                const logUrl = `${logLink.href}/content`
-                const logCount = currentJob.logStatistics?.lineCount ?? 1000000
-                log = await fetchLogByChunks(
-                  this.requestClient,
-                  accessToken!,
-                  logUrl,
-                  logCount
-                )
-
-                return Promise.reject({
-                  status: 500,
-                  log
-                })
-              }
-            }
-
-            return {
-              result: JSON.stringify(e)
-            }
-          })
-      }
-
-      await this.sessionManager
-        .clearSession(executionSessionId, accessToken)
-        .catch((err) => {
-          throw prefixMessage(err, 'Error while clearing session. ')
-        })
-
-      return { result: jobResult?.result, log }
-    } catch (e) {
-      if (e && e.status === 404) {
-        return this.executeScript(
-          jobPath,
-          linesOfCode,
-          contextName,
-          accessToken,
-          data,
-          debug,
-          false,
-          true
-        )
-      } else {
-        throw prefixMessage(e, 'Error while executing script. ')
-      }
-    }
+    return executeScript(
+      this.requestClient,
+      this.sessionManager,
+      this.rootFolderName,
+      jobPath,
+      linesOfCode,
+      contextName,
+      authConfig,
+      data,
+      debug,
+      expectWebout,
+      waitForResult,
+      pollOptions,
+      printPid,
+      variables
+    )
   }
 
   /**
@@ -532,6 +312,50 @@ export class SASViyaApiClient {
       .then((res) => res.result)
   }
 
+  /**
+   * Creates a file. Path to or URI of the parent folder is required.
+   * @param fileName - the name of the new file.
+   * @param contentBuffer - the content of the new file in Buffer.
+   * @param parentFolderPath - the full path to the parent folder.  If not
+   *  provided, the parentFolderUri must be provided.
+   * @param parentFolderUri - the URI (eg /folders/folders/UUID) of the parent
+   *  folder. If not provided, the parentFolderPath must be provided.
+   * @param accessToken - an access token for authorizing the request.
+   */
+  public async createFile(
+    fileName: string,
+    contentBuffer: Buffer,
+    parentFolderPath?: string,
+    parentFolderUri?: string,
+    accessToken?: string
+  ): Promise<File> {
+    if (!parentFolderPath && !parentFolderUri) {
+      throw new Error('Path or URI of the parent folder is required.')
+    }
+
+    if (!parentFolderUri && parentFolderPath) {
+      parentFolderUri = await this.getFolderUri(parentFolderPath, accessToken)
+    }
+
+    const headers = {
+      Accept: 'application/vnd.sas.file+json',
+      'Content-Disposition': `filename="${fileName}";`
+    }
+
+    const formData = new NodeFormData()
+    formData.append('file', contentBuffer, fileName)
+
+    return (
+      await this.requestClient.post<File>(
+        `/files/files?parentFolderUri=${parentFolderUri}&typeDefName=file#rawUpload`,
+        formData,
+        accessToken,
+        'multipart/form-data; boundary=' + (formData as any)._boundary,
+        headers
+      )
+    ).result
+  }
+
   /**
    * Creates a folder. Path to or URI of the parent folder is required.
    * @param folderName - the name of the new folder.
@@ -549,6 +373,7 @@ export class SASViyaApiClient {
     accessToken?: string,
     isForced?: boolean
   ): Promise<Folder> {
+    const logger = process.logger || console
     if (!parentFolderPath && !parentFolderUri) {
       throw new Error('Path or URI of the parent folder is required.')
     }
@@ -556,7 +381,7 @@ export class SASViyaApiClient {
     if (!parentFolderUri && parentFolderPath) {
       parentFolderUri = await this.getFolderUri(parentFolderPath, accessToken)
       if (!parentFolderUri) {
-        console.log(
+        logger.info(
           `Parent folder at path '${parentFolderPath}' is not present.`
         )
 
@@ -566,9 +391,13 @@ export class SASViyaApiClient {
         )
         const newFolderName = `${parentFolderPath.split('/').pop()}`
         if (newParentFolderPath === '') {
-          throw new Error('Root folder has to be present on the server.')
+          throw new RootFolderNotFoundError(
+            parentFolderPath,
+            this.serverUrl,
+            accessToken
+          )
         }
-        console.log(
+        logger.info(
           `Creating parent folder:\n'${newFolderName}' in '${newParentFolderPath}'`
         )
         const parentFolder = await this.createFolder(
@@ -577,7 +406,7 @@ export class SASViyaApiClient {
           undefined,
           accessToken
         )
-        console.log(
+        logger.info(
           `Parent folder '${newFolderName}' has been successfully created.`
         )
         parentFolderUri = `/folders/folders/${parentFolder.id}`
@@ -594,16 +423,15 @@ export class SASViyaApiClient {
       }
     }
 
-    const {
-      result: createFolderResponse
-    } = await this.requestClient.post<Folder>(
-      `/folders/folders?parentFolderUri=${parentFolderUri}`,
-      {
-        name: folderName,
-        type: 'folder'
-      },
-      accessToken
-    )
+    const { result: createFolderResponse } =
+      await this.requestClient.post<Folder>(
+        `/folders/folders?parentFolderUri=${parentFolderUri}`,
+        {
+          name: folderName,
+          type: 'folder'
+        },
+        accessToken
+      )
 
     // update folder map with newly created folder.
     await this.populateFolderMap(
@@ -706,39 +534,7 @@ export class SASViyaApiClient {
     clientSecret: string,
     authCode: string
   ): Promise<SasAuthResponse> {
-    const url = this.serverUrl + '/SASLogon/oauth/token'
-    let token
-    if (typeof Buffer === 'undefined') {
-      token = btoa(clientId + ':' + clientSecret)
-    } else {
-      token = Buffer.from(clientId + ':' + clientSecret).toString('base64')
-    }
-    const headers = {
-      Authorization: 'Basic ' + token
-    }
-
-    let formData
-    if (typeof FormData === 'undefined') {
-      formData = new NodeFormData()
-      formData.append('grant_type', 'authorization_code')
-      formData.append('code', authCode)
-    } else {
-      formData = new FormData()
-      formData.append('grant_type', 'authorization_code')
-      formData.append('code', authCode)
-    }
-
-    const authResponse = await this.requestClient
-      .post(
-        url,
-        formData,
-        undefined,
-        'multipart/form-data; boundary=' + (formData as any)._boundary,
-        headers
-      )
-      .then((res) => res.result as SasAuthResponse)
-
-    return authResponse
+    return getAccessToken(this.requestClient, clientId, clientSecret, authCode)
   }
 
   /**
@@ -752,39 +548,12 @@ export class SASViyaApiClient {
     clientSecret: string,
     refreshToken: string
   ) {
-    const url = this.serverUrl + '/SASLogon/oauth/token'
-    let token
-    if (typeof Buffer === 'undefined') {
-      token = btoa(clientId + ':' + clientSecret)
-    } else {
-      token = Buffer.from(clientId + ':' + clientSecret).toString('base64')
-    }
-    const headers = {
-      Authorization: 'Basic ' + token
-    }
-
-    let formData
-    if (typeof FormData === 'undefined') {
-      formData = new NodeFormData()
-      formData.append('grant_type', 'refresh_token')
-      formData.append('refresh_token', refreshToken)
-    } else {
-      formData = new FormData()
-      formData.append('grant_type', 'refresh_token')
-      formData.append('refresh_token', refreshToken)
-    }
-
-    const authResponse = await this.requestClient
-      .post<SasAuthResponse>(
-        url,
-        formData,
-        undefined,
-        'multipart/form-data; boundary=' + (formData as any)._boundary,
-        headers
-      )
-      .then((res) => res.result)
-
-    return authResponse
+    return refreshTokens(
+      this.requestClient,
+      clientId,
+      clientSecret,
+      refreshToken
+    )
   }
 
   /**
@@ -815,18 +584,25 @@ export class SASViyaApiClient {
    * @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 printPid - a boolean that indicates whether the function should print (PID) of the started job.
+   * @param variables - an object that represents macro variables.
    */
   public async executeComputeJob(
     sasJob: string,
     contextName: string,
     debug?: boolean,
     data?: any,
-    accessToken?: string,
+    authConfig?: AuthConfig,
     waitForResult = true,
     expectWebout = false,
     pollOptions?: PollOptions,
-    printPid = false
+    printPid = false,
+    variables?: MacroVar
   ) {
+    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'
@@ -840,7 +616,7 @@ export class SASViyaApiClient {
       ? `${this.rootFolderName}/${folderPath}`
       : folderPath
 
-    await this.populateFolderMap(fullFolderPath, accessToken).catch((err) => {
+    await this.populateFolderMap(fullFolderPath, access_token).catch((err) => {
       throw prefixMessage(err, 'Error while populating folder map. ')
     })
 
@@ -852,12 +628,6 @@ export class SASViyaApiClient {
       )
     }
 
-    const headers: any = { 'Content-Type': 'application/json' }
-
-    if (!!accessToken) {
-      headers.Authorization = `Bearer ${accessToken}`
-    }
-
     const jobToExecute = jobFolder?.find((item) => item.name === jobName)
 
     if (!jobToExecute) {
@@ -875,12 +645,10 @@ export class SASViyaApiClient {
         throw new Error(`URI of job definition was not found.`)
       }
 
-      const {
-        result: jobDefinition
-      } = await this.requestClient
+      const { result: jobDefinition } = await this.requestClient
         .get<JobDefinition>(
           `${this.serverUrl}${jobDefinitionLink.href}`,
-          accessToken
+          access_token
         )
         .catch((err) => {
           throw prefixMessage(err, 'Error while getting job definition. ')
@@ -900,13 +668,14 @@ export class SASViyaApiClient {
       sasJob,
       linesToExecute,
       contextName,
-      accessToken,
+      authConfig,
       data,
       debug,
       expectWebout,
       waitForResult,
       pollOptions,
-      printPid
+      printPid,
+      variables
     )
   }
 
@@ -923,8 +692,12 @@ export class SASViyaApiClient {
     contextName: string,
     debug: boolean,
     data?: any,
-    accessToken?: string
+    authConfig?: AuthConfig
   ) {
+    let access_token = (authConfig || {}).access_token
+    if (authConfig) {
+      ;({ access_token } = await getTokens(this.requestClient, authConfig))
+    }
     if (isRelativePath(sasJob) && !this.rootFolderName) {
       throw new Error(
         'Relative paths cannot be used without specifying a root folder name.'
@@ -937,7 +710,7 @@ export class SASViyaApiClient {
     const fullFolderPath = isRelativePath(sasJob)
       ? `${this.rootFolderName}/${folderPath}`
       : folderPath
-    await this.populateFolderMap(fullFolderPath, accessToken)
+    await this.populateFolderMap(fullFolderPath, access_token)
 
     const jobFolder = this.folderMap.get(fullFolderPath)
     if (!jobFolder) {
@@ -950,7 +723,7 @@ export class SASViyaApiClient {
 
     let files: any[] = []
     if (data && Object.keys(data).length) {
-      files = await this.uploadTables(data, accessToken)
+      files = await this.uploadTables(data, access_token)
     }
 
     if (!jobToExecute) {
@@ -962,7 +735,7 @@ export class SASViyaApiClient {
 
     const { result: jobDefinition } = await this.requestClient.get<Job>(
       `${this.serverUrl}${jobDefinitionLink}`,
-      accessToken
+      access_token
     )
 
     const jobArguments: { [key: string]: any } = {
@@ -995,21 +768,19 @@ export class SASViyaApiClient {
       jobDefinition,
       arguments: jobArguments
     }
-    const { result: postedJob, etag } = await this.requestClient.post<Job>(
+    const { result: postedJob } = await this.requestClient.post<Job>(
       `${this.serverUrl}/jobExecution/jobs?_action=wait`,
       postJobRequestBody,
-      accessToken
+      access_token
+    )
+    const jobStatus = await this.pollJobState(postedJob, authConfig).catch(
+      (err) => {
+        throw prefixMessage(err, 'Error while polling job status. ')
+      }
     )
-    const jobStatus = await this.pollJobState(
-      postedJob,
-      etag,
-      accessToken
-    ).catch((err) => {
-      throw prefixMessage(err, 'Error while polling job status. ')
-    })
     const { result: currentJob } = await this.requestClient.get<Job>(
       `${this.serverUrl}/jobExecution/jobs/${postedJob.id}`,
-      accessToken
+      access_token
     )
 
     let jobResult
@@ -1020,13 +791,13 @@ export class SASViyaApiClient {
     if (resultLink) {
       jobResult = await this.requestClient.get<any>(
         `${this.serverUrl}${resultLink}/content`,
-        accessToken,
+        access_token,
         'text/plain'
       )
     }
     if (debug && logLink) {
       log = await this.requestClient
-        .get<any>(`${this.serverUrl}${logLink.href}/content`, accessToken)
+        .get<any>(`${this.serverUrl}${logLink.href}/content`, access_token)
         .then((res: any) => res.result.items.map((i: any) => i.line).join('\n'))
     }
     if (jobStatus === 'failed') {
@@ -1072,126 +843,22 @@ export class SASViyaApiClient {
     this.folderMap.set(path, itemsAtRoot)
   }
 
-  // REFACTOR: set default value for 'pollOptions' attribute
   private async pollJobState(
-    postedJob: any,
-    etag: string | null,
-    accessToken?: string,
+    postedJob: Job,
+    authConfig?: AuthConfig,
     pollOptions?: PollOptions
   ) {
-    let POLL_INTERVAL = 300
-    let MAX_POLL_COUNT = 1000
-
-    if (pollOptions) {
-      POLL_INTERVAL = pollOptions.POLL_INTERVAL || POLL_INTERVAL
-      MAX_POLL_COUNT = pollOptions.MAX_POLL_COUNT || MAX_POLL_COUNT
-    }
-
-    let postedJobState = ''
-    let pollCount = 0
-    const headers: any = {
-      'Content-Type': 'application/json',
-      'If-None-Match': etag
-    }
-    if (accessToken) {
-      headers.Authorization = `Bearer ${accessToken}`
-    }
-    const stateLink = postedJob.links.find((l: any) => l.rel === 'state')
-    if (!stateLink) {
-      Promise.reject(`Job state link was not found.`)
-    }
-
-    const { result: state } = await this.requestClient
-      .get<string>(
-        `${this.serverUrl}${stateLink.href}?_action=wait&wait=30`,
-        accessToken,
-        'text/plain',
-        {},
-        this.debug
-      )
-      .catch((err) => {
-        throw prefixMessage(err, 'Error while getting job state. ')
-      })
-
-    const currentState = state.trim()
-    if (currentState === 'completed') {
-      return Promise.resolve(currentState)
-    }
-
-    return new Promise(async (resolve, _) => {
-      let printedState = ''
-
-      const interval = setInterval(async () => {
-        if (
-          postedJobState === 'running' ||
-          postedJobState === '' ||
-          postedJobState === 'pending'
-        ) {
-          if (stateLink) {
-            const { result: jobState } = await this.requestClient
-              .get<string>(
-                `${this.serverUrl}${stateLink.href}?_action=wait&wait=30`,
-                accessToken,
-                'text/plain',
-                {},
-                this.debug
-              )
-              .catch((err) => {
-                throw prefixMessage(
-                  err,
-                  'Error while getting job state after interval. '
-                )
-              })
-
-            postedJobState = jobState.trim()
-
-            if (this.debug && printedState !== postedJobState) {
-              console.log('Polling job status...')
-              console.log(`Current job state: ${postedJobState}`)
-
-              printedState = postedJobState
-            }
-
-            pollCount++
-
-            if (pollCount >= MAX_POLL_COUNT) {
-              resolve(postedJobState)
-            }
-          }
-        } else {
-          clearInterval(interval)
-          resolve(postedJobState)
-        }
-      }, POLL_INTERVAL)
-    })
+    return pollJobState(
+      this.requestClient,
+      postedJob,
+      this.debug,
+      authConfig,
+      pollOptions
+    )
   }
 
   private async uploadTables(data: any, accessToken?: string) {
-    const uploadedFiles = []
-    const headers: any = {
-      'Content-Type': 'application/json'
-    }
-    if (accessToken) {
-      headers.Authorization = `Bearer ${accessToken}`
-    }
-
-    for (const tableName in data) {
-      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 uploadResponse = await this.requestClient
-        .uploadFile(`${this.serverUrl}/files/files#rawUpload`, csv, accessToken)
-        .catch((err) => {
-          throw prefixMessage(err, 'Error while uploading file. ')
-        })
-
-      uploadedFiles.push({ tableName, file: uploadResponse.result })
-    }
-    return uploadedFiles
+    return uploadTables(this.requestClient, data, accessToken)
   }
 
   private async getFolderDetails(
@@ -1280,14 +947,6 @@ export class SASViyaApiClient {
       ? sourceFolder
       : await this.getFolderUri(sourceFolder, accessToken)
 
-    const requestInfo = {
-      method: 'GET',
-      headers: {
-        'Content-Type': 'application/json',
-        Authorization: 'Bearer ' + accessToken
-      }
-    }
-
     const { result: members } = await this.requestClient.get<{ items: any[] }>(
       `${this.serverUrl}${sourceFolderUri}/members?limit=${limit}`,
       accessToken
@@ -1337,6 +996,9 @@ export class SASViyaApiClient {
       accessToken
     )
 
+    if (!sourceFolderUri) {
+      return undefined
+    }
     const sourceFolderId = sourceFolderUri?.split('/').pop()
 
     const { result: folder } = await this.requestClient

src/SASjs.ts

@@ -1,18 +1,31 @@
 import { compareTimestamps, asyncForEach } from './utils'
-import { SASjsConfig, UploadFile, EditContextInput, PollOptions } from './types'
+import {
+  SASjsConfig,
+  UploadFile,
+  EditContextInput,
+  PollOptions,
+  LoginMechanism
+} from './types'
 import { SASViyaApiClient } from './SASViyaApiClient'
 import { SAS9ApiClient } from './SAS9ApiClient'
-import { FileUploader } from './FileUploader'
 import { AuthManager } from './auth'
-import { ServerType } from '@sasjs/utils/types'
+import {
+  ServerType,
+  MacroVar,
+  AuthConfig,
+  ExtraResponseAttributes
+} from '@sasjs/utils/types'
 import { RequestClient } from './request/RequestClient'
 import {
   JobExecutor,
   WebJobExecutor,
   ComputeJobExecutor,
-  JesJobExecutor
+  JesJobExecutor,
+  Sas9JobExecutor,
+  FileUploader
 } from './job-execution'
 import { ErrorResponse } from './types/errors'
+import { LoginOptions, LoginResult } from './types/Login'
 
 const defaultConfig: SASjsConfig = {
   serverUrl: '',
@@ -22,8 +35,9 @@ const defaultConfig: SASjsConfig = {
   serverType: ServerType.SasViya,
   debug: false,
   contextName: 'SAS Job Execution compute context',
-  useComputeApi: false,
-  allowInsecureRequests: false
+  useComputeApi: null,
+  allowInsecureRequests: false,
+  loginMechanism: LoginMechanism.Default
 }
 
 /**
@@ -41,6 +55,7 @@ export default class SASjs {
   private webJobExecutor: JobExecutor | null = null
   private computeJobExecutor: JobExecutor | null = null
   private jesJobExecutor: JobExecutor | null = null
+  private sas9JobExecutor: JobExecutor | null = null
 
   constructor(config?: any) {
     this.sasjsConfig = {
@@ -57,15 +72,15 @@ export default class SASjs {
 
   public async executeScriptSAS9(
     linesOfCode: string[],
-    serverName: string,
-    repositoryName: string
+    userName: string,
+    password: string
   ) {
     this.isMethodSupported('executeScriptSAS9', ServerType.Sas9)
 
     return await this.sas9ApiClient?.executeScript(
       linesOfCode,
-      serverName,
-      repositoryName
+      userName,
+      password
     )
   }
 
@@ -100,12 +115,12 @@ export default class SASjs {
 
   /**
    * Gets executable compute contexts.
-   * @param accessToken - an access token for an authorized user.
+   * @param authConfig - an access token, refresh token, client and secret for an authorized user.
    */
-  public async getExecutableContexts(accessToken: string) {
+  public async getExecutableContexts(authConfig: AuthConfig) {
     this.isMethodSupported('getExecutableContexts', ServerType.SasViya)
 
-    return await this.sasViyaApiClient!.getExecutableContexts(accessToken)
+    return await this.sasViyaApiClient!.getExecutableContexts(authConfig)
   }
 
   /**
@@ -237,14 +252,14 @@ export default class SASjs {
    * @param fileName - name of the file to run. It will be converted to path to the file being submitted for execution.
    * @param linesOfCode - lines of sas code from the file to run.
    * @param contextName - context name on which code will be run on the server.
-   * @param accessToken - (optional) the access token for authorizing the request.
+   * @param authConfig - (optional) the access token, refresh token, client and secret for authorizing the request.
    * @param debug - (optional) if true, global debug config will be overriden
    */
   public async executeScriptSASViya(
     fileName: string,
     linesOfCode: string[],
     contextName: string,
-    accessToken?: string,
+    authConfig?: AuthConfig,
     debug?: boolean
   ) {
     this.isMethodSupported('executeScriptSASViya', ServerType.SasViya)
@@ -258,14 +273,14 @@ export default class SASjs {
       fileName,
       linesOfCode,
       contextName,
-      accessToken,
+      authConfig,
       null,
       debug ? debug : this.sasjsConfig.debug
     )
   }
 
   /**
-   * Creates a folder at SAS file system.
+   * Creates a folder in the logical SAS folder tree
    * @param folderName - name of the folder to be created.
    * @param parentFolderPath - the full path (eg `/Public/example/myFolder`) of the parent folder.
    * @param parentFolderUri - the URI of the parent folder.
@@ -297,6 +312,40 @@ export default class SASjs {
     )
   }
 
+  /**
+   * Creates a file in the logical SAS folder tree
+   * @param fileName - name of the file to be created.
+   * @param content - content of the file to be created.
+   * @param parentFolderPath - the full path (eg `/Public/example/myFolder`) of the parent folder.
+   * @param parentFolderUri - the URI of the parent folder.
+   * @param accessToken - the access token to authorizing the request.
+   * @param sasApiClient - a client for interfacing with SAS API.
+   */
+  public async createFile(
+    fileName: string,
+    content: Buffer,
+    parentFolderPath: string,
+    parentFolderUri?: string,
+    accessToken?: string,
+    sasApiClient?: SASViyaApiClient
+  ) {
+    if (sasApiClient)
+      return await sasApiClient.createFile(
+        fileName,
+        content,
+        parentFolderPath,
+        parentFolderUri,
+        accessToken
+      )
+    return await this.sasViyaApiClient!.createFile(
+      fileName,
+      content,
+      parentFolderPath,
+      parentFolderUri,
+      accessToken
+    )
+  }
+
   /**
    * Fetches a folder from the SAS file system.
    * @param folderPath - path of the folder to be fetched.
@@ -458,7 +507,7 @@ export default class SASjs {
       ...this.sasjsConfig,
       ...config
     }
-    await this.setupConfiguration()
+    this.setupConfiguration()
   }
 
   /**
@@ -485,8 +534,27 @@ export default class SASjs {
    * @param username - a string representing the username.
    * @param password - a string representing the password.
    */
-  public async logIn(username: string, password: string) {
-    return this.authManager!.logIn(username, password)
+  public async logIn(
+    username?: string,
+    password?: 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)
   }
 
   /**
@@ -503,18 +571,32 @@ export default class SASjs {
    *  Process). Is prepended at runtime with the value of `appLoc`.
    * @param files - array of files to be uploaded, including File object and file name.
    * @param params - request URL parameters.
+   * @param 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 uploadFile(sasJob: string, files: UploadFile[], params: any) {
-    const fileUploader =
-      this.fileUploader ||
-      new FileUploader(
-        this.sasjsConfig.appLoc,
-        this.sasjsConfig.serverUrl,
-        this.jobsPath,
-        this.requestClient!
-      )
+  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 fileUploader.uploadFile(sasJob, files, params)
+    return await this.fileUploader!.execute(
+      sasJob,
+      data,
+      config,
+      loginRequiredCallback
+    )
   }
 
   /**
@@ -538,44 +620,135 @@ export default class SASjs {
    * `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 },
+    data: { [key: string]: any } | null,
     config: { [key: string]: any } = {},
     loginRequiredCallback?: () => any,
-    accessToken?: string
+    authConfig?: AuthConfig,
+    extraResponseAttributes: ExtraResponseAttributes[] = []
   ) {
     config = {
       ...this.sasjsConfig,
       ...config
     }
 
-    if (config.serverType === ServerType.SasViya && config.contextName) {
-      if (config.useComputeApi) {
-        return await this.computeJobExecutor!.execute(
-          sasJob,
-          data,
-          config,
-          loginRequiredCallback,
-          accessToken
-        )
+    const validationResult = this.validateInput(data)
+
+    if (validationResult.status) {
+      if (
+        config.serverType !== ServerType.Sas9 &&
+        config.useComputeApi !== undefined &&
+        config.useComputeApi !== null
+      ) {
+        if (config.useComputeApi) {
+          return await this.computeJobExecutor!.execute(
+            sasJob,
+            data,
+            config,
+            loginRequiredCallback,
+            authConfig
+          )
+        } else {
+          if (!config.contextName)
+            config = {
+              ...config,
+              contextName: 'SAS Job Execution compute context'
+            }
+          return await this.jesJobExecutor!.execute(
+            sasJob,
+            data,
+            config,
+            loginRequiredCallback,
+            authConfig,
+            extraResponseAttributes
+          )
+        }
+      } else if (
+        config.serverType === ServerType.Sas9 &&
+        config.username &&
+        config.password
+      ) {
+        return await this.sas9JobExecutor!.execute(sasJob, data, config)
       } else {
-        return await this.jesJobExecutor!.execute(
+        return await this.webJobExecutor!.execute(
           sasJob,
           data,
           config,
           loginRequiredCallback,
-          accessToken
+          authConfig,
+          extraResponseAttributes
         )
       }
     } else {
-      return await this.webJobExecutor!.execute(
-        sasJob,
-        data,
-        config,
-        loginRequiredCallback
-      )
+      return Promise.reject(new ErrorResponse(validationResult.msg))
+    }
+  }
+
+  /**
+   * This function validates the input data structure and table naming convention
+   *
+   * @param data A json object that contains one or more tables, it can also be null
+   * @returns An object which contains two attributes: 1) status: boolean, 2) msg: string
+   */
+  private validateInput(data: { [key: string]: any } | null): {
+    status: boolean
+    msg: string
+  } {
+    if (data === null) return { status: true, msg: '' }
+    for (const key in data) {
+      if (!key.match(/^[a-zA-Z_]/)) {
+        return {
+          status: false,
+          msg: 'First letter of table should be alphabet or underscore.'
+        }
+      }
+
+      if (!key.match(/^[a-zA-Z_][a-zA-Z0-9_]*$/)) {
+        return { status: false, msg: 'Table name should be alphanumeric.' }
+      }
+
+      if (key.length > 32) {
+        return {
+          status: false,
+          msg: 'Maximum length for table name could be 32 characters.'
+        }
+      }
+
+      if (this.getType(data[key]) !== 'Array') {
+        return {
+          status: false,
+          msg: 'Parameter data contains invalid table structure.'
+        }
+      }
+
+      for (let i = 0; i < data[key].length; i++) {
+        if (this.getType(data[key][i]) !== 'object') {
+          return {
+            status: false,
+            msg: `Table ${key} contains invalid structure.`
+          }
+        }
+      }
+    }
+    return { status: true, msg: '' }
+  }
+
+  /**
+   * this function returns the type of variable
+   *
+   * @param data it could be anything, like string, array, object etc.
+   * @returns a string which tells the type of input parameter
+   */
+  private getType(data: any): string {
+    if (Array.isArray(data)) {
+      return 'Array'
+    } else {
+      return typeof data
     }
   }
 
@@ -616,7 +789,11 @@ export default class SASjs {
         )
         sasApiClient.debug = this.sasjsConfig.debug
       } else if (this.sasjsConfig.serverType === ServerType.Sas9) {
-        sasApiClient = new SAS9ApiClient(serverUrl)
+        sasApiClient = new SAS9ApiClient(
+          serverUrl,
+          this.jobsPath,
+          this.sasjsConfig.allowInsecureRequests
+        )
       }
     } else {
       let sasClientConfig: any = null
@@ -658,20 +835,22 @@ export default class SASjs {
    * @param config - provide any changes to the config here, for instance to
    * enable/disable `debug`. Any change provided will override the global config,
    * for that particular function call.
-   * @param accessToken - a valid access token that is authorised to execute compute jobs.
+   * @param authConfig - a valid client, secret, refresh and access tokens that are authorised to execute compute jobs.
    * The access token is not required when the user is authenticated via the browser.
    * @param waitForResult - a boolean that indicates whether the function needs to wait for execution to complete.
    * @param pollOptions - an object that represents poll interval(milliseconds) and maximum amount of attempts. Object example: { MAX_POLL_COUNT: 24 * 60 * 60, POLL_INTERVAL: 1000 }.
    * @param printPid - a boolean that indicates whether the function should print (PID) of the started job.
+   * @param variables - an object that represents macro variables.
    */
   public async startComputeJob(
     sasJob: string,
     data: any,
     config: any = {},
-    accessToken?: string,
+    authConfig?: AuthConfig,
     waitForResult?: boolean,
     pollOptions?: PollOptions,
-    printPid = false
+    printPid = false,
+    variables?: MacroVar
   ) {
     config = {
       ...this.sasjsConfig,
@@ -690,11 +869,12 @@ export default class SASjs {
       config.contextName,
       config.debug,
       data,
-      accessToken,
+      authConfig,
       !!waitForResult,
       false,
       pollOptions,
-      printPid
+      printPid,
+      variables
     )
   }
 
@@ -702,6 +882,7 @@ export default class SASjs {
     await this.webJobExecutor?.resendWaitingRequests()
     await this.computeJobExecutor?.resendWaitingRequests()
     await this.jesJobExecutor?.resendWaitingRequests()
+    await this.fileUploader?.resendWaitingRequests()
   }
 
   /**
@@ -733,20 +914,18 @@ export default class SASjs {
     })
   }
 
+  /**
+   * this method returns an array of SASjsRequest
+   * @returns SASjsRequest[]
+   */
   public getSasRequests() {
-    const requests = [
-      ...this.webJobExecutor!.getRequests(),
-      ...this.computeJobExecutor!.getRequests(),
-      ...this.jesJobExecutor!.getRequests()
-    ]
+    const requests = [...this.requestClient!.getRequests()]
     const sortedRequests = requests.sort(compareTimestamps)
     return sortedRequests
   }
 
   public clearSasRequests() {
-    this.webJobExecutor!.clearRequests()
-    this.computeJobExecutor!.clearRequests()
-    this.jesJobExecutor!.clearRequests()
+    this.requestClient!.clearRequests()
   }
 
   private setupConfiguration() {
@@ -769,10 +948,17 @@ export default class SASjs {
       this.sasjsConfig.serverUrl = this.sasjsConfig.serverUrl.slice(0, -1)
     }
 
-    this.requestClient = new RequestClient(
-      this.sasjsConfig.serverUrl,
-      this.sasjsConfig.allowInsecureRequests
-    )
+    if (!this.requestClient) {
+      this.requestClient = new RequestClient(
+        this.sasjsConfig.serverUrl,
+        this.sasjsConfig.allowInsecureRequests
+      )
+    } else {
+      this.requestClient.setConfig(
+        this.sasjsConfig.serverUrl,
+        this.sasjsConfig.allowInsecureRequests
+      )
+    }
 
     this.jobsPath =
       this.sasjsConfig.serverType === ServerType.SasViya
@@ -805,12 +991,17 @@ export default class SASjs {
     if (this.sasjsConfig.serverType === ServerType.Sas9) {
       if (this.sas9ApiClient)
         this.sas9ApiClient!.setConfig(this.sasjsConfig.serverUrl)
-      else this.sas9ApiClient = new SAS9ApiClient(this.sasjsConfig.serverUrl)
+      else
+        this.sas9ApiClient = new SAS9ApiClient(
+          this.sasjsConfig.serverUrl,
+          this.jobsPath,
+          this.sasjsConfig.allowInsecureRequests
+        )
     }
 
     this.fileUploader = new FileUploader(
-      this.sasjsConfig.appLoc,
       this.sasjsConfig.serverUrl,
+      this.sasjsConfig.serverType!,
       this.jobsPath,
       this.requestClient
     )
@@ -823,6 +1014,13 @@ export default class SASjs {
       this.sasViyaApiClient!
     )
 
+    this.sas9JobExecutor = new Sas9JobExecutor(
+      this.sasjsConfig.serverUrl,
+      this.sasjsConfig.serverType!,
+      this.jobsPath,
+      this.sasjsConfig.allowInsecureRequests
+    )
+
     this.computeJobExecutor = new ComputeJobExecutor(
       this.sasjsConfig.serverUrl,
       this.sasViyaApiClient!
@@ -853,6 +1051,16 @@ export default class SASjs {
             isForced
           )
           break
+        case 'file':
+          await this.createFile(
+            member.name,
+            member.code,
+            parentFolder,
+            undefined,
+            accessToken,
+            sasApiClient
+          )
+          break
         case 'service':
           await this.createJobDefinition(
             member.name,

src/SessionManager.ts

@@ -1,17 +1,14 @@
-import { Session, Context, CsrfToken, SessionVariable } from './types'
+import { Session, Context, SessionVariable } from './types'
+import { NoSessionStateError } from './types/errors'
 import { asyncForEach, isUrl } from './utils'
 import { prefixMessage } from '@sasjs/utils/error'
 import { RequestClient } from './request/RequestClient'
 
 const MAX_SESSION_COUNT = 1
-const RETRY_LIMIT: number = 3
-let RETRY_COUNT: number = 0
-const INTERNAL_SAS_ERROR = {
-  status: 304,
-  message: 'Not Modified'
-}
 
 export class SessionManager {
+  private loggedErrors: NoSessionStateError[] = []
+
   constructor(
     private serverUrl: string,
     private contextName: string,
@@ -91,10 +88,7 @@ export class SessionManager {
   }
 
   private async createAndWaitForSession(accessToken?: string) {
-    const {
-      result: createdSession,
-      etag
-    } = await this.requestClient
+    const { result: createdSession, etag } = await this.requestClient
       .post<Session>(
         `${this.serverUrl}/compute/contexts/${
           this.currentContext!.id
@@ -160,58 +154,75 @@ export class SessionManager {
     session: Session,
     etag: string | null,
     accessToken?: string
-  ) {
+  ): Promise<string> {
+    const logger = process.logger || console
+
     let sessionState = session.state
 
     const stateLink = session.links.find((l: any) => l.rel === 'state')
 
-    return new Promise(async (resolve, _) => {
-      if (
-        sessionState === 'pending' ||
-        sessionState === 'running' ||
-        sessionState === ''
-      ) {
-        if (stateLink) {
-          if (this.debug && !this.printedSessionState.printed) {
-            console.log('Polling session status...')
+    if (
+      sessionState === 'pending' ||
+      sessionState === 'running' ||
+      sessionState === ''
+    ) {
+      if (stateLink) {
+        if (this.debug && !this.printedSessionState.printed) {
+          logger.info('Polling session status...')
 
-            this.printedSessionState.printed = true
-          }
+          this.printedSessionState.printed = true
+        }
 
-          const state = await this.getSessionState(
+        const { result: state, responseStatus: responseStatus } =
+          await this.getSessionState(
             `${this.serverUrl}${stateLink.href}?wait=30`,
             etag!,
             accessToken
           ).catch((err) => {
-            throw err
+            throw prefixMessage(err, 'Error while getting session state.')
           })
 
-          sessionState = state.trim()
+        sessionState = state.trim()
 
-          if (this.debug && this.printedSessionState.state !== sessionState) {
-            console.log(`Current session state is '${sessionState}'`)
+        if (this.debug && this.printedSessionState.state !== sessionState) {
+          logger.info(`Current session state is '${sessionState}'`)
 
-            this.printedSessionState.state = sessionState
-            this.printedSessionState.printed = false
-          }
-
-          // There is an internal error present in SAS Viya 3.5
-          // Retry to wait for a session status in such case of SAS internal error
-          if (
-            sessionState === INTERNAL_SAS_ERROR.message &&
-            RETRY_COUNT < RETRY_LIMIT
-          ) {
-            RETRY_COUNT++
-
-            resolve(this.waitForSession(session, etag, accessToken))
-          }
-
-          resolve(sessionState)
+          this.printedSessionState.state = sessionState
+          this.printedSessionState.printed = false
         }
+
+        if (!sessionState) {
+          const stateError = new NoSessionStateError(
+            responseStatus,
+            this.serverUrl + stateLink.href,
+            session.links.find((l: any) => l.rel === 'log')?.href as string
+          )
+
+          if (
+            !this.loggedErrors.find(
+              (err: NoSessionStateError) =>
+                err.serverResponseStatus === stateError.serverResponseStatus
+            )
+          ) {
+            this.loggedErrors.push(stateError)
+
+            logger.info(stateError.message)
+          }
+
+          return await this.waitForSession(session, etag, accessToken)
+        }
+
+        this.loggedErrors = []
+
+        return sessionState
       } else {
-        resolve(sessionState)
+        throw 'Error while getting session state link.'
       }
-    })
+    } else {
+      this.loggedErrors = []
+
+      return sessionState
+    }
   }
 
   private async getSessionState(
@@ -221,11 +232,11 @@ export class SessionManager {
   ) {
     return await this.requestClient
       .get(url, accessToken, 'text/plain', { 'If-None-Match': etag })
-      .then((res) => res.result as string)
+      .then((res) => ({
+        result: res.result as string,
+        responseStatus: res.status
+      }))
       .catch((err) => {
-        if (err.status === INTERNAL_SAS_ERROR.status)
-          return INTERNAL_SAS_ERROR.message
-
         throw err
       })
   }

src/api/viya/executeScript.ts

@@ -0,0 +1,293 @@
+import { timestampToYYYYMMDDHHMMSS } from '@sasjs/utils/time'
+import { AuthConfig, MacroVar } from '@sasjs/utils/types'
+import { prefixMessage } from '@sasjs/utils/error'
+import {
+  PollOptions,
+  Job,
+  ComputeJobExecutionError,
+  NotFoundError
+} from '../..'
+import { getTokens } from '../../auth/getTokens'
+import { RequestClient } from '../../request/RequestClient'
+import { SessionManager } from '../../SessionManager'
+import { isRelativePath, fetchLogByChunks } from '../../utils'
+import { formatDataForRequest } from '../../utils/formatDataForRequest'
+import { pollJobState } from './pollJobState'
+import { uploadTables } from './uploadTables'
+
+/**
+ * Executes code on the current SAS Viya server.
+ * @param jobPath - the path to the file being submitted for execution.
+ * @param linesOfCode - an array of code lines to execute.
+ * @param contextName - the context to execute the code in.
+ * @param authConfig - an object containing an access token, refresh token, client ID and secret.
+ * @param data - execution data.
+ * @param debug - when set to true, the log will be returned.
+ * @param expectWebout - when set to true, the automatic _webout fileref will be checked for content, and that content returned. This fileref is used when the Job contains a SASjs web request (as opposed to executing arbitrary SAS code).
+ * @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 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(
+  requestClient: RequestClient,
+  sessionManager: SessionManager,
+  rootFolderName: string,
+  jobPath: string,
+  linesOfCode: string[],
+  contextName: string,
+  authConfig?: AuthConfig,
+  data: any = null,
+  debug: boolean = false,
+  expectWebout = false,
+  waitForResult = true,
+  pollOptions?: PollOptions,
+  printPid = false,
+  variables?: MacroVar
+): Promise<any> {
+  let access_token = (authConfig || {}).access_token
+  if (authConfig) {
+    ;({ access_token } = await getTokens(requestClient, authConfig))
+  }
+
+  const logger = process.logger || console
+
+  try {
+    let executionSessionId: string
+
+    const session = await sessionManager
+      .getSession(access_token)
+      .catch((err) => {
+        throw prefixMessage(err, 'Error while getting session. ')
+      })
+
+    executionSessionId = session!.id
+
+    if (printPid) {
+      const { result: jobIdVariable } = await sessionManager
+        .getVariable(executionSessionId, 'SYSJOBID', access_token)
+        .catch((err) => {
+          throw prefixMessage(err, 'Error while getting session variable. ')
+        })
+
+      if (jobIdVariable && jobIdVariable.value) {
+        const relativeJobPath = rootFolderName
+          ? jobPath.split(rootFolderName).join('').replace(/^\//, '')
+          : jobPath
+
+        const logger = process.logger || console
+
+        logger.info(
+          `Triggered '${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)) {
+      fileName = `exec-${
+        jobPath.includes('/') ? jobPath.split('/')[1] : jobPath
+      }`
+    } else {
+      const jobPathParts = jobPath.split('/')
+      fileName = jobPathParts.pop()
+    }
+
+    let jobVariables: any = {
+      SYS_JES_JOB_URI: '',
+      _program: isRelativePath(jobPath)
+        ? rootFolderName + '/' + jobPath
+        : jobPath
+    }
+
+    if (variables) jobVariables = { ...jobVariables, ...variables }
+
+    if (debug) jobVariables = { ...jobVariables, _DEBUG: 131 }
+
+    let files: any[] = []
+
+    if (data) {
+      if (JSON.stringify(data).includes(';')) {
+        files = await uploadTables(requestClient, data, access_token).catch(
+          (err) => {
+            throw prefixMessage(err, 'Error while uploading tables. ')
+          }
+        )
+
+        jobVariables['_webin_file_count'] = files.length
+
+        files.forEach((fileInfo, index) => {
+          jobVariables[
+            `_webin_fileuri${index + 1}`
+          ] = `/files/files/${fileInfo.file.id}`
+          jobVariables[`_webin_name${index + 1}`] = fileInfo.tableName
+        })
+      } else {
+        jobVariables = { ...jobVariables, ...formatDataForRequest(data) }
+      }
+    }
+
+    // Execute job in session
+    const jobRequestBody = {
+      name: fileName,
+      description: 'Powered by SASjs',
+      code: linesOfCode,
+      variables: jobVariables,
+      arguments: jobArguments
+    }
+
+    const { result: postedJob, etag } = await requestClient
+      .post<Job>(
+        `/compute/sessions/${executionSessionId}/jobs`,
+        jobRequestBody,
+        access_token
+      )
+      .catch((err) => {
+        throw prefixMessage(err, 'Error while posting job. ')
+      })
+
+    if (!waitForResult) return session
+
+    if (debug) {
+      logger.info(`Job has been submitted for '${fileName}'.`)
+      logger.info(
+        `You can monitor the job progress at '${requestClient.getBaseUrl()}${
+          postedJob.links.find((l: any) => l.rel === 'state')!.href
+        }'.`
+      )
+    }
+
+    const jobStatus = await pollJobState(
+      requestClient,
+      postedJob,
+      debug,
+      authConfig,
+      pollOptions
+    ).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 sessionLogUrl =
+          postedJob.links.find((l: any) => l.rel === 'up')!.href + '/log'
+        const logCount = 1000000
+        err.log = await fetchLogByChunks(
+          requestClient,
+          access_token!,
+          sessionLogUrl,
+          logCount
+        )
+      }
+      throw prefixMessage(err, 'Error while polling job status. ')
+    })
+
+    if (authConfig) {
+      ;({ access_token } = await getTokens(requestClient, authConfig))
+    }
+
+    const { result: currentJob } = await requestClient
+      .get<Job>(
+        `/compute/sessions/${executionSessionId}/jobs/${postedJob.id}`,
+        access_token
+      )
+      .catch((err) => {
+        throw prefixMessage(err, 'Error while getting job. ')
+      })
+
+    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!,
+        logUrl,
+        logCount
+      )
+    }
+
+    if (jobStatus === 'failed' || jobStatus === 'error') {
+      throw new ComputeJobExecutionError(currentJob, log)
+    }
+
+    if (!expectWebout) {
+      return { job: currentJob, log }
+    }
+
+    const resultLink = `/compute/sessions/${executionSessionId}/filerefs/_webout/content`
+
+    jobResult = await requestClient
+      .get<any>(resultLink, access_token, 'text/plain')
+      .catch(async (e) => {
+        if (e instanceof NotFoundError) {
+          if (logLink) {
+            const logUrl = `${logLink.href}/content`
+            const logCount = currentJob.logStatistics?.lineCount ?? 1000000
+            log = await fetchLogByChunks(
+              requestClient,
+              access_token!,
+              logUrl,
+              logCount
+            )
+
+            return Promise.reject({
+              status: 500,
+              log
+            })
+          }
+        }
+
+        return {
+          result: JSON.stringify(e)
+        }
+      })
+
+    await sessionManager
+      .clearSession(executionSessionId, access_token)
+      .catch((err) => {
+        throw prefixMessage(err, 'Error while clearing session. ')
+      })
+
+    return { result: jobResult?.result, log }
+  } catch (e) {
+    if (e && e.status === 404) {
+      return executeScript(
+        requestClient,
+        sessionManager,
+        rootFolderName,
+        jobPath,
+        linesOfCode,
+        contextName,
+        authConfig,
+        data,
+        debug,
+        false,
+        true
+      )
+    } else {
+      throw prefixMessage(e, 'Error while executing script. ')
+    }
+  }
+}

src/api/viya/getFileStream.ts

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

src/api/viya/pollJobState.ts

@@ -0,0 +1,248 @@
+import { AuthConfig } from '@sasjs/utils/types'
+import { Job, PollOptions } from '../..'
+import { getTokens } from '../../auth/getTokens'
+import { RequestClient } from '../../request/RequestClient'
+import { JobStatePollError } from '../../types/errors'
+import { Link, WriteStream } from '../../types'
+import { delay, isNode } from '../../utils'
+
+export async function pollJobState(
+  requestClient: RequestClient,
+  postedJob: Job,
+  debug: boolean,
+  authConfig?: AuthConfig,
+  pollOptions?: PollOptions
+) {
+  const logger = process.logger || console
+
+  let pollInterval = 300
+  let maxPollCount = 1000
+
+  const defaultPollOptions: PollOptions = {
+    maxPollCount,
+    pollInterval,
+    streamLog: false
+  }
+
+  pollOptions = { ...defaultPollOptions, ...(pollOptions || {}) }
+
+  const stateLink = postedJob.links.find((l: any) => l.rel === 'state')
+  if (!stateLink) {
+    throw new Error(`Job state link was not found.`)
+  }
+
+  let currentState = await getJobState(
+    requestClient,
+    postedJob,
+    '',
+    debug,
+    authConfig
+  ).catch((err) => {
+    logger.error(
+      `Error fetching job state from ${stateLink.href}. Starting poll, assuming job to be running.`,
+      err
+    )
+    return 'unavailable'
+  })
+
+  let pollCount = 0
+
+  if (currentState === 'completed') {
+    return Promise.resolve(currentState)
+  }
+
+  let logFileStream
+  if (pollOptions.streamLog && isNode()) {
+    const { getFileStream } = require('./getFileStream')
+    logFileStream = await getFileStream(postedJob, pollOptions.logFolderPath)
+  }
+
+  // Poll up to the first 100 times with the specified poll interval
+  let result = await doPoll(
+    requestClient,
+    postedJob,
+    currentState,
+    debug,
+    pollCount,
+    authConfig,
+    {
+      ...pollOptions,
+      maxPollCount:
+        pollOptions.maxPollCount <= 100 ? pollOptions.maxPollCount : 100
+    },
+    logFileStream
+  )
+
+  currentState = result.state
+  pollCount = result.pollCount
+
+  if (!needsRetry(currentState) || pollCount >= pollOptions.maxPollCount) {
+    return currentState
+  }
+
+  // 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
+  let longJobPollOptions: PollOptions = {
+    maxPollCount: 24 * 60,
+    pollInterval: 60000,
+    streamLog: false
+  }
+  if (pollOptions) {
+    longJobPollOptions.streamLog = pollOptions.streamLog
+    longJobPollOptions.logFolderPath = pollOptions.logFolderPath
+  }
+
+  result = await doPoll(
+    requestClient,
+    postedJob,
+    currentState,
+    debug,
+    pollCount,
+    authConfig,
+    longJobPollOptions,
+    logFileStream
+  )
+
+  currentState = result.state
+  pollCount = result.pollCount
+
+  if (logFileStream) {
+    logFileStream.end()
+  }
+
+  return currentState
+}
+
+const getJobState = async (
+  requestClient: RequestClient,
+  job: Job,
+  currentState: string,
+  debug: boolean,
+  authConfig?: AuthConfig
+) => {
+  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)
+    }
+
+    const { result: jobState } = await requestClient
+      .get<string>(
+        `${stateLink.href}?_action=wait&wait=300`,
+        tokens?.access_token,
+        'text/plain',
+        {},
+        debug
+      )
+      .catch((err) => {
+        throw new JobStatePollError(job.id, err)
+      })
+
+    return jobState.trim()
+  } else {
+    return currentState
+  }
+}
+
+const needsRetry = (state: string) =>
+  state === 'running' ||
+  state === '' ||
+  state === 'pending' ||
+  state === 'unavailable'
+
+const doPoll = async (
+  requestClient: RequestClient,
+  postedJob: Job,
+  currentState: string,
+  debug: boolean,
+  pollCount: number,
+  authConfig?: AuthConfig,
+  pollOptions?: PollOptions,
+  logStream?: WriteStream
+): Promise<{ state: string; pollCount: number }> => {
+  let pollInterval = 300
+  let maxPollCount = 1000
+  let maxErrorCount = 5
+  let errorCount = 0
+  let state = currentState
+  let printedState = ''
+  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) {
+    state = await getJobState(
+      requestClient,
+      postedJob,
+      state,
+      debug,
+      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'
+    })
+
+    pollCount++
+
+    if (pollOptions?.streamLog) {
+      const jobUrl = postedJob.links.find((l: Link) => l.rel === 'self')
+      const { result: job } = await requestClient.get<Job>(
+        jobUrl!.href,
+        authConfig?.access_token
+      )
+
+      const endLogLine = job.logStatistics?.lineCount ?? 1000000
+
+      const { saveLog } = isNode() ? require('./saveLog') : { saveLog: null }
+      if (saveLog) {
+        await saveLog(
+          postedJob,
+          requestClient,
+          startLogLine,
+          endLogLine,
+          logStream,
+          authConfig?.access_token
+        )
+      }
+
+      startLogLine += endLogLine
+    }
+
+    if (debug && printedState !== state) {
+      logger.info('Polling job status...')
+      logger.info(`Current job state: ${state}`)
+
+      printedState = state
+    }
+
+    if (state != 'unavailable' && errorCount > 0) {
+      errorCount = 0
+    }
+
+    await delay(pollInterval)
+  }
+
+  return { state, pollCount }
+}

src/api/viya/saveLog.ts

@@ -0,0 +1,55 @@
+import { Job } from '../..'
+import { RequestClient } from '../../request/RequestClient'
+import { fetchLog } from '../../utils'
+import { WriteStream } from '../../types'
+import { writeStream } from './writeStream'
+
+/**
+ * Appends logs to a supplied write stream.
+ * This is useful for getting quick feedback on longer running jobs.
+ * @param job - the job to fetch logs for
+ * @param requestClient - the pre-configured HTTP request client
+ * @param startLine - the line at which to start fetching the log
+ * @param endLine - the line at which to stop fetching the log
+ * @param logFileStream - the write stream to which the log is appended
+ * @accessToken - an optional access token for authentication/authorization
+ * The access token is not required when fetching logs from the browser.
+ */
+export async function saveLog(
+  job: Job,
+  requestClient: RequestClient,
+  startLine: number,
+  endLine: number,
+  logFileStream?: WriteStream,
+  accessToken?: string
+) {
+  if (!accessToken) {
+    throw new Error(
+      `Logs for job ${job.id} cannot be fetched without a valid access token.`
+    )
+  }
+
+  if (!logFileStream) {
+    throw new Error(
+      `Logs for job ${job.id} cannot be written without a valid write stream.`
+    )
+  }
+
+  const logger = process.logger || console
+  const jobLogUrl = job.links.find((l) => l.rel === 'log')
+
+  if (!jobLogUrl) {
+    throw new Error(`Log URL for job ${job.id} was not found.`)
+  }
+
+  const log = await fetchLog(
+    requestClient,
+    accessToken,
+    `${jobLogUrl.href}/content`,
+    startLine,
+    endLine
+  )
+
+  logger.info(`Writing logs to ${logFileStream.path}`)
+  await writeStream(logFileStream, log || '')
+}

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

@@ -0,0 +1,675 @@
+import { RequestClient } from '../../../request/RequestClient'
+import { SessionManager } from '../../../SessionManager'
+import { executeScript } from '../executeScript'
+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 { ComputeJobExecutionError, NotFoundError } from '../../../types/errors'
+import { Logger, LogLevel } from '@sasjs/utils'
+
+const sessionManager = new (<jest.Mock<SessionManager>>SessionManager)()
+const requestClient = new (<jest.Mock<RequestClient>>RequestClient)()
+const defaultPollOptions: PollOptions = {
+  maxPollCount: 100,
+  pollInterval: 500,
+  streamLog: false
+}
+
+describe('executeScript', () => {
+  beforeEach(() => {
+    ;(process as any).logger = new Logger(LogLevel.Off)
+    setupMocks()
+  })
+
+  it('should not try to get fresh tokens if an authConfig is not provided', async () => {
+    await executeScript(
+      requestClient,
+      sessionManager,
+      'test',
+      'test',
+      ['%put hello'],
+      'test context'
+    )
+
+    expect(getTokensModule.getTokens).not.toHaveBeenCalled()
+  })
+
+  it('should try to get fresh tokens if an authConfig is provided', async () => {
+    await executeScript(
+      requestClient,
+      sessionManager,
+      'test',
+      'test',
+      ['%put hello'],
+      'test context',
+      mockAuthConfig
+    )
+
+    expect(getTokensModule.getTokens).toHaveBeenCalledWith(
+      requestClient,
+      mockAuthConfig
+    )
+  })
+
+  it('should get a session from the session manager before executing', async () => {
+    await executeScript(
+      requestClient,
+      sessionManager,
+      'test',
+      'test',
+      ['%put hello'],
+      'test context'
+    )
+
+    expect(sessionManager.getSession).toHaveBeenCalledWith(undefined)
+  })
+
+  it('should handle errors while getting a session', async () => {
+    jest
+      .spyOn(sessionManager, 'getSession')
+      .mockImplementation(() => Promise.reject('Test Error'))
+
+    const error = await executeScript(
+      requestClient,
+      sessionManager,
+      'test',
+      'test',
+      ['%put hello'],
+      'test context'
+    ).catch((e) => e)
+
+    expect(error).toContain('Error while getting session.')
+  })
+
+  it('should fetch the PID when printPid is true', async () => {
+    await executeScript(
+      requestClient,
+      sessionManager,
+      'test',
+      'test',
+      ['%put hello'],
+      'test context',
+      mockAuthConfig,
+      null,
+      false,
+      false,
+      false,
+      defaultPollOptions,
+      true
+    )
+
+    expect(sessionManager.getVariable).toHaveBeenCalledWith(
+      mockSession.id,
+      'SYSJOBID',
+      mockAuthConfig.access_token
+    )
+  })
+
+  it('should handle errors while getting the job PID', async () => {
+    jest
+      .spyOn(sessionManager, 'getVariable')
+      .mockImplementation(() => Promise.reject('Test Error'))
+
+    const error = await executeScript(
+      requestClient,
+      sessionManager,
+      'test',
+      'test',
+      ['%put hello'],
+      'test context',
+      mockAuthConfig,
+      null,
+      false,
+      false,
+      false,
+      defaultPollOptions,
+      true
+    ).catch((e) => e)
+
+    expect(error).toContain('Error while getting session variable.')
+  })
+
+  it('should use the file upload approach when data contains semicolons', async () => {
+    jest
+      .spyOn(uploadTablesModule, 'uploadTables')
+      .mockImplementation(() =>
+        Promise.resolve([{ tableName: 'test', file: { id: 1 } }])
+      )
+
+    await executeScript(
+      requestClient,
+      sessionManager,
+      'test',
+      'test',
+      ['%put hello'],
+      'test context',
+      mockAuthConfig,
+      { foo: 'bar;' },
+      false,
+      false,
+      false,
+      defaultPollOptions,
+      true
+    )
+
+    expect(uploadTablesModule.uploadTables).toHaveBeenCalledWith(
+      requestClient,
+      { foo: 'bar;' },
+      mockAuthConfig.access_token
+    )
+  })
+
+  it('should format data as CSV when it does not contain semicolons', async () => {
+    await executeScript(
+      requestClient,
+      sessionManager,
+      'test',
+      'test',
+      ['%put hello'],
+      'test context',
+      mockAuthConfig,
+      { foo: 'bar' },
+      false,
+      false,
+      false,
+      defaultPollOptions,
+      true
+    )
+
+    expect(formatDataModule.formatDataForRequest).toHaveBeenCalledWith({
+      foo: 'bar'
+    })
+  })
+
+  it('should submit a job for execution via the compute API', async () => {
+    jest
+      .spyOn(formatDataModule, 'formatDataForRequest')
+      .mockImplementation(() => ({ sasjs_tables: 'foo', sasjs0data: 'bar' }))
+
+    await executeScript(
+      requestClient,
+      sessionManager,
+      'test',
+      'test',
+      ['%put "hello";'],
+      'test context',
+      mockAuthConfig,
+      { foo: 'bar' },
+      false,
+      false,
+      false,
+      defaultPollOptions,
+      true
+    )
+
+    expect(requestClient.post).toHaveBeenCalledWith(
+      `/compute/sessions/${mockSession.id}/jobs`,
+      {
+        name: 'exec-test',
+        description: 'Powered by SASjs',
+        code: ['%put "hello";'],
+        variables: {
+          SYS_JES_JOB_URI: '',
+          _program: 'test/test',
+          sasjs_tables: 'foo',
+          sasjs0data: 'bar'
+        },
+        arguments: {
+          _contextName: 'test context',
+          _OMITJSONLISTING: true,
+          _OMITJSONLOG: true,
+          _OMITSESSIONRESULTS: true,
+          _OMITTEXTLISTING: true,
+          _OMITTEXTLOG: true
+        }
+      },
+      mockAuthConfig.access_token
+    )
+  })
+
+  it('should set the correct variables when debug is true', async () => {
+    jest
+      .spyOn(formatDataModule, 'formatDataForRequest')
+      .mockImplementation(() => ({ sasjs_tables: 'foo', sasjs0data: 'bar' }))
+
+    await executeScript(
+      requestClient,
+      sessionManager,
+      'test',
+      'test',
+      ['%put "hello";'],
+      'test context',
+      mockAuthConfig,
+      { foo: 'bar' },
+      true,
+      false,
+      false,
+      defaultPollOptions,
+      true
+    )
+
+    expect(requestClient.post).toHaveBeenCalledWith(
+      `/compute/sessions/${mockSession.id}/jobs`,
+      {
+        name: 'exec-test',
+        description: 'Powered by SASjs',
+        code: ['%put "hello";'],
+        variables: {
+          SYS_JES_JOB_URI: '',
+          _program: 'test/test',
+          sasjs_tables: 'foo',
+          sasjs0data: 'bar',
+          _DEBUG: 131
+        },
+        arguments: {
+          _contextName: 'test context',
+          _OMITJSONLISTING: true,
+          _OMITJSONLOG: true,
+          _OMITSESSIONRESULTS: false,
+          _OMITTEXTLISTING: true,
+          _OMITTEXTLOG: false
+        }
+      },
+      mockAuthConfig.access_token
+    )
+  })
+
+  it('should handle errors during job submission', async () => {
+    jest
+      .spyOn(requestClient, 'post')
+      .mockImplementation(() => Promise.reject('Test Error'))
+
+    const error = await executeScript(
+      requestClient,
+      sessionManager,
+      'test',
+      'test',
+      ['%put "hello";'],
+      'test context',
+      mockAuthConfig,
+      { foo: 'bar' },
+      true,
+      false,
+      false,
+      defaultPollOptions,
+      true
+    ).catch((e) => e)
+
+    expect(error).toContain('Error while posting job')
+  })
+
+  it('should immediately return the session when waitForResult is false', async () => {
+    const result = await executeScript(
+      requestClient,
+      sessionManager,
+      'test',
+      'test',
+      ['%put "hello";'],
+      'test context',
+      mockAuthConfig,
+      { foo: 'bar' },
+      true,
+      false,
+      false,
+      defaultPollOptions,
+      true
+    )
+
+    expect(result).toEqual(mockSession)
+  })
+
+  it('should poll for job completion when waitForResult is true', async () => {
+    await executeScript(
+      requestClient,
+      sessionManager,
+      'test',
+      'test',
+      ['%put "hello";'],
+      'test context',
+      mockAuthConfig,
+      { foo: 'bar' },
+      false,
+      false,
+      true,
+      defaultPollOptions,
+      true
+    )
+
+    expect(pollJobStateModule.pollJobState).toHaveBeenCalledWith(
+      requestClient,
+      mockJob,
+      false,
+      mockAuthConfig,
+      defaultPollOptions
+    )
+  })
+
+  it('should handle general errors when polling for job status', async () => {
+    jest
+      .spyOn(pollJobStateModule, 'pollJobState')
+      .mockImplementation(() => Promise.reject('Poll Error'))
+
+    const error = await executeScript(
+      requestClient,
+      sessionManager,
+      'test',
+      'test',
+      ['%put "hello";'],
+      'test context',
+      mockAuthConfig,
+      { foo: 'bar' },
+      false,
+      false,
+      true,
+      defaultPollOptions,
+      true
+    ).catch((e) => e)
+
+    expect(error).toContain('Error while polling job status.')
+  })
+
+  it('should fetch the log and append it to the error in case of a 5113 error code', async () => {
+    jest
+      .spyOn(pollJobStateModule, 'pollJobState')
+      .mockImplementation(() =>
+        Promise.reject({ response: { data: 'err=5113,' } })
+      )
+
+    const error = await executeScript(
+      requestClient,
+      sessionManager,
+      'test',
+      'test',
+      ['%put "hello";'],
+      'test context',
+      mockAuthConfig,
+      { foo: 'bar' },
+      false,
+      false,
+      true,
+      defaultPollOptions,
+      true
+    ).catch((e) => e)
+
+    expect(fetchLogsModule.fetchLogByChunks).toHaveBeenCalledWith(
+      requestClient,
+      mockAuthConfig.access_token,
+      mockJob.links.find((l) => l.rel === 'up')!.href + '/log',
+      1000000
+    )
+    expect(error.log).toEqual('Test Log')
+  })
+
+  it('should fetch the logs for the job if debug is true and a log URL is available', async () => {
+    await executeScript(
+      requestClient,
+      sessionManager,
+      'test',
+      'test',
+      ['%put "hello";'],
+      'test context',
+      mockAuthConfig,
+      { foo: 'bar' },
+      true,
+      false,
+      true,
+      defaultPollOptions,
+      true
+    )
+
+    expect(fetchLogsModule.fetchLogByChunks).toHaveBeenCalledWith(
+      requestClient,
+      mockAuthConfig.access_token,
+      mockJob.links.find((l) => l.rel === 'log')!.href + '/content',
+      mockJob.logStatistics.lineCount
+    )
+  })
+
+  it('should not fetch the logs for the job if debug is false', async () => {
+    await executeScript(
+      requestClient,
+      sessionManager,
+      'test',
+      'test',
+      ['%put "hello";'],
+      'test context',
+      mockAuthConfig,
+      { foo: 'bar' },
+      false,
+      false,
+      true,
+      defaultPollOptions,
+      true
+    )
+
+    expect(fetchLogsModule.fetchLogByChunks).not.toHaveBeenCalled()
+  })
+
+  it('should throw a ComputeJobExecutionError if the job has failed', async () => {
+    jest
+      .spyOn(pollJobStateModule, 'pollJobState')
+      .mockImplementation(() => Promise.resolve('failed'))
+
+    const error: ComputeJobExecutionError = await executeScript(
+      requestClient,
+      sessionManager,
+      'test',
+      'test',
+      ['%put "hello";'],
+      'test context',
+      mockAuthConfig,
+      { foo: 'bar' },
+      true,
+      false,
+      true,
+      defaultPollOptions,
+      true
+    ).catch((e) => e)
+
+    expect(fetchLogsModule.fetchLogByChunks).toHaveBeenCalledWith(
+      requestClient,
+      mockAuthConfig.access_token,
+      mockJob.links.find((l) => l.rel === 'log')!.href + '/content',
+      mockJob.logStatistics.lineCount
+    )
+
+    expect(error).toBeInstanceOf(ComputeJobExecutionError)
+    expect(error.log).toEqual('Test Log')
+    expect(error.job).toEqual(mockJob)
+  })
+
+  it('should throw a ComputeJobExecutionError if the job has errored out', async () => {
+    jest
+      .spyOn(pollJobStateModule, 'pollJobState')
+      .mockImplementation(() => Promise.resolve('error'))
+
+    const error: ComputeJobExecutionError = await executeScript(
+      requestClient,
+      sessionManager,
+      'test',
+      'test',
+      ['%put "hello";'],
+      'test context',
+      mockAuthConfig,
+      { foo: 'bar' },
+      true,
+      false,
+      true,
+      defaultPollOptions,
+      true
+    ).catch((e) => e)
+
+    expect(fetchLogsModule.fetchLogByChunks).toHaveBeenCalledWith(
+      requestClient,
+      mockAuthConfig.access_token,
+      mockJob.links.find((l) => l.rel === 'log')!.href + '/content',
+      mockJob.logStatistics.lineCount
+    )
+
+    expect(error).toBeInstanceOf(ComputeJobExecutionError)
+    expect(error.log).toEqual('Test Log')
+    expect(error.job).toEqual(mockJob)
+  })
+
+  it('should fetch the result if expectWebout is true', async () => {
+    await executeScript(
+      requestClient,
+      sessionManager,
+      'test',
+      'test',
+      ['%put "hello";'],
+      'test context',
+      mockAuthConfig,
+      { foo: 'bar' },
+      false,
+      true,
+      true,
+      defaultPollOptions,
+      true
+    )
+
+    expect(requestClient.get).toHaveBeenCalledWith(
+      `/compute/sessions/${mockSession.id}/filerefs/_webout/content`,
+      mockAuthConfig.access_token,
+      'text/plain'
+    )
+  })
+
+  it('should fetch the logs if the webout file was not found', async () => {
+    jest.spyOn(requestClient, 'get').mockImplementation((url, ...rest) => {
+      if (url.includes('_webout')) {
+        return Promise.reject(new NotFoundError(url))
+      }
+      return Promise.resolve({ result: mockJob, etag: '', status: 200 })
+    })
+
+    const error = await executeScript(
+      requestClient,
+      sessionManager,
+      'test',
+      'test',
+      ['%put "hello";'],
+      'test context',
+      mockAuthConfig,
+      { foo: 'bar' },
+      false,
+      true,
+      true,
+      defaultPollOptions,
+      true
+    ).catch((e) => e)
+
+    expect(requestClient.get).toHaveBeenCalledWith(
+      `/compute/sessions/${mockSession.id}/filerefs/_webout/content`,
+      mockAuthConfig.access_token,
+      'text/plain'
+    )
+
+    expect(fetchLogsModule.fetchLogByChunks).toHaveBeenCalledWith(
+      requestClient,
+      mockAuthConfig.access_token,
+      mockJob.links.find((l) => l.rel === 'log')!.href + '/content',
+      mockJob.logStatistics.lineCount
+    )
+
+    expect(error.status).toEqual(500)
+    expect(error.log).toEqual('Test Log')
+  })
+
+  it('should clear the session after execution is complete', async () => {
+    await executeScript(
+      requestClient,
+      sessionManager,
+      'test',
+      'test',
+      ['%put "hello";'],
+      'test context',
+      mockAuthConfig,
+      { foo: 'bar' },
+      false,
+      true,
+      true,
+      defaultPollOptions,
+      true
+    )
+
+    expect(sessionManager.clearSession).toHaveBeenCalledWith(
+      mockSession.id,
+      mockAuthConfig.access_token
+    )
+  })
+
+  it('should handle errors while clearing a session', async () => {
+    jest
+      .spyOn(sessionManager, 'clearSession')
+      .mockImplementation(() => Promise.reject('Clear Session Error'))
+
+    const error = await executeScript(
+      requestClient,
+      sessionManager,
+      'test',
+      'test',
+      ['%put "hello";'],
+      'test context',
+      mockAuthConfig,
+      { foo: 'bar' },
+      false,
+      true,
+      true,
+      defaultPollOptions,
+      true
+    ).catch((e) => e)
+
+    expect(error).toContain('Error while clearing session.')
+  })
+})
+
+const setupMocks = () => {
+  jest.restoreAllMocks()
+  jest.mock('../../../request/RequestClient')
+  jest.mock('../../../SessionManager')
+  jest.mock('../../../auth/getTokens')
+  jest.mock('../pollJobState')
+  jest.mock('../uploadTables')
+  jest.mock('../../../utils/formatDataForRequest')
+  jest.mock('../../../utils/fetchLogByChunks')
+
+  jest
+    .spyOn(requestClient, 'post')
+    .mockImplementation(() => Promise.resolve({ result: mockJob, etag: '' }))
+  jest
+    .spyOn(requestClient, 'get')
+    .mockImplementation(() =>
+      Promise.resolve({ result: mockJob, etag: '', status: 200 })
+    )
+  jest
+    .spyOn(requestClient, 'delete')
+    .mockImplementation(() => Promise.resolve({ result: {}, etag: '' }))
+  jest
+    .spyOn(getTokensModule, 'getTokens')
+    .mockImplementation(() => Promise.resolve(mockAuthConfig))
+  jest
+    .spyOn(pollJobStateModule, 'pollJobState')
+    .mockImplementation(() => Promise.resolve('completed'))
+  jest
+    .spyOn(sessionManager, 'getVariable')
+    .mockImplementation(() =>
+      Promise.resolve({ result: { value: 'test' }, etag: 'test', status: 200 })
+    )
+  jest
+    .spyOn(sessionManager, 'getSession')
+    .mockImplementation(() => Promise.resolve(mockSession))
+  jest
+    .spyOn(sessionManager, 'clearSession')
+    .mockImplementation(() => Promise.resolve())
+  jest
+    .spyOn(formatDataModule, 'formatDataForRequest')
+    .mockImplementation(() => ({ sasjs_tables: 'test', sasjs0data: 'test' }))
+  jest
+    .spyOn(fetchLogsModule, 'fetchLogByChunks')
+    .mockImplementation(() => Promise.resolve('Test Log'))
+}

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

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

src/api/viya/spec/mockResponses.ts

@@ -0,0 +1,73 @@
+import { AuthConfig } from '@sasjs/utils/types'
+import { Job, Session } from '../../../types'
+
+export const mockSession: Session = {
+  id: 's35510n',
+  state: 'idle',
+  links: [],
+  attributes: {
+    sessionInactiveTimeout: 1
+  },
+  creationTimeStamp: new Date().valueOf().toString()
+}
+
+export const mockJob: Job = {
+  id: 'j0b',
+  name: 'test job',
+  uri: '/j0b',
+  createdBy: 'test user',
+  results: {
+    '_webout.json': 'test'
+  },
+  logStatistics: {
+    lineCount: 100,
+    modifiedTimeStamp: new Date().valueOf().toString()
+  },
+  links: [
+    {
+      rel: 'log',
+      href: '/log',
+      method: 'GET',
+      type: 'log',
+      uri: 'log'
+    },
+    {
+      rel: 'self',
+      href: '/job',
+      method: 'GET',
+      type: 'job',
+      uri: 'job'
+    },
+    {
+      rel: 'state',
+      href: '/state',
+      method: 'GET',
+      type: 'state',
+      uri: 'state'
+    },
+    {
+      rel: 'up',
+      href: '/job',
+      method: 'GET',
+      type: 'up',
+      uri: 'job'
+    }
+  ]
+}
+
+export const mockAuthConfig: AuthConfig = {
+  client: 'cl13nt',
+  secret: '53cr3t',
+  access_token: 'acc355',
+  refresh_token: 'r3fr35h'
+}
+
+export class MockStream {
+  _write(chunk: string, _: any, next: Function) {
+    next()
+  }
+
+  reset() {}
+
+  destroy() {}
+}

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

@@ -0,0 +1,346 @@
+import { Logger, LogLevel } from '@sasjs/utils'
+import { RequestClient } from '../../../request/RequestClient'
+import { mockAuthConfig, mockJob } from './mockResponses'
+import { pollJobState } from '../pollJobState'
+import * as getTokensModule from '../../../auth/getTokens'
+import * as saveLogModule from '../saveLog'
+import * as getFileStreamModule from '../getFileStream'
+import * as isNodeModule from '../../../utils/isNode'
+import { PollOptions } from '../../../types'
+import { WriteStream } from 'fs'
+
+const requestClient = new (<jest.Mock<RequestClient>>RequestClient)()
+const defaultPollOptions: PollOptions = {
+  maxPollCount: 100,
+  pollInterval: 500,
+  streamLog: false
+}
+
+describe('pollJobState', () => {
+  beforeEach(() => {
+    ;(process as any).logger = new Logger(LogLevel.Off)
+    setupMocks()
+  })
+
+  it('should get valid tokens if the authConfig has been provided', async () => {
+    await pollJobState(
+      requestClient,
+      mockJob,
+      false,
+      mockAuthConfig,
+      defaultPollOptions
+    )
+
+    expect(getTokensModule.getTokens).toHaveBeenCalledWith(
+      requestClient,
+      mockAuthConfig
+    )
+  })
+
+  it('should not attempt to get tokens if the authConfig has not been provided', async () => {
+    await pollJobState(
+      requestClient,
+      mockJob,
+      false,
+      undefined,
+      defaultPollOptions
+    )
+
+    expect(getTokensModule.getTokens).not.toHaveBeenCalled()
+  })
+
+  it('should throw an error if the job does not have a state link', async () => {
+    const error = await pollJobState(
+      requestClient,
+      { ...mockJob, links: mockJob.links.filter((l) => l.rel !== 'state') },
+      false,
+      undefined,
+      defaultPollOptions
+    ).catch((e) => e)
+
+    expect((error as Error).message).toContain('Job state link was not found.')
+  })
+
+  it('should attempt to refresh tokens before each poll', async () => {
+    mockSimplePoll()
+
+    await pollJobState(
+      requestClient,
+      mockJob,
+      false,
+      mockAuthConfig,
+      defaultPollOptions
+    )
+
+    expect(getTokensModule.getTokens).toHaveBeenCalledTimes(3)
+  })
+
+  it('should attempt to fetch and save the log after each poll when streamLog is true', async () => {
+    mockSimplePoll()
+    const { saveLog } = require('../saveLog')
+
+    await pollJobState(requestClient, mockJob, false, mockAuthConfig, {
+      ...defaultPollOptions,
+      streamLog: true
+    })
+
+    expect(saveLog).toHaveBeenCalledTimes(2)
+  })
+
+  it('should create a write stream in Node.js environment when streamLog is true', async () => {
+    mockSimplePoll()
+    const { getFileStream } = require('../getFileStream')
+    const { saveLog } = require('../saveLog')
+
+    await pollJobState(requestClient, mockJob, false, mockAuthConfig, {
+      ...defaultPollOptions,
+      streamLog: true
+    })
+
+    expect(getFileStream).toHaveBeenCalled()
+    expect(saveLog).toHaveBeenCalledTimes(2)
+  })
+
+  it('should not create a write stream in a non-Node.js environment', async () => {
+    mockSimplePoll()
+    jest.spyOn(isNodeModule, 'isNode').mockImplementation(() => false)
+    const { saveLog } = require('../saveLog')
+    const { getFileStream } = require('../getFileStream')
+
+    await pollJobState(requestClient, mockJob, false, mockAuthConfig, {
+      ...defaultPollOptions,
+      streamLog: true
+    })
+
+    expect(getFileStream).not.toHaveBeenCalled()
+    expect(saveLog).not.toHaveBeenCalled()
+  })
+
+  it('should not attempt to fetch and save the log after each poll when streamLog is false', async () => {
+    mockSimplePoll()
+
+    await pollJobState(
+      requestClient,
+      mockJob,
+      false,
+      mockAuthConfig,
+      defaultPollOptions
+    )
+
+    expect(saveLogModule.saveLog).not.toHaveBeenCalled()
+  })
+
+  it('should return the current status when the max poll count is reached', async () => {
+    mockRunningPoll()
+
+    const state = await pollJobState(
+      requestClient,
+      mockJob,
+      false,
+      mockAuthConfig,
+      {
+        ...defaultPollOptions,
+        maxPollCount: 1
+      }
+    )
+
+    expect(state).toEqual('running')
+  })
+
+  it('should poll with a larger interval for longer running jobs', async () => {
+    mockLongPoll()
+
+    const state = await pollJobState(
+      requestClient,
+      mockJob,
+      false,
+      mockAuthConfig,
+      {
+        ...defaultPollOptions,
+        maxPollCount: 200,
+        pollInterval: 10
+      }
+    )
+
+    expect(state).toEqual('completed')
+  }, 200000)
+
+  it('should continue polling until the job completes or errors', async () => {
+    mockSimplePoll(1)
+
+    const state = await pollJobState(
+      requestClient,
+      mockJob,
+      false,
+      undefined,
+      defaultPollOptions
+    )
+
+    expect(requestClient.get).toHaveBeenCalledTimes(2)
+    expect(state).toEqual('completed')
+  })
+
+  it('should print the state to the console when debug is on', async () => {
+    jest.spyOn((process as any).logger, 'info')
+    mockSimplePoll()
+
+    await pollJobState(
+      requestClient,
+      mockJob,
+      true,
+      undefined,
+      defaultPollOptions
+    )
+
+    expect((process as any).logger.info).toHaveBeenCalledTimes(4)
+    expect((process as any).logger.info).toHaveBeenNthCalledWith(
+      1,
+      'Polling job status...'
+    )
+    expect((process as any).logger.info).toHaveBeenNthCalledWith(
+      2,
+      'Current job state: running'
+    )
+    expect((process as any).logger.info).toHaveBeenNthCalledWith(
+      3,
+      'Polling job status...'
+    )
+    expect((process as any).logger.info).toHaveBeenNthCalledWith(
+      4,
+      'Current job state: completed'
+    )
+  })
+
+  it('should continue polling when there is a single error in between', async () => {
+    mockPollWithSingleError()
+
+    const state = await pollJobState(
+      requestClient,
+      mockJob,
+      false,
+      undefined,
+      defaultPollOptions
+    )
+
+    expect(requestClient.get).toHaveBeenCalledTimes(2)
+    expect(state).toEqual('completed')
+  })
+
+  it('should throw an error when the error count exceeds the set value of 5', async () => {
+    mockErroredPoll()
+
+    const error = await pollJobState(
+      requestClient,
+      mockJob,
+      false,
+      undefined,
+      defaultPollOptions
+    ).catch((e) => e)
+
+    expect(error.message).toEqual(
+      'Error while polling job state for job j0b: Status Error'
+    )
+  })
+})
+
+const setupMocks = () => {
+  jest.restoreAllMocks()
+  jest.mock('../../../request/RequestClient')
+  jest.mock('../../../auth/getTokens')
+  jest.mock('../saveLog')
+  jest.mock('../getFileStream')
+  jest.mock('../../../utils/isNode')
+
+  jest
+    .spyOn(requestClient, 'get')
+    .mockImplementation(() =>
+      Promise.resolve({ result: 'completed', etag: '', status: 200 })
+    )
+  jest
+    .spyOn(getTokensModule, 'getTokens')
+    .mockImplementation(() => Promise.resolve(mockAuthConfig))
+  jest
+    .spyOn(saveLogModule, 'saveLog')
+    .mockImplementation(() => Promise.resolve())
+  jest
+    .spyOn(getFileStreamModule, 'getFileStream')
+    .mockImplementation(() => Promise.resolve({} as unknown as WriteStream))
+  jest.spyOn(isNodeModule, 'isNode').mockImplementation(() => true)
+}
+
+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
+          ? 'pending'
+          : count <= runningCount
+          ? 'running'
+          : 'completed',
+      etag: '',
+      status: 200
+    })
+  })
+}
+
+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: '',
+      status: 200
+    })
+  })
+}
+
+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: '',
+      status: 200
+    })
+  })
+}
+
+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: '',
+      status: 200
+    })
+  })
+}
+
+const mockErroredPoll = () => {
+  jest.spyOn(requestClient, 'get').mockImplementation((url) => {
+    if (url.includes('job')) {
+      return Promise.resolve({ result: mockJob, etag: '', status: 200 })
+    }
+    return Promise.reject('Status Error')
+  })
+}

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

@@ -0,0 +1,73 @@
+import { Logger, LogLevel } from '@sasjs/utils'
+import { RequestClient } from '../../../request/RequestClient'
+import * as fetchLogsModule from '../../../utils/fetchLogByChunks'
+import * as writeStreamModule from '../writeStream'
+import { saveLog } from '../saveLog'
+import { mockJob } from './mockResponses'
+import { WriteStream } from '../../../types'
+
+const requestClient = new (<jest.Mock<RequestClient>>RequestClient)()
+const stream = {} as unknown as WriteStream
+
+describe('saveLog', () => {
+  beforeEach(() => {
+    ;(process as any).logger = new Logger(LogLevel.Off)
+    setupMocks()
+  })
+
+  it('should throw an error when a valid access token is not provided', async () => {
+    const error = await saveLog(mockJob, requestClient, 0, 100, stream).catch(
+      (e) => e
+    )
+
+    expect(error.message).toContain(
+      `Logs for job ${mockJob.id} cannot be fetched without a valid access token.`
+    )
+  })
+
+  it('should throw an error when the log URL is not available', async () => {
+    const error = await saveLog(
+      { ...mockJob, links: mockJob.links.filter((l) => l.rel !== 'log') },
+      requestClient,
+      0,
+      100,
+      stream,
+      't0k3n'
+    ).catch((e) => e)
+
+    expect(error.message).toContain(
+      `Log URL for job ${mockJob.id} was not found.`
+    )
+  })
+
+  it('should fetch and save logs to the given path', async () => {
+    await saveLog(mockJob, requestClient, 0, 100, stream, 't0k3n')
+
+    expect(fetchLogsModule.fetchLog).toHaveBeenCalledWith(
+      requestClient,
+      't0k3n',
+      '/log/content',
+      0,
+      100
+    )
+    expect(writeStreamModule.writeStream).toHaveBeenCalledWith(
+      stream,
+      'Test Log'
+    )
+  })
+})
+
+const setupMocks = () => {
+  jest.restoreAllMocks()
+  jest.mock('../../../request/RequestClient')
+  jest.mock('../../../utils/fetchLogByChunks')
+  jest.mock('@sasjs/utils')
+  jest.mock('../writeStream')
+
+  jest
+    .spyOn(fetchLogsModule, 'fetchLog')
+    .mockImplementation(() => Promise.resolve('Test Log'))
+  jest
+    .spyOn(writeStreamModule, 'writeStream')
+    .mockImplementation(() => Promise.resolve())
+}

src/api/viya/spec/uploadTables.spec.ts

@@ -0,0 +1,67 @@
+import { RequestClient } from '../../../request/RequestClient'
+import * as convertToCsvModule from '../../../utils/convertToCsv'
+import { uploadTables } from '../uploadTables'
+
+const requestClient = new (<jest.Mock<RequestClient>>RequestClient)()
+
+describe('uploadTables', () => {
+  beforeEach(() => {
+    setupMocks()
+  })
+
+  it('should return a list of uploaded files', async () => {
+    const data = { foo: 'bar' }
+
+    const files = await uploadTables(requestClient, data, 't0k3n')
+
+    expect(files).toEqual([{ tableName: 'foo', file: 'test-file' }])
+    expect(requestClient.uploadFile).toHaveBeenCalledTimes(1)
+    expect(requestClient.uploadFile).toHaveBeenCalledWith(
+      '/files/files#rawUpload',
+      'Test CSV',
+      't0k3n'
+    )
+  })
+
+  it('should throw an error when the CSV exceeds the maximum length', async () => {
+    const data = { foo: 'bar' }
+    jest
+      .spyOn(convertToCsvModule, 'convertToCSV')
+      .mockImplementation(() => 'ERROR: LARGE STRING LENGTH')
+
+    const error = await uploadTables(requestClient, data, 't0k3n').catch(
+      (e) => e
+    )
+
+    expect(requestClient.uploadFile).not.toHaveBeenCalled()
+    expect(error.message).toEqual(
+      'The max length of a string value in SASjs is 32765 characters.'
+    )
+  })
+
+  it('should throw an error when the file upload fails', async () => {
+    const data = { foo: 'bar' }
+    jest
+      .spyOn(requestClient, 'uploadFile')
+      .mockImplementation(() => Promise.reject('Upload Error'))
+
+    const error = await uploadTables(requestClient, data, 't0k3n').catch(
+      (e) => e
+    )
+
+    expect(error).toContain('Error while uploading file.')
+  })
+})
+
+const setupMocks = () => {
+  jest.restoreAllMocks()
+  jest.mock('../../../utils/convertToCsv')
+  jest
+    .spyOn(convertToCsvModule, 'convertToCSV')
+    .mockImplementation(() => 'Test CSV')
+  jest
+    .spyOn(requestClient, 'uploadFile')
+    .mockImplementation(() =>
+      Promise.resolve({ result: 'test-file', etag: '' })
+    )
+}

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

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

src/api/viya/uploadTables.ts

@@ -0,0 +1,37 @@
+import { prefixMessage } from '@sasjs/utils/error'
+import { RequestClient } from '../../request/RequestClient'
+import { convertToCSV } from '../../utils/convertToCsv'
+
+/**
+ * Uploads tables to SAS as specially formatted CSVs.
+ * This is more compact than JSON, and easier to read within SAS.
+ * @param requestClient - the pre-configured HTTP request client
+ * @param data - the JSON representation of the data to be uploaded
+ * @param accessToken - an optional access token for authentication/authorization
+ * The access token is not required when uploading tables from the browser.
+ */
+export async function uploadTables(
+  requestClient: RequestClient,
+  data: any,
+  accessToken?: string
+) {
+  const uploadedFiles = []
+
+  for (const tableName in data) {
+    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 uploadResponse = await requestClient
+      .uploadFile(`/files/files#rawUpload`, csv, accessToken)
+      .catch((err) => {
+        throw prefixMessage(err, 'Error while uploading file. ')
+      })
+
+    uploadedFiles.push({ tableName, file: uploadResponse.result })
+  }
+  return uploadedFiles
+}

src/api/viya/writeStream.ts

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

src/auth/AuthManager.ts

@@ -1,12 +1,16 @@
 import { ServerType } from '@sasjs/utils/types'
-import { isAuthorizeFormRequired } from '.'
 import { RequestClient } from '../request/RequestClient'
+import { LoginOptions, LoginResult } from '../types/Login'
 import { serialize } from '../utils'
+import { openWebPage } from './openWebPage'
+import { verifySas9Login } from './verifySas9Login'
+import { verifySasViyaLogin } from './verifySasViyaLogin'
 
 export class AuthManager {
   public userName = ''
   private loginUrl: string
   private logoutUrl: string
+  private redirectedLoginUrl = `/SASLogon/home`
   constructor(
     private serverUrl: string,
     private serverType: ServerType,
@@ -20,30 +24,141 @@ export class AuthManager {
         : '/SASLogon/logout.do?'
   }
 
+  /**
+   * Opens Pop up window to SAS Login screen.
+   * And checks if user has finished login process.
+   */
+  public async redirectedLogIn({
+    onLoggedOut
+  }: LoginOptions): Promise<LoginResult> {
+    const { isLoggedIn: isLoggedInAlready, userName: currentSessionUsername } =
+      await this.fetchUserName()
+
+    if (isLoggedInAlready) {
+      await this.loginCallback()
+
+      return {
+        isLoggedIn: true,
+        userName: currentSessionUsername
+      }
+    }
+
+    const loginPopup = await openWebPage(
+      this.redirectedLoginUrl,
+      'SASLogon',
+      {
+        width: 500,
+        height: 600
+      },
+      onLoggedOut
+    )
+
+    if (!loginPopup) {
+      return { isLoggedIn: false, userName: '' }
+    }
+
+    const { isLoggedIn } =
+      this.serverType === ServerType.SasViya
+        ? await verifySasViyaLogin(loginPopup)
+        : await verifySas9Login(loginPopup)
+
+    loginPopup.close()
+
+    if (isLoggedIn) {
+      if (this.serverType === ServerType.Sas9) {
+        await this.performCASSecurityCheck()
+      }
+
+      const { userName } = await this.fetchUserName()
+
+      await this.loginCallback()
+
+      return { isLoggedIn: true, userName }
+    }
+
+    return { isLoggedIn: false, userName: '' }
+  }
+
   /**
    * Logs into the SAS server with the supplied credentials.
    * @param username - a string representing the username.
    * @param password - a string representing the password.
+   * @returns - a boolean `isLoggedin` and a string `username`
    */
-  public async logIn(username: string, password: string) {
-    const loginParams: any = {
+  public async logIn(username: string, password: string): Promise<LoginResult> {
+    const loginParams = {
       _service: 'default',
       username,
       password
     }
 
-    this.userName = loginParams.username
+    let {
+      isLoggedIn: isLoggedInAlready,
+      loginForm,
+      userName: currentSessionUsername
+    } = await this.checkSession()
 
-    const { isLoggedIn, loginForm } = await this.checkSession()
-    if (isLoggedIn) {
-      await this.loginCallback()
+    if (isLoggedInAlready) {
+      if (currentSessionUsername === loginParams.username) {
+        await this.loginCallback()
 
-      return {
-        isLoggedIn,
-        userName: this.userName
+        this.userName = currentSessionUsername!
+        return {
+          isLoggedIn: true,
+          userName: this.userName
+        }
+      } else {
+        await this.logOut()
+        loginForm = await this.getNewLoginForm()
       }
+    } else this.userName = ''
+
+    let loginResponse = await this.sendLoginRequest(loginForm, loginParams)
+
+    let isLoggedIn = isLogInSuccess(loginResponse)
+
+    if (!isLoggedIn) {
+      if (isCredentialsVerifyError(loginResponse)) {
+        const newLoginForm = await this.getLoginForm(loginResponse)
+
+        loginResponse = await this.sendLoginRequest(newLoginForm, loginParams)
+      }
+
+      const res = await this.checkSession()
+      isLoggedIn = res.isLoggedIn
+
+      if (isLoggedIn) this.userName = res.userName
+    } else {
+      this.userName = loginParams.username
     }
 
+    if (isLoggedIn) {
+      if (this.serverType === ServerType.Sas9) {
+        await this.performCASSecurityCheck()
+      }
+
+      this.loginCallback()
+    } else this.userName = ''
+
+    return {
+      isLoggedIn,
+      userName: this.userName
+    }
+  }
+
+  private async performCASSecurityCheck() {
+    const casAuthenticationUrl = `${this.serverUrl}/SASStoredProcess/j_spring_cas_security_check`
+
+    await this.requestClient.get<string>(
+      `/SASLogon/login?service=${casAuthenticationUrl}`,
+      undefined
+    )
+  }
+
+  private async sendLoginRequest(
+    loginForm: { [key: string]: any },
+    loginParams: { [key: string]: any }
+  ) {
     for (const key in loginForm) {
       loginParams[key] = loginForm[key]
     }
@@ -60,33 +175,58 @@ export class AuthManager {
       }
     )
 
-    let loggedIn = isLogInSuccess(loginResponse)
-
-    if (!loggedIn) {
-      const currentSession = await this.checkSession()
-      loggedIn = currentSession.isLoggedIn
-    }
-
-    if (loggedIn) {
-      this.loginCallback()
-    }
-
-    return {
-      isLoggedIn: !!loggedIn,
-      userName: this.userName
-    }
+    return loginResponse
   }
 
   /**
    * 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`.
+   * @returns - a promise which resolves with an object containing three values
+   *  - a boolean `isLoggedIn`
+   *  - a string `userName` and
+   *  - a form `loginForm` if not loggedin.
    */
-  public async checkSession() {
+  public async checkSession(): Promise<{
+    isLoggedIn: boolean
+    userName: string
+    loginForm?: any
+  }> {
+    const { isLoggedIn, userName } = await this.fetchUserName()
+    let loginForm = null
+
+    if (!isLoggedIn) {
+      //We will logout to make sure cookies are removed and login form is presented
+      //Residue can happen in case of session expiration
+      await this.logOut()
+
+      loginForm = await this.getNewLoginForm()
+    }
+
+    return Promise.resolve({
+      isLoggedIn,
+      userName: userName.toLowerCase(),
+      loginForm
+    })
+  }
+
+  private async getNewLoginForm() {
+    const { result: formResponse } = await this.requestClient.get<string>(
+      this.loginUrl.replace('.do', ''),
+      undefined,
+      'text/plain'
+    )
+
+    return await this.getLoginForm(formResponse)
+  }
+
+  private async fetchUserName(): Promise<{
+    isLoggedIn: boolean
+    userName: string
+  }> {
     //For VIYA we will send request on API endpoint. Which is faster then pinging SASJobExecution.
     //For SAS9 we will send request on SASStoredProcess
     const url =
-      this.serverType === 'SASVIYA'
-        ? `${this.serverUrl}/identities`
+      this.serverType === ServerType.SasViya
+        ? `${this.serverUrl}/identities/users/@currentUser`
         : `${this.serverUrl}/SASStoredProcess`
 
     const { result: loginResponse } = await this.requestClient
@@ -96,26 +236,27 @@ export class AuthManager {
       })
 
     const isLoggedIn = loginResponse !== 'authErr'
-    let loginForm = null
+    const userName = isLoggedIn ? this.extractUserName(loginResponse) : ''
 
-    if (!isLoggedIn) {
-      //We will logout to make sure cookies are removed and login form is presented
-      this.logOut()
+    return { isLoggedIn, userName }
+  }
 
-      const { result: formResponse } = await this.requestClient.get<string>(
-        this.loginUrl.replace('.do', ''),
-        undefined,
-        'text/plain'
-      )
+  private extractUserName = (response: any): string => {
+    switch (this.serverType) {
+      case ServerType.SasViya:
+        return response?.id
 
-      loginForm = await this.getLoginForm(formResponse)
+      case ServerType.Sas9:
+        const matched = response?.match(/"title":"Log Off [0-1a-zA-Z ]*"/)
+        const username = matched?.[0].slice(17, -1)
+
+        if (!username.includes(' ')) return username
+
+        return username
+          .split(' ')
+          .map((name: string) => name.slice(0, 3).toLowerCase())
+          .join('')
     }
-
-    return Promise.resolve({
-      isLoggedIn,
-      userName: this.userName,
-      loginForm
-    })
   }
 
   private getLoginForm(response: any) {
@@ -168,5 +309,10 @@ export class AuthManager {
   }
 }
 
+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 = (response: string): boolean =>
   /You have signed in/gm.test(response)

src/auth/getAccessToken.ts

@@ -0,0 +1,53 @@
+import { SasAuthResponse } from '@sasjs/utils/types'
+import { prefixMessage } from '@sasjs/utils/error'
+import * as NodeFormData from 'form-data'
+import { RequestClient } from '../request/RequestClient'
+
+/**
+ * Exchanges the auth code for an access token for the given 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.
+ */
+export async function getAccessToken(
+  requestClient: RequestClient,
+  clientId: string,
+  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 headers = {
+    Authorization: 'Basic ' + token
+  }
+
+  let formData
+  if (typeof FormData === 'undefined') {
+    formData = new NodeFormData()
+  } else {
+    formData = new FormData()
+  }
+  formData.append('grant_type', 'authorization_code')
+  formData.append('code', authCode)
+
+  const authResponse = await requestClient
+    .post(
+      url,
+      formData,
+      undefined,
+      'multipart/form-data; boundary=' + (formData as any)._boundary,
+      headers
+    )
+    .then((res) => res.result as SasAuthResponse)
+    .catch((err) => {
+      throw prefixMessage(err, 'Error while getting access token')
+    })
+
+  return authResponse
+}

src/auth/getTokens.ts

@@ -0,0 +1,40 @@
+import {
+  isAccessTokenExpiring,
+  isRefreshTokenExpiring,
+  hasTokenExpired
+} from '@sasjs/utils/auth'
+import { AuthConfig } from '@sasjs/utils/types'
+import { RequestClient } from '../request/RequestClient'
+import { refreshTokens } from './refreshTokens'
+
+/**
+ * Returns the auth configuration, refreshing the tokens if necessary.
+ * @param requestClient - the pre-configured HTTP request client
+ * @param authConfig - an object containing a client ID, secret, access token and refresh token
+ */
+export async function getTokens(
+  requestClient: RequestClient,
+  authConfig: AuthConfig
+): Promise<AuthConfig> {
+  const logger = process.logger || console
+  let { access_token, refresh_token, client, secret } = authConfig
+  if (
+    isAccessTokenExpiring(access_token) ||
+    isRefreshTokenExpiring(refresh_token)
+  ) {
+    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.')
+    ;({ access_token, refresh_token } = await refreshTokens(
+      requestClient,
+      client,
+      secret,
+      refresh_token
+    ))
+  }
+  return { access_token, refresh_token, client, secret }
+}

src/auth/openWebPage.ts

@@ -0,0 +1,40 @@
+import { openLoginPrompt } from '../utils/loginPrompt'
+
+interface WindowFeatures {
+  width: number
+  height: number
+}
+
+const defaultWindowFeatures: WindowFeatures = { width: 500, height: 600 }
+
+export async function openWebPage(
+  url: string,
+  windowName: string = '',
+  WindowFeatures: WindowFeatures = defaultWindowFeatures,
+  onLoggedOut?: () => Promise<Boolean>
+): Promise<Window | null> {
+  const { width, height } = WindowFeatures
+  const left = screen.width / 2 - width / 2
+  const top = screen.height / 2 - height / 2
+
+  const loginPopup = window.open(
+    url,
+    windowName,
+    `toolbar=0,location=0,menubar=0,width=${width},height=${height},left=${left},top=${top}`
+  )
+
+  if (!loginPopup) {
+    const getUserAction: () => Promise<Boolean> = onLoggedOut ?? openLoginPrompt
+
+    const doLogin = await getUserAction()
+    return doLogin
+      ? window.open(
+          url,
+          windowName,
+          `toolbar=0,location=0,menubar=0,width=${width},height=${height},left=${left},top=${top}`
+        )
+      : null
+  }
+
+  return loginPopup
+}

src/auth/refreshTokens.ts

@@ -0,0 +1,49 @@
+import { SasAuthResponse } from '@sasjs/utils/types'
+import { prefixMessage } from '@sasjs/utils/error'
+import * as NodeFormData from 'form-data'
+import { RequestClient } from '../request/RequestClient'
+
+/**
+ * Exchanges the refresh token for an access token for the given 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 refresh token received from the server.
+ */
+export async function refreshTokens(
+  requestClient: RequestClient,
+  clientId: string,
+  clientSecret: string,
+  refreshToken: string
+) {
+  const url = '/SASLogon/oauth/token'
+  let token
+  token =
+    typeof Buffer === 'undefined'
+      ? btoa(clientId + ':' + clientSecret)
+      : Buffer.from(clientId + ':' + clientSecret).toString('base64')
+
+  const headers = {
+    Authorization: 'Basic ' + token
+  }
+
+  const formData =
+    typeof FormData === 'undefined' ? new NodeFormData() : new FormData()
+  formData.append('grant_type', 'refresh_token')
+  formData.append('refresh_token', refreshToken)
+
+  const authResponse = await requestClient
+    .post<SasAuthResponse>(
+      url,
+      formData,
+      undefined,
+      'multipart/form-data; boundary=' + (formData as any)._boundary,
+      headers
+    )
+    .then((res) => res.result)
+    .catch((err) => {
+      throw prefixMessage(err, 'Error while refreshing tokens')
+    })
+
+  return authResponse
+}

src/auth/spec/AuthManager.spec.ts

@@ -3,10 +3,14 @@ import * as dotenv from 'dotenv'
 import { ServerType } from '@sasjs/utils/types'
 import axios from 'axios'
 import {
+  mockedCurrentUserApi,
   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'
 jest.mock('axios')
 const mockedAxios = axios as jest.Mocked<typeof axios>
@@ -57,139 +61,614 @@ describe('AuthManager', () => {
     expect((authManager as any).logoutUrl).toEqual('/SASLogon/logout?')
   })
 
-  it('should call the auth callback and return when already logged in', async (done) => {
-    const authManager = new AuthManager(
-      serverUrl,
-      serverType,
-      requestClient,
-      authCallback
-    )
-    jest.spyOn(authManager, 'checkSession').mockImplementation(() =>
-      Promise.resolve({
-        isLoggedIn: true,
-        userName: 'test',
-        loginForm: 'test'
-      })
-    )
+  describe('login - default mechanism', () => {
+    it('should call the auth callback and return when already logged in', async () => {
+      const authManager = new AuthManager(
+        serverUrl,
+        serverType,
+        requestClient,
+        authCallback
+      )
+      jest.spyOn(authManager, 'checkSession').mockImplementation(() =>
+        Promise.resolve({
+          isLoggedIn: true,
+          userName,
+          loginForm: 'test'
+        })
+      )
 
-    const loginResponse = await authManager.logIn(userName, password)
+      const loginResponse = await authManager.logIn(userName, password)
 
-    expect(loginResponse.isLoggedIn).toBeTruthy()
-    expect(loginResponse.userName).toEqual(userName)
-    expect(authCallback).toHaveBeenCalledTimes(1)
-    done()
-  })
-
-  it('should post a login request to the server if not logged in', async (done) => {
-    const authManager = new AuthManager(
-      serverUrl,
-      serverType,
-      requestClient,
-      authCallback
-    )
-    jest.spyOn(authManager, 'checkSession').mockImplementation(() =>
-      Promise.resolve({
-        isLoggedIn: false,
-        userName: 'test',
-        loginForm: { name: 'test' }
-      })
-    )
-    mockedAxios.post.mockImplementation(() =>
-      Promise.resolve({ data: mockLoginSuccessResponse })
-    )
-
-    const loginResponse = await authManager.logIn(userName, password)
-
-    expect(loginResponse.isLoggedIn).toBeTruthy()
-    expect(loginResponse.userName).toEqual(userName)
-
-    const loginParams = serialize({
-      _service: 'default',
-      username: userName,
-      password,
-      name: 'test'
+      expect(loginResponse.isLoggedIn).toBeTruthy()
+      expect(loginResponse.userName).toEqual(userName)
+      expect(authCallback).toHaveBeenCalledTimes(1)
     })
-    expect(mockedAxios.post).toHaveBeenCalledWith(
-      `/SASLogon/login`,
-      loginParams,
-      {
-        withCredentials: true,
-        headers: {
-          'Content-Type': 'application/x-www-form-urlencoded',
-          Accept: '*/*'
+
+    it('should post a login request to the server when already logged in with other username', async () => {
+      const authManager = new AuthManager(
+        serverUrl,
+        serverType,
+        requestClient,
+        authCallback
+      )
+      jest.spyOn(authManager, 'checkSession').mockImplementation(() =>
+        Promise.resolve({
+          isLoggedIn: true,
+          userName: 'someOtherUsername',
+          loginForm: null
+        })
+      )
+      jest
+        .spyOn(authManager, 'logOut')
+        .mockImplementation(() => Promise.resolve(true))
+
+      jest
+        .spyOn<any, any>(authManager, 'getNewLoginForm')
+        .mockImplementation(() =>
+          Promise.resolve({
+            name: 'test'
+          })
+        )
+      mockedAxios.post.mockImplementation(() =>
+        Promise.resolve({ data: mockLoginSuccessResponse })
+      )
+
+      const loginResponse = await authManager.logIn(userName, password)
+
+      expect(loginResponse.isLoggedIn).toBeTruthy()
+      expect(loginResponse.userName).toEqual(userName)
+
+      const loginParams = serialize({
+        _service: 'default',
+        username: userName,
+        password,
+        name: 'test'
+      })
+      expect(authCallback).toHaveBeenCalledTimes(1)
+      expect(authManager.logOut).toHaveBeenCalledTimes(1)
+      expect(authManager['getNewLoginForm']).toHaveBeenCalledTimes(1)
+      expect(mockedAxios.post).toHaveBeenCalledWith(
+        `/SASLogon/login`,
+        loginParams,
+        {
+          withCredentials: true,
+          headers: {
+            'Content-Type': 'application/x-www-form-urlencoded',
+            Accept: '*/*'
+          }
         }
-      }
-    )
-    expect(authCallback).toHaveBeenCalledTimes(1)
-    done()
+      )
+      expect(authCallback).toHaveBeenCalledTimes(1)
+    })
+
+    it('should post a login request to the server when not logged in', async () => {
+      const authManager = new AuthManager(
+        serverUrl,
+        serverType,
+        requestClient,
+        authCallback
+      )
+      jest.spyOn(authManager, 'checkSession').mockImplementation(() =>
+        Promise.resolve({
+          isLoggedIn: false,
+          userName: '',
+          loginForm: { name: 'test' }
+        })
+      )
+      mockedAxios.post.mockImplementation(() =>
+        Promise.resolve({ data: mockLoginSuccessResponse })
+      )
+
+      const loginResponse = await authManager.logIn(userName, password)
+
+      expect(loginResponse.isLoggedIn).toBeTruthy()
+      expect(loginResponse.userName).toEqual(userName)
+
+      const loginParams = serialize({
+        _service: 'default',
+        username: userName,
+        password,
+        name: 'test'
+      })
+      expect(mockedAxios.post).toHaveBeenCalledWith(
+        `/SASLogon/login`,
+        loginParams,
+        {
+          withCredentials: true,
+          headers: {
+            'Content-Type': 'application/x-www-form-urlencoded',
+            Accept: '*/*'
+          }
+        }
+      )
+      expect(authCallback).toHaveBeenCalledTimes(1)
+    })
+
+    it('should post a login & a cas_security request to the SAS9 server when not logged in', async () => {
+      const serverType = ServerType.Sas9
+      const authManager = new AuthManager(
+        serverUrl,
+        serverType,
+        requestClient,
+        authCallback
+      )
+      jest.spyOn(authManager, 'checkSession').mockImplementation(() =>
+        Promise.resolve({
+          isLoggedIn: false,
+          userName: '',
+          loginForm: { name: 'test' }
+        })
+      )
+      mockedAxios.post.mockImplementation(() =>
+        Promise.resolve({ data: mockLoginSuccessResponse })
+      )
+      mockedAxios.get.mockImplementation(() => Promise.resolve({ status: 200 }))
+
+      const loginResponse = await authManager.logIn(userName, password)
+
+      expect(loginResponse.isLoggedIn).toBeTruthy()
+      expect(loginResponse.userName).toEqual(userName)
+
+      const loginParams = serialize({
+        _service: 'default',
+        username: userName,
+        password,
+        name: 'test'
+      })
+      expect(mockedAxios.post).toHaveBeenCalledWith(
+        `/SASLogon/login`,
+        loginParams,
+        {
+          withCredentials: true,
+          headers: {
+            'Content-Type': 'application/x-www-form-urlencoded',
+            Accept: '*/*'
+          }
+        }
+      )
+      const casAuthenticationUrl = `${serverUrl}/SASStoredProcess/j_spring_cas_security_check`
+      expect(mockedAxios.get).toHaveBeenCalledWith(
+        `/SASLogon/login?service=${casAuthenticationUrl}`,
+        getHeadersJson
+      )
+      expect(authCallback).toHaveBeenCalledTimes(1)
+    })
+
+    it('should return empty username if unable to logged in', async () => {
+      const authManager = new AuthManager(
+        serverUrl,
+        serverType,
+        requestClient,
+        authCallback
+      )
+      jest.spyOn(authManager, 'checkSession').mockImplementation(() =>
+        Promise.resolve({
+          isLoggedIn: false,
+          userName: '',
+          loginForm: { name: 'test' }
+        })
+      )
+      mockedAxios.post.mockImplementation(() =>
+        Promise.resolve({ data: 'Not Signed in' })
+      )
+
+      const loginResponse = await authManager.logIn(userName, password)
+
+      expect(loginResponse.isLoggedIn).toBeFalsy()
+      expect(loginResponse.userName).toEqual('')
+
+      const loginParams = serialize({
+        _service: 'default',
+        username: userName,
+        password,
+        name: 'test'
+      })
+      expect(mockedAxios.post).toHaveBeenCalledWith(
+        `/SASLogon/login`,
+        loginParams,
+        {
+          withCredentials: true,
+          headers: {
+            'Content-Type': 'application/x-www-form-urlencoded',
+            Accept: '*/*'
+          }
+        }
+      )
+    })
+
+    it('should parse and submit the authorisation form when necessary', async () => {
+      const authManager = new AuthManager(
+        serverUrl,
+        serverType,
+        requestClient,
+        authCallback
+      )
+      jest
+        .spyOn(requestClient, 'authorize')
+        .mockImplementation(() => Promise.resolve())
+      jest.spyOn(authManager, 'checkSession').mockImplementation(() =>
+        Promise.resolve({
+          isLoggedIn: false,
+          userName: 'test',
+          loginForm: { name: 'test' }
+        })
+      )
+      mockedAxios.post.mockImplementationOnce(() =>
+        Promise.resolve({
+          data: mockLoginAuthoriseRequiredResponse,
+          config: { url: 'https://test.com/SASLogon/login' },
+          request: { responseURL: 'https://test.com/OAuth/authorize' }
+        })
+      )
+
+      mockedAxios.get.mockImplementationOnce(() =>
+        Promise.resolve({
+          data: mockLoginAuthoriseRequiredResponse
+        })
+      )
+
+      await authManager.logIn(userName, password)
+
+      expect(requestClient.authorize).toHaveBeenCalledWith(
+        mockLoginAuthoriseRequiredResponse
+      )
+    })
   })
 
-  it('should parse and submit the authorisation form when necessary', async (done) => {
-    const authManager = new AuthManager(
-      serverUrl,
-      serverType,
-      requestClient,
-      authCallback
-    )
-    jest
-      .spyOn(requestClient, 'authorize')
-      .mockImplementation(() => Promise.resolve())
-    jest.spyOn(authManager, 'checkSession').mockImplementation(() =>
-      Promise.resolve({
-        isLoggedIn: false,
-        userName: 'test',
-        loginForm: { name: 'test' }
-      })
-    )
-    mockedAxios.post.mockImplementationOnce(() =>
-      Promise.resolve({
-        data: mockLoginAuthoriseRequiredResponse,
-        config: { url: 'https://test.com/SASLogon/login' },
-        request: { responseURL: 'https://test.com/OAuth/authorize' }
-      })
-    )
+  describe('login - redirect mechanism', () => {
+    beforeAll(() => {
+      jest.mock('../openWebPage')
+      jest
+        .spyOn(openWebPageModule, 'openWebPage')
+        .mockImplementation(() =>
+          Promise.resolve({ close: jest.fn() } as unknown as Window)
+        )
+      jest.mock('../verifySasViyaLogin')
+      jest
+        .spyOn(verifySasViyaLoginModule, 'verifySasViyaLogin')
+        .mockImplementation(() => Promise.resolve({ isLoggedIn: true }))
+      jest.mock('../verifySas9Login')
+      jest
+        .spyOn(verifySas9LoginModule, 'verifySas9Login')
+        .mockImplementation(() => Promise.resolve({ isLoggedIn: true }))
+    })
 
-    mockedAxios.get.mockImplementationOnce(() =>
-      Promise.resolve({
-        data: mockLoginAuthoriseRequiredResponse
-      })
-    )
+    it('should call the auth callback and return when already logged in', async () => {
+      const authManager = new AuthManager(
+        serverUrl,
+        serverType,
+        requestClient,
+        authCallback
+      )
+      jest
+        .spyOn<any, any>(authManager, 'fetchUserName')
+        .mockImplementation(() =>
+          Promise.resolve({
+            isLoggedIn: true,
+            userName
+          })
+        )
 
-    await authManager.logIn(userName, password)
+      const loginResponse = await authManager.redirectedLogIn({})
 
-    expect(requestClient.authorize).toHaveBeenCalledWith(
-      mockLoginAuthoriseRequiredResponse
-    )
-    done()
+      expect(loginResponse.isLoggedIn).toBeTruthy()
+      expect(loginResponse.userName).toEqual(userName)
+      expect(authCallback).toHaveBeenCalledTimes(1)
+    })
+
+    it('should perform login via pop up if not logged in', async () => {
+      const authManager = new AuthManager(
+        serverUrl,
+        serverType,
+        requestClient,
+        authCallback
+      )
+      jest
+        .spyOn<any, any>(authManager, 'fetchUserName')
+        .mockImplementationOnce(() =>
+          Promise.resolve({
+            isLoggedIn: false,
+            userName: ''
+          })
+        )
+        .mockImplementationOnce(() =>
+          Promise.resolve({
+            isLoggedIn: true,
+            userName
+          })
+        )
+
+      const loginResponse = await authManager.redirectedLogIn({})
+
+      expect(loginResponse.isLoggedIn).toBeTruthy()
+      expect(loginResponse.userName).toEqual(userName)
+
+      expect(openWebPageModule.openWebPage).toHaveBeenCalledWith(
+        `/SASLogon/home`,
+        'SASLogon',
+        {
+          width: 500,
+          height: 600
+        },
+        undefined
+      )
+      expect(authManager['fetchUserName']).toHaveBeenCalledTimes(2)
+      expect(verifySasViyaLoginModule.verifySasViyaLogin).toHaveBeenCalledTimes(
+        1
+      )
+      expect(authCallback).toHaveBeenCalledTimes(1)
+    })
+
+    it('should perform login via pop up if not logged in with server sas9', async () => {
+      const serverType = ServerType.Sas9
+      const authManager = new AuthManager(
+        serverUrl,
+        serverType,
+        requestClient,
+        authCallback
+      )
+      jest
+        .spyOn<any, any>(authManager, 'fetchUserName')
+        .mockImplementationOnce(() =>
+          Promise.resolve({
+            isLoggedIn: false,
+            userName: ''
+          })
+        )
+        .mockImplementationOnce(() =>
+          Promise.resolve({
+            isLoggedIn: true,
+            userName
+          })
+        )
+
+      const loginResponse = await authManager.redirectedLogIn({})
+
+      expect(loginResponse.isLoggedIn).toBeTruthy()
+      expect(loginResponse.userName).toEqual(userName)
+
+      expect(openWebPageModule.openWebPage).toHaveBeenCalledWith(
+        `/SASLogon/home`,
+        'SASLogon',
+        {
+          width: 500,
+          height: 600
+        },
+        undefined
+      )
+      expect(authManager['fetchUserName']).toHaveBeenCalledTimes(2)
+      expect(verifySas9LoginModule.verifySas9Login).toHaveBeenCalledTimes(1)
+      expect(authCallback).toHaveBeenCalledTimes(1)
+    })
+
+    it('should return empty username if user unable to re-login via pop up', async () => {
+      const authManager = new AuthManager(
+        serverUrl,
+        serverType,
+        requestClient,
+        authCallback
+      )
+      jest
+        .spyOn<any, any>(authManager, 'fetchUserName')
+        .mockImplementationOnce(() =>
+          Promise.resolve({
+            isLoggedIn: false,
+            userName: ''
+          })
+        )
+        .mockImplementationOnce(() =>
+          Promise.resolve({
+            isLoggedIn: true,
+            userName
+          })
+        )
+      jest
+        .spyOn(verifySasViyaLoginModule, 'verifySasViyaLogin')
+        .mockImplementation(() => Promise.resolve({ isLoggedIn: false }))
+
+      const loginResponse = await authManager.redirectedLogIn({})
+
+      expect(loginResponse.isLoggedIn).toBeFalsy()
+      expect(loginResponse.userName).toEqual('')
+
+      expect(openWebPageModule.openWebPage).toHaveBeenCalledWith(
+        `/SASLogon/home`,
+        'SASLogon',
+        {
+          width: 500,
+          height: 600
+        },
+        undefined
+      )
+      expect(authManager['fetchUserName']).toHaveBeenCalledTimes(1)
+
+      expect(authCallback).toHaveBeenCalledTimes(0)
+    })
+
+    it('should return empty username if user rejects to re-login', async () => {
+      const authManager = new AuthManager(
+        serverUrl,
+        serverType,
+        requestClient,
+        authCallback
+      )
+      jest
+        .spyOn<any, any>(authManager, 'fetchUserName')
+        .mockImplementationOnce(() =>
+          Promise.resolve({
+            isLoggedIn: false,
+            userName: ''
+          })
+        )
+        .mockImplementationOnce(() =>
+          Promise.resolve({
+            isLoggedIn: true,
+            userName
+          })
+        )
+      jest
+        .spyOn(openWebPageModule, 'openWebPage')
+        .mockImplementation(() => Promise.resolve(null))
+
+      const loginResponse = await authManager.redirectedLogIn({})
+
+      expect(loginResponse.isLoggedIn).toBeFalsy()
+      expect(loginResponse.userName).toEqual('')
+
+      expect(openWebPageModule.openWebPage).toHaveBeenCalledWith(
+        `/SASLogon/home`,
+        'SASLogon',
+        {
+          width: 500,
+          height: 600
+        },
+        undefined
+      )
+      expect(authManager['fetchUserName']).toHaveBeenCalledTimes(1)
+
+      expect(authCallback).toHaveBeenCalledTimes(0)
+    })
   })
 
-  it('should check and return session information if logged in', async (done) => {
-    const authManager = new AuthManager(
-      serverUrl,
-      serverType,
-      requestClient,
-      authCallback
-    )
-    mockedAxios.get.mockImplementation(() =>
-      Promise.resolve({ data: '<button onClick="logout">' })
-    )
+  describe('checkSession', () => {
+    it('return session information when logged in', async () => {
+      const authManager = new AuthManager(
+        serverUrl,
+        serverType,
+        requestClient,
+        authCallback
+      )
+      mockedAxios.get.mockImplementation(() =>
+        Promise.resolve({ data: mockedCurrentUserApi(userName) })
+      )
 
-    const response = await authManager.checkSession()
-    expect(response.isLoggedIn).toBeTruthy()
-    expect(mockedAxios.get).toHaveBeenNthCalledWith(
-      1,
-      `http://test-server.com/identities`,
-      {
-        withCredentials: true,
-        responseType: 'text',
-        transformResponse: undefined,
-        headers: {
-          Accept: '*/*',
-          'Content-Type': 'text/plain'
+      const response = await authManager.checkSession()
+      expect(response.isLoggedIn).toBeTruthy()
+      expect(response.userName).toEqual(userName)
+      expect(mockedAxios.get).toHaveBeenNthCalledWith(
+        1,
+        `http://test-server.com/identities/users/@currentUser`,
+        {
+          withCredentials: true,
+          responseType: 'text',
+          transformResponse: undefined,
+          headers: {
+            Accept: '*/*',
+            'Content-Type': 'text/plain'
+          }
         }
-      }
-    )
+      )
+    })
 
-    done()
+    it('return session information when logged in - SAS9', async () => {
+      // username cannot have `-` and cannot be uppercased
+      const username = 'testusername'
+      const serverType = ServerType.Sas9
+      const authManager = new AuthManager(
+        serverUrl,
+        serverType,
+        requestClient,
+        authCallback
+      )
+      mockedAxios.get.mockImplementation(() =>
+        Promise.resolve({
+          data: `"title":"Log Off ${username}","url":"javascript: clearFrame(\"/SASStoredProcess/do?_action=logoff\")"' })`
+        })
+      )
+
+      const response = await authManager.checkSession()
+      expect(response.isLoggedIn).toBeTruthy()
+      expect(response.userName).toEqual(username)
+      expect(mockedAxios.get).toHaveBeenNthCalledWith(
+        1,
+        `http://test-server.com/SASStoredProcess`,
+        {
+          withCredentials: true,
+          responseType: 'text',
+          transformResponse: undefined,
+          headers: {
+            Accept: '*/*',
+            'Content-Type': 'text/plain'
+          }
+        }
+      )
+    })
+
+    it('return session information when logged in - SAS9 - having full name in html', async () => {
+      const fullname = 'FirstName LastName'
+      const username = 'firlas'
+      const serverType = ServerType.Sas9
+      const authManager = new AuthManager(
+        serverUrl,
+        serverType,
+        requestClient,
+        authCallback
+      )
+      mockedAxios.get.mockImplementation(() =>
+        Promise.resolve({
+          data: `"title":"Log Off ${fullname}","url":"javascript: clearFrame(\"/SASStoredProcess/do?_action=logoff\")"' })`
+        })
+      )
+
+      const response = await authManager.checkSession()
+      expect(response.isLoggedIn).toBeTruthy()
+      expect(response.userName).toEqual(username)
+      expect(mockedAxios.get).toHaveBeenNthCalledWith(
+        1,
+        `http://test-server.com/SASStoredProcess`,
+        {
+          withCredentials: true,
+          responseType: 'text',
+          transformResponse: undefined,
+          headers: {
+            Accept: '*/*',
+            'Content-Type': 'text/plain'
+          }
+        }
+      )
+    })
+
+    it('perform logout when not logged in', async () => {
+      const authManager = new AuthManager(
+        serverUrl,
+        serverType,
+        requestClient,
+        authCallback
+      )
+      mockedAxios.get
+        .mockImplementationOnce(() => Promise.resolve({ status: 401 }))
+        .mockImplementation(() => Promise.resolve({}))
+
+      const response = await authManager.checkSession()
+      expect(response.isLoggedIn).toBeFalsy()
+      expect(response.userName).toEqual('')
+      expect(mockedAxios.get).toHaveBeenNthCalledWith(
+        1,
+        `http://test-server.com/identities/users/@currentUser`,
+        {
+          withCredentials: true,
+          responseType: 'text',
+          transformResponse: undefined,
+          headers: {
+            Accept: '*/*',
+            'Content-Type': 'text/plain'
+          }
+        }
+      )
+      expect(mockedAxios.get).toHaveBeenNthCalledWith(
+        2,
+        `/SASLogon/logout.do?`,
+        getHeadersJson
+      )
+    })
   })
 })
+
+const getHeadersJson = {
+  withCredentials: true,
+  headers: {
+    'Content-Type': 'application/json',
+    Accept: 'application/json'
+  },
+  responseType: 'json'
+}

src/auth/spec/getAccessToken.spec.ts

@@ -0,0 +1,75 @@
+import { AuthConfig } from '@sasjs/utils'
+import * as NodeFormData from 'form-data'
+import { generateToken, mockAuthResponse } from './mockResponses'
+import { RequestClient } from '../../request/RequestClient'
+import { getAccessToken } from '../getAccessToken'
+
+const requestClient = new (<jest.Mock<RequestClient>>RequestClient)()
+
+describe('getAccessToken', () => {
+  it('should attempt to refresh tokens', async () => {
+    setupMocks()
+    const access_token = generateToken(30)
+    const refresh_token = generateToken(30)
+    const authConfig: AuthConfig = {
+      access_token,
+      refresh_token,
+      client: 'cl13nt',
+      secret: 's3cr3t'
+    }
+    jest
+      .spyOn(requestClient, 'post')
+      .mockImplementation(() =>
+        Promise.resolve({ result: mockAuthResponse, etag: '' })
+      )
+    const token = Buffer.from(
+      authConfig.client + ':' + authConfig.secret
+    ).toString('base64')
+
+    await getAccessToken(
+      requestClient,
+      authConfig.client,
+      authConfig.secret,
+      authConfig.refresh_token
+    )
+
+    expect(requestClient.post).toHaveBeenCalledWith(
+      '/SASLogon/oauth/token',
+      expect.any(NodeFormData),
+      undefined,
+      expect.stringContaining('multipart/form-data; boundary='),
+      {
+        Authorization: 'Basic ' + token
+      }
+    )
+  })
+
+  it('should handle errors while refreshing tokens', async () => {
+    setupMocks()
+    const access_token = generateToken(30)
+    const refresh_token = generateToken(30)
+    const authConfig: AuthConfig = {
+      access_token,
+      refresh_token,
+      client: 'cl13nt',
+      secret: 's3cr3t'
+    }
+    jest
+      .spyOn(requestClient, 'post')
+      .mockImplementation(() => Promise.reject('Token Error'))
+
+    const error = await getAccessToken(
+      requestClient,
+      authConfig.client,
+      authConfig.secret,
+      authConfig.refresh_token
+    ).catch((e) => e)
+
+    expect(error).toContain('Error while getting access token')
+  })
+})
+
+const setupMocks = () => {
+  jest.restoreAllMocks()
+  jest.mock('../../request/RequestClient')
+}

src/auth/spec/getTokens.spec.ts

@@ -0,0 +1,79 @@
+import { AuthConfig } from '@sasjs/utils'
+import * as refreshTokensModule from '../refreshTokens'
+import { generateToken, mockAuthResponse } from './mockResponses'
+import { getTokens } from '../getTokens'
+import { RequestClient } from '../../request/RequestClient'
+
+const requestClient = new (<jest.Mock<RequestClient>>RequestClient)()
+
+describe('getTokens', () => {
+  it('should attempt to refresh tokens if the access token is expiring', async () => {
+    setupMocks()
+    const access_token = generateToken(30)
+    const refresh_token = generateToken(86400000)
+    const authConfig: AuthConfig = {
+      access_token,
+      refresh_token,
+      client: 'cl13nt',
+      secret: 's3cr3t'
+    }
+
+    await getTokens(requestClient, authConfig)
+
+    expect(refreshTokensModule.refreshTokens).toHaveBeenCalledWith(
+      requestClient,
+      authConfig.client,
+      authConfig.secret,
+      authConfig.refresh_token
+    )
+  })
+
+  it('should attempt to refresh tokens if the refresh token is expiring', async () => {
+    setupMocks()
+    const access_token = generateToken(86400000)
+    const refresh_token = generateToken(30)
+    const authConfig: AuthConfig = {
+      access_token,
+      refresh_token,
+      client: 'cl13nt',
+      secret: 's3cr3t'
+    }
+
+    await getTokens(requestClient, authConfig)
+
+    expect(refreshTokensModule.refreshTokens).toHaveBeenCalledWith(
+      requestClient,
+      authConfig.client,
+      authConfig.secret,
+      authConfig.refresh_token
+    )
+  })
+
+  it('should throw an error if the refresh token has already expired', async () => {
+    setupMocks()
+    const access_token = generateToken(86400000)
+    const refresh_token = generateToken(-36000)
+    const authConfig: AuthConfig = {
+      access_token,
+      refresh_token,
+      client: 'cl13nt',
+      secret: 's3cr3t'
+    }
+    const expectedError =
+      'Unable to obtain new access token. Your refresh token has expired.'
+
+    const error = await getTokens(requestClient, authConfig).catch((e) => e)
+
+    expect(error.message).toEqual(expectedError)
+  })
+})
+
+const setupMocks = () => {
+  jest.restoreAllMocks()
+  jest.mock('../../request/RequestClient')
+  jest.mock('../refreshTokens')
+
+  jest
+    .spyOn(refreshTokensModule, 'refreshTokens')
+    .mockImplementation(() => Promise.resolve(mockAuthResponse))
+}

src/auth/spec/mockResponses.ts

@@ -1,2 +1,49 @@
+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',
+  refresh_token: 'r3fr35h',
+  id_token: 'id',
+  token_type: 'bearer',
+  expires_in: new Date().valueOf(),
+  scope: 'default',
+  jti: 'test'
+}
+
+export const generateToken = (timeToLiveSeconds: number): string => {
+  const exp =
+    new Date(new Date().getTime() + timeToLiveSeconds * 1000).getTime() / 1000
+  const header = 'eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9'
+  const payload = Buffer.from(JSON.stringify({ exp })).toString('base64')
+  const signature = '4-iaDojEVl0pJQMjrbM1EzUIfAZgsbK_kgnVyVxFSVo'
+  const token = `${header}.${payload}.${signature}`
+  return token
+}
+
+export const mockedCurrentUserApi = (username: string) => ({
+  creationTimeStamp: '2021-04-17T14:13:14.000Z',
+  modifiedTimeStamp: '2021-08-31T22:08:07.000Z',
+  id: username,
+  type: 'user',
+  name: 'Full User Name',
+  links: [
+    {
+      method: 'GET',
+      rel: 'self',
+      href: `/identities/users/${username}`,
+      uri: `/identities/users/${username}`,
+      type: 'user'
+    },
+    {
+      method: 'GET',
+      rel: 'alternate',
+      href: `/identities/users/${username}`,
+      uri: `/identities/users/${username}`,
+      type: 'application/vnd.sas.summary'
+    }
+  ],
+  version: 2
+})

src/auth/spec/openWebPage.spec.ts

@@ -0,0 +1,64 @@
+/**
+ * @jest-environment jsdom
+ */
+import { openWebPage } from '../openWebPage'
+import * as loginPromptModule from '../../utils/loginPrompt'
+
+describe('openWebPage', () => {
+  const serverUrl = 'http://test-server.com'
+
+  describe('window.open is not blocked', () => {
+    const mockedOpen = jest
+      .fn()
+      .mockImplementation(() => ({} as unknown as Window))
+    const originalOpen = window.open
+
+    beforeAll(() => {
+      window.open = mockedOpen
+    })
+    afterAll(() => {
+      window.open = originalOpen
+    })
+
+    it(`should return new Window popup - using default adapter's dialog`, async () => {
+      await expect(openWebPage(serverUrl)).resolves.toBeDefined()
+
+      expect(mockedOpen).toBeCalled()
+    })
+  })
+
+  describe('window.open is blocked', () => {
+    const mockedOpen = jest.fn().mockImplementation(() => null)
+    const originalOpen = window.open
+
+    beforeAll(() => {
+      window.open = mockedOpen
+    })
+    afterAll(() => {
+      window.open = originalOpen
+    })
+
+    it(`should return new Window popup - using default adapter's dialog`, async () => {
+      jest.mock('../../utils/loginPrompt')
+      jest
+        .spyOn(loginPromptModule, 'openLoginPrompt')
+        .mockImplementation(() => Promise.resolve(true))
+
+      await expect(openWebPage(serverUrl)).resolves.toBeDefined()
+      expect(loginPromptModule.openLoginPrompt).toBeCalled()
+      expect(mockedOpen).toBeCalled()
+    })
+
+    it(`should return new Window popup - using frontend's provided onloggedOut`, async () => {
+      const onLoggedOut = jest
+        .fn()
+        .mockImplementation(() => Promise.resolve(true))
+
+      await expect(
+        openWebPage(serverUrl, undefined, undefined, onLoggedOut)
+      ).resolves.toBeDefined()
+      expect(onLoggedOut).toBeCalled()
+      expect(mockedOpen).toBeCalled()
+    })
+  })
+})

src/auth/spec/refreshTokens.spec.ts

@@ -0,0 +1,75 @@
+import { AuthConfig } from '@sasjs/utils'
+import * as NodeFormData from 'form-data'
+import { generateToken, mockAuthResponse } from './mockResponses'
+import { RequestClient } from '../../request/RequestClient'
+import { refreshTokens } from '../refreshTokens'
+
+const requestClient = new (<jest.Mock<RequestClient>>RequestClient)()
+
+describe('refreshTokens', () => {
+  it('should attempt to refresh tokens', async () => {
+    setupMocks()
+    const access_token = generateToken(30)
+    const refresh_token = generateToken(30)
+    const authConfig: AuthConfig = {
+      access_token,
+      refresh_token,
+      client: 'cl13nt',
+      secret: 's3cr3t'
+    }
+    jest
+      .spyOn(requestClient, 'post')
+      .mockImplementation(() =>
+        Promise.resolve({ result: mockAuthResponse, etag: '' })
+      )
+    const token = Buffer.from(
+      authConfig.client + ':' + authConfig.secret
+    ).toString('base64')
+
+    await refreshTokens(
+      requestClient,
+      authConfig.client,
+      authConfig.secret,
+      authConfig.refresh_token
+    )
+
+    expect(requestClient.post).toHaveBeenCalledWith(
+      '/SASLogon/oauth/token',
+      expect.any(NodeFormData),
+      undefined,
+      expect.stringContaining('multipart/form-data; boundary='),
+      {
+        Authorization: 'Basic ' + token
+      }
+    )
+  })
+
+  it('should handle errors while refreshing tokens', async () => {
+    setupMocks()
+    const access_token = generateToken(30)
+    const refresh_token = generateToken(30)
+    const authConfig: AuthConfig = {
+      access_token,
+      refresh_token,
+      client: 'cl13nt',
+      secret: 's3cr3t'
+    }
+    jest
+      .spyOn(requestClient, 'post')
+      .mockImplementation(() => Promise.reject('Token Error'))
+
+    const error = await refreshTokens(
+      requestClient,
+      authConfig.client,
+      authConfig.secret,
+      authConfig.refresh_token
+    ).catch((e) => e)
+
+    expect(error).toContain('Error while refreshing tokens')
+  })
+})
+
+const setupMocks = () => {
+  jest.restoreAllMocks()
+  jest.mock('../../request/RequestClient')
+}

src/auth/spec/verifySas9Login.spec.ts

@@ -0,0 +1,37 @@
+/**
+ * @jest-environment jsdom
+ */
+import { verifySas9Login } from '../verifySas9Login'
+import * as delayModule from '../../utils/delay'
+
+describe('verifySas9Login', () => {
+  const serverUrl = 'http://test-server.com'
+
+  beforeAll(() => {
+    jest.mock('../../utils')
+    jest
+      .spyOn(delayModule, 'delay')
+      .mockImplementation(() => Promise.resolve({}))
+  })
+
+  it('should return isLoggedIn true by checking state of popup', async () => {
+    const popup = {
+      window: {
+        location: { href: serverUrl + `/SASLogon/home` },
+        document: { body: { innerText: '<h3>You have signed in.</h3>' } }
+      }
+    } as unknown as Window
+
+    await expect(verifySas9Login(popup)).resolves.toEqual({
+      isLoggedIn: true
+    })
+  })
+
+  it('should return isLoggedIn false if user closed popup, already', async () => {
+    const popup: Window = { closed: true } as unknown as Window
+
+    await expect(verifySas9Login(popup)).resolves.toEqual({
+      isLoggedIn: false
+    })
+  })
+})

src/auth/spec/verifySasViyaLogin.spec.ts

@@ -0,0 +1,38 @@
+/**
+ * @jest-environment jsdom
+ */
+import { verifySasViyaLogin } from '../verifySasViyaLogin'
+import * as delayModule from '../../utils/delay'
+
+describe('verifySasViyaLogin', () => {
+  const serverUrl = 'http://test-server.com'
+
+  beforeAll(() => {
+    jest.mock('../../utils')
+    jest
+      .spyOn(delayModule, 'delay')
+      .mockImplementation(() => Promise.resolve({}))
+    document.cookie = encodeURIComponent('Current-User={"userId":"user-hash"}')
+  })
+
+  it('should return isLoggedIn true by checking state of popup', async () => {
+    const popup = {
+      window: {
+        location: { href: serverUrl + `/SASLogon/home` },
+        document: { body: { innerText: '<h3>You have signed in.</h3>' } }
+      }
+    } as unknown as Window
+
+    await expect(verifySasViyaLogin(popup)).resolves.toEqual({
+      isLoggedIn: true
+    })
+  })
+
+  it('should return isLoggedIn false if user closed popup, already', async () => {
+    const popup: Window = { closed: true } as unknown as Window
+
+    await expect(verifySasViyaLogin(popup)).resolves.toEqual({
+      isLoggedIn: false
+    })
+  })
+})

src/auth/verifySas9Login.ts

@@ -0,0 +1,20 @@
+import { delay } from '../utils'
+
+export async function verifySas9Login(loginPopup: Window): Promise<{
+  isLoggedIn: boolean
+}> {
+  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.')
+    elapsedSeconds = (new Date().valueOf() - startTime.valueOf()) / 1000
+  } while (!isLoggedIn && elapsedSeconds < 5 * 60)
+
+  return { isLoggedIn }
+}

src/auth/verifySasViyaLogin.ts

@@ -0,0 +1,33 @@
+import { delay } from '../utils'
+
+export async function verifySasViyaLogin(loginPopup: Window): Promise<{
+  isLoggedIn: boolean
+}> {
+  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.'
+      )
+    elapsedSeconds = (new Date().valueOf() - startTime.valueOf()) / 1000
+  } while (!isAuthorized && elapsedSeconds < 5 * 60)
+
+  return { isLoggedIn: isLoggedIn && isAuthorized }
+}
+
+export const isLoggedInSASVIYA = () =>
+  document.cookie.includes('Current-User') && document.cookie.includes('userId')

src/job-execution/ComputeJobExecutor.ts

@@ -1,4 +1,4 @@
-import { ServerType } from '@sasjs/utils/types'
+import { AuthConfig, ServerType } from '@sasjs/utils/types'
 import { SASViyaApiClient } from '../SASViyaApiClient'
 import {
   ErrorResponse,
@@ -17,7 +17,7 @@ export class ComputeJobExecutor extends BaseJobExecutor {
     data: any,
     config: any,
     loginRequiredCallback?: any,
-    accessToken?: string
+    authConfig?: AuthConfig
   ) {
     const loginCallback = loginRequiredCallback || (() => Promise.resolve())
     const waitForResult = true
@@ -30,19 +30,17 @@ export class ComputeJobExecutor extends BaseJobExecutor {
           config.contextName,
           config.debug,
           data,
-          accessToken,
+          authConfig,
           waitForResult,
           expectWebout
         )
         .then((response) => {
-          this.appendRequest(response, sasJob, config.debug)
-
+          this.sasViyaApiClient.appendRequest(response, sasJob, config.debug)
           resolve(response.result)
         })
         .catch(async (e: Error) => {
           if (e instanceof ComputeJobExecutionError) {
-            this.appendRequest(e, sasJob, config.debug)
-
+            this.sasViyaApiClient.appendRequest(e, sasJob, config.debug)
             reject(new ErrorResponse(e?.message, e))
           }
 

src/job-execution/FileUploader.ts

@@ -0,0 +1,143 @@
+import {
+  getValidJson,
+  parseSasViyaDebugResponse,
+  parseWeboutResponse
+} from '../utils'
+import { UploadFile } from '../types/UploadFile'
+import {
+  ErrorResponse,
+  JobExecutionError,
+  LoginRequiredError
+} from '../types/errors'
+import { RequestClient } from '../request/RequestClient'
+import { ServerType } from '@sasjs/utils/types'
+import { BaseJobExecutor } from './JobExecutor'
+
+interface dataFileUpload {
+  files: UploadFile[]
+  params: { [key: string]: any } | null
+}
+
+export class FileUploader extends BaseJobExecutor {
+  constructor(
+    serverUrl: string,
+    serverType: ServerType,
+    private jobsPath: string,
+    private requestClient: RequestClient
+  ) {
+    super(serverUrl, serverType)
+  }
+
+  public async execute(
+    sasJob: string,
+    data: any,
+    config: any,
+    loginRequiredCallback?: any
+  ) {
+    const { files, params }: dataFileUpload = data
+    const loginCallback = loginRequiredCallback || (() => Promise.resolve())
+
+    if (!files?.length)
+      throw new ErrorResponse('At least one file must be provided.')
+
+    if (!sasJob || sasJob === '')
+      throw new ErrorResponse('sasJob must be provided.')
+
+    let paramsString = ''
+
+    for (let param in params)
+      if (params.hasOwnProperty(param))
+        paramsString += `&${param}=${params[param]}`
+
+    const program = config.appLoc
+      ? config.appLoc.replace(/\/?$/, '/') + sasJob.replace(/^\//, '')
+      : sasJob
+    const uploadUrl = `${this.jobsPath}/?${
+      '_program=' + program
+    }${paramsString}`
+
+    const formData = new FormData()
+
+    for (let file of files) {
+      formData.append('file', file.file, file.fileName)
+    }
+
+    const csrfToken = this.requestClient.getCsrfToken('file')
+    if (csrfToken) formData.append('_csrf', csrfToken.value)
+    if (config.debug) formData.append('_debug', '131')
+    if (config.serverType === ServerType.SasViya && config.contextName)
+      formData.append('_contextname', config.contextName)
+
+    const headers = {
+      'cache-control': 'no-cache',
+      Accept: '*/*',
+      'Content-Type': 'text/plain'
+    }
+
+    // currently only web approach is supported for file upload
+    // therefore log is part of response with debug enabled and must be parsed
+    const requestPromise = new Promise((resolve, reject) => {
+      this.requestClient
+        .post(uploadUrl, formData, undefined, 'application/json', headers)
+        .then(async (res: any) => {
+          this.requestClient.appendRequest(res, sasJob, config.debug)
+
+          let jsonResponse = res.result
+
+          if (config.debug) {
+            switch (this.serverType) {
+              case ServerType.SasViya:
+                jsonResponse = await parseSasViyaDebugResponse(
+                  res.result,
+                  this.requestClient,
+                  config.serverUrl
+                )
+                break
+              case ServerType.Sas9:
+                jsonResponse =
+                  typeof res.result === 'string'
+                    ? parseWeboutResponse(res.result, uploadUrl)
+                    : res.result
+                break
+            }
+          } else {
+            jsonResponse =
+              typeof res.result === 'string'
+                ? getValidJson(res.result)
+                : res.result
+          }
+
+          resolve(jsonResponse)
+        })
+        .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) {
+            this.appendWaitingRequest(() => {
+              return this.execute(
+                sasJob,
+                data,
+                config,
+                loginRequiredCallback
+              ).then(
+                (res: any) => {
+                  resolve(res)
+                },
+                (err: any) => {
+                  reject(err)
+                }
+              )
+            })
+
+            await loginCallback()
+          } else {
+            reject(new ErrorResponse('File upload request failed.', e))
+          }
+        })
+    })
+    return requestPromise
+  }
+}

src/job-execution/JesJobExecutor.ts

@@ -1,11 +1,13 @@
-import { ServerType } from '@sasjs/utils/types'
+import { AuthConfig, ServerType } from '@sasjs/utils/types'
 import { SASViyaApiClient } from '../SASViyaApiClient'
 import {
   ErrorResponse,
   JobExecutionError,
   LoginRequiredError
 } from '../types/errors'
+import { ExtraResponseAttributes } from '@sasjs/utils/types'
 import { BaseJobExecutor } from './JobExecutor'
+import { appendExtraResponseAttributes } from '../utils'
 
 export class JesJobExecutor extends BaseJobExecutor {
   constructor(serverUrl: string, private sasViyaApiClient: SASViyaApiClient) {
@@ -17,27 +19,27 @@ export class JesJobExecutor extends BaseJobExecutor {
     data: any,
     config: any,
     loginRequiredCallback?: any,
-    accessToken?: string
+    authConfig?: AuthConfig,
+    extraResponseAttributes: ExtraResponseAttributes[] = []
   ) {
     const loginCallback = loginRequiredCallback || (() => Promise.resolve())
 
     const requestPromise = new Promise((resolve, reject) => {
       this.sasViyaApiClient
-        ?.executeJob(
-          sasJob,
-          config.contextName,
-          config.debug,
-          data,
-          accessToken
-        )
-        .then((response) => {
-          this.appendRequest(response, sasJob, config.debug)
+        ?.executeJob(sasJob, config.contextName, config.debug, data, authConfig)
+        .then((response: any) => {
+          this.sasViyaApiClient.appendRequest(response, sasJob, config.debug)
 
-          resolve(response.result)
+          const responseObject = appendExtraResponseAttributes(
+            response,
+            extraResponseAttributes
+          )
+
+          resolve(responseObject)
         })
         .catch(async (e: Error) => {
           if (e instanceof JobExecutionError) {
-            this.appendRequest(e, sasJob, config.debug)
+            this.sasViyaApiClient.appendRequest(e, sasJob, config.debug)
 
             reject(new ErrorResponse(e?.message, e))
           }
@@ -50,7 +52,9 @@ export class JesJobExecutor extends BaseJobExecutor {
                 sasJob,
                 data,
                 config,
-                loginRequiredCallback
+                loginRequiredCallback,
+                authConfig,
+                extraResponseAttributes
               ).then(
                 (res: any) => {
                   resolve(res)

src/job-execution/JobExecutor.ts

@@ -1,6 +1,6 @@
-import { ServerType } from '@sasjs/utils/types'
-import { SASjsRequest } from '../types'
-import { asyncForEach, parseGeneratedCode, parseSourceCode } from '../utils'
+import { AuthConfig, ServerType } from '@sasjs/utils/types'
+import { ExtraResponseAttributes } from '@sasjs/utils/types'
+import { asyncForEach } from '../utils'
 
 export type ExecuteFunction = () => Promise<any>
 
@@ -10,25 +10,24 @@ export interface JobExecutor {
     data: any,
     config: any,
     loginRequiredCallback?: any,
-    accessToken?: string
+    authConfig?: AuthConfig,
+    extraResponseAttributes?: ExtraResponseAttributes[]
   ) => Promise<any>
   resendWaitingRequests: () => Promise<void>
-  getRequests: () => SASjsRequest[]
-  clearRequests: () => void
 }
 
 export abstract class BaseJobExecutor implements JobExecutor {
   constructor(protected serverUrl: string, protected serverType: ServerType) {}
 
   private waitingRequests: ExecuteFunction[] = []
-  private requests: SASjsRequest[] = []
 
   abstract execute(
     sasJob: string,
     data: any,
     config: any,
     loginRequiredCallback?: any,
-    accessToken?: string | undefined
+    authConfig?: AuthConfig | undefined,
+    extraResponseAttributes?: ExtraResponseAttributes[]
   ): Promise<any>
 
   resendWaitingRequests = async () => {
@@ -43,54 +42,7 @@ export abstract class BaseJobExecutor implements JobExecutor {
     return
   }
 
-  getRequests = () => this.requests
-
-  clearRequests = () => {
-    this.requests = []
-  }
-
   protected appendWaitingRequest(request: ExecuteFunction) {
     this.waitingRequests.push(request)
   }
-
-  protected appendRequest(response: any, program: string, debug: boolean) {
-    let sourceCode = ''
-    let generatedCode = ''
-    let sasWork = null
-
-    if (debug) {
-      if (response?.result && response?.log) {
-        sourceCode = parseSourceCode(response.log)
-        generatedCode = parseGeneratedCode(response.log)
-
-        if (response.log) {
-          sasWork = response.log
-        } else {
-          sasWork = response.result.WORK
-        }
-      } else if (response?.result) {
-        sourceCode = parseSourceCode(response.result)
-        generatedCode = parseGeneratedCode(response.result)
-        sasWork = response.result.WORK
-      }
-    }
-
-    const stringifiedResult =
-      typeof response?.result === 'string'
-        ? response?.result
-        : JSON.stringify(response?.result, null, 2)
-
-    this.requests.push({
-      logFile: response?.log || stringifiedResult || response,
-      serviceLink: program,
-      timestamp: new Date(),
-      sourceCode,
-      generatedCode,
-      SASWORK: sasWork
-    })
-
-    if (this.requests.length > 20) {
-      this.requests.splice(0, 1)
-    }
-  }
 }

src/job-execution/Sas9JobExecutor.ts

@@ -0,0 +1,111 @@
+import { ServerType } from '@sasjs/utils/types'
+import * as NodeFormData from 'form-data'
+import { ErrorResponse } from '../types/errors'
+import { convertToCSV, isRelativePath } from '../utils'
+import { BaseJobExecutor } from './JobExecutor'
+import { Sas9RequestClient } from '../request/Sas9RequestClient'
+
+/**
+ * Job executor for SAS9 servers for use in Node.js environments.
+ * Initiates login with the provided username and password from the config
+ * The cookies are stored in the request client and used in subsequent
+ * job execution requests.
+ */
+export class Sas9JobExecutor extends BaseJobExecutor {
+  private requestClient: Sas9RequestClient
+  constructor(
+    serverUrl: string,
+    serverType: ServerType,
+    private jobsPath: string,
+    allowInsecureRequests: boolean
+  ) {
+    super(serverUrl, serverType)
+    this.requestClient = new Sas9RequestClient(serverUrl, allowInsecureRequests)
+  }
+
+  async execute(sasJob: string, data: any, config: any) {
+    const program = isRelativePath(sasJob)
+      ? config.appLoc
+        ? config.appLoc.replace(/\/?$/, '/') + sasJob.replace(/^\//, '')
+        : sasJob
+      : sasJob
+    let apiUrl = `${config.serverUrl}${this.jobsPath}?${'_program=' + program}`
+    apiUrl = `${apiUrl}${
+      config.username && config.password
+        ? '&_username=' + config.username + '&_password=' + config.password
+        : ''
+    }`
+
+    let requestParams = {
+      ...this.getRequestParams(config)
+    }
+
+    let formData = new NodeFormData()
+
+    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])
+      }
+    }
+
+    await this.requestClient.login(
+      config.username,
+      config.password,
+      this.jobsPath
+    )
+    const contentType =
+      data && Object.keys(data).length
+        ? 'multipart/form-data; boundary=' + (formData as any)._boundary
+        : 'text/plain'
+    return await this.requestClient!.post(
+      apiUrl,
+      formData,
+      undefined,
+      contentType,
+      {
+        Accept: '*/*',
+        Connection: 'Keep-Alive'
+      }
+    )
+  }
+
+  private getRequestParams(config: any): any {
+    const requestParams: any = {}
+
+    if (config.debug) {
+      requestParams['_debug'] = 131
+    }
+
+    return requestParams
+  }
+}
+
+const generateFileUploadForm = (
+  formData: NodeFormData,
+  data: any
+): NodeFormData => {
+  for (const tableName in data) {
+    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.'
+      )
+    }
+
+    formData.append(name, csv, {
+      filename: `${name}.csv`,
+      contentType: 'application/csv'
+    })
+  }
+
+  return formData
+}

src/job-execution/WebJobExecutor.ts

@@ -1,4 +1,8 @@
-import { ServerType } from '@sasjs/utils/types'
+import {
+  AuthConfig,
+  ExtraResponseAttributes,
+  ServerType
+} from '@sasjs/utils/types'
 import {
   ErrorResponse,
   JobExecutionError,
@@ -8,8 +12,13 @@ import { generateFileUploadForm } from '../file/generateFileUploadForm'
 import { generateTableUploadForm } from '../file/generateTableUploadForm'
 import { RequestClient } from '../request/RequestClient'
 import { SASViyaApiClient } from '../SASViyaApiClient'
-import { isRelativePath } from '../utils'
+import {
+  isRelativePath,
+  parseSasViyaDebugResponse,
+  appendExtraResponseAttributes
+} from '../utils'
 import { BaseJobExecutor } from './JobExecutor'
+import { parseWeboutResponse } from '../utils/parseWeboutResponse'
 
 export interface WaitingRequstPromise {
   promise: Promise<any> | null
@@ -31,7 +40,9 @@ export class WebJobExecutor extends BaseJobExecutor {
     sasJob: string,
     data: any,
     config: any,
-    loginRequiredCallback?: any
+    loginRequiredCallback?: any,
+    authConfig?: AuthConfig,
+    extraResponseAttributes: ExtraResponseAttributes[] = []
   ) {
     const loginCallback = loginRequiredCallback || (() => Promise.resolve())
     const program = isRelativePath(sasJob)
@@ -39,15 +50,29 @@ export class WebJobExecutor extends BaseJobExecutor {
         ? config.appLoc.replace(/\/?$/, '/') + sasJob.replace(/^\//, '')
         : sasJob
       : sasJob
-    const jobUri =
-      config.serverType === ServerType.SasViya
-        ? await this.getJobUri(sasJob)
-        : ''
-    const apiUrl = `${config.serverUrl}${this.jobsPath}/?${
-      jobUri.length > 0
-        ? '__program=' + program + '&_job=' + jobUri
-        : '_program=' + program
-    }`
+    let apiUrl = `${config.serverUrl}${this.jobsPath}/?${'_program=' + program}`
+
+    if (config.serverType === ServerType.SasViya) {
+      const jobUri = await this.getJobUri(sasJob)
+
+      apiUrl += jobUri.length > 0 ? '&_job=' + jobUri : ''
+
+      if (jobUri.length > 0) {
+        apiUrl += '&_job=' + jobUri
+        /**
+         * Using both _job and _program parameters will cause a conflict in the JES web app, as it’s not clear whether or not the server should make the extra fetch for the job uri.
+         * To handle this, we add the extra underscore and recreate the _program variable in the SAS side of the SASjs adapter so it remains available for backend developers.
+         */
+        apiUrl = apiUrl.replace('_program=', '__program=')
+      }
+
+      // if context name exists and is not blank string
+      // then add _contextname variable in apiUrl
+      apiUrl +=
+        config.contextName && !/\s/.test(config.contextName)
+          ? `&_contextname=${config.contextName}`
+          : ''
+    }
 
     let requestParams = {
       ...this.getRequestParams(config)
@@ -65,19 +90,17 @@ export class WebJobExecutor extends BaseJobExecutor {
         // file upload approach
         try {
           formData = generateFileUploadForm(formData, data)
-        } catch (e) {
+        } catch (e: any) {
           return Promise.reject(new ErrorResponse(e?.message, e))
         }
       } else {
         // param based approach
         try {
-          const {
-            formData: newFormData,
-            requestParams: params
-          } = generateTableUploadForm(formData, data)
+          const { formData: newFormData, requestParams: params } =
+            generateTableUploadForm(formData, data)
           formData = newFormData
           requestParams = { ...requestParams, ...params }
-        } catch (e) {
+        } catch (e: any) {
           return Promise.reject(new ErrorResponse(e?.message, e))
         }
       }
@@ -91,33 +114,50 @@ export class WebJobExecutor extends BaseJobExecutor {
 
     const requestPromise = new Promise((resolve, reject) => {
       this.requestClient!.post(apiUrl, formData, undefined)
-        .then(async (res) => {
-          if (this.serverType === ServerType.SasViya && config.debug) {
-            const jsonResponse = await this.parseSasViyaDebugResponse(
-              res.result as string
-            )
-            this.appendRequest(res, sasJob, config.debug)
-            resolve(jsonResponse)
+        .then(async (res: any) => {
+          this.requestClient!.appendRequest(res, sasJob, config.debug)
+
+          let jsonResponse = res.result
+
+          if (config.debug) {
+            switch (this.serverType) {
+              case ServerType.SasViya:
+                jsonResponse = await parseSasViyaDebugResponse(
+                  res.result,
+                  this.requestClient,
+                  this.serverUrl
+                )
+                break
+              case ServerType.Sas9:
+                jsonResponse =
+                  typeof res.result === 'string'
+                    ? parseWeboutResponse(res.result, apiUrl)
+                    : res.result
+                break
+            }
           }
-          this.appendRequest(res, sasJob, config.debug)
-          resolve(res.result)
+
+          const responseObject = appendExtraResponseAttributes(
+            { result: jsonResponse },
+            extraResponseAttributes
+          )
+          resolve(responseObject)
         })
         .catch(async (e: Error) => {
           if (e instanceof JobExecutionError) {
-            this.appendRequest(e, sasJob, config.debug)
-
+            this.requestClient!.appendRequest(e, sasJob, config.debug)
             reject(new ErrorResponse(e?.message, e))
           }
 
           if (e instanceof LoginRequiredError) {
-            await loginCallback()
-
             this.appendWaitingRequest(() => {
               return this.execute(
                 sasJob,
                 data,
                 config,
-                loginRequiredCallback
+                loginRequiredCallback,
+                authConfig,
+                extraResponseAttributes
               ).then(
                 (res: any) => {
                   resolve(res)
@@ -127,6 +167,8 @@ export class WebJobExecutor extends BaseJobExecutor {
                 }
               )
             })
+
+            await loginCallback()
           } else {
             reject(new ErrorResponse(e?.message, e))
           }
@@ -136,20 +178,6 @@ export class WebJobExecutor extends BaseJobExecutor {
     return requestPromise
   }
 
-  private parseSasViyaDebugResponse = async (response: string) => {
-    const iframeStart = response.split(
-      '<iframe style="width: 99%; height: 500px" src="'
-    )[1]
-    const jsonUrl = iframeStart ? iframeStart.split('"></iframe>')[0] : null
-    if (!jsonUrl) {
-      throw new Error('Unable to find webout file URL.')
-    }
-
-    return this.requestClient
-      .get(this.serverUrl + jsonUrl, undefined)
-      .then((res) => res.result)
-  }
-
   private async getJobUri(sasJob: string) {
     if (!this.sasViyaApiClient) return ''
     let uri = ''

src/job-execution/index.ts

@@ -1,4 +1,6 @@
 export * from './ComputeJobExecutor'
 export * from './JesJobExecutor'
 export * from './JobExecutor'
+export * from './Sas9JobExecutor'
 export * from './WebJobExecutor'
+export * from './FileUploader'

src/request/RequestClient.ts

@@ -8,8 +8,11 @@ import {
   InternalServerError,
   JobExecutionError
 } from '../types/errors'
+import { SASjsRequest } from '../types'
 import { parseWeboutResponse } from '../utils/parseWeboutResponse'
 import { prefixMessage } from '@sasjs/utils/error'
+import { SAS9AuthError } from '../types/errors/SAS9AuthError'
+import { parseGeneratedCode, parseSourceCode } from '../utils'
 
 export interface HttpClient {
   get<T>(
@@ -41,27 +44,22 @@ export interface HttpClient {
 
   getCsrfToken(type: 'general' | 'file'): CsrfToken | undefined
   clearCsrfTokens(): void
+  getBaseUrl(): string
 }
 
 export class RequestClient implements HttpClient {
-  private csrfToken: CsrfToken = { headerName: '', value: '' }
-  private fileUploadCsrfToken: CsrfToken | undefined
-  private httpClient: AxiosInstance
+  private requests: SASjsRequest[] = []
 
-  constructor(private baseUrl: string, allowInsecure = false) {
-    const https = require('https')
-    if (allowInsecure && https.Agent) {
-      this.httpClient = axios.create({
-        baseURL: baseUrl,
-        httpsAgent: new https.Agent({
-          rejectUnauthorized: !allowInsecure
-        })
-      })
-    } else {
-      this.httpClient = axios.create({
-        baseURL: baseUrl
-      })
-    }
+  protected csrfToken: CsrfToken = { headerName: '', value: '' }
+  protected fileUploadCsrfToken: CsrfToken | undefined
+  protected httpClient!: AxiosInstance
+
+  constructor(protected baseUrl: string, allowInsecure = false) {
+    this.createHttpClient(baseUrl, allowInsecure)
+  }
+
+  public setConfig(baseUrl: string, allowInsecure = false) {
+    this.createHttpClient(baseUrl, allowInsecure)
   }
 
   public getCsrfToken(type: 'general' | 'file' = 'general') {
@@ -73,13 +71,77 @@ export class RequestClient implements HttpClient {
     this.fileUploadCsrfToken = { headerName: '', value: '' }
   }
 
+  public getBaseUrl() {
+    return this.httpClient.defaults.baseURL || ''
+  }
+
+  /**
+   * this method returns all requests, an array of SASjsRequest type
+   * @returns SASjsRequest[]
+   */
+  public getRequests = () => this.requests
+
+  /**
+   * this method clears the requests array, i.e set to empty
+   */
+  public clearRequests = () => {
+    this.requests = []
+  }
+
+  /**
+   * this method appends the response from sasjs request to requests array
+   * @param response - response from sasjs request
+   * @param program - name of program
+   * @param debug - a boolean that indicates whether debug was enabled or not
+   */
+  public appendRequest(response: any, program: string, debug: boolean) {
+    let sourceCode = ''
+    let generatedCode = ''
+    let sasWork = null
+
+    if (debug) {
+      if (response?.log) {
+        sourceCode = parseSourceCode(response.log)
+        generatedCode = parseGeneratedCode(response.log)
+
+        if (response?.result) {
+          sasWork = response.result.WORK
+        } else {
+          sasWork = response.log
+        }
+      } else if (response?.result) {
+        sourceCode = parseSourceCode(response.result)
+        generatedCode = parseGeneratedCode(response.result)
+        sasWork = response.result.WORK
+      }
+    }
+
+    const stringifiedResult =
+      typeof response?.result === 'string'
+        ? response?.result
+        : JSON.stringify(response?.result, null, 2)
+
+    this.requests.push({
+      logFile: response?.log || stringifiedResult || response,
+      serviceLink: program,
+      timestamp: new Date(),
+      sourceCode,
+      generatedCode,
+      SASWORK: sasWork
+    })
+
+    if (this.requests.length > 20) {
+      this.requests.splice(0, 1)
+    }
+  }
+
   public async get<T>(
     url: string,
     accessToken: string | undefined,
     contentType: string = 'application/json',
     overrideHeaders: { [key: string]: string | number } = {},
     debug: boolean = false
-  ): Promise<{ result: T; etag: string }> {
+  ): Promise<{ result: T; etag: string; status: number }> {
     const headers = {
       ...this.getHeaders(accessToken, contentType),
       ...overrideHeaders
@@ -120,7 +182,7 @@ export class RequestClient implements HttpClient {
       })
   }
 
-  public post<T>(
+  public async post<T>(
     url: string,
     data: any,
     accessToken: string | undefined,
@@ -214,9 +276,8 @@ export class RequestClient implements HttpClient {
     const headers = this.getHeaders(accessToken, 'application/json')
 
     if (this.fileUploadCsrfToken?.value) {
-      headers[
-        this.fileUploadCsrfToken.headerName
-      ] = this.fileUploadCsrfToken.value
+      headers[this.fileUploadCsrfToken.headerName] =
+        this.fileUploadCsrfToken.value
     }
 
     try {
@@ -225,7 +286,7 @@ export class RequestClient implements HttpClient {
         result: response.data,
         etag: response.headers['etag'] as string
       }
-    } catch (e) {
+    } catch (e: any) {
       const response = e.response as AxiosResponse
       if (response?.status === 403 || response?.status === 449) {
         this.parseAndSetFileUploadCsrfToken(response)
@@ -287,11 +348,12 @@ export class RequestClient implements HttpClient {
       })
       .then((res) => res.data)
       .catch((error) => {
-        console.log(error)
+        const logger = process.logger || console
+        logger.error(error)
       })
   }
 
-  private getHeaders = (
+  protected getHeaders = (
     accessToken: string | undefined,
     contentType: string
   ) => {
@@ -316,7 +378,7 @@ export class RequestClient implements HttpClient {
     return headers
   }
 
-  private parseAndSetFileUploadCsrfToken = (response: AxiosResponse) => {
+  protected parseAndSetFileUploadCsrfToken = (response: AxiosResponse) => {
     const token = this.parseCsrfToken(response)
 
     if (token) {
@@ -324,7 +386,7 @@ export class RequestClient implements HttpClient {
     }
   }
 
-  private parseAndSetCsrfToken = (response: AxiosResponse) => {
+  protected parseAndSetCsrfToken = (response: AxiosResponse) => {
     const token = this.parseCsrfToken(response)
 
     if (token) {
@@ -333,9 +395,9 @@ export class RequestClient implements HttpClient {
   }
 
   private parseCsrfToken = (response: AxiosResponse): CsrfToken | undefined => {
-    const tokenHeader = (response.headers[
-      'x-csrf-header'
-    ] as string)?.toLowerCase()
+    const tokenHeader = (
+      response.headers['x-csrf-header'] as string
+    )?.toLowerCase()
 
     if (tokenHeader) {
       const token = response.headers[tokenHeader]
@@ -348,7 +410,7 @@ export class RequestClient implements HttpClient {
     }
   }
 
-  private handleError = async (
+  protected handleError = async (
     e: any,
     callback: any,
     debug: boolean = false
@@ -406,7 +468,7 @@ export class RequestClient implements HttpClient {
     throw e
   }
 
-  private parseResponse<T>(response: AxiosResponse<any>) {
+  protected parseResponse<T>(response: AxiosResponse<any>) {
     const etag = response?.headers ? response.headers['etag'] : ''
     let parsedResponse
     let includeSAS9Log: boolean = false
@@ -427,9 +489,15 @@ export class RequestClient implements HttpClient {
       includeSAS9Log = true
     }
 
-    let responseToReturn: { result: T; etag: any; log?: string } = {
+    let responseToReturn: {
+      result: T
+      etag: any
+      log?: string
+      status: number
+    } = {
       result: parsedResponse as T,
-      etag
+      etag,
+      status: response.status
     }
 
     if (includeSAS9Log) {
@@ -438,9 +506,28 @@ export class RequestClient implements HttpClient {
 
     return responseToReturn
   }
+
+  private createHttpClient(baseUrl: string, allowInsecure = false) {
+    const https = require('https')
+    if (allowInsecure && https.Agent) {
+      this.httpClient = axios.create({
+        baseURL: baseUrl,
+        httpsAgent: new https.Agent({
+          rejectUnauthorized: !allowInsecure
+        })
+      })
+    } else {
+      this.httpClient = axios.create({
+        baseURL: baseUrl
+      })
+    }
+
+    this.httpClient.defaults.validateStatus = (status) =>
+      status >= 200 && status < 305
+  }
 }
 
-const throwIfError = (response: AxiosResponse) => {
+export const throwIfError = (response: AxiosResponse) => {
   if (response.status === 401) {
     throw new LoginRequiredError()
   }
@@ -471,6 +558,10 @@ const throwIfError = (response: AxiosResponse) => {
     throw new AuthorizeError(response.data.message, authorizeRequestUrl)
   }
 
+  if (response.config?.url?.includes('sasAuthError')) {
+    throw new SAS9AuthError()
+  }
+
   const error = parseError(response.data as string)
 
   if (error) {
@@ -479,46 +570,60 @@ const throwIfError = (response: AxiosResponse) => {
 }
 
 const parseError = (data: string) => {
+  if (!data) return null
+
   try {
     const responseJson = JSON.parse(data?.replace(/[\n\r]/g, ' '))
-    return responseJson.errorCode && responseJson.message
-      ? new JobExecutionError(
-          responseJson.errorCode,
-          responseJson.message,
-          data?.replace(/[\n\r]/g, ' ')
-        )
-      : null
-  } catch (_) {
-    try {
-      const hasError = data?.includes('{"errorCode')
-      if (hasError) {
-        const parts = data.split('{"errorCode')
-        if (parts.length > 1) {
-          const error = '{"errorCode' + parts[1].split('"}')[0] + '"}'
-          const errorJson = JSON.parse(error.replace(/[\n\r]/g, ' '))
-          return new JobExecutionError(
-            errorJson.errorCode,
-            errorJson.message,
-            data?.replace(/[\n\r]/g, '\n')
-          )
-        }
-        return null
-      }
-      try {
-        const hasError = !!data?.match(/stored process not found: /i)
-        if (hasError) {
-          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}`
-            return new JobExecutionError(404, message, '')
-          }
-        }
-      } catch (_) {
-        return null
-      }
-    } catch (_) {
-      return null
+    if (responseJson.errorCode && responseJson.message) {
+      return new JobExecutionError(
+        responseJson.errorCode,
+        responseJson.message,
+        data?.replace(/[\n\r]/g, ' ')
+      )
     }
-  }
+  } catch (_) {}
+
+  try {
+    const hasError = data?.includes('{"errorCode')
+    if (hasError) {
+      const parts = data.split('{"errorCode')
+      if (parts.length > 1) {
+        const error = '{"errorCode' + parts[1].split('"}')[0] + '"}'
+        const errorJson = JSON.parse(error.replace(/[\n\r]/g, ' '))
+        return new JobExecutionError(
+          errorJson.errorCode,
+          errorJson.message,
+          data?.replace(/[\n\r]/g, '\n')
+        )
+      }
+    }
+  } catch (_) {}
+
+  try {
+    const hasError = !!data?.match(/stored process not found: /i)
+    if (hasError) {
+      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}`
+        return new JobExecutionError(404, message, '')
+      }
+    }
+  } catch (_) {}
+
+  try {
+    const hasError =
+      !!data?.match(/Stored Process Error/i) &&
+      !!data?.match(/This request completed with errors./i)
+    if (hasError) {
+      const parts = data.split('<h2>SAS Log</h2>')
+      if (parts.length > 1) {
+        const log = parts[1].split('<pre>')[1].split('</pre>')[0]
+        const message = `This request completed with errors.`
+        return new JobExecutionError(404, message, log)
+      }
+    }
+  } catch (_) {}
+
+  return null
 }

src/request/Sas9RequestClient.ts

@@ -0,0 +1,121 @@
+import { AxiosRequestConfig } from 'axios'
+import axiosCookieJarSupport from 'axios-cookiejar-support'
+import * as tough from 'tough-cookie'
+import { prefixMessage } from '@sasjs/utils/error'
+import { RequestClient, throwIfError } from './RequestClient'
+
+/**
+ * Specific request client for SAS9 in Node.js environments.
+ * Handles redirects and cookie management.
+ */
+export class Sas9RequestClient extends RequestClient {
+  constructor(baseUrl: string, allowInsecure = false) {
+    super(baseUrl, allowInsecure)
+    this.httpClient.defaults.maxRedirects = 0
+    this.httpClient.defaults.validateStatus = (status) =>
+      status >= 200 && status < 303
+
+    if (axiosCookieJarSupport) {
+      axiosCookieJarSupport(this.httpClient)
+      this.httpClient.defaults.jar = new tough.CookieJar()
+    }
+  }
+
+  public async login(username: string, password: string, jobsPath: string) {
+    const codeInjectorPath = `/User Folders/${username}/My Folder/sasjs/runner`
+    if (this.httpClient.defaults.jar) {
+      ;(this.httpClient.defaults.jar as tough.CookieJar).removeAllCookies()
+      await this.get(
+        `${jobsPath}?_program=${codeInjectorPath}&_username=${username}&_password=${password}`,
+        undefined,
+        'text/plain'
+      )
+    }
+  }
+
+  public async get<T>(
+    url: string,
+    accessToken: string | undefined,
+    contentType: string = 'application/json',
+    overrideHeaders: { [key: string]: string | number } = {},
+    debug: boolean = false
+  ): Promise<{ result: T; etag: string; status: number }> {
+    const headers = {
+      ...this.getHeaders(accessToken, contentType),
+      ...overrideHeaders
+    }
+
+    const requestConfig: AxiosRequestConfig = {
+      headers,
+      responseType: contentType === 'text/plain' ? 'text' : 'json',
+      withCredentials: true
+    }
+    if (contentType === 'text/plain') {
+      requestConfig.transformResponse = undefined
+    }
+
+    return this.httpClient
+      .get<T>(url, requestConfig)
+      .then((response) => {
+        if (response.status === 302) {
+          return this.get(
+            response.headers['location'],
+            accessToken,
+            contentType
+          )
+        }
+        throwIfError(response)
+        return this.parseResponse<T>(response)
+      })
+      .catch(async (e) => {
+        return await this.handleError(
+          e,
+          () =>
+            this.get<T>(url, accessToken, contentType, overrideHeaders).catch(
+              (err) => {
+                throw prefixMessage(
+                  err,
+                  'Error while executing handle error callback. '
+                )
+              }
+            ),
+          debug
+        ).catch((err) => {
+          throw prefixMessage(err, 'Error while handling error. ')
+        })
+      })
+  }
+
+  public post<T>(
+    url: string,
+    data: any,
+    accessToken: string | undefined,
+    contentType = 'application/json',
+    overrideHeaders: { [key: string]: string | number } = {}
+  ): Promise<{ result: T; etag: string }> {
+    const headers = {
+      ...this.getHeaders(accessToken, contentType),
+      ...overrideHeaders
+    }
+
+    return this.httpClient
+      .post<T>(url, data, { headers, withCredentials: true })
+      .then(async (response) => {
+        if (response.status === 302) {
+          return await this.get(
+            response.headers['location'],
+            undefined,
+            contentType,
+            overrideHeaders
+          )
+        }
+        throwIfError(response)
+        return this.parseResponse<T>(response)
+      })
+      .catch(async (e) => {
+        return await this.handleError(e, () =>
+          this.post<T>(url, data, accessToken, contentType, overrideHeaders)
+        )
+      })
+  }
+}

src/test/FileUploader.spec.ts

@@ -1,5 +1,9 @@
-import { FileUploader } from '../FileUploader'
-import { UploadFile } from '../types'
+/**
+ * @jest-environment jsdom
+ */
+
+import { FileUploader } from '../job-execution/FileUploader'
+import { SASjsConfig, UploadFile } from '../types'
 import { RequestClient } from '../request/RequestClient'
 import axios from 'axios'
 jest.mock('axios')
@@ -28,89 +32,101 @@ const prepareFilesAndParams = () => {
 }
 
 describe('FileUploader', () => {
+  const config: SASjsConfig = {
+    ...new SASjsConfig(),
+    appLoc: '/sample/apploc',
+    debug: false
+  }
+
   const fileUploader = new FileUploader(
-    '/sample/apploc',
-    'https://sample.server.com',
+    config.serverUrl,
+    config.serverType!,
     '/jobs/path',
     new RequestClient('https://sample.server.com')
   )
 
-  it('should upload successfully', async (done) => {
+  it('should upload successfully', async () => {
     const sasJob = 'test/upload'
-    const { files, params } = prepareFilesAndParams()
+    const data = prepareFilesAndParams()
     mockedAxios.post.mockImplementation(() =>
       Promise.resolve({ data: sampleResponse })
     )
 
-    fileUploader.uploadFile(sasJob, files, params).then((res: any) => {
-      expect(res).toEqual(JSON.parse(sampleResponse))
-      done()
-    })
+    const res = await fileUploader.execute(sasJob, data, config)
+
+    expect(res).toEqual(JSON.parse(sampleResponse))
   })
 
-  it('should an error when no files are provided', async (done) => {
+  it('should upload successfully when login is required', async () => {
+    mockedAxios.post
+      .mockImplementationOnce(() =>
+        Promise.resolve({ data: '<form action="Logon">' })
+      )
+      .mockImplementationOnce(() => Promise.resolve({ data: sampleResponse }))
+
+    const loginCallback = jest.fn().mockImplementation(async () => {
+      await fileUploader.resendWaitingRequests()
+      Promise.resolve()
+    })
+
+    const sasJob = 'test'
+    const data = prepareFilesAndParams()
+
+    const res = await fileUploader.execute(sasJob, data, config, loginCallback)
+
+    expect(res).toEqual(JSON.parse(sampleResponse))
+
+    expect(mockedAxios.post).toHaveBeenCalledTimes(2)
+    expect(loginCallback).toHaveBeenCalled()
+  })
+
+  it('should an error when no files are provided', async () => {
     const sasJob = 'test/upload'
     const files: UploadFile[] = []
     const params = { table: 'libtable' }
 
-    fileUploader.uploadFile(sasJob, files, params).catch((err: any) => {
-      expect(err.error.message).toEqual('At least one file must be provided.')
-      done()
-    })
+    const res: any = await fileUploader
+      .execute(sasJob, files, params, config)
+      .catch((err: any) => err)
+    expect(res.error.message).toEqual('At least one file must be provided.')
   })
 
-  it('should throw an error when no sasJob is provided', async (done) => {
+  it('should throw an error when no sasJob is provided', async () => {
     const sasJob = ''
-    const { files, params } = prepareFilesAndParams()
+    const data = prepareFilesAndParams()
 
-    fileUploader.uploadFile(sasJob, files, params).catch((err: any) => {
-      expect(err.error.message).toEqual('sasJob must be provided.')
-      done()
-    })
+    const res: any = await fileUploader
+      .execute(sasJob, data, config)
+      .catch((err: any) => err)
+    expect(res.error.message).toEqual('sasJob must be provided.')
   })
 
-  it('should throw an error when login is required', async (done) => {
-    mockedAxios.post.mockImplementation(() =>
-      Promise.resolve({ data: '<form action="Logon">' })
-    )
-
-    const sasJob = 'test'
-    const { files, params } = prepareFilesAndParams()
-
-    fileUploader.uploadFile(sasJob, files, params).catch((err: any) => {
-      expect(err.error.message).toEqual(
-        'You must be logged in to upload a file.'
-      )
-      done()
-    })
-  })
-
-  it('should throw an error when invalid JSON is returned by the server', async (done) => {
+  it('should throw an error when invalid JSON is returned by the server', async () => {
     mockedAxios.post.mockImplementation(() =>
       Promise.resolve({ data: '{invalid: "json"' })
     )
 
     const sasJob = 'test'
-    const { files, params } = prepareFilesAndParams()
+    const data = prepareFilesAndParams()
 
-    fileUploader.uploadFile(sasJob, files, params).catch((err: any) => {
-      expect(err.error.message).toEqual('File upload request failed.')
-      done()
-    })
+    const res: any = await fileUploader
+      .execute(sasJob, data, config)
+      .catch((err: any) => err)
+
+    expect(res.error.message).toEqual('File upload request failed.')
   })
 
-  it('should throw an error when the server request fails', async (done) => {
+  it('should throw an error when the server request fails', async () => {
     mockedAxios.post.mockImplementation(() =>
       Promise.reject({ data: '{message: "Server error"}' })
     )
 
     const sasJob = 'test'
-    const { files, params } = prepareFilesAndParams()
+    const data = prepareFilesAndParams()
 
-    fileUploader.uploadFile(sasJob, files, params).catch((err: any) => {
-      expect(err.error.message).toEqual('File upload request failed.')
-
-      done()
-    })
+    const res: any = await fileUploader
+      .execute(sasJob, data, config)
+      .catch((err: any) => err)
+    expect(res.error.message).toEqual('File upload request failed.')
   })
 })

src/test/FolderOperations.spec.ts

@@ -14,7 +14,7 @@ describe('FolderOperations', () => {
 
   beforeEach(() => {})
 
-  it('should move and rename folder', async (done) => {
+  it('should move and rename folder', async () => {
     mockFetchResponse(false)
 
     let res: any = await sasViyaApiClient.moveFolder(
@@ -26,11 +26,9 @@ describe('FolderOperations', () => {
 
     expect(res.folder.name).toEqual('newName')
     expect(res.folder.parentFolderUri.split('=')[1]).toEqual('/Test/toFolder')
-
-    done()
   })
 
-  it('should move and keep the name of folder', async (done) => {
+  it('should move and keep the name of folder', async () => {
     mockFetchResponse(true)
 
     let res: any = await sasViyaApiClient.moveFolder(
@@ -42,11 +40,9 @@ describe('FolderOperations', () => {
 
     expect(res.folder.name).toEqual('oldName')
     expect(res.folder.parentFolderUri.split('=')[1]).toEqual('/Test/toFolder')
-
-    done()
   })
 
-  it('should only rename folder', async (done) => {
+  it('should only rename folder', async () => {
     mockFetchResponse(false)
 
     let res: any = await sasViyaApiClient.moveFolder(
@@ -58,8 +54,6 @@ describe('FolderOperations', () => {
 
     expect(res.folder.name).toEqual('newName')
     expect(res.folder.parentFolderUri.split('=')[1]).toEqual('/Test/toFolder')
-
-    done()
   })
 })
 

src/test/SessionManager.spec.ts

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

src/test/utils/getValidJson.spec.ts

@@ -0,0 +1,50 @@
+import { getValidJson } from '../../utils'
+import { JsonParseArrayError, InvalidJsonError } from '../../types/errors'
+
+describe('jsonValidator', () => {
+  it('should not throw an error with a valid json', () => {
+    const json = {
+      test: 'test'
+    }
+
+    expect(getValidJson(json)).toBe(json)
+  })
+
+  it('should not throw an error with a valid json string', () => {
+    const json = {
+      test: 'test'
+    }
+
+    expect(getValidJson(JSON.stringify(json))).toStrictEqual(json)
+  })
+
+  it('should throw an error with an invalid json', () => {
+    const json = `{\"test\":\"test\"\"test2\":\"test\"}`
+    const test = () => {
+      getValidJson(json)
+    }
+    expect(test).toThrowError(InvalidJsonError)
+  })
+
+  it('should throw an error when an array is passed', () => {
+    const array = ['hello', 'world']
+    const test = () => {
+      getValidJson(array)
+    }
+    expect(test).toThrow(JsonParseArrayError)
+  })
+
+  it('should throw an error when null is passed', () => {
+    const test = () => {
+      getValidJson(null as any)
+    }
+    expect(test).toThrow(InvalidJsonError)
+  })
+
+  it('should throw an error when undefined is passed', () => {
+    const test = () => {
+      getValidJson(undefined as any)
+    }
+    expect(test).toThrow(InvalidJsonError)
+  })
+})

src/test/utils/isUrl.spec.ts

@@ -28,12 +28,12 @@ describe('urlValidator', () => {
   it('should return false when the URL is null', () => {
     const url = null
 
-    expect(isUrl((url as unknown) as string)).toEqual(false)
+    expect(isUrl(url as unknown as string)).toEqual(false)
   })
 
   it('should return false when the URL is undefined', () => {
     const url = undefined
 
-    expect(isUrl((url as unknown) as string)).toEqual(false)
+    expect(isUrl(url as unknown as string)).toEqual(false)
   })
 })

src/test/utils/parseGeneratedCode.spec.ts

@@ -1,6 +1,6 @@
 import { parseGeneratedCode } from '../../utils/index'
 
-it('should parse generated code', async (done) => {
+it('should parse generated code', () => {
   expect(sampleResponse).toBeTruthy()
 
   const parsedGeneratedCode = parseGeneratedCode(sampleResponse)
@@ -15,8 +15,6 @@ it('should parse generated code', async (done) => {
   expect(generatedCodeLines[2].startsWith('MPRINT(MM_WEBOUT)')).toBeTruthy()
   expect(generatedCodeLines[3].startsWith('MPRINT(MM_WEBRIGHT)')).toBeTruthy()
   expect(generatedCodeLines[4].startsWith('MPRINT(MM_WEBOUT)')).toBeTruthy()
-
-  done()
 })
 
 /* tslint:disable */

src/test/utils/parseSourceCode.spec.ts

@@ -1,6 +1,6 @@
 import { parseSourceCode } from '../../utils/index'
 
-it('should parse SAS9 source code', async (done) => {
+it('should parse SAS9 source code', async () => {
   expect(sampleResponse).toBeTruthy()
 
   const parsedSourceCode = parseSourceCode(sampleResponse)
@@ -15,8 +15,6 @@ it('should parse SAS9 source code', async (done) => {
   expect(sourceCodeLines[2].startsWith('8')).toBeTruthy()
   expect(sourceCodeLines[3].startsWith('9')).toBeTruthy()
   expect(sourceCodeLines[4].startsWith('10')).toBeTruthy()
-
-  done()
 })
 
 /* tslint:disable */

src/types/File.ts

@@ -0,0 +1,8 @@
+import { Link } from './Link'
+
+export interface File {
+  id: string
+  name: string
+  parentUri: string
+  links: Link[]
+}

src/types/Login.ts

@@ -0,0 +1,8 @@
+export interface LoginOptions {
+  onLoggedOut?: () => Promise<boolean>
+}
+
+export interface LoginResult {
+  isLoggedIn: boolean
+  userName: string
+}

src/types/PollOptions.ts

@@ -1,4 +1,6 @@
 export interface PollOptions {
-  MAX_POLL_COUNT?: number
-  POLL_INTERVAL?: number
+  maxPollCount: number
+  pollInterval: number
+  streamLog: boolean
+  logFolderPath?: string
 }

src/types/Process.d.ts

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

src/types/SASjsConfig.ts

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

src/types/WriteStream.ts

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

src/types/errors/InvalidJsonError.ts

@@ -0,0 +1,7 @@
+export class InvalidJsonError extends Error {
+  constructor() {
+    super('Error: invalid Json string')
+    this.name = 'InvalidJsonError'
+    Object.setPrototypeOf(this, InvalidJsonError.prototype)
+  }
+}

src/types/errors/JobStatePollError.ts

@@ -0,0 +1,11 @@
+export class JobStatePollError extends Error {
+  constructor(id: string, public originalError: Error) {
+    super(
+      `Error while polling job state for job ${id}: ${
+        originalError.message || originalError
+      }`
+    )
+    this.name = 'JobStatePollError'
+    Object.setPrototypeOf(this, JobStatePollError.prototype)
+  }
+}

src/types/errors/JsonParseArrayError.ts

@@ -0,0 +1,7 @@
+export class JsonParseArrayError extends Error {
+  constructor() {
+    super('Can not parse array object to json.')
+    this.name = 'JsonParseArrayError'
+    Object.setPrototypeOf(this, JsonParseArrayError.prototype)
+  }
+}

src/types/errors/NoSessionStateError.ts

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

src/types/errors/RootFolderNotFoundError.spec.ts

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

src/types/errors/RootFolderNotFoundError.ts

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

src/types/errors/SAS9AuthError.ts

@@ -0,0 +1,9 @@
+export class SAS9AuthError extends Error {
+  constructor() {
+    super(
+      'The credentials you provided cannot be authenticated. Please provide a valid set of credentials.'
+    )
+    this.name = 'AuthorizeError'
+    Object.setPrototypeOf(this, SAS9AuthError.prototype)
+  }
+}

src/types/errors/WeboutResponseError.ts

@@ -0,0 +1,7 @@
+export class WeboutResponseError extends Error {
+  constructor(public url: string) {
+    super(`Error: error while parsing response from ${url}`)
+    this.name = 'WeboutResponseError'
+    Object.setPrototypeOf(this, WeboutResponseError.prototype)
+  }
+}

src/types/errors/index.ts

@@ -2,6 +2,12 @@ export * from './AuthorizeError'
 export * from './ComputeJobExecutionError'
 export * from './InternalServerError'
 export * from './JobExecutionError'
+export * from './JobStatePollError'
 export * from './LoginRequiredError'
 export * from './NotFoundError'
 export * from './ErrorResponse'
+export * from './NoSessionStateError'
+export * from './RootFolderNotFoundError'
+export * from './JsonParseArrayError'
+export * from './WeboutResponseError'
+export * from './InvalidJsonError'

src/types/index.ts

@@ -1,6 +1,7 @@
 export * from './Context'
 export * from './CsrfToken'
 export * from './Folder'
+export * from './File'
 export * from './Job'
 export * from './JobDefinition'
 export * from './JobResult'
@@ -10,3 +11,4 @@ export * from './SASjsRequest'
 export * from './Session'
 export * from './UploadFile'
 export * from './PollOptions'
+export * from './WriteStream'

src/utils/appendExtraResponseAttributes.ts

@@ -0,0 +1,22 @@
+import { ExtraResponseAttributes } from '@sasjs/utils/types'
+
+export async function appendExtraResponseAttributes(
+  response: any,
+  extraResponseAttributes: ExtraResponseAttributes[]
+) {
+  let responseObject = {}
+
+  if (extraResponseAttributes?.length) {
+    const extraAttributes = extraResponseAttributes.reduce(
+      (map: any, obj: any) => ((map[obj] = response[obj]), map),
+      {}
+    )
+
+    responseObject = {
+      result: response.result,
+      ...extraAttributes
+    }
+  } else responseObject = response.result
+
+  return responseObject
+}

src/utils/convertToCsv.spec.ts

@@ -0,0 +1,170 @@
+import { convertToCSV } from './convertToCsv'
+
+describe('convertToCsv', () => {
+  it('should convert single quoted values', () => {
+    const data = [
+      { foo: `'bar'`, bar: 'abc' },
+      { foo: 'sadf', bar: 'def' },
+      { foo: 'asd', bar: `'qwert'` }
+    ]
+
+    const expectedOutput = `foo:$char5. bar:$char7.\r\n"'bar'",abc\r\nsadf,def\r\nasd,"'qwert'"`
+
+    expect(convertToCSV(data)).toEqual(expectedOutput)
+  })
+
+  it('should convert double quoted values', () => {
+    const data = [
+      { foo: `"bar"`, bar: 'abc' },
+      { foo: 'sadf', bar: 'def' },
+      { foo: 'asd', bar: `"qwert"` }
+    ]
+
+    const expectedOutput = `foo:$char5. bar:$char7.\r\n"""bar""",abc\r\nsadf,def\r\nasd,"""qwert"""`
+
+    expect(convertToCSV(data)).toEqual(expectedOutput)
+  })
+
+  it('should convert values with mixed quotes', () => {
+    const data = [{ foo: `'blah'`, bar: `"blah"` }]
+
+    const expectedOutput = `foo:$char6. bar:$char6.\r\n"'blah'","""blah"""`
+
+    expect(convertToCSV(data)).toEqual(expectedOutput)
+  })
+
+  it('should convert values with mixed quotes', () => {
+    const data = [{ foo: `'blah,"'`, bar: `"blah,blah" "` }]
+
+    const expectedOutput = `foo:$char8. bar:$char13.\r\n"'blah,""'","""blah,blah"" """`
+
+    expect(convertToCSV(data)).toEqual(expectedOutput)
+  })
+
+  it('should convert values with mixed quotes', () => {
+    const data = [{ foo: `',''`, bar: `","` }]
+
+    const expectedOutput = `foo:$char4. bar:$char3.\r\n"',''",""","""`
+
+    expect(convertToCSV(data)).toEqual(expectedOutput)
+  })
+
+  it('should convert values with mixed quotes', () => {
+    const data = [{ foo: `','`, bar: `,"` }]
+
+    const expectedOutput = `foo:$char3. bar:$char2.\r\n"','",","""`
+
+    expect(convertToCSV(data)).toEqual(expectedOutput)
+  })
+
+  it('should convert values with mixed quotes', () => {
+    const data = [{ foo: `"`, bar: `'` }]
+
+    const expectedOutput = `foo:$char1. bar:$char1.\r\n"""","'"`
+
+    expect(convertToCSV(data)).toEqual(expectedOutput)
+  })
+
+  it('should convert values with mixed quotes', () => {
+    const data = [{ foo: `,`, bar: `',` }]
+
+    const expectedOutput = `foo:$char1. bar:$char2.\r\n",","',"`
+
+    expect(convertToCSV(data)).toEqual(expectedOutput)
+  })
+
+  it('should convert values with number cases 1', () => {
+    const data = [
+      { col1: 42, col2: null, col3: 'x', col4: null },
+      { col1: 42, col2: null, col3: 'x', col4: null },
+      { col1: 42, col2: null, col3: 'x', col4: null },
+      { col1: 42, col2: null, col3: 'x', col4: '' },
+      { col1: 42, col2: null, col3: 'x', col4: '' }
+    ]
+
+    const expectedOutput = `col1:best. col2:best. col3:$char1. col4:$char1.\r\n42,.,x,\r\n42,.,x,\r\n42,.,x,\r\n42,.,x,\r\n42,.,x,`
+
+    expect(convertToCSV(data)).toEqual(expectedOutput)
+  })
+
+  it('should convert values with number cases 2', () => {
+    const data = [
+      { col1: 42, col2: null, col3: 'x', col4: '' },
+      { col1: 42, col2: null, col3: 'x', col4: '' },
+      { col1: 42, col2: null, col3: 'x', col4: '' },
+      { col1: 42, col2: 1.62, col3: 'x', col4: 'x' },
+      { col1: 42, col2: 1.62, col3: 'x', col4: 'x' }
+    ]
+
+    const expectedOutput = `col1:best. col2:best. col3:$char1. col4:$char1.\r\n42,.,x,\r\n42,.,x,\r\n42,.,x,\r\n42,1.62,x,x\r\n42,1.62,x,x`
+
+    expect(convertToCSV(data)).toEqual(expectedOutput)
+  })
+
+  it('should convert values with common special characters', () => {
+    expect(convertToCSV([{ tab: '\t' }])).toEqual(`tab:$char1.\r\n\"\t\"`)
+    expect(convertToCSV([{ lf: '\n' }])).toEqual(`lf:$char1.\r\n\"\n\"`)
+    expect(convertToCSV([{ semicolon: ';semi' }])).toEqual(
+      `semicolon:$char5.\r\n;semi`
+    )
+    expect(convertToCSV([{ percent: '%' }])).toEqual(`percent:$char1.\r\n%`)
+    expect(convertToCSV([{ singleQuote: "'" }])).toEqual(
+      `singleQuote:$char1.\r\n\"'\"`
+    )
+    expect(convertToCSV([{ doubleQuote: '"' }])).toEqual(
+      `doubleQuote:$char1.\r\n""""`
+    )
+    expect(convertToCSV([{ crlf: '\r\n' }])).toEqual(`crlf:$char2.\r\n\"\n\"`)
+    expect(convertToCSV([{ euro: '€euro' }])).toEqual(`euro:$char7.\r\n€euro`)
+    expect(convertToCSV([{ banghash: '!#banghash' }])).toEqual(
+      `banghash:$char10.\r\n!#banghash`
+    )
+  })
+
+  it('should convert values with other special characters', () => {
+    const data = [
+      {
+        speech0: '"speech',
+        pct: '%percent',
+        speech: '"speech',
+        slash: '\\slash',
+        slashWithSpecial: '\\\tslash',
+        macvar: '&sysuserid',
+        chinese: '传/傳chinese',
+        sigma: 'Σsigma',
+        at: '@at',
+        serbian: 'Српски',
+        dollar: '$'
+      }
+    ]
+
+    const expectedOutput = `speech0:$char7. pct:$char8. speech:$char7. slash:$char6. slashWithSpecial:$char7. macvar:$char10. chinese:$char14. sigma:$char7. at:$char3. serbian:$char12. dollar:$char1.\r\n"""speech",%percent,"""speech",\\slash,\"\\\tslash\",&sysuserid,传/傳chinese,Σsigma,@at,Српски,$`
+
+    expect(convertToCSV(data)).toEqual(expectedOutput)
+
+    expect(convertToCSV([{ speech: 'menext' }])).toEqual(
+      `speech:$char6.\r\nmenext`
+    )
+    expect(convertToCSV([{ speech: 'me\nnext' }])).toEqual(
+      `speech:$char7.\r\n\"me\nnext\"`
+    )
+    expect(convertToCSV([{ speech: `me'next` }])).toEqual(
+      `speech:$char7.\r\n\"me'next\"`
+    )
+    expect(convertToCSV([{ speech: `me"next` }])).toEqual(
+      `speech:$char7.\r\n\"me""next\"`
+    )
+    expect(convertToCSV([{ speech: `me""next` }])).toEqual(
+      `speech:$char8.\r\n\"me""""next\"`
+    )
+    expect(convertToCSV([{ slashWithSpecial: '\\\tslash' }])).toEqual(
+      `slashWithSpecial:$char7.\r\n\"\\\tslash\"`
+    )
+    expect(convertToCSV([{ slashWithSpecial: '\\ \tslash' }])).toEqual(
+      `slashWithSpecial:$char8.\r\n\"\\ \tslash\"`
+    )
+    expect(
+      convertToCSV([{ slashWithSpecialExtra: '\\\ts\tl\ta\ts\t\th\t' }])
+    ).toEqual(`slashWithSpecialExtra:$char13.\r\n\"\\\ts\tl\ta\ts\t\th\t\"`)
+  })
+})

src/utils/convertToCsv.ts

@@ -1,6 +1,6 @@
 /**
- * Converts the given JSON object to a CSV string.
- * @param data - the JSON object to convert.
+ * Converts the given JSON object array to a CSV string.
+ * @param data - the array of JSON objects to convert.
  */
 export const convertToCSV = (data: any) => {
   const replacer = (key: any, value: any) => (value === null ? '' : value)
@@ -37,15 +37,7 @@ export const convertToCSV = (data: any) => {
           let byteSize
 
           if (typeof row[field] === 'string') {
-            let doubleQuotesFound = row[field]
-              .split('')
-              .filter((char: any) => char === '"')
-
             byteSize = getByteSize(row[field])
-
-            if (doubleQuotesFound.length > 0) {
-              byteSize += doubleQuotesFound.length
-            }
           }
 
           return byteSize
@@ -61,7 +53,7 @@ export const convertToCSV = (data: any) => {
       )
     }
 
-    return `${field}:${firstFoundType === 'chars' ? '$' : ''}${
+    return `${field}:${firstFoundType === 'chars' ? '$char' : ''}${
       longestValueForField
         ? longestValueForField
         : firstFoundType === 'chars'
@@ -73,35 +65,28 @@ export const convertToCSV = (data: any) => {
   if (invalidString) {
     return 'ERROR: LARGE STRING LENGTH'
   }
+
   csvTest = data.map((row: any) => {
     const fields = Object.keys(row).map((fieldName, index) => {
       let value
-      let containsSpecialChar = false
       const currentCell = row[fieldName]
 
-      if (JSON.stringify(currentCell).search(/(\\t|\\n|\\r)/gm) > -1) {
-        value = currentCell.toString()
-        containsSpecialChar = true
-      } else {
-        value = JSON.stringify(currentCell, replacer)
-      }
+      if (typeof currentCell === 'number') return currentCell
 
-      value = value.replace(/\\\\/gm, '\\')
+      // stringify with replacer converts null values to empty strings
+      value = currentCell === null ? '' : currentCell
 
-      if (containsSpecialChar) {
-        if (value.includes(',') || value.includes('"')) {
-          value = '"' + value + '"'
-        }
-      } else {
-        if (
-          !value.includes(',') &&
-          value.includes('"') &&
-          !value.includes('\\"')
-        ) {
-          value = value.substring(1, value.length - 1)
-        }
+      // if there any present, it should have preceding (") for escaping
+      value = value.replace(/"/g, `""`)
 
-        value = value.replace(/\\"/gm, '""')
+      // also wraps the value in double quotes
+      value = `"${value}"`
+
+      if (
+        value.substring(1, value.length - 1).search(/(\t|\n|\r|,|\'|\")/gm) < 0
+      ) {
+        // Remove wrapping quotes for values that don't contain special characters
+        value = value.substring(1, value.length - 1)
       }
 
       value = value.replace(/\r\n/gm, '\n')