Merge pull request #411 from sasjs/issue-408

feat: select extra attributes in JES response

.github/dependabot.yml

@@ -0,0 +1,7 @@
+version: 2
+updates:
+- package-ecosystem: npm
+  directory: "/"
+  schedule:
+    interval: daily
+  open-pull-requests-limit: 10

package.json

@@ -45,10 +45,11 @@
     "jest": "^27.0.4",
     "jest-extended": "^0.11.5",
     "path": "^0.12.7",
+    "process": "^0.11.10",
     "rimraf": "^3.0.2",
     "semantic-release": "^17.4.3",
     "terser-webpack-plugin": "^5.1.3",
-    "ts-jest": "^27.0.2",
+    "ts-jest": "^27.0.3",
     "ts-loader": "^9.2.2",
     "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.18.0",
@@ -57,11 +58,11 @@
     "typedoc-plugin-external-module-name": "^4.0.6",
     "typescript": "^4.3.2",
     "webpack": "^5.38.1",
-    "webpack-cli": "^4.7.0"
+    "webpack-cli": "^4.7.2"
   },
   "main": "index.js",
   "dependencies": {
-    "@sasjs/utils": "^2.17.0",
+    "@sasjs/utils": "^2.20.1",
     "axios": "^0.21.1",
     "axios-cookiejar-support": "^1.0.1",
     "form-data": "^4.0.0",

sasjs-tests/package-lock.json

@@ -2005,12 +2005,15 @@
     },
     "@sasjs/adapter": {
       "version": "file:../build/sasjs-adapter-5.0.0.tgz",
-      "integrity": "sha512-DxoQbdJqzqOTIuT7qwSfAbmNTWdpOx5zGkiMuZBSwoi9lSsRNoARiWnJq5Vl6h4RXJlc/FVdBFt35RZm4Mc0ZQ==",
+      "integrity": "sha512-nP9O64IslMipxSKAG8PV/X2fRr+0E4/RqwD8jXP2bqZ/QraiKZG0bQPC5hSKqEp7bho8+XpZ4HaXW3Vr9kEZ8Q==",
       "requires": {
-        "@sasjs/utils": "^2.10.2",
+        "@sasjs/utils": "^2.14.0",
         "axios": "^0.21.1",
+        "axios-cookiejar-support": "^1.0.1",
         "form-data": "^4.0.0",
-        "https": "^1.0.0"
+        "https": "^1.0.0",
+        "tough-cookie": "^4.0.0",
+        "url": "^0.11.0"
       },
       "dependencies": {
         "form-data": {
@@ -2022,6 +2025,21 @@
             "combined-stream": "^1.0.8",
             "mime-types": "^2.1.12"
           }
+        },
+        "tough-cookie": {
+          "version": "4.0.0",
+          "resolved": "https://registry.npmjs.org/tough-cookie/-/tough-cookie-4.0.0.tgz",
+          "integrity": "sha512-tHdtEpQCMrc1YLrMaqXXcj6AxhYi/xgit6mZu1+EDWUn+qhUf8wMQoFIy9NXuq23zAwtcB0t/MjACGR18pcRbg==",
+          "requires": {
+            "psl": "^1.1.33",
+            "punycode": "^2.1.1",
+            "universalify": "^0.1.2"
+          }
+        },
+        "universalify": {
+          "version": "0.1.2",
+          "resolved": "https://registry.npmjs.org/universalify/-/universalify-0.1.2.tgz",
+          "integrity": "sha512-rBJeI5CXAlmy1pV+617WB9J63U6XcazHHF2f2dbJix4XzpUF0RS3Zbj0FGIOCAva5P/d/GBOYaACQ1w+0azUkg=="
         }
       }
     },
