feat: audit log #14985

TaduJR · 2024-05-11T09:25:47Z

What does this PR do?

This change tries to resolve #1461 by adding audit logger on v1 api, v2 api and backend.
These are the list of events handled on Teams and Organizations

Event-Types
	- Modified
		Event Setup
			Title
			Duration
			Location
	- Created
	- Delete

Bookings
	- Modified
		Reschedule
		Edit Location
	- Created
	- Cancelled

Note

This PR needs frontend integration and audit log table data fetching based on logged team

Important

I already made the common local parser. It just needs integration with the frontend.

Tip

I have an idea on where to show the Logged Events. Check this the screenshot.

Fixes [CAL-1710] Audit log #1461 (GitHub issue number)
Fixes CAL-1461 (Linear issue number - should be visible at the bottom of the GitHub issue description)

Handling EventType Audit Logs
https://www.loom.com/share/07e24f0d6249494da1647ce4f9a82520

Mandatory Tasks (DO NOT REMOVE)

I have self-reviewed the code (A decent size PR without self-review might be rejected)
I have added a Docs issue here if this PR makes changes that would require a documentation change
I have added or modified automated tests that prove my fix is effective or that my feature works (PRs might be rejected if logical changes are not properly tested)

How should this be tested?

Are there environment variables that should be set? No
What are the minimal test data to have? Event Type, Team and User Entity Records
What is expected (happy path) to have (input and output)?
Any other important info that could help to test that PR? Yes, check the Highlighted Markdowns

Checklist

I haven't commented my code, particularly in hard-to-understand areas
/claim [CAL-1710] Audit log #1461

vercel · 2024-05-11T09:25:52Z

@TaduJR is attempting to deploy a commit to the cal Team on Vercel.

A member of the Team first needs to authorize it.

github-actions · 2024-05-11T09:25:59Z

Thank you for following the naming conventions! 🙏 Feel free to join our discord and post your PR link.

graphite-app · 2024-05-11T09:30:13Z

Graphite Automations

"Add community label" took an action on this PR • (05/11/24)

1 label was added to this PR based on Keith Williams's automation.

"Add foundation team as reviewer" took an action on this PR • (05/11/24)

1 reviewer was added to this PR based on Keith Williams's automation.

"Add consumer team as reviewer" took an action on this PR • (05/11/24)

1 reviewer was added to this PR based on Keith Williams's automation.

github-actions · 2024-05-11T09:36:28Z

📦 Next.js Bundle Analysis for @calcom/web

This analysis was generated by the Next.js Bundle Analysis action. 🤖

This PR introduced no changes to the JavaScript bundle! 🙌

zomars

This PR has a lot of potential. Thank you for your contribution 🙏 I have some observations in order to ensure this is a top quality feature.

Delegate auditing logs to a background task

Since we're doing extra writing to the database for each action being taken. We should find a way to delegate all this logging off the main thread. It is expected that this will make all logged actions slower. But we should try to make this the least intrusive as possible. Some possible approaches that come to mind is using a prisma middleware to avoid polluting the code itself.

Make the feature opt-in by default

Since this codebase is shared with all self posters. We should try to make all these features opt-in by default. That way we don't suddenly introduce more unexpected DB load or side effect after an update. A possible approach would be using our current feature flags to toggle logging on or off and it is turned off by default. That way we can also switch it off without having to redeploy in case something wrong happens.

Use dependency injection pattern

This is so we can easily switch to a third party service if needed. We can disable it locally. We can unit test it. We can switch it with another one. I would try to come up with a AuditLogger abstraction and create an InternalAuditLogger as our first option. Here's a very nice video explaining the pattern if you want to dive into that.

Feel free to reach out with questions and more guidance.

May you be well 🙏

zomars · 2024-05-14T18:38:26Z

packages/prisma/schema.prisma

