@sasjs/adapter 4.16.6 → 4.17.0

package/node/job-execution/WebJobExecutor.d.ts

@@ -13,5 +13,6 @@ export declare class WebJobExecutor extends BaseJobExecutor {
     private sasViyaApiClient;
     constructor(serverUrl: string, serverType: ServerType, jobsPath: string, requestClient: RequestClient, sasViyaApiClient: SASViyaApiClient);
     execute(sasJob: string, data: any, config: any, loginRequiredCallback?: any, authConfig?: AuthConfig, extraResponseAttributes?: ExtraResponseAttributes[]): Promise<unknown>;
+    protected getRequestParams(config: any): any;
     private getJobUri;
 }

package/node/types/SASjsConfig.d.ts

@@ -79,6 +79,14 @@ export declare class SASjsConfig {
      * may affect browser performance, especially with debug (logs) enabled.
      */
     requestHistoryLimit?: number;
+    /**
+     * Optional setting. When `true`, the request runs as a Viya execution task —
+     * appends `_executionTasks=true` to the request URL. Only applies to the Viya
+     * web jobs path, i.e. when `serverType === SASVIYA` AND
+     * `useComputeApi` is `null`/`undefined`. Has no effect when `useComputeApi`
+     * is explicitly set to `true` or `false`.
+     */
+    runAsTask?: boolean;
 }
 export declare enum LoginMechanism {
     Default = "Default",

package/node/utils/index.d.ts

@@ -15,6 +15,7 @@ export * from './parseGeneratedCode';
 export * from './parseSasViyaLog';
 export * from './parseSourceCode';
 export * from './parseViyaDebugResponse';
+export * from './parseViyaLogDebugResponse';
 export * from './parseWeboutResponse';
 export * from './serialize';
 export * from './splitChunks';

package/node/utils/parseViyaLogDebugResponse.d.ts

@@ -0,0 +1,10 @@
+/**
+ * When querying a Viya job using the Web approach with _DEBUG=128 (used when
+ * runAsTask is true), the webout JSON is inlined into the response via:
+ *   var blob = new Blob([`{...}`], {type: 'application/json'});
+ * On abort/error paths the same shape is used but with text/plain and
+ * weboutBEGIN/END markers around the JSON:
+ *   var blob = new Blob([`>>weboutBEGIN<<\n{...}\n>>weboutEND<<\n`], {type: 'text/plain'});
+ * No follow-up request is needed — extract and parse the JSON directly.
+ */
+export declare const parseSasViyaLogDebugResponse: (response: any) => Promise<any>;

package/package.json

@@ -77,11 +77,11 @@
   "main": "index.js",
   "dependencies": {
     "@sasjs/utils": "^3.5.6",
-    "axios": "1.15.0",
+    "axios": "1.16.0",
     "axios-cookiejar-support": "5.0.5",
     "form-data": "4.0.4",
     "https": "1.0.0",
     "tough-cookie": "4.1.3"
   },
-  "version": "4.16.6"
+  "version": "4.17.0"
 }

package/src/SASViyaApiClient.ts

@@ -1031,11 +1031,17 @@ export class SASViyaApiClient {
       jobArguments[`_webin_name${index + 1}`] = fileInfo.tableName
     })
 
