Skip to content

Fix #146: Move Target configuration to constructor parameters and deprecate the corresponding setters#146

Merged
samdark merged 8 commits into
yiisoft:masterfrom
WarLikeLaux:move-setters-to-constructor
Jun 7, 2026
Merged

Fix #146: Move Target configuration to constructor parameters and deprecate the corresponding setters#146
samdark merged 8 commits into
yiisoft:masterfrom
WarLikeLaux:move-setters-to-constructor

Conversation

@WarLikeLaux
Copy link
Copy Markdown
Contributor

@WarLikeLaux WarLikeLaux commented May 31, 2026

Q A
Is bugfix?
New feature? ✔️
Docs added? ✔️
Tests added? ✔️
Breaks BC?

What does this PR do?

Follow-up to #140. Move Target's configuration setters to constructor parameters and mark the setters as deprecated.

New constructor parameters on Target, forwarded by StreamTarget and PsrTarget:

  • $levels (already present)
  • $categories, $exceptCategories - category filters
  • $format, $prefix, $timestampFormat - formatting
  • $exportInterval - export batching
  • $enabled - enable/disable state

Deprecated (to be removed in 3.0), each replaced by the matching constructor parameter: setCategories(), setExcept(), setLevels(), setFormat(), setPrefix(), setExportInterval(), setTimestampFormat(), setEnabled().

Use cases

$target = new StreamTarget(
    levels: [LogLevel::ERROR],
    exceptCategories: ['Yiisoft\Db\*'],
    timestampFormat: 'Y-m-d H:i:s',
    exportInterval: 100,
);

No BC break: the setters keep working (deprecated only), and every constructor parameter is optional with the current default.

The internal Formatter gets the matching constructor parameters too. Its setters stay (not deprecated) because the deprecated Target setters delegate to them, and that delegation has to keep working until they are all removed in 3.0.

Summary by CodeRabbit

  • New Features

    • Logging targets now support complete configuration via constructor parameters. Setter methods (setCategories, setExcept, setLevels, setFormat, setPrefix, setExportInterval, setTimestampFormat, setEnabled) are deprecated since 2.2.2.
  • Documentation

    • Updated README and guides to demonstrate constructor-based configuration approach with examples.
  • Tests

    • Added comprehensive test coverage for constructor-based logging target configuration options.

@codecov
Copy link
Copy Markdown

codecov Bot commented May 31, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (1d415af) to head (b2b18f5).
⚠️ Report is 2 commits behind head on master.

Additional details and impacted files
@@             Coverage Diff             @@
##              master      #146   +/-   ##
===========================================
  Coverage     100.00%   100.00%           
- Complexity       163       165    +2     
===========================================
  Files             11        11           
  Lines            449       454    +5     
===========================================
+ Hits             449       454    +5     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@WarLikeLaux
Copy link
Copy Markdown
Contributor Author

@coderabbitai full review

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 31, 2026

✅ Actions performed

Full review triggered.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 31, 2026

Review Change Stack

📝 Walkthrough

Walkthrough

This PR enables immutable initialization of logging targets by moving configuration from setter methods to constructor parameters. Formatter gains a constructor, Target expands its constructor to accept all configuration options and marks eight legacy setters as deprecated, and StreamTarget/PsrTarget forward expanded parameters to the parent. Tests verify constructor behavior, and documentation reflects the migration.

Changes

Constructor-based Target configuration

