1
0
mirror of https://github.com/sasjs/adapter.git synced 2026-01-04 03:00:05 +00:00

Compare commits

...

41 Commits

Author SHA1 Message Date
Allan Bowe
1aa92c0a69 Merge pull request #107 from sasjs/access-token-missed
Access token missed
2020-09-23 21:26:46 +02:00
Mihajlo Medjedovic
4c097a69fd style: lint 2020-09-23 20:43:41 +02:00
Mihajlo Medjedovic
2634933e84 fix: accessToken not passed in function calls 2020-09-23 20:41:31 +02:00
Krishna Acondy
c1bab07b08 Merge pull request #105 from sasjs/file-upload-csrf
fix(jes-job-execution): prevent file upload requests failing with invalid CSRF token
2020-09-23 08:04:18 +01:00
Krishna Acondy
95f3ebd51d chore(dx): add pull request template 2020-09-22 12:40:11 +01:00
Krishna Acondy
0e5b72b54f Merge branch 'master' into file-upload-csrf 2020-09-22 12:29:48 +01:00
Krishna Acondy
33ce592379 fix(*): fix build issue with iconv-loader 2020-09-22 10:51:44 +01:00
Krishna Acondy
9f6591d7e3 chore(sasjs-tests): fix failing tests, bump adapter version 2020-09-22 09:32:45 +01:00
Krishna Acondy
5343ca00d8 fix(file-upload): maintain separate CSRF token for file uploads 2020-09-22 09:26:16 +01:00
Krishna Acondy
f764f1f22f Merge pull request #94 from sasjs/sas-job-absolute-paths
feat(job-execution): support absolute paths to SAS jobs
2020-09-22 08:46:04 +01:00
Krishna Acondy
978af5037e Merge branch 'master' of https://github.com/sasjs/adapter into sas-job-absolute-paths 2020-09-22 08:38:13 +01:00
Krishna Acondy
39e88052c7 Merge pull request #101 from sasjs/dependabot/npm_and_yarn/semantic-release-17.1.2
chore(deps-dev): bump semantic-release from 17.1.1 to 17.1.2
2020-09-22 08:34:38 +01:00
dependabot-preview[bot]
889351caf1 chore(deps-dev): bump semantic-release from 17.1.1 to 17.1.2
Bumps [semantic-release](https://github.com/semantic-release/semantic-release) from 17.1.1 to 17.1.2.
- [Release notes](https://github.com/semantic-release/semantic-release/releases)
- [Commits](https://github.com/semantic-release/semantic-release/compare/v17.1.1...v17.1.2)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2020-09-22 07:33:28 +00:00
Krishna Acondy
e6476dc230 Merge pull request #102 from sasjs/dependabot/npm_and_yarn/webpack-4.44.2
chore(deps-dev): bump webpack from 4.44.1 to 4.44.2
2020-09-22 08:31:20 +01:00
dependabot-preview[bot]
e7de45c94f chore(deps-dev): bump webpack from 4.44.1 to 4.44.2
Bumps [webpack](https://github.com/webpack/webpack) from 4.44.1 to 4.44.2.
- [Release notes](https://github.com/webpack/webpack/releases)
- [Commits](https://github.com/webpack/webpack/compare/v4.44.1...v4.44.2)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2020-09-22 07:30:22 +00:00
Krishna Acondy
2f822aba71 Merge pull request #103 from sasjs/dependabot/npm_and_yarn/types/jest-26.0.14
chore(deps-dev): bump @types/jest from 26.0.13 to 26.0.14
2020-09-22 08:28:16 +01:00
dependabot-preview[bot]
ba687bf8e2 chore(deps-dev): bump @types/jest from 26.0.13 to 26.0.14
Bumps [@types/jest](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/jest) from 26.0.13 to 26.0.14.
- [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
- [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/jest)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2020-09-22 07:21:57 +00:00
Krishna Acondy
618cbe5a21 Merge pull request #104 from sasjs/dependabot/npm_and_yarn/ts-loader-8.0.4
chore(deps-dev): bump ts-loader from 8.0.3 to 8.0.4
2020-09-22 08:19:40 +01:00
Krishna Acondy
d723150b6d fix(job-execution): support relative paths with web approach 2020-09-21 19:45:23 +01:00
dependabot-preview[bot]
b1ad983ca5 chore(deps-dev): bump ts-loader from 8.0.3 to 8.0.4
Bumps [ts-loader](https://github.com/TypeStrong/ts-loader) from 8.0.3 to 8.0.4.
- [Release notes](https://github.com/TypeStrong/ts-loader/releases)
- [Changelog](https://github.com/TypeStrong/ts-loader/blob/master/CHANGELOG.md)
- [Commits](https://github.com/TypeStrong/ts-loader/compare/v8.0.3...8.0.4)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2020-09-21 18:19:59 +00:00
Krishna Acondy
4711d0510e Merge branch 'master' of https://github.com/sasjs/adapter into sas-job-absolute-paths 2020-09-21 08:47:19 +01:00
Krishna Acondy
93854c287f Merge pull request #100 from sasjs/descs
chore(doc): Update descriptions of SASjsConfig properties
2020-09-21 08:45:29 +01:00
Krishna Acondy
687a3047fd chore(*): remove trailing slashes 2020-09-21 08:38:03 +01:00
Krishna Acondy
c067c6e74d chore(*): remove log 2020-09-21 08:26:18 +01:00
Allan Bowe
04b44f40ba docs: updates to description of SASjsConfig items 2020-09-20 20:23:04 +02:00
Allan Bowe
ce2126bd34 docs: typedocs 2020-09-20 20:22:44 +02:00
Krishna Acondy
638efe8899 chore(build): add terser plugin for code optimization 2020-09-20 12:00:02 +01:00
Krishna Acondy
23353355e4 chore(build): update webpack config to minify built code 2020-09-20 11:59:37 +01:00
Krishna Acondy
1be64798c5 fix(job-execution): fetch log when webout is not available 2020-09-20 11:42:49 +01:00
Krishna Acondy
a92a458cf1 chore(types): export types from index 2020-09-20 11:42:29 +01:00
Krishna Acondy
703fdf9c02 fix(job-execution): fix program name 2020-09-20 10:35:32 +01:00
Krishna Acondy
bc239cf5d6 fix(job-execution): fix program path for absolute path jobs 2020-09-18 17:40:35 +01:00
Krishna Acondy
86780db478 fix(job-execution): fix program variable for absolute path jobs 2020-09-18 17:32:12 +01:00
Krishna Acondy
5d5afa20c7 chore(doc): update documentation 2020-09-18 16:49:54 +01:00
Krishna Acondy
d662c1a981 Merge branch 'master' into sas-job-absolute-paths 2020-09-18 16:45:13 +01:00
Krishna Acondy
f3abafd5ed Merge branch 'master' into sas-job-absolute-paths 2020-09-18 15:06:50 +01:00
Krishna Acondy
5076ea696c feat(job-execution): support absolute job paths for JES and web approaches 2020-09-18 09:24:33 +01:00
Krishna Acondy
3a60e6422c chore(sasjs-tests): fix failing test, add test for absolute path 2020-09-18 08:33:46 +01:00
Krishna Acondy
b90b5d5c03 Merge branch 'master' of https://github.com/sasjs/adapter into sas-job-absolute-paths 2020-09-18 08:25:21 +01:00
Krishna Acondy
d5a8140d4f feat(job-execution): populate folder map on demand 2020-09-17 09:35:43 +01:00
Krishna Acondy
5f5d84da87 feat(job-execution): support absolute paths to SAS jobs 2020-09-16 08:49:18 +01:00
58 changed files with 9223 additions and 1154 deletions

17
PULL_REQUEST_TEMPLATE.md Normal file
View File

@@ -0,0 +1,17 @@
## Issue
Link any related issue(s) in this section.
## Intent
What this PR intends to achieve.
## Implementation
What code changes have been made to achieve the intent.
## Checks
- [ ] Code is formatted correctly (`npm run lint:fix`).
- [ ] All unit tests are passing (`npm test`).
- [ ] All `sasjs-tests` are passing (instructions available [here](https://github.com/sasjs/adapter/blob/master/sasjs-tests/README.md)).

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

2221
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@@ -37,22 +37,22 @@
"license": "ISC", "license": "ISC",
"devDependencies": { "devDependencies": {
"@types/isomorphic-fetch": "0.0.35", "@types/isomorphic-fetch": "0.0.35",
"@types/jest": "^26.0.13", "@types/jest": "^26.0.14",
"cp": "^0.2.0", "cp": "^0.2.0",
"jest": "^25.5.4", "jest": "^25.5.4",
"path": "^0.12.7", "path": "^0.12.7",
"rimraf": "^3.0.2", "rimraf": "^3.0.2",
"semantic-release": "^17.1.1", "semantic-release": "^17.1.2",
"terser-webpack-plugin": "^4.2.2",
"ts-jest": "^25.5.1", "ts-jest": "^25.5.1",
"ts-loader": "^8.0.3", "ts-loader": "^8.0.4",
"tslint": "^6.1.3", "tslint": "^6.1.3",
"tslint-config-prettier": "^1.18.0", "tslint-config-prettier": "^1.18.0",
"typedoc": "^0.17.8", "typedoc": "^0.17.8",
"typedoc-neo-theme": "^1.0.10", "typedoc-neo-theme": "^1.0.10",
"typedoc-plugin-external-module-name": "^4.0.3", "typedoc-plugin-external-module-name": "^4.0.3",
"typescript": "^3.9.7", "typescript": "^3.9.7",
"uglifyjs-webpack-plugin": "^2.2.0", "webpack": "^4.44.2",
"webpack": "^4.44.1",
"webpack-cli": "^3.3.12" "webpack-cli": "^3.3.12"
}, },
"main": "index.js", "main": "index.js",

View File

@@ -1357,9 +1357,9 @@
"integrity": "sha512-shAmDyaQC4H92APFoIaVDHCx5bStIocgvbwQyxPRrbUY20V1EYTbSDchWbuwlMG3V17cprZhA6+78JfB+3DTPw==" "integrity": "sha512-shAmDyaQC4H92APFoIaVDHCx5bStIocgvbwQyxPRrbUY20V1EYTbSDchWbuwlMG3V17cprZhA6+78JfB+3DTPw=="
}, },
"@sasjs/adapter": { "@sasjs/adapter": {
"version": "1.3.13", "version": "1.12.0",
"resolved": "https://registry.npmjs.org/@sasjs/adapter/-/adapter-1.3.13.tgz", "resolved": "https://registry.npmjs.org/@sasjs/adapter/-/adapter-1.12.0.tgz",
"integrity": "sha512-dWcDxgY3FB7Yx1I5dPpeQeyJDu4lezhIFrjn6lbdwRhV15aqOt4l9o9qZP+VbgOXqyi9gN0Y+p+vs2chBDFQqg==", "integrity": "sha512-0uGQH9ynomWzdBaEujEtcR38q6V7LCgG0mrb1Wellv6cC/IHD3j6WfeZZAgtiMPeOSJjbCDBOlVnzC2TlBqJFw==",
"requires": { "requires": {
"es6-promise": "^4.2.8", "es6-promise": "^4.2.8",
"form-data": "^3.0.0", "form-data": "^3.0.0",

View File

@@ -4,7 +4,7 @@
"homepage": ".", "homepage": ".",
"private": true, "private": true,
"dependencies": { "dependencies": {
"@sasjs/adapter": "^1.3.13", "@sasjs/adapter": "^1.12.0",
"@sasjs/test-framework": "^1.4.0", "@sasjs/test-framework": "^1.4.0",
"@testing-library/jest-dom": "^4.2.4", "@testing-library/jest-dom": "^4.2.4",
"@testing-library/react": "^9.5.0", "@testing-library/react": "^9.5.0",

View File

@@ -13,7 +13,7 @@ const defaultConfig: SASjsConfig = {
}; };
const customConfig = { const customConfig = {
serverUrl: "url", serverUrl: "http://url.com",
pathSAS9: "sas9", pathSAS9: "sas9",
pathSASViya: "viya", pathSASViya: "viya",
appLoc: "/Public/seedapp", appLoc: "/Public/seedapp",

View File

@@ -47,6 +47,16 @@ const getLargeObjectData = () => {
export const sendArrTests = (adapter: SASjs): TestSuite => ({ export const sendArrTests = (adapter: SASjs): TestSuite => ({
name: "sendArr", name: "sendArr",
tests: [ tests: [
{
title: "Absolute paths",
description: "Should work with absolute paths to SAS jobs",
test: () => {
return adapter.request("/Public/app/common/sendArr", stringData);
},
assertion: (res: any) => {
return res.table1[0][0] === stringData.table1[0].col1;
}
},
{ {
title: "Single string value", title: "Single string value",
description: "Should send an array with a single string value", description: "Should send an array with a single string value",
@@ -78,7 +88,7 @@ export const sendArrTests = (adapter: SASjs): TestSuite => ({
return adapter.request("common/sendArr", data).catch((e) => e); return adapter.request("common/sendArr", data).catch((e) => e);
}, },
assertion: (error: any) => { assertion: (error: any) => {
return !!error && !!error.MESSAGE; return !!error && !!error.body && !!error.body.message;
} }
}, },
{ {
@@ -175,7 +185,7 @@ export const sendObjTests = (adapter: SASjs): TestSuite => ({
}; };
return adapter.request("common/sendObj", invalidData).catch((e) => e); return adapter.request("common/sendObj", invalidData).catch((e) => e);
}, },
assertion: (error: any) => !!error && !!error.MESSAGE assertion: (error: any) => !!error && !!error.body && !!error.body.message
}, },
{ {
title: "Single string value", title: "Single string value",
@@ -209,7 +219,7 @@ export const sendObjTests = (adapter: SASjs): TestSuite => ({
.catch((e) => e); .catch((e) => e);
}, },
assertion: (error: any) => { assertion: (error: any) => {
return !!error && !!error.MESSAGE; return !!error && !!error.body && !!error.body.message;
} }
}, },
{ {

View File

@@ -3,20 +3,21 @@ import {
parseAndSubmitAuthorizeForm, parseAndSubmitAuthorizeForm,
convertToCSV, convertToCSV,
makeRequest, makeRequest,
isRelativePath,
isUri, isUri,
isUrl isUrl
} from './utils' } from './utils'
import * as NodeFormData from 'form-data' import * as NodeFormData from 'form-data'
import * as path from 'path'
import { import {
Job, Job,
Session, Session,
Context, Context,
Folder, Folder,
CsrfToken, CsrfToken,
EditContextInput EditContextInput,
ErrorResponse,
JobDefinition
} from './types' } from './types'
import { JobDefinition } from './types/JobDefinition'
import { formatDataForRequest } from './utils/formatDataForRequest' import { formatDataForRequest } from './utils/formatDataForRequest'
import { SessionManager } from './SessionManager' import { SessionManager } from './SessionManager'
@@ -29,35 +30,34 @@ export class SASViyaApiClient {
private serverUrl: string, private serverUrl: string,
private rootFolderName: string, private rootFolderName: string,
private contextName: string, private contextName: string,
private setCsrfToken: (csrfToken: CsrfToken) => void, private setCsrfToken: (csrfToken: CsrfToken) => void
private rootFolderMap = new Map<string, Job[]>()
) { ) {
if (!rootFolderName) {
throw new Error('Root folder must be provided.')
}
if (serverUrl) isUrl(serverUrl) if (serverUrl) isUrl(serverUrl)
} }
private csrfToken: CsrfToken | null = null private csrfToken: CsrfToken | null = null
private rootFolder: Folder | null = null private fileUploadCsrfToken: CsrfToken | null = null
private sessionManager = new SessionManager( private sessionManager = new SessionManager(
this.serverUrl, this.serverUrl,
this.contextName, this.contextName,
this.setCsrfToken this.setCsrfToken
) )
private isForceDeploy: boolean = false private isForceDeploy: boolean = false
private folderMap = new Map<string, Job[]>()
/** /**
* Returns a map containing the directory structure in the currently set root folder. * Returns a list of jobs in the currently set root folder.
*/ */
public async getAppLocMap() { public async getJobsInFolder(folderPath: string) {
if (this.rootFolderMap.size) { const path = isRelativePath(folderPath)
return this.rootFolderMap ? `${this.rootFolderName}/${folderPath}`
: folderPath
if (this.folderMap.get(path)) {
return this.folderMap.get(path)
} }
this.populateRootFolderMap() await this.populateFolderMap(path)
return this.rootFolderMap return this.folderMap.get(path)
} }
/** /**
@@ -192,7 +192,7 @@ export class SASViyaApiClient {
} }
const { result: contexts } = await this.request<{ items: Context[] }>( const { result: contexts } = await this.request<{ items: Context[] }>(
`${this.serverUrl}/compute/contexts`, `${this.serverUrl}/compute/contexts?limit=10000`,
{ headers } { headers }
) )
const executionContext = const executionContext =
@@ -387,7 +387,7 @@ export class SASViyaApiClient {
/** /**
* Executes code on the current SAS Viya server. * Executes code on the current SAS Viya server.
* @param fileName - a name for the file being submitted for execution. * @param jobPath - the path to the file being submitted for execution.
* @param linesOfCode - an array of code lines to execute. * @param linesOfCode - an array of code lines to execute.
* @param contextName - the context to execute the code in. * @param contextName - the context to execute the code in.
* @param accessToken - an access token for an authorized user. * @param accessToken - an access token for an authorized user.
@@ -398,7 +398,7 @@ export class SASViyaApiClient {
* @param expectWebout - when set to true, the automatic _webout fileref will be checked for content, and that content returned. This fileref is used when the Job contains a SASjs web request (as opposed to executing arbitrary SAS code). * @param expectWebout - when set to true, the automatic _webout fileref will be checked for content, and that content returned. This fileref is used when the Job contains a SASjs web request (as opposed to executing arbitrary SAS code).
*/ */
public async executeScript( public async executeScript(
jobName: string, jobPath: string,
linesOfCode: string[], linesOfCode: string[],
contextName: string, contextName: string,
accessToken?: string, accessToken?: string,
@@ -436,13 +436,21 @@ export class SASViyaApiClient {
jobArguments['_DEBUG'] = 131 jobArguments['_DEBUG'] = 131
} }
const fileName = `exec-${ let fileName
jobName.includes('/') ? jobName.split('/')[1] : jobName if (isRelativePath(jobPath)) {
}` fileName = `exec-${
jobPath.includes('/') ? jobPath.split('/')[1] : jobPath
}`
} else {
const jobPathParts = jobPath.split('/')
fileName = jobPathParts.pop()
}
let jobVariables: any = { let jobVariables: any = {
SYS_JES_JOB_URI: '', SYS_JES_JOB_URI: '',
_program: this.rootFolderName + '/' + jobName _program: isRelativePath(jobPath)
? this.rootFolderName + '/' + jobPath
: jobPath
} }
let files: any[] = [] let files: any[] = []
@@ -534,9 +542,30 @@ export class SASViyaApiClient {
`${this.serverUrl}${resultLink}`, `${this.serverUrl}${resultLink}`,
{ headers }, { headers },
'text' 'text'
).catch((e) => ({ ).catch(async (e) => {
result: JSON.stringify(e) if (e && e.status === 404) {
})) if (logLink) {
log = await this.request<any>(
`${this.serverUrl}${logLink.href}/content?limit=10000`,
{
headers
}
).then((res: any) =>
res.result.items.map((i: any) => i.line).join('\n')
)
return Promise.reject(
new ErrorResponse('Job execution failed', {
status: 500,
body: log
})
)
}
}
return {
result: JSON.stringify(e)
}
})
} }
await this.sessionManager.clearSession(executionSessionId, accessToken) await this.sessionManager.clearSession(executionSessionId, accessToken)
@@ -545,7 +574,7 @@ export class SASViyaApiClient {
} catch (e) { } catch (e) {
if (e && e.status === 404) { if (e && e.status === 404) {
return this.executeScript( return this.executeScript(
jobName, jobPath,
linesOfCode, linesOfCode,
contextName, contextName,
accessToken, accessToken,
@@ -662,8 +691,11 @@ export class SASViyaApiClient {
createFolderRequest createFolderRequest
) )
// updates rootFolderMap with newly created folder. // update folder map with newly created folder.
await this.populateRootFolderMap(accessToken) await this.populateFolderMap(
`${parentFolderPath}/${folderName}`,
accessToken
)
return createFolderResponse return createFolderResponse
} }
@@ -892,30 +924,51 @@ export class SASViyaApiClient {
data?: any, data?: any,
accessToken?: string accessToken?: string
) { ) {
if (!this.rootFolder) { if (isRelativePath(sasJob) && !this.rootFolderName) {
await this.populateRootFolder(accessToken)
}
if (!this.rootFolder) {
throw new Error(`Root folder was not found.`)
}
if (!this.rootFolderMap.size) {
await this.populateRootFolderMap(accessToken)
}
if (!this.rootFolderMap.size) {
throw new Error( throw new Error(
`The job '${sasJob}' was not found in '${this.rootFolderName}'.` 'Relative paths cannot be used without specifying a root folder name'
) )
} }
if (isRelativePath(sasJob)) {
const folderName = sasJob.split('/')[0]
await this.populateFolderMap(
`${this.rootFolderName}/${folderName}`,
accessToken
)
if (!this.folderMap.get(`${this.rootFolderName}/${folderName}`)) {
throw new Error(
`The folder '${folderName}' was not found at '${this.serverUrl}/${this.rootFolderName}'`
)
}
} else {
const folderPathParts = sasJob.split('/')
folderPathParts.pop()
const folderPath = folderPathParts.join('/')
await this.populateFolderMap(folderPath, accessToken)
}
const headers: any = { 'Content-Type': 'application/json' } const headers: any = { 'Content-Type': 'application/json' }
if (!!accessToken) { if (!!accessToken) {
headers.Authorization = `Bearer ${accessToken}` headers.Authorization = `Bearer ${accessToken}`
} }
const folderName = sasJob.split('/')[0] let jobToExecute
const jobName = sasJob.split('/')[1] if (isRelativePath(sasJob)) {
const jobFolder = this.rootFolderMap.get(folderName) const folderName = sasJob.split('/')[0]
const jobToExecute = jobFolder?.find((item) => item.name === jobName) const jobName = sasJob.split('/')[1]
const jobFolder = this.folderMap.get(
`${this.rootFolderName}/${folderName}`
)
jobToExecute = jobFolder?.find((item) => item.name === jobName)
} else {
const folderPathParts = sasJob.split('/')
const jobName = folderPathParts.pop()
const folderPath = folderPathParts.join('/')
const jobFolder = this.folderMap.get(folderPath)
jobToExecute = jobFolder?.find((item) => item.name === jobName)
}
if (!jobToExecute) { if (!jobToExecute) {
throw new Error(`Job was not found.`) throw new Error(`Job was not found.`)
@@ -957,8 +1010,8 @@ export class SASViyaApiClient {
} }
/** /**
* Executes a job via the SAS Viya Job Execution API. * Executes a job via the SAS Viya Job Execution API
* @param sasJob - the relative path to the job. * @param sasJob - the relative or absolute path to the job.
* @param contextName - the name of the context where the job is to be executed. * @param contextName - the name of the context where the job is to be executed.
* @param debug - sets the _debug flag in the job arguments. * @param debug - sets the _debug flag in the job arguments.
* @param data - any data to be passed in as input to the job. * @param data - any data to be passed in as input to the job.
@@ -971,20 +1024,34 @@ export class SASViyaApiClient {
data?: any, data?: any,
accessToken?: string accessToken?: string
) { ) {
if (!this.rootFolder) { if (isRelativePath(sasJob) && !this.rootFolderName) {
await this.populateRootFolder(accessToken) throw new Error(
'Relative paths cannot be used without specifying a root folder name.'
)
} }
if (!this.rootFolder) { if (isRelativePath(sasJob)) {
throw new Error(`Root folder was not found.`) const folderName = sasJob.split('/')[0]
} await this.populateFolderMap(
if (!this.rootFolderMap.size) { `${this.rootFolderName}/${folderName}`,
await this.populateRootFolderMap(accessToken) accessToken
}
if (!this.rootFolderMap.size) {
throw new Error(
`The job '${sasJob}' was not found in folder '${this.rootFolderName}'.`
) )
if (!this.folderMap.get(`${this.rootFolderName}/${folderName}`)) {
throw new Error(
`The folder '${folderName}' was not found at '${this.serverUrl}/${this.rootFolderName}'.`
)
}
} else {
const folderPathParts = sasJob.split('/')
folderPathParts.pop()
const folderPath = folderPathParts.join('/')
await this.populateFolderMap(folderPath, accessToken)
if (!this.folderMap.get(folderPath)) {
throw new Error(
`The folder '${folderPath}' was not found at '${this.serverUrl}'.`
)
}
} }
let files: any[] = [] let files: any[] = []
@@ -992,124 +1059,128 @@ export class SASViyaApiClient {
files = await this.uploadTables(data, accessToken) files = await this.uploadTables(data, accessToken)
} }
const jobName = path.basename(sasJob) let jobToExecute: Job | undefined
const jobFolder = sasJob.replace(`/${jobName}`, '') let jobName: string | undefined
const allJobsInFolder = this.rootFolderMap.get(jobFolder.replace('/', '')) let jobPath: string | undefined
if (isRelativePath(sasJob)) {
if (allJobsInFolder) { const folderName = sasJob.split('/')[0]
const jobSpec = allJobsInFolder.find((j: Job) => j.name === jobName) jobName = sasJob.split('/')[1]
jobPath = `${this.rootFolderName}/${folderName}`
if (!jobSpec) { const jobFolder = this.folderMap.get(jobPath)
throw new Error('Job was not found.') jobToExecute = jobFolder?.find((item) => item.name === jobName)
}
const jobDefinitionLink = jobSpec?.links.find(
(l) => l.rel === 'getResource'
)?.href
if (!jobDefinitionLink) {
throw new Error('Job definition URI was not found.')
}
const requestInfo: any = {
method: 'GET'
}
const headers: any = { 'Content-Type': 'application/json' }
if (!!accessToken) {
headers.Authorization = `Bearer ${accessToken}`
}
requestInfo.headers = headers
const { result: jobDefinition } = await this.request<Job>(
`${this.serverUrl}${jobDefinitionLink}`,
requestInfo
)
const jobArguments: { [key: string]: any } = {
_contextName: contextName,
_program: `${this.rootFolderName}/${sasJob}`,
_webin_file_count: files.length,
_OMITJSONLISTING: true,
_OMITJSONLOG: true,
_OMITSESSIONRESULTS: true,
_OMITTEXTLISTING: true,
_OMITTEXTLOG: true
}
if (debug) {
jobArguments['_OMITTEXTLOG'] = 'false'
jobArguments['_OMITSESSIONRESULTS'] = 'false'
jobArguments['_DEBUG'] = 131
}
files.forEach((fileInfo, index) => {
jobArguments[
`_webin_fileuri${index + 1}`
] = `/files/files/${fileInfo.file.id}`
jobArguments[`_webin_name${index + 1}`] = fileInfo.tableName
})
const postJobRequest = {
method: 'POST',
headers,
body: JSON.stringify({
name: `exec-${jobName}`,
description: 'Powered by SASjs',
jobDefinition,
arguments: jobArguments
})
}
const { result: postedJob, etag } = await this.request<Job>(
`${this.serverUrl}/jobExecution/jobs?_action=wait`,
postJobRequest
)
const jobStatus = await this.pollJobState(
postedJob,
etag,
accessToken,
true
)
const { result: currentJob } = await this.request<Job>(
`${this.serverUrl}/jobExecution/jobs/${postedJob.id}`,
{ headers }
)
let jobResult, log
if (jobStatus === 'failed') {
return Promise.reject(currentJob.error)
}
const resultLink = currentJob.results['_webout.json']
const logLink = currentJob.links.find((l) => l.rel === 'log')
if (resultLink) {
jobResult = await this.request<any>(
`${this.serverUrl}${resultLink}/content`,
{ headers },
'text'
)
}
if (debug && logLink) {
log = await this.request<any>(
`${this.serverUrl}${logLink.href}/content`,
{
headers
}
).then((res: any) =>
res.result.items.map((i: any) => i.line).join('\n')
)
}
return { result: jobResult?.result, log }
} else { } else {
throw new Error( const folderPathParts = sasJob.split('/')
`The job '${sasJob}' was not found in folder '${this.rootFolderName}'.` jobName = folderPathParts.pop()
jobPath = folderPathParts.join('/')
const jobFolder = this.folderMap.get(jobPath)
jobToExecute = jobFolder?.find((item) => item.name === jobName)
}
if (!jobToExecute) {
throw new Error(`The job ${sasJob} was not found.`)
}
const jobDefinitionLink = jobToExecute?.links.find(
(l) => l.rel === 'getResource'
)?.href
const requestInfo: any = {
method: 'GET'
}
const headers: any = { 'Content-Type': 'application/json' }
if (!!accessToken) {
headers.Authorization = `Bearer ${accessToken}`
}
requestInfo.headers = headers
const { result: jobDefinition } = await this.request<Job>(
`${this.serverUrl}${jobDefinitionLink}`,
requestInfo
)
const jobArguments: { [key: string]: any } = {
_contextName: contextName,
_program: `${jobPath}/${jobName}`,
_webin_file_count: files.length,
_OMITJSONLISTING: true,
_OMITJSONLOG: true,
_OMITSESSIONRESULTS: true,
_OMITTEXTLISTING: true,
_OMITTEXTLOG: true
}
if (debug) {
jobArguments['_OMITTEXTLOG'] = 'false'
jobArguments['_OMITSESSIONRESULTS'] = 'false'
jobArguments['_DEBUG'] = 131
}
files.forEach((fileInfo, index) => {
jobArguments[
`_webin_fileuri${index + 1}`
] = `/files/files/${fileInfo.file.id}`
jobArguments[`_webin_name${index + 1}`] = fileInfo.tableName
})
const postJobRequest = {
method: 'POST',
headers,
body: JSON.stringify({
name: `exec-${jobName}`,
description: 'Powered by SASjs',
jobDefinition,
arguments: jobArguments
})
}
const { result: postedJob, etag } = await this.request<Job>(
`${this.serverUrl}/jobExecution/jobs?_action=wait`,
postJobRequest
)
const jobStatus = await this.pollJobState(
postedJob,
etag,
accessToken,
true
)
const { result: currentJob } = await this.request<Job>(
`${this.serverUrl}/jobExecution/jobs/${postedJob.id}`,
{ headers }
)
let jobResult
let log
if (jobStatus === 'failed') {
return Promise.reject(currentJob.error)
}
const resultLink = currentJob.results['_webout.json']
const logLink = currentJob.links.find((l) => l.rel === 'log')
if (resultLink) {
jobResult = await this.request<any>(
`${this.serverUrl}${resultLink}/content`,
{ headers },
'text'
) )
} }
if (debug && logLink) {
log = await this.request<any>(
`${this.serverUrl}${logLink.href}/content`,
{
headers
}
).then((res: any) => res.result.items.map((i: any) => i.line).join('\n'))
}
return { result: jobResult?.result, log }
} }
private async populateRootFolderMap(accessToken?: string) { private async populateFolderMap(folderPath: string, accessToken?: string) {
const allItems = new Map<string, Job[]>() const path = isRelativePath(folderPath)
const url = '/folders/folders/@item?path=' + this.rootFolderName ? `${this.rootFolderName}/${folderPath}`
: folderPath
if (this.folderMap.get(path)) {
return
}
const url = '/folders/folders/@item?path=' + path
const requestInfo: any = { const requestInfo: any = {
method: 'GET' method: 'GET'
} }
@@ -1121,9 +1192,7 @@ export class SASViyaApiClient {
requestInfo requestInfo
) )
if (!folder) { if (!folder) {
throw new Error( throw new Error(`The path ${path} does not exist on ${this.serverUrl}`)
`Not able to populate root folder map, because folder '${this.rootFolderName}' does not exist.`
)
} }
const { result: members } = await this.request<{ items: any[] }>( const { result: members } = await this.request<{ items: any[] }>(
`${this.serverUrl}/folders/folders/${folder.id}/members`, `${this.serverUrl}/folders/folders/${folder.id}/members`,
@@ -1131,55 +1200,7 @@ export class SASViyaApiClient {
) )
const itemsAtRoot = members.items const itemsAtRoot = members.items
allItems.set('', itemsAtRoot) this.folderMap.set(path, itemsAtRoot)
const subfolderRequests = members.items
.filter((i: any) => i.contentType === 'folder')
.map(async (member: any) => {
const subFolderUrl =
'/folders/folders/@item?path=' +
this.rootFolderName +
'/' +
member.name
const { result: memberDetail } = await this.request<Folder>(
`${this.serverUrl}${subFolderUrl}`,
requestInfo
)
const membersLink = memberDetail.links.find(
(l: any) => l.rel === 'members'
)
const { result: memberContents } = await this.request<{ items: any[] }>(
`${this.serverUrl}${membersLink!.href}`,
requestInfo
)
const itemsInFolder = memberContents.items as any[]
allItems.set(member.name, itemsInFolder)
return itemsInFolder
})
await Promise.all(subfolderRequests)
this.rootFolderMap = allItems
}
private async populateRootFolder(accessToken?: string) {
const url = '/folders/folders/@item?path=' + this.rootFolderName
const requestInfo: RequestInit = {
method: 'GET'
}
if (accessToken) {
requestInfo.headers = { Authorization: `Bearer ${accessToken}` }
}
let error
const rootFolder = await this.request<Folder>(
`${this.serverUrl}${url}`,
requestInfo
)
this.rootFolder = rootFolder?.result || null
if (error) {
throw new Error(JSON.stringify(error))
}
} }
private async pollJobState( private async pollJobState(
@@ -1321,7 +1342,9 @@ export class SASViyaApiClient {
const uploadResponse = await this.request<any>( const uploadResponse = await this.request<any>(
`${this.serverUrl}/files/files#rawUpload`, `${this.serverUrl}/files/files#rawUpload`,
createFileRequest createFileRequest,
'json',
'fileUpload'
) )
uploadedFiles.push({ tableName, file: uploadResponse.result }) uploadedFiles.push({ tableName, file: uploadResponse.result })
@@ -1476,22 +1499,36 @@ export class SASViyaApiClient {
this.setCsrfToken(csrfToken) this.setCsrfToken(csrfToken)
} }
setFileUploadCsrfToken = (csrfToken: CsrfToken) => {
this.fileUploadCsrfToken = csrfToken
}
private async request<T>( private async request<T>(
url: string, url: string,
options: RequestInit, options: RequestInit,
contentType: 'text' | 'json' = 'json' contentType: 'text' | 'json' = 'json',
type: 'fileUpload' | 'other' = 'other'
) { ) {
if (this.csrfToken) { const callback =
options.headers = { type === 'fileUpload'
...options.headers, ? this.setFileUploadCsrfToken
[this.csrfToken.headerName]: this.csrfToken.value : this.setCsrfTokenLocal
if (type === 'other') {
if (this.csrfToken) {
options.headers = {
...options.headers,
[this.csrfToken.headerName]: this.csrfToken.value
}
}
} else {
if (this.fileUploadCsrfToken) {
options.headers = {
...options.headers,
[this.fileUploadCsrfToken.headerName]: this.fileUploadCsrfToken.value
}
} }
} }
return await makeRequest<T>( return await makeRequest<T>(url, options, callback, contentType)
url,
options,
this.setCsrfTokenLocal,
contentType
)
} }
} }

View File

@@ -21,7 +21,8 @@ import {
parseGeneratedCode, parseGeneratedCode,
parseWeboutResponse, parseWeboutResponse,
needsRetry, needsRetry,
asyncForEach asyncForEach,
isRelativePath
} from './utils' } from './utils'
import { import {
SASjsConfig, SASjsConfig,
@@ -501,8 +502,6 @@ export default class SASjs {
...config ...config
} }
sasJob = sasJob.startsWith('/') ? sasJob.replace('/', '') : sasJob
if (config.serverType === ServerType.SASViya && config.contextName) { if (config.serverType === ServerType.SASViya && config.contextName) {
if (config.useComputeApi) { if (config.useComputeApi) {
requestResponse = await this.executeJobViaComputeApi( requestResponse = await this.executeJobViaComputeApi(
@@ -794,11 +793,15 @@ export default class SASjs {
SASjob: sasJob, SASjob: sasJob,
data data
} }
const program = config.appLoc const program = isRelativePath(sasJob)
? config.appLoc.replace(/\/?$/, '/') + sasJob.replace(/^\//, '') ? config.appLoc
? config.appLoc.replace(/\/?$/, '/') + sasJob.replace(/^\//, '')
: sasJob
: sasJob : sasJob
const jobUri = const jobUri =
config.serverType === 'SASVIYA' ? await this.getJobUri(sasJob) : '' config.serverType === ServerType.SASViya
? await this.getJobUri(sasJob)
: ''
const apiUrl = `${config.serverUrl}${this.jobsPath}/?${ const apiUrl = `${config.serverUrl}${this.jobsPath}/?${
jobUri.length > 0 jobUri.length > 0
? '__program=' + program + '&_job=' + jobUri ? '__program=' + program + '&_job=' + jobUri
@@ -1091,21 +1094,26 @@ export default class SASjs {
private async getJobUri(sasJob: string) { private async getJobUri(sasJob: string) {
if (!this.sasViyaApiClient) return '' if (!this.sasViyaApiClient) return ''
const jobMap: any = await this.sasViyaApiClient.getAppLocMap()
let uri = '' let uri = ''
if (jobMap.size) { let folderPath
const jobKey = sasJob.split('/')[0] let jobName: string
const jobName = sasJob.split('/')[1] if (isRelativePath(sasJob)) {
folderPath = sasJob.split('/')[0]
jobName = sasJob.split('/')[1]
} else {
const folderPathParts = sasJob.split('/')
jobName = folderPathParts.pop() || ''
folderPath = folderPathParts.join('/')
}
const locJobs = jobMap.get(jobKey) const locJobs = await this.sasViyaApiClient.getJobsInFolder(folderPath)
if (locJobs) { if (locJobs) {
const job = locJobs.find( const job = locJobs.find(
(el: any) => el.name === jobName && el.contentType === 'jobDefinition' (el: any) => el.name === jobName && el.contentType === 'jobDefinition'
) )
if (job) { if (job) {
uri = job.uri uri = job.uri
}
} }
} }
return uri return uri

View File

@@ -78,7 +78,7 @@ export class SessionManager {
if (!this.currentContext) { if (!this.currentContext) {
const { result: contexts } = await this.request<{ const { result: contexts } = await this.request<{
items: Context[] items: Context[]
}>(`${this.serverUrl}/compute/contexts`, { }>(`${this.serverUrl}/compute/contexts?limit=10000`, {
headers: this.getHeaders(accessToken) headers: this.getHeaders(accessToken)
}) })

View File

@@ -1,8 +1,8 @@
import { ServerType } from './ServerType' import { ServerType } from './ServerType'
/** /**
* Specifies the configuration for the SASjs instance. * Specifies the configuration for the SASjs instance - eg where and how to
* * connect to SAS.
*/ */
export class SASjsConfig { export class SASjsConfig {
/** /**
@@ -11,11 +11,24 @@ export class SASjsConfig {
* streamed. * streamed.
*/ */
serverUrl: string = '' serverUrl: string = ''
/**
* The location of the Stored Process Web Application. By default the adapter
* will use '/SASStoredProcess/do' on SAS 9.
*/
pathSAS9: string = '' pathSAS9: string = ''
/**
* The location of the Job Execution Web Application. By default the adapter
* will use '/SASJobExecution' on SAS Viya.
*/
pathSASViya: string = '' pathSASViya: string = ''
/** /**
* The appLoc is the parent folder under which the SAS services (STPs or Job * The appLoc is the parent folder under which the SAS services (STPs or Job
* Execution Services) are stored. * Execution Services) are stored. We recommend that each app is stored in
* a dedicated parent folder (the appLoc) and the services are grouped inside
* subfolders within the appLoc - allowing functionality to be restricted
* according to those groups at backend.
* When using appLoc, the paths provided in the `request` function should be
* _without_ a leading slash (/).
*/ */
appLoc: string = '' appLoc: string = ''
/** /**
@@ -26,6 +39,22 @@ export class SASjsConfig {
* Set to `true` to enable additional debugging. * Set to `true` to enable additional debugging.
*/ */
debug: boolean = true debug: boolean = true
/**
* The name of the compute context to use when calling the Viya APIs directly.
* Example value: 'SAS Job Execution compute context'
* If set to missing or empty, and useComputeApi is true, the adapter will use
* the JES APIs. If provided, the Job Code will be executed in pooled
* compute sessions on this named context.
*/
contextName: string = '' contextName: string = ''
/**
* Set to `false` to use the Job Execution Web Service. To enhance VIYA
* performance, set to `true` and provide a `contextName` on which to run
* the code. When running on a named context, the code executes under the
* user identity. When running as a Job Execution service, the code runs
* under the identity in the JES context. If no `contextName` is provided,
* and `useComputeApi` is `true`, then the service will run as a Job, except
* triggered using the APIs instead of the Job Execution Web Service broker.
*/
useComputeApi = false useComputeApi = false
} }

View File

@@ -1,7 +1,10 @@
export * from './Context' export * from './Context'
export * from './CsrfToken' export * from './CsrfToken'
export * from './ErrorResponse'
export * from './Folder' export * from './Folder'
export * from './Job' export * from './Job'
export * from './JobDefinition'
export * from './JobResult'
export * from './Link' export * from './Link'
export * from './SASjsConfig' export * from './SASjsConfig'
export * from './SASjsRequest' export * from './SASjsRequest'
@@ -9,4 +12,3 @@ export * from './SASjsWaitingRequest'
export * from './ServerType' export * from './ServerType'
export * from './Session' export * from './Session'
export * from './UploadFile' export * from './UploadFile'
export * from './ErrorResponse'

View File

@@ -4,6 +4,9 @@ export * from './convertToCsv'
export * from './isAuthorizeFormRequired' export * from './isAuthorizeFormRequired'
export * from './isLoginRequired' export * from './isLoginRequired'
export * from './isLoginSuccess' export * from './isLoginSuccess'
export * from './isRelativePath'
export * from './isUri'
export * from './isUrl'
export * from './makeRequest' export * from './makeRequest'
export * from './needsRetry' export * from './needsRetry'
export * from './parseAndSubmitAuthorizeForm' export * from './parseAndSubmitAuthorizeForm'
@@ -13,5 +16,3 @@ export * from './parseSasViyaLog'
export * from './serialize' export * from './serialize'
export * from './splitChunks' export * from './splitChunks'
export * from './parseWeboutResponse' export * from './parseWeboutResponse'
export * from './isUri'
export * from './isUrl'

View File

@@ -0,0 +1,2 @@
export const isRelativePath = (uri: string): boolean =>
!!uri && !uri.startsWith('/')

View File

@@ -1,49 +1,56 @@
const path = require("path"); const path = require('path')
const webpack = require("webpack"); const webpack = require('webpack')
const UglifyJsPlugin = require("uglifyjs-webpack-plugin"); const terserPlugin = require('terser-webpack-plugin')
const browserConfig = { const browserConfig = {
entry: "./src/index.ts", entry: './src/index.ts',
devtool: "inline-source-map", devtool: 'inline-source-map',
mode: "development", mode: 'production',
optimization: { optimization: {
minimize: false, minimizer: [
new terserPlugin({
cache: true,
parallel: true,
sourceMap: true,
terserOptions: {}
})
]
}, },
module: { module: {
rules: [ rules: [
{ {
test: /\.ts?$/, test: /\.ts?$/,
use: "ts-loader", use: 'ts-loader',
exclude: /node_modules/, exclude: /node_modules/
}, }
], ]
}, },
resolve: { resolve: {
extensions: [".ts", ".js"], extensions: ['.ts', '.js']
}, },
output: { output: {
filename: "index.js", filename: 'index.js',
path: path.resolve(__dirname, "build"), path: path.resolve(__dirname, 'build'),
libraryTarget: "umd", libraryTarget: 'umd',
library: "SASjs", library: 'SASjs'
}, },
plugins: [ plugins: [
new webpack.ContextReplacementPlugin(/moment[\/\\]locale$/, /en/), new webpack.ContextReplacementPlugin(/moment[\/\\]locale$/, /en/),
new webpack.SourceMapDevToolPlugin({ new webpack.SourceMapDevToolPlugin({
filename: null, filename: null,
exclude: [/node_modules/], exclude: [/node_modules/],
test: /\.ts($|\?)/i, test: /\.ts($|\?)/i
}), })
], ]
}; }
const nodeConfig = { const nodeConfig = {
...browserConfig, ...browserConfig,
target: "node", target: 'node',
output: { output: {
...browserConfig.output, ...browserConfig.output,
path: path.resolve(__dirname, "build", "node"), path: path.resolve(__dirname, 'build', 'node')
}, }
}; }
module.exports = [browserConfig, nodeConfig]; module.exports = [browserConfig, nodeConfig]