Merge pull request #263 from sasjs/error-handling

fix(docs): updated docs

src/SASViyaApiClient.ts

@@ -21,6 +21,7 @@ import { isAuthorizeFormRequired } from './auth/isAuthorizeFormRequired'
 import { RequestClient } from './request/RequestClient'
 import { NotFoundError } from './types/NotFoundError'
 import { SasAuthResponse } from '@sasjs/utils/types'
+import { prefixMessage } from '@sasjs/utils/error'
 
 /**
  * A client for interfacing with the SAS Viya REST API.
@@ -280,25 +281,24 @@ export class SASViyaApiClient {
         'Content-Type': 'application/json'
       }
 
-      if (accessToken) {
+      if (accessToken) headers.Authorization = `Bearer ${accessToken}`
-        headers.Authorization = `Bearer ${accessToken}`
-      }
 
       let executionSessionId: string
+
       const session = await this.sessionManager
         .getSession(accessToken)
         .catch((err) => {
-          throw err
+          throw prefixMessage(err, 'Error while getting session. ')
         })
 
       executionSessionId = session!.id
 
       if (printPid) {
-        const { result: jobIdVariable } = await this.sessionManager.getVariable(
+        const { result: jobIdVariable } = await this.sessionManager
-          executionSessionId,
+          .getVariable(executionSessionId, 'SYSJOBID', accessToken)
-          'SYSJOBID',
+          .catch((err) => {
-          accessToken
+            throw prefixMessage(err, 'Error while getting session variable. ')
-        )
+          })
 
         if (jobIdVariable && jobIdVariable.value) {
           const relativeJobPath = this.rootFolderName
@@ -331,6 +331,7 @@ export class SASViyaApiClient {
       }
 
       let fileName
+
       if (isRelativePath(jobPath)) {
         fileName = `exec-${
           jobPath.includes('/') ? jobPath.split('/')[1] : jobPath
@@ -352,7 +353,7 @@ export class SASViyaApiClient {
       if (data) {
         if (JSON.stringify(data).includes(';')) {
           files = await this.uploadTables(data, accessToken).catch((err) => {
-            throw err
+            throw prefixMessage(err, 'Error while uploading tables. ')
           })
 
           jobVariables['_webin_file_count'] = files.length
@@ -376,19 +377,18 @@ export class SASViyaApiClient {
         variables: jobVariables,
         arguments: jobArguments
       }
+
       const { result: postedJob, etag } = await this.requestClient
         .post<Job>(
           `/compute/sessions/${executionSessionId}/jobs`,
           jobRequestBody,
           accessToken
         )
-        .catch((err: any) => {
+        .catch((err) => {
-          throw err
+          throw prefixMessage(err, 'Error while posting job. ')
         })
 
-      if (!waitForResult) {
+      if (!waitForResult) return session
-        return session
-      }
 
       if (debug) {
         console.log(`Job has been submitted for '${fileName}'.`)
@@ -404,7 +404,9 @@ export class SASViyaApiClient {
         etag,
         accessToken,
         pollOptions
-      )
+      ).catch((err) => {
+        throw prefixMessage(err, 'Error while polling job status. ')
+      })
 
       const { result: currentJob } = await this.requestClient
         .get<Job>(
@@ -412,7 +414,7 @@ export class SASViyaApiClient {
           accessToken
         )
         .catch((err) => {
-          throw err
+          throw prefixMessage(err, 'Error while getting job. ')
         })
 
       let jobResult
@@ -427,7 +429,7 @@ export class SASViyaApiClient {
             res.result.items.map((i: any) => i.line).join('\n')
           )
           .catch((err) => {
-            throw err
+            throw prefixMessage(err, 'Error while getting log. ')
           })
       }
 
@@ -455,7 +457,7 @@ export class SASViyaApiClient {
                     res.result.items.map((i: any) => i.line).join('\n')
                   )
                   .catch((err) => {
-                    throw err
+                    throw prefixMessage(err, 'Error while getting log. ')
                   })
 
                 return Promise.reject({
@@ -464,6 +466,7 @@ export class SASViyaApiClient {
                 })
               }
             }
+
             return {
               result: JSON.stringify(e)
             }
@@ -473,7 +476,7 @@ export class SASViyaApiClient {
       await this.sessionManager
         .clearSession(executionSessionId, accessToken)
         .catch((err) => {
-          throw err
+          throw prefixMessage(err, 'Error while clearing session. ')
         })
 
       return { result: jobResult?.result, log }
@@ -490,7 +493,7 @@ export class SASViyaApiClient {
           true
         )
       } else {
-        throw e
+        throw prefixMessage(e, 'Error while executing script. ')
       }
     }
   }
@@ -814,9 +817,12 @@ export class SASViyaApiClient {
       ? `${this.rootFolderName}/${folderPath}`
       : folderPath
 
-    await this.populateFolderMap(fullFolderPath, accessToken)
+    await this.populateFolderMap(fullFolderPath, accessToken).catch((err) => {
+      throw prefixMessage(err, 'Error while populating folder map. ')
+    })
 
     const jobFolder = this.folderMap.get(fullFolderPath)
+
     if (!jobFolder) {
       throw new Error(
         `The folder '${fullFolderPath}' was not found on '${this.serverUrl}'`
@@ -824,6 +830,7 @@ export class SASViyaApiClient {
     }
 
     const headers: any = { 'Content-Type': 'application/json' }
+
     if (!!accessToken) {
       headers.Authorization = `Bearer ${accessToken}`
     }
@@ -847,10 +854,14 @@ export class SASViyaApiClient {
 
       const {
         result: jobDefinition
-      } = await this.requestClient.get<JobDefinition>(
+      } = await this.requestClient
+        .get<JobDefinition>(
           `${this.serverUrl}${jobDefinitionLink.href}`,
           accessToken
         )
+        .catch((err) => {
+          throw prefixMessage(err, 'Error while getting job definition. ')
+        })
 
       code = jobDefinition.code
 
@@ -861,6 +872,7 @@ export class SASViyaApiClient {
     if (!code) code = ''
 
     const linesToExecute = code.replace(/\r\n/g, '\n').split('\n')
+
     return await this.executeScript(
       sasJob,
       linesToExecute,
@@ -872,7 +884,9 @@ export class SASViyaApiClient {
       waitForResult,
       pollOptions,
       printPid
-    )
+    ).catch((err) => {
+      throw prefixMessage(err, 'Error while executing script. ')
+    })
   }
 
   /**
@@ -1007,19 +1021,27 @@ export class SASViyaApiClient {
     }
 
     const url = '/folders/folders/@item?path=' + path
-    const { result: folder } = await this.requestClient.get<Folder>(
+    const { result: folder } = await this.requestClient
-      `${url}`,
+      .get<Folder>(`${url}`, accessToken)
-      accessToken
+      .catch((err) => {
-    )
+        throw prefixMessage(err, 'Error while getting folder. ')
+      })
+
     if (!folder) {
       throw new Error(`The path ${path} does not exist on ${this.serverUrl}`)
     }
-    const { result: members } = await this.requestClient.get<{ items: any[] }>(
+
+    const { result: members } = await this.requestClient
+      .get<{ items: any[] }>(
         `/folders/folders/${folder.id}/members?limit=${folder.memberCount}`,
         accessToken
       )
+      .catch((err) => {
+        throw prefixMessage(err, 'Error while getting members. ')
+      })
 
     const itemsAtRoot = members.items
+
     this.folderMap.set(path, itemsAtRoot)
   }
 
@@ -1052,11 +1074,15 @@ export class SASViyaApiClient {
       Promise.reject(`Job state link was not found.`)
     }
 
-    const { result: state } = await this.requestClient.get<string>(
+    const { result: state } = await this.requestClient
+      .get<string>(
         `${this.serverUrl}${stateLink.href}?_action=wait&wait=30`,
         accessToken,
         'text/plain'
       )
+      .catch((err) => {
+        throw prefixMessage(err, 'Error while getting job state. ')
+      })
 
     const currentState = state.trim()
     if (currentState === 'completed') {
@@ -1073,11 +1099,15 @@ export class SASViyaApiClient {
           postedJobState === 'pending'
         ) {
           if (stateLink) {
-            const { result: jobState } = await this.requestClient.get<string>(
+            const { result: jobState } = await this.requestClient
+              .get<string>(
                 `${this.serverUrl}${stateLink.href}?_action=wait&wait=30`,
                 accessToken,
                 'text/plain'
               )
+              .catch((err) => {
+                throw prefixMessage(err, 'Error while getting job state. ')
+              })
 
             postedJobState = jobState.trim()
 
@@ -1119,19 +1149,25 @@ export class SASViyaApiClient {
         )
       }
 
-      const uploadResponse = await this.requestClient.uploadFile(
+      const uploadResponse = await this.requestClient
-        `${this.serverUrl}/files/files#rawUpload`,
+        .uploadFile(`${this.serverUrl}/files/files#rawUpload`, csv, accessToken)
-        csv,
+        .catch((err) => {
-        accessToken
+          throw prefixMessage(err, 'Error while uploading file. ')
-      )
+        })
 
       uploadedFiles.push({ tableName, file: uploadResponse.result })
     }
     return uploadedFiles
   }
 
-  private async getFolderUri(folderPath: string, accessToken?: string) {
+  private async getFolderDetails(
-    const url = '/folders/folders/@item?path=' + folderPath
+    folderPath: string,
+    accessToken?: string
+  ): Promise<Folder | undefined> {
+    const url = isUri(folderPath)
+      ? folderPath
+      : `/folders/folders/@item?path=${folderPath}`
+
     const { result: folder } = await this.requestClient
       .get<Folder>(`${this.serverUrl}${url}`, accessToken)
       .catch(() => {
@@ -1139,7 +1175,15 @@ export class SASViyaApiClient {
       })
 
     if (!folder) return undefined
-    return `/folders/folders/${folder.id}`
+    return folder
+  }
+
+  private async getFolderUri(folderPath: string, accessToken?: string) {
+    const folderDetails = await this.getFolderDetails(folderPath, accessToken)
+
+    if (!folderDetails) return undefined
+
+    return `/folders/folders/${folderDetails.id}`
   }
 
   private async getRecycleBinUri(accessToken: string) {
@@ -1188,9 +1232,44 @@ export class SASViyaApiClient {
   }
 
   /**
-   * Moves a Viya folder to a new location.  The folder may be renamed at the same time.
+   * Lists children folders for given Viya folder.
+   * @param sourceFolder - the full path (eg `/Public/example/myFolder`) or URI of the source folder listed. Providing URI instead of path will save one extra request.
+   * @param accessToken - an access token for authorizing the request.
+   */
+  public async listFolder(
+    sourceFolder: string,
+    accessToken?: string,
+    limit: number = 20
+  ) {
+    // checks if 'sourceFolder' is already a URI
+    const sourceFolderUri = isUri(sourceFolder)
+      ? 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
+    )
+
+    if (members && members.items) {
+      return members.items.map((item: any) => item.name)
+    } else {
+      return []
+    }
+  }
+
+  /**
+   * Moves Viya folder to a new location.  The folder may be renamed at the same time.
    * @param sourceFolder - the full path (eg `/Public/example/myFolder`) or URI of the source folder to be moved. Providing URI instead of path will save one extra request.
-   * @param targetParentFolder - the full path or URI of the _parent_ folder to which the `sourceFolder` will be moved (eg `/Public/newDestination`). To move a folder, a user has to have write permissions in targetParentFolder. Providing URI instead of path will save one extra request.
+   * @param targetParentFolder - the full path or URI of the _parent_ folder to which the `sourceFolder` will be moved (eg `/Public/newDestination`). To move a folder, a user has to have write permissions in targetParentFolder. Providing URI instead of the path will save one extra request.
    * @param targetFolderName - the name of the "moved" folder.  If left blank, the original folder name will be used (eg `myFolder` in `/Public/newDestination/myFolder` for the example above).  Optional field.
    * @param accessToken - an access token for authorizing the request.
    */