Layer / File(s) Summary
Formatter constructor for initialization
src/Message/Formatter.php
Formatter gains a public constructor accepting optional format, prefix, and timestampFormat callables for initialization-time configuration.
Target constructor and setter deprecations
src/Target.php
Target constructor expands from levels-only to full configuration signature (categories, except, format, prefix, timestampFormat, exportInterval, enabled). Constructor initializes CategoryFilter and Formatter instances. All eight setter methods (setCategories, setExcept, setLevels, setFormat, setPrefix, setExportInterval, setTimestampFormat, setEnabled) marked deprecated in docblocks. New private assertLevelsAreValid() helper centralizes level validation.
StreamTarget and PsrTarget constructor forwarding
src/StreamTarget.php, src/PsrTarget.php
Both target implementations expand constructors with matching parameter signatures and forward all configuration parameters to parent Target constructor, replacing previous levels-only forwarding.
Test asset and constructor coverage
tests/TestAsset/DummyTarget.php, tests/TargetTest.php
DummyTarget extended to accept and forward all new constructor parameters. Seven new test methods verify constructor-provided configuration correctly affects message formatting, category/exception filtering, export intervals, and enabled state.
Documentation and changelog updates
CHANGELOG.md, README.md, docs/guide/ru/README.md
README example updated to use StreamTarget constructor exportInterval parameter with deprecation notice for related setters. Russian documentation updated identically. CHANGELOG records the feature in 2.2.2 under development.

🎯 3 (Moderate) | ⏱️ ~25 minutes

🐰 A rabbit's refrain upon this migration:
Constructor's call beats setter's way,
Parameters immute, no delay,
Configuration set from birth's first ray,
The deprecated setters fade away. 🎉

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 57.69% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The pull request title accurately summarizes the main change: moving Target configuration from setters to constructor parameters and deprecating the old setters.
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.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

@WarLikeLaux
Copy link
Copy Markdown
Contributor Author

@coderabbitai full review

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 31, 2026

✅ Actions performed

Full review triggered.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🤖 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 `@docs/guide/ru/README.md`:
- Around line 123-127: Remove the blank line(s) inside the blockquote so the
quoted lines about deprecated setters (the lines mentioning setExportInterval(),
setCategories(), setExcept(), setLevels(), setFormat(), setPrefix(),
setTimestampFormat(), setEnabled() and the note about export on shutdown) form a
single contiguous blockquote; edit the README.md blockquote so there are no
empty lines between the quoted lines (this will satisfy markdownlint
MD028/no-blanks-blockquote).

In `@README.md`:
- Around line 139-143: Remove the blank line inside the blockquote so
consecutive quoted lines are contiguous; specifically edit the block containing
the deprecation note for setExportInterval() and the related setters
(setCategories(), setExcept(), setLevels(), setFormat(), setPrefix(),
setTimestampFormat(), setEnabled()) and the following "Note: All message
flushing..." line so there is no empty line between those blockquote lines,
keeping each quoted line on its own line but without an intervening blank line.
🪄 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: bd9d39a9-b2b9-480a-829c-d9f141a4f07d

📥 Commits

Reviewing files that changed from the base of the PR and between e6aa6b8 and 685387a.

📒 Files selected for processing (9)
  • CHANGELOG.md
  • README.md
  • docs/guide/ru/README.md
  • src/Message/Formatter.php
  • src/PsrTarget.php
  • src/StreamTarget.php
  • src/Target.php
  • tests/TargetTest.php
  • tests/TestAsset/DummyTarget.php

Comment thread docs/guide/ru/README.md Outdated
Comment thread README.md Outdated
Comment thread src/Message/Formatter.php
Comment thread src/Target.php Outdated
Comment thread src/Target.php Outdated
Comment thread src/Target.php Outdated
Comment thread src/Target.php
@WarLikeLaux WarLikeLaux requested a review from vjik May 31, 2026 16:12
@vjik vjik requested a review from a team June 1, 2026 08:06
@vjik vjik added the status:code review The pull request needs review. label Jun 1, 2026
Comment thread src/Target.php Outdated
@WarLikeLaux WarLikeLaux requested a review from samdark June 1, 2026 18:09
@samdark samdark changed the title Move Target config to constructor params, deprecate setters Fix #146: Move Target configuration to constructor parameters and deprecate the corresponding setters Jun 7, 2026
@samdark samdark merged commit 2e385fb into yiisoft:master Jun 7, 2026
24 checks passed
@samdark
Copy link
Copy Markdown
Member

samdark commented Jun 7, 2026

👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

status:code review The pull request needs review.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants