Skip to content

chore: Strict log types#38296

Merged
kodiakhq[bot] merged 1 commit intodevelopfrom
chore/strict-logs
Jan 22, 2026
Merged

chore: Strict log types#38296
kodiakhq[bot] merged 1 commit intodevelopfrom
chore/strict-logs

Conversation

@KevLehman
Copy link
Member

@KevLehman KevLehman commented Jan 22, 2026

Proposed changes (including videos or screenshots)

Issue(s)

https://rocketchat.atlassian.net/browse/CORE-1715

Steps to test or reproduce

Further comments

The following signatures of logging are now not supported

logger.error(error)
logger.error(error, 'some message')
logger.error('some message', param1, param2)

(.error is the example, but it applies to all other log methods)

The following signatures are not recommended

logger.error(`Error ${err}`)

Althought there's no way to prevent that with types, please prefer the usage of the object format for those logs

logger.error({ err })

When logging errors, remember that the only property that would be properly stringified as an error is err. If you log an error with another name, like error, it would work, but won't print as you would expect

Summary by CodeRabbit

  • Refactor
    • All logging methods (log, debug, info, warn, error, etc.) now accept either an object or string parameter with a unified signature.
    • Removed custom logging hooks and simplified logger configuration.

✏️ Tip: You can customize this high-level summary in your review settings.

@dionisio-bot
Copy link
Contributor

dionisio-bot bot commented Jan 22, 2026

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

  • This PR is targeting the wrong base branch. It should target 8.2.0, but it targets 8.1.0

Please fix the issues and try again

If you have any trouble, please check the PR guidelines

@changeset-bot
Copy link

changeset-bot bot commented Jan 22, 2026

⚠️ No Changeset found

Latest commit: fcdc3c1

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 22, 2026

Walkthrough

The PR removes custom logMethod augmentation from Pino configuration and simplifies Logger class method signatures. Nine logging methods (log, debug, info, startup, success, warn, error, method, subscription) transition from multiple overloads handling variadic arguments to single signatures accepting object | string parameters, eliminating special multi-argument handling while preserving functionality.

Changes

Cohort / File(s) Summary
Pino Configuration
packages/logger/src/getPino.ts
Removed custom logMethod hook and related multi-argument formatting logic from Pino configuration; preserved log levels and environment-based transports
Logger API Simplification
packages/logger/src/index.ts
Consolidated 9 logger method signatures (log, debug, info, startup, success, warn, error, method, subscription) from multiple overloads to single signatures accepting object | string parameter; removed generic/unknown overloads and variadic argument handling

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested labels

stat: ready to merge, stat: QA assured

Suggested reviewers

  • pierre-lehnen-rc
  • ricardogarim
  • d-gubert

Poem

🐰 A logger stripped of tangled threads,
Now speaks in clean and simple spreads,
One message in, no fuss nor frills,
The Pino pipes flow as it wills!
✨ Simplicity wins again, my friend!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'chore: Strict log types' accurately describes the main change, which simplifies logging method signatures to enforce stricter typing by removing variadic arguments and custom logMethod hooks.
Linked Issues check ✅ Passed The PR implements stricter typing for logging APIs as indicated by CORE-1715, removing support for variadic arguments and enforcing object|string parameter types across all logging methods.
Out of Scope Changes check ✅ Passed All changes are directly related to enforcing stricter log types: removing custom logMethod augmentation and simplifying method signatures to accept only object|string parameters.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch chore/strict-logs

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

Comment @coderabbitai help to get the list of available commands and usage tips.

@codecov
Copy link

codecov bot commented Jan 22, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 70.77%. Comparing base (150f662) to head (fcdc3c1).
⚠️ Report is 1 commits behind head on develop.

Additional details and impacted files

Impacted file tree graph

@@             Coverage Diff             @@
##           develop   #38296      +/-   ##
===========================================
- Coverage    70.79%   70.77%   -0.02%     
===========================================
  Files         3158     3158              
  Lines       109355   109355              
  Branches     19680    19650      -30     
===========================================
- Hits         77414    77400      -14     
- Misses       29912    29922      +10     
- Partials      2029     2033       +4     
Flag Coverage Δ
e2e 60.30% <ø> (-0.05%) ⬇️
e2e-api 48.10% <ø> (ø)
unit 71.91% <ø> (ø)

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.