@@ -2046,14 +2064,15 @@
       }
     },
     "@sasjs/utils": {
-      "version": "2.12.1",
-      "resolved": "https://registry.npmjs.org/@sasjs/utils/-/utils-2.12.1.tgz",
-      "integrity": "sha512-6gZS5zW0J70P7XaVuEczyfHVaVa8Ks/aWr4PIlpJcxWD0enJtCEmos2DdnezdSoNvODkPq/8rzMPqko5jaXK1Q==",
+      "version": "2.15.5",
+      "resolved": "https://registry.npmjs.org/@sasjs/utils/-/utils-2.15.5.tgz",
+      "integrity": "sha512-5HSWX5fy8D0Zy+Le+LgeRZG4vb5quLqhNiHw3dl0MS2hpsWACSRKia060jZk9LNHayKwBuusjlz5Ba0SyyaiEQ==",
       "requires": {
         "@types/prompts": "^2.0.11",
         "chalk": "^4.1.1",
         "cli-table": "^0.3.6",
         "consola": "^2.15.0",
+        "fs-extra": "^10.0.0",
         "prompts": "^2.4.1",
         "valid-url": "^1.0.9"
       },
@@ -2088,6 +2107,16 @@
           "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz",
           "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA=="
         },
+        "fs-extra": {
+          "version": "10.0.0",
+          "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-10.0.0.tgz",
+          "integrity": "sha512-C5owb14u9eJwizKGdchcDUQeFtlSHHthBk8pbX9Vc1PFZrLombudjDnNns88aYslCyF6IY5SUw3Roz6xShcEIQ==",
+          "requires": {
+            "graceful-fs": "^4.2.0",
+            "jsonfile": "^6.0.1",
+            "universalify": "^2.0.0"
+          }
+        },
         "has-flag": {
           "version": "4.0.0",
           "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz",
@@ -2402,9 +2431,9 @@
       "integrity": "sha512-tHq6qdbT9U1IRSGf14CL0pUlULksvY9OZ+5eEgl1N7t+OA3tGvNpxJCzuKQlsNgCVwbAs670L1vcVQi8j9HjnA=="
     },
     "@types/node": {
-      "version": "14.14.25",
-      "resolved": "https://registry.npmjs.org/@types/node/-/node-14.14.25.tgz",
-      "integrity": "sha512-EPpXLOVqDvisVxtlbvzfyqSsFeQxltFbluZNRndIb8tr9KiBnYNLzrc1N3pyKUCww2RNrfHDViqDWWE1LCJQtQ=="
+      "version": "14.14.41",
+      "resolved": "https://registry.npmjs.org/@types/node/-/node-14.14.41.tgz",
+      "integrity": "sha512-dueRKfaJL4RTtSa7bWeTK1M+VH+Gns73oCgzvYfHZywRCoPSd8EkXBL0mZ9unPTveBn+D9phZBaxuzpwjWkW0g=="
     },
     "@types/normalize-package-data": {
       "version": "2.4.0",
@@ -2422,9 +2451,9 @@
       "integrity": "sha512-6gOkRe7OIioWAXfnO/2lFiv+SJichKVSys1mSsgyrYHSEjk8Ctv4tSR/Odvnu+HWlH2C8j53dahU03XmQdd5fA=="
     },
     "@types/prompts": {
-      "version": "2.0.11",
-      "resolved": "https://registry.npmjs.org/@types/prompts/-/prompts-2.0.11.tgz",
-      "integrity": "sha512-dcF5L3rU9VfpLEJIV++FEyhGhuIpJllNEwllVuJ5g8eoVqjf048tW9+spivIwjzgPbtaGAl7mIZW3cmhDAq2UQ==",
+      "version": "2.0.12",
+      "resolved": "https://registry.npmjs.org/@types/prompts/-/prompts-2.0.12.tgz",
+      "integrity": "sha512-Hr6osqfNg3IcQT3pJDXCsSnb0KnldY/hXeJCKJriwbZLnedN9n1e8kcZwLc25GIWULDb6h5aEyOBbf33XpZBXQ==",
       "requires": {
         "@types/node": "*"
       }
@@ -3467,6 +3496,22 @@
         "follow-redirects": "^1.10.0"
       }
     },
+    "axios-cookiejar-support": {
+      "version": "1.0.1",
+      "resolved": "https://registry.npmjs.org/axios-cookiejar-support/-/axios-cookiejar-support-1.0.1.tgz",
+      "integrity": "sha512-IZJxnAJ99XxiLqNeMOqrPbfR7fRyIfaoSLdPUf4AMQEGkH8URs0ghJK/xtqBsD+KsSr3pKl4DEQjCn834pHMig==",
+      "requires": {
+        "is-redirect": "^1.0.0",
+        "pify": "^5.0.0"
+      },
+      "dependencies": {
+        "pify": {
+          "version": "5.0.0",
+          "resolved": "https://registry.npmjs.org/pify/-/pify-5.0.0.tgz",
+          "integrity": "sha512-eW/gHNMlxdSP6dmG6uJip6FXN0EQBwm2clYYd8Wul42Cwu/DK8HEftzsapcNdYe2MfLiIwZqsDk2RDEsTE79hA=="
+        }
+      }
+    },
     "axobject-query": {
       "version": "2.2.0",
       "resolved": "https://registry.npmjs.org/axobject-query/-/axobject-query-2.2.0.tgz",
@@ -8557,6 +8602,11 @@
       "resolved": "https://registry.npmjs.org/is-potential-custom-element-name/-/is-potential-custom-element-name-1.0.0.tgz",
       "integrity": "sha1-DFLlS8yjkbssSUsh6GJtczbG45c="
     },
+    "is-redirect": {
+      "version": "1.0.0",
+      "resolved": "https://registry.npmjs.org/is-redirect/-/is-redirect-1.0.0.tgz",
+      "integrity": "sha1-HQPd7VO9jbDzDCbk+V02/HyH3CQ="
+    },
     "is-regex": {
       "version": "1.1.0",
       "resolved": "https://registry.npmjs.org/is-regex/-/is-regex-1.1.0.tgz",

sasjs-tests/package.json

@@ -7,7 +7,7 @@
     "@sasjs/adapter": "file:../build/sasjs-adapter-5.0.0.tgz",
     "@sasjs/test-framework": "^1.4.0",
     "@types/jest": "^26.0.20",
-    "@types/node": "^14.14.25",
+    "@types/node": "^14.14.41",
     "@types/react": "^17.0.1",
     "@types/react-dom": "^17.0.0",
     "@types/react-router-dom": "^5.1.7",

sasjs-tests/src/App.tsx

@@ -13,14 +13,19 @@ const App = (): ReactElement<{}> => {
 
   useEffect(() => {
     if (adapter) {
-      setTestSuites([
+      const testSuites = [
         basicTests(adapter, config.userName, config.password),
         sendArrTests(adapter),
         sendObjTests(adapter),
         specialCaseTests(adapter),
-        sasjsRequestTests(adapter),
-        computeTests(adapter)
-      ])
+        sasjsRequestTests(adapter)
+      ]
+
+      if (adapter.getSasjsConfig().serverType === 'SASVIYA') {
+        testSuites.push(computeTests(adapter))
+      }
+
+      setTestSuites(testSuites)
     }
   }, [adapter, config])
 

sasjs-tests/src/testSuites/Basic.ts

@@ -145,6 +145,33 @@ export const basicTests = (
           sasjsConfig.debug === false
         )
       }
+    },
+    {
+      title: 'Request with extra attributes on JES approach',
+      description:
+        'Should complete successful request with extra attributes present in response',
+      test: async () => {
+        const config = {
+          useComputeApi: false
+        }
+
+        return await adapter.request(
+          'common/sendArr',
+          stringData,
+          config,
+          undefined,
+          undefined,
+          ['output', 'file', 'data']
+        )
+      },
+      assertion: (response: any) => {
+        const responseKeys: any = Object.keys(response)
+        return (
+          responseKeys.includes('file') &&
+          responseKeys.includes('output') &&
+          responseKeys.includes('data')
+        )
+      }
     }
   ]
 })

src/SASViyaApiClient.ts

