Merge pull request #581 from sasjs/package-lock-and-node-version

fix: updated package-lock + updated node version for workflow

.github/workflows/build.yml

@@ -13,14 +13,15 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [15.x]
+        node-version: [lts/*]
 
     steps:
       - uses: actions/checkout@v2
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v2
         with:
           node-version: ${{ matrix.node-version }}
+          cache: npm
       - name: Install Dependencies
         run: npm ci
       - name: Check code style

.npmignore

@@ -3,3 +3,4 @@ docs/
 .github/
 *.md
 *.spec.ts
+.all-contributorsrc

package.json

@@ -41,17 +41,21 @@
   "license": "ISC",
   "devDependencies": {
     "@types/axios": "^0.14.0",
+    "@types/express": "^4.17.13",
     "@types/form-data": "^2.5.0",
     "@types/jest": "^27.0.1",
     "@types/mime": "^2.0.3",
+    "@types/pem": "^1.9.6",
     "@types/tough-cookie": "^4.0.1",
     "copyfiles": "^2.4.1",
     "cp": "^0.2.0",
     "dotenv": "^10.0.0",
+    "express": "^4.17.1",
     "jest": "^27.2.0",
     "jest-extended": "^0.11.5",
     "node-polyfill-webpack-plugin": "^1.1.4",
     "path": "^0.12.7",
+    "pem": "^1.14.4",
     "process": "^0.11.10",
     "rimraf": "^3.0.2",
     "semantic-release": "^17.4.7",
@@ -69,7 +73,7 @@
   },
   "main": "index.js",
   "dependencies": {
-    "@sasjs/utils": "^2.30.0",
+    "@sasjs/utils": "^2.32.0",
     "axios": "^0.21.4",
     "axios-cookiejar-support": "^1.0.1",
     "form-data": "^4.0.0",

sasjs-tests/package.json

@@ -5,7 +5,7 @@
   "private": true,
   "dependencies": {
     "@sasjs/adapter": "file:../build/sasjs-adapter-5.0.0.tgz",
-    "@sasjs/test-framework": "^1.4.0",
+    "@sasjs/test-framework": "^1.4.2",
     "@types/jest": "^26.0.20",
     "@types/node": "^14.14.41",
     "@types/react": "^17.0.1",

sasjs-tests/src/testSuites/Basic.ts

@@ -13,7 +13,6 @@ const defaultConfig: SASjsConfig = {
   debug: false,
   contextName: 'SAS Job Execution compute context',
   useComputeApi: false,
-  allowInsecureRequests: false,
   loginMechanism: LoginMechanism.Default
 }
 

src/SAS9ApiClient.ts

@@ -1,3 +1,4 @@
+import * as https from 'https'
 import { generateTimestamp } from '@sasjs/utils/time'
 import * as NodeFormData from 'form-data'
 import { Sas9RequestClient } from './request/Sas9RequestClient'
@@ -13,10 +14,10 @@ export class SAS9ApiClient {
   constructor(
     private serverUrl: string,
     private jobsPath: string,
-    allowInsecureRequests: boolean
+    httpsAgentOptions?: https.AgentOptions
   ) {
     if (serverUrl) isUrl(serverUrl)
-    this.requestClient = new Sas9RequestClient(serverUrl, allowInsecureRequests)
+    this.requestClient = new Sas9RequestClient(serverUrl, httpsAgentOptions)
   }
 
   /**

src/SASjs.ts

@@ -4,10 +4,14 @@ import {
   UploadFile,
   EditContextInput,
   PollOptions,
-  LoginMechanism
+  LoginMechanism,
+  FolderMember,
+  ServiceMember,
+  ExecutionQuery
 } from './types'
 import { SASViyaApiClient } from './SASViyaApiClient'
 import { SAS9ApiClient } from './SAS9ApiClient'
+import { SASjsApiClient } from './SASjsApiClient'
 import { AuthManager } from './auth'
 import {
   ServerType,
@@ -36,7 +40,6 @@ const defaultConfig: SASjsConfig = {
   debug: false,
   contextName: 'SAS Job Execution compute context',
   useComputeApi: null,
-  allowInsecureRequests: false,
   loginMechanism: LoginMechanism.Default
 }
 
@@ -49,6 +52,7 @@ export default class SASjs {
   private jobsPath: string = ''
   private sasViyaApiClient: SASViyaApiClient | null = null
   private sas9ApiClient: SAS9ApiClient | null = null
+  private SASjsApiClient: SASjsApiClient | null = null
   private fileUploader: FileUploader | null = null
   private authManager: AuthManager | null = null
   private requestClient: RequestClient | null = null
@@ -57,7 +61,7 @@ export default class SASjs {
   private jesJobExecutor: JobExecutor | null = null
   private sas9JobExecutor: JobExecutor | null = null
 
-  constructor(config?: any) {
+  constructor(config?: Partial<SASjsConfig>) {
     this.sasjsConfig = {
       ...defaultConfig,
       ...config
@@ -792,7 +796,7 @@ export default class SASjs {
         sasApiClient = new SAS9ApiClient(
           serverUrl,
           this.jobsPath,
-          this.sasjsConfig.allowInsecureRequests
+          this.sasjsConfig.httpsAgentOptions
         )
       }
     } else {
@@ -824,6 +828,14 @@ export default class SASjs {
     )
   }
 
+  public async deployToSASjs(members: [FolderMember, ServiceMember]) {
+    return await this.SASjsApiClient?.deploy(members, this.sasjsConfig.appLoc)
+  }
+
+  public async executeJobSASjs(query: ExecutionQuery) {
+    return await this.SASjsApiClient?.executeJob(query)
+  }
+
   /**
    * Kicks off execution of the given job via the compute API.
    * @returns an object representing the compute session created for the given job.
@@ -951,12 +963,12 @@ export default class SASjs {
     if (!this.requestClient) {
       this.requestClient = new RequestClient(
         this.sasjsConfig.serverUrl,
-        this.sasjsConfig.allowInsecureRequests
+        this.sasjsConfig.httpsAgentOptions
       )
     } else {
       this.requestClient.setConfig(
         this.sasjsConfig.serverUrl,
-        this.sasjsConfig.allowInsecureRequests
+        this.sasjsConfig.httpsAgentOptions
       )
     }
 
@@ -973,30 +985,44 @@ export default class SASjs {
     )
 
     if (this.sasjsConfig.serverType === ServerType.SasViya) {
-      if (this.sasViyaApiClient)
+      if (this.sasViyaApiClient) {
         this.sasViyaApiClient!.setConfig(
           this.sasjsConfig.serverUrl,
           this.sasjsConfig.appLoc
         )
-      else
+      } else {
         this.sasViyaApiClient = new SASViyaApiClient(
           this.sasjsConfig.serverUrl,
           this.sasjsConfig.appLoc,
           this.sasjsConfig.contextName,
           this.requestClient
         )
+      }
 
       this.sasViyaApiClient.debug = this.sasjsConfig.debug
     }
+
     if (this.sasjsConfig.serverType === ServerType.Sas9) {
-      if (this.sas9ApiClient)
+      if (this.sas9ApiClient) {
         this.sas9ApiClient!.setConfig(this.sasjsConfig.serverUrl)
-      else
+      } else {
         this.sas9ApiClient = new SAS9ApiClient(
           this.sasjsConfig.serverUrl,
           this.jobsPath,
-          this.sasjsConfig.allowInsecureRequests
+          this.sasjsConfig.httpsAgentOptions
         )
+      }
+    }
+
+    if (this.sasjsConfig.serverType === ServerType.Sasjs) {
+      if (this.SASjsApiClient) {
+        this.SASjsApiClient.setConfig(this.sasjsConfig.serverUrl)
+      } else {
+        this.SASjsApiClient = new SASjsApiClient(
+          this.sasjsConfig.serverUrl,
+          this.requestClient
+        )
+      }
     }
 
     this.fileUploader = new FileUploader(
@@ -1018,7 +1044,7 @@ export default class SASjs {
       this.sasjsConfig.serverUrl,
       this.sasjsConfig.serverType!,
       this.jobsPath,
-      this.sasjsConfig.allowInsecureRequests
+      this.sasjsConfig.httpsAgentOptions
     )
 
     this.computeJobExecutor = new ComputeJobExecutor(

src/SASjsApiClient.ts

@@ -0,0 +1,39 @@
+import { FolderMember, ServiceMember, ExecutionQuery } from './types'
+import { RequestClient } from './request/RequestClient'
+
+export class SASjsApiClient {
+  constructor(
+    private serverUrl: string,
+    private requestClient: RequestClient
+  ) {}
+
+  public setConfig(serverUrl: string) {
+    if (serverUrl) this.serverUrl = serverUrl
+  }
+
+  public async deploy(members: [FolderMember, ServiceMember], appLoc: string) {
+    const { result } = await this.requestClient.post<{
+      status: string
+      message: string
+      example?: {}
+    }>(
+      'SASjsApi/drive/deploy',
+      { fileTree: members, appLoc: appLoc },
+      undefined
+    )
+
+    return Promise.resolve(result)
+  }
+
+  public async executeJob(query: ExecutionQuery) {
+    const { result } = await this.requestClient.post<{
+      status: string
+      message: string
+      log?: string
+      logPath?: string
+      error?: {}
+    }>('SASjsApi/stp/execute', query, undefined)
+
+    return Promise.resolve(result)
+  }
+}

src/auth/AuthManager.ts

@@ -256,6 +256,8 @@ export class AuthManager {
           .split(' ')
           .map((name: string) => name.slice(0, 3).toLowerCase())
           .join('')
+      default:
+        return ''
     }
   }
 

src/auth/getAccessToken.ts

@@ -46,7 +46,7 @@ export async function getAccessToken(
     )
     .then((res) => res.result as SasAuthResponse)
     .catch((err) => {
-      throw prefixMessage(err, 'Error while getting access token')
+      throw prefixMessage(err, 'Error while getting access token. ')
     })
 
   return authResponse

src/job-execution/Sas9JobExecutor.ts

@@ -1,3 +1,4 @@
+import * as https from 'https'
 import { ServerType } from '@sasjs/utils/types'
 import * as NodeFormData from 'form-data'
 import { ErrorResponse } from '../types/errors'
@@ -17,10 +18,10 @@ export class Sas9JobExecutor extends BaseJobExecutor {
     serverUrl: string,
     serverType: ServerType,
     private jobsPath: string,
-    allowInsecureRequests: boolean
+    httpsAgentOptions?: https.AgentOptions
   ) {
     super(serverUrl, serverType)
-    this.requestClient = new Sas9RequestClient(serverUrl, allowInsecureRequests)
+    this.requestClient = new Sas9RequestClient(serverUrl, httpsAgentOptions)
   }
 
   async execute(sasJob: string, data: any, config: any) {

src/request/RequestClient.ts

@@ -1,4 +1,5 @@
-import axios, { AxiosInstance, AxiosRequestConfig, AxiosResponse } from 'axios'
+import { AxiosInstance, AxiosRequestConfig, AxiosResponse } from 'axios'
+import * as https from 'https'
 import { CsrfToken } from '..'
 import { isAuthorizeFormRequired, isLogInRequired } from '../auth'
 import {
@@ -12,7 +13,11 @@ import { SASjsRequest } from '../types'
 import { parseWeboutResponse } from '../utils/parseWeboutResponse'
 import { prefixMessage } from '@sasjs/utils/error'
 import { SAS9AuthError } from '../types/errors/SAS9AuthError'
-import { parseGeneratedCode, parseSourceCode } from '../utils'
+import {
+  parseGeneratedCode,
+  parseSourceCode,
+  createAxiosInstance
+} from '../utils'
 
 export interface HttpClient {
   get<T>(
@@ -54,12 +59,15 @@ export class RequestClient implements HttpClient {
   protected fileUploadCsrfToken: CsrfToken | undefined
   protected httpClient!: AxiosInstance
 
-  constructor(protected baseUrl: string, allowInsecure = false) {
-    this.createHttpClient(baseUrl, allowInsecure)
+  constructor(
+    protected baseUrl: string,
+    httpsAgentOptions?: https.AgentOptions
+  ) {
+    this.createHttpClient(baseUrl, httpsAgentOptions)
   }
 
-  public setConfig(baseUrl: string, allowInsecure = false) {
-    this.createHttpClient(baseUrl, allowInsecure)
+  public setConfig(baseUrl: string, httpsAgentOptions?: https.AgentOptions) {
+    this.createHttpClient(baseUrl, httpsAgentOptions)
   }
 
   public getCsrfToken(type: 'general' | 'file' = 'general') {
@@ -511,23 +519,18 @@ export class RequestClient implements HttpClient {
     return responseToReturn
   }
 
-  private createHttpClient(baseUrl: string, allowInsecure = false) {
-    const https = require('https')
-    if (allowInsecure && https.Agent) {
-      this.httpClient = axios.create({
-        baseURL: baseUrl,
-        httpsAgent: new https.Agent({
-          rejectUnauthorized: !allowInsecure
-        })
-      })
-    } else {
-      this.httpClient = axios.create({
-        baseURL: baseUrl
-      })
-    }
+  private createHttpClient(
+    baseUrl: string,
+    httpsAgentOptions?: https.AgentOptions
+  ) {
+    const httpsAgent = httpsAgentOptions
+      ? new https.Agent(httpsAgentOptions)
+      : undefined
+
+    this.httpClient = createAxiosInstance(baseUrl, httpsAgent)
 
     this.httpClient.defaults.validateStatus = (status) =>
-      status >= 200 && status < 305
+      status >= 200 && status < 401
   }
 }
 

src/request/Sas9RequestClient.ts

@@ -1,3 +1,4 @@
+import * as https from 'https'
 import { AxiosRequestConfig } from 'axios'
 import axiosCookieJarSupport from 'axios-cookiejar-support'
 import * as tough from 'tough-cookie'
@@ -9,8 +10,8 @@ import { RequestClient, throwIfError } from './RequestClient'
  * Handles redirects and cookie management.
  */
 export class Sas9RequestClient extends RequestClient {
-  constructor(baseUrl: string, allowInsecure = false) {
-    super(baseUrl, allowInsecure)
+  constructor(baseUrl: string, httpsAgentOptions?: https.AgentOptions) {
+    super(baseUrl, httpsAgentOptions)
     this.httpClient.defaults.maxRedirects = 0
     this.httpClient.defaults.validateStatus = (status) =>
       status >= 200 && status < 303

src/test/RequestClient.spec.ts

@@ -0,0 +1,167 @@
+import * as pem from 'pem'
+import * as http from 'http'
+import * as https from 'https'
+import { app, mockedAuthResponse } from './SAS_server_app'
+import { ServerType } from '@sasjs/utils'
+import SASjs from '../SASjs'
+import * as axiosModules from '../utils/createAxiosInstance'
+
+const axiosActual = jest.requireActual('axios')
+
+jest
+  .spyOn(axiosModules, 'createAxiosInstance')
+  .mockImplementation((baseURL: string, httpsAgent?: https.Agent) =>
+    axiosActual.create({ baseURL, httpsAgent })
+  )
+
+const PORT = 8000
+const SERVER_URL = `https://localhost:${PORT}/`
+
+const ERROR_MESSAGES = {
+  selfSigned: 'self signed certificate',
+  CCA: 'unable to verify the first certificate'
+}
+
+describe('RequestClient', () => {
+  let server: http.Server
+
+  const adapter = new SASjs({
+    serverUrl: `http://localhost:${PORT}/`,
+    serverType: ServerType.SasViya
+  })
+
+  beforeAll(async () => {
+    await new Promise((resolve: any, reject: any) => {
+      server = app
+        .listen(PORT, () => resolve())
+        .on('error', (err: any) => reject(err))
+    })
+  })
+
+  afterAll(() => {
+    server.close()
+  })
+
+  it('should response the POST method', async () => {
+    const authResponse = await adapter.getAccessToken(
+      'clientId',
+      'clientSecret',
+      'authCode'
+    )
+
+    expect(authResponse.access_token).toBe(mockedAuthResponse.access_token)
+  })
+
+  it('should response the POST method with Unauthorized', async () => {
+    await expect(
+      adapter.getAccessToken('clientId', 'clientSecret', 'incorrect')
+    ).rejects.toThrow(
+      'Error while getting access token. Request failed with status code 401'
+    )
+  })
+})
+
+describe('RequestClient - Self Signed Server', () => {
+  let adapter: SASjs
+
+  let httpsServer: https.Server
+  let sslConfig: pem.CertificateCreationResult
+
+  beforeAll(async () => {
+    ;({ httpsServer, keys: sslConfig } = await setupSelfSignedServer())
+    await new Promise((resolve: any, reject: any) => {
+      httpsServer
+        .listen(PORT, () => resolve())
+        .on('error', (err: any) => reject(err))
+    })
+
+    adapter = new SASjs({
+      serverUrl: SERVER_URL,
+      serverType: ServerType.SasViya,
+      httpsAgentOptions: { ca: [sslConfig.certificate] }
+    })
+  })
+
+  afterAll(() => {
+    httpsServer.close()
+  })
+
+  it('should throw error for not providing certificate', async () => {
+    const adapterWithoutCertificate = new SASjs({
+      serverUrl: SERVER_URL,
+      serverType: ServerType.SasViya
+    })
+
+    await expect(
+      adapterWithoutCertificate.getAccessToken(
+        'clientId',
+        'clientSecret',
+        'authCode'
+      )
+    ).rejects.toThrow(
+      `Error while getting access token. ${ERROR_MESSAGES.selfSigned}`
+    )
+  })
+
+  it('should response the POST method using insecure flag', async () => {
+    const adapterAllowInsecure = new SASjs({
+      serverUrl: SERVER_URL,
+      serverType: ServerType.SasViya,
+      httpsAgentOptions: { rejectUnauthorized: false }
+    })
+
+    const authResponse = await adapterAllowInsecure.getAccessToken(
+      'clientId',
+      'clientSecret',
+      'authCode'
+    )
+
+    expect(authResponse.access_token).toBe(mockedAuthResponse.access_token)
+  })
+
+  it('should response the POST method', async () => {
+    const authResponse = await adapter.getAccessToken(
+      'clientId',
+      'clientSecret',
+      'authCode'
+    )
+
+    expect(authResponse.access_token).toBe(mockedAuthResponse.access_token)
+  })
+
+  it('should response the POST method with Unauthorized', async () => {
+    await expect(
+      adapter.getAccessToken('clientId', 'clientSecret', 'incorrect')
+    ).rejects.toThrow(
+      'Error while getting access token. Request failed with status code 401'
+    )
+  })
+})
+
+const setupSelfSignedServer = async (): Promise<{
+  httpsServer: https.Server
+  keys: pem.CertificateCreationResult
+}> => {
+  return await new Promise(async (resolve) => {
+    const keys = await createCertificate()
+
+    const httpsServer = https.createServer(
+      { key: keys.clientKey, cert: keys.certificate },
+      app
+    )
+
+    resolve({ httpsServer, keys })
+  })
+}
+
+const createCertificate = async (): Promise<pem.CertificateCreationResult> => {
+  return await new Promise((resolve, reject) => {
+    pem.createCertificate(
+      { days: 1, selfSigned: true },
+      (error: any, keys: pem.CertificateCreationResult) => {
+        if (error) reject(false)
+        resolve(keys)
+      }
+    )
+  })
+}

src/test/SAS_server_app.ts

@@ -0,0 +1,38 @@
+import express = require('express')
+
+export const app = express()
+
+export const mockedAuthResponse = {
+  access_token: 'access_token',
+  token_type: 'bearer',
+  id_token: 'id_token',
+  refresh_token: 'refresh_token',
+  expires_in: 43199,
+  scope: 'openid',
+  jti: 'jti'
+}
+
+app.get('/', function (req: any, res: any) {
+  res.send('Hello World')
+})
+
+app.post('/SASLogon/oauth/token', function (req: any, res: any) {
+  let valid = true
+  // capture the encoded form data
+  req.on('data', (data: any) => {
+    const resData = data.toString()
+
+    if (resData.includes('incorrect')) valid = false
+  })
+
+  // send a response when finished reading
+  // the encoded form data
+  req.on('end', () => {
+    if (valid) res.status(200).send(mockedAuthResponse)
+    else
+      res.status(401).send({
+        error: 'unauthorized',
+        error_description: 'Bad credentials'
+      })
+  })
+})

src/test/SessionManager.spec.ts

@@ -1,6 +1,5 @@
 import { SessionManager } from '../SessionManager'
 import { RequestClient } from '../request/RequestClient'
-import { NoSessionStateError } from '../types/errors'
 import * as dotenv from 'dotenv'
 import axios from 'axios'
 import { Logger, LogLevel } from '@sasjs/utils'

src/types/ExecuteScript.ts

@@ -0,0 +1,4 @@
+export interface ExecutionQuery {
+  _program: string
+  _debug?: number
+}

src/types/FileTree.ts

@@ -0,0 +1,47 @@
+export interface FileTree {
+  members: [FolderMember, ServiceMember]
+}
+
+export enum MemberType {
+  folder = 'folder',
+  service = 'service'
+}
+
+export interface FolderMember {
+  name: string
+  type: MemberType.folder
+  members: [FolderMember, ServiceMember]
+}
+
+export interface ServiceMember {
+  name: string
+  type: MemberType.service
+  code: string
+}
+
+export const isFileTree = (arg: any): arg is FileTree =>
+  arg &&
+  arg.members &&
+  Array.isArray(arg.members) &&
+  arg.members.filter(
+    (member: FolderMember | ServiceMember) =>
+      !isFolderMember(member) && !isServiceMember(member)
+  ).length === 0
+
+const isFolderMember = (arg: any): arg is FolderMember =>
+  arg &&
+  typeof arg.name === 'string' &&
+  arg.type === MemberType.folder &&
+  arg.members &&
+  Array.isArray(arg.members) &&
+  arg.members.filter(
+    (member: FolderMember | ServiceMember) =>
+      !isFolderMember(member) && !isServiceMember(member)
+  ).length === 0
+
+const isServiceMember = (arg: any): arg is ServiceMember =>
+  arg &&
+  typeof arg.name === 'string' &&
+  arg.type === MemberType.service &&
+  arg.code &&
+  typeof arg.code === 'string'

src/types/SASjsConfig.ts

@@ -1,3 +1,4 @@
+import * as https from 'https'
 import { ServerType } from '@sasjs/utils/types'
 
 /**
@@ -54,11 +55,11 @@ export class SASjsConfig {
    */
   useComputeApi: boolean | null = null
   /**
-   * Defaults to `false`.
-   * When set to `true`, the adapter will allow requests to SAS servers that use a self-signed SSL certificate.
-   * Changing this setting is not recommended.
+   * Optional settings to configure HTTPS Agent.
+   * By providing `key`, `cert`, `ca` to connect with server
+   * Other options can be set `rejectUnauthorized` and `requestCert`
    */
-  allowInsecureRequests = false
+  httpsAgentOptions?: https.AgentOptions
   /**
    * Supported login mechanisms are - Redirected and Default
    */

src/types/index.ts

@@ -12,3 +12,5 @@ export * from './Session'
 export * from './UploadFile'
 export * from './PollOptions'
 export * from './WriteStream'
+export * from './FileTree'
+export * from './ExecuteScript'

src/utils/createAxiosInstance.ts

@@ -0,0 +1,7 @@
+import axios from 'axios'
+import * as https from 'https'
+
+export const createAxiosInstance = (
+  baseURL: string,
+  httpsAgent?: https.Agent
+) => axios.create({ baseURL, httpsAgent })

src/utils/index.ts

@@ -1,6 +1,7 @@
 export * from './asyncForEach'
 export * from './compareTimestamps'
 export * from './convertToCsv'
+export * from './createAxiosInstance'
 export * from './delay'
 export * from './isNode'
 export * from './isRelativePath'