Improvement: Additional Audit Log Indexes

[scott-ray-wilson]

Description 📣

This PR adds additional index to the audit logs table and decreases the timeout on the audit log query to match the server timeout duration.

Type ✨

• Bug fix
• New feature
• Improvement
• Breaking change
• Documentation

Tests 🛠️

# Here's some code block to paste some code snippets

---

• I have read the contributing guide, agreed and acknowledged the code of conduct. 📝

Summary by CodeRabbit

• Chores
  • Improved indexing strategy for the AuditLog table to enhance query performance.
  • Reduced timeout duration for long-running queries to prevent database resource issues.
• New Features
  • Enhanced the Audit Logs page by refining the loading indicator, providing clearer feedback during data fetching.

[coderabbitai]

Walkthrough

The changes include modifications on both the backend and frontend related to audit log functionalities. A new migration script has been added to adjust indexing on the AuditLog table. It checks the existence of specific columns and conditionally creates indexes for eventType, userAgentType, and an index that targets a secret path extracted from eventMetadata. The migration also provides a rollback procedure to drop these indexes if necessary. In the audit log data access layer, the SQL query condition for filtering the secretPath within eventMetadata has been altered to use direct value extraction via the ->> operator instead of the @> operator with a JSON builder. Additionally, the query timeout has been reduced from 120 seconds to approximately 29.5 seconds. On the frontend, the loading state on a button within the logs table component now responds to an additional pending state.

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

backend/src/ee/services/audit-log/audit-log-dal.ts

Oops! Something went wrong! :(

ESLint: 8.57.1

ESLint couldn't find the plugin "@typescript-eslint/eslint-plugin".

(The package "@typescript-eslint/eslint-plugin" was not found when loaded as a Node module from the directory "/backend".)

It's likely that the plugin isn't installed correctly. Try reinstalling by running the following:

npm install @typescript-eslint/eslint-plugin@latest --save-dev

The plugin "@typescript-eslint/eslint-plugin" was referenced from the config file in "backend/.eslintrc.js".

If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b4d0718 and 4380ce5.

📒 Files selected for processing (1)

• backend/src/ee/services/audit-log/audit-log-dal.ts (2 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• backend/src/ee/services/audit-log/audit-log-dal.ts

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: Run integration test

---

🪧 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.
  • Generate unit testing code for this file.
  • 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 generate unit testing code for this file.
  • @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 generate unit testing code.
  • @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.

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 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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

backend/src/ee/services/audit-log/audit-log-dal.ts (1)

115-116: Reduced query timeout aligns with server limits

Good adjustment to the timeout value. Reducing from 120 seconds to 29.5 seconds aligns with the server timeout while preventing long-running queries from consuming excessive resources.

Small typo in the comment: "les" should be "less".

- // we time out long-running queries to prevent DB resource issues (a little les than 30 seconds [server timeout])
+ // we time out long-running queries to prevent DB resource issues (a little less than 30 seconds [server timeout])

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 706feaf and b4d0718.

📒 Files selected for processing (3)

• backend/src/db/migrations/20250306134330_additional-audit-log-indexes.ts (1 hunks)
• backend/src/ee/services/audit-log/audit-log-dal.ts (2 hunks)
• frontend/src/pages/organization/AuditLogsPage/components/LogsTable.tsx (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (3)

• GitHub Check: Check TS and Lint
• GitHub Check: Check Frontend Type and Lint check
• GitHub Check: Run integration test

🔇 Additional comments (4)

frontend/src/pages/organization/AuditLogsPage/components/LogsTable.tsx (1)

109-109: Improved button loading state handling

Good enhancement to the loading state logic. The button now correctly shows the loading indicator both when fetching the next page of logs and during the initial pending state, which provides better visual feedback to users.

backend/src/ee/services/audit-log/audit-log-dal.ts (1)

94-94: Optimization of secretPath filtering

Good change to the query condition. Using the ->> operator for direct value extraction is more efficient than the previous @> with jsonb_build_object approach, especially when paired with the new index created in the migration.

backend/src/db/migrations/20250306134330_additional-audit-log-indexes.ts (2)

5-19: Well-designed migration for audit log optimization

The migration effectively adds targeted indexes to improve audit log query performance. The approach of checking for column existence before creating indexes is robust and prevents errors during migration execution.

The composite index on projectId, secretPath (extracted from eventMetadata), and createdAt DESC is particularly valuable as it directly supports the query pattern modified in the audit-log-dal.ts file.

---

21-34: Proper rollback implementation

Well-implemented rollback function that properly removes all indexes created in the up migration. The checks for column existence ensure the migration will work correctly even if the schema changes in the future.

[akhilmhdh]

Please coordinate with @maidul98 on merging and deployment of this.