({
},
users: [{ type: Schema.Types.ObjectId, ref: 'User' }]
})
+
groupSchema.plugin(AutoIncrement, { inc_field: 'groupId' })
// Hooks
@@ -55,6 +58,17 @@ groupSchema.post('save', function (group: IGroup, next: Function) {
})
})
+// pre remove hook to remove all references of group from users
+groupSchema.pre('remove', async function () {
+ const userIds = this.users
+ await Promise.all(
+ userIds.map(async (userId) => {
+ const user = await User.findById(userId)
+ user?.removeGroup(this._id)
+ })
+ )
+})
+
// Instance Methods
groupSchema.method(
'addUser',
diff --git a/api/src/routes/api/drive.ts b/api/src/routes/api/drive.ts
index 71ffa4a..6126946 100644
--- a/api/src/routes/api/drive.ts
+++ b/api/src/routes/api/drive.ts
@@ -7,9 +7,12 @@ import { multerSingle } from '../../middlewares/multer'
import { DriveController } from '../../controllers/'
import {
deployValidation,
+ extractJSONFromZip,
+ extractName,
fileBodyValidation,
fileParamValidation,
- folderParamValidation
+ folderParamValidation,
+ isZipFile
} from '../../utils'
const controller = new DriveController()
@@ -49,7 +52,24 @@ driveRouter.post(
async (req, res) => {
if (!req.file) return res.status(400).send('"file" is not present.')
- const fileContent = await readFile(req.file.path)
+ let fileContent: string = ''
+
+ const { value: zipFile } = isZipFile(req.file)
+ if (zipFile) {
+ fileContent = await extractJSONFromZip(zipFile)
+ const fileInZip = extractName(zipFile.originalname)
+
+ if (!fileContent) {
+ deleteFile(req.file.path)
+ return res
+ .status(400)
+ .send(
+ `No content present in ${fileInZip} of compressed file ${zipFile.originalname}`
+ )
+ }
+ } else {
+ fileContent = await readFile(req.file.path)
+ }
let jsonContent
try {
diff --git a/api/src/routes/api/group.ts b/api/src/routes/api/group.ts
index 8164262..930b817 100644
--- a/api/src/routes/api/group.ts
+++ b/api/src/routes/api/group.ts
@@ -1,7 +1,7 @@
import express from 'express'
import { GroupController } from '../../controllers/'
import { authenticateAccessToken, verifyAdmin } from '../../middlewares'
-import { registerGroupValidation } from '../../utils'
+import { getGroupValidation, registerGroupValidation } from '../../utils'
const groupRouter = express.Router()
@@ -18,7 +18,11 @@ groupRouter.post(
const response = await controller.createGroup(body)
res.send(response)
} catch (err: any) {
- res.status(403).send(err.toString())
+ const statusCode = err.code
+
+ delete err.code
+
+ res.status(statusCode).send(err.message)
}
}
)
@@ -29,7 +33,11 @@ groupRouter.get('/', authenticateAccessToken, async (req, res) => {
const response = await controller.getAllGroups()
res.send(response)
} catch (err: any) {
- res.status(403).send(err.toString())
+ const statusCode = err.code
+
+ delete err.code
+
+ res.status(statusCode).send(err.message)
}
})
@@ -41,10 +49,37 @@ groupRouter.get('/:groupId', authenticateAccessToken, async (req, res) => {
const response = await controller.getGroup(parseInt(groupId))
res.send(response)
} catch (err: any) {
- res.status(403).send(err.toString())
+ const statusCode = err.code
+
+ delete err.code
+
+ res.status(statusCode).send(err.message)
}
})
+groupRouter.get(
+ '/by/groupname/:name',
+ authenticateAccessToken,
+ async (req, res) => {
+ const { error, value: params } = getGroupValidation(req.params)
+ if (error) return res.status(400).send(error.details[0].message)
+
+ const { name } = params
+
+ const controller = new GroupController()
+ try {
+ const response = await controller.getGroupByGroupName(name)
+ res.send(response)
+ } catch (err: any) {
+ const statusCode = err.code
+
+ delete err.code
+
+ res.status(statusCode).send(err.message)
+ }
+ }
+)
+
groupRouter.post(
'/:groupId/:userId',
authenticateAccessToken,
@@ -60,7 +95,11 @@ groupRouter.post(
)
res.send(response)
} catch (err: any) {
- res.status(403).send(err.toString())
+ const statusCode = err.code
+
+ delete err.code
+
+ res.status(statusCode).send(err.message)
}
}
)
@@ -80,7 +119,11 @@ groupRouter.delete(
)
res.send(response)
} catch (err: any) {
- res.status(403).send(err.toString())
+ const statusCode = err.code
+
+ delete err.code
+
+ res.status(statusCode).send(err.message)
}
}
)
@@ -97,7 +140,11 @@ groupRouter.delete(
await controller.deleteGroup(parseInt(groupId))
res.status(200).send('Group Deleted!')
} catch (err: any) {
- res.status(403).send(err.toString())
+ const statusCode = err.code
+
+ delete err.code
+
+ res.status(statusCode).send(err.message)
}
}
)
diff --git a/api/src/routes/api/spec/drive.spec.ts b/api/src/routes/api/spec/drive.spec.ts
index 341bd02..e9e6e8a 100644
--- a/api/src/routes/api/spec/drive.spec.ts
+++ b/api/src/routes/api/spec/drive.spec.ts
@@ -3,6 +3,7 @@ import { Express } from 'express'
import mongoose, { Mongoose } from 'mongoose'
import { MongoMemoryServer } from 'mongodb-memory-server'
import request from 'supertest'
+import AdmZip from 'adm-zip'
import {
folderExists,
@@ -72,11 +73,52 @@ describe('drive', () => {
})
describe('deploy', () => {
- const shouldFailAssertion = async (payload: any) => {
- const res = await request(app)
- .post('/SASjsApi/drive/deploy')
- .auth(accessToken, { type: 'bearer' })
- .send({ appLoc: '/Public', fileTree: payload })
+ const makeRequest = async (payload: any, type: string = 'payload') => {
+ const requestUrl =
+ type === 'payload'
+ ? '/SASjsApi/drive/deploy'
+ : '/SASjsApi/drive/deploy/upload'
+
+ if (type === 'payload') {
+ return await request(app)
+ .post(requestUrl)
+ .auth(accessToken, { type: 'bearer' })
+ .send({ appLoc: '/Public', fileTree: payload })
+ }
+ if (type === 'file') {
+ const deployContents = JSON.stringify({
+ appLoc: '/Public',
+ fileTree: payload
+ })
+ return await request(app)
+ .post(requestUrl)
+ .auth(accessToken, { type: 'bearer' })
+ .attach('file', Buffer.from(deployContents), 'deploy.json')
+ } else {
+ const deployContents = JSON.stringify({
+ appLoc: '/Public',
+ fileTree: payload
+ })
+ const zip = new AdmZip()
+ // add file directly
+ zip.addFile(
+ 'deploy.json',
+ Buffer.from(deployContents, 'utf8'),
+ 'entry comment goes here'
+ )
+
+ return await request(app)
+ .post(requestUrl)
+ .auth(accessToken, { type: 'bearer' })
+ .attach('file', zip.toBuffer(), 'deploy.json.zip')
+ }
+ }
+
+ const shouldFailAssertion = async (
+ payload: any,
+ type: string = 'payload'
+ ) => {
+ const res = await makeRequest(payload, type)
expect(res.statusCode).toEqual(400)
@@ -176,6 +218,240 @@ describe('drive', () => {
await deleteFolder(path.join(getFilesFolder(), 'public'))
})
+
+ describe('upload', () => {
+ it('should respond with payload example if valid JSON file was not provided', async () => {
+ await shouldFailAssertion(null, 'file')
+ await shouldFailAssertion(undefined, 'file')
+ await shouldFailAssertion('data', 'file')
+ await shouldFailAssertion({}, 'file')
+ await shouldFailAssertion(
+ {
+ userId: 1,
+ title: 'test is cool'
+ },
+ 'file'
+ )
+ await shouldFailAssertion(
+ {
+ membersWRONG: []
+ },
+ 'file'
+ )
+ await shouldFailAssertion(
+ {
+ members: {}
+ },
+ 'file'
+ )
+ await shouldFailAssertion(
+ {
+ members: [
+ {
+ nameWRONG: 'jobs',
+ type: 'folder',
+ members: []
+ }
+ ]
+ },
+ 'file'
+ )
+ await shouldFailAssertion(
+ {
+ members: [
+ {
+ name: 'jobs',
+ type: 'WRONG',
+ members: []
+ }
+ ]
+ },
+ 'file'
+ )
+ await shouldFailAssertion(
+ {
+ members: [
+ {
+ name: 'jobs',
+ type: 'folder',
+ members: [
+ {
+ name: 'extract',
+ type: 'folder',
+ members: [
+ {
+ name: 'makedata1',
+ type: 'service',
+ codeWRONG: '%put Hello World!;'
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ },
+ 'file'
+ )
+ })
+
+ it('should successfully deploy if valid JSON file was provided', async () => {
+ const deployContents = JSON.stringify({
+ appLoc: '/public',
+ fileTree: getTreeExample()
+ })
+ const res = await request(app)
+ .post('/SASjsApi/drive/deploy/upload')
+ .auth(accessToken, { type: 'bearer' })
+ .attach('file', Buffer.from(deployContents), 'deploy.json')
+
+ expect(res.statusCode).toEqual(200)
+ expect(res.text).toEqual(
+ '{"status":"success","message":"Files deployed successfully to @sasjs/server."}'
+ )
+ await expect(folderExists(getFilesFolder())).resolves.toEqual(true)
+
+ const testJobFolder = path.join(
+ getFilesFolder(),
+ 'public',
+ 'jobs',
+ 'extract'
+ )
+ await expect(folderExists(testJobFolder)).resolves.toEqual(true)
+
+ const exampleService = getExampleService()
+ const testJobFile =
+ path.join(testJobFolder, exampleService.name) + '.sas'
+
+ await expect(fileExists(testJobFile)).resolves.toEqual(true)
+
+ await expect(readFile(testJobFile)).resolves.toEqual(
+ exampleService.code
+ )
+
+ await deleteFolder(path.join(getFilesFolder(), 'public'))
+ })
+ })
+
+ describe('upload - zipped', () => {
+ it('should respond with payload example if valid Zipped file was not provided', async () => {
+ await shouldFailAssertion(null, 'zip')
+ await shouldFailAssertion(undefined, 'zip')
+ await shouldFailAssertion('data', 'zip')
+ await shouldFailAssertion({}, 'zip')
+ await shouldFailAssertion(
+ {
+ userId: 1,
+ title: 'test is cool'
+ },
+ 'zip'
+ )
+ await shouldFailAssertion(
+ {
+ membersWRONG: []
+ },
+ 'zip'
+ )
+ await shouldFailAssertion(
+ {
+ members: {}
+ },
+ 'zip'
+ )
+ await shouldFailAssertion(
+ {
+ members: [
+ {
+ nameWRONG: 'jobs',
+ type: 'folder',
+ members: []
+ }
+ ]
+ },
+ 'zip'
+ )
+ await shouldFailAssertion(
+ {
+ members: [
+ {
+ name: 'jobs',
+ type: 'WRONG',
+ members: []
+ }
+ ]
+ },
+ 'zip'
+ )
+ await shouldFailAssertion(
+ {
+ members: [
+ {
+ name: 'jobs',
+ type: 'folder',
+ members: [
+ {
+ name: 'extract',
+ type: 'folder',
+ members: [
+ {
+ name: 'makedata1',
+ type: 'service',
+ codeWRONG: '%put Hello World!;'
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ },
+ 'zip'
+ )
+ })
+
+ it('should successfully deploy if valid Zipped file was provided', async () => {
+ const deployContents = JSON.stringify({
+ appLoc: '/public',
+ fileTree: getTreeExample()
+ })
+
+ const zip = new AdmZip()
+ // add file directly
+ zip.addFile(
+ 'deploy.json',
+ Buffer.from(deployContents, 'utf8'),
+ 'entry comment goes here'
+ )
+ const res = await request(app)
+ .post('/SASjsApi/drive/deploy/upload')
+ .auth(accessToken, { type: 'bearer' })
+ .attach('file', zip.toBuffer(), 'deploy.json.zip')
+
+ expect(res.statusCode).toEqual(200)
+ expect(res.text).toEqual(
+ '{"status":"success","message":"Files deployed successfully to @sasjs/server."}'
+ )
+ await expect(folderExists(getFilesFolder())).resolves.toEqual(true)
+
+ const testJobFolder = path.join(
+ getFilesFolder(),
+ 'public',
+ 'jobs',
+ 'extract'
+ )
+ await expect(folderExists(testJobFolder)).resolves.toEqual(true)
+
+ const exampleService = getExampleService()
+ const testJobFile =
+ path.join(testJobFolder, exampleService.name) + '.sas'
+
+ await expect(fileExists(testJobFile)).resolves.toEqual(true)
+
+ await expect(readFile(testJobFile)).resolves.toEqual(
+ exampleService.code
+ )
+
+ await deleteFolder(path.join(getFilesFolder(), 'public'))
+ })
+ })
})
describe('folder', () => {
diff --git a/api/src/routes/api/spec/group.spec.ts b/api/src/routes/api/spec/group.spec.ts
index b48bad8..86196ce 100644
--- a/api/src/routes/api/spec/group.spec.ts
+++ b/api/src/routes/api/spec/group.spec.ts
@@ -23,7 +23,7 @@ const user = {
}
const group = {
- name: 'DCGroup1',
+ name: 'dcgroup1',
description: 'DC group for testing purposes.'
}
@@ -70,6 +70,32 @@ describe('group', () => {
expect(res.body.users).toEqual([])
})
+ it('should respond with Conflict when group already exists with same name', async () => {
+ await groupController.createGroup(group)
+
+ const res = await request(app)
+ .post('/SASjsApi/group')
+ .auth(adminAccessToken, { type: 'bearer' })
+ .send(group)
+ .expect(409)
+
+ expect(res.text).toEqual('Group name already exists.')
+ expect(res.body).toEqual({})
+ })
+
+ it('should respond with Bad Request when group name does not match the group name schema', async () => {
+ const res = await request(app)
+ .post('/SASjsApi/group')
+ .auth(adminAccessToken, { type: 'bearer' })
+ .send({ ...group, name: 'Wrong Group Name' })
+ .expect(400)
+
+ expect(res.text).toEqual(
+ '"name" must only contain alpha-numeric characters'
+ )
+ expect(res.body).toEqual({})
+ })
+
it('should respond with Unauthorized if access token is not present', async () => {
const res = await request(app).post('/SASjsApi/group').send().expect(401)
@@ -125,14 +151,51 @@ describe('group', () => {
expect(res.body).toEqual({})
})
- it('should respond with Forbidden if groupId is incorrect', async () => {
+ it(`should delete group's reference from users' groups array`, async () => {
+ const dbGroup = await groupController.createGroup(group)
+ const dbUser1 = await userController.createUser({
+ ...user,
+ username: 'deletegroup1'
+ })
+ const dbUser2 = await userController.createUser({
+ ...user,
+ username: 'deletegroup2'
+ })
+
+ await groupController.addUserToGroup(dbGroup.groupId, dbUser1.id)
+ await groupController.addUserToGroup(dbGroup.groupId, dbUser2.id)
+
+ await request(app)
+ .delete(`/SASjsApi/group/${dbGroup.groupId}`)
+ .auth(adminAccessToken, { type: 'bearer' })
+ .send()
+ .expect(200)
+
+ const res1 = await request(app)
+ .get(`/SASjsApi/user/${dbUser1.id}`)
+ .auth(adminAccessToken, { type: 'bearer' })
+ .send()
+ .expect(200)
+
+ expect(res1.body.groups).toEqual([])
+
+ const res2 = await request(app)
+ .get(`/SASjsApi/user/${dbUser2.id}`)
+ .auth(adminAccessToken, { type: 'bearer' })
+ .send()
+ .expect(200)
+
+ expect(res2.body.groups).toEqual([])
+ })
+
+ it('should respond with Not Found if groupId is incorrect', async () => {
const res = await request(app)
.delete(`/SASjsApi/group/1234`)
.auth(adminAccessToken, { type: 'bearer' })
.send()
- .expect(403)
+ .expect(404)
- expect(res.text).toEqual('Error: No Group deleted!')
+ expect(res.text).toEqual('Group not found.')
expect(res.body).toEqual({})
})
@@ -216,16 +279,76 @@ describe('group', () => {
expect(res.body).toEqual({})
})
- it('should respond with Forbidden if groupId is incorrect', async () => {
+ it('should respond with Not Found if groupId is incorrect', async () => {
const res = await request(app)
.get('/SASjsApi/group/1234')
.auth(adminAccessToken, { type: 'bearer' })
.send()
- .expect(403)
+ .expect(404)
- expect(res.text).toEqual('Error: Group not found.')
+ expect(res.text).toEqual('Group not found.')
expect(res.body).toEqual({})
})
+
+ describe('by group name', () => {
+ it('should respond with group', async () => {
+ const { name } = await groupController.createGroup(group)
+
+ const res = await request(app)
+ .get(`/SASjsApi/group/by/groupname/${name}`)
+ .auth(adminAccessToken, { type: 'bearer' })
+ .send()
+ .expect(200)
+
+ expect(res.body.groupId).toBeTruthy()
+ expect(res.body.name).toEqual(group.name)
+ expect(res.body.description).toEqual(group.description)
+ expect(res.body.isActive).toEqual(true)
+ expect(res.body.users).toEqual([])
+ })
+
+ it('should respond with group when access token is not of an admin account', async () => {
+ const accessToken = await generateSaveTokenAndCreateUser({
+ ...user,
+ username: 'getbyname' + user.username
+ })
+
+ const { name } = await groupController.createGroup(group)
+
+ const res = await request(app)
+ .get(`/SASjsApi/group/by/groupname/${name}`)
+ .auth(accessToken, { type: 'bearer' })
+ .send()
+ .expect(200)
+
+ expect(res.body.groupId).toBeTruthy()
+ expect(res.body.name).toEqual(group.name)
+ expect(res.body.description).toEqual(group.description)
+ expect(res.body.isActive).toEqual(true)
+ expect(res.body.users).toEqual([])
+ })
+
+ it('should respond with Unauthorized if access token is not present', async () => {
+ const res = await request(app)
+ .get('/SASjsApi/group/by/groupname/dcgroup')
+ .send()
+ .expect(401)
+
+ expect(res.text).toEqual('Unauthorized')
+ expect(res.body).toEqual({})
+ })
+
+ it('should respond with Not Found if groupname is incorrect', async () => {
+ const res = await request(app)
+ .get('/SASjsApi/group/by/groupname/randomCharacters')
+ .auth(adminAccessToken, { type: 'bearer' })
+ .send()
+ .expect(404)
+
+ expect(res.text).toEqual('Group not found.')
+ expect(res.body).toEqual({})
+ })
+ })
})
describe('getAll', () => {
@@ -245,8 +368,8 @@ describe('group', () => {
expect(res.body).toEqual([
{
groupId: expect.anything(),
- name: 'DCGroup1',
- description: 'DC group for testing purposes.'
+ name: group.name,
+ description: group.description
}
])
})
@@ -267,8 +390,8 @@ describe('group', () => {
expect(res.body).toEqual([
{
groupId: expect.anything(),
- name: 'DCGroup1',
- description: 'DC group for testing purposes.'
+ name: group.name,
+ description: group.description
}
])
})
@@ -309,6 +432,34 @@ describe('group', () => {
])
})
+ it(`should add group to user's groups array`, async () => {
+ const dbGroup = await groupController.createGroup(group)
+ const dbUser = await userController.createUser({
+ ...user,
+ username: 'addUserToGroup'
+ })
+
+ await request(app)
+ .post(`/SASjsApi/group/${dbGroup.groupId}/${dbUser.id}`)
+ .auth(adminAccessToken, { type: 'bearer' })
+ .send()
+ .expect(200)
+
+ const res = await request(app)
+ .get(`/SASjsApi/user/${dbUser.id}`)
+ .auth(adminAccessToken, { type: 'bearer' })
+ .send()
+ .expect(200)
+
+ expect(res.body.groups).toEqual([
+ {
+ groupId: expect.anything(),
+ name: group.name,
+ description: group.description
+ }
+ ])
+ })
+
it('should respond with group without duplicating user', async () => {
const dbGroup = await groupController.createGroup(group)
const dbUser = await userController.createUser({
@@ -362,26 +513,26 @@ describe('group', () => {
expect(res.body).toEqual({})
})
- it('should respond with Forbidden if groupId is incorrect', async () => {
+ it('should respond with Not Found if groupId is incorrect', async () => {
const res = await request(app)
.post('/SASjsApi/group/123/123')
.auth(adminAccessToken, { type: 'bearer' })
.send()
- .expect(403)
+ .expect(404)
- expect(res.text).toEqual('Error: Group not found.')
+ expect(res.text).toEqual('Group not found.')
expect(res.body).toEqual({})
})
- it('should respond with Forbidden if userId is incorrect', async () => {
+ it('should respond with Not Found if userId is incorrect', async () => {
const dbGroup = await groupController.createGroup(group)
const res = await request(app)
.post(`/SASjsApi/group/${dbGroup.groupId}/123`)
.auth(adminAccessToken, { type: 'bearer' })
.send()
- .expect(403)
+ .expect(404)
- expect(res.text).toEqual('Error: User not found.')
+ expect(res.text).toEqual('User not found.')
expect(res.body).toEqual({})
})
})
@@ -412,6 +563,29 @@ describe('group', () => {
expect(res.body.users).toEqual([])
})
+ it(`should remove group from user's groups array`, async () => {
+ const dbGroup = await groupController.createGroup(group)
+ const dbUser = await userController.createUser({
+ ...user,
+ username: 'removeGroupFromUser'
+ })
+ await groupController.addUserToGroup(dbGroup.groupId, dbUser.id)
+
+ await request(app)
+ .delete(`/SASjsApi/group/${dbGroup.groupId}/${dbUser.id}`)
+ .auth(adminAccessToken, { type: 'bearer' })
+ .send()
+ .expect(200)
+
+ const res = await request(app)
+ .get(`/SASjsApi/user/${dbUser.id}`)
+ .auth(adminAccessToken, { type: 'bearer' })
+ .send()
+ .expect(200)
+
+ expect(res.body.groups).toEqual([])
+ })
+
it('should respond with Unauthorized if access token is not present', async () => {
const res = await request(app)
.delete('/SASjsApi/group/123/123')
@@ -438,26 +612,26 @@ describe('group', () => {
expect(res.body).toEqual({})
})
- it('should respond with Forbidden if groupId is incorrect', async () => {
+ it('should respond with Not Found if groupId is incorrect', async () => {
const res = await request(app)
.delete('/SASjsApi/group/123/123')
.auth(adminAccessToken, { type: 'bearer' })
.send()
- .expect(403)
+ .expect(404)
- expect(res.text).toEqual('Error: Group not found.')
+ expect(res.text).toEqual('Group not found.')
expect(res.body).toEqual({})
})
- it('should respond with Forbidden if userId is incorrect', async () => {
+ it('should respond with Not Found if userId is incorrect', async () => {
const dbGroup = await groupController.createGroup(group)
const res = await request(app)
.delete(`/SASjsApi/group/${dbGroup.groupId}/123`)
.auth(adminAccessToken, { type: 'bearer' })
.send()
- .expect(403)
+ .expect(404)
- expect(res.text).toEqual('Error: User not found.')
+ expect(res.text).toEqual('User not found.')
expect(res.body).toEqual({})
})
})
diff --git a/api/src/routes/appStream/appStreamHtml.ts b/api/src/routes/appStream/appStreamHtml.ts
index 2635729..b0512ca 100644
--- a/api/src/routes/appStream/appStreamHtml.ts
+++ b/api/src/routes/appStream/appStreamHtml.ts
@@ -23,13 +23,21 @@ export const appStreamHtml = (appStreamConfig: AppStreamConfig) => `
${style}
- App Stream
+
+ 
+ App Stream
+
- ${Object.entries(appStreamConfig)
- .map(([streamServiceName, entry]) =>
- singleAppStreamHtml(streamServiceName, entry.appLoc, entry.streamLogo)
- )
- .join('')}
+ ${Object.entries(appStreamConfig)
+ .map(([streamServiceName, entry]) =>
+ singleAppStreamHtml(
+ streamServiceName,
+ entry.appLoc,
+ entry.streamLogo
+ )
+ )
+ .join('')}
+