@KevLehman KevLehman marked this pull request as ready for review January 22, 2026 18:49
@KevLehman KevLehman added this to the 8.2.0 milestone Jan 22, 2026
@github-actions
Copy link
Contributor

📦 Docker Image Size Report

➡️ Changes

Service Current Baseline Change Percent
sum of all images 0B 0B 0B
account-service 0B 0B 0B
authorization-service 0B 0B 0B
ddp-streamer-service 0B 0B 0B
omnichannel-transcript-service 0B 0B 0B
presence-service 0B 0B 0B
queue-worker-service 0B 0B 0B
rocketchat 0B 0B 0B

📊 Historical Trend

---
config:
  theme: "dark"
  xyChart:
    width: 900
    height: 400
---
xychart
  title "Image Size Evolution by Service (Last 30 Days + This PR)"
  x-axis ["11/18 22:53", "11/19 23:02", "11/21 16:49", "11/24 17:34", "11/27 22:32", "11/28 19:05", "12/01 23:01", "12/02 21:57", "12/03 21:00", "12/04 18:17", "12/05 21:56", "12/08 20:15", "12/09 22:17", "12/10 23:26", "12/11 21:56", "12/12 22:45", "12/13 01:34", "12/15 22:31", "12/16 22:18", "12/17 21:04", "12/18 23:12", "12/19 23:27", "12/20 21:03", "12/22 18:54", "12/23 16:16", "12/24 19:38", "12/25 17:51", "12/26 13:18", "12/29 19:01", "12/30 20:52", "01/22 18:55 (PR)"]
  y-axis "Size (GB)" 0 --> 0.5
  line "account-service" [0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.00]
  line "authorization-service" [0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.00]
  line "ddp-streamer-service" [0.12, 0.12, 0.12, 0.12, 0.12, 0.12, 0.12, 0.12, 0.12, 0.12, 0.12, 0.12, 0.12, 0.12, 0.12, 0.12, 0.12, 0.12, 0.12, 0.12, 0.12, 0.12, 0.12, 0.12, 0.12, 0.12, 0.12, 0.12, 0.12, 0.12, 0.00]
  line "omnichannel-transcript-service" [0.14, 0.14, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.00]
  line "presence-service" [0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.11, 0.00]
  line "queue-worker-service" [0.14, 0.14, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.00]
  line "rocketchat" [0.35, 0.35, 0.34, 0.34, 0.34, 0.34, 0.34, 0.34, 0.34, 0.34, 0.34, 0.34, 0.34, 0.34, 0.34, 0.34, 0.34, 0.34, 0.34, 0.34, 0.34, 0.34, 0.34, 0.34, 0.34, 0.34, 0.34, 0.34, 0.34, 0.34, 0.00]
Loading

Statistics (last 30 days):

  • 📊 Average: 1.5GiB
  • ⬇️ Minimum: 1.4GiB
  • ⬆️ Maximum: 1.6GiB
  • 🎯 Current PR: 0B
ℹ️ About this report

This report compares Docker image sizes from this build against the develop baseline.

  • Tag: pr-38296
  • Baseline: develop
  • Timestamp: 2026-01-22 18:55:06 UTC
  • Historical data points: 30

Updated: Thu, 22 Jan 2026 18:55:06 GMT

@KevLehman KevLehman added the stat: QA assured Means it has been tested and approved by a company insider label Jan 22, 2026
@dionisio-bot dionisio-bot bot added the stat: ready to merge PR tested and approved waiting for merge label Jan 22, 2026
Copy link
Contributor

@cubic-dev-ai cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 2 files

@kodiakhq kodiakhq bot merged commit e22b852 into develop Jan 22, 2026
48 checks passed
@kodiakhq kodiakhq bot deleted the chore/strict-logs branch January 22, 2026 21:32
Kaustubh1204 pushed a commit to Kaustubh1204/Rocket.Chat that referenced this pull request Jan 22, 2026
Rohit3523 pushed a commit that referenced this pull request Feb 4, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

stat: QA assured Means it has been tested and approved by a company insider stat: ready to merge PR tested and approved waiting for merge

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants