feat: improve apps logs

.changeset/rich-peas-worry.md

@@ -0,0 +1,7 @@
+---
+'@rocket.chat/rest-typings': minor
+'@rocket.chat/apps-engine': minor
+'@rocket.chat/meteor': minor
+---
+
+Improve the `/api/apps/:id/logs` endpoint to accept filters

.changeset/short-mayflies-sing.md

@@ -0,0 +1,7 @@
+---
+'@rocket.chat/rest-typings': minor
+'@rocket.chat/apps-engine': minor
+'@rocket.chat/meteor': minor
+---
+
+Add a new endpoint `/api/apps/logs` that allows for fetching logs without a filter for app id

apps/meteor/client/views/marketplace/hooks/useLogs.ts

@@ -8,6 +8,6 @@ export const useLogs = (appId: string): UseQueryResult<OperationResult<'GET', '/
 
 	return useQuery({
 		queryKey: ['marketplace', 'apps', appId, 'logs'],
-		queryFn: () => logs(),
+		queryFn: () => logs({}),
 	});
 };

apps/meteor/ee/server/apps/communication/endpoints/actionButtonsHandler.ts

@@ -1,20 +1,15 @@
-import type { AppManager } from '@rocket.chat/apps-engine/server/AppManager';
-
 import { API } from '../../../../../app/api/server';
 import type { AppsRestApi } from '../rest';
 
-export const actionButtonsHandler = (apiManager: AppsRestApi) =>
-	[
-		{
-			authRequired: false,
-		},
+export const registerActionButtonsHandler = ({ api, _manager }: AppsRestApi) =>
+	void api.addRoute(
+		'actionButtons',
+		{ authRequired: false },
 		{
-			get(): any {
-				const manager = apiManager._manager as AppManager;
-
-				const buttons = manager.getUIActionButtonManager().getAllActionButtons();
+			get() {
+				const buttons = _manager.getUIActionButtonManager().getAllActionButtons();
 
 				return API.v1.success(buttons);
 			},
 		},
-	] as const;
+	);

apps/meteor/ee/server/apps/communication/endpoints/appGeneralLogsHandler.ts

@@ -0,0 +1,35 @@
+import { isAppLogsProps } from '@rocket.chat/rest-typings';
+
+import { getPaginationItems } from '../../../../../app/api/server/helpers/getPaginationItems';
+import type { AppsRestApi } from '../rest';
+import { makeAppLogsQuery } from './lib/makeAppLogsQuery';
+
+export const registerAppGeneralLogsHandler = ({ api, _orch }: AppsRestApi) =>
+	void api.addRoute(
+		'logs',
+		{ authRequired: true, permissionRequired: ['manage-apps'], validateParams: isAppLogsProps },
+		{
+			async get() {
+				const { offset, count } = await getPaginationItems(this.queryParams);
+				const { sort } = await this.parseJsonQuery();
+
+				const options = {
+					sort: sort || { _updatedAt: -1 },
+					skip: offset,
+					limit: count,
+				};
+
+				let query: Record<string, any>;
+
+				try {
+					query = makeAppLogsQuery(this.queryParams);
+				} catch (error) {
+					return api.failure({ error: error instanceof Error ? error.message : 'Unknown error' });
+				}
+
+				const result = await _orch.getLogStorage().find(query, options);
+
+				return api.success({ offset, logs: result.logs, count: result.logs.length, total: result.total });
+			},
+		},
+	);

apps/meteor/ee/server/apps/communication/endpoints/appLogsHandler.ts

@@ -0,0 +1,45 @@
+import { isAppLogsProps } from '@rocket.chat/rest-typings';
+
+import { getPaginationItems } from '../../../../../app/api/server/helpers/getPaginationItems';
+import type { AppsRestApi } from '../rest';
+import { makeAppLogsQuery } from './lib/makeAppLogsQuery';
+
+export const registerAppLogsHandler = ({ api, _manager, _orch }: AppsRestApi) =>
+	void api.addRoute(
+		':id/logs',
+		{ authRequired: true, permissionRequired: ['manage-apps'], validateParams: isAppLogsProps },
+		{
+			async get() {
+				const proxiedApp = _manager.getOneById(this.urlParams.id);
+
+				if (!proxiedApp) {
+					return api.notFound(`No App found by the id of: ${this.urlParams.id}`);
+				}
+
+				if (this.queryParams.appId && this.queryParams.appId !== this.urlParams.id) {
+					return api.notFound(`Invalid query parameter "appId": ${this.queryParams.appId}`);
+				}
+
+				const { offset, count } = await getPaginationItems(this.queryParams);
+				const { sort } = await this.parseJsonQuery();
+
+				const options = {
+					sort: sort || { _updatedAt: -1 },
+					skip: offset,
+					limit: count,
+				};
+
+				let query: Record<string, any>;
+
+				try {
+					query = makeAppLogsQuery(this.queryParams);
+				} catch (error) {
+					return api.failure({ error: error instanceof Error ? error.message : 'Unknown error' });
+				}
+
+				const result = await _orch.getLogStorage().find(query, options);
+
+				return api.success({ offset, logs: result.logs, count: result.logs.length, total: result.total });
+			},
+		},
+	);

apps/meteor/ee/server/apps/communication/endpoints/appsCountHandler.ts

@@ -2,25 +2,16 @@ import type { AppManager } from '@rocket.chat/apps-engine/server/AppManager';
 import { License } from '@rocket.chat/license';
 
 import { API } from '../../../../../app/api/server';
-import type { SuccessResult } from '../../../../../app/api/server/definition';
 import { getInstallationSourceFromAppStorageItem } from '../../../../../lib/apps/getInstallationSourceFromAppStorageItem';
 import type { AppsRestApi } from '../rest';
 
-type AppsCountResult = {
-	totalMarketplaceEnabled: number;
-	totalPrivateEnabled: number;
-	maxMarketplaceApps: number;
-	maxPrivateApps: number;
-};
-
-export const appsCountHandler = (apiManager: AppsRestApi) =>
-	[
-		{
-			authRequired: false,
-		},
+export const registerAppsCountHandler = ({ api, _manager }: AppsRestApi) =>
+	void api.addRoute(
+		'count',
+		{ authRequired: false },
 		{
-			async get(): Promise<SuccessResult<AppsCountResult>> {
-				const manager = apiManager._manager as AppManager;
+			async get() {
+				const manager = _manager as AppManager;
 
 				const apps = await manager.get({ enabled: true });
 				const { maxMarketplaceApps, maxPrivateApps } = License.getAppsConfig();
@@ -34,4 +25,4 @@ export const appsCountHandler = (apiManager: AppsRestApi) =>
 				});
 			},
 		},
-	] as const;
+	);

