@sasjs/adapter 3.9.4 → 3.10.2

package/node/index.js.LICENSE.txt

@@ -63,6 +63,7 @@
 /*!
  * mime-db
  * Copyright(c) 2014 Jonathan Ong
+ * Copyright(c) 2015-2022 Douglas Christopher Wilson
  * MIT Licensed
  */
 

package/node/types/errors/InvalidCsrfError.d.ts

@@ -0,0 +1,3 @@
+export declare class InvalidCsrfError extends Error {
+    constructor();
+}

package/package.json

@@ -8,15 +8,17 @@
     "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 ./checkNodeVersion.js build && cd build && npm version \"5.0.0\" && npm pack",
     "publish:lib": "npm run build && cd build && npm publish",
-    "lint:fix": "npx prettier --loglevel silent --write \"src/**/*.{ts,tsx,js,jsx,html,css,sass,less,json,yml,md,graphql}\" && npx prettier --loglevel silent --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}\"",
-    "lint:silent": "npx prettier --loglevel silent --check \"src/**/*.{ts,tsx,js,jsx,html,css,sass,less,json,yml,md,graphql}\" && npx prettier --loglevel silent --check \"sasjs-tests/src/**/*.{ts,tsx,js,jsx,html,css,sass,less,json,yml,md,graphql}\"",
+    "lint:fix": "npx prettier --loglevel silent --write \"src/**/*.{ts,tsx,js,jsx,html,css,sass,less,json,yml,md,graphql}\" && npx prettier --loglevel silent --write \"sasjs-tests/src/**/*.{ts,tsx,js,jsx,html,css,sass,less,json,yml,md,graphql}\" && npx prettier --loglevel silent --write \"cypress/**/*.{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}\" && npx prettier --check \"cypress/**/*.{ts,tsx,js,jsx,html,css,sass,less,json,yml,md,graphql}\"",
+    "lint:silent": "npx prettier --loglevel silent --check \"src/**/*.{ts,tsx,js,jsx,html,css,sass,less,json,yml,md,graphql}\" && npx prettier --loglevel silent --check \"sasjs-tests/src/**/*.{ts,tsx,js,jsx,html,css,sass,less,json,yml,md,graphql}\" && npx prettier --loglevel silent --check \"cypress/**/*.{ts,tsx,js,jsx,html,css,sass,less,json,yml,md,graphql}\"",
     "test": "jest --silent --coverage",
     "prepublishOnly": "cp -r ./build/* . && rm -rf ./build",
     "postpublish": "git clean -fd",
     "semantic-release": "semantic-release",
     "typedoc": "node createTSDocs",
-    "prepare": "git rev-parse --git-dir && git config core.hooksPath ./.git-hooks && git config core.autocrlf false || true"
+    "prepare": "git rev-parse --git-dir && git config core.hooksPath ./.git-hooks && git config core.autocrlf false || true",
+    "cypress": "cypress open",
+    "cy:run": "cypress run"
   },
   "publishConfig": {
     "access": "public"
@@ -41,9 +43,13 @@
   },
   "license": "ISC",
   "devDependencies": {
+    "@cypress/webpack-preprocessor": "5.9.1",
+    "@types/form-data": "2.5.0",
+    "cypress": "7.7.0",
+    "typedoc-neo-theme": "1.1.1",
+    "typedoc-plugin-external-module-name": "4.0.6",
     "@types/axios": "0.14.0",
     "@types/express": "4.17.13",
-    "@types/form-data": "2.5.0",
     "@types/jest": "27.4.0",
     "@types/mime": "2.0.3",
     "@types/pem": "1.9.6",
@@ -80,5 +86,5 @@
     "https": "1.0.0",
     "tough-cookie": "4.0.0"
   },
-  "version": "3.9.4"
+  "version": "3.10.2"
 }

package/src/auth/AuthManager.ts

@@ -257,6 +257,12 @@ export class AuthManager {
     const isLoggedIn = loginResponse !== 'authErr'
     const userName = isLoggedIn ? this.extractUserName(loginResponse) : ''
 
+    if (!isLoggedIn) {
+      //We will logout to make sure cookies are removed and login form is presented
+      //Residue can happen in case of session expiration
+      await this.logOut()
+    }
+
     return { isLoggedIn, userName }
   }
 

