Merge pull request #480 from sasjs/issue-477

fix: update error message when folder not found

.all-contributorsrc

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

.git-hooks/commit-msg

@@ -6,7 +6,7 @@ GREEN="\033[1;32m"
 # temporary file which holds the message).
 commit_message=$(cat "$1")
 
-if (echo "$commit_message" | grep -Eq "^(build|chore|ci|docs|feat|fix|perf|refactor|revert|style|test)(\([a-z0-9 \-\*]+\))?!?: .+$") then
+if (echo "$commit_message" | grep -Eq "^(build|chore|ci|docs|feat|fix|perf|refactor|revert|style|test)(\([a-z0-9 -\*]+\))?!?: .+$") then
    echo "${GREEN} ✔ Commit message meets Conventional Commit standards"
    exit 0
 fi

README.md

@@ -172,7 +172,7 @@ Configuration on the client side involves passing an object on startup, which ca
 * `serverType` - either `SAS9` or `SASVIYA`.
 * `serverUrl` - the location (including http protocol and port) of the SAS Server. Can be omitted, eg if serving directly from the SAS Web Server, or in streaming mode.
 * `debug` - if `true` then SAS Logs and extra debug information is returned.
-* `useComputeApi` - Only relevant when the serverType is `SASVIYA`. If `true` the [Compute API](#using-the-compute-api) is used.  If `false` the [JES API](#using-the-jes-api) is used.  If `null` or `undefined` the [Web](#using-jes-web-app) approach is used.  
+* `useComputeApi` - Only relevant when the serverType is `SASVIYA`. If `true` the [Compute API](#using-the-compute-api) is used.  If `false` the [JES API](#using-the-jes-api) is used.  If `null` or `undefined` the [Web](#using-jes-web-app) approach is used.
 * `contextName` - Compute context on which the requests will be called.  If missing or not provided, defaults to `Job Execution Compute context`.
 
 The adapter supports a number of approaches for interfacing with Viya (`serverType` is `SASVIYA`).  For maximum performance, be sure to [configure your compute context](https://sasjs.io/guide-viya/#shared-account-and-server-re-use) with `reuseServerProcesses` as `true` and a system account in `runServerAs`.  This functionality is available since Viya 3.5.  This configuration is supported when [creating contexts using the CLI](https://sasjs.io/sasjs-cli-context/#sasjs-context-create).
@@ -236,6 +236,9 @@ If you find this library useful, help us grow our star graph!
 ![](https://starchart.cc/sasjs/adapter.svg)
 
 ## Contributors ✨
+<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
+[![All Contributors](https://img.shields.io/badge/all_contributors-7-orange.svg?style=flat-square)](#contributors-)
+<!-- ALL-CONTRIBUTORS-BADGE:END -->
 
 Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
 
@@ -244,7 +247,13 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
 <!-- markdownlint-disable -->
 <table>
   <tr>
-    <td align="center"><a href="https://github.com/medjedovicm"><img src="https://avatars.githubusercontent.com/u/18329105?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Mihajlo Medjedovic</b></sub></a><br /><a href="https://github.com/sasjs/adapter/commits?author=medjedovicm" title="Code">💻</a></td>
+    <td align="center"><a href="https://krishna-acondy.io/"><img src="https://avatars.githubusercontent.com/u/2980428?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Krishna Acondy</b></sub></a><br /><a href="https://github.com/sasjs/adapter/commits?author=krishna-acondy" title="Code">💻</a> <a href="#infra-krishna-acondy" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="#blog-krishna-acondy" title="Blogposts">📝</a> <a href="#content-krishna-acondy" title="Content">🖋</a> <a href="#ideas-krishna-acondy" title="Ideas, Planning, & Feedback">🤔</a> <a href="#video-krishna-acondy" title="Videos">📹</a></td>
+    <td align="center"><a href="https://www.erudicat.com/"><img src="https://avatars.githubusercontent.com/u/25773492?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Yury Shkoda</b></sub></a><br /><a href="https://github.com/sasjs/adapter/commits?author=YuryShkoda" title="Code">💻</a> <a href="#infra-YuryShkoda" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="#ideas-YuryShkoda" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/sasjs/adapter/commits?author=YuryShkoda" title="Tests">⚠️</a> <a href="#video-YuryShkoda" title="Videos">📹</a></td>
+    <td align="center"><a href="https://github.com/medjedovicm"><img src="https://avatars.githubusercontent.com/u/18329105?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Mihajlo Medjedovic</b></sub></a><br /><a href="https://github.com/sasjs/adapter/commits?author=medjedovicm" title="Code">💻</a> <a href="#infra-medjedovicm" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="https://github.com/sasjs/adapter/commits?author=medjedovicm" title="Tests">⚠️</a> <a href="https://github.com/sasjs/adapter/pulls?q=is%3Apr+reviewed-by%3Amedjedovicm" title="Reviewed Pull Requests">👀</a></td>
+    <td align="center"><a href="https://github.com/allanbowe"><img src="https://avatars.githubusercontent.com/u/4420615?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Allan Bowe</b></sub></a><br /><a href="https://github.com/sasjs/adapter/commits?author=allanbowe" title="Code">💻</a> <a href="https://github.com/sasjs/adapter/pulls?q=is%3Apr+reviewed-by%3Aallanbowe" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/sasjs/adapter/commits?author=allanbowe" title="Tests">⚠️</a> <a href="#mentoring-allanbowe" title="Mentoring">🧑‍🏫</a> <a href="#maintenance-allanbowe" title="Maintenance">🚧</a></td>
+    <td align="center"><a href="https://github.com/saadjutt01"><img src="https://avatars.githubusercontent.com/u/8914650?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Muhammad Saad </b></sub></a><br /><a href="https://github.com/sasjs/adapter/commits?author=saadjutt01" title="Code">💻</a> <a href="https://github.com/sasjs/adapter/pulls?q=is%3Apr+reviewed-by%3Asaadjutt01" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/sasjs/adapter/commits?author=saadjutt01" title="Tests">⚠️</a> <a href="#mentoring-saadjutt01" title="Mentoring">🧑‍🏫</a> <a href="#infra-saadjutt01" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a></td>
+    <td align="center"><a href="https://github.com/sabhas"><img src="https://avatars.githubusercontent.com/u/82647447?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Sabir Hassan</b></sub></a><br /><a href="https://github.com/sasjs/adapter/commits?author=sabhas" title="Code">💻</a> <a href="https://github.com/sasjs/adapter/pulls?q=is%3Apr+reviewed-by%3Asabhas" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/sasjs/adapter/commits?author=sabhas" title="Tests">⚠️</a> <a href="#ideas-sabhas" title="Ideas, Planning, & Feedback">🤔</a></td>
+    <td align="center"><a href="https://github.com/VladislavParhomchik"><img src="https://avatars.githubusercontent.com/u/83717836?v=4?s=100" width="100px;" alt=""/><br /><sub><b>VladislavParhomchik</b></sub></a><br /><a href="https://github.com/sasjs/adapter/commits?author=VladislavParhomchik" title="Tests">⚠️</a> <a href="https://github.com/sasjs/adapter/pulls?q=is%3Apr+reviewed-by%3AVladislavParhomchik" title="Reviewed Pull Requests">👀</a></td>
   </tr>
 </table>
 

sasjs-tests/src/testSuites/Basic.ts

@@ -47,9 +47,7 @@ export const basicTests = (
         'Should fail on first attempt and should log the user in on second attempt',
       test: async () => {
         await adapter.logOut()
-        await sleep(1000)
         await adapter.logIn('invalid', 'invalid')
-        await sleep(1000)
         return adapter.logIn(userName, password)
       },
       assertion: (response: any) =>
@@ -153,9 +151,6 @@ export const basicTests = (
       description:
         'Should complete successful request with extra attributes present in response',
       test: async () => {
-        if (adapter.getSasjsConfig().serverType !== 'SASVIYA')
-          return Promise.resolve('skip')
-
         const config = {
           useComputeApi: false
         }
@@ -170,15 +165,9 @@ export const basicTests = (
         )
       },
       assertion: (response: any) => {
-        if (response === 'skip') return true
-
         const responseKeys: any = Object.keys(response)
         return responseKeys.includes('file') && responseKeys.includes('data')
       }
     }
   ]
 })
-
-const sleep = (ms: number) => {
-  return new Promise((resolve) => setTimeout(resolve, ms))
-}

src/SASViyaApiClient.spec.ts

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

src/SASViyaApiClient.ts

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

src/job-execution/WebJobExecutor.ts

@@ -107,9 +107,20 @@ export class WebJobExecutor extends BaseJobExecutor {
             this.appendRequest(res, sasJob, config.debug)
             resolve(jsonResponse)
           }
-          
-          this.appendRequest(res, sasJob, config.debug)
+          if (this.serverType === ServerType.Sas9 && config.debug) {
+            const jsonResponse = parseWeboutResponse(res.result as string)
+            if (jsonResponse === '') {
+              throw new Error(
+                'Valid JSON could not be extracted from response.'
+              )
+            }
+
+            getValidJson(jsonResponse)
+            this.appendRequest(res, sasJob, config.debug)
+            resolve(res.result)
+          }
           getValidJson(res.result as string)
+          this.appendRequest(res, sasJob, config.debug)
           resolve(res.result)
         })
         .catch(async (e: Error) => {

src/types/errors/RootFolderNotFoundError.spec.ts

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

src/types/errors/RootFolderNotFoundError.ts

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

src/types/errors/index.ts

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