upstream-rocketchat/apps/meteor/server/lib/statistics/functions/sendUsageReport.spec.ts

import { expect } from 'chai';
import { describe, it, beforeEach, afterEach } from 'mocha';
import proxyquire from 'proxyquire';
import sinon from 'sinon';

const sandbox = sinon.createSandbox();

const mocks = {
	Statistics: {
		findLast: sandbox.stub(),
		updateOne: sandbox.stub(),
	},
	statistics: {
		save: sandbox.stub(),
	},
	serverFetch: sandbox.stub(),
	getWorkspaceAccessToken: sandbox.stub().resolves('workspace-token'),
	Meteor: {
		absoluteUrl: sandbox.stub().returns('http://localhost:3000/'),
	},
	logger: {
		error: sandbox.stub(),
	},
	Info: {
		version: '3.0.1',
	},
};

const { sendUsageReport } = proxyquire.noCallThru().load('./sendUsageReport', {
	'@rocket.chat/models': { Statistics: mocks.Statistics },
	'@rocket.chat/server-fetch': { serverFetch: mocks.serverFetch },
	'../index': { statistics: mocks.statistics },
	'../../cloud': { getWorkspaceAccessToken: mocks.getWorkspaceAccessToken },
	'meteor/meteor': { Meteor: mocks.Meteor },
	'../../../../app/utils/rocketchat.info': { Info: mocks.Info },
});

describe('sendUsageReport', () => {
	beforeEach(() => {
		sandbox.resetHistory();
	});

	afterEach(() => {
		delete process.env.RC_DISABLE_STATISTICS_REPORTING;
	});

	it('should save statistics locally and not send to collector when RC_DISABLE_STATISTICS_REPORTING is true', async () => {
		process.env.RC_DISABLE_STATISTICS_REPORTING = 'true';

		const result = await sendUsageReport(mocks.logger);

		expect(mocks.statistics.save.called).to.be.true;
		expect(mocks.serverFetch.called).to.be.false;
		expect(result).to.be.undefined;
	});

	it('should save statistics locally and send to collector when RC_DISABLE_STATISTICS_REPORTING is false', async () => {
		process.env.RC_DISABLE_STATISTICS_REPORTING = 'false';

		const result = await sendUsageReport(mocks.logger);

		expect(mocks.statistics.save.called).to.be.true;
		expect(mocks.serverFetch.calledOnce).to.be.true;
		expect(mocks.serverFetch.calledWith('https://collector.rocket.chat/', sinon.match({ method: 'POST' }))).to.be.true;
		expect(result).to.be.undefined;
	});

	it('should generate new statistics when version changes', async () => {
		mocks.Statistics.findLast.resolves({
			_id: 'stats-id',
			version: '2.9.0',
			createdAt: new Date(),
		});

		mocks.statistics.save.resolves({ _id: 'new-stats-id' });

		const result = await sendUsageReport(mocks.logger);

		expect(mocks.statistics.save.calledOnce).to.be.true;
		expect(result).to.be.undefined;
	});

	it('should NOT generate new statistics if last version equals current version', async () => {
		mocks.Statistics.findLast.resolves({
			_id: 'stats-id',
			version: '3.0.1',
			createdAt: new Date(),
			statsToken: 'token',
		});

		const result = await sendUsageReport(mocks.logger);

		expect(mocks.statistics.save.called).to.be.false;
		expect(result).to.equal('token');
	});

	it('should generate new statistics when no previous stats exist', async () => {
		mocks.Statistics.findLast.resolves(undefined);
		mocks.statistics.save.resolves({ _id: 'new-stats-id' });

		await sendUsageReport(mocks.logger);

		expect(mocks.statistics.save.calledOnce).to.be.true;
	});
});