Merge pull request #467 from sasjs/removed-url-package

fix: removed url package

README.md

@@ -194,6 +194,8 @@ Note - to use the web approach, the `useComputeApi` property must be `undefined`
 ### Using the JES API
 Here we are running Jobs using the Job Execution Service except this time we are making the requests directly using the REST API instead of through the JES Web App.  This is helpful when we need to call web services outside of a browser (eg with the SASjs CLI or other commandline tools).  To save one network request, the adapter prefetches the JOB URIs and passes them in the `__job` parameter.  Depending on your network bandwidth, it may or may not be faster than the JES Web approach.
 
+This approach (`useComputeApi: false`) also ensures that jobs are displayed in Environment Manager.
+
 ```
 {
   appLoc:"/Your/Path",
@@ -206,6 +208,8 @@ Here we are running Jobs using the Job Execution Service except this time we are
 ### Using the Compute API
 This approach is by far the fastest, as a result of the optimisations we have built into the adapter.  With this configuration, in the first sasjs request, we take a URI map of the services in the target folder, and create a session manager.  This manager will spawn a additional session every time a request is made. Subsequent requests will use the existing 'hot' session, if it exists.  Sessions are always deleted after every use, which actually makes this _less_ resource intensive than a typical JES web app, in which all sessions are kept alive by default for 15 minutes.
 
+With this approach (`useComputeApi: true`), the requests/logs will _not_ appear in the list in Environment manager.
+
 ```
 {
   appLoc:"/Your/Path",

package.json

@@ -3,8 +3,8 @@
   "description": "JavaScript adapter for SAS",
   "homepage": "https://adapter.sasjs.io",
   "scripts": {
-    "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",
+    "build": "rimraf build && rimraf node && mkdir node && copyfiles -u 1 \"./src/**/*\" ./node && webpack && rimraf build/src && rimraf node",
+    "package:lib": "npm run build && copyfiles ./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}\" && npx prettier --write \"sasjs-tests/src/**/*.{ts,tsx,js,jsx,html,css,sass,less,json,yml,md,graphql}\"",
     "lint": "npx prettier --check \"src/**/*.{ts,tsx,js,jsx,html,css,sass,less,json,yml,md,graphql}\" && npx prettier --check \"sasjs-tests/src/**/*.{ts,tsx,js,jsx,html,css,sass,less,json,yml,md,graphql}\"",
@@ -13,7 +13,7 @@
     "postpublish": "git clean -fd",
     "semantic-release": "semantic-release",
     "typedoc": "typedoc",
-    "prepare": "[ -d .git ] && git config core.hooksPath ./.git-hooks || true"
+    "prepare": "git rev-parse --git-dir && git config core.hooksPath ./.git-hooks && git config core.autocrlf false || true"
   },
   "publishConfig": {
     "access": "public"
@@ -41,11 +41,13 @@
     "@types/jest": "^26.0.23",
     "@types/mime": "^2.0.3",
     "@types/tough-cookie": "^4.0.0",
+    "copyfiles": "^2.4.1",
     "cp": "^0.2.0",
     "dotenv": "^10.0.0",
     "jest": "^27.0.6",
     "jest-extended": "^0.11.5",
     "mime": "^2.5.2",
+    "node-polyfill-webpack-plugin": "^1.1.4",
     "path": "^0.12.7",
     "process": "^0.11.10",
     "rimraf": "^3.0.2",
@@ -64,13 +66,11 @@
   },
   "main": "index.js",
   "dependencies": {
-    "@sasjs/utils": "^2.21.0",
+    "@sasjs/utils": "^2.23.2",
     "axios": "^0.21.1",
     "axios-cookiejar-support": "^1.0.1",
     "form-data": "^4.0.0",
     "https": "^1.0.0",
-    "jwt-decode": "^3.1.2",
-    "tough-cookie": "^4.0.0",
-    "url": "^0.11.0"
+    "tough-cookie": "^4.0.0"
   }
 }

sasjs-tests/README.md