+    // Viya JES requires arguments to be Map<String,String>; coerce booleans/numbers.
+    const stringifiedArguments: { [key: string]: string } = {}
+    for (const k of Object.keys(jobArguments)) {
+      stringifiedArguments[k] = String(jobArguments[k])
+    }
+
     const postJobRequestBody = {
       name: `exec-${jobName}`,
       description: 'Powered by SASjs',
       jobDefinition,
-      arguments: jobArguments
+      arguments: stringifiedArguments
     }
 
     const { result: postedJob } = await this.requestClient.post<Job>(

package/src/api/viya/uploadTables.ts

@@ -1,6 +1,6 @@
 import { prefixMessage } from '@sasjs/utils/error'
 import { RequestClient } from '../../request/RequestClient'
-import { convertToCSV } from '../../utils/convertToCsv'
+import { convertToCSV, isFormatsTable } from '../../utils/convertToCsv'
 
 /**
  * Uploads tables to SAS as specially formatted CSVs.
@@ -18,6 +18,10 @@ export async function uploadTables(
   const uploadedFiles = []
 
   for (const tableName in data) {
+    // $tablename keys carry only column-format metadata for the matching
+    // tablename payload; they must not be uploaded as separate files.
+    if (isFormatsTable(tableName)) continue
+
     const csv = convertToCSV(data, tableName)
     if (csv === 'ERROR: LARGE STRING LENGTH') {
       throw new Error(

package/src/file/generateTableUploadForm.ts

@@ -11,6 +11,13 @@ export const generateTableUploadForm = (
   let tableCounter = 0
 
   for (const tableName in data) {
+    if (
+      isFormatsTable(tableName) &&
+      Object.keys(data).includes(tableName.replace(/^\$/, ''))
+    ) {
+      continue
+    }
+
     tableCounter++
 
     // Formats table should not be sent as part of 'sasjs_tables'

package/src/job-execution/JobExecutor.ts

@@ -55,7 +55,6 @@ export abstract class BaseJobExecutor implements JobExecutor {
     if (config.debug) {
       requestParams['_omittextlog'] = 'false'
       requestParams['_omitSessionResults'] = 'false'
-
       requestParams['_debug'] = 131
     }
 

package/src/job-execution/WebJobExecutor.ts

@@ -16,9 +16,11 @@ import { SASViyaApiClient } from '../SASViyaApiClient'
 import {
   isRelativePath,
   parseSasViyaDebugResponse,
+  parseSasViyaLogDebugResponse,
   appendExtraResponseAttributes,
   parseWeboutResponse,
-  getFormData
+  getFormData,
+  isNode
 } from '../utils'
 import { BaseJobExecutor } from './JobExecutor'
 
@@ -101,6 +103,10 @@ export class WebJobExecutor extends BaseJobExecutor {
       apiUrl += config.contextName?.trim()
         ? `&_contextname=${encodeURIComponent(config.contextName)}`
         : ''
+
+      if (config.runAsTask === true) {
+        apiUrl += '&_executionTasks=true'
+      }
     }
 
     let requestParams = {
@@ -113,6 +119,26 @@ export class WebJobExecutor extends BaseJobExecutor {
      */
     let formData = getFormData()
 
+    // FIXME(viya - SAS Track CS0409737): remove when Viya stops rejecting empty multipart on
+    // _executionTasks=true. Dummy file keeps the body non-empty
+    const hasExecutionTasksFlag = config.runAsTask === true
+
+    // Move debug params to URL for viya; viya seems to honor them more
+    // reliably in the query string than the multipart body.
+    if (
+      hasExecutionTasksFlag &&
+      config.debug &&
+      config.serverType === ServerType.SasViya
+    ) {
+      const debugKeys = ['_debug', '_omitSessionResults']
+      debugKeys.forEach((key) => {
+        if (requestParams[key] !== undefined) {
+          apiUrl += `&${key}=${encodeURIComponent(requestParams[key])}`
+          delete requestParams[key]
+        }
+      })
+    }
+
     if (data) {
       const stringifiedData = JSON.stringify(data)
       if (
@@ -133,10 +159,21 @@ export class WebJobExecutor extends BaseJobExecutor {
             generateTableUploadForm(formData, data)
           formData = newFormData
           requestParams = { ...requestParams, ...params }
+
+          if (
+            config.serverType === ServerType.SasViya &&
+            hasExecutionTasksFlag
+          ) {
+            addDummyFile(formData)
+          }
         } catch (e: any) {
           return Promise.reject(new ErrorResponse(e?.message, e))
         }
       }
+    } else {
+      if (config.serverType === ServerType.SasViya && hasExecutionTasksFlag) {
+        addDummyFile(formData)
+      }
     }
 
     for (const key in requestParams) {
@@ -168,11 +205,14 @@ export class WebJobExecutor extends BaseJobExecutor {
           if (config.debug) {
             switch (this.serverType) {
               case ServerType.SasViya:
-                jsonResponse = await parseSasViyaDebugResponse(
-                  res.result,
-                  this.requestClient,
-                  this.serverUrl
-                )
+                jsonResponse =
+                  config.useComputeApi === null && config.runAsTask === true
+                    ? await parseSasViyaLogDebugResponse(res.result)
+                    : await parseSasViyaDebugResponse(
+                        res.result,
+                        this.requestClient,
+                        this.serverUrl
+                      )
                 break
               case ServerType.Sas9:
                 jsonResponse =
@@ -231,6 +271,23 @@ export class WebJobExecutor extends BaseJobExecutor {
     return requestPromise
   }
 
+  protected getRequestParams(config: any): any {
+    const requestParams = super.getRequestParams(config)
+
+    // FIXME(viya - possible issue with default debug flags)
+    // runAsTask on Viya: use _debug=128 (not 131) and omit _omittextlog
+    if (
+      config.debug &&
+      config.serverType === ServerType.SasViya &&
+      config.runAsTask === true
+    ) {
+      requestParams['_debug'] = 128
+      delete requestParams['_omittextlog']
+    }
+
+    return requestParams
+  }
+
   private async getJobUri(sasJob: string) {
     if (!this.sasViyaApiClient) return ''
     let uri = ''
@@ -263,3 +320,18 @@ export class WebJobExecutor extends BaseJobExecutor {
     return uri
   }
 }
+
+function addDummyFile(formData: NodeFormData | FormData) {
+  if (isNode()) {
+    ;(formData as NodeFormData).append('_sasjs_noop', '', {
+      filename: '_sasjs_noop.txt',
+      contentType: 'text/plain'
+    })
+  } else {
+    ;(formData as FormData).append(
+      '_sasjs_noop',
+      new Blob([''], { type: 'text/plain' }),
+      '_sasjs_noop.txt'
+    )
+  }
+}

package/src/types/SASjsConfig.ts

@@ -79,6 +79,14 @@ export class SASjsConfig {
    * may affect browser performance, especially with debug (logs) enabled.
    */
   requestHistoryLimit?: number = 10
+  /**
+   * Optional setting. When `true`, the request runs as a Viya execution task —
+   * appends `_executionTasks=true` to the request URL. Only applies to the Viya
+   * web jobs path, i.e. when `serverType === SASVIYA` AND
+   * `useComputeApi` is `null`/`undefined`. Has no effect when `useComputeApi`
+   * is explicitly set to `true` or `false`.
+   */
+  runAsTask?: boolean = false
 }
 
 export enum LoginMechanism {

package/src/utils/index.ts

@@ -15,6 +15,7 @@ export * from './parseGeneratedCode'
 export * from './parseSasViyaLog'
 export * from './parseSourceCode'
 export * from './parseViyaDebugResponse'
+export * from './parseViyaLogDebugResponse'
 export * from './parseWeboutResponse'
 export * from './serialize'
 export * from './splitChunks'

package/src/utils/parseViyaLogDebugResponse.ts

@@ -0,0 +1,32 @@
+import { getValidJson } from './getValidJson'
+import { parseWeboutResponse } from './parseWeboutResponse'
+
+/**
+ * When querying a Viya job using the Web approach with _DEBUG=128 (used when
+ * runAsTask is true), the webout JSON is inlined into the response via:
+ *   var blob = new Blob([`{...}`], {type: 'application/json'});
+ * On abort/error paths the same shape is used but with text/plain and
+ * weboutBEGIN/END markers around the JSON:
+ *   var blob = new Blob([`>>weboutBEGIN<<\n{...}\n>>weboutEND<<\n`], {type: 'text/plain'});
+ * No follow-up request is needed — extract and parse the JSON directly.
+ */
+export const parseSasViyaLogDebugResponse = async (response: any) => {
+  // If upstream already parsed the response as JSON (object), pass through.
+  if (typeof response !== 'string') {
+    return response
+  }
+
+  const blobMatch = response.match(
+    /new Blob\(\[`([\s\S]*?)`\],\s*\{type:\s*'(?:application\/json|text\/plain)'\}\)/
+  )
+  if (!blobMatch) {
+    throw new Error('Unable to find webout blob in debug log response.')
+  }
+
+  const blobContent = blobMatch[1]
+  const stripped = blobContent.includes('>>weboutBEGIN<<')
+    ? parseWeboutResponse(blobContent)
+    : blobContent
+
+  return getValidJson(stripped)
+}

package/types/SASjsConfig.d.ts

@@ -79,6 +79,14 @@ export declare class SASjsConfig {
      * may affect browser performance, especially with debug (logs) enabled.
      */
     requestHistoryLimit?: number;
+    /**
+     * Optional setting. When `true`, the request runs as a Viya execution task —
+     * appends `_executionTasks=true` to the request URL. Only applies to the Viya
+     * web jobs path, i.e. when `serverType === SASVIYA` AND
+     * `useComputeApi` is `null`/`undefined`. Has no effect when `useComputeApi`
+     * is explicitly set to `true` or `false`.
+     */
+    runAsTask?: boolean;
 }
 export declare enum LoginMechanism {
     Default = "Default",

package/utils/index.d.ts

@@ -15,6 +15,7 @@ export * from './parseGeneratedCode';
 export * from './parseSasViyaLog';
 export * from './parseSourceCode';
 export * from './parseViyaDebugResponse';
+export * from './parseViyaLogDebugResponse';
 export * from './parseWeboutResponse';
 export * from './serialize';
 export * from './splitChunks';

package/utils/parseViyaLogDebugResponse.d.ts

@@ -0,0 +1,10 @@
+/**
+ * When querying a Viya job using the Web approach with _DEBUG=128 (used when
+ * runAsTask is true), the webout JSON is inlined into the response via:
+ *   var blob = new Blob([`{...}`], {type: 'application/json'});
+ * On abort/error paths the same shape is used but with text/plain and
+ * weboutBEGIN/END markers around the JSON:
+ *   var blob = new Blob([`>>weboutBEGIN<<\n{...}\n>>weboutEND<<\n`], {type: 'text/plain'});
+ * No follow-up request is needed — extract and parse the JSON directly.
+ */
+export declare const parseSasViyaLogDebugResponse: (response: any) => Promise<any>;

package/utils/spec/parseViyaLogDebugResponse.spec.d.ts

@@ -0,0 +1 @@
+export {};