chore: migrate audit DDP methods to /v1/audit.* REST endpoints (EE)

[ggazzo]

Summary

Continues the DDP→REST sweep (#40659, #40711, #40675, #40724, #40728, #40734). This batch migrates the three auditGet* DDP methods that backed the EE audit panel. DDP methods stay registered for external SDK/mobile clients with deprecation logs pointing at the new routes.

New endpoints (EE — auditing license required)

DDP method	REST endpoint	Permission	Body / query
auditGetAuditions	GET /v1/audit.auditions	can-audit-log	?startDate=&endDate= (ISO)
auditGetMessages	POST /v1/audit.messages	can-audit	{ rid?, startDate, endDate, users, msg, type, visitor?, agent? }
auditGetOmnichannelMessages	POST /v1/audit.omnichannel.messages	can-audit	{ startDate, endDate, users, msg, type, visitor?, agent? }

Each endpoint is rate-limited at 10/60s (matching the DDP DDPRateLimiter rules) and writes the same AuditLog entry the DDP path produced. Dates are serialized as ISO strings on the wire.

Implementation

• Method bodies extracted into apps/meteor/ee/server/lib/audit/functions.ts; DDP entrypoints become thin + deprecation-logged.
• messages and omnichannel.messages are POST because the audit log insertion is a side effect (write) and the query params include arrays (users) that don't serialize cleanly into query strings.

Client changes

• AuditLogTable → useEndpoint('GET', '/v1/audit.auditions')
• useAuditMutation → useEndpoint('POST', '/v1/audit.messages') + useEndpoint('POST', '/v1/audit.omnichannel.messages')
• Dates serialized via .toISOString().

Test plan

• CI green (lint + typecheck)
• Admin (EE) → Audit → Messages panel filter by user/channel/date → results render, audit log entry created
• Audit → Omnichannel messages panel by visitor/agent/date → results render
• Audit → Audit log table (can-audit-log perm) → past entries render
• Hit the endpoints with curl and confirm 403 without license/permission, 200 with both

🤖 Generated with Claude Code

Summary by CodeRabbit

• New Features
  • Added EE-only REST API endpoints for audit auditions, audit messages, and omnichannel audit messages under /v1/audit.* (rate-limited to 10 requests per 60 seconds).
  • Updated the Audit UI to fetch auditions and messages via the new REST routes.
• Bug Fixes
  • Standardized startDate/endDate handling as ISO strings and normalized REST responses to consistently return auditions/messages.
• Chores
  • Kept legacy audit methods available with deprecation notices directing callers to the REST endpoints until 9.0.0.

Task: ARCH-2269

[dionisio-bot]

Looks like this PR is not ready to merge, because of the following issues:

• This PR is missing the 'stat: QA assured' label

Please fix the issues and try again

If you have any trouble, please check the PR guidelines

[changeset-bot]

🦋 Changeset detected

Latest commit: 29ff63a

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 3 packages

Name	Type
@rocket.chat/meteor	Minor
@rocket.chat/core-typings	Minor
@rocket.chat/rest-typings	Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[coderabbitai]

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

• @coderabbitai resume to resume automatic reviews.
• @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

• ▶️ Resume reviews
• 🔍 Trigger review

Walkthrough

Audit retrieval now uses shared server functions behind new /v1/audit.* REST endpoints. The audit UI switches to those endpoints with ISO date payloads, while the legacy DDP methods remain as deprecated delegates. Release notes document the migration and endpoint contracts.

Changes

Audit REST endpoint migration

Layer / File(s)	Summary
Shared audit functions apps/meteor/ee/server/lib/audit/functions.ts	Adds shared helpers for authorization, room and user resolution, message and audit-log queries, audit-log recording, and statistics updates.
REST API routes and typings apps/meteor/ee/server/api/audit.ts	Adds three authenticated, rate-limited audit endpoints with typed contracts, AJV request/response validation, and date parsing.
DDP delegation apps/meteor/ee/server/lib/audit/methods.ts	Legacy audit methods now log deprecations, validate dates, and delegate to shared audit functions.
Client migration to REST apps/meteor/client/views/audit/components/AuditLogTable.tsx, apps/meteor/client/views/audit/hooks/useAuditMutation.ts	Audit callers switch from useMethod to useEndpoint, pass ISO dates, and map REST response payloads into client models.
Release notes .changeset/ddp-migrate-batch6-audit-callers.md, .changeset/rest-audit-endpoints.md	Documents the new REST routes, response contracts, rate limits, and DDP deprecation period.

Estimated code review effort: 4 (Complex) | ~60 minutes

Suggested labels: type: feature

Suggested reviewers: sampaiodiego, tassoevan

Sequence Diagram(s)

sequenceDiagram
  participant AuditUI
  participant AuditAPI
  participant AuditFunctions
  participant Messages
  participant AuditLog
  AuditUI->>AuditAPI: Request audit endpoint with ISO dates
  AuditAPI->>AuditFunctions: Invoke audit retrieval function
  AuditFunctions->>Messages: Query matching messages
  AuditFunctions->>AuditLog: Record audit operation
  AuditAPI-->>AuditUI: Return auditions or messages

Loading

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly describes the main change: migrating EE audit DDP methods to new /v1/audit.* REST endpoints.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 68.66%. Comparing base (a27dd2f) to head (29ff63a).
⚠️ Report is 4 commits behind head on develop.

Additional details and impacted files

@@             Coverage Diff             @@
##           develop   #40736      +/-   ##
===========================================
- Coverage    68.66%   68.66%   -0.01%     
===========================================
  Files         4138     4138              
  Lines       159082   159082              
  Branches     27942    27953      +11     
===========================================
- Hits        109238   109233       -5     
- Misses       44696    44701       +5     
  Partials      5148     5148              

Flag	Coverage Δ
unit	70.65% <ø> (-0.01%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[coderabbitai]

Actionable comments posted: 6

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@apps/meteor/client/views/audit/components/AuditLogTable.tsx`:
- Around line 27-33: The audit log query is still force-casting the REST
response into IAuditLog instead of converting it to the client shape. Update
AuditLogTable’s useEndpoint/queryFn path to deserialize the payload before
caching it, mapping REST fields like ts and date values into the IAuditLog
structure the table and AuditLogEntry expect, similar to how useAuditMutation
handles REST-to-client conversion.

In `@apps/meteor/client/views/audit/hooks/useAuditMutation.ts`:
- Around line 19-27: The `useAuditMutation` branch for `type === 'l'` is
ignoring the `AuditFields` filter values by hardcoding `visitor` and `agent` to
empty strings. Update the `getOmnichannelAuditMessages` call to forward the
actual `visitor` and `agent` values from the current audit filters, using the
existing `AuditFields` data in `useAuditMutation` so omnichannel searches stay
scoped correctly.

In `@apps/meteor/ee/server/lib/audit/functions.ts`:
- Around line 44-46: The shared audit helper in functions.ts is emitting a stale
DDP-only deprecation warning from logic now used by REST routes. Remove the
console.warn from the type === 'l' branch in the shared function and keep
deprecation logging only in the DDP wrapper path that calls this helper, so REST
calls do not report a misleading “method” warning or 4.0.0 removal target.
- Around line 175-177: The omnichannel audit path in auditGetMessagesMethod is
missing the same livechat room restriction filter used elsewhere, so apply
livechat.applyRoomRestrictions before the
LivechatRooms.findByVisitorIdAndAgentId lookup. Update the audit messages flow
in functions.ts so the visitor/agent room search is constrained consistently
with the standard audit path, using the existing auditGetMessagesMethod and
livechat.applyRoomRestrictions symbols as the insertion point.
- Around line 178-182: The `findByVisitorIdAndAgentId`/audit query path should
guard the no-room case before building the Mongo filter. In the `rids`/`query`
निर्माण, return or throw early when `rooms` is empty so `rid: { $in: undefined
}` is never created. Keep the fix localized around the `rids` assignment and the
`query: Filter<IMessage>` construction.

In `@apps/meteor/ee/server/lib/audit/methods.ts`:
- Around line 37-53: The audit DDP methods currently validate only the date
fields, so untyped payloads can still reach the shared audit query builders with
missing users, type, visitor, or agent data. Update the method boundaries in
auditGetOmnichannelMessages, auditGetMessages, and auditGetAuditions to validate
the full params object before calling auditGetOmnichannelMessagesMethod,
auditGetMessagesMethod, and auditGetAuditionsMethod. Keep the existing date
checks, but add validation for all required fields in each request shape so
invalid input is rejected early.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 19e5eb95-46be-4ddd-908c-daa3adeb7a77

📥 Commits

Reviewing files that changed from the base of the PR and between 275a6ed and 7ce2aaa.

📒 Files selected for processing (7)

• .changeset/ddp-migrate-batch6-audit-callers.md
• .changeset/rest-audit-endpoints.md
• apps/meteor/client/views/audit/components/AuditLogTable.tsx
• apps/meteor/client/views/audit/hooks/useAuditMutation.ts
• apps/meteor/ee/server/api/audit.ts
• apps/meteor/ee/server/lib/audit/functions.ts
• apps/meteor/ee/server/lib/audit/methods.ts

📜 Review details

⏰ Context from checks skipped due to timeout. (7)

• GitHub Check: cubic · AI code reviewer
• GitHub Check: Hacktron Security Check
• GitHub Check: 🔨 Test Unit / Unit Tests
• GitHub Check: 🔎 Code Check / Code Lint
• GitHub Check: 🔎 Code Check / TypeScript
• GitHub Check: 🔨 Test Storybook / Test Storybook
• GitHub Check: 📦 Meteor Build (coverage)

🧰 Additional context used

📓 Path-based instructions (1)

**/*.{ts,tsx,js}

📄 CodeRabbit inference engine (.cursor/rules/playwright.mdc)

**/*.{ts,tsx,js}: Write concise, technical TypeScript/JavaScript with accurate typing in Playwright tests
Avoid code comments in the implementation

Files:

• apps/meteor/client/views/audit/components/AuditLogTable.tsx
• apps/meteor/client/views/audit/hooks/useAuditMutation.ts
• apps/meteor/ee/server/lib/audit/functions.ts
• apps/meteor/ee/server/lib/audit/methods.ts
• apps/meteor/ee/server/api/audit.ts

🧠 Learnings (7)

📚 Learning: 2026-03-16T21:50:37.589Z

Learnt from: amitb0ra
Repo: RocketChat/Rocket.Chat PR: 39676
File: .changeset/migrate-users-register-openapi.md:3-3
Timestamp: 2026-03-16T21:50:37.589Z
Learning: For changes related to OpenAPI migrations in Rocket.Chat/OpenAPI, when removing endpoint types and validators from rocket.chat/rest-typings (e.g., UserRegisterParamsPOST, /v1/users.register) document this as a minor changeset (not breaking) per RocketChat/Rocket.Chat-Open-API#150 Rule 7. Note that the endpoint type is re-exposed via a module augmentation .d.ts in the consuming package (e.g., packages/web-ui-registration/src/users-register.d.ts). In reviews, ensure the changeset clearly states: this is a non-breaking change, the major version should not be bumped, and the changeset reflects a minor version bump. Do not treat this as a breaking change during OpenAPI migrations.

Applied to files:

• .changeset/ddp-migrate-batch6-audit-callers.md
• .changeset/rest-audit-endpoints.md

📚 Learning: 2026-03-27T14:52:56.865Z

Learnt from: dougfabris
Repo: RocketChat/Rocket.Chat PR: 39892
File: apps/meteor/client/views/room/contextualBar/Threads/Thread.tsx:150-155
Timestamp: 2026-03-27T14:52:56.865Z
Learning: In Rocket.Chat, there are two different `ModalBackdrop` components with different prop APIs. During review, confirm the import source: (1) `rocket.chat/fuselage` `ModalBackdrop` uses `ModalBackdropProps` based on `BoxProps` (so it supports `onClick` and other Box/DOM props) and does not have an `onDismiss` prop; (2) `rocket.chat/ui-client` `ModalBackdrop` uses a narrower props interface like `{ children?: ReactNode; onDismiss?: () => void }` and handles Escape keypress and outside mouse-up, and it does not forward arbitrary DOM props such as `onClick`. Flag mismatched props (e.g., `onDismiss` passed to the fuselage component or `onClick` passed to the ui-client component) and ensure the usage matches the correct component being imported.

Applied to files:

• apps/meteor/client/views/audit/components/AuditLogTable.tsx

📚 Learning: 2026-05-06T12:21:44.083Z

Learnt from: juliajforesti
Repo: RocketChat/Rocket.Chat PR: 40256
File: apps/meteor/client/components/CreateDiscussion/CreateDiscussion.tsx:121-149
Timestamp: 2026-05-06T12:21:44.083Z
Learning: Field wrappers in rocket.chat/fuselage-forms (Field, FieldLabel, FieldRow, FieldError, FieldHint) auto-create htmlFor/id associations, aria-describedby, and role="alert" for errors. Do not manually set htmlFor, id, aria-describedby, or role attributes when using these wrappers. This automatic wiring does not apply to plain rocket.chat/fuselage components, which require explicit ID wiring per the accessibility docs. In code reviews, prefer using fuselage-forms wrappers for form fields and verify there is no unnecessary manual ID/aria wiring in files that use these wrappers. If a component uses plain fuselage components, ensure proper id wiring as per docs.

Applied to files:

• apps/meteor/client/views/audit/components/AuditLogTable.tsx
• apps/meteor/client/views/audit/hooks/useAuditMutation.ts
• apps/meteor/ee/server/lib/audit/functions.ts
• apps/meteor/ee/server/lib/audit/methods.ts
• apps/meteor/ee/server/api/audit.ts

📚 Learning: 2026-02-10T16:32:42.586Z

Learnt from: tassoevan
Repo: RocketChat/Rocket.Chat PR: 38528
File: apps/meteor/client/startup/roles.ts:14-14
Timestamp: 2026-02-10T16:32:42.586Z
Learning: In Rocket.Chat's Meteor client code, DDP streams use EJSON and Date fields arrive as Date objects; do not manually construct new Date() in stream handlers (for example, in sdk.stream()). Only REST API responses return plain JSON where dates are strings, so implement explicit conversion there if needed. Apply this guidance to all TypeScript files under apps/meteor/client to ensure consistent date handling in DDP streams and REST responses.

Applied to files:

• apps/meteor/client/views/audit/hooks/useAuditMutation.ts

📚 Learning: 2026-05-11T20:30:35.265Z

Learnt from: tassoevan
Repo: RocketChat/Rocket.Chat PR: 40480
File: apps/meteor/client/meteor/startup/accounts.ts:59-61
Timestamp: 2026-05-11T20:30:35.265Z
Learning: In Rocket.Chat’s Meteor client code, when calling `dispatchToastMessage` with `{ type: 'error' }`, pass the raw caught error object as `message` without manual normalization. `dispatchToastMessage` is designed to accept `message: unknown` for error toasts, so avoid converting errors to strings (e.g., `String(error)`) or extracting `error.message` before passing them.

Applied to files:

• apps/meteor/client/views/audit/hooks/useAuditMutation.ts

📚 Learning: 2026-02-26T19:25:44.063Z

Learnt from: gabriellsh
Repo: RocketChat/Rocket.Chat PR: 38778
File: packages/ui-voip/src/providers/useMediaSession.ts:192-192
Timestamp: 2026-02-26T19:25:44.063Z
Learning: In the Rocket.Chat repository, do not reference Biome lint rules in code review feedback. Biome is not used even if biome.json exists; only reference Biome rules if there is explicit, project-wide usage documented. For TypeScript files, review lint implications without Biome guidance unless the project enables Biome rules.

Applied to files:

• apps/meteor/client/views/audit/hooks/useAuditMutation.ts
• apps/meteor/ee/server/lib/audit/functions.ts
• apps/meteor/ee/server/lib/audit/methods.ts
• apps/meteor/ee/server/api/audit.ts

📚 Learning: 2026-02-26T19:25:44.063Z

Learnt from: gabriellsh
Repo: RocketChat/Rocket.Chat PR: 38778
File: packages/ui-voip/src/providers/useMediaSession.ts:192-192
Timestamp: 2026-02-26T19:25:44.063Z
Learning: In this repository (RocketChat/Rocket.Chat), Biome lint rules are not used even if a biome.json exists. When reviewing TypeScript files (e.g., packages/ui-voip/src/providers/useMediaSession.ts), ensure lint suggestions do not reference Biome-specific rules. Rely on general ESLint/TypeScript lint rules and project conventions instead.

Applied to files:

• apps/meteor/client/views/audit/hooks/useAuditMutation.ts
• apps/meteor/ee/server/lib/audit/functions.ts
• apps/meteor/ee/server/lib/audit/methods.ts
• apps/meteor/ee/server/api/audit.ts

🪛 ast-grep (0.44.0)

apps/meteor/ee/server/lib/audit/functions.ts

[warning] 131-131: Do not use variable for regular expressions
Context: new RegExp(escapeRegExp(msg).trim(), 'i')
Note: [CWE-1333] Inefficient Regular Expression Complexity. Security best practice.

(regexp-non-literal-typescript)

---

[warning] 189-189: Do not use variable for regular expressions
Context: new RegExp(escapeRegExp(msg).trim(), 'i')
Note: [CWE-1333] Inefficient Regular Expression Complexity. Security best practice.

(regexp-non-literal-typescript)

🔇 Additional comments (6)

.changeset/ddp-migrate-batch6-audit-callers.md (1)

1-6: LGTM!

.changeset/rest-audit-endpoints.md (1)

1-12: LGTM!

apps/meteor/ee/server/lib/audit/functions.ts (1)

1-19: LGTM!

Also applies to: 59-148, 206-227

apps/meteor/ee/server/lib/audit/methods.ts (1)

7-8: LGTM!

apps/meteor/ee/server/api/audit.ts (2)

1-122: LGTM!

Also applies to: 288-404

---

125-130: 🎯 Functional Correctness

Use the 400 failure path for invalid dates. parseDateOrFail() throws a plain Error, while these endpoints declare 400 responses for validation failures. Add an explicit API.v1.failure(...)/Meteor.Error mapping here, or the route layer may turn malformed dates into 500s.

[cubic-dev-ai]

All reported issues were addressed across 7 files

<sub>Reply with feedback, questions, or to request a fix.

Re-trigger cubic</sub>

[cubic-dev-ai]

All reported issues were addressed across 1 file (changes from recent commits).

<sub>Tip: Review your code locally with the cubic CLI to iterate faster.

Re-trigger cubic</sub>

[ggazzo]

/jira ARCH-2166

[cubic-dev-ai]

All reported issues were addressed across 1 file (changes from recent commits).

<sub>Tip: Review your code locally with the cubic CLI to iterate faster.

Re-trigger cubic</sub>