fix(logs): serialize server logs with level, message and actor

[LucasSantana-Dev]

Symptom

Dashboard Server Logs page: the 6 level cards (INFO/WARN/ERROR/MODERATION/AUTOMOD/SYSTEM) all show 0 even though log rows exist below; every row shows the generic info icon with a blank level badge, no message, and no actor.

Root cause

GET /api/guilds/:id/logs, /logs/search, /logs/users/:userId returned raw ServerLog rows (type, action, userId, channelId, details, createdAt). But the frontend ServerLog type (packages/frontend/src/types/logs.ts) expects level, message, userName, channelName — a serialization layer that was never implemented.

• The 6 cards are computed client-side: logs.filter(l => l.level === level).length (ServerLogs.tsx:325). With level undefined on every row → all 0.
• Rows fall back to LEVEL_CONFIG[log.level] || LEVEL_CONFIG.info → generic info icon, blank {log.level} badge.
• message (stored in the action column) and the actor never render.

Fix

Add serializeServerLog() (+ LOG_LEVEL_BY_TYPE) in ServerLogService:

• level ← LOG_LEVEL_BY_TYPE[type] (fallback info)
• message ← action
• parses details (persisted JSON-stringified) into metadata
• userName ← details.username, falling back to userId so the actor is never blank

Applied at all three list endpoints. getStats is untouched (the cards are client-side, not fed by it).

Tests

New ServerLogService.spec.ts (6 tests): level mapping, unknown-type fallback, stringified-details parse, username surfacing, userId fallback, null-tolerance. Full-workspace typecheck clean.

Note: backend change — reaches prod on the next backend deploy.

---

Summary by cubic

Fixes the Server Logs dashboard by returning serialized logs with proper levels, messages, and actor/channel names. All log list endpoints now return shaped logs instead of raw DB rows.

• Bug Fixes
  • Added serializeServerLog() and LOG_LEVEL_BY_TYPE in packages/shared/src/services/ServerLogService.ts: map type→level (fallback info), set message from action, parse details to metadata, surface userName/channelName with userId/channelId fallbacks, treat empty-string names as absent so fallbacks apply, ISO createdAt.
  • Updated packages/backend/src/routes/management.ts to return logs.map(serializeServerLog) for /api/guilds/:id/logs, /logs/search, and /logs/users/:userId. Added packages/shared/src/services/ServerLogService.spec.ts tests and a passthrough serializeServerLog stub in packages/backend/tests/integration/routes/management.test.ts via @lucky/shared/services.

^{Written for commit 4ffc6f5. Summary will update on new commits.}

Summary by CodeRabbit

• New Features

  • Server audit logs are now returned in a dashboard-friendly format, with clearer log levels, readable messages, and improved user/channel display names.
  • Log search and guild log views now consistently show properly formatted log entries.

• Bug Fixes

  • Improved handling of stored log details so malformed or varied data formats no longer break log display.
  • Added fallback display values when names are unavailable.

[github-actions]

Failed to generate code suggestions for PR

[coderabbitai]

📝 Walkthrough

Walkthrough

Introduces serializeServerLog in ServerLogService.ts, defining ServerLogLevel, LOG_LEVEL_BY_TYPE, and SerializedServerLog to convert raw log rows into a dashboard-facing shape with derived level, message, and actor names. Management routes now map log responses through this serializer, with corresponding test updates and a new unit test suite.

Changes

Server log serialization

Layer / File(s)	Summary
Serialization contract and implementation packages/shared/src/services/ServerLogService.ts	Adds ServerLogLevel, LOG_LEVEL_BY_TYPE, SerializedServerLog, parseLogDetails, and serializeServerLog to derive level, message, and actor names from raw log rows.
Management route wiring packages/backend/src/routes/management.ts, packages/backend/tests/integration/routes/management.test.ts	Guild logs, search, and user-logs endpoints map raw logs through serializeServerLog before responding; routing test mocks the serializer as an identity function.
Serialization unit tests packages/shared/src/services/ServerLogService.spec.ts	New Jest suite verifies level derivation, details parsing, userName/channelName fallback, and LOG_LEVEL_BY_TYPE mappings.

Estimated code review effort: 2 (Simple) | ~15 minutes

Sequence Diagram(s)

sequenceDiagram
  participant Client
  participant ManagementRoute
  participant ServerLogService
  participant Prisma

  Client->>ManagementRoute: GET /api/guilds/:guildId/logs
  ManagementRoute->>Prisma: fetch raw logs
  Prisma-->>ManagementRoute: raw log rows
  ManagementRoute->>ServerLogService: serializeServerLog(log) for each
  ServerLogService-->>ManagementRoute: SerializedServerLog
  ManagementRoute-->>Client: serialized logs response