@@ -41,6 +41,19 @@ So you can run the script like so:
 SSH_ACCOUNT=me@my-sas-server.com DEPLOY_PATH=/var/www/html/my-folder/sasjs-tests npm run deploy
 ```
 
+If you are on `WINDOWS`, you will first need to install one dependency:
+```bash
+npm i -g copyfiles
+```
+and then run to build:
+```bash
+npm run update:adapter && npm run build 
+```
+when it finishes run to deploy:
+```bash
+scp -rp ./build/* me@my-sas-server.com:/var/www/html/my-folder/sasjs-tests
+```
+
 If you'd like to deploy just `sasjs-tests` without changing the adapter version, you can use the `deploy:tests` script, while also setting the same environment variables as above.
 
 ## 3. Creating the required SAS services

sasjs-tests/package.json

@@ -23,7 +23,8 @@
     "test": "react-scripts test",
     "eject": "react-scripts eject",
     "update:adapter": "cd .. && npm run package:lib && cd sasjs-tests && npm i ../build/sasjs-adapter-5.0.0.tgz",
-    "deploy:tests": "rsync -avhe ssh ./build/* --delete $SSH_ACCOUNT:$DEPLOY_PATH",
+    "deploy:tests": "rsync -avhe ssh ./build/* --delete $SSH_ACCOUNT:$DEPLOY_PATH || npm run deploy:tests-win",
+    "deploy:tests-win": "scp %DEPLOY_PATH% ./build/*",
     "deploy": "npm run update:adapter && npm run build && npm run deploy:tests"
   },
   "eslintConfig": {

src/SASViyaApiClient.ts

@@ -3,9 +3,7 @@ import {
   isRelativePath,
   isUri,
   isUrl,
-  fetchLogByChunks,
-  isAccessTokenExpiring,
-  isRefreshTokenExpiring
+  fetchLogByChunks
 } from './utils'
 import * as NodeFormData from 'form-data'
 import {
@@ -28,10 +26,14 @@ import { formatDataForRequest } from './utils/formatDataForRequest'
 import { SessionManager } from './SessionManager'
 import { ContextManager } from './ContextManager'
 import { timestampToYYYYMMDDHHMMSS } from '@sasjs/utils/time'
+import {
+  isAccessTokenExpiring,
+  isRefreshTokenExpiring
+} from '@sasjs/utils/auth'
 import { Logger, LogLevel } from '@sasjs/utils/logger'
+import { SasAuthResponse, MacroVar, AuthConfig } from '@sasjs/utils/types'
 import { isAuthorizeFormRequired } from './auth/isAuthorizeFormRequired'
 import { RequestClient } from './request/RequestClient'
-import { SasAuthResponse, MacroVar, AuthConfig } from '@sasjs/utils/types'
 import { prefixMessage } from '@sasjs/utils/error'
 import * as mime from 'mime'
 

src/SessionManager.ts

@@ -1,4 +1,5 @@
-import { Session, Context, CsrfToken, SessionVariable } from './types'
+import { Session, Context, SessionVariable } from './types'
+import { NoSessionStateError } from './types/errors'
 import { asyncForEach, isUrl } from './utils'
 import { prefixMessage } from '@sasjs/utils/error'
 import { RequestClient } from './request/RequestClient'
@@ -173,13 +174,14 @@ export class SessionManager {
             this.printedSessionState.printed = true
           }
 
-          const state = await this.getSessionState(
-            `${this.serverUrl}${stateLink.href}?wait=30`,
-            etag!,
-            accessToken
-          ).catch((err) => {
-            throw prefixMessage(err, 'Error while getting session state.')
-          })
+          const { result: state, responseStatus: responseStatus } =
+            await this.getSessionState(
+              `${this.serverUrl}${stateLink.href}?wait=30`,
+              etag!,
+              accessToken
+            ).catch((err) => {
+              throw prefixMessage(err, 'Error while getting session state.')
+            })
 
           sessionState = state.trim()
 
@@ -198,7 +200,14 @@ export class SessionManager {
 
               resolve(this.waitForSession(session, etag, accessToken))
             } else {
-              reject('Could not get session state.')
+              reject(
+                new NoSessionStateError(
+                  responseStatus,
+                  this.serverUrl + stateLink.href,
+                  session.links.find((l: any) => l.rel === 'log')
+                    ?.href as string
+                )
+              )
             }
           }
 
@@ -217,7 +226,10 @@ export class SessionManager {
   ) {
     return await this.requestClient
       .get(url, accessToken, 'text/plain', { 'If-None-Match': etag })
-      .then((res) => res.result as string)
+      .then((res) => ({
+        result: res.result as string,
+        responseStatus: res.status
+      }))
       .catch((err) => {
         throw err
       })

src/job-execution/WebJobExecutor.ts

@@ -8,8 +8,9 @@ import { generateFileUploadForm } from '../file/generateFileUploadForm'
 import { generateTableUploadForm } from '../file/generateTableUploadForm'
 import { RequestClient } from '../request/RequestClient'
 import { SASViyaApiClient } from '../SASViyaApiClient'
-import { isRelativePath } from '../utils'
+import { isRelativePath, isValidJson } from '../utils'
 import { BaseJobExecutor } from './JobExecutor'
+import { parseWeboutResponse } from '../utils/parseWeboutResponse'
 
 export interface WaitingRequstPromise {
   promise: Promise<any> | null
@@ -100,6 +101,19 @@ export class WebJobExecutor extends BaseJobExecutor {
             this.appendRequest(res, sasJob, config.debug)
             resolve(jsonResponse)
           }
+          if (this.serverType === ServerType.Sas9 && config.debug) {
+            const jsonResponse = parseWeboutResponse(res.result as string)
+            if (jsonResponse === '') {
+              throw new Error(
+                'Valid JSON could not be extracted from response.'
+              )
+            }
+
+            isValidJson(jsonResponse)
+            this.appendRequest(res, sasJob, config.debug)
+            resolve(res.result)
+          }
+          isValidJson(res.result as string)
           this.appendRequest(res, sasJob, config.debug)
           resolve(res.result)
         })

src/request/RequestClient.ts

@@ -11,6 +11,7 @@ import {
 import { parseWeboutResponse } from '../utils/parseWeboutResponse'
 import { prefixMessage } from '@sasjs/utils/error'
 import { SAS9AuthError } from '../types/errors/SAS9AuthError'
+import { isValidJson } from '../utils'
 
 export interface HttpClient {
   get<T>(
@@ -83,7 +84,7 @@ export class RequestClient implements HttpClient {
     contentType: string = 'application/json',
     overrideHeaders: { [key: string]: string | number } = {},
     debug: boolean = false
-  ): Promise<{ result: T; etag: string }> {
+  ): Promise<{ result: T; etag: string; status: number }> {
     const headers = {
       ...this.getHeaders(accessToken, contentType),
       ...overrideHeaders
@@ -423,7 +424,13 @@ export class RequestClient implements HttpClient {
       }
     } catch {
       try {
-        parsedResponse = JSON.parse(parseWeboutResponse(response.data))
+        const weboutResponse = parseWeboutResponse(response.data)
+        if (weboutResponse === '') {
+          throw new Error('Valid JSON could not be extracted from response.')
+        }
+
+        const jsonResponse = isValidJson(weboutResponse)
+        parsedResponse = jsonResponse
       } catch {
         parsedResponse = response.data
       }
@@ -431,9 +438,15 @@ export class RequestClient implements HttpClient {
       includeSAS9Log = true
     }
 
-    let responseToReturn: { result: T; etag: any; log?: string } = {
+    let responseToReturn: {
+      result: T
+      etag: any
+      log?: string
+      status: number
+    } = {
       result: parsedResponse as T,
-      etag
+      etag,
+      status: response.status
     }
 
     if (includeSAS9Log) {

src/request/Sas9RequestClient.ts

@@ -39,7 +39,7 @@ export class Sas9RequestClient extends RequestClient {
     contentType: string = 'application/json',
     overrideHeaders: { [key: string]: string | number } = {},
     debug: boolean = false
-  ): Promise<{ result: T; etag: string }> {
+  ): Promise<{ result: T; etag: string; status: number }> {
     const headers = {
       ...this.getHeaders(accessToken, contentType),
       ...overrideHeaders

src/test/SessionManager.spec.ts

@@ -1,7 +1,9 @@
 import { SessionManager } from '../SessionManager'
-import * as dotenv from 'dotenv'
 import { RequestClient } from '../request/RequestClient'
+import { NoSessionStateError } from '../types/errors'
+import * as dotenv from 'dotenv'
 import axios from 'axios'
+
 jest.mock('axios')
 const mockedAxios = axios as jest.Mocked<typeof axios>
 
@@ -43,4 +45,38 @@ describe('SessionManager', () => {
       ).resolves.toEqual(expectedResponse)
     })
   })
+
+  describe('waitForSession', () => {
+    it('should reject with NoSessionStateError if SAS server did not provide session state', async () => {
+      const responseStatus = 304
+
+      mockedAxios.get.mockImplementation(() =>
+        Promise.resolve({ data: '', status: responseStatus })
+      )
+
+      await expect(
+        sessionManager['waitForSession'](
+          {
+            id: 'id',
+            state: '',
+            links: [
+              { rel: 'state', href: '', uri: '', type: '', method: 'GET' }
+            ],
+            attributes: {
+              sessionInactiveTimeout: 0
+            },
+            creationTimeStamp: ''
+          },
+          null,
+          'access_token'
+        )
+      ).rejects.toEqual(
+        new NoSessionStateError(
+          responseStatus,
+          process.env.SERVER_URL as string,
+          'logUrl'
+        )
+      )
+    })
+  })
 })

src/test/utils/isValidJson.spec.ts

@@ -0,0 +1,31 @@
+import { isValidJson } from '../../utils'
+
+describe('jsonValidator', () => {
+  it('should not throw an error with an valid json', () => {
+    const json = {
+      test: 'test'
+    }
+
+    expect(isValidJson(json)).toBe(json)
+  })
+
+  it('should not throw an error with an valid json string', () => {
+    const json = {
+      test: 'test'
+    }
+
+    expect(isValidJson(JSON.stringify(json))).toStrictEqual(json)
+  })
+
+  it('should throw an error with an invalid json', () => {
+    const json = `{\"test\":\"test\"\"test2\":\"test\"}`
+
+    expect(() => {
+      try {
+        isValidJson(json)
+      } catch (err) {
+        throw new Error()
+      }
+    }).toThrowError
+  })
+})

src/types/errors/NoSessionStateError.ts

@@ -0,0 +1,15 @@
+export class NoSessionStateError extends Error {
+  constructor(
+    public serverResponseStatus: number,
+    public sessionStateUrl: string,
+    public logUrl: string
+  ) {
+    super(
+      `Could not get session state. Server responded with ${serverResponseStatus} whilst checking state: ${sessionStateUrl}`
+    )
+
+    this.name = 'NoSessionStatus'
+
+    Object.setPrototypeOf(this, NoSessionStateError.prototype)
+  }
+}

src/types/errors/index.ts

@@ -5,3 +5,4 @@ export * from './JobExecutionError'
 export * from './LoginRequiredError'
 export * from './NotFoundError'
 export * from './ErrorResponse'
+export * from './NoSessionStateError'

src/utils/auth.ts

@@ -1,35 +0,0 @@
-import jwtDecode from 'jwt-decode'
-
-/**
- * Checks if the Access Token is expired or is expiring in 1 hour.  A default Access Token
- * lasts 12 hours. If the Access Token expires, the Refresh Token is used to fetch a new
- * Access Token. In the case that the Refresh Token is expired, 1 hour is enough to let
- * most jobs finish.
- * @param {string} token- token string that will be evaluated
- */
-export function isAccessTokenExpiring(token: string): boolean {
-  if (!token) {
-    return true
-  }
-  const payload = jwtDecode<{ exp: number }>(token)
-  const timeToLive = payload.exp - new Date().valueOf() / 1000
-
-  return timeToLive <= 60 * 60 // 1 hour
-}
-
-/**
- * Checks if the Refresh Token is expired or expiring in 30 secs. A default Refresh Token
- * lasts 30 days.  Once the Refresh Token expires, the user must re-authenticate (provide
- * credentials in a browser to obtain an authorisation code). 30 seconds is enough time
- * to make a request for a final Access Token.
- * @param {string} token- token string that will be evaluated
- */
-export function isRefreshTokenExpiring(token?: string): boolean {
-  if (!token) {
-    return true
-  }
-  const payload = jwtDecode<{ exp: number }>(token)
-  const timeToLive = payload.exp - new Date().valueOf() / 1000
-
-  return timeToLive <= 30 // 30 seconds
-}