@@ -28,7 +28,7 @@ import { timestampToYYYYMMDDHHMMSS } from '@sasjs/utils/time'
 import { Logger, LogLevel } from '@sasjs/utils/logger'
 import { isAuthorizeFormRequired } from './auth/isAuthorizeFormRequired'
 import { RequestClient } from './request/RequestClient'
-import { SasAuthResponse } from '@sasjs/utils/types'
+import { SasAuthResponse, MacroVar } from '@sasjs/utils/types'
 import { prefixMessage } from '@sasjs/utils/error'
 
 /**
@@ -271,6 +271,7 @@ export class SASViyaApiClient {
    * @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 }.
    * @param printPid - a boolean that indicates whether the function should print (PID) of the started job.
+   * @param variables - an object that represents macro variables.
    */
   public async executeScript(
     jobPath: string,
@@ -282,7 +283,8 @@ export class SASViyaApiClient {
     expectWebout = false,
     waitForResult = true,
     pollOptions?: PollOptions,
-    printPid = false
+    printPid = false,
+    variables?: MacroVar
   ): Promise<any> {
     try {
       const headers: any = {
@@ -356,6 +358,8 @@ export class SASViyaApiClient {
           : jobPath
       }
 
+      if (variables) jobVariables = { ...jobVariables, ...variables }
+
       let files: any[] = []
 
       if (data) {
@@ -812,6 +816,7 @@ export class SASViyaApiClient {
    * @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 }.
    * @param printPid - a boolean that indicates whether the function should print (PID) of the started job.
+   * @param variables - an object that represents macro variables.
    */
   public async executeComputeJob(
     sasJob: string,
@@ -822,7 +827,8 @@ export class SASViyaApiClient {
     waitForResult = true,
     expectWebout = false,
     pollOptions?: PollOptions,
-    printPid = false
+    printPid = false,
+    variables?: MacroVar
   ) {
     if (isRelativePath(sasJob) && !this.rootFolderName) {
       throw new Error(
@@ -901,7 +907,8 @@ export class SASViyaApiClient {
       expectWebout,
       waitForResult,
       pollOptions,
-      printPid
+      printPid,
+      variables
     )
   }
 

src/SASjs.ts

@@ -4,7 +4,7 @@ import { SASViyaApiClient } from './SASViyaApiClient'
 import { SAS9ApiClient } from './SAS9ApiClient'
 import { FileUploader } from './FileUploader'
 import { AuthManager } from './auth'
-import { ServerType } from '@sasjs/utils/types'
+import { ServerType, MacroVar } from '@sasjs/utils/types'
 import { RequestClient } from './request/RequestClient'
 import {
   JobExecutor,
@@ -14,6 +14,7 @@ import {
   Sas9JobExecutor
 } from './job-execution'
 import { ErrorResponse } from './types/errors'
+import { ExtraResponseAttributes } from '@sasjs/utils/types'
 
 const defaultConfig: SASjsConfig = {
   serverUrl: '',
@@ -540,13 +541,17 @@ export default class SASjs {
    * `await request(sasJobPath, data, config, () => setIsLoggedIn(false))`
    * If you are not passing in any data and configuration, it will look like so:
    * `await request(sasJobPath, {}, {}, () => setIsLoggedIn(false))`
+   * @param extraResponseAttributes - a array of predefined values that are used
+   * to provide extra attributes (same names as those values) to be added in response
+   * Supported values are declared in ExtraResponseAttributes type.
    */
   public async request(
     sasJob: string,
     data: { [key: string]: any },
     config: { [key: string]: any } = {},
     loginRequiredCallback?: () => any,
-    accessToken?: string
+    accessToken?: string,
+    extraResponseAttributes: ExtraResponseAttributes[] = []
   ) {
     config = {
       ...this.sasjsConfig,
@@ -568,7 +573,8 @@ export default class SASjs {
           data,
           config,
           loginRequiredCallback,
-          accessToken
+          accessToken,
+          extraResponseAttributes
         )
       }
     } else if (
@@ -671,6 +677,7 @@ export default class SASjs {
    * @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 }.
    * @param printPid - a boolean that indicates whether the function should print (PID) of the started job.
+   * @param variables - an object that represents macro variables.
    */
   public async startComputeJob(
     sasJob: string,
@@ -679,7 +686,8 @@ export default class SASjs {
     accessToken?: string,
     waitForResult?: boolean,
     pollOptions?: PollOptions,
-    printPid = false
+    printPid = false,
+    variables?: MacroVar
   ) {
     config = {
       ...this.sasjsConfig,
@@ -702,7 +710,8 @@ export default class SASjs {
       !!waitForResult,
       false,
       pollOptions,
-      printPid
+      printPid,
+      variables
     )
   }
 

src/auth/AuthManager.ts

@@ -35,6 +35,7 @@ export class AuthManager {
     this.userName = loginParams.username
 
     const { isLoggedIn, loginForm } = await this.checkSession()
+
     if (isLoggedIn) {
       await this.loginCallback()
 
@@ -44,6 +45,35 @@ export class AuthManager {
       }
     }
 
+    let loginResponse = await this.sendLoginRequest(loginForm, loginParams)
+
+    let loggedIn = isLogInSuccess(loginResponse)
+
+    if (!loggedIn) {
+      if (isCredentialsVerifyError(loginResponse)) {
+        const newLoginForm = await this.getLoginForm(loginResponse)
+
+        loginResponse = await this.sendLoginRequest(newLoginForm, loginParams)
+      }
+
+      const currentSession = await this.checkSession()
+      loggedIn = currentSession.isLoggedIn
+    }
+
+    if (loggedIn) {
+      this.loginCallback()
+    }
+
+    return {
+      isLoggedIn: !!loggedIn,
+      userName: this.userName
+    }
+  }
+
+  private async sendLoginRequest(
+    loginForm: { [key: string]: any },
+    loginParams: { [key: string]: any }
+  ) {
     for (const key in loginForm) {
       loginParams[key] = loginForm[key]
     }
@@ -60,21 +90,7 @@ export class AuthManager {
       }
     )
 
-    let loggedIn = isLogInSuccess(loginResponse)
-
-    if (!loggedIn) {
-      const currentSession = await this.checkSession()
-      loggedIn = currentSession.isLoggedIn
-    }
-
-    if (loggedIn) {
-      this.loginCallback()
-    }
-
-    return {
-      isLoggedIn: !!loggedIn,
-      userName: this.userName
-    }
+    return loginResponse
   }
 
   /**
@@ -168,5 +184,10 @@ export class AuthManager {
   }
 }
 
+const isCredentialsVerifyError = (response: string): boolean =>
+  /An error occurred while the system was verifying your credentials. Please enter your credentials again./gm.test(
+    response
+  )
+
 const isLogInSuccess = (response: string): boolean =>
   /You have signed in/gm.test(response)

src/job-execution/JesJobExecutor.ts

@@ -5,6 +5,7 @@ import {
   JobExecutionError,
   LoginRequiredError
 } from '../types/errors'
+import { ExtraResponseAttributes } from '@sasjs/utils/types'
 import { BaseJobExecutor } from './JobExecutor'
 
 export class JesJobExecutor extends BaseJobExecutor {
@@ -17,7 +18,8 @@ export class JesJobExecutor extends BaseJobExecutor {
     data: any,
     config: any,
     loginRequiredCallback?: any,
-    accessToken?: string
+    accessToken?: string,
+    extraResponseAttributes: ExtraResponseAttributes[] = []
   ) {
     const loginCallback = loginRequiredCallback || (() => Promise.resolve())
 
@@ -30,10 +32,26 @@ export class JesJobExecutor extends BaseJobExecutor {
           data,
           accessToken
         )
-        .then((response) => {
+        .then((response: any) => {
           this.appendRequest(response, sasJob, config.debug)
 
-          resolve(response)
+          let responseObject = {}
+
+          if (extraResponseAttributes && extraResponseAttributes.length > 0) {
+            const extraAttributes = extraResponseAttributes.reduce(
+              (map: any, obj: any) => ((map[obj] = response[obj]), map),
+              {}
+            )
+
+            responseObject = {
+              result: response.result,
+              ...extraAttributes
+            }
+          } else {
+            responseObject = response.result
+          }
+
+          resolve(responseObject)
         })
         .catch(async (e: Error) => {
           if (e instanceof JobExecutionError) {
@@ -50,7 +68,9 @@ export class JesJobExecutor extends BaseJobExecutor {
                 sasJob,
                 data,
                 config,
-                loginRequiredCallback
+                loginRequiredCallback,
+                accessToken,
+                extraResponseAttributes
               ).then(
                 (res: any) => {
                   resolve(res)

src/job-execution/JobExecutor.ts

@@ -1,5 +1,6 @@
 import { ServerType } from '@sasjs/utils/types'
 import { SASjsRequest } from '../types'
+import { ExtraResponseAttributes } from '@sasjs/utils/types'
 import { asyncForEach, parseGeneratedCode, parseSourceCode } from '../utils'
 
 export type ExecuteFunction = () => Promise<any>
@@ -10,7 +11,8 @@ export interface JobExecutor {
     data: any,
     config: any,
     loginRequiredCallback?: any,
-    accessToken?: string
+    accessToken?: string,
+    extraResponseAttributes?: ExtraResponseAttributes[]
   ) => Promise<any>
   resendWaitingRequests: () => Promise<void>
   getRequests: () => SASjsRequest[]
@@ -28,7 +30,8 @@ export abstract class BaseJobExecutor implements JobExecutor {
     data: any,
     config: any,
     loginRequiredCallback?: any,
-    accessToken?: string | undefined
+    accessToken?: string | undefined,
+    extraResponseAttributes?: ExtraResponseAttributes[]
   ): Promise<any>
 
   resendWaitingRequests = async () => {

webpack.config.js

@@ -2,19 +2,30 @@ const path = require('path')
 const webpack = require('webpack')
 const terserPlugin = require('terser-webpack-plugin')
 
+const defaultPlugins = [
+  new webpack.ContextReplacementPlugin(/moment[\/\\]locale$/, /en/),
+  new webpack.SourceMapDevToolPlugin({
+    filename: null,
+    exclude: [/node_modules/],
+    test: /\.ts($|\?)/i
+  })
+]
+
+const optimization = {
+  minimize: true,
+  minimizer: [
+    new terserPlugin({
+      parallel: true,
+      terserOptions: {}
+    })
+  ]
+}
+
 const browserConfig = {
   entry: './src/index.ts',
   devtool: 'inline-source-map',
   mode: 'production',
-  optimization: {
-    minimize: true,
-    minimizer: [
-      new terserPlugin({
-        parallel: true,
-        terserOptions: {}
-      })
-    ]
-  },
+  optimization: optimization,
   module: {
     rules: [
       {
@@ -35,17 +46,26 @@ const browserConfig = {
     library: 'SASjs'
   },
   plugins: [
-    new webpack.ContextReplacementPlugin(/moment[\/\\]locale$/, /en/),
-    new webpack.SourceMapDevToolPlugin({
-      filename: null,
-      exclude: [/node_modules/],
-      test: /\.ts($|\?)/i
+    ...defaultPlugins,
+    new webpack.ProvidePlugin({
+      process: 'process/browser'
     })
   ]
 }
 
+const browserConfigWithoutProcessPlugin = {
+  entry: browserConfig.entry,
+  devtool: browserConfig.devtool,
+  mode: browserConfig.mode,
+  optimization: optimization,
+  module: browserConfig.module,
+  resolve: browserConfig.resolve,
+  output: browserConfig.output,
+  plugins: defaultPlugins
+}
+
 const nodeConfig = {
-  ...browserConfig,
+  ...browserConfigWithoutProcessPlugin,
   target: 'node',
   entry: './node/index.ts',
   output: {