Loading

Possibly related PRs

• LucasSantana-Dev/Lucky#613: Both PRs modify the same guild logs handler in packages/backend/src/routes/management.ts.

🚥 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 accurately summarizes the main change: serializing server logs for the dashboard with level, message, and actor fields.

✨ Finishing Touches

📝 Generate docstrings

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch fix/server-logs-serialize-level-message

---

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

[github-actions]

	Warnings
⚠️	User-facing change without a CHANGELOG.md update. Add a line under ## [Unreleased] if this should appear in release notes. (Or apply the skip-changelog label if this PR does not affect end users.)

Generated by 🚫 dangerJS against 4ffc6f5

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (1)

packages/shared/src/services/ServerLogService.ts (1)

41-67: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick win

Tighten LOG_LEVEL_BY_TYPE typing for compile-time exhaustiveness.

LOG_LEVEL_BY_TYPE is typed as Record<string, ServerLogLevel>, so adding a new LogType variant without updating this map won't be caught at compile time — it will silently fall back to 'info' at runtime. Using satisfies Record<LogType, ServerLogLevel> would catch missing mappings immediately.

♻️ Proposed refactor for compile-time exhaustiveness

-export const LOG_LEVEL_BY_TYPE: Record<string, ServerLogLevel> = {
+export const LOG_LEVEL_BY_TYPE = {
     message_delete: 'moderation',
     message_edit: 'moderation',
     member_join: 'info',
     member_leave: 'info',
     role_update: 'info',
     channel_update: 'system',
     voice_state: 'info',
     mod_action: 'moderation',
     mod_case_update: 'moderation',
     automod_trigger: 'automod',
     automod_settings: 'automod',
     custom_command: 'system',
     embed_template: 'system',
     auto_message: 'system',
     settings_change: 'system',
-}
+} satisfies Record<LogType, ServerLogLevel>

Note: with this change, indexing by an arbitrary string (e.g. log.type) will need a cast, e.g. LOG_LEVEL_BY_TYPE[log.type as LogType] ?? 'info', since the runtime ?? fallback still handles unknown values safely.

🤖 Prompt for 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.

In `@packages/shared/src/services/ServerLogService.ts` around lines 41 - 67,
`LOG_LEVEL_BY_TYPE` is too loosely typed with `Record<string, ServerLogLevel>`,
so new `LogType` values can be added without compile-time coverage. Update the
map in `ServerLogService` to use `satisfies Record<LogType, ServerLogLevel>` so
every `LogType` must be mapped, and adjust the lookup where `log.type` is used
to index the map by casting to `LogType` while keeping the existing `?? 'info'`
fallback for unknown runtime values.

🤖 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 `@packages/shared/src/services/ServerLogService.ts`:
- Around line 110-143: In serializeServerLog, the userName and channelName
fallbacks only handle null/undefined, so empty strings still render as blank
values. Update the fallback logic to treat empty strings as missing for
metadata.username and metadata.channelName, and then fall back to log.userId and
log.channelId respectively so the displayed actor/channel name is never blank.

---

Nitpick comments:
In `@packages/shared/src/services/ServerLogService.ts`:
- Around line 41-67: `LOG_LEVEL_BY_TYPE` is too loosely typed with
`Record<string, ServerLogLevel>`, so new `LogType` values can be added without
compile-time coverage. Update the map in `ServerLogService` to use `satisfies
Record<LogType, ServerLogLevel>` so every `LogType` must be mapped, and adjust
the lookup where `log.type` is used to index the map by casting to `LogType`
while keeping the existing `?? 'info'` fallback for unknown runtime values.

🪄 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: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: f02792f0-9924-41ea-a133-39510a5af544

📥 Commits

Reviewing files that changed from the base of the PR and between 62f5333 and 017ea4a.

📒 Files selected for processing (4)

• packages/backend/src/routes/management.ts
• packages/backend/tests/integration/routes/management.test.ts
• packages/shared/src/services/ServerLogService.spec.ts
• packages/shared/src/services/ServerLogService.ts

[cubic-dev-ai]

0 issues found across 1 file (changes from recent commits).

<sub>Auto-approved: Bug fix adding safe log serialization with fallbacks; well-tested and low risk.

Re-trigger cubic</sub>

[cubic-dev-ai]

0 issues found across 2 files (changes from recent commits).

<sub>Auto-approved: Adds data serialization for server logs to fix dashboard display. Safe, isolated change with comprehensive tests.

Re-trigger cubic</sub>

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
100.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud