feat: booking audit log #22817

alishaz-polymath · 2025-07-30T12:35:12Z

What does this PR do?

Fixes Define and migrate BookingAudit table #22831 (GitHub issue number)
Fixes CAL-6180 (Linear issue number - should be visible at the bottom of the GitHub issue description)

Visual Demo (For contributors especially)

A visual demonstration is strongly recommended, for both the original and new change (video / image - any one).

Video Demo (if applicable):

Show screen recordings of the issue or feature.
Demonstrate how to reproduce the issue, the behavior before and after the change.

Image Demo (if applicable):

Add side-by-side screenshots of the original and updated change.
Highlight any significant change(s).

Mandatory Tasks (DO NOT REMOVE)

I have self-reviewed the code (A decent size PR without self-review might be rejected).
I have updated the developer docs in /docs if this PR makes changes that would require a documentation change. If N/A, write N/A here and check the checkbox.
I confirm automated tests are in place that prove my fix is effective or that my feature works.

How should this be tested?

Are there environment variables that should be set?
What are the minimal test data to have?
What is expected (happy path) to have (input and output)?
Any other important info that could help to test that PR

Checklist

I haven't read the contributing guide
My code doesn't follow the style guidelines of this project
I haven't commented my code, particularly in hard-to-understand areas
I haven't checked if my changes generate no new warnings

coderabbitai · 2025-07-30T12:35:19Z

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing Touches

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch feat/booking-audit-log

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai generate unit tests to generate unit tests for this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

vercel · 2025-07-30T12:37:38Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

2 Skipped Deployments

Name	Status	Preview	Comments	Updated (UTC)
cal	⬜️ Ignored (Inspect)			Aug 1, 2025 3:30am
cal-eu	⬜️ Ignored (Inspect)			Aug 1, 2025 3:30am

linear · 2025-07-31T05:20:01Z

CAL-6180 Define and migrate BookingAudit table

alishaz-polymath · 2025-07-31T15:32:20Z

packages/lib/server/service/bookingAuditService.ts

+export type BookingAuditData = {
+  version?: number;
+  actor?: {
+    type: "User" | "System" | "Attendee";
+  };
+  booking?: {
+    meetingTime?: string;
+    totalReschedules?: number;
+    attendeeCountChange?: number;
+    cancellationReason?: string;
+    rejectionReason?: string;
+    assignmentReason?: string;
+    reassignmentReason?: string;
+  };
+  attendee?: {
+    id?: string;
+  };
+  meeting?: {
+    provider?: string;
+    meetingId?: string;
+    meetingUrl?: string;
+  };
+  location?: {
+    type?: string;
+    address?: string;
+    details?: Record<string, unknown>;
+  };
+};


@emrysal Does this make sense as the structure? Anything I'm missing out on, or extra/unnecessary? Did you have the same vision about the versioning?

emrysal · 2025-08-04T09:12:06Z

packages/lib/server/repository/IBookingAuditRepository.ts

@@ -0,0 +1,8 @@
+import type { BookingAudit, Prisma } from "@prisma/client";
+
+export interface IBookingAuditRepository {


The repository interface should be lightly decoupled from Prisma - use a DTO

e.g.

import type { BookingAuditCreateInput, BookingAudit } from "./dto/bookingAudit";

type BookingAuditCreateInput = Prisma.BookingAuditCreateInput; ...

emrysal · 2025-08-04T09:15:21Z

packages/lib/server/service/bookingAuditService.ts

+  })
+  .optional();
+
+export type BookingAuditData = z.infer<typeof BookingAuditDataSchema>;


Try not to use z.infer if possible

z.infer seems like the idiomatic way to infer types from the zod schema. Is there a reason why we should avoid it? 👀

It's heavy on TS, but it is idiomatic.

What would be the recommended alternative?

emrysal · 2025-08-04T09:16:42Z

packages/lib/server/service/bookingAuditService.ts

+  data?: BookingAuditData | null;
+};
+
+const CURRENT_AUDIT_DATA_VERSION = 1;


Versioning should be done on the action, not on the entire table.

Could you expand on this? I'm not sure I follow 🤔
Currently we version the data's structure to then be able to parse correctly in the future when any further changes comes in. Was that not the purpose/intention?

yes, but this is per payload type, not the entire table 👍

alishaz-polymath added 3 commits July 30, 2025 07:09

init db

c25b947

add repo and services

f5bceb6

add more details to BookingAuditData type

b7a4ad4

github-actions bot added the ❗️ migrations contains migration files label Jul 30, 2025

keithwillcode added core area: core, team members only enterprise area: enterprise, audit log, organisation, SAML, SSO labels Jul 30, 2025

minor fixes

3daae22

vercel bot deployed to Preview – dev July 30, 2025 13:15 View deployment

add version to data structure

86a9e7d

vercel bot deployed to Preview – dev July 31, 2025 05:38 View deployment

alishaz-polymath commented Jul 31, 2025

View reviewed changes

use zod for strict adherence

d1f1b92

vercel bot deployed to Preview – dev August 1, 2025 03:47 View deployment

emrysal reviewed Aug 4, 2025

View reviewed changes

		@@ -0,0 +1,8 @@
		import type { BookingAudit, Prisma } from "@prisma/client";

		export interface IBookingAuditRepository {

feat: booking audit log #22817

Are you sure you want to change the base?

feat: booking audit log #22817

Uh oh!

Conversation

alishaz-polymath commented Jul 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does this PR do?

Visual Demo (For contributors especially)

Video Demo (if applicable):

Image Demo (if applicable):

Mandatory Tasks (DO NOT REMOVE)

How should this be tested?

Checklist

Uh oh!

coderabbitai bot commented Jul 30, 2025

Review skipped

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

vercel bot commented Jul 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

linear bot commented Jul 31, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

alishaz-polymath commented Jul 30, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

vercel bot commented Jul 30, 2025 •

edited

Loading