@@ -1200,22 +1279,35 @@ export class SASViyaApiClient {
     targetFolderName: string,
     accessToken: string
   ) {
-    // checks if 'sourceFolder' is already a URI
+    // If target path is an existing folder, than keep source folder name, othervise rename it with given target folder name
-    const sourceFolderUri = isUri(sourceFolder)
+    const sourceFolderName = sourceFolder.split('/').pop() as string
-      ? sourceFolder
+    const targetFolderDetails = await this.getFolderDetails(
-      : await this.getFolderUri(sourceFolder, accessToken)
+      targetParentFolder,
+      accessToken
+    )
+
+    if (!targetFolderDetails) {
+      let targetParentFolderArr = targetParentFolder.split('/')
+      targetParentFolderArr.splice(targetParentFolderArr.length - 1, 1)
+      targetParentFolder = targetParentFolderArr.join('/')
+    } else {
+      targetFolderName = sourceFolderName
+    }
+
+    // checks if 'sourceFolder' is already an URI
+    const sourceFolderUri = await this.getFolderUri(sourceFolder, accessToken)
 
     // checks if 'targetParentFolder' is already a URI
-    const targetParentFolderUri = isUri(targetParentFolder)
+    const targetParentFolderUri = await this.getFolderUri(
-      ? targetParentFolder
+      targetParentFolder,
-      : await this.getFolderUri(targetParentFolder, accessToken)
+      accessToken
+    )
 
     const sourceFolderId = sourceFolderUri?.split('/').pop()
-    const url = sourceFolderUri
 
     const { result: folder } = await this.requestClient
       .patch<Folder>(
-        `${this.serverUrl}${url}`,
+        `${this.serverUrl}${sourceFolderUri}`,
         {
           id: sourceFolderId,
           name: targetFolderName,

src/SASjs.ts

@@ -317,6 +317,25 @@ export default class SASjs {
     return await this.sasViyaApiClient?.deleteFolder(folderPath, accessToken)
   }
 
+  /**
+   * Lists children folders for given Viya folder.
+   * @param sourceFolder - the full path (eg `/Public/example/myFolder`) or URI of the source folder listed. Providing URI instead of path will save one extra request.
+   * @param accessToken - an access token for authorizing the request.
+   */
+  public async listFolder(
+    sourceFolder: string,
+    accessToken?: string,
+    limit?: number
+  ) {
+    this.isMethodSupported('listFolder', ServerType.SasViya)
+
+    return await this.sasViyaApiClient?.listFolder(
+      sourceFolder,
+      accessToken,
+      limit
+    )
+  }
+
   /**
    * Moves folder to a new location.  The folder may be renamed at the same time.
    * @param sourceFolder - the full path (eg `/Public/example/myFolder`) or URI of the source folder to be moved. Providing URI instead of path will save one extra request.

src/SessionManager.ts

@@ -64,7 +64,7 @@ export class SessionManager {
         this.sessions = this.sessions.filter((s) => s.id !== id)
       })
       .catch((err) => {
-        throw err
+        throw prefixMessage(err, 'Error while deleting session. ')
       })
   }
 

src/test/FolderOperations.spec.ts

@@ -0,0 +1,83 @@
+import { RequestClient } from '../request/RequestClient'
+import { SASViyaApiClient } from '../SASViyaApiClient'
+import axios from 'axios'
+jest.mock('axios')
+const mockedAxios = axios as jest.Mocked<typeof axios>
+
+describe('FolderOperations', () => {
+  const sasViyaApiClient = new SASViyaApiClient(
+    'https://sample.server.com',
+    '/Public',
+    'Context',
+    new RequestClient('https://sample.server.com')
+  )
+
+  beforeEach(() => {})
+
+  it('should move and rename folder', async (done) => {
+    mockFetchResponse(false)
+
+    let res: any = await sasViyaApiClient.moveFolder(
+      '/Test/fromFolder/oldName',
+      '/Test/toFolder/newName',
+      'newName',
+      'token'
+    )
+
+    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) => {
+    mockFetchResponse(true)
+
+    let res: any = await sasViyaApiClient.moveFolder(
+      '/Test/fromFolder/oldName',
+      '/Test/toFolder',
+      'toFolder',
+      'token'
+    )
+
+    expect(res.folder.name).toEqual('oldName')
+    expect(res.folder.parentFolderUri.split('=')[1]).toEqual('/Test/toFolder')
+
+    done()
+  })
+
+  it('should only rename folder', async (done) => {
+    mockFetchResponse(false)
+
+    let res: any = await sasViyaApiClient.moveFolder(
+      '/Test/toFolder/oldName',
+      '/Test/toFolder/newName',
+      'newName',
+      'token'
+    )
+
+    expect(res.folder.name).toEqual('newName')
+    expect(res.folder.parentFolderUri.split('=')[1]).toEqual('/Test/toFolder')
+
+    done()
+  })
+})
+
+const mockFetchResponse = (targetFolderExists: boolean) => {
+  mockedAxios.patch.mockImplementation((url: any, request: any) => {
+    return Promise.resolve({ status: 200, data: { folder: request } })
+  })
+
+  mockedAxios.get.mockImplementation((url: any, request: any) => {
+    if (!targetFolderExists && url.includes('newName')) {
+      return Promise.resolve(undefined)
+    }
+
+    return Promise.resolve({
+      status: 200,
+      data: {
+        id: url
+      }
+    })
+  })
+}