Merge pull request #148 from sasjs/issue113

feat: service not found error handling

docs/globals.html

@@ -76,7 +76,7 @@
 						<section class="tsd-index-section ">
 							<h3>Modules</h3>
 							<ul class="tsd-index-list">
-								<li class="tsd-kind-module tsd-is-not-exported"><a href="modules/reflection-762.html" class="tsd-kind-icon"><em>Module</em></a></li>
+								<li class="tsd-kind-module tsd-is-not-exported"><a href="modules/reflection-790.html" class="tsd-kind-icon"><em>Module</em></a></li>
 								<li class="tsd-kind-module"><a href="modules/types.html" class="tsd-kind-icon">types</a></li>
 								<li class="tsd-kind-module"><a href="modules/utils.html" class="tsd-kind-icon">utils</a></li>
 							</ul>

sasjs-tests/src/App.tsx

@@ -5,6 +5,7 @@ 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);
@@ -17,7 +18,8 @@ const App = (): ReactElement<{}> => {
         sendArrTests(adapter),
         sendObjTests(adapter),
         specialCaseTests(adapter),
-        sasjsRequestTests(adapter)
+        sasjsRequestTests(adapter),
+        computeTests(adapter)
       ]);
     }
   }, [adapter, config]);

sasjs-tests/src/testSuites/Compute.ts

@@ -0,0 +1,41 @@
+import SASjs from "@sasjs/adapter";
+import { TestSuite } from "@sasjs/test-framework";
+
+export const computeTests = (adapter: SASjs): TestSuite => ({
+  name: "Compute",
+  tests: [
+    {
+      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);
+      },
+      assertion: (res: any) => {
+        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",
+      test: () => {
+        const data: any = { table1: [{ col1: "first col value" }] };
+        return adapter.startComputeJob("/Public/app/common/sendArr", data, {}, "", true);
+      },
+      assertion: (res: any) => {
+        const expectedProperties = ["id", "state", "creationTimeStamp", "jobConditionCode"]
+        return validate(expectedProperties, res);
+      }
+    }
+  ]
+});
+
+const validate = (expectedProperties: string[], data: any): boolean => {
+  const actualProperties = Object.keys(data);
+
+        const isValid = expectedProperties.every(
+          (property) => actualProperties.includes(property)
+        );
+        return isValid
+}

src/FileUploader.ts

@@ -1,6 +1,7 @@
 import { isLogInRequired, needsRetry, isUrl } from './utils'
 import { CsrfToken } from './types/CsrfToken'
 import { UploadFile } from './types/UploadFile'
+import { ErrorResponse } from './types'
 
 const requestRetryLimit = 5
 
@@ -18,29 +19,31 @@ export class FileUploader {
   private retryCount = 0
 
   public uploadFile(sasJob: string, files: UploadFile[], params: any) {
-    if (files?.length < 1)
-      throw new Error('At least one file 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.serverUrl}${this.jobsPath}/?${
-      '_program=' + program
-    }${paramsString}`
-
-    const headers = {
-      'cache-control': 'no-cache'
-    }
-
     return new Promise((resolve, reject) => {
+      if (files?.length < 1)
+        reject(new ErrorResponse('At least one file must be provided.'))
+      if (!sasJob || sasJob === '')
+        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.serverUrl}${this.jobsPath}/?${
+        '_program=' + program
+      }${paramsString}`
+
+      const headers = {
+        'cache-control': 'no-cache'
+      }
+
       const formData = new FormData()
 
       for (let file of files) {
@@ -76,7 +79,7 @@ export class FileUploader {
         })
         .then((responseText) => {
           if (isLogInRequired(responseText))
-            reject('You must be logged in to upload a file')
+            reject(new ErrorResponse('You must be logged in to upload a file.'))
 
           if (needsRetry(responseText)) {
             if (this.retryCount < requestRetryLimit) {
@@ -95,10 +98,18 @@ export class FileUploader {
             try {
               resolve(JSON.parse(responseText))
             } catch (e) {
-              reject(e)
+              reject(
+                new ErrorResponse(
+                  'Error while parsing json from upload response.',
+                  e
+                )
+              )
             }
           }
         })
+        .catch((err: any) => {
+          reject(new ErrorResponse('Upload request failed.', err))
+        })
     })
   }
 }

src/SASViyaApiClient.ts

@@ -52,7 +52,9 @@ export class SASViyaApiClient {
 
   public set debug(value: boolean) {
     this._debug = value
-    this.sessionManager.debug = value
+    if (this.sessionManager) {
+      this.sessionManager.debug = value
+    }
   }
 
   /**
@@ -152,6 +154,7 @@ export class SASViyaApiClient {
           context.name,
           accessToken,
           null,
+          true,
           true
         ).catch((err) => err)
     })
@@ -434,7 +437,8 @@ export class SASViyaApiClient {
     contextName: string,
     accessToken?: string,
     data = null,
-    expectWebout = false
+    expectWebout = false,
+    waitForResult = true
   ): Promise<any> {
     try {
       const headers: any = {
@@ -527,6 +531,10 @@ export class SASViyaApiClient {
         throw err
       })
 
+      if (!waitForResult) {
+        return session
+      }
+
       if (this.debug) {
         console.log(`Job has been submitted for '${fileName}'.`)
         console.log(
@@ -573,6 +581,8 @@ export class SASViyaApiClient {
 
       if (expectWebout) {
         resultLink = `/compute/sessions/${executionSessionId}/filerefs/_webout/content`
+      } else {
+        return currentJob
       }
 
       if (resultLink) {
@@ -597,7 +607,7 @@ export class SASViyaApiClient {
                 })
 
               return Promise.reject(
-                new ErrorResponse('Job execution failed', {
+                new ErrorResponse('Job execution failed.', {
                   status: 500,
                   body: log
                 })
@@ -624,7 +634,9 @@ export class SASViyaApiClient {
           linesOfCode,
           contextName,
           accessToken,
-          data
+          data,
+          false,
+          true
         )
       } else {
         throw e
@@ -937,13 +949,16 @@ export class SASViyaApiClient {
    * @param debug - sets the _debug flag in the job arguments.
    * @param data - any data to be passed in as input to the job.
    * @param accessToken - an optional access token for an authorized user.
+   * @param waitForResult - a boolean indicating if the function should wait for a result.
+   * @param expectWebout - a boolean indicating whether to expect a _webout response.
    */
   public async executeComputeJob(
     sasJob: string,
     contextName: string,
-    debug: boolean,
     data?: any,
-    accessToken?: string
+    accessToken?: string,
+    waitForResult = true,
+    expectWebout = false
   ) {
     if (isRelativePath(sasJob) && !this.rootFolderName) {
       throw new Error(
@@ -1017,6 +1032,8 @@ export class SASViyaApiClient {
       jobToExecute.code = code
     }
 
+    if (!code) code = ''
+
     const linesToExecute = code.replace(/\r\n/g, '\n').split('\n')
     return await this.executeScript(
       sasJob,
@@ -1024,7 +1041,8 @@ export class SASViyaApiClient {
       contextName,
       accessToken,
       data,
-      true
+      expectWebout,
+      waitForResult
     )
   }
 
@@ -1096,7 +1114,7 @@ export class SASViyaApiClient {
     }
 
     if (!jobToExecute) {
-      throw new Error(`The job ${sasJob} was not found.`)
+      throw new Error(`Job was not found.`)
     }
     const jobDefinitionLink = jobToExecute?.links.find(
       (l) => l.rel === 'getResource'

src/SASjs.ts

@@ -44,7 +44,7 @@ const defaultConfig: SASjsConfig = {
   pathSASViya: '/SASJobExecution',
   appLoc: '/Public/seedapp',
   serverType: ServerType.SASViya,
-  debug: true,
+  debug: false,
   contextName: 'SAS Job Execution compute context',
   useComputeApi: false
 }
@@ -670,6 +670,50 @@ export default class SASjs {
     )
   }
 
+  /**
+   * Kicks off execution of the given job via the compute API.
+   * @returns an object representing the compute session created for the given job.
+   * @param sasJob - the path to the SAS program (ultimately resolves to
+   *  the SAS `_program` parameter to run a Job Definition or SAS 9 Stored
+   *  Process). Is prepended at runtime with the value of `appLoc`.
+   * @param data - a JSON object containing one or more tables to be sent to
+   * SAS. Can be `null` if no inputs required.
+   * @param config - provide any changes to the config here, for instance to
+   * enable/disable `debug`. Any change provided will override the global config,
+   * for that particular function call.
+   * @param accessToken - a valid access token that is 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.
+   */
+  public async startComputeJob(
+    sasJob: string,
+    data: any,
+    config: any = {},
+    accessToken?: string,
+    waitForResult?: boolean
+  ) {
+    config = {
+      ...this.sasjsConfig,
+      ...config
+    }
+
+    this.isMethodSupported('startComputeJob', ServerType.SASViya)
+    if (!config.contextName) {
+      throw new Error(
+        'Context name is undefined. Please set a `contextName` in your SASjs or override config.'
+      )
+    }
+
+    return this.sasViyaApiClient?.executeComputeJob(
+      sasJob,
+      config.contextName,
+      data,
+      accessToken,
+      !!waitForResult,
+      false
+    )
+  }
+
   private async executeJobViaComputeApi(
     sasJob: string,
     data: any,
@@ -689,13 +733,16 @@ export default class SASjs {
 
     sasjsWaitingRequest.requestPromise.promise = new Promise(
       async (resolve, reject) => {
+        const waitForResult = true
+        const expectWebout = true
         this.sasViyaApiClient
           ?.executeComputeJob(
             sasJob,
             config.contextName,
-            config.debug,
             data,
-            accessToken
+            accessToken,
+            waitForResult,
+            expectWebout
           )
           .then((response) => {
             if (!config.debug) {
@@ -733,11 +780,23 @@ export default class SASjs {
               } else {
                 this.retryCountComputeApi = 0
                 reject(
-                  new ErrorResponse('Compute API retry requests limit reached')
+                  new ErrorResponse('Compute API retry requests limit reached.')
                 )
               }
             }
 
+            if (response?.log) {
+              this.appendSasjsRequest(response.log, sasJob, null)
+            }
+
+            if (error.toString().includes('Job was not found')) {
+              reject(
+                new ErrorResponse('Service not found on the server.', {
+                  sasJob: sasJob
+                })
+              )
+            }
+
             if (error && error.status === 401) {
               if (loginRequiredCallback) loginRequiredCallback(true)
               sasjsWaitingRequest.requestPromise.resolve = resolve
@@ -745,10 +804,8 @@ export default class SASjs {
               sasjsWaitingRequest.config = config
               this.sasjsWaitingRequests.push(sasjsWaitingRequest)
             } else {
-              reject(new ErrorResponse('Job execution failed', error))
+              reject(new ErrorResponse('Job execution failed.', error))
             }
-
-            this.appendSasjsRequest(response.log, sasJob, null)
           })
       }
     )
@@ -828,12 +885,24 @@ export default class SASjs {
                   } else {
                     this.retryCountJeseApi = 0
                     reject(
-                      new ErrorResponse('Jes API retry requests limit reached')
+                      new ErrorResponse('Jes API retry requests limit reached.')
                     )
                   }
                 }
 
-                reject(new ErrorResponse('Job execution failed', e))
+                if (e?.log) {
+                  this.appendSasjsRequest(e.log, sasJob, null)
+                }
+
+                if (e.toString().includes('Job was not found')) {
+                  reject(
+                    new ErrorResponse('Service not found on the server.', {
+                      sasJob: sasJob
+                    })
+                  )
+                }
+
+                reject(new ErrorResponse('Job execution failed.', e))
               })
           )
         }
@@ -1017,7 +1086,7 @@ export default class SASjs {
                   } else {
                     reject(
                       new ErrorResponse(
-                        'Job WEB execution failed',
+                        'Job WEB execution failed.',
                         this.parseSAS9ErrorResponse(responseText)
                       )
                     )
@@ -1035,7 +1104,7 @@ export default class SASjs {
                         } catch (e) {
                           reject(
                             new ErrorResponse(
-                              'Job WEB debug response parsing failed',
+                              'Job WEB debug response parsing failed.',
                               { response: resText, exception: e }
                             )
                           )
@@ -1044,7 +1113,7 @@ export default class SASjs {
                       (err: any) => {
                         reject(
                           new ErrorResponse(
-                            'Job WEB debug response parsing failed',
+                            'Job WEB debug response parsing failed.',
                             err
                           )
                         )
@@ -1053,19 +1122,34 @@ export default class SASjs {
                   } catch (e) {
                     reject(
                       new ErrorResponse(
-                        'Job WEB debug response parsing failed',
+                        'Job WEB debug response parsing failed.',
                         { response: responseText, exception: e }
                       )
                     )
                   }
                 } else {
                   this.updateUsername(responseText)
+                  if (
+                    responseText.includes(
+                      'The requested URL /SASStoredProcess/do/ was not found on this server.'
+                    ) ||
+                    responseText.includes('Stored process not found')
+                  ) {
+                    reject(
+                      new ErrorResponse(
+                        'Service not found on the server.',
+                        { service: sasJob },
+                        responseText
+                      )
+                    )
+                  }
+
                   try {
                     const parsedJson = JSON.parse(responseText)
                     resolve(parsedJson)
                   } catch (e) {
                     reject(
-                      new ErrorResponse('Job WEB response parsing failed', {
+                      new ErrorResponse('Job WEB response parsing failed.', {
                         response: responseText,
                         exception: e
                       })
@@ -1076,7 +1160,7 @@ export default class SASjs {
             }
           })
           .catch((e: Error) => {
-            reject(new ErrorResponse('Job WEB request failed', e))
+            reject(new ErrorResponse('Job WEB request failed.', e))
           })
       }
     )
@@ -1217,10 +1301,20 @@ export default class SASjs {
     }
   }
 
-  private fetchLogFileContent(logLink: string) {
+  /**
+   * Fetches content of the log file
+   * @param logLink - url of the log file.
+   * @param accessToken - an access token for an authorized user.
+   */
+  public fetchLogFileContent(logLink: string, accessToken?: string) {
+    const headers: any = { 'Content-Type': 'application/json' }
+
+    if (accessToken) headers.Authorization = 'Bearer ' + accessToken
+
     return new Promise((resolve, reject) => {
       fetch(logLink, {
-        method: 'GET'
+        method: 'GET',
+        headers
       })
         .then((response: any) => response.text())
         .then((response: any) => resolve(response))
@@ -1318,11 +1412,15 @@ export default class SASjs {
       this.sasjsConfig.serverUrl === undefined ||
       this.sasjsConfig.serverUrl === ''
     ) {
-      let url = `${location.protocol}//${location.hostname}`
-      if (location.port) {
-        url = `${url}:${location.port}`
+      if (typeof location !== 'undefined') {
+        let url = `${location.protocol}//${location.hostname}`
+
+        if (location.port) url = `${url}:${location.port}`
+
+        this.sasjsConfig.serverUrl = url
+      } else {
+        this.sasjsConfig.serverUrl = ''
       }
-      this.sasjsConfig.serverUrl = url
     }
 
     if (this.sasjsConfig.serverUrl.slice(-1) === '/') {

src/test/FileUploader.spec.ts

@@ -0,0 +1,137 @@
+import { FileUploader } from '../FileUploader'
+import { UploadFile } from '../types'
+
+const sampleResponse = `{
+  "SYSUSERID": "cas",
+  "_DEBUG":" ",
+  "SYS_JES_JOB_URI": "/jobExecution/jobs/000-000-000-000",
+  "_PROGRAM" : "/Public/app/editors/loadfile",
+  "SYSCC" : "0",
+  "SYSJOBID" : "117382",
+  "SYSWARNINGTEXT" : ""
+}`
+
+const prepareFilesAndParams = () => {
+  const files: UploadFile[] = [
+    {
+      file: new File([''], 'testfile'),
+      fileName: 'testfile'
+    }
+  ]
+  const params = { table: 'libtable' }
+
+  return { files, params }
+}
+
+describe('FileUploader', () => {
+  let originalFetch: any
+  const fileUploader = new FileUploader(
+    '/sample/apploc',
+    'https://sample.server.com',
+    '/jobs/path',
+    null,
+    null
+  )
+
+  beforeAll(() => {
+    originalFetch = (global as any).fetch
+  })
+
+  beforeEach(() => {
+    ;(global as any).fetch = jest.fn().mockImplementation(() =>
+      Promise.resolve({
+        text: () => Promise.resolve(sampleResponse)
+      })
+    )
+  })
+
+  afterAll(() => {
+    ;(global as any).fetch = originalFetch
+  })
+
+  it('should upload successfully', async (done) => {
+    const sasJob = 'test/upload'
+    const { files, params } = prepareFilesAndParams()
+
+    fileUploader.uploadFile(sasJob, files, params).then((res: any) => {
+      expect(JSON.stringify(res)).toEqual(
+        JSON.stringify(JSON.parse(sampleResponse))
+      )
+      done()
+    })
+  })
+
+  it('should an error when no files are provided', async (done) => {
+    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()
+    })
+  })
+
+  it('should throw an error when no sasJob is provided', async (done) => {
+    const sasJob = ''
+    const { files, params } = prepareFilesAndParams()
+
+    fileUploader.uploadFile(sasJob, files, params).catch((err: any) => {
+      expect(err.error.message).toEqual('sasJob must be provided.')
+      done()
+    })
+  })
+
+  it('should throw an error when login is required', async (done) => {
+    ;(global as any).fetch = jest.fn().mockImplementation(() =>
+      Promise.resolve({
+        text: () => Promise.resolve('<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) => {
+    ;(global as any).fetch = jest.fn().mockImplementation(() =>
+      Promise.resolve({
+        text: () => Promise.resolve('{invalid: "json"')
+      })
+    )
+
+    const sasJob = 'test'
+    const { files, params } = prepareFilesAndParams()
+
+    fileUploader.uploadFile(sasJob, files, params).catch((err: any) => {
+      expect(err.error.message).toEqual(
+        'Error while parsing json from upload response.'
+      )
+      done()
+    })
+  })
+
+  it('should throw an error when the server request fails', async (done) => {
+    ;(global as any).fetch = jest.fn().mockImplementation(() =>
+      Promise.resolve({
+        text: () => Promise.reject('{message: "Server error"}')
+      })
+    )
+
+    const sasJob = 'test'
+    const { files, params } = prepareFilesAndParams()
+
+    fileUploader.uploadFile(sasJob, files, params).catch((err: any) => {
+      expect(err.error.message).toEqual('Upload request failed.')
+
+      done()
+    })
+  })
+})

src/test/utils/parseGeneratedCode.spec.ts

@@ -1,4 +1,4 @@
-import { parseGeneratedCode } from './index'
+import { parseGeneratedCode } from '../../utils/index'
 
 it('should parse generated code', async (done) => {
   expect(sampleResponse).toBeTruthy()

src/test/utils/parseSourceCode.spec.ts

@@ -1,4 +1,4 @@
-import { parseSourceCode } from './index'
+import { parseSourceCode } from '../../utils/index'
 
 it('should parse SAS9 source code', async (done) => {
   expect(sampleResponse).toBeTruthy()

src/types/ErrorResponse.ts

@@ -1,17 +1,19 @@
 export class ErrorResponse {
-  body: ErrorBody
+  error: ErrorBody
 
-  constructor(message: string, details?: any) {
-    let detailsString = ''
-    let raw
+  constructor(message: string, details?: any, raw?: any) {
+    let detailsString = details
 
-    try {
-      detailsString = JSON.stringify(details)
-    } catch {
-      raw = details
+    if (typeof details !== 'object') {
+      try {
+        detailsString = JSON.parse(details)
+      } catch {
+        raw = details
+        detailsString = ''
+      }
     }
 
-    this.body = {
+    this.error = {
       message,
       details: detailsString,
       raw