Merge pull request #476 from sasjs/issue-170

fix: file upload with debug enabled

src/FileUploader.ts

@@ -1,4 +1,4 @@
-import { isUrl } from './utils'
+import { isUrl, getValidJson, parseSasViyaDebugResponse } from './utils'
 import { UploadFile } from './types/UploadFile'
 import { ErrorResponse, LoginRequiredError } from './types/errors'
 import { RequestClient } from './request/RequestClient'
@@ -63,13 +63,28 @@ export class FileUploader {
 
     return this.requestClient
       .post(uploadUrl, formData, undefined, 'application/json', headers)
-      .then((res) => {
-        let result
+      .then(async (res) => {
+        // for web approach on Viya
+        if (
+          this.sasjsConfig.debug &&
+          (this.sasjsConfig.useComputeApi === null ||
+            this.sasjsConfig.useComputeApi === undefined) &&
+          this.sasjsConfig.serverType === ServerType.SasViya
+        ) {
+          const jsonResponse = await parseSasViyaDebugResponse(
+            res.result as string,
+            this.requestClient,
+            this.sasjsConfig.serverUrl
+          )
+          return typeof jsonResponse === 'string'
+            ? getValidJson(jsonResponse)
+            : jsonResponse
+        }
 
-        result =
-          typeof res.result === 'string' ? JSON.parse(res.result) : res.result
+        return typeof res.result === 'string'
+          ? getValidJson(res.result)
+          : res.result
 
-        return result
         //TODO: append to SASjs requests
       })
       .catch((err: Error) => {

src/SASjs.ts

@@ -544,11 +544,22 @@ 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 overrideSasjsConfig - object to override existing config (optional)
    */
-  public uploadFile(sasJob: string, files: UploadFile[], params: any) {
-    const fileUploader =
-      this.fileUploader ||
-      new FileUploader(this.sasjsConfig, this.jobsPath, this.requestClient!)
+  public uploadFile(
+    sasJob: string,
+    files: UploadFile[],
+    params: any,
+    overrideSasjsConfig?: any
+  ) {
+    const fileUploader = overrideSasjsConfig
+      ? new FileUploader(
+          { ...this.sasjsConfig, ...overrideSasjsConfig },
+          this.jobsPath,
+          this.requestClient!
+        )
+      : this.fileUploader ||
+        new FileUploader(this.sasjsConfig, this.jobsPath, this.requestClient!)
 
     return fileUploader.uploadFile(sasJob, files, params)
   }

src/job-execution/WebJobExecutor.ts

@@ -8,7 +8,11 @@ import { generateFileUploadForm } from '../file/generateFileUploadForm'
 import { generateTableUploadForm } from '../file/generateTableUploadForm'
 import { RequestClient } from '../request/RequestClient'
 import { SASViyaApiClient } from '../SASViyaApiClient'
-import { isRelativePath, isValidJson } from '../utils'
+import {
+  isRelativePath,
+  getValidJson,
+  parseSasViyaDebugResponse
+} from '../utils'
 import { BaseJobExecutor } from './JobExecutor'
 import { parseWeboutResponse } from '../utils/parseWeboutResponse'
 
@@ -95,8 +99,10 @@ export class WebJobExecutor extends BaseJobExecutor {
       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
+            const jsonResponse = await parseSasViyaDebugResponse(
+              res.result as string,
+              this.requestClient,
+              this.serverUrl
             )
             this.appendRequest(res, sasJob, config.debug)
             resolve(jsonResponse)
@@ -109,11 +115,11 @@ export class WebJobExecutor extends BaseJobExecutor {
               )
             }
 
-            isValidJson(jsonResponse)
+            getValidJson(jsonResponse)
             this.appendRequest(res, sasJob, config.debug)
             resolve(res.result)
           }
-          isValidJson(res.result as string)
+          getValidJson(res.result as string)
           this.appendRequest(res, sasJob, config.debug)
           resolve(res.result)
         })
@@ -151,20 +157,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/request/RequestClient.ts

@@ -11,7 +11,7 @@ import {
 import { parseWeboutResponse } from '../utils/parseWeboutResponse'
 import { prefixMessage } from '@sasjs/utils/error'
 import { SAS9AuthError } from '../types/errors/SAS9AuthError'
-import { isValidJson } from '../utils'
+import { getValidJson } from '../utils'
 
 export interface HttpClient {
   get<T>(
@@ -434,7 +434,7 @@ export class RequestClient implements HttpClient {
           throw new Error('Valid JSON could not be extracted from response.')
         }
 
-        const jsonResponse = isValidJson(weboutResponse)
+        const jsonResponse = getValidJson(weboutResponse)
         parsedResponse = jsonResponse
       } catch {
         parsedResponse = response.data

src/test/utils/getValidJson.spec.ts

@@ -0,0 +1,41 @@
+import { getValidJson } from '../../utils'
+
+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\"}`
+    let errorThrown = false
+    try {
+      getValidJson(json)
+    } catch (error) {
+      errorThrown = true
+    }
+    expect(errorThrown).toBe(true)
+  })
+
+  it('should throw an error when an array is passed', () => {
+    const array = ['hello', 'world']
+    let errorThrown = false
+    try {
+      getValidJson(array)
+    } catch (error) {
+      errorThrown = true
+    }
+    expect(errorThrown).toBe(true)
+  })
+})

src/test/utils/isValidJson.spec.ts

@@ -1,31 +0,0 @@
-import { isValidJson } from '../../utils'
-
-describe('jsonValidator', () => {
-  it('should not throw an error with an valid json', () => {
-    const json = {
-      test: 'test'
-    }
-
-    expect(isValidJson(json)).toBe(json)
-  })
-
-  it('should not throw an error with an valid json string', () => {
-    const json = {
-      test: 'test'
-    }
-
-    expect(isValidJson(JSON.stringify(json))).toStrictEqual(json)
-  })
-
-  it('should throw an error with an invalid json', () => {
-    const json = `{\"test\":\"test\"\"test2\":\"test\"}`
-
-    expect(() => {
-      try {
-        isValidJson(json)
-      } catch (err) {
-        throw new Error()
-      }
-    }).toThrowError
-  })
-})

src/utils/getValidJson.ts

@@ -0,0 +1,16 @@
+/**
+ * if string passed then parse the string to json else if throw error for all other types unless it is not a valid json object.
+ * @param str - string to check.
+ */
+export const getValidJson = (str: string | object) => {
+  try {
+    if (Array.isArray(str)) {
+      throw new Error('Can not parse array object to json.')
+    }
+    if (typeof str === 'object') return str
+
+    return JSON.parse(str)
+  } catch (e) {
+    throw new Error('Invalid JSON response.')
+  }
+}

src/utils/index.ts

@@ -12,4 +12,5 @@ export * from './serialize'
 export * from './splitChunks'
 export * from './parseWeboutResponse'
 export * from './fetchLogByChunks'
-export * from './isValidJson'
+export * from './getValidJson'
+export * from './parseViyaDebugResponse'

src/utils/isValidJson.ts

@@ -1,13 +0,0 @@
-/**
- * Checks if string is in valid JSON format else throw error.
- * @param str - string to check.
- */
-export const isValidJson = (str: string | object) => {
-  try {
-    if (typeof str === 'object') return str
-
-    return JSON.parse(str)
-  } catch (e) {
-    throw new Error('Invalid JSON response.')
-  }
-}

src/utils/parseViyaDebugResponse.ts

@@ -0,0 +1,29 @@
+import { RequestClient } from '../request/RequestClient'
+
+/**
+ * When querying a Viya job using the Web approach (as opposed to using the APIs) with _DEBUG enabled,
+ * the first response contains the log with the content in an iframe. Therefore when debug is enabled,
+ * and the serverType is VIYA, and useComputeApi is null (WEB), we call this function to extract the
+ * (_webout) content from the iframe.
+ * @param response - first response from viya job
+ * @param requestClient
+ * @param serverUrl
+ * @returns
+ */
+export const parseSasViyaDebugResponse = async (
+  response: string,
+  requestClient: RequestClient,
+  serverUrl: 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 requestClient
+    .get(serverUrl + jsonUrl, undefined)
+    .then((res) => res.result)
+}