sasjs/server
1
0
Fork 0
mirror of https://github.com/sasjs/server.git synced 2025-12-11 19:44:35 +00:00
Code Issues Projects Releases Wiki Activity

fix: update response of /SASjsApi/stp/execute and /SASjsApi/code/execute

Browse Source
This commit is contained in:
Sabir Hassan
2022-08-19 15:06:39 +05:00
parent e94c56b23f
commit 98ea2ac9b9
7 changed files with 50 additions and 158 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
api/src/controllers/code.ts
View File

@@ -1,7 +1,6 @@
import express from 'express' import express from 'express'
import { Request, Security, Route, Tags, Post, Body } from 'tsoa' import { Request, Security, Route, Tags, Post, Body } from 'tsoa'
import { ExecuteReturnJson, ExecutionController } from './internal' import { ExecutionController } from './internal'
import { ExecuteReturnJsonResponse } from '.'
import { import {
getPreProgramVariables, getPreProgramVariables,
getUserAutoExec, getUserAutoExec,
@@ -35,7 +34,7 @@ export class CodeController {
public async executeCode( public async executeCode(
@Request() request: express.Request, @Request() request: express.Request,
@Body() body: ExecuteCodePayload @Body() body: ExecuteCodePayload
): Promise<ExecuteReturnJsonResponse> { ): Promise<string | Buffer> {
return executeCode(request, body) return executeCode(request, body)
} }
} }
@@ -51,22 +50,15 @@ const executeCode = async (
: await getUserAutoExec() : await getUserAutoExec()
try { try {
const { webout, log, httpHeaders } = const { result } = await new ExecutionController().executeProgram({
(await new ExecutionController().executeProgram({
program: code, program: code,
preProgramVariables: getPreProgramVariables(req), preProgramVariables: getPreProgramVariables(req),
vars: { ...req.query, _debug: 131 }, vars: { ...req.query, _debug: 131 },
otherArgs: { userAutoExec }, otherArgs: { userAutoExec },
returnJson: true,
runTime: runTime runTime: runTime
})) as ExecuteReturnJson })
return { return result
status: 'success',
_webout: webout as string,
log: parseLogToArray(log),
httpHeaders
}
} catch (err: any) { } catch (err: any) {
throw { throw {
code: 400, code: 400,

26
api/src/controllers/internal/Execution.ts
View File

@@ -20,12 +20,6 @@ export interface ExecuteReturnRaw {
result: string | Buffer result: string | Buffer
} }
export interface ExecuteReturnJson {
httpHeaders: HTTPHeaders
webout: string | Buffer
log?: string
}
interface ExecuteFileParams { interface ExecuteFileParams {
programPath: string programPath: string
preProgramVariables: PreProgramVars preProgramVariables: PreProgramVars
@@ -68,10 +62,9 @@ export class ExecutionController {
preProgramVariables, preProgramVariables,
vars, vars,
otherArgs, otherArgs,
returnJson,
session: sessionByFileUpload, session: sessionByFileUpload,
runTime runTime
}: ExecuteProgramParams): Promise<ExecuteReturnRaw | ExecuteReturnJson> { }: ExecuteProgramParams): Promise<ExecuteReturnRaw> {
const sessionController = getSessionController(runTime) const sessionController = getSessionController(runTime)
const session = const session =
@@ -89,8 +82,6 @@ export class ExecutionController {
tokenFile, tokenFile,
preProgramVariables?.httpHeaders.join('\n') ?? '' preProgramVariables?.httpHeaders.join('\n') ?? ''
) )
if (returnJson)
await createFile(headersPath, 'Content-type: application/json')
await processProgram( await processProgram(
program, program,
@@ -110,10 +101,7 @@ export class ExecutionController {
? await readFile(headersPath) ? await readFile(headersPath)
: '' : ''
const httpHeaders: HTTPHeaders = extractHeaders(headersContent) const httpHeaders: HTTPHeaders = extractHeaders(headersContent)
const fileResponse: boolean = const fileResponse: boolean = httpHeaders.hasOwnProperty('content-type')
httpHeaders.hasOwnProperty('content-type') &&
!returnJson && // not a POST Request
!isDebugOn(vars) // Debug is not enabled
const webout = (await fileExists(weboutPath)) const webout = (await fileExists(weboutPath))
? fileResponse ? fileResponse
@@ -124,19 +112,11 @@ export class ExecutionController {
// it should be deleted by scheduleSessionDestroy // it should be deleted by scheduleSessionDestroy
session.inUse = false session.inUse = false
if (returnJson) {
return {
httpHeaders,
webout,
log: isDebugOn(vars) || session.crashed ? log : undefined
}
}
return { return {
httpHeaders, httpHeaders,
result: result:
isDebugOn(vars) || session.crashed isDebugOn(vars) || session.crashed
? `<html><body>${webout}<div style="text-align:left"><hr /><h2>SAS Log</h2><pre>${log}</pre></div></body></html>` ? `${webout}\n${process.logsUUID}\n${log}`
: webout : webout
} }
} }

134
api/src/controllers/stp.ts
View File

@@ -1,33 +1,16 @@
import express from 'express' import express from 'express'
import { import { Request, Security, Route, Tags, Post, Body, Get, Query } from 'tsoa'
Request, import { ExecutionController, ExecutionVars } from './internal'
Security,
Route,
Tags,
Post,
Body,
Get,
Query,
Example
} from 'tsoa'
import {
ExecuteReturnJson,
ExecuteReturnRaw,
ExecutionController,
ExecutionVars
} from './internal'
import { import {
getPreProgramVariables, getPreProgramVariables,
HTTPHeaders, HTTPHeaders,
isDebugOn,
LogLine, LogLine,
makeFilesNamesMap, makeFilesNamesMap,
parseLogToArray,
getRunTimeAndFilePath getRunTimeAndFilePath
} from '../utils' } from '../utils'
import { MulterFile } from '../types/Upload' import { MulterFile } from '../types/Upload'
interface ExecuteReturnJsonPayload { interface ExecutePostRequestPayload {
/** /**
* Location of SAS program * Location of SAS program
* @example "/Public/somefolder/some.file" * @example "/Public/somefolder/some.file"
@@ -35,17 +18,6 @@ interface ExecuteReturnJsonPayload {
_program?: string _program?: string
} }
interface IRecordOfAny {
[key: string]: any
}
export interface ExecuteReturnJsonResponse {
status: string
_webout: string | IRecordOfAny
log: LogLine[]
message?: string
httpHeaders: HTTPHeaders
}
@Security('bearerAuth') @Security('bearerAuth')
@Route('SASjsApi/stp') @Route('SASjsApi/stp')
@Tags('STP') @Tags('STP')
@@ -62,11 +34,12 @@ export class STPController {
* @example _program "/Projects/myApp/some/program" * @example _program "/Projects/myApp/some/program"
*/ */
@Get('/execute') @Get('/execute')
public async executeReturnRaw( public async executeGetRequest(
@Request() request: express.Request, @Request() request: express.Request,
@Query() _program: string @Query() _program: string
): Promise<string | Buffer> { ): Promise<string | Buffer> {
return executeReturnRaw(request, _program) const vars = request.query as ExecutionVars
return execute(request, _program, vars)
} }
/** /**
@@ -87,50 +60,42 @@ export class STPController {
* @param _program Location of SAS or JS code * @param _program Location of SAS or JS code
* @example _program "/Projects/myApp/some/program" * @example _program "/Projects/myApp/some/program"
*/ */
@Example<ExecuteReturnJsonResponse>({
status: 'success',
_webout: 'webout content',
log: [],
httpHeaders: {
'Content-type': 'application/zip',
'Cache-Control': 'public, max-age=1000'
}
})
@Post('/execute') @Post('/execute')
public async executeReturnJson( public async executePostRequest(
@Request() request: express.Request, @Request() request: express.Request,
@Body() body?: ExecuteReturnJsonPayload, @Body() body?: ExecutePostRequestPayload,
@Query() _program?: string @Query() _program?: string
): Promise<ExecuteReturnJsonResponse> { ): Promise<string | Buffer> {
const program = _program ?? body?._program const program = _program ?? body?._program
return executeReturnJson(request, program!) const vars = { ...request.query, ...request.body }
const filesNamesMap = request.files?.length
? makeFilesNamesMap(request.files as MulterFile[])
: null
const otherArgs = { filesNamesMap: filesNamesMap }
return execute(request, program!, vars, otherArgs)
} }
} }
const executeReturnRaw = async ( const execute = async (
req: express.Request, req: express.Request,
_program: string _program: string,
vars: ExecutionVars,
otherArgs?: any
): Promise<string | Buffer> => { ): Promise<string | Buffer> => {
const query = req.query as ExecutionVars
try { try {
const { codePath, runTime } = await getRunTimeAndFilePath(_program) const { codePath, runTime } = await getRunTimeAndFilePath(_program)
const { result, httpHeaders } = const { result, httpHeaders } = await new ExecutionController().executeFile(
(await new ExecutionController().executeFile({ {
programPath: codePath, programPath: codePath,
runTime,
preProgramVariables: getPreProgramVariables(req), preProgramVariables: getPreProgramVariables(req),
vars: query, vars,
runTime otherArgs,
})) as ExecuteReturnRaw session: req.sasjsSession
// Should over-ride response header for debug
// on GET request to see entire log rendering on browser.
if (isDebugOn(query)) {
httpHeaders['content-type'] = 'text/plain'
} }
)
req.res?.set(httpHeaders)
if (result instanceof Buffer) { if (result instanceof Buffer) {
;(req as any).sasHeaders = httpHeaders ;(req as any).sasHeaders = httpHeaders
@@ -146,48 +111,3 @@ const executeReturnRaw = async (
} }
} }
} }
const executeReturnJson = async (
req: express.Request,
_program: string
): Promise<ExecuteReturnJsonResponse> => {
const filesNamesMap = req.files?.length
? makeFilesNamesMap(req.files as MulterFile[])
: null
try {
const { codePath, runTime } = await getRunTimeAndFilePath(_program)
const { webout, log, httpHeaders } =
(await new ExecutionController().executeFile({
programPath: codePath,
preProgramVariables: getPreProgramVariables(req),
vars: { ...req.query, ...req.body },
otherArgs: { filesNamesMap: filesNamesMap },
returnJson: true,
session: req.sasjsSession,
runTime
})) as ExecuteReturnJson
let weboutRes: string | IRecordOfAny = webout
if (httpHeaders['content-type']?.toLowerCase() === 'application/json') {
try {
weboutRes = JSON.parse(webout as string)
} catch (_) {}
}
return {
status: 'success',
_webout: weboutRes,
log: parseLogToArray(log),
httpHeaders
}
} catch (err: any) {
throw {
code: 400,
status: 'failure',
message: 'Job execution failed.',
error: typeof err === 'object' ? err.toString() : err
}
}
}

4
api/src/routes/api/stp.ts
View File

@@ -13,7 +13,7 @@ stpRouter.get('/execute', async (req, res) => {
if (error) return res.status(400).send(error.details[0].message) if (error) return res.status(400).send(error.details[0].message)
try { try {
const response = await controller.executeReturnRaw(req, query._program) const response = await controller.executeGetRequest(req, query._program)
if (response instanceof Buffer) { if (response instanceof Buffer) {
res.writeHead(200, (req as any).sasHeaders) res.writeHead(200, (req as any).sasHeaders)
@@ -42,7 +42,7 @@ stpRouter.post(
// if (errQ && errB) return res.status(400).send(errB.details[0].message) // if (errQ && errB) return res.status(400).send(errB.details[0].message)
try { try {
const response = await controller.executeReturnJson( const response = await controller.executePostRequest(
req, req,
req.body, req.body,
req.query?._program as string req.query?._program as string

1
api/src/types/system/process.d.ts vendored
View File

@@ -5,6 +5,7 @@ declare namespace NodeJS {
pythonLoc?: string pythonLoc?: string
driveLoc: string driveLoc: string
logsLoc: string logsLoc: string
logsUUID: string
sasSessionController?: import('../../controllers/internal').SASSessionController sasSessionController?: import('../../controllers/internal').SASSessionController
jsSessionController?: import('../../controllers/internal').JSSessionController jsSessionController?: import('../../controllers/internal').JSSessionController
pythonSessionController?: import('../../controllers/internal').PythonSessionController pythonSessionController?: import('../../controllers/internal').PythonSessionController

2
api/src/utils/setProcessVariables.ts
View File

@@ -50,6 +50,8 @@ export const setProcessVariables = async () => {
await createFolder(absLogsPath) await createFolder(absLogsPath)
process.logsLoc = getRealPath(absLogsPath) process.logsLoc = getRealPath(absLogsPath)
process.logsUUID = 'SASJS_LOGS_SEPARATOR_163ee17b6ff24f028928972d80a26784'
console.log('sasLoc: ', process.sasLoc) console.log('sasLoc: ', process.sasLoc)
console.log('sasDrive: ', process.driveLoc) console.log('sasDrive: ', process.driveLoc)
console.log('sasLogs: ', process.logsLoc) console.log('sasLogs: ', process.logsLoc)

11
web/src/containers/Studio/editor.tsx
View File

@@ -70,6 +70,8 @@ type SASjsEditorProps = {
} }
const baseUrl = window.location.origin const baseUrl = window.location.origin
const SASJS_LOGS_SEPARATOR =
'SASJS_LOGS_SEPARATOR_163ee17b6ff24f028928972d80a26784'
const SASjsEditor = ({ const SASjsEditor = ({
selectedFilePath, selectedFilePath,
@@ -203,13 +205,8 @@ const SASjsEditor = ({
axios axios
.post(`/SASjsApi/code/execute`, { code, runTime: selectedRunTime }) .post(`/SASjsApi/code/execute`, { code, runTime: selectedRunTime })
.then((res: any) => { .then((res: any) => {
const parsedLog = res?.data?.log setWebout(res.data.split(SASJS_LOGS_SEPARATOR)[0] ?? '')
.map((logLine: any) => logLine.line) setLog(res.data.split(SASJS_LOGS_SEPARATOR)[1] ?? '')
.join('\n')
setLog(parsedLog)
setWebout(`${res.data?._webout}`)
setTab('log') setTab('log')
// Scroll to bottom of log // Scroll to bottom of log