Merge pull request #8449 from ever-co/feat/automation-task-sync-activ…

…ity-log [Fix] Activity Log Event use generic method
ever-co · Oct 17, 2024 · af1c24c · af1c24c
2 parents ae6066d + ec297ab
commit af1c24c
Show file tree

Hide file tree

Showing 12 changed files with 317 additions and 325 deletions.
diff --git a/packages/core/src/activity-log/activity-log.helper.ts b/packages/core/src/activity-log/activity-log.helper.ts
@@ -36,18 +36,25 @@ export function generateActivityLogDescription(
 	});
 }
 
-export function activityLogUpdatedFieldsAndValues<T>(original: T, updated: Partial<T>) {
+/**
+ * @description Log updated field names, old and new values for Activity Log Updated Actions
+ * @template T
+ * @param {T} originalValues - Old values before update
+ * @param {Partial<T>} updated - Updated values
+ * @returns An object with updated fields, their old and new values
+ */
+export function activityLogUpdatedFieldsAndValues<T>(originalValues: T, updated: Partial<T>) {
 	const updatedFields: string[] = [];
 	const previousValues: IActivityLogUpdatedValues[] = [];
 	const updatedValues: IActivityLogUpdatedValues[] = [];
 
 	for (const key of Object.keys(updated)) {
-		if (original[key] !== updated[key]) {
+		if (originalValues[key] !== updated[key]) {
 			// Add updated field
 			updatedFields.push(key);
 
 			// Add old and new values
-			previousValues.push({ [key]: original[key] });
+			previousValues.push({ [key]: originalValues[key] });
 			updatedValues.push({ [key]: updated[key] });
 		}
 	}

diff --git a/packages/core/src/activity-log/activity-log.module.ts b/packages/core/src/activity-log/activity-log.module.ts
@@ -1,5 +1,5 @@
 import { CqrsModule } from '@nestjs/cqrs';
-import { Module } from '@nestjs/common';
+import { Global, Module } from '@nestjs/common';
 import { MikroOrmModule } from '@mikro-orm/nestjs';
 import { TypeOrmModule } from '@nestjs/typeorm';
 import { RolePermissionModule } from '../role-permission/role-permission.module';
@@ -9,6 +9,7 @@ import { ActivityLogService } from './activity-log.service';
 import { EventHandlers } from './events/handlers';
 import { TypeOrmActivityLogRepository } from './repository/type-orm-activity-log.repository';
 
+@Global()
 @Module({
 	imports: [
 		TypeOrmModule.forFeature([ActivityLog]),

diff --git a/packages/core/src/activity-log/activity-log.service.ts b/packages/core/src/activity-log/activity-log.service.ts
@@ -1,9 +1,20 @@
 import { BadRequestException, Injectable } from '@nestjs/common';
+import { EventBus } from '@nestjs/cqrs';
 import { FindManyOptions, FindOptionsOrder, FindOptionsWhere } from 'typeorm';
-import { IActivityLog, IActivityLogInput, IPagination } from '@gauzy/contracts';
+import {
+	ActionTypeEnum,
+	ActorTypeEnum,
+	BaseEntityEnum,
+	IActivityLog,
+	IActivityLogInput,
+	ID,
+	IPagination
+} from '@gauzy/contracts';
 import { isNotNullOrUndefined } from '@gauzy/common';
 import { TenantAwareCrudService } from './../core/crud';
 import { RequestContext } from '../core/context';
+import { activityLogUpdatedFieldsAndValues, generateActivityLogDescription } from './activity-log.helper';
+import { ActivityLogEvent } from './events/activity-log.event';
 import { GetActivityLogsDTO, allowedOrderDirections, allowedOrderFields } from './dto/get-activity-logs.dto';
 import { ActivityLog } from './activity-log.entity';
 import { MikroOrmActivityLogRepository, TypeOrmActivityLogRepository } from './repository';
@@ -12,11 +23,35 @@ import { MikroOrmActivityLogRepository, TypeOrmActivityLogRepository } from './r
 export class ActivityLogService extends TenantAwareCrudService<ActivityLog> {
 	constructor(
 		readonly typeOrmActivityLogRepository: TypeOrmActivityLogRepository,
-		readonly mikroOrmActivityLogRepository: MikroOrmActivityLogRepository
+		readonly mikroOrmActivityLogRepository: MikroOrmActivityLogRepository,
+		private readonly _eventBus: EventBus
 	) {
 		super(typeOrmActivityLogRepository, mikroOrmActivityLogRepository);
 	}
 
+	/**
+	 * Creates a new activity log entry with the provided input, while associating it with the current user and tenant.
+	 *
+	 * @param input - The data required to create an activity log entry.
+	 * @returns The created activity log entry.
+	 * @throws BadRequestException when the log creation fails.
+	 */
+	async create(input: IActivityLogInput): Promise<IActivityLog> {
+		try {
+			// Retrieve the current user's ID from the request context
+			const creatorId = RequestContext.currentUserId();
+
+			// Retrieve the current tenant ID from the request context or use the provided tenantId
+			const tenantId = RequestContext.currentTenantId() || input.tenantId;
+
+			// Create the activity log entry using the provided input along with the tenantId and creatorId
+			return await super.create({ ...input, tenantId, creatorId });
+		} catch (error) {
+			console.log('Error while creating activity log:', error);
+			throw new BadRequestException('Error while creating activity log', error);
+		}
+	}
+
 	/**
 	 * Finds and retrieves activity logs based on the given filters criteria.
 	 *
@@ -67,7 +102,7 @@ export class ActivityLogService extends TenantAwareCrudService<ActivityLog> {
 
 		const take = filters.take ? filters.take : 100; // Default take value if not provided
 		// Pagination: ensure `filters.skip` is a positive integer starting from 1
-		const skip = (filters.skip && Number.isInteger(filters.skip) && filters.skip > 0) ? filters.skip : 1;
+		const skip = filters.skip && Number.isInteger(filters.skip) && filters.skip > 0 ? filters.skip : 1;
 
 		// Ensure that filters are properly defined
 		const queryOptions: FindManyOptions<ActivityLog> = {
@@ -85,20 +120,56 @@ export class ActivityLogService extends TenantAwareCrudService<ActivityLog> {
 	}
 
 	/**
-	 * Creates a new activity log entry with the provided input, while associating it with the current user and tenant.
-	 *
-	 * @param input - The data required to create an activity log entry.
-	 * @returns The created activity log entry.
-	 * @throws BadRequestException when the log creation fails.
+	 * @description Create or Update Activity Log
+	 * @template T
+	 * @param {BaseEntityEnum} entityType - Entity type for whom creating activity log (E.g : Task, OrganizationProject, etc.)
+	 * @param {string} entityName - Name or Title of the entity
+	 * @param {ActorTypeEnum} actor - The actor type performing the action (User or System)
+	 * @param {ID} organizationId
+	 * @param {ID} tenantId
+	 * @param {ActionTypeEnum} actionType - Action performed (Created or Updated)
+	 * @param {T} data - Entity data (for Created action) or Updated entity data (for Updated action)
+	 * @param {Partial<T>} [originalValues] - Entity data before update (optional for Update action)
+	 * @param {Partial<T>} [newValues] - Entity updated data per field (optional for Update action)
 	 */
-	async logActivity(input: IActivityLogInput): Promise<IActivityLog> {
-		try {
-			const creatorId = RequestContext.currentUserId(); // Retrieve the current user's ID from the request context
-			// Create the activity log entry using the provided input along with the tenantId and creatorId
-			return await super.create({ ...input, creatorId });
-		} catch (error) {
-			console.log('Error while creating activity log:', error);
-			throw new BadRequestException('Error while creating activity log', error);
+	logActivity<T>(
+		entity: BaseEntityEnum,
+		actionType: ActionTypeEnum,
+		actor: ActorTypeEnum,
+		entityId: ID,
+		entityName: string,
+		data: T,
+		organizationId: ID,
+		tenantId: ID,
+		originalValues?: Partial<T>,
+		newValues?: Partial<T>
+	) {
+		let jsonFields: Record<string, any> = new Object();
+
+		// If it's an update action, add updated fields and values
+		if (actionType === ActionTypeEnum.Updated && originalValues && newValues) {
+			const { updatedFields, previousValues, updatedValues } = activityLogUpdatedFieldsAndValues(
+				originalValues,
+				newValues
+			);
+
+			// Add updated fields and values to the log
+			jsonFields = Object.assign({}, { updatedFields, previousValues, updatedValues });
 		}
+
+		// Emit the event to log the activity
+		this._eventBus.publish(
+			new ActivityLogEvent({
+				entity,
+				entityId,
+				action: actionType,
+				actorType: actor,
+				description: generateActivityLogDescription(actionType, entity, entityName),
+				data,
+				organizationId,
+				tenantId,
+				...jsonFields
+			})
+		);
 	}
 }
diff --git a/packages/core/src/activity-log/events/handlers/activity-log.handler.ts b/packages/core/src/activity-log/events/handlers/activity-log.handler.ts
@@ -15,6 +15,6 @@ export class ActivityLogEventHandler implements IEventHandler<ActivityLogEvent>
 	 */
 	async handle(event: ActivityLogEvent) {
 		// Extract the input from the event and create a new activity log entry
-		return await this.activityLogService.logActivity(event.input);
+		return await this.activityLogService.create(event.input);
 	}
 }
diff --git a/packages/core/src/organization-project-module/organization-project-module.service.ts b/packages/core/src/organization-project-module/organization-project-module.service.ts
@@ -1,8 +1,6 @@
 import { BadRequestException, HttpException, HttpStatus, Injectable } from '@nestjs/common';
-import { EventBus } from '@nestjs/cqrs';
 import { Brackets, FindManyOptions, SelectQueryBuilder, UpdateResult, WhereExpressionBuilder } from 'typeorm';
 import {
-	ActionTypeEnum,
 	BaseEntityEnum,
 	ActorTypeEnum,
 	ID,
@@ -12,16 +10,16 @@ import {
 	IOrganizationProjectModuleUpdateInput,
 	IPagination,
 	PermissionsEnum,
-	ProjectModuleStatusEnum
+	ProjectModuleStatusEnum,
+	ActionTypeEnum
 } from '@gauzy/contracts';
 import { isEmpty, isNotEmpty } from '@gauzy/common';
 import { isPostgres } from '@gauzy/config';
 import { PaginationParams, TenantAwareCrudService } from './../core/crud';
 import { RequestContext } from '../core/context';
-import { ActivityLogEvent } from '../activity-log/events';
-import { activityLogUpdatedFieldsAndValues, generateActivityLogDescription } from '../activity-log/activity-log.helper';
 import { OrganizationProjectModule } from './organization-project-module.entity';
 import { prepareSQLQuery as p } from './../database/database.helper';
+import { ActivityLogService } from '../activity-log/activity-log.service';
 import { TypeOrmOrganizationProjectModuleRepository } from './repository/type-orm-organization-project-module.repository';
 import { MikroOrmOrganizationProjectModuleRepository } from './repository/mikro-orm-organization-project-module.repository';
 
@@ -30,7 +28,7 @@ export class OrganizationProjectModuleService extends TenantAwareCrudService<Org
 	constructor(
 		readonly typeOrmProjectModuleRepository: TypeOrmOrganizationProjectModuleRepository,
 		readonly mikroOrmProjectModuleRepository: MikroOrmOrganizationProjectModuleRepository,
-		private readonly _eventBus: EventBus
+		private readonly activityLogService: ActivityLogService
 	) {
 		super(typeOrmProjectModuleRepository, mikroOrmProjectModuleRepository);
 	}
@@ -46,33 +44,24 @@ export class OrganizationProjectModuleService extends TenantAwareCrudService<Org
 		const { organizationId } = entity;
 
 		try {
-			const module = await super.create({
+			const projectModule = await super.create({
 				...entity,
 				creatorId
 			});
 
-			// Generate the activity log description
-			const description = generateActivityLogDescription(
-				ActionTypeEnum.Created,
+			// Generate the activity log
+			this.activityLogService.logActivity<OrganizationProjectModule>(
 				BaseEntityEnum.OrganizationProjectModule,
-				module.name
-			);
-
-			// Emit an event to log the activity
-			this._eventBus.publish(
-				new ActivityLogEvent({
-					entity: BaseEntityEnum.OrganizationProjectModule,
-					entityId: module.id,
-					action: ActionTypeEnum.Created,
-					actorType: ActorTypeEnum.User,
-					description,
-					data: module,
-					organizationId,
-					tenantId
-				})
+				ActionTypeEnum.Created,
+				ActorTypeEnum.User,
+				projectModule.id,
+				projectModule.name,
+				projectModule,
+				organizationId,
+				tenantId
 			);
 
-			return module;
+			return projectModule;
 		} catch (error) {
 			throw new BadRequestException(error);
 		}
@@ -93,54 +82,41 @@ export class OrganizationProjectModuleService extends TenantAwareCrudService<Org
 
 		try {
 			// Retrieve existing module.
-			const existingModule = await this.findOneByIdString(id, {
+			const existingProjectModule = await this.findOneByIdString(id, {
 				relations: {
 					members: true,
 					manager: true
 				}
 			});
 
-			if (!existingModule) {
+			if (!existingProjectModule) {
 				throw new BadRequestException('Module not found');
 			}
 
 			// Update module with new values
-			const updatedModule = await super.create({
+			const updatedProjectModule = await super.create({
 				...entity,
 				id
 			});
 
-			// Generate the activity log description
-			const description = generateActivityLogDescription(
-				ActionTypeEnum.Updated,
-				BaseEntityEnum.OrganizationProjectModule,
-				updatedModule.name
-			);
+			// Generate the activity log
+			const { organizationId } = updatedProjectModule;
 
-			const { updatedFields, previousValues, updatedValues } = activityLogUpdatedFieldsAndValues(
-				updatedModule,
+			this.activityLogService.logActivity<OrganizationProjectModule>(
+				BaseEntityEnum.OrganizationProjectModule,
+				ActionTypeEnum.Updated,
+				ActorTypeEnum.User,
+				updatedProjectModule.id,
+				updatedProjectModule.name,
+				updatedProjectModule,
+				organizationId,
+				tenantId,
+				existingProjectModule,
 				entity
 			);
 
-			// Emit an event to log the activity
-			this._eventBus.publish(
-				new ActivityLogEvent({
-					entity: BaseEntityEnum.OrganizationProjectModule,
-					entityId: updatedModule.id,
-					action: ActionTypeEnum.Updated,
-					actorType: ActorTypeEnum.User,
-					description,
-					updatedFields,
-					updatedValues,
-					previousValues,
-					data: updatedModule,
-					organizationId: updatedModule.organizationId,
-					tenantId
-				})
-			);
-
 			// return updated Module
-			return updatedModule;
+			return updatedProjectModule;
 		} catch (error) {
 			throw new BadRequestException(error);
 		}