apps/meteor/ee/server/apps/communication/endpoints/lib/makeAppLogsQuery.ts

@@ -0,0 +1,60 @@
+import type { AppLogsProps } from '@rocket.chat/rest-typings';
+
+/**
+ * Creates a query object for fetching app logs based on provided parameters.
+ *
+ * NOTE: This function expects that all values are in the correct format, as it is
+ * used by an endpoint handler which has query parameter validation.
+ *
+ * @param queryParams - The query parameters.
+ * @returns A query object for fetching app logs.
+ * @throws {Error} If the date range is invalid.
+ */
+export function makeAppLogsQuery(queryParams: AppLogsProps) {
+	const query: Record<string, any> = {};
+
+	if (queryParams.appId) {
+		query.appId = queryParams.appId;
+	}
+
+	if (queryParams.logLevel) {
+		const queryLogLevel = Number(queryParams.logLevel);
+		const logLevel = ['error'];
+
+		if (queryLogLevel >= 1) {
+			logLevel.push('warn', 'info', 'log');
+		}
+
+		if (queryLogLevel >= 2) {
+			logLevel.push('debug', 'success');
+		}
+
+		query['entries.severity'] = { $in: logLevel };
+	}
+
+	if (queryParams.method) {
+		query.method = queryParams.method;
+	}
+
+	if (queryParams.startDate) {
+		query._updatedAt = {
+			$gte: new Date(queryParams.startDate),
+		};
+	}
+
+	if (queryParams.endDate) {
+		const endDate = new Date(queryParams.endDate);
+		endDate.setDate(endDate.getDate() + 1);
+
+		if (query._updatedAt?.$gte && query._updatedAt.$gte >= endDate) {
+			throw new Error('Invalid date range');
+		}
+
+		query._updatedAt = {
+			...(query._updatedAt || {}),
+			$lte: endDate,
+		};
+	}
+
+	return query;
+}

