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

feat(pollJobState): added ability to configure poll options

.gitignore

@@ -1,2 +1,2 @@
 node_modules
-build
+build

PULL_REQUEST_TEMPLATE.md

@@ -14,4 +14,5 @@ What code changes have been made to achieve the intent.
 
 - [ ] Code is formatted correctly (`npm run lint:fix`).
 - [ ] All unit tests are passing (`npm test`).
+- [ ] All `sasjs-cli` unit tests are passing (`npm test`).
 - [ ] All `sasjs-tests` are passing (instructions available [here](https://github.com/sasjs/adapter/blob/master/sasjs-tests/README.md)).

package.json

@@ -2,7 +2,7 @@
   "name": "@sasjs/adapter",
   "description": "JavaScript adapter for SAS",
   "scripts": {
-    "build": "rimraf build && webpack",
+    "build": "rimraf build && rimraf node && mkdir node && cp -r src/* node && webpack && rimraf build/src && rimraf node",
     "package:lib": "npm run build && cp ./package.json build && cd build && npm version \"5.0.0\" && npm pack",
     "publish:lib": "npm run build && cd build && npm publish",
     "lint:fix": "npx prettier --write 'src/**/*.{ts,tsx,js,jsx,html,css,sass,less,json,yml,md,graphql}'",
@@ -37,15 +37,15 @@
   "license": "ISC",
   "devDependencies": {
     "@types/isomorphic-fetch": "0.0.35",
-    "@types/jest": "^26.0.14",
+    "@types/jest": "^26.0.15",
     "cp": "^0.2.0",
     "jest": "^25.5.4",
     "path": "^0.12.7",
     "rimraf": "^3.0.2",
-    "semantic-release": "^17.1.2",
-    "terser-webpack-plugin": "^4.2.2",
+    "semantic-release": "^17.3.0",
+    "terser-webpack-plugin": "^4.2.3",
     "ts-jest": "^25.5.1",
-    "ts-loader": "^8.0.4",
+    "ts-loader": "^8.0.11",
     "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.18.0",
     "typedoc": "^0.17.8",
@@ -53,7 +53,7 @@
     "typedoc-plugin-external-module-name": "^4.0.3",
     "typescript": "^3.9.7",
     "webpack": "^4.44.2",
-    "webpack-cli": "^3.3.12"
+    "webpack-cli": "^4.2.0"
   },
   "main": "index.js",
   "dependencies": {

sasjs-tests/package-lock.json

@@ -1357,9 +1357,9 @@
       "integrity": "sha512-shAmDyaQC4H92APFoIaVDHCx5bStIocgvbwQyxPRrbUY20V1EYTbSDchWbuwlMG3V17cprZhA6+78JfB+3DTPw=="
     },
     "@sasjs/adapter": {
-      "version": "1.12.0",
-      "resolved": "https://registry.npmjs.org/@sasjs/adapter/-/adapter-1.12.0.tgz",
-      "integrity": "sha512-0uGQH9ynomWzdBaEujEtcR38q6V7LCgG0mrb1Wellv6cC/IHD3j6WfeZZAgtiMPeOSJjbCDBOlVnzC2TlBqJFw==",
+      "version": "1.18.3",
+      "resolved": "https://registry.npmjs.org/@sasjs/adapter/-/adapter-1.18.3.tgz",
+      "integrity": "sha512-wzDFJRyt2dXFeQP+JzqRGunYUbujrAbU/Jc4IWg5URsCkGAzwsNl/4G0xJVbqOTy1MvoZ431rfCnvhkUlg7D3Q==",
       "requires": {
         "es6-promise": "^4.2.8",
         "form-data": "^3.0.0",

sasjs-tests/package.json

@@ -4,7 +4,7 @@
   "homepage": ".",
   "private": true,
   "dependencies": {
-    "@sasjs/adapter": "^1.12.0",
+    "@sasjs/adapter": "^1.18.2",
     "@sasjs/test-framework": "^1.4.0",
     "@testing-library/jest-dom": "^4.2.4",
     "@testing-library/react": "^9.5.0",

sasjs-tests/src/App.test.js

@@ -1,9 +0,0 @@
-import React from "react";
-import { render } from "@testing-library/react";
-import App from "./App";
-
-test("renders learn react link", () => {
-  const { getByText } = render(<App />);
-  const linkElement = getByText(/learn react/i);
-  expect(linkElement).toBeInTheDocument();
-});

sasjs-tests/src/testSuites/Basic.ts

@@ -3,12 +3,12 @@ import { TestSuite } from "@sasjs/test-framework";
 
 const defaultConfig: SASjsConfig = {
   serverUrl: window.location.origin,
-  pathSAS9: "/SASStoredProcess/do",
-  pathSASViya: "/SASJobExecution",
-  appLoc: "/Public/seedapp",
+  pathSAS9: '/SASStoredProcess/do',
+  pathSASViya: '/SASJobExecution',
+  appLoc: '/Public/seedapp',
   serverType: ServerType.SASViya,
-  debug: true,
-  contextName: "SAS Job Execution compute context",
+  debug: false,
+  contextName: 'SAS Job Execution compute context',
   useComputeApi: false
 };
 
@@ -57,6 +57,7 @@ export const basicTests = (
       },
       assertion: (sasjsInstance: SASjs) => {
         const sasjsConfig = sasjsInstance.getSasjsConfig();
+
         return (
           sasjsConfig.serverUrl === defaultConfig.serverUrl &&
           sasjsConfig.pathSAS9 === defaultConfig.pathSAS9 &&

sasjs-tests/src/testSuites/RequestData.ts

@@ -88,7 +88,7 @@ export const sendArrTests = (adapter: SASjs): TestSuite => ({
         return adapter.request("common/sendArr", data).catch((e) => e);
       },
       assertion: (error: any) => {
-        return !!error && !!error.body && !!error.body.message;
+        return !!error && !!error.error && !!error.error.message;
       }
     },
     {
@@ -185,7 +185,7 @@ export const sendObjTests = (adapter: SASjs): TestSuite => ({
         };
         return adapter.request("common/sendObj", invalidData).catch((e) => e);
       },
-      assertion: (error: any) => !!error && !!error.body && !!error.body.message
+      assertion: (error: any) => !!error && !!error.error && !!error.error.message
     },
     {
       title: "Single string value",
@@ -219,7 +219,7 @@ export const sendObjTests = (adapter: SASjs): TestSuite => ({
           .catch((e) => e);
       },
       assertion: (error: any) => {
-        return !!error && !!error.body && !!error.body.message;
+        return !!error && !!error.error && !!error.error.message;
       }
     },
     {

sasjs-tests/src/testSuites/SasjsRequests.ts

@@ -23,22 +23,24 @@ export const sasjsRequestTests = (adapter: SASjs): TestSuite => ({
     },
     {
       title: "Make error and capture log",
-      description: "Should make an error and capture log",
+      description: "Should make an error and capture log, in the same time it is testing if debug override is working",
       test: async () => {
         return new Promise(async (resolve, reject) => {
           adapter
-            .request("common/makeErr", data)
+            .request("common/makeErr", data, {debug: true})
             .then((res) => {
               //no action here, this request must throw error
             })
             .catch((err) => {
               let sasRequests = adapter.getSasRequests();
-              let makeErrRequest =
+              let makeErrRequest: any =
                 sasRequests.find((req) =>
                   req.serviceLink.includes("makeErr")
                 ) || null;
 
-              resolve(!!makeErrRequest);
+              if (!makeErrRequest) resolve(false)
+
+              resolve(!!(makeErrRequest.logFile && makeErrRequest.logFile.length > 0));
             });
         });
       },

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.body && result.body.details) {
+      if (result && result.log) {
         try {
-          const resultParsed = JSON.parse(result.body.details)
+          const resultParsed = result.log
+          let sysUserId = ''
 
-          if (resultParsed && resultParsed.body) {
-            let sysUserId = ''
+          const sysUserIdLog = resultParsed
+            .split('\n')
+            .find((line: string) => line.startsWith('SYSUSERID='))
 
-            const sysUserIdLog = resultParsed.body
-              .split('\n')
-              .find((line: string) => line.startsWith('SYSUSERID='))
+          if (sysUserIdLog) {
+            sysUserId = sysUserIdLog.replace('SYSUSERID=', '')
 
-            if (sysUserIdLog) {
-              sysUserId = sysUserIdLog.replace('SYSUSERID=', '')
-
-              executableContexts.push({
-                createdBy: contextsList[index].createdBy,
-                id: contextsList[index].id,
-                name: contextsList[index].name,
-                version: contextsList[index].version,
-                attributes: {
-                  sysUserId
-                }
-              })
-            }
+            executableContexts.push({
+              createdBy: contextsList[index].createdBy,
+              id: contextsList[index].id,
+              name: contextsList[index].name,
+              version: contextsList[index].version,
+              attributes: {
+                sysUserId
+              }
+            })
           }
         } catch (error) {
           throw error
@@ -426,10 +425,11 @@ export class SASViyaApiClient {
    * @param linesOfCode - an array of code lines to execute.
    * @param contextName - the context to execute the code in.
    * @param accessToken - an access token for an authorized user.
-   * @param sessionId - optional session ID to reuse.
    * @param data - execution data.
    * @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,
@@ -437,8 +437,10 @@ export class SASViyaApiClient {
     contextName: string,
     accessToken?: string,
     data = null,
+    debug: boolean = false,
     expectWebout = false,
-    waitForResult = true
+    waitForResult = true,
+    pollOptions?: PollOptions
   ): Promise<any> {
     try {
       const headers: any = {
@@ -467,7 +469,7 @@ export class SASViyaApiClient {
         _OMITTEXTLOG: true
       }
 
-      if (this.debug) {
+      if (debug) {
         jobArguments['_OMITTEXTLOG'] = false
         jobArguments['_OMITSESSIONRESULTS'] = false
         jobArguments['_DEBUG'] = 131
@@ -535,7 +537,7 @@ export class SASViyaApiClient {
         return session
       }
 
-      if (this.debug) {
+      if (debug) {
         console.log(`Job has been submitted for '${fileName}'.`)
         console.log(
           `You can monitor the job progress at '${this.serverUrl}${
@@ -544,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}`,
@@ -558,7 +565,7 @@ export class SASViyaApiClient {
 
       const logLink = currentJob.links.find((l) => l.rel === 'log')
 
-      if (this.debug && logLink) {
+      if (debug && logLink) {
         log = await this.request<any>(
           `${this.serverUrl}${logLink.href}/content?limit=10000`,
           {
@@ -574,7 +581,7 @@ export class SASViyaApiClient {
       }
 
       if (jobStatus === 'failed' || jobStatus === 'error') {
-        return Promise.reject({ error: currentJob.error, log })
+        return Promise.reject({ job: currentJob, log })
       }
 
       let resultLink
@@ -606,12 +613,10 @@ export class SASViyaApiClient {
                   throw err
                 })
 
-              return Promise.reject(
-                new ErrorResponse('Job execution failed.', {
-                  status: 500,
-                  body: log
-                })
-              )
+              return Promise.reject({
+                status: 500,
+                log: log
+              })
             }
           }
           return {
@@ -635,6 +640,7 @@ export class SASViyaApiClient {
           contextName,
           accessToken,
           data,
+          debug,
           false,
           true
         )
@@ -951,14 +957,17 @@ 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,
     contextName: string,
+    debug?: boolean,
     data?: any,
     accessToken?: string,
     waitForResult = true,
-    expectWebout = false
+    expectWebout = false,
+    pollOptions?: PollOptions
   ) {
     if (isRelativePath(sasJob) && !this.rootFolderName) {
       throw new Error(
@@ -1041,8 +1050,10 @@ export class SASViyaApiClient {
       contextName,
       accessToken,
       data,
+      debug,
       expectWebout,
-      waitForResult
+      waitForResult,
+      pollOptions
     )
   }
 
@@ -1235,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
-    const POLL_INTERVAL = 100
+    let 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,
@@ -734,10 +737,12 @@ export default class SASjs {
     return this.sasViyaApiClient?.executeComputeJob(
       sasJob,
       config.contextName,
+      config.debug,
       data,
       accessToken,
       !!waitForResult,
-      false
+      false,
+      pollOptions
     )
   }
 
@@ -766,6 +771,7 @@ export default class SASjs {
           ?.executeComputeJob(
             sasJob,
             config.contextName,
+            config.debug,
             data,
             accessToken,
             waitForResult,
@@ -895,8 +901,8 @@ export default class SASjs {
 
                 return responseJson
               })
-              .catch(async (e) => {
-                if (needsRetry(JSON.stringify(e))) {
+              .catch(async (response) => {
+                if (needsRetry(JSON.stringify(response))) {
                   if (this.retryCountJeseApi < requestRetryLimit) {
                     let retryResponse = await this.executeJobViaJesApi(
                       sasJob,
@@ -917,11 +923,11 @@ export default class SASjs {
                   }
                 }
 
-                if (e?.log) {
-                  this.appendSasjsRequest(e.log, sasJob, null)
+                if (response?.log) {
+                  this.appendSasjsRequest(response.log, sasJob, null)
                 }
 
-                if (e.toString().includes('Job was not found')) {
+                if (response.toString().includes('Job was not found')) {
                   reject(
                     new ErrorResponse('Service not found on the server.', {
                       sasJob: sasJob
@@ -929,7 +935,7 @@ export default class SASjs {
                   )
                 }
 
-                reject(new ErrorResponse('Job execution failed.', e))
+                reject(new ErrorResponse('Job execution failed.', response))
               })
           )
         }

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'

webpack.config.js

@@ -47,6 +47,7 @@ const browserConfig = {
 const nodeConfig = {
   ...browserConfig,
   target: 'node',
+  entry: './node/index.ts',
   output: {
     ...browserConfig.output,
     path: path.resolve(__dirname, 'build', 'node')