Merge pull request #204 from sasjs/fix-runtime-feature

fix: webout path in code.js fixed when running on windows
2025-12-10 19:34:34 +00:00 · 2022-06-20 14:40:55 +02:00
parent 1e2c08a8d3 eb397b15c2
commit 48ff8d73d4
7 changed files with 33 additions and 18 deletions
--- a/README.md
+++ b/README.md
@@ -140,10 +140,10 @@ HELMET_CSP_CONFIG_PATH=./csp.config.json
 LOG_FORMAT_MORGAN=

 # A comma separated string that defines the available runTimes.
-# Priority is given to the runtime that cSAS_PATHomes first in string.
+# Priority is given to the runtime that comes first in the string.
 # Possible options at the moment are sas and js

-# options: [sas,js|js,sas|sas|js] default:sas,js
+# options: [sas,js|js,sas|sas|js] default:sas
 RUN_TIMES=

 ```
--- a/api/.env.example
+++ b/api/.env.example
@@ -17,7 +17,7 @@ AUTH_CODE_SECRET=<secret>
 SESSION_SECRET=<secret>
 DB_CONNECT=mongodb+srv://<DB_USERNAME>:<DB_PASSWORD>@<CLUSTER>/<DB_NAME>?retryWrites=true&w=majority

-RUN_TIMES=[sas|js|sas,js|js,sas] default considered as sas,js
+RUN_TIMES=[sas|js|sas,js|js,sas] default considered as sas
 SAS_PATH=/opt/sas/sas9/SASHome/SASFoundation/9.4/sas
 NODE_PATH=~/.nvm/versions/node/v16.14.0/bin/node

--- a/api/public/swagger.yaml
+++ b/api/public/swagger.yaml
@@ -144,7 +144,7 @@ components:
                - sas
                - js
            type: string
-        ExecuteSASCodePayload:
+        ExecuteCodePayload:
            properties:
                code:
                    type: string
@@ -666,7 +666,7 @@ paths:
                            $ref: '#/components/schemas/ClientPayload'
    /SASjsApi/code/execute:
        post:
-            operationId: ExecuteSASCode
+            operationId: ExecuteCode
            responses:
                '200':
                    description: Ok
@@ -687,7 +687,7 @@ paths:
                content:
                    application/json:
                        schema:
-                            $ref: '#/components/schemas/ExecuteSASCodePayload'
+                            $ref: '#/components/schemas/ExecuteCodePayload'
    /SASjsApi/drive/deploy:
        post:
            operationId: Deploy
@@ -763,7 +763,7 @@ paths:
                            examples:
                                'Example 1':
                                    value: {status: failure, message: 'Deployment failed!'}
-            description: "Accepts JSON file and zipped compressed JSON file as well.\nCompressed file should only contain one JSON file and should have same name\nas of compressed file e.g. deploy.JSON should be compressed to deploy.JSON.zip\nAny other file or JSON file in zipped will be ignored!"
+            description: "Accepts JSON file and zipped compressed JSON file as well.\r\nCompressed file should only contain one JSON file and should have same name\r\nas of compressed file e.g. deploy.JSON should be compressed to deploy.JSON.zip\r\nAny other file or JSON file in zipped will be ignored!"
            summary: 'Creates/updates files within SASjs Drive using uploaded JSON/compressed JSON file.'
            tags:
                - Drive
@@ -851,7 +851,7 @@ paths:
                            examples:
                                'Example 1':
                                    value: {status: failure, message: 'File request failed.'}
-            description: "It's optional to either provide `_filePath` in url as query parameter\nOr provide `filePath` in body as form field.\nBut it's required to provide else API will respond with Bad Request."
+            description: "It's optional to either provide `_filePath` in url as query parameter\r\nOr provide `filePath` in body as form field.\r\nBut it's required to provide else API will respond with Bad Request."
            summary: 'Create a file in SASjs Drive'
            tags:
                - Drive
@@ -902,7 +902,7 @@ paths:
                            examples:
                                'Example 1':
                                    value: {status: failure, message: 'File request failed.'}
-            description: "It's optional to either provide `_filePath` in url as query parameter\nOr provide `filePath` in body as form field.\nBut it's required to provide else API will respond with Bad Request."
+            description: "It's optional to either provide `_filePath` in url as query parameter\r\nOr provide `filePath` in body as form field.\r\nBut it's required to provide else API will respond with Bad Request."
            summary: 'Modify a file in SASjs Drive'
            tags:
                - Drive
@@ -1454,7 +1454,7 @@ paths:
                                anyOf:
                                    - {type: string}
                                    - {type: string, format: byte}
-            description: "Trigger a SAS or JS program using the _program URL parameter.\n\nAccepts URL parameters and file uploads.  For more details, see docs:\n\nhttps://server.sasjs.io/storedprograms"
+            description: "Trigger a SAS or JS program using the _program URL parameter.\r\n\r\nAccepts URL parameters and file uploads.  For more details, see docs:\r\n\r\nhttps://server.sasjs.io/storedprograms"
            summary: 'Execute a Stored Program, returns raw _webout content.'
            tags:
                - STP
@@ -1482,7 +1482,7 @@ paths:
                            examples:
                                'Example 1':
                                    value: {status: success, _webout: 'webout content', log: [], httpHeaders: {Content-type: application/zip, Cache-Control: 'public, max-age=1000'}}
-            description: "Trigger a SAS or JS program using the _program URL parameter.\n\nAccepts URL parameters and file uploads.  For more details, see docs:\n\nhttps://server.sasjs.io/storedprograms\n\nThe response will be a JSON object with the following root attributes:\nlog, webout, headers.\n\nThe webout attribute will be nested JSON ONLY if the response-header\ncontains a content-type of application/json AND it is valid JSON.\nOtherwise it will be a stringified version of the webout content."
+            description: "Trigger a SAS or JS program using the _program URL parameter.\r\n\r\nAccepts URL parameters and file uploads.  For more details, see docs:\r\n\r\nhttps://server.sasjs.io/storedprograms\r\n\r\nThe response will be a JSON object with the following root attributes:\r\nlog, webout, headers.\r\n\r\nThe webout attribute will be nested JSON ONLY if the response-header\r\ncontains a content-type of application/json AND it is valid JSON.\r\nOtherwise it will be a stringified version of the webout content."
            summary: 'Execute a Stored Program, return a JSON object'
            tags:
                - STP
--- a/api/src/controllers/internal/createJSProgram.ts
+++ b/api/src/controllers/internal/createJSProgram.ts
@@ -19,7 +19,11 @@ export const createJSProgram = async (

  const preProgramVarStatments = `
 let _webout = '';
