import { faker } from '@faker-js/faker'; import type { IOmnichannelCannedResponse } from '@rocket.chat/core-typings'; import { expect } from 'chai'; import { before, describe, it } from 'mocha'; import { getCredentials, api, request, credentials } from '../../../data/api-data'; import { createCannedResponse } from '../../../data/livechat/canned-responses'; import { createAgent, createDepartment } from '../../../data/livechat/rooms'; import { removeTag, saveTags } from '../../../data/livechat/tags'; import { createMonitor, createUnit } from '../../../data/livechat/units'; import { updatePermission, updateSetting } from '../../../data/permissions.helper'; import { password, adminUsername } from '../../../data/user'; import { createUser, login } from '../../../data/users.helper'; import { IS_EE } from '../../../e2e/config/constants'; (IS_EE ? describe : describe.skip)('[EE] LIVECHAT - Canned responses', () => { before((done) => getCredentials(done)); before(async () => { await updateSetting('Livechat_enabled', true); }); describe('canned-responses.get', () => { it('should throw unauthorized when view-canned-responses permission is not set', async () => { await updatePermission('view-canned-responses', []); return request.get(api('canned-responses.get')).set(credentials).expect(403); }); it('should return an array of canned responses when available', async () => { await updatePermission('view-canned-responses', ['livechat-agent', 'livechat-monitor', 'livechat-manager', 'admin']); await createCannedResponse(); const { body } = await request.get(api('canned-responses.get')).set(credentials).expect(200); expect(body).to.have.property('success', true); expect(body.responses).to.be.an('array').with.lengthOf.greaterThan(0); expect(body.responses[0]).to.have.property('_id'); expect(body.responses[0]).to.have.property('shortcut'); expect(body.responses[0]).to.have.property('scope'); expect(body.responses[0]).to.have.property('tags'); expect(body.responses[0]).to.have.property('text'); expect(body.responses[0]).to.have.property('userId'); }); it('should return canned responses for monitors even if department is disabled', async () => { const user = await createUser(); const monitor = await createMonitor(user.username); const creds = await login(user.username, password); const department = await createDepartment(undefined, undefined, false); await createUnit(monitor._id, user.username, [department._id]); // create canned response const shortcut = faker.string.uuid(); await request .post(api('canned-responses')) .set(credentials) .send({ shortcut, scope: 'department', tags: ['tag'], text: 'text', departmentId: department._id }) .expect(200); const { body } = await request.get(api('canned-responses.get')).set(creds).expect(200); expect(body).to.have.property('success', true); expect(body.responses).to.be.an('array').with.lengthOf.greaterThan(0); expect(body.responses.find((response: IOmnichannelCannedResponse) => response.shortcut === shortcut)).to.be.an('object'); }); it('should return canned respones for scope user when agent is not on any department', async () => { const user = await createUser(); await createAgent(user.username); const creds = await login(user.username, password); // create canned response const shortcut = faker.string.uuid(); await request .post(api('canned-responses')) .set(creds) .send({ shortcut, scope: 'user', tags: ['tag'], text: 'text' }) .expect(200); const { body } = await request.get(api('canned-responses.get')).set(creds).expect(200); expect(body).to.have.property('success', true); expect(body.responses).to.be.an('array').with.lengthOf.greaterThan(0); expect(body.responses.find((response: IOmnichannelCannedResponse) => response.shortcut === shortcut)).to.be.an('object'); }); it('should return canned responses on the global scope', async () => { const user = await createUser(); const creds = await login(user.username, password); await createAgent(user.username); // create canned response const shortcut = faker.string.uuid(); await request.post(api('canned-responses')).set(credentials).send({ shortcut, scope: 'global', text: 'text' }).expect(200); const { body } = await request.get(api('canned-responses.get')).set(creds).expect(200); expect(body).to.have.property('success', true); expect(body.responses).to.be.an('array').with.lengthOf.greaterThan(0); expect(body.responses.find((response: IOmnichannelCannedResponse) => response.shortcut === shortcut)).to.be.an('object'); }); it('should return canned responses from the departments user is in', async () => { const user = await createUser(); const creds = await login(user.username, password); await createAgent(user.username); const department = await createDepartment([{ agentId: user._id }], undefined, true); // create canned response const shortcut = faker.string.uuid(); await request .post(api('canned-responses')) .set(credentials) .send({ shortcut, scope: 'department', text: 'text', departmentId: department._id }) .expect(200); const { body } = await request.get(api('canned-responses.get')).set(creds).expect(200); expect(body).to.have.property('success', true); expect(body.responses).to.be.an('array').with.lengthOf.greaterThan(0); expect(body.responses.find((response: IOmnichannelCannedResponse) => response.shortcut === shortcut)).to.be.an('object'); }); }); describe('[GET] canned-responses', () => { it('should fail if user dont have view-canned-responses permission', async () => { await updatePermission('view-canned-responses', []); return request.get(api('canned-responses')).set(credentials).expect(403); }); it('should return an array of canned responses when available', async () => { await updatePermission('view-canned-responses', ['livechat-agent', 'livechat-monitor', 'livechat-manager', 'admin']); await createCannedResponse(); const { body } = await request.get(api('canned-responses')).query({ sort: '{ "_createdAt": -1 }' }).set(credentials).expect(200); expect(body).to.have.property('success', true); expect(body.cannedResponses).to.be.an('array').with.lengthOf.greaterThan(0); expect(body.cannedResponses[0]).to.have.property('_id'); expect(body.cannedResponses[0]).to.have.property('shortcut'); expect(body.cannedResponses[0]).to.have.property('scope'); expect(body.cannedResponses[0]).to.have.property('tags'); expect(body.cannedResponses[0]).to.have.property('text'); expect(body.cannedResponses[0]).to.have.property('userId'); }); it('should return a canned response matching the params provided (shortcut)', async () => { const response = await createCannedResponse(); const { body } = await request.get(api('canned-responses')).set(credentials).query({ shortcut: response.shortcut }).expect(200); expect(body).to.have.property('success', true); expect(body.cannedResponses).to.be.an('array').with.lengthOf(1); expect(body.cannedResponses[0]).to.have.property('_id'); expect(body.cannedResponses[0]).to.have.property('shortcut', response.shortcut); }); it('should return a canned response matching the params provided (scope)', async () => { const response = await createCannedResponse(); const { body } = await request.get(api('canned-responses')).set(credentials).query({ scope: response.scope }).expect(200); expect(body).to.have.property('success', true); expect(body.cannedResponses).to.be.an('array').with.lengthOf.greaterThan(0); expect(body.cannedResponses[0]).to.have.property('_id'); expect(body.cannedResponses[0]).to.have.property('scope', response.scope); }); it('should return a canned response matching the params provided (tags)', async () => { const response = await createCannedResponse(); const { body } = await request.get(api('canned-responses')).set(credentials).query({ 'tags[]': response.tags?.[0] }).expect(200); expect(body).to.have.property('success', true); expect(body.cannedResponses).to.be.an('array').with.lengthOf(1); expect(body.cannedResponses[0]).to.have.property('_id'); expect(body.cannedResponses[0]).to.have.property('tags').that.is.an('array').which.includes(response.tags?.[0]); }); it('should return a canned response matching the params provided (text)', async () => { const response = await createCannedResponse(); const { body } = await request.get(api('canned-responses')).set(credentials).query({ text: response.text }).expect(200); expect(body).to.have.property('success', true); expect(body.cannedResponses).to.be.an('array').with.lengthOf(1); expect(body.cannedResponses[0]).to.have.property('_id'); expect(body.cannedResponses[0]).to.have.property('text', response.text); }); }); describe('[POST] canned-responses', () => { const dupshortcut = `shortcut-${faker.string.nanoid(6)}`; it('should fail if user dont have save-canned-responses permission', async () => { await updatePermission('save-canned-responses', []); return request .post(api('canned-responses')) .set(credentials) .send({ shortcut: 'shortcut', scope: 'user', tags: ['tag'], text: 'text' }) .expect(403); }); it('should fail if shortcut is not on the request', async () => { await updatePermission('save-canned-responses', ['livechat-agent', 'livechat-monitor', 'livechat-manager', 'admin']); return request.post(api('canned-responses')).set(credentials).expect(400); }); it('should fail if text is not on the request', async () => { return request.post(api('canned-responses')).set(credentials).send({ shortcut: 'shortcut' }).expect(400); }); it('should fail if scope is not on the request', async () => { return request.post(api('canned-responses')).set(credentials).send({ shortcut: 'shortcut', text: 'text' }).expect(400); }); it('should fail if tags is not an array of strings', async () => { return request .post(api('canned-responses')) .set(credentials) .send({ shortcut: 'shortcut', text: 'text', scope: 'department', tags: 'tag' }) .expect(400); }); it('should create a new canned response', async () => { const { body } = await request .post(api('canned-responses')) .set(credentials) .send({ shortcut: dupshortcut, scope: 'user', tags: ['tag'], text: 'text' }) .expect(200); expect(body).to.have.property('success', true); }); it('should fail if shortcut is already in use', async () => { return request .post(api('canned-responses')) .set(credentials) .send({ shortcut: dupshortcut, scope: 'user', tags: ['tag'], text: 'text' }) .expect(400); }); it('should save a canned response related to an EE tag', async () => { const tag = await saveTags(); const { body } = await request .post(api('canned-responses')) .set(credentials) .send({ shortcut: `eetag-${faker.string.nanoid(6)}`, scope: 'user', tags: [tag.name], text: 'text' }) .expect(200); expect(body).to.have.property('success', true); const { body: getResult } = await request.get(api('canned-responses')).set(credentials).query({ 'tags[]': tag.name }).expect(200); expect(getResult).to.have.property('success', true); expect(getResult.cannedResponses).to.be.an('array').with.lengthOf(1); expect(getResult.cannedResponses[0]).to.have.property('_id'); expect(getResult.cannedResponses[0]).to.have.property('tags').that.is.an('array').which.includes(tag.name); }); it('should not include removed tags in the response', async () => { const tag = await saveTags(); const { body } = await request .post(api('canned-responses')) .set(credentials) .send({ shortcut: `remove-${faker.string.nanoid(6)}`, scope: 'user', tags: [tag.name], text: 'text' }) .expect(200); expect(body).to.have.property('success', true); await removeTag(tag._id); const { body: getResult } = await request.get(api('canned-responses')).set(credentials).query({ 'tags[]': tag.name }).expect(200); expect(getResult).to.have.property('success', true); expect(getResult.cannedResponses).to.be.an('array').with.lengthOf(0); }); it('should persist userId when updating a canned response', async () => { const response = await createCannedResponse(); const { body: { cannedResponses }, } = await request.get(api('canned-responses')).set(credentials).query({}).expect(200); const targetCannedResponse = cannedResponses.find( (cannedResponse: IOmnichannelCannedResponse) => cannedResponse.shortcut === response.shortcut, ); const { body } = await request .post(api('canned-responses')) .set(credentials) .send({ _id: targetCannedResponse._id, shortcut: `${targetCannedResponse.shortcut}-edited`, text: 'edited text', scope: 'user' }) .expect(200); expect(body).to.have.property('success', true); const { body: getResult } = await request .get(api('canned-responses')) .set(credentials) .query({ shortcut: `${targetCannedResponse.shortcut}-edited` }) .expect(200); expect(getResult).to.have.property('success', true); expect(getResult.cannedResponses[0]).to.have.property('userId', adminUsername); }); }); describe('[DELETE] canned-responses', () => { it('should fail if user dont have remove-canned-responses permission', async () => { await updatePermission('remove-canned-responses', []); return request.delete(api('canned-responses/sfdads')).set(credentials).expect(403); }); it('should fail if _id is not on the request', async () => { await updatePermission('remove-canned-responses', ['livechat-agent', 'livechat-monitor', 'livechat-manager', 'admin']); return request.delete(api('canned-responses')).set(credentials).expect(400); }); it('should delete a canned response', async () => { const response = await createCannedResponse(); const { body: cr } = await request.get(api('canned-responses')).set(credentials).query({ shortcut: response.shortcut }).expect(200); const { body } = await request .delete(api(`canned-responses/${cr.cannedResponses[0]._id}`)) .set(credentials) .expect(200); expect(body).to.have.property('success', true); }); }); });