src/utils/index.ts

@@ -1,5 +1,4 @@
 export * from './asyncForEach'
-export * from './auth'
 export * from './compareTimestamps'
 export * from './convertToCsv'
 export * from './isRelativePath'
@@ -13,3 +12,4 @@ export * from './serialize'
 export * from './splitChunks'
 export * from './parseWeboutResponse'
 export * from './fetchLogByChunks'
+export * from './isValidJson'

src/utils/isValidJson.ts

@@ -0,0 +1,13 @@
+/**
+ * Checks if string is in valid JSON format else throw error.
+ * @param str - string to check.
+ */
+export const isValidJson = (str: string | object) => {
+  try {
+    if (typeof str === 'object') return str
+
+    return JSON.parse(str)
+  } catch (e) {
+    throw new Error('Invalid JSON response.')
+  }
+}

webpack.config.js

@@ -1,6 +1,7 @@
 const path = require('path')
 const webpack = require('webpack')
 const terserPlugin = require('terser-webpack-plugin')
+const nodePolyfillPlugin = require('node-polyfill-webpack-plugin')
 
 const defaultPlugins = [
   new webpack.ContextReplacementPlugin(/moment[\/\\]locale$/, /en/),
@@ -37,7 +38,7 @@ const browserConfig = {
   },
   resolve: {
     extensions: ['.ts', '.js'],
-    fallback: { https: false }
+    fallback: { https: false, fs: false, readline: false }
   },
   output: {
     filename: 'index.js',
@@ -49,7 +50,8 @@ const browserConfig = {
     ...defaultPlugins,
     new webpack.ProvidePlugin({
       process: 'process/browser'
-    })
+    }),
+    new nodePolyfillPlugin()
   ]
 }