f1011ddd08
* feat(booking-audit): extract core audit system changes from PR 25125 This PR extracts core audit infrastructure changes without integration changes: 1. New action services introduced: - SeatBookedAuditActionService - SeatRescheduledAuditActionService 2. Simplification of ActionService interface: - Streamlined IAuditActionService interface - Reduced TypeScript burden with cleaner type definitions 3. ActionSource support: - Added BookingAuditSource enum (API_V1, API_V2, WEBAPP, WEBHOOK, UNKNOWN) - Added source and operationId fields to BookingAudit model 4. New AuditAction types: - SEAT_BOOKED - SEAT_RESCHEDULED - APP actor type 5. New BookingAuditAccessService: - Permission-based access control for audit logs - Added readTeamAuditLogs and readOrgAuditLogs permissions 6. Fixes in the logs viewer flow: - Enhanced BookingAuditViewerService with improved filtering - Local AttendeeRepository for actor enrichment Changes are contained within packages/features/booking-audit with minimal outside changes (permission registry only). Co-Authored-By: hariom@cal.com <hariombalhara@gmail.com> * refactor(booking-audit): streamline action handling and enhance localization - Replaced action icon retrieval with a mapping object for improved clarity and performance. - Introduced constants for actor role labels to simplify role retrieval. - Added new localization strings for audit log permission errors and organization requirements. - Updated various service and repository interfaces to enhance type safety and clarity. - Removed deprecated architecture documentation and adjusted related imports for consistency. These changes aim to improve code maintainability and user experience in the booking audit system. * fix(booking-audit): enhance actor role localization and operation ID tracking - Updated actor role labels in the booking logs view to use lowercase for consistency. - Improved localization by wrapping actor role display in a translation function. - Added operationId field to audit logs for better correlation of actions across multiple bookings. - Enhanced BookingAuditViewerService to include operationId in enriched audit logs. - Updated integration tests to verify consistent operationId across related audit logs. These changes aim to improve localization accuracy and facilitate better tracking of user actions in the booking audit system. * feat: integrate credential repository and enhance app actor handling - Added CredentialRepository to manage app credentials, including a method to find credentials by ID. - Updated BookingAudit system to support app actors identified by credential ID, improving actor attribution and audit clarity. - Introduced a new utility function to map app slugs to display names, enhancing the user experience in audit logs. - Modified relevant interfaces and types to accommodate the new credential handling and app actor structure. - Enhanced BookingAuditViewerService to display app names based on credentials, ensuring accurate representation in audit logs. --------- Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
173 lines
6.2 KiB
TypeScript
173 lines
6.2 KiB
TypeScript
import { z } from "zod";
|
|
|
|
import { StringChangeSchema } from "../common/changeSchemas";
|
|
import { AuditActionServiceHelper } from "./AuditActionServiceHelper";
|
|
import type { IAuditActionService, TranslationWithParams, GetDisplayTitleParams, GetDisplayJsonParams, BaseStoredAuditData } from "./IAuditActionService";
|
|
|
|
/**
|
|
* Rescheduled Audit Action Service
|
|
* Handles RESCHEDULED action with per-action versioning
|
|
*/
|
|
|
|
// Module-level because it is passed to IAuditActionService type outside the class scope
|
|
const fieldsSchemaV1 = z.object({
|
|
startTime: StringChangeSchema,
|
|
endTime: StringChangeSchema,
|
|
rescheduledToUid: StringChangeSchema,
|
|
});
|
|
|
|
export class RescheduledAuditActionService implements IAuditActionService {
|
|
readonly VERSION = 1;
|
|
public static readonly TYPE = "RESCHEDULED" as const;
|
|
private static dataSchemaV1 = z.object({
|
|
version: z.literal(1),
|
|
fields: fieldsSchemaV1,
|
|
});
|
|
private static fieldsSchemaV1 = fieldsSchemaV1;
|
|
public static readonly latestFieldsSchema = fieldsSchemaV1;
|
|
// Union of all versions
|
|
public static readonly storedDataSchema = RescheduledAuditActionService.dataSchemaV1;
|
|
// Union of all versions
|
|
public static readonly storedFieldsSchema = RescheduledAuditActionService.fieldsSchemaV1;
|
|
private helper: AuditActionServiceHelper<
|
|
typeof RescheduledAuditActionService.latestFieldsSchema,
|
|
typeof RescheduledAuditActionService.storedDataSchema
|
|
>;
|
|
|
|
constructor() {
|
|
this.helper = new AuditActionServiceHelper({
|
|
latestVersion: this.VERSION,
|
|
latestFieldsSchema: RescheduledAuditActionService.latestFieldsSchema,
|
|
storedDataSchema: RescheduledAuditActionService.storedDataSchema,
|
|
});
|
|
}
|
|
|
|
getVersionedData(fields: unknown) {
|
|
return this.helper.getVersionedData(fields);
|
|
}
|
|
|
|
parseStored(data: unknown) {
|
|
return this.helper.parseStored(data);
|
|
}
|
|
|
|
getVersion(data: unknown): number {
|
|
return this.helper.getVersion(data);
|
|
}
|
|
|
|
migrateToLatest(data: unknown) {
|
|
// V1-only: validate and return as-is (no migration needed)
|
|
const validated = fieldsSchemaV1.parse(data);
|
|
return { isMigrated: false, latestData: validated };
|
|
}
|
|
|
|
async getDisplayTitle({
|
|
storedData,
|
|
userTimeZone,
|
|
}: GetDisplayTitleParams): Promise<TranslationWithParams> {
|
|
const { fields } = this.parseStored(storedData);
|
|
const rescheduledToUid = fields.rescheduledToUid.new;
|
|
const timeZone = userTimeZone;
|
|
|
|
// Format dates in user timezone
|
|
const oldDate = fields.startTime.old
|
|
? AuditActionServiceHelper.formatDateInTimeZone(fields.startTime.old, timeZone)
|
|
: "";
|
|
const newDate = fields.startTime.new
|
|
? AuditActionServiceHelper.formatDateInTimeZone(fields.startTime.new, timeZone)
|
|
: "";
|
|
|
|
return {
|
|
key: "booking_audit_action.rescheduled",
|
|
params: {
|
|
oldDate,
|
|
newDate,
|
|
},
|
|
components: rescheduledToUid ? [{ type: "link", href: `/booking/${rescheduledToUid}/logs` }] : undefined,
|
|
};
|
|
}
|
|
|
|
getDisplayTitleForRescheduledFromLog({
|
|
fromRescheduleUid,
|
|
userTimeZone,
|
|
storedData,
|
|
}: {
|
|
fromRescheduleUid: string;
|
|
userTimeZone: string;
|
|
storedData: BaseStoredAuditData;
|
|
}): TranslationWithParams {
|
|
const timeZone = userTimeZone;
|
|
const { fields } = this.parseStored(storedData);
|
|
|
|
// Format dates in user timezone
|
|
const oldDate = fields.startTime.old
|
|
? AuditActionServiceHelper.formatDateInTimeZone(fields.startTime.old, timeZone)
|
|
: "";
|
|
const newDate = fields.startTime.new
|
|
? AuditActionServiceHelper.formatDateInTimeZone(fields.startTime.new, timeZone)
|
|
: "";
|
|
|
|
return {
|
|
key: "booking_audit_action.rescheduled_from",
|
|
params: {
|
|
oldDate,
|
|
newDate,
|
|
},
|
|
components: [{ type: "link", href: `/booking/${fromRescheduleUid}/logs` }],
|
|
};
|
|
}
|
|
|
|
getDisplayJson({
|
|
storedData,
|
|
userTimeZone,
|
|
}: GetDisplayJsonParams): RescheduledAuditDisplayData {
|
|
const { fields } = this.parseStored({ version: storedData.version, fields: storedData.fields });
|
|
const timeZone = userTimeZone;
|
|
|
|
return {
|
|
previousStartTime: fields.startTime.old
|
|
? AuditActionServiceHelper.formatDateTimeInTimeZone(fields.startTime.old, timeZone)
|
|
: null,
|
|
newStartTime: fields.startTime.new
|
|
? AuditActionServiceHelper.formatDateTimeInTimeZone(fields.startTime.new, timeZone)
|
|
: null,
|
|
previousEndTime: fields.endTime.old
|
|
? AuditActionServiceHelper.formatDateTimeInTimeZone(fields.endTime.old, timeZone)
|
|
: null,
|
|
newEndTime: fields.endTime.new
|
|
? AuditActionServiceHelper.formatDateTimeInTimeZone(fields.endTime.new, timeZone)
|
|
: null,
|
|
rescheduledToUid: fields.rescheduledToUid.new ?? null,
|
|
};
|
|
}
|
|
|
|
/**
|
|
* Finds the rescheduled log that created a specific booking
|
|
* by matching the rescheduledToUid field with the target booking UID
|
|
* @param rescheduledLogs - Array of rescheduled audit logs to search through
|
|
* @param rescheduledToBookingUid - The UID of the booking that was created from the reschedule
|
|
* @returns The matching log or null if not found
|
|
*/
|
|
getMatchingLog<T extends { data: unknown }>({
|
|
rescheduledLogs,
|
|
rescheduledToBookingUid,
|
|
}: {
|
|
rescheduledLogs: T[];
|
|
rescheduledToBookingUid: string;
|
|
}): T | null {
|
|
return rescheduledLogs.find((log) => {
|
|
const parsedData = this.parseStored(log.data);
|
|
return parsedData.fields.rescheduledToUid.new === rescheduledToBookingUid;
|
|
}) ?? null;
|
|
}
|
|
}
|
|
|
|
export type RescheduledAuditData = z.infer<typeof fieldsSchemaV1>;
|
|
|
|
export type RescheduledAuditDisplayData = {
|
|
previousStartTime: string | null;
|
|
newStartTime: string | null;
|
|
previousEndTime: string | null;
|
|
newEndTime: string | null;
|
|
rescheduledToUid: string | null;
|
|
};
|