package/src/job-execution/WebJobExecutor.ts

@@ -92,7 +92,7 @@ export class WebJobExecutor extends BaseJobExecutor {
       if (jobUri.length > 0) {
         apiUrl += '&_job=' + jobUri
         /**
-         * Using both _job and _program parameters will cause a conflict in the JES web app, as it’s not clear whether or not the server should make the extra fetch for the job uri.
+         * Using both _job and _program parameters will cause a conflict in the JES web app, as it's not clear whether or not the server should make the extra fetch for the job uri.
          * To handle this, we add the extra underscore and recreate the _program variable in the SAS side of the SASjs adapter so it remains available for backend developers.
          */
         apiUrl = apiUrl.replace('_program=', '__program=')
@@ -169,13 +169,17 @@ export class WebJobExecutor extends BaseJobExecutor {
               ? res.result.log.map((logLine: any) => logLine.line).join('\n')
               : res.result.log
 
-          const resObj =
-            this.serverType === ServerType.Sasjs
-              ? {
-                  result: res.result._webout,
-                  log: parsedSasjsServerLog
-                }
-              : res
+          const resObj = res
+
+          if (this.serverType === ServerType.Sasjs) {
+            if (res.result._webout.length < 1)
+              throw new JobExecutionError(
+                0,
+                'Job execution failed',
+                parsedSasjsServerLog
+              )
+          }
+
           this.requestClient!.appendRequest(resObj, sasJob, config.debug)
 
           let jsonResponse = res.result

package/src/request/RequestClient.ts

@@ -19,6 +19,7 @@ import {
   parseSourceCode,
   createAxiosInstance
 } from '../utils'
+import { InvalidCsrfError } from '../types/errors/InvalidCsrfError'
 
 export interface HttpClient {
   get<T>(
@@ -498,6 +499,24 @@ export class RequestClient implements HttpClient {
       throw e
     }
 
+    if (e instanceof InvalidCsrfError) {
+      // Fetching root will inject CSRF token in cookie
+      await this.httpClient
+        .get('/', {
+          withCredentials: true
+        })
+        .catch((err) => {
+          throw prefixMessage(err, 'Error while re-fetching CSRF token.')
+        })
+
+      return await callback().catch((err: any) => {
+        throw prefixMessage(
+          err,
+          'Error while executing callback in handleError. '
+        )
+      })
+    }
+
     if (response?.status === 403 || response?.status === 449) {
       this.parseAndSetCsrfToken(response)
 
@@ -584,9 +603,17 @@ export class RequestClient implements HttpClient {
 export const throwIfError = (response: AxiosResponse) => {
   switch (response.status) {
     case 400:
-      if (typeof response.data === 'object') {
+      if (
+        typeof response.data === 'object' &&
+        response.data.error === 'invalid_grant'
+      ) {
+        // In SASVIYA when trying to get access token, if auth code is wrong status code will be 400 so in such case we return login required error.
         throw new LoginRequiredError(response.data)
       }
+
+      if (response.data.toLowerCase() === 'invalid csrf token!') {
+        throw new InvalidCsrfError()
+      }
       break
     case 401:
       if (typeof response.data === 'object') {

package/src/types/errors/InvalidCsrfError.ts

@@ -0,0 +1,9 @@
+export class InvalidCsrfError extends Error {
+  constructor() {
+    const message = 'Invalid CSRF token!'
+
+    super(`Auth error: ${message}`)
+    this.name = 'InvalidCsrfError'
+    Object.setPrototypeOf(this, InvalidCsrfError.prototype)
+  }
+}

package/types/errors/InvalidCsrfError.d.ts

@@ -0,0 +1,3 @@
+export declare class InvalidCsrfError extends Error {
+    constructor();
+}

package/.gitpod.yml

@@ -1,2 +0,0 @@
-tasks:
-  - init: npm install && npm run build

package/.prettierrc

@@ -1,6 +0,0 @@
-{
-  "trailingComma": "none",
-  "tabWidth": 2,
-  "semi": false,
-  "singleQuote": true
-}

package/jest.config.js

@@ -1,184 +0,0 @@
-// For a detailed explanation regarding each configuration property, visit:
-// https://jestjs.io/docs/en/configuration.html
-
-module.exports = {
-  testTimeout: 90000,
-  // All imported modules in your tests should be mocked automatically
-  // automock: false,
-
-  // Stop running tests after `n` failures
-  // bail: 1,
-
-  // Respect "browser" field in package.json when resolving modules
-  // browser: false,
-
-  // The directory where Jest should store its cached dependency information
-  // cacheDirectory: "/private/var/folders/7y/nmqg1srj29q6210rs9dfsdzc0000gn/T/jest_dx",
-
-  // Automatically clear mock calls and instances between every test
-  clearMocks: true,
-
-  // Indicates whether the coverage information should be collected while executing the test
-  // collectCoverage: false,
-
-  // An array of glob patterns indicating a set of files for which coverage information should be collected
-  // collectCoverageFrom: undefined,
-
-  // The directory where Jest should output its coverage files
-  coverageDirectory: 'coverage',
-
-  // An array of regexp pattern strings used to skip coverage collection
-  // coveragePathIgnorePatterns: [
-  //   "/node_modules/"
-  // ],
-
-  // A list of reporter names that Jest uses when writing coverage reports
-  // coverageReporters: [
-  //   "json",
-  //   "text",
-  //   "lcov",
-  //   "clover"
-  // ],
-
-  // An object that configures minimum threshold enforcement for coverage results
-  // coverageThreshold: undefined,
-
-  // A path to a custom dependency extractor
-  // dependencyExtractor: undefined,
-
-  // Make calling deprecated APIs throw helpful error messages
-  // errorOnDeprecated: false,
-
-  // Force coverage collection from ignored files using an array of glob patterns
-  // forceCoverageMatch: [],
-
-  // A path to a module which exports an async function that is triggered once before all test suites
-  // globalSetup: undefined,
-
-  // A path to a module which exports an async function that is triggered once after all test suites
-  // globalTeardown: undefined,
-
-  // A set of global variables that need to be available in all test environments
-  // globals: {},
-
-  // The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
-  // maxWorkers: "50%",
-
-  // An array of directory names to be searched recursively up from the requiring module's location
-  // moduleDirectories: [
-  //   "node_modules"
-  // ],
-
-  // An array of file extensions your modules use
-  // moduleFileExtensions: [
-  //   "js",
-  //   "json",
-  //   "jsx",
-  //   "ts",
-  //   "tsx",
-  //   "node"
-  // ],
-
-  // A map from regular expressions to module names that allow to stub out resources with a single module
-  moduleNameMapper: {},
-
-  // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
-  // modulePathIgnorePatterns: [],
-
-  // Activates notifications for test results
-  // notify: false,
-
-  // An enum that specifies notification mode. Requires { notify: true }
-  // notifyMode: "failure-change",
-
-  // A preset that is used as a base for Jest's configuration
-  preset: 'ts-jest/presets/js-with-ts',
-
-  // Run tests from one or more projects
-  // projects: undefined,
-
-  // Use this configuration option to add custom reporters to Jest
-  // reporters: undefined,
-
-  // Automatically reset mock state between every test
-  // resetMocks: false,
-
-  // Reset the module registry before running each individual test
-  // resetModules: false,
-
-  // A path to a custom resolver
-  // resolver: undefined,
-
-  // Automatically restore mock state between every test
-  // restoreMocks: false,
-
-  // The root directory that Jest should scan for tests and modules within
-  // rootDir: undefined,
-
-  // A list of paths to directories that Jest should use to search for files in
-  // roots: [
-  //   "<rootDir>"
-  // ],
-
-  // Allows you to use a custom runner instead of Jest's default test runner
-  // runner: "jest-runner",
-
-  // The paths to modules that run some code to configure or set up the testing environment before each test
-  setupFiles: [],
-
-  // A list of paths to modules that run some code to configure or set up the testing framework before each test
-  setupFilesAfterEnv: ['jest-extended/all'],
-
-  // A list of paths to snapshot serializer modules Jest should use for snapshot testing
-  // snapshotSerializers: [],
-
-  // Options that will be passed to the testEnvironment
-  // testEnvironmentOptions: {},
-
-  // Adds a location field to test results
-  // testLocationInResults: false,
-
-  // The glob patterns Jest uses to detect test files
-  testMatch: ['**/*spec.[j|t]s?(x)'],
-
-  // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
-  testPathIgnorePatterns: ['/node_modules/', '/build'],
-
-  // The regexp pattern or array of patterns that Jest uses to detect test files
-  // testRegex: [],
-
-  // This option allows the use of a custom results processor
-  // testResultsProcessor: undefined,
-
-  // This option allows use of a custom test runner
-  // testRunner: "jasmine2",
-
-  // This option sets the URL for the jsdom environment. It is reflected in properties such as location.href
-  // testURL: "http://localhost",
-
-  // Setting this value to "fake" allows the use of fake timers for functions such as "setTimeout"
-  // timers: "real",
-
-  // A map from regular expressions to paths to transformers
-  transform: {
-    '^.+\\.ts?$': 'ts-jest'
-  }
-
-  // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
-  // transformIgnorePatterns: [
-  //   '**/test/**/*.ts?(x)',
-  //   '**/?(*.)+(spec|test).ts?(x)'
-  // ]
-
-  // An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
-  // unmockedModulePathPatterns: undefined,
-
-  // Indicates whether each individual test should be reported during the run
-  // verbose: undefined,
-
-  // An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
-  // watchPathIgnorePatterns: [],
-
-  // Whether to use watchman for file crawling
-  // watchman: true,
-}

package/tsconfig.json

@@ -1,14 +0,0 @@
-{
-  "compilerOptions": {
-    "lib": ["ES2018", "DOM", "ES2019.String"],
-    "target": "es5",
-    "module": "commonjs",
-    "declaration": true,
-    "outDir": "./build",
-    "strict": true,
-    "sourceMap": true,
-    "typeRoots": ["./node_modules/@types", "./src/types/system"]
-  },
-  "include": ["src"],
-  "exclude": ["node_modules"]
-}

package/tslint.json

@@ -1,9 +0,0 @@
-{
-  "extends": ["tslint:recommended", "tslint-config-prettier"],
-  "rules": {
-    "no-string-literal": false,
-    "forin": false,
-    "no-console": false,
-    "max-classes-per-file": false
-  }
-}

package/typedoc.json

@@ -1,13 +0,0 @@
-{
-  "out": "docs",
-  "exclude": ["**/*+(index|.spec|.e2e).ts"],
-  "excludeExternals": true,
-  "excludePrivate": true,
-  "entryPoints": [
-    "src/SASjs.ts",
-    "src/SAS9ApiClient.ts",
-    "src/SASjsApiClient.ts",
-    "src/SASViyaApiClient.ts",
-    "src/types"
-  ]
-}

package/webpack.config.js

@@ -1,79 +0,0 @@
-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/),
-  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: optimization,
-  module: {
-    rules: [
-      {
-        test: /\.ts?$/,
-        use: 'ts-loader',
-        exclude: /node_modules/
-      }
-    ]
-  },
-  resolve: {
-    extensions: ['.ts', '.js'],
-    fallback: { https: false, fs: false, readline: false }
-  },
-  output: {
-    filename: 'index.js',
-    path: path.resolve(__dirname, 'build'),
-    libraryTarget: 'umd',
-    library: 'SASjs'
-  },
-  plugins: [
-    ...defaultPlugins,
-    new webpack.ProvidePlugin({
-      process: 'process/browser'
-    }),
-    new nodePolyfillPlugin()
-  ]
-}
-
-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 = {
-  ...browserConfigWithoutProcessPlugin,
-  target: 'node',
-  entry: './node/index.ts',
-  output: {
-    ...browserConfig.output,
-    path: path.resolve(__dirname, 'build', 'node')
-  }
-}
-
-module.exports = [browserConfig, nodeConfig]