30810eecd7
Some checks failed
Create issues from TODOs / todos (push) Failing after 3s
Close inactive issues / close-issues (push) Has been cancelled
Deploy GitHub Pages / deploy-preview (push) Has been cancelled
CI / ⚙️ Variables Setup (push) Has been cancelled
CI / ⚙️ Test Guard (push) Has been cancelled
CI / 🚀 Notify external services - draft (push) Has been cancelled
CI / 📦 Build Packages (push) Has been cancelled
CI / 📦 Meteor Build (coverage) (push) Has been cancelled
CI / 📦 Meteor Build (production) (push) Has been cancelled
CI / 🚢 Build Docker (amd64, [account-service presence-service omnichannel-transcript-service], ${{ (github.event_name != 'release' && github.ref != 'refs/heads/develop') && 'coverage' || 'production' }}) (push) Has been cancelled
CI / 🚢 Build Docker (amd64, [account-service presence-service omnichannel-transcript-service], fips) (push) Has been cancelled
CI / 🚢 Build Docker (amd64, [authorization-service queue-worker-service ddp-streamer-service], ${{ (github.event_name != 'release' && github.ref != 'refs/heads/develop') && 'coverage' || 'production' }}) (push) Has been cancelled
CI / 🚢 Build Docker (amd64, [authorization-service queue-worker-service ddp-streamer-service], fips) (push) Has been cancelled
CI / 🚢 Build Docker (amd64, [rocketchat], ${{ (github.event_name != 'release' && github.ref != 'refs/heads/develop') && 'coverage' || 'production' }}) (push) Has been cancelled
CI / 🚢 Build Docker (amd64, [rocketchat], coverage) (push) Has been cancelled
CI / 🚢 Build Docker (amd64, [rocketchat], fips) (push) Has been cancelled
CI / 🚢 Build Docker (arm64, [account-service presence-service omnichannel-transcript-service], ${{ (github.event_name != 'release' && github.ref != 'refs/heads/develop') && 'coverage' || 'production' }}) (push) Has been cancelled
CI / 🚢 Build Docker (arm64, [authorization-service queue-worker-service ddp-streamer-service], ${{ (github.event_name != 'release' && github.ref != 'refs/heads/develop') && 'coverage' || 'production' }}) (push) Has been cancelled
CI / 🚢 Build Docker (arm64, [rocketchat], ${{ (github.event_name != 'release' && github.ref != 'refs/heads/develop') && 'coverage' || 'production' }}) (push) Has been cancelled
CI / 🚢 Build Docker (arm64, [rocketchat], coverage) (push) Has been cancelled
CI / 🚢 Publish Docker Images (ghcr.io) (push) Has been cancelled
CI / 📦 Track Image Sizes (push) Has been cancelled
CI / 🔎 Code Check - Action Lint (push) Has been cancelled
CI / 🔎 Code Check (push) Has been cancelled
CI / 🔨 Test Storybook (push) Has been cancelled
CI / 🔨 Test Unit (push) Has been cancelled
CI / 🔨 Test API (CE) (push) Has been cancelled
CI / 🔨 Test API Livechat (CE) (push) Has been cancelled
CI / 🔨 Test UI (CE) (push) Has been cancelled
CI / 🔨 Test API (EE) (push) Has been cancelled
CI / 🔨 Test API Livechat (EE) (push) Has been cancelled
CI / 🔨 Test API Apps (deno-runtime - EE) (push) Has been cancelled
CI / 🔨 Test UI (EE) (push) Has been cancelled
CI / 🔨 Test API (FIPS) (push) Has been cancelled
CI / 🔨 Test API Livechat (FIPS) (push) Has been cancelled
CI / 🔨 Test UI (FIPS) (push) Has been cancelled
CI / 🔨 Test Federation Matrix (push) Has been cancelled
CI / 📊 Report Coverage (push) Has been cancelled
CI / ✅ Tests Done (push) Has been cancelled
CI / 🚀 Publish build assets (push) Has been cancelled
CI / 🚀 Publish Docker Images (DockerHub) (push) Has been cancelled
CI / 🚀 Notify external services (push) Has been cancelled
CI / Update Version Durability (push) Has been cancelled
Release / Release (push) Has been cancelled
Code scanning - action / CodeQL-Build (push) Failing after 2s
Auto-close duplicate issues / auto-close-duplicates (push) Failing after 1s
314 lines
13 KiB
TypeScript
314 lines
13 KiB
TypeScript
import type { IRoom } from '@rocket.chat/core-typings';
|
|
import { expect } from 'chai';
|
|
import { after, before, describe, it } from 'mocha';
|
|
import type { Response } from 'supertest';
|
|
|
|
import { getCredentials, api, request, credentials } from '../../data/api-data';
|
|
import { sendSimpleMessage } from '../../data/chat.helper';
|
|
import { updatePermission } from '../../data/permissions.helper';
|
|
import { createRoom, deleteRoom } from '../../data/rooms.helper';
|
|
|
|
describe('[Engagement Dashboard]', function () {
|
|
this.retries(0);
|
|
|
|
const isEnterprise = Boolean(process.env.IS_EE);
|
|
|
|
before((done) => getCredentials(done));
|
|
|
|
before(() => updatePermission('view-engagement-dashboard', ['admin']));
|
|
|
|
after(() => updatePermission('view-engagement-dashboard', ['admin']));
|
|
|
|
(isEnterprise ? describe : describe.skip)('[/engagement-dashboard/channels/list]', () => {
|
|
let testRoom: IRoom;
|
|
let emptyRoom: IRoom;
|
|
|
|
before(async () => {
|
|
testRoom = (await createRoom({ type: 'c', name: `channel.test.engagement.${Date.now()}-${Math.random()}` })).body.channel;
|
|
emptyRoom = (await createRoom({ type: 'c', name: `channel.test.engagement.empty.${Date.now()}-${Math.random()}` })).body.channel;
|
|
});
|
|
|
|
after(async () => {
|
|
await deleteRoom({ type: 'c', roomId: testRoom._id });
|
|
await deleteRoom({ type: 'c', roomId: emptyRoom._id });
|
|
});
|
|
|
|
it('should fail if user does not have the view-engagement-dashboard permission', async () => {
|
|
await updatePermission('view-engagement-dashboard', []);
|
|
await request
|
|
.get(api('engagement-dashboard/channels/list'))
|
|
.set(credentials)
|
|
.query({
|
|
end: new Date().toISOString(),
|
|
start: new Date(Date.now() - 7 * 24 * 60 * 60 * 1000).toISOString(),
|
|
offset: 0,
|
|
count: 25,
|
|
})
|
|
.expect('Content-Type', 'application/json')
|
|
.expect(403)
|
|
.expect((res: Response) => {
|
|
expect(res.body).to.have.property('success', false);
|
|
expect(res.body.error).to.be.equal('User does not have the permissions required for this action [error-unauthorized]');
|
|
});
|
|
});
|
|
|
|
it('should fail if start param is not a valid date', async () => {
|
|
await updatePermission('view-engagement-dashboard', ['admin']);
|
|
await request
|
|
.get(api('engagement-dashboard/channels/list'))
|
|
.set(credentials)
|
|
.query({
|
|
start: 'invalid-date',
|
|
end: new Date().toISOString(),
|
|
offset: 0,
|
|
count: 25,
|
|
})
|
|
.expect('Content-Type', 'application/json')
|
|
.expect(400)
|
|
.expect((res: Response) => {
|
|
expect(res.body).to.have.property('success', false);
|
|
expect(res.body.error).to.be.equal('Match error: Failed Match.Where validation in field start');
|
|
});
|
|
});
|
|
|
|
it('should fail if end param is not a valid date', async () => {
|
|
await request
|
|
.get(api('engagement-dashboard/channels/list'))
|
|
.set(credentials)
|
|
.query({
|
|
start: new Date(Date.now() - 7 * 24 * 60 * 60 * 1000).toISOString(),
|
|
end: 'invalid-date',
|
|
offset: 0,
|
|
count: 25,
|
|
})
|
|
.expect('Content-Type', 'application/json')
|
|
.expect(400)
|
|
.expect((res: Response) => {
|
|
expect(res.body).to.have.property('success', false);
|
|
expect(res.body.error).to.be.equal('Match error: Failed Match.Where validation in field end');
|
|
});
|
|
});
|
|
|
|
it('should fail if start param is not provided', async () => {
|
|
await request
|
|
.get(api('engagement-dashboard/channels/list'))
|
|
.set(credentials)
|
|
.query({
|
|
end: new Date(),
|
|
})
|
|
.expect('Content-Type', 'application/json')
|
|
.expect(400)
|
|
.expect((res: Response) => {
|
|
expect(res.body).to.have.property('success', false);
|
|
expect(res.body.error).to.be.equal("Match error: Missing key 'start'");
|
|
});
|
|
});
|
|
|
|
it('should fail if end param is not provided', async () => {
|
|
await request
|
|
.get(api('engagement-dashboard/channels/list'))
|
|
.set(credentials)
|
|
.query({
|
|
start: new Date(Date.now() - 7 * 24 * 60 * 60 * 1000).toISOString(),
|
|
})
|
|
.expect('Content-Type', 'application/json')
|
|
.expect(400)
|
|
.expect((res: Response) => {
|
|
expect(res.body).to.have.property('success', false);
|
|
expect(res.body.error).to.be.equal("Match error: Missing key 'end'");
|
|
});
|
|
});
|
|
|
|
it('should succesfuly return results', async () => {
|
|
await sendSimpleMessage({ roomId: testRoom._id });
|
|
|
|
await request
|
|
.get(api('engagement-dashboard/channels/list'))
|
|
.set(credentials)
|
|
.query({
|
|
end: new Date().toISOString(),
|
|
start: new Date(Date.now() - 7 * 24 * 60 * 60 * 1000).toISOString(),
|
|
})
|
|
.expect('Content-Type', 'application/json')
|
|
.expect(200)
|
|
.expect((res: Response) => {
|
|
expect(res.body).to.have.property('success', true);
|
|
expect(res.body).to.have.property('offset', 0);
|
|
expect(res.body).to.have.property('count');
|
|
expect(res.body).to.have.property('total');
|
|
expect(res.body).to.have.property('channels');
|
|
expect(res.body.channels).to.be.an('array').that.is.not.empty;
|
|
|
|
expect(res.body.channels[0]).to.be.an('object').that.is.not.empty;
|
|
expect(res.body.channels[0]).to.have.property('messages').that.is.a('number');
|
|
expect(res.body.channels[0]).to.have.property('lastWeekMessages').that.is.a('number');
|
|
expect(res.body.channels[0]).to.have.property('diffFromLastWeek').that.is.a('number');
|
|
expect(res.body.channels[0].room).to.be.an('object').that.is.not.empty;
|
|
|
|
expect(res.body.channels[0].room).to.have.property('_id').that.is.a('string');
|
|
expect(res.body.channels[0].room).to.have.property('name').that.is.a('string');
|
|
expect(res.body.channels[0].room).to.have.property('ts').that.is.a('string');
|
|
expect(res.body.channels[0].room).to.have.property('t').that.is.a('string');
|
|
expect(res.body.channels[0].room).to.have.property('_updatedAt').that.is.a('string');
|
|
});
|
|
});
|
|
|
|
it('should not return empty rooms', async () => {
|
|
await request
|
|
.get(api('engagement-dashboard/channels/list'))
|
|
.set(credentials)
|
|
.query({
|
|
end: new Date().toISOString(),
|
|
start: new Date(Date.now() - 7 * 24 * 60 * 60 * 1000).toISOString(),
|
|
})
|
|
.expect('Content-Type', 'application/json')
|
|
.expect(200)
|
|
.expect((res: Response) => {
|
|
expect(res.body).to.have.property('success', true);
|
|
expect(res.body).to.have.property('offset', 0);
|
|
expect(res.body).to.have.property('count');
|
|
expect(res.body).to.have.property('total');
|
|
expect(res.body).to.have.property('channels');
|
|
const channelRecord = res.body.channels.find(({ room }: { room: { _id: string } }) => room._id === emptyRoom._id);
|
|
expect(channelRecord).to.be.undefined;
|
|
});
|
|
});
|
|
|
|
it('should correctly count messages diff compared to last week when there are messages in a room', async () => {
|
|
await request
|
|
.get(api('engagement-dashboard/channels/list'))
|
|
.set(credentials)
|
|
.query({
|
|
end: new Date().toISOString(),
|
|
start: new Date(Date.now() - 7 * 24 * 60 * 60 * 1000).toISOString(),
|
|
})
|
|
.expect('Content-Type', 'application/json')
|
|
.expect(200)
|
|
.expect((res: Response) => {
|
|
expect(res.body).to.have.property('success', true);
|
|
expect(res.body).to.have.property('offset', 0);
|
|
expect(res.body).to.have.property('count');
|
|
expect(res.body).to.have.property('total');
|
|
expect(res.body).to.have.property('channels');
|
|
expect(res.body.channels).to.be.an('array').that.is.not.empty;
|
|
|
|
const channelRecord = res.body.channels.find(({ room }: { room: { _id: string } }) => room._id === testRoom._id);
|
|
expect(channelRecord).not.to.be.undefined;
|
|
|
|
expect(channelRecord).to.be.an('object').that.is.not.empty;
|
|
expect(channelRecord).to.have.property('messages', 1);
|
|
expect(channelRecord).to.have.property('lastWeekMessages', 0);
|
|
expect(channelRecord).to.have.property('diffFromLastWeek', 1);
|
|
expect(channelRecord.room).to.be.an('object').that.is.not.empty;
|
|
|
|
expect(channelRecord.room).to.have.property('_id', testRoom._id);
|
|
expect(channelRecord.room).to.have.property('name', testRoom.name);
|
|
expect(channelRecord.room).to.have.property('ts', testRoom.ts);
|
|
expect(channelRecord.room).to.have.property('t', testRoom.t);
|
|
});
|
|
});
|
|
|
|
it('should correctly count messages diff compared to last week when there are messages in a room', async () => {
|
|
await request
|
|
.get(api('engagement-dashboard/channels/list'))
|
|
.set(credentials)
|
|
.query({
|
|
end: new Date().toISOString(),
|
|
start: new Date(Date.now() - 7 * 24 * 60 * 60 * 1000).toISOString(),
|
|
})
|
|
.expect('Content-Type', 'application/json')
|
|
.expect(200)
|
|
.expect((res: Response) => {
|
|
expect(res.body).to.have.property('success', true);
|
|
expect(res.body).to.have.property('offset', 0);
|
|
expect(res.body).to.have.property('count');
|
|
expect(res.body).to.have.property('total');
|
|
expect(res.body).to.have.property('channels');
|
|
expect(res.body.channels).to.be.an('array').that.is.not.empty;
|
|
|
|
const channelRecord = res.body.channels.find(({ room }: { room: { _id: string } }) => room._id === testRoom._id);
|
|
expect(channelRecord).not.to.be.undefined;
|
|
|
|
expect(channelRecord).to.be.an('object').that.is.not.empty;
|
|
expect(channelRecord).to.have.property('messages', 1);
|
|
expect(channelRecord).to.have.property('lastWeekMessages', 0);
|
|
expect(channelRecord).to.have.property('diffFromLastWeek', 1);
|
|
expect(channelRecord.room).to.be.an('object').that.is.not.empty;
|
|
|
|
expect(channelRecord.room).to.have.property('_id', testRoom._id);
|
|
expect(channelRecord.room).to.have.property('name', testRoom.name);
|
|
expect(channelRecord.room).to.have.property('ts', testRoom.ts);
|
|
expect(channelRecord.room).to.have.property('t', testRoom.t);
|
|
});
|
|
});
|
|
|
|
it('should correctly count messages from last week and diff when moving to the next week', async () => {
|
|
await request
|
|
.get(api('engagement-dashboard/channels/list'))
|
|
.set(credentials)
|
|
.query({
|
|
end: new Date(Date.now() + 8 * 24 * 60 * 60 * 1000).toISOString(),
|
|
start: new Date(Date.now() + 24 * 60 * 60 * 1000).toISOString(),
|
|
})
|
|
.expect('Content-Type', 'application/json')
|
|
.expect(200)
|
|
.expect((res: Response) => {
|
|
expect(res.body).to.have.property('success', true);
|
|
expect(res.body).to.have.property('offset', 0);
|
|
expect(res.body).to.have.property('count');
|
|
expect(res.body).to.have.property('total');
|
|
expect(res.body).to.have.property('channels');
|
|
expect(res.body.channels).to.be.an('array').that.is.not.empty;
|
|
|
|
const channelRecord = res.body.channels.find(({ room }: { room: { _id: string } }) => room._id === testRoom._id);
|
|
expect(channelRecord).not.to.be.undefined;
|
|
|
|
expect(channelRecord).to.be.an('object').that.is.not.empty;
|
|
expect(channelRecord).to.have.property('messages', 0);
|
|
expect(channelRecord).to.have.property('lastWeekMessages', 1);
|
|
expect(channelRecord).to.have.property('diffFromLastWeek', -1);
|
|
expect(channelRecord.room).to.be.an('object').that.is.not.empty;
|
|
|
|
expect(channelRecord.room).to.have.property('_id', testRoom._id);
|
|
expect(channelRecord.room).to.have.property('name', testRoom.name);
|
|
expect(channelRecord.room).to.have.property('ts', testRoom.ts);
|
|
expect(channelRecord.room).to.have.property('t', testRoom.t);
|
|
});
|
|
});
|
|
|
|
it('should correctly count messages from last week and diff when moving to the next week', async () => {
|
|
await request
|
|
.get(api('engagement-dashboard/channels/list'))
|
|
.set(credentials)
|
|
.query({
|
|
end: new Date(Date.now() + 8 * 24 * 60 * 60 * 1000).toISOString(),
|
|
start: new Date(Date.now() + 24 * 60 * 60 * 1000).toISOString(),
|
|
})
|
|
.expect('Content-Type', 'application/json')
|
|
.expect(200)
|
|
.expect((res: Response) => {
|
|
expect(res.body).to.have.property('success', true);
|
|
expect(res.body).to.have.property('offset', 0);
|
|
expect(res.body).to.have.property('count');
|
|
expect(res.body).to.have.property('total');
|
|
expect(res.body).to.have.property('channels');
|
|
expect(res.body.channels).to.be.an('array').that.is.not.empty;
|
|
|
|
const channelRecord = res.body.channels.find(({ room }: { room: { _id: string } }) => room._id === testRoom._id);
|
|
expect(channelRecord).not.to.be.undefined;
|
|
|
|
expect(channelRecord).to.be.an('object').that.is.not.empty;
|
|
expect(channelRecord).to.have.property('messages', 0);
|
|
expect(channelRecord).to.have.property('lastWeekMessages', 1);
|
|
expect(channelRecord).to.have.property('diffFromLastWeek', -1);
|
|
expect(channelRecord.room).to.be.an('object').that.is.not.empty;
|
|
|
|
expect(channelRecord.room).to.have.property('_id', testRoom._id);
|
|
expect(channelRecord.room).to.have.property('name', testRoom.name);
|
|
expect(channelRecord.room).to.have.property('ts', testRoom.ts);
|
|
expect(channelRecord.room).to.have.property('t', testRoom.t);
|
|
});
|
|
});
|
|
});
|
|
});
|