Merge pull request #167 from sasjs/cli-issue-249

feat(pollJobState): added ability to configure poll options

src/SASViyaApiClient.ts

@@ -17,7 +17,8 @@ import {
   CsrfToken,
   EditContextInput,
   ErrorResponse,
-  JobDefinition
+  JobDefinition,
+  PollOptions
 } from './types'
 import { formatDataForRequest } from './utils/formatDataForRequest'
 import { SessionManager } from './SessionManager'
@@ -154,6 +155,7 @@ export class SASViyaApiClient {
           context.name,
           accessToken,
           null,
+          false,
           true,
           true
         ).catch((err) => err)
@@ -164,30 +166,27 @@ export class SASViyaApiClient {
     for (const promise of promises) results.push(await promise())
 
     results.forEach((result: any, index: number) => {
-      if (result && result.error && result.error.details) {
+      if (result && result.log) {
         try {
-          const resultParsed = result.error.details
+          const resultParsed = result.log
+          let sysUserId = ''
 
-          if (resultParsed && resultParsed.body) {
+          const sysUserIdLog = resultParsed
-            let sysUserId = ''
+            .split('\n')
+            .find((line: string) => line.startsWith('SYSUSERID='))
 
-            const sysUserIdLog = resultParsed.body
+          if (sysUserIdLog) {
-              .split('\n')
+            sysUserId = sysUserIdLog.replace('SYSUSERID=', '')
-              .find((line: string) => line.startsWith('SYSUSERID='))
 
-            if (sysUserIdLog) {
+            executableContexts.push({
-              sysUserId = sysUserIdLog.replace('SYSUSERID=', '')
+              createdBy: contextsList[index].createdBy,
-
+              id: contextsList[index].id,
-              executableContexts.push({
+              name: contextsList[index].name,
-                createdBy: contextsList[index].createdBy,
+              version: contextsList[index].version,
-                id: contextsList[index].id,
+              attributes: {
-                name: contextsList[index].name,
+                sysUserId
-                version: contextsList[index].version,
+              }
-                attributes: {
+            })
-                  sysUserId
-                }
-              })
-            }
           }
         } catch (error) {
           throw error
@@ -430,6 +429,7 @@ export class SASViyaApiClient {
    * @param debug - when set to true, the log will be returned.
    * @param expectWebout - when set to true, the automatic _webout fileref will be checked for content, and that content returned. This fileref is used when the Job contains a SASjs web request (as opposed to executing arbitrary SAS code).
    * @param waitForResult - when set to true, function will return the session
+   * @param pollOptions - an object that represents poll interval(milliseconds) and maximum amount of attempts. Object example: { MAX_POLL_COUNT: 24 * 60 * 60, POLL_INTERVAL: 1000 }.
    */
   public async executeScript(
     jobPath: string,
@@ -439,7 +439,8 @@ export class SASViyaApiClient {
     data = null,
     debug: boolean = false,
     expectWebout = false,
-    waitForResult = true
+    waitForResult = true,
+    pollOptions?: PollOptions
   ): Promise<any> {
     try {
       const headers: any = {
@@ -545,7 +546,12 @@ export class SASViyaApiClient {
         )
       }
 
-      const jobStatus = await this.pollJobState(postedJob, etag, accessToken)
+      const jobStatus = await this.pollJobState(
+        postedJob,
+        etag,
+        accessToken,
+        pollOptions
+      )
 
       const { result: currentJob } = await this.request<Job>(
         `${this.serverUrl}/compute/sessions/${executionSessionId}/jobs/${postedJob.id}`,
@@ -951,6 +957,7 @@ export class SASViyaApiClient {
    * @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.
+   * @param pollOptions - an object that represents poll interval(milliseconds) and maximum amount of attempts. Object example: { MAX_POLL_COUNT: 24 * 60 * 60, POLL_INTERVAL: 1000 }.
    */
   public async executeComputeJob(
     sasJob: string,
@@ -959,7 +966,8 @@ export class SASViyaApiClient {
     data?: any,
     accessToken?: string,
     waitForResult = true,
-    expectWebout = false
+    expectWebout = false,
+    pollOptions?: PollOptions
   ) {
     if (isRelativePath(sasJob) && !this.rootFolderName) {
       throw new Error(
@@ -1044,7 +1052,8 @@ export class SASViyaApiClient {
       data,
       debug,
       expectWebout,
-      waitForResult
+      waitForResult,
+      pollOptions
     )
   }
 
@@ -1237,13 +1246,21 @@ export class SASViyaApiClient {
     this.folderMap.set(path, itemsAtRoot)
   }
 
+  // REFACTOR: set default value for 'pollOptions' attribute
   private async pollJobState(
     postedJob: any,
     etag: string | null,
-    accessToken?: string
+    accessToken?: string,
+    pollOptions?: PollOptions
   ) {
-    const MAX_POLL_COUNT = 1000
+    let POLL_INTERVAL = 100
-    const POLL_INTERVAL = 100
+    let MAX_POLL_COUNT = 1000
+
+    if (pollOptions) {
+      POLL_INTERVAL = pollOptions.POLL_INTERVAL || POLL_INTERVAL
+      MAX_POLL_COUNT = pollOptions.MAX_POLL_COUNT || MAX_POLL_COUNT
+    }
+
     let postedJobState = ''
     let pollCount = 0
     const headers: any = {

src/SASjs.ts

@@ -32,7 +32,8 @@ import {
   CsrfToken,
   UploadFile,
   EditContextInput,
-  ErrorResponse
+  ErrorResponse,
+  PollOptions
 } from './types'
 import { SASViyaApiClient } from './SASViyaApiClient'
 import { SAS9ApiClient } from './SAS9ApiClient'
@@ -711,13 +712,15 @@ export default class SASjs {
    * @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.
+   * @param pollOptions - an object that represents poll interval(milliseconds) and maximum amount of attempts. Object example: { MAX_POLL_COUNT: 24 * 60 * 60, POLL_INTERVAL: 1000 }.
    */
   public async startComputeJob(
     sasJob: string,
     data: any,
     config: any = {},
     accessToken?: string,
-    waitForResult?: boolean
+    waitForResult?: boolean,
+    pollOptions?: PollOptions
   ) {
     config = {
       ...this.sasjsConfig,
@@ -738,7 +741,8 @@ export default class SASjs {
       data,
       accessToken,
       !!waitForResult,
-      false
+      false,
+      pollOptions
     )
   }
 

src/types/PollOptions.ts

@@ -0,0 +1,4 @@
+export interface PollOptions {
+  MAX_POLL_COUNT?: number
+  POLL_INTERVAL?: number
+}

src/types/index.ts

@@ -12,3 +12,4 @@ export * from './SASjsWaitingRequest'
 export * from './ServerType'
 export * from './Session'
 export * from './UploadFile'
+export * from './PollOptions'