feat: workspace info admin page

.changeset/workspace-status-admin-page.md

@@ -0,0 +1,5 @@
+---
+"@rocket.chat/meteor": minor
+---
+
+Added a new Admin page called `Workspace info` in place of Information page, to make it easier to check the license 

apps/meteor/app/api/server/lib/getServerInfo.ts

@@ -1,20 +1,15 @@
+import type { IWorkspaceInfo } from '@rocket.chat/core-typings';
+
 import { hasPermissionAsync } from '../../../authorization/server/functions/hasPermission';
 import {
 	getCachedSupportedVersionsToken,
 	wrapPromise,
 } from '../../../cloud/server/functions/supportedVersionsToken/supportedVersionsToken';
 import { Info, minimumClientVersions } from '../../../utils/rocketchat.info';
 
-type ServerInfo = {
-	info?: typeof Info;
-	supportedVersions?: { signed: string };
-	minimumClientVersions: typeof minimumClientVersions;
-	version: string;
-};
-
 const removePatchInfo = (version: string): string => version.replace(/(\d+\.\d+).*/, '$1');
 
-export async function getServerInfo(userId?: string): Promise<ServerInfo> {
+export async function getServerInfo(userId?: string): Promise<IWorkspaceInfo> {
 	const hasPermissionToViewStatistics = userId && (await hasPermissionAsync(userId, 'view-statistics'));
 	const supportedVersionsToken = await wrapPromise(getCachedSupportedVersionsToken());
 

apps/meteor/app/statistics/server/lib/statistics.ts

@@ -305,18 +305,30 @@ export const statistics = {
 		);
 
 		// Message statistics
-		statistics.totalChannelMessages = (await Rooms.findByType('c', { projection: { msgs: 1 } }).toArray()).reduce(
-			function _countChannelMessages(num: number, room: IRoom) {
+		const channels = await Rooms.findByType('c', { projection: { msgs: 1, prid: 1 } }).toArray();
+		const totalChannelDiscussionsMessages = await channels.reduce(function _countChannelDiscussionsMessages(num: number, room: IRoom) {
+			return num + (room.prid ? room.msgs : 0);
+		}, 0);
+		statistics.totalChannelMessages =
+			(await channels.reduce(function _countChannelMessages(num: number, room: IRoom) {
 				return num + room.msgs;
-			},
-			0,
-		);
-		statistics.totalPrivateGroupMessages = (await Rooms.findByType('p', { projection: { msgs: 1 } }).toArray()).reduce(
-			function _countPrivateGroupMessages(num: number, room: IRoom) {
+			}, 0)) - totalChannelDiscussionsMessages;
+
+		const privateGroups = await Rooms.findByType('p', { projection: { msgs: 1, prid: 1 } }).toArray();
+		const totalPrivateGroupsDiscussionsMessages = await privateGroups.reduce(function _countPrivateGroupsDiscussionsMessages(
+			num: number,
+			room: IRoom,
+		) {
+			return num + (room.prid ? room.msgs : 0);
+		},
+		0);
+		statistics.totalPrivateGroupMessages =
+			(await privateGroups.reduce(function _countPrivateGroupMessages(num: number, room: IRoom) {
 				return num + room.msgs;
-			},
-			0,
-		);
+			}, 0)) - totalPrivateGroupsDiscussionsMessages;
+
+		statistics.totalDiscussionsMessages = totalPrivateGroupsDiscussionsMessages + totalChannelDiscussionsMessages;
+
 		statistics.totalDirectMessages = (await Rooms.findByType('d', { projection: { msgs: 1 } }).toArray()).reduce(
 			function _countDirectMessages(num: number, room: IRoom) {
 				return num + room.msgs;
@@ -332,6 +344,7 @@ export const statistics = {
 		statistics.totalMessages =
 			statistics.totalChannelMessages +
 			statistics.totalPrivateGroupMessages +
+			statistics.totalDiscussionsMessages +
 			statistics.totalDirectMessages +
 			statistics.totalLivechatMessages;
 

apps/meteor/client/hooks/useLicense.ts

@@ -3,8 +3,8 @@ import { useEndpoint, usePermission } from '@rocket.chat/ui-contexts';
 import type { UseQueryResult } from '@tanstack/react-query';
 import { useQuery } from '@tanstack/react-query';
 
-export const useLicense = (): UseQueryResult<OperationResult<'GET', '/v1/licenses.get'>> => {
-	const getLicenses = useEndpoint('GET', '/v1/licenses.get');
+export const useLicense = (): UseQueryResult<OperationResult<'GET', '/v1/licenses.info'>> => {
+	const getLicenses = useEndpoint('GET', '/v1/licenses.info');
 	const canViewLicense = usePermission('view-privileged-setting');
 
 	return useQuery(
@@ -13,7 +13,7 @@ export const useLicense = (): UseQueryResult<OperationResult<'GET', '/v1/license
 			if (!canViewLicense) {
 				throw new Error('unauthorized api call');
 			}
-			return getLicenses();
+			return getLicenses({ loadValues: true });
 		},
 		{
 			staleTime: Infinity,

apps/meteor/client/hooks/useWorkspaceInfo.ts

@@ -0,0 +1,29 @@
+import type { IWorkspaceInfo, IStats } from '@rocket.chat/core-typings';
+import type { IInstance } from '@rocket.chat/rest-typings';
+import { useEndpoint } from '@rocket.chat/ui-contexts';
+import { useQueries } from '@tanstack/react-query';
+
+export const useWorkspaceInfo = () => {
+	const getStatistics = useEndpoint('GET', '/v1/statistics');
+	const getInstances = useEndpoint('GET', '/v1/instances.get');
+	const getServerInfo = useEndpoint('GET', '/info');
+
+	const results = useQueries({
+		queries: [
+			{ queryKey: ['info', 'serverInfo'], queryFn: () => getServerInfo(), staleTime: Infinity, keepPreviousData: true },
+			{ queryKey: ['info', 'instances'], queryFn: () => getInstances(), staleTime: Infinity, keepPreviousData: true },
+			{ queryKey: ['info', 'statistics'], queryFn: () => getStatistics({ refresh: 'true' }), staleTime: Infinity, keepPreviousData: true },
+		],
+	});
+
+	const [serverInfoQuery, instancesQuery, statisticsQuery] = results;
+
+	const instances: IInstance[] | undefined = instancesQuery?.data?.instances as IInstance[];
+	const statistics: IStats | undefined = statisticsQuery?.data as IStats;
+	const serverInfo: IWorkspaceInfo | undefined = serverInfoQuery?.data as IWorkspaceInfo;
+
+	const isLoading = results.some((query) => query.isLoading);
+	const isError = results.some((query) => query.isError);
+
+	return { instances, statistics, serverInfo, isLoading, isError, refetchStatistics: statisticsQuery.refetch };
+};

apps/meteor/client/lib/utils/isOverLicenseLimits.ts

@@ -0,0 +1,22 @@
+import type { LicenseLimitKind } from '@rocket.chat/license';
+
+type Limits = Record<
+	LicenseLimitKind,
+	{
+		max: number;
+		value?: number;
+	}
+>;
+
+export const isOverLicenseLimits = (limits: Limits): boolean => {
+	for (const key in limits) {
+		if (Object.hasOwn(limits, key)) {
+			const limit = limits[key as keyof Limits];
+			if (limit.value !== undefined && limit.value > limit.max) {
+				return true;
+			}
+		}
+	}
+
+	return false;
+};

apps/meteor/client/sidebar/header/actions/hooks/useAdministrationItems.spec.tsx

@@ -3,17 +3,75 @@ import { renderHook } from '@testing-library/react-hooks';
 
 import { useAdministrationItems } from './useAdministrationItems';
 
+const LICENSE_INFO_PAYLOAD = {
+	data: {
+		license: {
+			version: '3.0',
+			information: {
+				autoRenew: false,
+				visualExpiration: '0001-01-01T00:00:00.000Z',
+				trial: false,
+				offline: false,
+				createdAt: '2023-10-09T17:25:54.828Z',
+				grantedBy: {
+					method: 'manual',
+					seller: 'V2',
+				},
+				tags: [
+					{
+						name: 'Pro',
+						color: '#F3BE08',
+					},
+				],
+			},
+			validation: {
+				serverUrls: [
+					{
+						value: 'localhost:3000',
+						type: 'regex',
+					},
+				],
+				validPeriods: [
+					{
+						validUntil: '2023-11-17T00:00:00.000Z',
+						invalidBehavior: 'invalidate_license',
+					},
+				],
+				statisticsReport: {
+					required: true,
+				},
+			},
+			grantedModules: [],
+			limits: {
+				activeUsers: [
+					{
+						max: 25,
+						behavior: 'prevent_action',
+					},
+				],
+			},
+			cloudMeta: {
+				trial: false,
+				trialEnd: '0001-01-01T00:00:00Z',
+				workspaceId: '651c4519f712c20001151d0a',
+			},
+		},
+		activeModules: [],
+		limits: {
+			activeUsers: {
+				value: 10,
+				max: 25,
+			},
+		},
+	},
+	success: true,
+};
+
 it('should not show upgrade item if has license and not have trial', async () => {
+	const license = { ...LICENSE_INFO_PAYLOAD, data: { ...LICENSE_INFO_PAYLOAD.data, activeModules: ['testModules'] } };
 	const { result, waitFor } = renderHook(() => useAdministrationItems(), {
 		wrapper: mockAppRoot()
-			.withEndpoint('GET', '/v1/licenses.get', () => ({
-				licenses: [
-					{
-						modules: ['testModule'],
-						meta: { trial: false },
-					} as any,
-				],
-			}))
+			.withEndpoint('GET', '/v1/licenses.info', () => license as any)
 			.withEndpoint('GET', '/v1/cloud.registrationStatus', () => ({
 				registrationStatus: {
 					workspaceRegistered: false,
@@ -32,13 +90,7 @@ it('should not show upgrade item if has license and not have trial', async () =>
 it('should return an upgrade item if not have license or if have a trial', async () => {
 	const { result, waitFor } = renderHook(() => useAdministrationItems(), {
 		wrapper: mockAppRoot()
-			.withEndpoint('GET', '/v1/licenses.get', () => ({
-				licenses: [
-					{
-						modules: [],
-					} as any,
-				],
-			}))
+			.withEndpoint('GET', '/v1/licenses.info', () => LICENSE_INFO_PAYLOAD as any)
 			.withEndpoint('GET', '/v1/cloud.registrationStatus', () => ({
 				registrationStatus: {
 					workspaceRegistered: false,
@@ -62,13 +114,7 @@ it('should return an upgrade item if not have license or if have a trial', async
 it('should return omnichannel item if has `view-livechat-manager` permission ', async () => {
 	const { result, waitFor } = renderHook(() => useAdministrationItems(), {
 		wrapper: mockAppRoot()
-			.withEndpoint('GET', '/v1/licenses.get', () => ({
-				licenses: [
-					{
-						modules: [],
-					} as any,
-				],
-			}))
+			.withEndpoint('GET', '/v1/licenses.info', () => LICENSE_INFO_PAYLOAD as any)
 			.withEndpoint('GET', '/v1/cloud.registrationStatus', () => ({
 				registrationStatus: {
 					workspaceRegistered: false,
@@ -90,13 +136,7 @@ it('should return omnichannel item if has `view-livechat-manager` permission ',
 it('should show administration item if has at least one admin permission', async () => {
 	const { result, waitFor } = renderHook(() => useAdministrationItems(), {
 		wrapper: mockAppRoot()
-			.withEndpoint('GET', '/v1/licenses.get', () => ({
-				licenses: [
-					{
-						modules: [],
-					} as any,
-				],
-			}))
+			.withEndpoint('GET', '/v1/licenses.info', () => LICENSE_INFO_PAYLOAD as any)
 			.withEndpoint('GET', '/v1/cloud.registrationStatus', () => ({
 				registrationStatus: {
 					workspaceRegistered: false,

apps/meteor/client/sidebar/header/actions/hooks/useAdministrationItems.tsx

@@ -65,8 +65,8 @@ export const useAdministrationItems = (): GenericMenuItemProps[] => {
 	const isAdmin = useRole('admin');
 	const setModal = useSetModal();
 
-	const { data: registrationStatusData } = useRegistrationStatus();
-	const workspaceRegistered = registrationStatusData?.registrationStatus?.workspaceRegistered ?? false;
+	const { data } = useRegistrationStatus();
+	const workspaceRegistered = data?.registrationStatus?.workspaceRegistered ?? false;
 
 	const handleRegisterWorkspaceClick = (): void => {
 		const handleModalClose = (): void => setModal(null);