sasjs/adapter
1
0
Fork 0
mirror of https://github.com/sasjs/adapter.git synced 2026-04-21 21:21:31 +00:00
Code Issues Projects Releases Wiki Activity

Merge branch 'master' into cli-issue-182

Browse Source
This commit is contained in:
Yury Shkoda
2020-12-23 15:11:19 +03:00
parent 6b3a0cdb13 33a202fa1c
commit d991ead86a
38 changed files with 6207 additions and 2976 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.env.example
+2
View File
@@ -0,0 +1,2 @@
SERVER_URL=https://server.com
DEFAULT_COMPUTE_CONTEXT=SAS Job Execution compute context
.github/reviewer-lottery.yml
+9
View File
@@ -0,0 +1,9 @@
groups:
- name: SASjs Devs # name of the group
reviewers: 1 # how many reviewers do you want to assign?
usernames: # github usernames of the reviewers
- krishna-acondy
- YuryShkoda
- saadjutt01
- medjedovicm
- allanbowe
.github/workflows/assign-reviewer.yml
+13
View File
@@ -0,0 +1,13 @@
name: 'Assign Reviewer'
on:
pull_request:
types: [opened]
jobs:
test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: uesteibar/reviewer-lottery@v1
with:
repo-token: ${{ secrets.GH_TOKEN }}
.gitignore
+3 -1
View File
@@ -1,2 +1,4 @@
node_modules
build
build
.env
docs/assets/js/search.json
+1 -1
View File
File diff suppressed because one or more lines are too long
docs/classes/root.fileuploader.html
+228
View File
File diff suppressed because one or more lines are too long
docs/classes/root.sas9apiclient.html
+309
View File
File diff suppressed because one or more lines are too long
docs/classes/root.sasjs.html
+1673
View File
File diff suppressed because one or more lines are too long
docs/classes/root.sasviyaapiclient.html
+1480
View File
File diff suppressed because one or more lines are too long
docs/classes/root.sessionmanager.html
+357
View File
File diff suppressed because one or more lines are too long
docs/classes/types.errorresponse.html
+3
View File
@@ -220,6 +220,9 @@
<li class=" tsd-kind-interface tsd-parent-kind-module root">
<a href="../interfaces/types.session.html" class="tsd-kind-icon">Session</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module root">
<a href="../interfaces/types.sessionvariable.html" class="tsd-kind-icon">Session<wbr>Variable</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module root">
<a href="../interfaces/types.uploadfile.html" class="tsd-kind-icon">Upload<wbr>File</a>
</li>
docs/classes/types.sasjsconfig.html
+3
View File
@@ -367,6 +367,9 @@
<li class=" tsd-kind-interface tsd-parent-kind-module root">
<a href="../interfaces/types.session.html" class="tsd-kind-icon">Session</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module root">
<a href="../interfaces/types.sessionvariable.html" class="tsd-kind-icon">Session<wbr>Variable</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module root">
<a href="../interfaces/types.uploadfile.html" class="tsd-kind-icon">Upload<wbr>File</a>
</li>
docs/enums/types.servertype.html
+3
View File
@@ -190,6 +190,9 @@
<li class=" tsd-kind-interface tsd-parent-kind-module root">
<a href="../interfaces/types.session.html" class="tsd-kind-icon">Session</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module root">
<a href="../interfaces/types.sessionvariable.html" class="tsd-kind-icon">Session<wbr>Variable</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module root">
<a href="../interfaces/types.uploadfile.html" class="tsd-kind-icon">Upload<wbr>File</a>
</li>
docs/globals.html
+1 -1
View File
@@ -76,7 +76,7 @@
<section class="tsd-index-section ">
<h3>Modules</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-module tsd-is-not-exported"><a href="modules/reflection-837.html" class="tsd-kind-icon"><em>Module</em></a></li>
<li class="tsd-kind-module"><a href="modules/root.html" class="tsd-kind-icon">root</a></li>
<li class="tsd-kind-module"><a href="modules/types.html" class="tsd-kind-icon">types</a></li>
<li class="tsd-kind-module"><a href="modules/utils.html" class="tsd-kind-icon">utils</a></li>
</ul>
docs/interfaces/types.context.html
+3
View File
@@ -247,6 +247,9 @@
<li class=" tsd-kind-interface tsd-parent-kind-module root">
<a href="types.session.html" class="tsd-kind-icon">Session</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module root">
<a href="types.sessionvariable.html" class="tsd-kind-icon">Session<wbr>Variable</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module root">
<a href="types.uploadfile.html" class="tsd-kind-icon">Upload<wbr>File</a>
</li>
docs/interfaces/types.contextallattributes.html
+3
View File
@@ -382,6 +382,9 @@
<li class=" tsd-kind-interface tsd-parent-kind-module root">
<a href="types.session.html" class="tsd-kind-icon">Session</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module root">
<a href="types.sessionvariable.html" class="tsd-kind-icon">Session<wbr>Variable</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module root">
<a href="types.uploadfile.html" class="tsd-kind-icon">Upload<wbr>File</a>
</li>
docs/interfaces/types.csrftoken.html
+3
View File
@@ -193,6 +193,9 @@
<li class=" tsd-kind-interface tsd-parent-kind-module root">
<a href="types.session.html" class="tsd-kind-icon">Session</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module root">
<a href="types.sessionvariable.html" class="tsd-kind-icon">Session<wbr>Variable</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module root">
<a href="types.uploadfile.html" class="tsd-kind-icon">Upload<wbr>File</a>
</li>
docs/interfaces/types.editcontextinput.html
+3
View File
@@ -301,6 +301,9 @@
<li class=" tsd-kind-interface tsd-parent-kind-module root">
<a href="types.session.html" class="tsd-kind-icon">Session</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module root">
<a href="types.sessionvariable.html" class="tsd-kind-icon">Session<wbr>Variable</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module root">
<a href="types.uploadfile.html" class="tsd-kind-icon">Upload<wbr>File</a>
</li>
docs/interfaces/types.folder.html
+3
View File
@@ -229,6 +229,9 @@
<li class=" tsd-kind-interface tsd-parent-kind-module root">
<a href="types.session.html" class="tsd-kind-icon">Session</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module root">
<a href="types.sessionvariable.html" class="tsd-kind-icon">Session<wbr>Variable</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module root">
<a href="types.uploadfile.html" class="tsd-kind-icon">Upload<wbr>File</a>
</li>
docs/interfaces/types.job.html
+3
View File
@@ -301,6 +301,9 @@
<li class=" tsd-kind-interface tsd-parent-kind-module root">
<a href="types.session.html" class="tsd-kind-icon">Session</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module root">
<a href="types.sessionvariable.html" class="tsd-kind-icon">Session<wbr>Variable</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module root">
<a href="types.uploadfile.html" class="tsd-kind-icon">Upload<wbr>File</a>
</li>
docs/interfaces/types.jobdefinition.html
+3
View File
@@ -175,6 +175,9 @@
<li class=" tsd-kind-interface tsd-parent-kind-module root">
<a href="types.session.html" class="tsd-kind-icon">Session</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module root">
<a href="types.sessionvariable.html" class="tsd-kind-icon">Session<wbr>Variable</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module root">
<a href="types.uploadfile.html" class="tsd-kind-icon">Upload<wbr>File</a>
</li>
docs/interfaces/types.jobresult.html
+3
View File
@@ -175,6 +175,9 @@
<li class=" tsd-kind-interface tsd-parent-kind-module root">
<a href="types.session.html" class="tsd-kind-icon">Session</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module root">
<a href="types.sessionvariable.html" class="tsd-kind-icon">Session<wbr>Variable</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module root">
<a href="types.uploadfile.html" class="tsd-kind-icon">Upload<wbr>File</a>
</li>
docs/interfaces/types.link.html
+3
View File
@@ -247,6 +247,9 @@
<li class=" tsd-kind-interface tsd-parent-kind-module root">
<a href="types.session.html" class="tsd-kind-icon">Session</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module root">
<a href="types.sessionvariable.html" class="tsd-kind-icon">Session<wbr>Variable</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module root">
<a href="types.uploadfile.html" class="tsd-kind-icon">Upload<wbr>File</a>
</li>
docs/interfaces/types.polloptions.html
+3
View File
@@ -193,6 +193,9 @@
<li class=" tsd-kind-interface tsd-parent-kind-module root">
<a href="types.session.html" class="tsd-kind-icon">Session</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module root">
<a href="types.sessionvariable.html" class="tsd-kind-icon">Session<wbr>Variable</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module root">
<a href="types.uploadfile.html" class="tsd-kind-icon">Upload<wbr>File</a>
</li>
docs/interfaces/types.sasjsrequest.html
+3
View File
@@ -270,6 +270,9 @@
<li class=" tsd-kind-interface tsd-parent-kind-module root">
<a href="types.session.html" class="tsd-kind-icon">Session</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module root">
<a href="types.sessionvariable.html" class="tsd-kind-icon">Session<wbr>Variable</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module root">
<a href="types.uploadfile.html" class="tsd-kind-icon">Upload<wbr>File</a>
</li>
docs/interfaces/types.sasjswaitingrequest.html
+3
View File
@@ -248,6 +248,9 @@
<li class=" tsd-kind-interface tsd-parent-kind-module root">
<a href="types.session.html" class="tsd-kind-icon">Session</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module root">
<a href="types.sessionvariable.html" class="tsd-kind-icon">Session<wbr>Variable</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module root">
<a href="types.uploadfile.html" class="tsd-kind-icon">Upload<wbr>File</a>
</li>
docs/interfaces/types.session.html
+3
View File
@@ -255,6 +255,9 @@
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-interface tsd-parent-kind-module root">
<a href="types.sessionvariable.html" class="tsd-kind-icon">Session<wbr>Variable</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module root">
<a href="types.uploadfile.html" class="tsd-kind-icon">Upload<wbr>File</a>
</li>
docs/interfaces/types.sessionvariable.html
+197
View File
File diff suppressed because one or more lines are too long
docs/interfaces/types.uploadfile.html
+3
View File
@@ -186,6 +186,9 @@
<li class=" tsd-kind-interface tsd-parent-kind-module root">
<a href="types.session.html" class="tsd-kind-icon">Session</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module root">
<a href="types.sessionvariable.html" class="tsd-kind-icon">Session<wbr>Variable</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-interface tsd-parent-kind-module root">
docs/modules/root.html
+125
View File
File diff suppressed because one or more lines are too long
docs/modules/types.html
+4
View File
@@ -105,6 +105,7 @@
<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/types.sasjsrequest.html" class="tsd-kind-icon">SASjsRequest</a></li>
<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/types.sasjswaitingrequest.html" class="tsd-kind-icon">SASjsWaitingRequest</a></li>
<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/types.session.html" class="tsd-kind-icon">Session</a></li>
<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/types.sessionvariable.html" class="tsd-kind-icon">SessionVariable</a></li>
<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/types.uploadfile.html" class="tsd-kind-icon">UploadFile</a></li>
</ul>
</section>
@@ -164,6 +165,9 @@
<li class=" tsd-kind-interface tsd-parent-kind-module root">
<a href="../interfaces/types.session.html" class="tsd-kind-icon">Session</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module root">
<a href="../interfaces/types.sessionvariable.html" class="tsd-kind-icon">Session<wbr>Variable</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module root">
<a href="../interfaces/types.uploadfile.html" class="tsd-kind-icon">Upload<wbr>File</a>
</li>
package-lock.json
Generated
+1639 -2965
View File
File diff suppressed because it is too large Load Diff
package.json
+2 -1
View File
@@ -39,6 +39,7 @@
"@types/isomorphic-fetch": "0.0.35",
"@types/jest": "^26.0.15",
"cp": "^0.2.0",
"dotenv": "^8.2.0",
"jest": "^25.5.4",
"path": "^0.12.7",
"rimraf": "^3.0.2",
@@ -57,7 +58,7 @@
},
"main": "index.js",
"dependencies": {
"@sasjs/utils": "^1.3.0",
"@sasjs/utils": "^1.5.0",
"es6-promise": "^4.2.8",
"form-data": "^3.0.0",
"isomorphic-fetch": "^2.2.1"
src/SASViyaApiClient.ts
+32 -4
View File
@@ -16,13 +16,14 @@ import {
Folder,
CsrfToken,
EditContextInput,
ErrorResponse,
JobDefinition,
PollOptions
} from './types'
import { formatDataForRequest } from './utils/formatDataForRequest'
import { SessionManager } from './SessionManager'
import { ContextManager } from './ContextManager'
import { timestampToYYYYMMDDHHMMSS } from '@sasjs/utils/time'
import { Logger, LogLevel } from '@sasjs/utils/logger'
/**
* A client for interfacing with the SAS Viya REST API.
@@ -249,6 +250,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 waitForResult - when set to true, function will return the session
* @param pollOptions - an object that represents poll interval(milliseconds) and maximum amount of attempts. Object example: { MAX_POLL_COUNT: 24 * 60 * 60, POLL_INTERVAL: 1000 }.
* @param printPid - a boolean that indicates whether the function should print (PID) of the started job.
*/
public async executeScript(
jobPath: string,
@@ -259,7 +261,8 @@ export class SASViyaApiClient {
debug: boolean = false,
expectWebout = false,
waitForResult = true,
pollOptions?: PollOptions
pollOptions?: PollOptions,
printPid = false
): Promise<any> {
try {
const headers: any = {
@@ -279,6 +282,28 @@ export class SASViyaApiClient {
executionSessionId = session!.id
if (printPid) {
const { result: jobIdVariable } = await this.sessionManager.getVariable(
executionSessionId,
'SYSJOBID',
accessToken
)
if (jobIdVariable && jobIdVariable.value) {
const relativeJobPath = this.rootFolderName
? jobPath.split(this.rootFolderName).join('').replace(/^\//, '')
: jobPath
const logger = new Logger(debug ? LogLevel.Debug : LogLevel.Info)
logger.info(
`Triggered '${relativeJobPath}' with PID ${
jobIdVariable.value
} at ${timestampToYYYYMMDDHHMMSS()}`
)
}
}
const jobArguments: { [key: string]: any } = {
_contextName: contextName,
_OMITJSONLISTING: true,
@@ -777,6 +802,7 @@ export class SASViyaApiClient {
* @param waitForResult - a boolean indicating if the function should wait for a result.
* @param expectWebout - a boolean indicating whether to expect a _webout response.
* @param pollOptions - an object that represents poll interval(milliseconds) and maximum amount of attempts. Object example: { MAX_POLL_COUNT: 24 * 60 * 60, POLL_INTERVAL: 1000 }.
* @param printPid - a boolean that indicates whether the function should print (PID) of the started job.
*/
public async executeComputeJob(
sasJob: string,
@@ -786,7 +812,8 @@ export class SASViyaApiClient {
accessToken?: string,
waitForResult = true,
expectWebout = false,
pollOptions?: PollOptions
pollOptions?: PollOptions,
printPid = false
) {
if (isRelativePath(sasJob) && !this.rootFolderName) {
throw new Error(
@@ -872,7 +899,8 @@ export class SASViyaApiClient {
debug,
expectWebout,
waitForResult,
pollOptions
pollOptions,
printPid
)
}
src/SASjs.ts
+5 -2
View File
@@ -764,6 +764,7 @@ export default class SASjs {
* The access token is not required when the user is authenticated via the browser.
* @param waitForResult - a boolean that indicates whether the function needs to wait for execution to complete.
* @param pollOptions - an object that represents poll interval(milliseconds) and maximum amount of attempts. Object example: { MAX_POLL_COUNT: 24 * 60 * 60, POLL_INTERVAL: 1000 }.
* @param printPid - a boolean that indicates whether the function should print (PID) of the started job.
*/
public async startComputeJob(
sasJob: string,
@@ -771,7 +772,8 @@ export default class SASjs {
config: any = {},
accessToken?: string,
waitForResult?: boolean,
pollOptions?: PollOptions
pollOptions?: PollOptions,
printPid = false
) {
config = {
...this.sasjsConfig,
@@ -793,7 +795,8 @@ export default class SASjs {
accessToken,
!!waitForResult,
false,
pollOptions
pollOptions,
printPid
)
}
src/SessionManager.ts
+19 -1
View File
@@ -1,5 +1,6 @@
import { Session, Context, CsrfToken } from './types'
import { Session, Context, CsrfToken, SessionVariable } from './types'
import { asyncForEach, makeRequest, isUrl } from './utils'
import { prefixMessage } from '@sasjs/utils/error'
const MAX_SESSION_COUNT = 1
const RETRY_LIMIT: number = 3
@@ -265,4 +266,21 @@ export class SessionManager {
throw err
})
}
async getVariable(sessionId: string, variable: string, accessToken?: string) {
const getSessionVariable = {
method: 'GET',
headers: this.getHeaders(accessToken)
}
return await this.request<SessionVariable>(
`${this.serverUrl}/compute/sessions/${sessionId}/variables/${variable}`,
getSessionVariable
).catch((err) => {
throw prefixMessage(
err,
`Error while fetching session variable '${variable}'.`
)
})
}
}
src/test/SessionManager.spec.ts
+53
View File
@@ -0,0 +1,53 @@
import { SessionManager } from '../SessionManager'
import * as dotenv from 'dotenv'
describe('SessionManager', () => {
dotenv.config()
let originalFetch: any
const sessionManager = new SessionManager(
process.env.SERVER_URL as string,
process.env.DEFAULT_COMPUTE_CONTEXT as string,
() => {}
)
beforeAll(() => {
originalFetch = (global as any).fetch
})
afterEach(() => {
;(global as any).fetch = originalFetch
})
describe('getVariable', () => {
it('should fetch session variable', async () => {
const sampleResponse = {
ok: true,
links: [],
name: 'SYSJOBID',
scope: 'GLOBAL',
value: '25218',
version: 1
}
;(global as any).fetch = jest.fn().mockImplementation(() =>
Promise.resolve({
ok: true,
headers: { get: () => '' },
json: () => Promise.resolve(sampleResponse)
})
)
const expectedResponse = { etag: '', result: sampleResponse }
await expect(
sessionManager.getVariable(
'fakeSessionId',
'SYSJOBID',
'fakeAccessToken'
)
).resolves.toEqual(expectedResponse)
})
})
})
src/types/Session.ts
+4
View File
@@ -9,3 +9,7 @@ export interface Session {
}
creationTimeStamp: string
}
export interface SessionVariable {
value: string
}