-const weboutPath = '${weboutPath}'; 
+const weboutPath = '${
+    process.platform === 'win32'
+      ? weboutPath.replace(/\\/g, '\\\\')
+      : weboutPath
+  }'; 
 const _sasjs_tokenfile = '${tokenFile}';
 const _sasjs_username = '${preProgramVariables?.username}';
 const _sasjs_userid = '${preProgramVariables?.userId}';
--- a/api/src/utils/validation.ts
+++ b/api/src/utils/validation.ts
@@ -124,7 +124,7 @@ export const folderParamValidation = (data: any): Joi.ValidationResult =>
 export const runCodeValidation = (data: any): Joi.ValidationResult =>
  Joi.object({
    code: Joi.string().required(),
-    runTime: Joi.string().valid(...Object.values(RunTimeType))
+    runTime: Joi.string().valid(...process.runTimes)
  }).validate(data)

 export const executeProgramRawValidation = (data: any): Joi.ValidationResult =>
--- a/api/src/utils/verifyEnvVariables.ts
+++ b/api/src/utils/verifyEnvVariables.ts
@@ -258,5 +258,5 @@ const DEFAULTS = {
  PORT: '5000',
  HELMET_COEP: HelmetCoepType.TRUE,
  LOG_FORMAT_MORGAN: LOG_FORMAT_MORGANType.Common,
-  RUN_TIMES: `${RunTimeType.SAS},${RunTimeType.JS}`
+  RUN_TIMES: `${RunTimeType.SAS}`
 }
--- a/web/src/containers/Studio/index.tsx
+++ b/web/src/containers/Studio/index.tsx
@@ -48,7 +48,16 @@ const Studio = () => {
  const [ctrlPressed, setCtrlPressed] = useState(false)
  const [webout, setWebout] = useState('')
  const [tab, setTab] = useState('1')
-  const [selectedRunTime, setSelectedRunTime] = useState(RunTimeType.SAS)
+  const [runTimes, setRunTimes] = useState<string[]>([])
+  const [selectedRunTime, setSelectedRunTime] = useState('')
+
+  useEffect(() => {
+    setRunTimes(Object.values(appContext.runTimes))
+  }, [appContext.runTimes])
+
+  useEffect(() => {
+    if (runTimes.length) setSelectedRunTime(runTimes[0])
+  }, [runTimes])

  const handleTabChange = (_e: any, newValue: string) => {
    setTab(newValue)
@@ -153,7 +162,7 @@ const Studio = () => {
          </TabList>
        </Box>

-        <TabPanel style={{ paddingBottom: 0 }} value="1">
+        <TabPanel sx={{ paddingBottom: 0 }} value="1">
          <div className={classes.subMenu}>
            <Tooltip title="CTRL+ENTER will also run SAS code">
              <Button onClick={handleRunBtnClick} className={classes.runButton}>
@@ -174,8 +183,10 @@ const Studio = () => {
                  value={selectedRunTime}
                  onChange={handleChangeRunTime}
                >
-                  {appContext.runTimes.map((runTime) => (
-                    <MenuItem value={runTime}>{runTime}</MenuItem>
+                  {runTimes.map((runTime) => (
+                    <MenuItem key={runTime} value={runTime}>
+                      {runTime}
+                    </MenuItem>
                  ))}
                </Select>
              </FormControl>