Merge pull request #285 from sasjs/error-handling

fix(error-handling): added InternalServerError

package.json

@@ -43,23 +43,23 @@
     "jest-extended": "^0.11.5",
     "path": "^0.12.7",
     "rimraf": "^3.0.2",
-    "semantic-release": "^17.3.9",
+    "semantic-release": "^17.4.1",
     "terser-webpack-plugin": "^4.2.3",
     "ts-jest": "^25.5.1",
     "ts-loader": "^8.0.17",
     "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.18.0",
-    "typedoc": "^0.19.2",
+    "typedoc": "^0.20.30",
     "typedoc-neo-theme": "^1.1.0",
     "typedoc-plugin-external-module-name": "^4.0.6",
     "typescript": "^3.9.9",
-    "webpack": "^5.21.2",
+    "webpack": "^5.24.4",
     "webpack-cli": "^4.5.0"
   },
   "main": "index.js",
   "dependencies": {
+    "@sasjs/utils": "^2.6.3",
     "axios": "^0.21.1",
-    "@sasjs/utils": "^2.5.0",
     "form-data": "^3.0.0",
     "https": "^1.0.0"
   }

sasjs-tests/package-lock.json

@@ -2004,21 +2004,19 @@
       }
     },
     "@sasjs/adapter": {
-      "version": "2.1.0",
+      "version": "file:../build/sasjs-adapter-5.0.0.tgz",
-      "resolved": "https://registry.npmjs.org/@sasjs/adapter/-/adapter-2.1.0.tgz",
+      "integrity": "sha512-1t+3LIL2BFw8HpZUPI9QM24801+JH4DCAu4eHoLLmytYhN72asMi1aVtgSDb1xiJYgpbTG7EK3qRpHIV8cEN8w==",
-      "integrity": "sha512-FdvxAPzXHHwCurH5B1RxSGeO6h+lVqDGAtrTAQDByT7HhsikAMFi6mW5dJR/1CKcI2rLOdE/479yYqjwfX8nwg==",
       "requires": {
-        "@sasjs/utils": "^2.0.2",
+        "@sasjs/utils": "^2.5.0",
-        "es6-promise": "^4.2.8",
+        "axios": "^0.21.1",
         "form-data": "^3.0.0",
-        "https": "^1.0.0",
+        "https": "^1.0.0"
-        "isomorphic-fetch": "^2.2.1"
       },
       "dependencies": {
         "form-data": {
-          "version": "3.0.0",
+          "version": "3.0.1",
-          "resolved": "https://registry.npmjs.org/form-data/-/form-data-3.0.0.tgz",
+          "resolved": "https://registry.npmjs.org/form-data/-/form-data-3.0.1.tgz",
-          "integrity": "sha512-CKMFDglpbMi6PyN+brwB9Q/GOw0eAnsrEZDgcsH5Krhz5Od/haKHAX0NmQfha2zPPz0JpWzA7GJHGSnvCRLWsg==",
+          "integrity": "sha512-RHkBKtLWUVwd7SqRIvCZMEvAMoGUp0XU+seQiZejj0COz3RI3hWP4sCv3gZWWLjJTd7rGwcsF5eKZGii0r/hbg==",
           "requires": {
             "asynckit": "^0.4.0",
             "combined-stream": "^1.0.8",
@@ -2048,10 +2046,11 @@
       }
     },
     "@sasjs/utils": {
-      "version": "2.2.0",
+      "version": "2.5.1",
-      "resolved": "https://registry.npmjs.org/@sasjs/utils/-/utils-2.2.0.tgz",
+      "resolved": "https://registry.npmjs.org/@sasjs/utils/-/utils-2.5.1.tgz",
-      "integrity": "sha512-T01TYAFU+WQ1uAUaunZXg0MotQe5jn3auVuMPPbY5RU5VhIn4oVhr6qz3EHyNsYYKD1aj5pP7w2elnBzkgWhGw==",
+      "integrity": "sha512-a3ISiUX8Yz7au4XYxq2KWf9ODT6nsIDbE4FEqS+AQ3McxZkfuAk4v+REXjOmIlcyQd4R4bufEK8XoB6AROn9sA==",
       "requires": {
+        "@types/prompts": "^2.0.9",
         "consola": "^2.15.0",
         "prompts": "^2.4.0",
         "valid-url": "^1.0.9"
@@ -2366,6 +2365,14 @@
       "resolved": "https://registry.npmjs.org/@types/prettier/-/prettier-2.1.6.tgz",
       "integrity": "sha512-6gOkRe7OIioWAXfnO/2lFiv+SJichKVSys1mSsgyrYHSEjk8Ctv4tSR/Odvnu+HWlH2C8j53dahU03XmQdd5fA=="
     },
+    "@types/prompts": {
+      "version": "2.0.9",
+      "resolved": "https://registry.npmjs.org/@types/prompts/-/prompts-2.0.9.tgz",
+      "integrity": "sha512-TORZP+FSjTYMWwKadftmqEn6bziN5RnfygehByGsjxoK5ydnClddtv6GikGWPvCm24oI+YBwck5WDxIIyNxUrA==",
+      "requires": {
+        "@types/node": "*"
+      }
+    },
     "@types/prop-types": {
       "version": "15.7.3",
       "resolved": "https://registry.npmjs.org/@types/prop-types/-/prop-types-15.7.3.tgz",
@@ -3396,6 +3403,14 @@
       "resolved": "https://registry.npmjs.org/axe-core/-/axe-core-4.1.1.tgz",
       "integrity": "sha512-5Kgy8Cz6LPC9DJcNb3yjAXTu3XihQgEdnIg50c//zOC/MyLP0Clg+Y8Sh9ZjjnvBrDZU4DgXS9C3T9r4/scGZQ=="
     },
+    "axios": {
+      "version": "0.21.1",
+      "resolved": "https://registry.npmjs.org/axios/-/axios-0.21.1.tgz",
+      "integrity": "sha512-dKQiRHxGD9PPRIUNIWvZhPTPpl1rf/OxTYKsqKUDjBwYylTvV7SjSHJb9ratfyzM6wCdLCOYLzs73qpg5c4iGA==",
+      "requires": {
+        "follow-redirects": "^1.10.0"
+      }
+    },
     "axobject-query": {
       "version": "2.2.0",
       "resolved": "https://registry.npmjs.org/axobject-query/-/axobject-query-2.2.0.tgz",
@@ -4677,9 +4692,9 @@
       "integrity": "sha512-e54B99q/OUoH64zYYRf3HBP5z24G38h5D3qXu23JGRoigpX5Ss4r9ZnDk3g0Z8uQC2x2lPaJ+UlWBc1ZWBWdLg=="
     },
     "consola": {
-      "version": "2.15.2",
+      "version": "2.15.3",
-      "resolved": "https://registry.npmjs.org/consola/-/consola-2.15.2.tgz",
+      "resolved": "https://registry.npmjs.org/consola/-/consola-2.15.3.tgz",
-      "integrity": "sha512-VxqWw5C8O/mQpZYtfaaSCDJcVK3AxyvQ26rhgvyAI4j/QJISh8DLwFS8GQU+9154u4ngyCsSlnyIAYJme9kQug=="
+      "integrity": "sha512-9vAdYbHj6x2fLKC4+oPH0kFzY/orMZyG2Aj+kNylHxKGJ/Ed4dpNyAQYwJOdqO4zdM7XpVHmyejQDcQHrnuXbw=="
     },
     "console-browserify": {
       "version": "1.2.0",
@@ -5722,24 +5737,6 @@
       "resolved": "https://registry.npmjs.org/encodeurl/-/encodeurl-1.0.2.tgz",
       "integrity": "sha1-rT/0yG7C0CkyL1oCw6mmBslbP1k="
     },
-    "encoding": {
-      "version": "0.1.13",
-      "resolved": "https://registry.npmjs.org/encoding/-/encoding-0.1.13.tgz",
-      "integrity": "sha512-ETBauow1T35Y/WZMkio9jiM0Z5xjHHmJ4XmjZOq1l/dXz3lr2sRn87nJy20RupqSh1F2m3HHPSp8ShIPQJrJ3A==",
-      "requires": {
-        "iconv-lite": "^0.6.2"
-      },
-      "dependencies": {
-        "iconv-lite": {
-          "version": "0.6.2",
-          "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.6.2.tgz",
-          "integrity": "sha512-2y91h5OpQlolefMPmUlivelittSWy0rP+oYVpn6A7GwVHNE8AWzoYOBNmlwks3LobaJxgHCYZAnyNo2GgpNRNQ==",
-          "requires": {
-            "safer-buffer": ">= 2.1.2 < 3.0.0"
-          }
-        }
-      }
-    },
     "end-of-stream": {
       "version": "1.4.4",
       "resolved": "https://registry.npmjs.org/end-of-stream/-/end-of-stream-1.4.4.tgz",
@@ -5882,11 +5879,6 @@
         "es6-symbol": "^3.1.1"
       }
     },
-    "es6-promise": {
-      "version": "4.2.8",
-      "resolved": "https://registry.npmjs.org/es6-promise/-/es6-promise-4.2.8.tgz",
-      "integrity": "sha512-HJDGx5daxeIvxdBxvG2cb9g4tEvwIk3i8+nhX0yGrYmZUzbkdg8QbDevheDB8gd0//uPj4c1EQua8Q+MViT0/w=="
-    },
     "es6-symbol": {
       "version": "3.1.3",
       "resolved": "https://registry.npmjs.org/es6-symbol/-/es6-symbol-3.1.3.tgz",
@@ -8584,15 +8576,6 @@
       "resolved": "https://registry.npmjs.org/isobject/-/isobject-3.0.1.tgz",
       "integrity": "sha1-TkMekrEalzFjaqH5yNHMvP2reN8="
     },
-    "isomorphic-fetch": {
-      "version": "2.2.1",
-      "resolved": "https://registry.npmjs.org/isomorphic-fetch/-/isomorphic-fetch-2.2.1.tgz",
-      "integrity": "sha1-YRrhrPFPXoH3KVB0coGf6XM1WKk=",
-      "requires": {
-        "node-fetch": "^1.0.1",
-        "whatwg-fetch": ">=0.10.0"
-      }
-    },
     "isstream": {
       "version": "0.1.2",
       "resolved": "https://registry.npmjs.org/isstream/-/isstream-0.1.2.tgz",
@@ -11423,15 +11406,6 @@
         }
       }
     },