@@ -402,6 +402,7 @@ model Team {
  platformOAuthClient   PlatformOAuthClient[]
  smsLockState          SMSLockState            @default(UNLOCKED)
  platformBilling       PlatformBilling?
+  auditLog              AuditLog[]


Is the relationship needed at all? We can ditch the relationship and still query by teamId don't we?

zomars · 2024-05-14T18:40:57Z

packages/prisma/schema.prisma

+  id         Int      @id @default(autoincrement())
+  action     String
+  actionDesc String?
+  actor      Json


Instead of Json can we turn this into actorId so we can query/join the user on query? We're trying to avoid Json fields as much as possible are these are harder to index and query.

zomars · 2024-05-14T18:42:01Z

packages/prisma/schema.prisma

+  action     String
+  actionDesc String?
+  actor      Json
+  target     Json?


Same here on target. We can have a targetId: 1 and targetType: "team" instead of a Json field.

zomars · 2024-05-14T18:43:24Z

packages/prisma/schema.prisma

+  actionDesc String?
+  actor      Json
+  target     Json?
+  crud       String


This could/should be an enum:

enum Crud { CREATE READ UPDATE DELETE }

zomars · 2024-05-14T18:53:33Z

/tip $25

algora-pbc · 2024-05-14T18:53:51Z

🎉🎈 @TaduJR has been awarded $25! 🎈🎊

TaduJR · 2024-05-14T20:40:11Z

Hello @zomars. I will look into and fix every changes you requested and thank you so much for the tip.

socket-security · 2024-05-26T16:30:45Z

No dependency changes detected. Learn more about Socket for GitHub ↗︎

👍 No dependency changes detected in pull request

…dit_log Testing Multithreading for audit_log

Merge changes for yarnlock

graphite-app bot added the community Created by Linear-GitHub Sync label May 11, 2024

graphite-app bot requested review from a team May 11, 2024 09:25

algora-pbc bot mentioned this pull request May 11, 2024

[CAL-1710] Audit log #1461

Open

algora-pbc bot added the 🙋 Bounty claim label May 11, 2024

PeerRich added High priority Created by Linear-GitHub Sync and removed Medium priority Created by Linear-GitHub Sync labels May 14, 2024

zomars requested changes May 14, 2024

View reviewed changes

algora-pbc bot added the 💰 Rewarded Rewarded bounties on Algora.io label May 14, 2024

keithwillcode added this to the v4.2 milestone May 15, 2024

TaduJR force-pushed the audit_log branch from 42f0039 to 7f5fe94 Compare May 25, 2024 17:25

github-actions bot added the Medium priority Created by Linear-GitHub Sync label May 25, 2024

TaduJR and others added 30 commits May 27, 2024 22:51

testing

526305f

testing

893b03e

testing

e154c88

testing

2548844

testing

e2981cf

testing

e8fdfac

testing

9a4efeb

testing

70f175c

test booking update backend

7241ef9

remove booking delete backend

6508d6e

implement backend with log parser

4ee8f8a

fix typecheck

821815b

Merge branch 'calcom:main' into audit_log

401911e

implement multithreading for auditlogger

f6e2257

Merge branch 'audit_log' of https://github.com/TaduJR/cal.com into au…

72a7aed

…dit_log Testing Multithreading for audit_log

fix import type

1f13727

fix path resolver

c487b76

fix import

4fd1c66

fix import error

06e9fbd

testing

f9aa9e4

testing

5849ceb

fix import

08cffd6

testing

7fa5126

testing

e30e66a

remove multithreading until feature enabled is implemented

f18e6e2

testing

1188184

testing

28a715a

Merge branch 'calcom:main' into audit_log

6060ea2

testing

446012e

Merge remote-tracking branch 'fork/audit_log' into audit_log

71ae7e4

Merge changes for yarnlock

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: audit log #14985

feat: audit log #14985

TaduJR commented May 11, 2024 •

edited

vercel bot commented May 11, 2024

github-actions bot commented May 11, 2024 •

edited

graphite-app bot commented May 11, 2024

github-actions bot commented May 11, 2024 •

edited

zomars left a comment

zomars May 14, 2024

zomars May 14, 2024

zomars May 14, 2024

zomars May 14, 2024

zomars commented May 14, 2024

algora-pbc bot commented May 14, 2024

TaduJR commented May 14, 2024

socket-security bot commented May 26, 2024 •

edited

feat: audit log #14985

Are you sure you want to change the base?

feat: audit log #14985

Conversation

TaduJR commented May 11, 2024 • edited

What does this PR do?

Mandatory Tasks (DO NOT REMOVE)

How should this be tested?

Checklist

vercel bot commented May 11, 2024

github-actions bot commented May 11, 2024 • edited

graphite-app bot commented May 11, 2024

Graphite Automations

github-actions bot commented May 11, 2024 • edited

📦 Next.js Bundle Analysis for @calcom/web

zomars left a comment

Choose a reason for hiding this comment

Delegate auditing logs to a background task

Make the feature opt-in by default

Use dependency injection pattern

zomars May 14, 2024

Choose a reason for hiding this comment

zomars May 14, 2024

Choose a reason for hiding this comment

zomars May 14, 2024

Choose a reason for hiding this comment

zomars May 14, 2024

Choose a reason for hiding this comment

zomars commented May 14, 2024

algora-pbc bot commented May 14, 2024

TaduJR commented May 14, 2024

socket-security bot commented May 26, 2024 • edited

TaduJR commented May 11, 2024 •

edited

github-actions bot commented May 11, 2024 •

edited

github-actions bot commented May 11, 2024 •

edited

socket-security bot commented May 26, 2024 •

edited