feat: create BookingHistoryViewerService to combine audit logs with routing form submissions (calcom#26045)

* feat: create BookingHistoryViewerService to combine audit logs with routing form submissions

Co-Authored-By: hariom@cal.com <hariombalhara@gmail.com>

* refactor(booking): rename audit log query and enhance type safety

- Updated the booking logs view to use the new getBookingHistory query instead of getAuditLogs.
- Introduced DisplayBookingAuditLog type for improved clarity in BookingAuditViewerService.
- Refactored BookingHistoryViewerService to utilize the new DisplayBookingAuditLog type and added sorting functionality for history logs.
- Adjusted related types and methods to ensure consistency across services.

* refactor(routing-forms): streamline imports and enhance type definitions

- Consolidated type exports and imports from the features library for better organization.
- Removed redundant type definitions and functions in zod.ts, findFieldValueByIdentifier.ts, getFieldIdentifier.ts, and parseRoutingFormResponse.ts.
- Introduced new utility functions for handling field responses and parsing routing form responses.
- Improved type safety and clarity across routing form response handling.

* fix: remove double prefix from uniqueId in form submission entry

Co-Authored-By: hariom@cal.com <hariombalhara@gmail.com>

* 1c97f9c (calcom#26453)

---------

Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>

Author: hariombalhara

packages/app-store/routing-forms/lib/findFieldValueByIdentifier.ts

@@ -1,20 +1 @@
-import getFieldIdentifier from "./getFieldIdentifier";
-import type { RoutingFormResponseData } from "./responseData/types";
-
-type FindFieldValueByIdentifierResult =
-  | { success: true; data: string | string[] | number | null }
-  | { success: false; error: string };
-
-export function findFieldValueByIdentifier(
-  data: RoutingFormResponseData,
-  identifier: string
-): FindFieldValueByIdentifierResult {
-  const field = data.fields.find((field) => getFieldIdentifier(field) === identifier);
-  if (!field) {
-    return { success: false, error: `Field with identifier ${identifier} not found` };
-  }
-
-  const fieldValue = data.response[field.id]?.value;
-
-  return { success: true, data: fieldValue ?? null };
-}
+export { findFieldValueByIdentifier } from "@calcom/features/routing-forms/lib/findFieldValueByIdentifier";

packages/app-store/routing-forms/lib/getFieldIdentifier.ts

@@ -1,5 +1 @@
-import type { Field } from "../types/types";
-
-const getFieldIdentifier = (field: Field) => field.identifier || field.label;
-
-export default getFieldIdentifier;
+export { default } from "@calcom/features/routing-forms/lib/getFieldIdentifier";

packages/app-store/routing-forms/lib/responseData/parseRoutingFormResponse.ts

@@ -1,10 +1 @@
-import { zodNonRouterField } from "@calcom/app-store/routing-forms/zod";
-import { routingFormResponseInDbSchema } from "@calcom/app-store/routing-forms/zod";
-
-import type { RoutingFormResponseData } from "./types";
-
-export function parseRoutingFormResponse(rawResponse: unknown, formFields: unknown): RoutingFormResponseData {
-  const response = routingFormResponseInDbSchema.parse(rawResponse);
-  const fields = zodNonRouterField.array().parse(formFields);
-  return { response, fields };
-}
+export { parseRoutingFormResponse } from "@calcom/features/routing-forms/lib/parseRoutingFormResponse";

packages/app-store/routing-forms/zod.ts

@@ -4,50 +4,15 @@ import { raqbQueryValueSchema } from "@calcom/lib/raqb/zod";
 
 import { routingFormAppDataSchemas } from "./appDataSchemas";
 
-export type FieldOption = {
-  label: string;
-  id: string | null;
-};
+export {
+  zodNonRouterField,
+  routingFormResponseInDbSchema,
+  type FieldOption,
+  type TNonRouterField,
+} from "@calcom/features/routing-forms/lib/zod";
 
-export type TNonRouterField = {
-  id: string;
-  label: string;
-  identifier?: string;
-  placeholder?: string;
-  type: string;
-  /** @deprecated in favour of `options` */
-  selectText?: string;
-  required?: boolean;
-  deleted?: boolean;
-  options?: FieldOption[];
-};
-
-// Note: zodNonRouterField is NOT annotated with z.ZodType because it uses .extend() below
-// which requires the full ZodObject type to be preserved
-export const zodNonRouterField = z.object({
-  id: z.string(),
-  label: z.string(),
-  identifier: z.string().optional(),
-  placeholder: z.string().optional(),
-  type: z.string(),
-  /**
-   * @deprecated in favour of `options`
-   */
-  selectText: z.string().optional(),
-  required: z.boolean().optional(),
-  deleted: z.boolean().optional(),
-  options: z
-    .array(
-      z.object({
-        label: z.string(),
-        // To keep backwards compatibility with the options generated from legacy selectText, we allow saving null as id
-        // It helps in differentiating whether the routing logic should consider the option.label as value or option.id as value.
-        // This is important for legacy routes which has option.label saved in conditions and it must keep matching with the value of the option
-        id: z.string().or(z.null()),
-      })
-    )
-    .optional(),
-});
+import type { TNonRouterField } from "@calcom/features/routing-forms/lib/zod";
+import { zodNonRouterField } from "@calcom/features/routing-forms/lib/zod";
 
 export type TRouterField = TNonRouterField & {
   routerId: string;
@@ -158,12 +123,3 @@ export const zodRoutesView = z.union([z.array(zodRouteView), z.null()]).optional
 export const appDataSchema = z.any();
 
 export const appKeysSchema = z.object({});
-
-// This is different from FormResponse in types.d.ts in that it has label optional. We don't seem to be using label at this point, so we might want to use this only while saving the response when Routing Form is submitted
-// Record key is formFieldId
-export const routingFormResponseInDbSchema = z.record(
-  z.object({
-    label: z.string().optional(),
-    value: z.union([z.string(), z.number(), z.array(z.string())]),
-  })
-);

packages/features/booking-audit/client/components/BookingHistory.tsx

@@ -360,7 +360,7 @@ export function BookingHistory({ bookingUid }: BookingHistoryProps) {
     const [searchTerm, setSearchTerm] = useState("");
     const [actorFilter, setActorFilter] = useState<string | null>(null);
     const { t } = useLocale();
-    const { data, isLoading, error } = trpc.viewer.bookings.getAuditLogs.useQuery({
+    const { data, isLoading, error } = trpc.viewer.bookings.getBookingHistory.useQuery({
         bookingUid,
     });
 

packages/features/booking-audit/di/BookingHistoryViewerService.container.ts

@@ -0,0 +1,14 @@
+import { createContainer } from "@calcom/features/di/di";
+
+import {
+  type BookingHistoryViewerService,
+  moduleLoader as bookingHistoryViewerServiceModule,
+} from "./BookingHistoryViewerService.module";
+
+const container = createContainer();
+
+export function getBookingHistoryViewerService() {
+  bookingHistoryViewerServiceModule.loadModule(container);
+
+  return container.get<BookingHistoryViewerService>(bookingHistoryViewerServiceModule.token);
+}

packages/features/booking-audit/di/BookingHistoryViewerService.module.ts

@@ -0,0 +1,28 @@
+import { BookingHistoryViewerService } from "@calcom/features/booking-audit/lib/service/BookingHistoryViewerService";
+import { BOOKING_AUDIT_DI_TOKENS } from "@calcom/features/booking-audit/di/tokens";
+import { moduleLoader as bookingAuditViewerServiceModuleLoader } from "@calcom/features/booking-audit/di/BookingAuditViewerService.module";
+import { moduleLoader as routingFormResponseRepositoryModuleLoader } from "@calcom/features/routing-forms/di/RoutingFormResponseRepository.module";
+
+import { createModule, bindModuleToClassOnToken } from "../../di/di";
+
+export const bookingHistoryViewerServiceModule = createModule();
+const token = BOOKING_AUDIT_DI_TOKENS.BOOKING_HISTORY_VIEWER_SERVICE;
+const moduleToken = BOOKING_AUDIT_DI_TOKENS.BOOKING_HISTORY_VIEWER_SERVICE_MODULE;
+
+export { BookingHistoryViewerService };
+
+const loadModule = bindModuleToClassOnToken({
+  module: bookingHistoryViewerServiceModule,
+  moduleToken,
+  token,
+  classs: BookingHistoryViewerService,
+  depsMap: {
+    bookingAuditViewerService: bookingAuditViewerServiceModuleLoader,
+    routingFormResponseRepository: routingFormResponseRepositoryModuleLoader,
+  },
+});
+
+export const moduleLoader = {
+  token,
+  loadModule,
+};

packages/features/booking-audit/di/tokens.ts

@@ -9,4 +9,6 @@ export const BOOKING_AUDIT_DI_TOKENS = {
     BOOKING_AUDIT_REPOSITORY_MODULE: Symbol("BookingAuditRepositoryModule"),
     AUDIT_ACTOR_REPOSITORY: Symbol("AuditActorRepository"),
     AUDIT_ACTOR_REPOSITORY_MODULE: Symbol("AuditActorRepositoryModule"),
+    BOOKING_HISTORY_VIEWER_SERVICE: Symbol("BookingHistoryViewerService"),
+    BOOKING_HISTORY_VIEWER_SERVICE_MODULE: Symbol("BookingHistoryViewerServiceModule"),
 };

packages/features/booking-audit/lib/service/BookingAuditViewerService.ts

@@ -48,6 +48,8 @@ type EnrichedAuditLog = {
     };
 };
 
+export type DisplayBookingAuditLog = EnrichedAuditLog;
+
 /**
  * BookingAuditViewerService - Service for viewing and formatting booking audit logs
  */
@@ -93,7 +95,7 @@ export class BookingAuditViewerService {
         userEmail: string;
         userTimeZone: string;
         organizationId: number | null;
-    }): Promise<{ bookingUid: string; auditLogs: EnrichedAuditLog[] }> {
+    }): Promise<{ bookingUid: string; auditLogs: DisplayBookingAuditLog[] }> {
         const { bookingUid, userId, userTimeZone, organizationId } = params;
         await this.accessService.assertPermissions({
             bookingUid,

packages/features/booking-audit/lib/service/BookingHistoryViewerService.ts

@@ -0,0 +1,105 @@
+import type { RoutingFormResponseRepositoryInterface } from "@calcom/lib/server/repository/RoutingFormResponseRepository.interface";
+
+import type { BookingAuditViewerService, DisplayBookingAuditLog } from "./BookingAuditViewerService";
+import { getFieldResponseByIdentifier } from "@calcom/features/routing-forms/lib/getFieldResponseByIdentifier";
+
+type GetHistoryForBookingParams = {
+    bookingUid: string;
+    userId: number;
+    userEmail: string;
+    userTimeZone: string;
+    organizationId: number | null;
+};
+
+type BookingHistoryLog = DisplayBookingAuditLog;
+
+interface BookingHistoryViewerServiceDeps {
+    bookingAuditViewerService: BookingAuditViewerService;
+    routingFormResponseRepository: RoutingFormResponseRepositoryInterface;
+}
+
+export class BookingHistoryViewerService {
+    private readonly bookingAuditViewerService: BookingAuditViewerService;
+    private readonly routingFormResponseRepository: RoutingFormResponseRepositoryInterface;
+
+    constructor(private readonly deps: BookingHistoryViewerServiceDeps) {
+        this.bookingAuditViewerService = deps.bookingAuditViewerService;
+        this.routingFormResponseRepository = deps.routingFormResponseRepository;
+    }
+
+    private sortLogsReverseChronologically(historyLogs: BookingHistoryLog[]): BookingHistoryLog[] {
+        return historyLogs.sort((a, b) => {
+            const timestampA = new Date(a.timestamp).getTime();
+            const timestampB = new Date(b.timestamp).getTime();
+            return timestampB - timestampA;
+        });
+    }
+
+    private async getFormAuditLogsForBooking(bookingUid: string): Promise<BookingHistoryLog[]> {
+        // TODO: Form doesn't have its Audit Logs yet, so we replicate them using the Form Response directly for now.
+        const formResponse = await this.routingFormResponseRepository.findByBookingUidIncludeForm(bookingUid);
+        if (!formResponse) {
+            return [];
+        }
+        return [this.createFormSubmissionEntry({ formResponse, bookingUid })];
+    }
+
+    async getHistoryForBooking(
+        params: GetHistoryForBookingParams
+    ): Promise<{ bookingUid: string; auditLogs: BookingHistoryLog[] }> {
+        const { bookingUid } = params;
+
+        const { auditLogs: bookingAuditLogs } = await this.bookingAuditViewerService.getAuditLogsForBooking(params);
+
+        const historyEntries: BookingHistoryLog[] = [...bookingAuditLogs, ...await this.getFormAuditLogsForBooking(bookingUid)];
+
+        const sortedLogs = this.sortLogsReverseChronologically(historyEntries);
+
+        return {
+            bookingUid,
+            auditLogs: sortedLogs,
+        };
+    }
+
+    private createFormSubmissionEntry({
+        formResponse,
+        bookingUid,
+    }: {
+        formResponse: NonNullable<
+            Awaited<ReturnType<RoutingFormResponseRepositoryInterface["findByBookingUidIncludeForm"]>>
+        >;
+        bookingUid: string;
+    }): BookingHistoryLog {
+        const timestamp = formResponse.createdAt.toISOString();
+
+        const emailFieldResult = getFieldResponseByIdentifier({ responsePayload: formResponse.response, formFields: formResponse.form.fields, identifier: "email" });
+        const emailFieldValueFromResponse = emailFieldResult.success ? emailFieldResult.data : null;
+        // A valid string can be the email otherwise we assume it is not an email
+        const submitterEmail = typeof emailFieldValueFromResponse === "string" ? emailFieldValueFromResponse : null;
+        const uniqueId = `form-submission-${formResponse.id}`;
+        return {
+            id: uniqueId,
+            bookingUid,
+            type: "RECORD_CREATED",
+            action: "CREATED",
+            timestamp,
+            createdAt: timestamp,
+            source: "WEBAPP",
+            operationId: uniqueId,
+            displayJson: null,
+            actionDisplayTitle: { key: "form_submitted" },
+            displayFields: null,
+            actor: {
+                id: `form-submission-actor-${formResponse.id}`,
+                type: "GUEST",
+                userUuid: null,
+                attendeeId: null,
+                name: null,
+                createdAt: formResponse.createdAt,
+                displayName: submitterEmail ? `${submitterEmail}` : "Guest",
+                displayEmail: submitterEmail || null,
+                displayAvatar: null,
+            },
+        };
+    }
+}