-    "node-fetch": {
-      "version": "1.7.3",
-      "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-1.7.3.tgz",
-      "integrity": "sha512-NhZ4CsKx7cYm2vSrBAr2PvFOe6sWDf0UYLRqA6svUYg7+/TSfVAu49jYC4BvQ4Sms9SZgdqGBgroqfDhJdTyKQ==",
-      "requires": {
-        "encoding": "^0.1.11",
-        "is-stream": "^1.0.1"
-      }
-    },
     "node-forge": {
       "version": "0.10.0",
       "resolved": "https://registry.npmjs.org/node-forge/-/node-forge-0.10.0.tgz",

sasjs-tests/package.json

@@ -4,7 +4,7 @@
   "homepage": ".",
   "private": true,
   "dependencies": {
-    "@sasjs/adapter": "^2.1.0",
+    "@sasjs/adapter": "^2.2.4",
     "@sasjs/test-framework": "^1.4.0",
     "@types/jest": "^26.0.20",
     "@types/node": "^14.14.25",

sasjs-tests/public/config.json

@@ -6,7 +6,7 @@
     "appLoc": "/Public/app",
     "serverType": "SASVIYA",
     "debug": false,
-    "contextName": "SharedCompute",
+    "contextName": "sasjs adapter compute context",
     "useComputeApi": true
   }
 }