apps/meteor/ee/server/apps/communication/rest.ts

@@ -10,11 +10,12 @@ import { serverFetch as fetch } from '@rocket.chat/server-fetch';
 import { Meteor } from 'meteor/meteor';
 import { ZodError } from 'zod';
 
-import { actionButtonsHandler } from './endpoints/actionButtonsHandler';
-import { appsCountHandler } from './endpoints/appsCountHandler';
+import { registerActionButtonsHandler } from './endpoints/actionButtonsHandler';
+import { registerAppGeneralLogsHandler } from './endpoints/appGeneralLogsHandler';
+import { registerAppLogsHandler } from './endpoints/appLogsHandler';
+import { registerAppsCountHandler } from './endpoints/appsCountHandler';
 import type { APIClass } from '../../../../app/api/server';
 import { API } from '../../../../app/api/server';
-import { getPaginationItems } from '../../../../app/api/server/helpers/getPaginationItems';
 import { getUploadFormData } from '../../../../app/api/server/lib/getUploadFormData';
 import { getWorkspaceAccessToken, getWorkspaceAccessTokenWithScope } from '../../../../app/cloud/server';
 import { apiDeprecationLogger } from '../../../../app/lib/server/lib/deprecationWarningLogger';
@@ -93,8 +94,11 @@ export class AppsRestApi {
 			return API.v1.failure();
 		};
 
-		this.api.addRoute('actionButtons', ...actionButtonsHandler(this));
-		this.api.addRoute('count', ...appsCountHandler(this));
+		registerActionButtonsHandler(this);
+		registerAppsCountHandler(this);
+
+		registerAppLogsHandler(this);
+		registerAppGeneralLogsHandler(this);
 
 		this.api.addRoute(
 			'incompatibleModal',
@@ -1138,34 +1142,6 @@ export class AppsRestApi {
 			},
 		);
 
-		this.api.addRoute(
-			':id/logs',
-			{ authRequired: true, permissionsRequired: ['manage-apps'] },
-			{
-				async get() {
-					const prl = manager.getOneById(this.urlParams.id);
-
-					if (prl) {
-						const { offset, count } = await getPaginationItems(this.queryParams);
-						const { sort, fields, query } = await this.parseJsonQuery();
-
-						const ourQuery = Object.assign({}, query, { appId: prl.getID() });
-						const options = {
-							sort: sort || { _updatedAt: -1 },
-							skip: offset,
-							limit: count,
-							fields,
-						};
-
-						const logs = await orchestrator?.getLogStorage()?.find(ourQuery, options);
-
-						return API.v1.success({ logs });
-					}
-					return API.v1.notFound(`No App found by the id of: ${this.urlParams.id}`);
-				},
-			},
-		);
-
 		this.api.addRoute(
 			':id/settings',
 			{ authRequired: true, permissionsRequired: ['manage-apps'] },

apps/meteor/ee/server/apps/orchestrator.js

@@ -109,6 +109,10 @@ export class AppServerOrchestrator {
 	}
 
 	getLogStorage() {
+		if (!this._logStorage) {
+			throw new Error('Apps-Engine not yet fully initialized');
+		}
+
 		return this._logStorage;
 	}
 

apps/meteor/ee/server/apps/storage/AppRealLogStorage.ts

@@ -13,9 +13,16 @@ export class AppRealLogStorage extends AppLogStorage {
 		query: {
 			[field: string]: any;
 		},
-		{ fields, ...options }: IAppLogStorageFindOptions,
-	): Promise<ILoggerStorageEntry[]> {
-		return this.db.findPaginated(query, { projection: fields, ...options }).cursor.toArray();
+		options: IAppLogStorageFindOptions,
+	) {
+		const { cursor, totalCount } = this.db.findPaginated<ILoggerStorageEntry>(query, options);
+
+		const [logs, total] = await Promise.all([cursor.toArray(), totalCount]);
+
+		return {
+			logs,
+			total,
+		};
 	}
 
 	async storeEntries(logEntry: ILoggerStorageEntry): Promise<ILoggerStorageEntry> {