feat: App Stream, load on startup, new route added

api/public/sasjs-logo.svg

@@ -0,0 +1,21 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- Generator: Adobe Illustrator 19.0.0, SVG Export Plug-In . SVG Version: 6.00 Build 0)  -->
+<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
+	 viewBox="0 0 32 32" style="enable-background:new 0 0 32 32;" xml:space="preserve">
+<style type="text/css">
+	.st0{fill:#F6E40C;}
+</style>
+<rect id="XMLID_1_" width="32" height="32"/>
+<g id="XMLID_654_">
+	<path id="XMLID_656_" class="st0" d="M27.9,17.4c-1.1,0-2.1,0-3,0c-1.2,0-2.3,0-3.5,0c-0.5,0-0.7,0.2-0.6,0.7c0,2.1,0,4.3,0,6.4
+		c0,0.5-0.2,0.8-0.6,1c-2.5,1.4-4.9,2.8-7.3,4.3c-0.4,0.2-0.6,0.2-1,0c-2.4-1.4-4.9-2.9-7.3-4.3c-0.2-0.1-0.5-0.5-0.5-0.7
+		c0-3.2,0-6.4,0-9.6c0-0.1,0-0.1,0.1-0.3c0.3,0,0.5,0,0.8,0c1.9,0,3.7,0,5.6,0c0.6,0,0.7-0.2,0.7-0.7c0-2.1,0-4.2,0-6.4
+		c0-0.5,0.1-0.8,0.6-1.1c2.5-1.4,4.9-2.9,7.3-4.3c0.2-0.1,0.6-0.1,0.9,0c2.5,1.4,5,2.9,7.5,4.4c0.2,0.1,0.4,0.4,0.4,0.6
+		C27.9,10.6,27.9,13.9,27.9,17.4z M20.8,14.8c1.4,0,2.7,0,4,0c0.5,0,0.7-0.2,0.7-0.7c0-1.7,0-3.3,0-5c0-0.5-0.2-0.7-0.6-1
+		c-1.6-0.9-3.2-1.9-4.8-2.8c-0.2-0.1-0.7-0.1-0.9,0c-1.6,0.9-3.2,1.9-4.8,2.8c-0.4,0.2-0.6,0.5-0.6,1c0,3.2,0,6.3,0,9.5
+		c0,1.9,0,1.9-1.9,1.9c-0.4,0-0.6-0.1-0.6-0.6c0-0.6,0-1.3,0-1.9c0-0.5-0.2-0.6-0.6-0.6c-1.1,0-2.2,0-3.3,0c-0.5,0-0.7,0.2-0.7,0.7
+		c0,1.6,0,3.3,0,4.9c0,0.5,0.2,0.8,0.6,1c1.6,0.9,3.2,1.9,4.8,2.8c0.2,0.1,0.7,0.1,0.9,0c1.6-0.9,3.2-1.9,4.8-2.8
+		c0.4-0.2,0.6-0.5,0.6-1c0-3.1,0-6.1,0-9.2c0-1.9,0-1.9,1.9-1.9c0.5,0,0.7,0.2,0.7,0.7C20.8,13.3,20.8,14,20.8,14.8z"/>
+	<path id="XMLID_655_" class="st0" d="M18,2.1l-6.8,3.9V2.7c0-0.3,0.3-0.6,0.6-0.6H18z"/>
+</g>
+</svg>

api/public/swagger.yaml

@@ -225,6 +225,8 @@ components:
             properties:
                 appLoc:
                     type: string
+                streamWebFolder:
+                    type: string
                 fileTree:
                     $ref: '#/components/schemas/FileTree'
             required:

api/src/app.ts

@@ -8,6 +8,7 @@ import cors from 'cors'
 import {
   connectDB,
   getWebBuildFolderPath,
+  loadAppStreamConfig,
   sasJSCoreMacros,
   setProcessVariables
 } from './utils'
@@ -43,6 +44,8 @@ export default setProcessVariables().then(async () => {
   const { setupRoutes } = await import('./routes/setupRoutes')
   setupRoutes(app)
 
+  await loadAppStreamConfig()
+
   // should be served after setting up web route
   // index.html needs to be injected with some js script.
   app.use(express.static(getWebBuildFolderPath()))

api/src/controllers/drive.ts

@@ -29,6 +29,7 @@ import { getTmpFilesFolderPath } from '../utils'
 
 interface DeployPayload {
   appLoc: string
+  streamWebFolder?: string
   fileTree: FileTree
 }
 
@@ -190,14 +191,23 @@ const getFileTree = () => {
 }
 
 const deploy = async (data: DeployPayload) => {
+  const driveFilesPath = getTmpFilesFolderPath()
+
+  const appLocParts = data.appLoc.replace(/^\//, '').split('/')
+
+  const appLocPath = path
+    .join(getTmpFilesFolderPath(), ...appLocParts)
+    .replace(new RegExp('/', 'g'), path.sep)
+
+  if (!appLocPath.includes(driveFilesPath)) {
+    throw new Error('appLoc cannot be outside drive.')
+  }
+
   if (!isFileTree(data.fileTree)) {
     throw { code: 400, ...invalidDeployFormatResponse }
   }
 
-  await createFileTree(
-    data.fileTree.members,
-    data.appLoc.replace(/^\//, '').split('/')
-  ).catch((err) => {
+  await createFileTree(data.fileTree.members, appLocParts).catch((err) => {
     throw { code: 500, ...execDeployErrorResponse, ...err }
   })
 

api/src/middlewares/multer.ts

@@ -1,9 +1,8 @@
 import path from 'path'
 import { Request } from 'express'
 import multer, { FileFilterCallback, Options } from 'multer'
-import { getTmpUploadsPath } from '../utils'
+import { blockFileRegex, getTmpUploadsPath } from '../utils'
 
-const acceptableExtensions = ['.sas']
 const fieldNameSize = 300
 const fileSize = 10485760 // 10 MB
 
@@ -31,15 +30,11 @@ const fileFilter: Options['fileFilter'] = (
   file: Express.Multer.File,
   callback: FileFilterCallback
 ) => {
-  const fileExtension = path.extname(file.originalname).toLocaleLowerCase()
-
-  if (!acceptableExtensions.includes(fileExtension)) {
+  const fileExtension = path.extname(file.originalname)
+  const shouldBlockUpload = blockFileRegex.test(file.originalname)
+  if (shouldBlockUpload) {
     return callback(
-      new Error(
-        `File extension '${fileExtension}' not acceptable. Valid extension(s): ${acceptableExtensions.join(
-          ', '
-        )}`
-      )
+      new Error(`File extension '${fileExtension}' not acceptable.`)
     )
   }
 

api/src/routes/api/drive.ts

@@ -22,9 +22,12 @@ driveRouter.post('/deploy', async (req, res) => {
   try {
     const response = await controller.deploy(body)
 
-    const appLoc = body.appLoc.replace(/^\//, '')?.split('/')
-
-    publishAppStream(appLoc)
+    if (body.streamWebFolder)
+      publishAppStream(
+        body.appLoc,
+        body.streamWebFolder,
+        body.streamServiceName
+      )
 
     res.send(response)
   } catch (err: any) {

api/src/routes/api/spec/drive.spec.ts

@@ -266,7 +266,7 @@ describe('files', () => {
 
       it("should respond with Bad Request if filePath doesn't has correct extension", async () => {
         const fileToAttachPath = path.join(__dirname, 'files', 'sample.sas')
-        const pathToUpload = '/my/path/code.oth'
+        const pathToUpload = '/my/path/code.exe'
 
         const res = await request(app)
           .post(`/SASjsApi/drive/file?_filePath=${pathToUpload}`)
@@ -275,7 +275,7 @@ describe('files', () => {
           .attach('file', fileToAttachPath)
           .expect(400)
 
-        expect(res.text).toEqual('Valid extensions for filePath: .sas')
+        expect(res.text).toEqual('Invalid file extension')
         expect(res.body).toEqual({})
       })
 
@@ -293,7 +293,7 @@ describe('files', () => {
       })
 
       it("should respond with Bad Request if attached file doesn't has correct extension", async () => {
-        const fileToAttachPath = path.join(__dirname, 'files', 'sample.oth')
+        const fileToAttachPath = path.join(__dirname, 'files', 'sample.exe')
         const pathToUpload = '/my/path/code.sas'
 
         const res = await request(app)
@@ -303,9 +303,7 @@ describe('files', () => {
           .attach('file', fileToAttachPath)
           .expect(400)
 
-        expect(res.text).toEqual(
-          `File extension '.oth' not acceptable. Valid extension(s): .sas`
-        )
+        expect(res.text).toEqual(`File extension '.exe' not acceptable.`)
         expect(res.body).toEqual({})
       })
 
@@ -426,7 +424,7 @@ describe('files', () => {
 
       it("should respond with Bad Request if filePath doesn't has correct extension", async () => {
         const fileToAttachPath = path.join(__dirname, 'files', 'sample.sas')
-        const pathToUpload = '/my/path/code.oth'
+        const pathToUpload = '/my/path/code.exe'
 
         const res = await request(app)
           .patch(`/SASjsApi/drive/file?_filePath=${pathToUpload}`)
@@ -435,7 +433,7 @@ describe('files', () => {
           .attach('file', fileToAttachPath)
           .expect(400)
 
-        expect(res.text).toEqual('Valid extensions for filePath: .sas')
+        expect(res.text).toEqual('Invalid file extension')
         expect(res.body).toEqual({})
       })
 
@@ -453,7 +451,7 @@ describe('files', () => {
       })
 
       it("should respond with Bad Request if attached file doesn't has correct extension", async () => {
-        const fileToAttachPath = path.join(__dirname, 'files', 'sample.oth')
+        const fileToAttachPath = path.join(__dirname, 'files', 'sample.exe')
         const pathToUpload = '/my/path/code.sas'
 
         const res = await request(app)
@@ -463,9 +461,7 @@ describe('files', () => {
           .attach('file', fileToAttachPath)
           .expect(400)
 
-        expect(res.text).toEqual(
-          `File extension '.oth' not acceptable. Valid extension(s): .sas`
-        )
+        expect(res.text).toEqual(`File extension '.exe' not acceptable.`)
         expect(res.body).toEqual({})
       })
 

api/src/routes/appStream/appStreamHtml.ts

@@ -0,0 +1,47 @@
+import { AppStreamConfig } from '../../types'
+
+const style = `<style>
+* {
+  font-family: 'Roboto', sans-serif;
+}
+.app-container {
+  display: flex;
+  flex-wrap: wrap;
+  align-items: baseline;
+  justify-content: center;
+}
+.app-container .app {
+  width: 100px;
+  margin: 10px;
+  overflow: hidden;
+  border-radius: 10px 10px 0 0;
+  text-align: center;
+}
+</style>`
+
+const defaultAppLogo = '/sasjs-logo.svg'
+
+const singleAppStreamHtml = (streamServiceName: string, logo?: string) =>
+  ` <a class="app" href="${streamServiceName}">
+      <img src="${logo ?? defaultAppLogo}" />
+      ${streamServiceName}
+    </a>`
+
+export const appStreamHtml = (appStreamConfig: AppStreamConfig) => `
+<html>
+  <head>
+    <base href="/AppStream/">
+    ${style}
+  </head>
+  <body>
+    <h1>App Stream</h1>
+    <div class="app-container">
+      ${Object.entries(appStreamConfig).map(([streamServiceName, entry]) =>
+        singleAppStreamHtml(streamServiceName, entry.logo)
+      )}
+      <a class="app" href="#"><img src="/sasjs-logo.svg" />App Name here</a>
+      <a class="app" href="#"><img src="/sasjs-logo.svg" />App Name here</a>
+      <a class="app" href="#"><img src="/sasjs-logo.svg" />App Name here</a>
+    </div>
+  </body>
+</html>`

api/src/routes/appStream/index.ts

@@ -2,24 +2,60 @@ import path from 'path'
 import express from 'express'
 import { folderExists } from '@sasjs/utils'
 
-import { getTmpFilesFolderPath } from '../../utils'
+import { addEntryToAppStreamConfig, getTmpFilesFolderPath } from '../../utils'
+import { appStreamHtml } from './appStreamHtml'
 
 const router = express.Router()
 
-export const publishAppStream = async (appLoc: string[]) => {
-  const appLocUrl = encodeURI(appLoc.join('/'))
-  const appLocPath = appLoc.join(path.sep)
+router.get('/', async (_, res) => {
+  const content = appStreamHtml(process.appStreamConfig)
 
-  const pathToDeployment = path.join(
-    getTmpFilesFolderPath(),
-    appLocPath,
-    'services',
-    'webv'
-  )
+  return res.send(content)
+})
+
+export const publishAppStream = async (
+  appLoc: string,
+  streamWebFolder: string,
+  streamServiceName?: string,
+  addEntryToFile: boolean = true
+) => {
+  const driveFilesPath = getTmpFilesFolderPath()
+
+  const appLocParts = appLoc.replace(/^\//, '')?.split('/')
+  const appLocPath = path.join(driveFilesPath, ...appLocParts)
+  if (!appLocPath.includes(driveFilesPath)) {
+    throw new Error('appLoc cannot be outside drive.')
+  }
+
+  const pathToDeployment = path.join(appLocPath, 'services', streamWebFolder)
+  if (!pathToDeployment.includes(appLocPath)) {
+    throw new Error('streamWebFolder cannot be outside appLoc.')
+  }
 
   if (await folderExists(pathToDeployment)) {
-    router.use(`/${appLocUrl}`, express.static(pathToDeployment))
-    console.log('Serving Stream App: ', appLocUrl)
+    const appCount = process.appStreamConfig
+      ? Object.keys(process.appStreamConfig).length
+      : 0
+
+    if (!streamServiceName || process.appStreamConfig[streamServiceName]) {
+      streamServiceName = `AppStreamName${appCount + 1}`
+    }
+
+    router.use(`/${streamServiceName}`, express.static(pathToDeployment))
+
+    addEntryToAppStreamConfig(
+      streamServiceName,
+      appLoc,
+      streamWebFolder,
+      undefined,
+      addEntryToFile
+    )
+
+    const sasJsPort = process.env.PORT ?? 5000
+    console.log(
+      'Serving Stream App: ',
+      `http://localhost:${sasJsPort}/AppStream/${streamServiceName}`
+    )
   }
 }
 

api/src/types/AppStreamConfig.ts

@@ -0,0 +1,7 @@
+export interface AppStreamConfig {
+  [key: string]: {
+    appLoc: string
+    streamWebFolder: string
+    logo?: string
+  }
+}

api/src/types/Process.d.ts

@@ -3,5 +3,6 @@ declare namespace NodeJS {
     sasLoc: string
     driveLoc: string
     sessionController?: import('../controllers/internal').SessionController
+    appStreamConfig: import('./').AppStreamConfig
   }
 }

api/src/types/index.ts

@@ -1,4 +1,5 @@
 // TODO: uppercase types
+export * from './AppStreamConfig'
 export * from './Execution'
 export * from './FileTree'
 export * from './InfoJWT'

api/src/utils/appStreamConfig.ts

@@ -0,0 +1,81 @@
+import { createFile, fileExists, readFile } from '@sasjs/utils'
+import { publishAppStream } from '../routes/appStream'
+import { AppStreamConfig } from '../types'
+
+import { getTmpAppStreamConfigPath } from './file'
+
+export const loadAppStreamConfig = async () => {
+  const appStreamConfigPath = getTmpAppStreamConfigPath()
+
+  const content = (await fileExists(appStreamConfigPath))
+    ? await readFile(appStreamConfigPath)
+    : '{}'
+
+  let appStreamConfig: AppStreamConfig
+  try {
+    appStreamConfig = JSON.parse(content)
+
+    if (!isValidAppStreamConfig(appStreamConfig)) throw 'invalid type'
+  } catch (_) {
+    appStreamConfig = {}
+  }
+  process.appStreamConfig = {}
+
+  for (const [streamServiceName, entry] of Object.entries(appStreamConfig)) {
+    const { appLoc, streamWebFolder } = entry
+
+    publishAppStream(appLoc, streamWebFolder, streamServiceName, false)
+  }
+
+  console.log('App Stream Config loaded!')
+}
+
+export const addEntryToAppStreamConfig = (
+  streamServiceName: string,
+  appLoc: string,
+  streamWebFolder: string,
+  logo?: string,
+  addEntryToFile: boolean = true
+) => {
+  if (streamServiceName && appLoc && streamWebFolder) {
+    process.appStreamConfig[streamServiceName] = {
+      appLoc,
+      streamWebFolder,
+      logo
+    }
+    if (addEntryToFile) saveAppStreamConfig()
+  }
+}
+
+export const removeEntryFromAppStreamConfig = (streamServiceName: string) => {
+  if (streamServiceName) {
+    delete process.appStreamConfig[streamServiceName]
+    saveAppStreamConfig()
+  }
+}
+
+const saveAppStreamConfig = async () => {
+  const appStreamConfigPath = getTmpAppStreamConfigPath()
+
+  try {
+    await createFile(
+      appStreamConfigPath,
+      JSON.stringify(process.appStreamConfig, null, 2)
+    )
+  } catch (_) {}
+}
+
+const isValidAppStreamConfig = (config: any) => {
+  if (config) {
+    return !Object.entries(config).some(([streamServiceName, entry]) => {
+      const { appLoc, streamWebFolder, logo } = entry as any
+
+      return (
+        typeof streamServiceName !== 'string' ||
+        typeof appLoc !== 'string' ||
+        typeof streamWebFolder !== 'string'
+      )
+    })
+  }
+  return false
+}

api/src/utils/file.ts

@@ -15,6 +15,9 @@ export const getWebBuildFolderPath = () =>
 
 export const getTmpFolderPath = () => process.driveLoc
 
+export const getTmpAppStreamConfigPath = () =>
+  path.join(getTmpFolderPath(), 'appStreamConfig.json')
+
 export const getTmpUploadsPath = () => path.join(getTmpFolderPath(), 'uploads')
 
 export const getTmpFilesFolderPath = () =>

api/src/utils/index.ts

@@ -1,3 +1,4 @@
+export * from './appStreamConfig'
 export * from './connectDB'
 export * from './extractHeaders'
 export * from './file'

api/src/utils/validation.ts

@@ -3,6 +3,8 @@ import Joi from 'joi'
 const usernameSchema = Joi.string().alphanum().min(6).max(20)
 const passwordSchema = Joi.string().min(6).max(1024)
 
+export const blockFileRegex = /\.(exe|sh|htaccess)$/i
+
 export const authorizeValidation = (data: any): Joi.ValidationResult =>
   Joi.object({
     username: usernameSchema.required(),
@@ -69,21 +71,30 @@ export const registerClientValidation = (data: any): Joi.ValidationResult =>
 export const deployValidation = (data: any): Joi.ValidationResult =>
   Joi.object({
     appLoc: Joi.string().pattern(/^\//).required().min(2),
+    streamServiceName: Joi.string(),
+    streamWebFolder: Joi.string(),
     fileTree: Joi.any().required()
   }).validate(data)
 
+const filePathSchema = Joi.string()
+  .custom((value, helpers) => {
+    if (blockFileRegex.test(value)) return helpers.error('string.pattern.base')
+
+    return value
+  })
+  .required()
+  .messages({
+    'string.pattern.base': `Invalid file extension`
+  })
+
 export const fileBodyValidation = (data: any): Joi.ValidationResult =>
   Joi.object({
-    filePath: Joi.string().pattern(/.sas$/).required().messages({
-      'string.pattern.base': `Valid extensions for filePath: .sas`
-    })
+    filePath: filePathSchema
   }).validate(data)
 
 export const fileParamValidation = (data: any): Joi.ValidationResult =>
   Joi.object({
-    _filePath: Joi.string().pattern(/.sas$/).required().messages({
-      'string.pattern.base': `Valid extensions for filePath: .sas`
-    })
+    _filePath: filePathSchema
   }).validate(data)
 
 export const runSASValidation = (data: any): Joi.ValidationResult =>