sasjs-tests/src/testSuites/Basic.ts

@@ -2,6 +2,8 @@ import SASjs, { SASjsConfig } from "@sasjs/adapter";
 import { TestSuite } from "@sasjs/test-framework";
 import { ServerType } from "@sasjs/utils/types";
 
+const stringData: any = { table1: [{ col1: "first col value" }] };
+
 const defaultConfig: SASjsConfig = {
   serverUrl: window.location.origin,
   pathSAS9: "/SASStoredProcess/do",
@@ -51,6 +53,36 @@ export const basicTests = (
       assertion: (response: any) =>
         response && response.isLoggedIn && response.userName === userName
     },
+    {
+      title: "Trigger login callback",
+      description:
+        "Should trigger required login callback and after successful login, it should finish the request",
+      test: async () => {
+        await adapter.logOut();
+        
+        return await adapter.request("common/sendArr", stringData, null, () => {
+          adapter.logIn(userName, password);
+        });
+      },
+      assertion: (response: any) => {
+        return response.table1[0][0] === stringData.table1[0].col1;
+      }
+    },
+    {
+      title: "Request with debug on",
+      description:
+        "Should complete successful request with debugging switched on",
+      test: async () => {
+        const config = {
+          debug: true
+        }
+
+        return await adapter.request("common/sendArr", stringData, config)
+      },
+      assertion: (response: any) => {
+        return response.table1[0][0] === stringData.table1[0].col1;
+      }
+    },
     {
       title: "Default config",
       description:

src/FileUploader.ts

@@ -1,6 +1,6 @@
 import { isUrl } from './utils'
 import { UploadFile } from './types/UploadFile'
-import { ErrorResponse, LoginRequiredError } from './types'
+import { ErrorResponse, LoginRequiredError } from './types/errors'
 import { RequestClient } from './request/RequestClient'
 
 export class FileUploader {

src/SASViyaApiClient.ts

@@ -8,10 +8,13 @@ import {
   Folder,
   EditContextInput,
   JobDefinition,
-  PollOptions,
+  PollOptions
-  ComputeJobExecutionError,
-  JobExecutionError
 } from './types'
+import {
+  ComputeJobExecutionError,
+  JobExecutionError,
+  NotFoundError
+} from './types/errors'
 import { formatDataForRequest } from './utils/formatDataForRequest'
 import { SessionManager } from './SessionManager'
 import { ContextManager } from './ContextManager'
@@ -19,7 +22,6 @@ import { timestampToYYYYMMDDHHMMSS } from '@sasjs/utils/time'
 import { Logger, LogLevel } from '@sasjs/utils/logger'
 import { isAuthorizeFormRequired } from './auth/isAuthorizeFormRequired'
 import { RequestClient } from './request/RequestClient'
-import { NotFoundError } from './types/NotFoundError'
 import { SasAuthResponse } from '@sasjs/utils/types'
 import { prefixMessage } from '@sasjs/utils/error'
 
@@ -977,7 +979,13 @@ export class SASViyaApiClient {
       postJobRequestBody,
       accessToken
     )
-    const jobStatus = await this.pollJobState(postedJob, etag, accessToken)
+    const jobStatus = await this.pollJobState(
+      postedJob,
+      etag,
+      accessToken
+    ).catch((err) => {
+      throw prefixMessage(err, 'Error while polling job status. ')
+    })
     const { result: currentJob } = await this.requestClient.get<Job>(
       `${this.serverUrl}/jobExecution/jobs/${postedJob.id}`,
       accessToken
@@ -1076,7 +1084,9 @@ export class SASViyaApiClient {
       .get<string>(
         `${this.serverUrl}${stateLink.href}?_action=wait&wait=30`,
         accessToken,
-        'text/plain'
+        'text/plain',
+        {},
+        this.debug
       )
       .catch((err) => {
         throw prefixMessage(err, 'Error while getting job state. ')
@@ -1101,10 +1111,15 @@ export class SASViyaApiClient {
               .get<string>(
                 `${this.serverUrl}${stateLink.href}?_action=wait&wait=30`,
                 accessToken,
-                'text/plain'
+                'text/plain',
+                {},
+                this.debug
               )
               .catch((err) => {
-                throw prefixMessage(err, 'Error while getting job state. ')
+                throw prefixMessage(
+                  err,
+                  'Error while getting job state after interval. '
+                )
               })
 
             postedJobState = jobState.trim()

src/index.ts

@@ -1,5 +1,6 @@
 import SASjs from './SASjs'
 export * from './types'
+export * from './types/errors'
 export * from './SASViyaApiClient'
 export * from './SAS9ApiClient'
 export default SASjs

src/job-execution/ComputeJobExecutor.ts

@@ -1,7 +1,10 @@
 import { ServerType } from '@sasjs/utils/types'
-import { ErrorResponse } from '..'
 import { SASViyaApiClient } from '../SASViyaApiClient'
-import { ComputeJobExecutionError, LoginRequiredError } from '../types'
+import {
+  ErrorResponse,
+  ComputeJobExecutionError,
+  LoginRequiredError
+} from '../types/errors'
 import { BaseJobExecutor } from './JobExecutor'
 
 export class ComputeJobExecutor extends BaseJobExecutor {

src/job-execution/JesJobExecutor.ts

@@ -1,7 +1,10 @@
 import { ServerType } from '@sasjs/utils/types'
-import { ErrorResponse } from '..'
 import { SASViyaApiClient } from '../SASViyaApiClient'
-import { JobExecutionError, LoginRequiredError } from '../types'
+import {
+  ErrorResponse,
+  JobExecutionError,
+  LoginRequiredError
+} from '../types/errors'
 import { BaseJobExecutor } from './JobExecutor'
 
 export class JesJobExecutor extends BaseJobExecutor {

src/job-execution/WebJobExecutor.ts

@@ -1,5 +1,9 @@
 import { ServerType } from '@sasjs/utils/types'
-import { ErrorResponse, JobExecutionError, LoginRequiredError } from '..'
+import {
+  ErrorResponse,
+  JobExecutionError,
+  LoginRequiredError
+} from '../types/errors'
 import { generateFileUploadForm } from '../file/generateFileUploadForm'
 import { generateTableUploadForm } from '../file/generateTableUploadForm'
 import { RequestClient } from '../request/RequestClient'

src/request/RequestClient.ts

@@ -1,9 +1,13 @@
 import axios, { AxiosInstance, AxiosRequestConfig, AxiosResponse } from 'axios'
-import { CsrfToken, JobExecutionError } from '..'
+import { CsrfToken } from '..'
 import { isAuthorizeFormRequired, isLogInRequired } from '../auth'
-import { LoginRequiredError } from '../types'
+import {
-import { AuthorizeError } from '../types/AuthorizeError'
+  AuthorizeError,
-import { NotFoundError } from '../types/NotFoundError'
+  LoginRequiredError,
+  NotFoundError,
+  InternalServerError,
+  JobExecutionError
+} from '../types/errors'
 import { parseWeboutResponse } from '../utils/parseWeboutResponse'
 import { prefixMessage } from '@sasjs/utils/error'
 
@@ -73,7 +77,8 @@ export class RequestClient implements HttpClient {
     url: string,
     accessToken: string | undefined,
     contentType: string = 'application/json',
-    overrideHeaders: { [key: string]: string | number } = {}
+    overrideHeaders: { [key: string]: string | number } = {},
+    debug: boolean = false
   ): Promise<{ result: T; etag: string }> {
     const headers = {
       ...this.getHeaders(accessToken, contentType),
@@ -93,11 +98,22 @@ export class RequestClient implements HttpClient {
       .get<T>(url, requestConfig)
       .then((response) => {
         throwIfError(response)
+
         return this.parseResponse<T>(response)
       })
       .catch(async (e) => {
-        return await this.handleError(e, () =>
+        return await this.handleError(
-          this.get<T>(url, accessToken, contentType, overrideHeaders)
+          e,
+          () =>
+            this.get<T>(url, accessToken, contentType, overrideHeaders).catch(
+              (err) => {
+                throw prefixMessage(
+                  err,
+                  'Error while executing handle error callback. '
+                )
+              }
+            ),
+          debug
         ).catch((err) => {
           throw prefixMessage(err, 'Error while handling error. ')
         })
@@ -332,7 +348,11 @@ export class RequestClient implements HttpClient {
     }
   }
 
-  private handleError = async (e: any, callback: any) => {
+  private handleError = async (
+    e: any,
+    callback: any,
+    debug: boolean = false
+  ) => {
     const response = e.response as AxiosResponse
 
     if (e instanceof AuthorizeError) {
@@ -378,6 +398,9 @@ export class RequestClient implements HttpClient {
       throw e
     } else if (response?.status === 404) {
       throw new NotFoundError(response.config.url!)
+    } else if (response?.status === 502) {
+      if (debug) throw new InternalServerError()
+      else return
     }
 
     throw e
@@ -449,6 +472,7 @@ const throwIfError = (response: AxiosResponse) => {
   }
 
   const error = parseError(response.data as string)
+
   if (error) {
     throw error
   }

src/types/errors/ComputeJobExecutionError.ts

@@ -1,4 +1,4 @@
-import { Job } from './Job'
+import { Job } from '../Job'
 
 export class ComputeJobExecutionError extends Error {
   constructor(public job: Job, public log: string) {

src/types/errors/InternalServerError.ts

@@ -0,0 +1,9 @@
+export class InternalServerError extends Error {
+  constructor() {
+    super('Error: Internal server error.')
+
+    this.name = 'InternalServerError'
+
+    Object.setPrototypeOf(this, InternalServerError.prototype)
+  }
+}

src/types/errors/index.ts

@@ -0,0 +1,7 @@
+export * from './AuthorizeError'
+export * from './ComputeJobExecutionError'
+export * from './InternalServerError'
+export * from './JobExecutionError'
+export * from './LoginRequiredError'
+export * from './NotFoundError'
+export * from './ErrorResponse'

src/types/index.ts

@@ -1,14 +1,10 @@
-export * from './ComputeJobExecutionError'
 export * from './Context'
 export * from './CsrfToken'
-export * from './ErrorResponse'
 export * from './Folder'
 export * from './Job'
-export * from './JobExecutionError'
 export * from './JobDefinition'
 export * from './JobResult'
 export * from './Link'
-export * from './LoginRequiredError'
 export * from './SASjsConfig'
 export * from './SASjsRequest'
 export * from './Session'