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

@WarLikeLauxWarLikeLaux commented May 31, 2026

Copy link
Copy Markdown
Contributor
QA
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 = newStreamTarget(
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

codecovBot commented May 31, 2026

Copy link
Copy Markdown

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
ContributorAuthor

@coderabbitai full review

@coderabbitai

Copy link
Copy Markdown
✅ Actions performed

Full review triggered.

@coderabbitai

coderabbitaiBot commented May 31, 2026

Copy link
Copy Markdown

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 nameStatusExplanationResolution
Docstring Coverage⚠️ WarningDocstring 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 nameStatusExplanation
Title check✅ PassedThe pull request title accurately summarizes the main change: moving Target configuration from setters to constructor parameters and deprecating the old setters.
Linked Issues check✅ PassedCheck skipped because no linked issues were found for this pull request.
Out of Scope Changes check✅ PassedCheck skipped because no linked issues were found for this pull request.
Description Check✅ PassedCheck 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
ContributorAuthor

@coderabbitai full review

@coderabbitai

Copy link
Copy Markdown
✅ Actions performed

Full review triggered.

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown

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 threaddocs/guide/ru/README.md Outdated
Comment threadREADME.md Outdated
Comment threadsrc/Message/Formatter.php
Comment threadsrc/Target.php Outdated
Comment threadsrc/Target.php Outdated
Comment threadsrc/Target.php Outdated
Comment threadsrc/Target.php
@WarLikeLaux
WarLikeLaux requested a review from vjikMay 31, 2026 16:12
vjik
vjik approved these changes Jun 1, 2026
@vjik
vjik requested a review from a teamJune 1, 2026 08:06
@vjikvjik added the status:code review The pull request needs review. label Jun 1, 2026
Comment threadsrc/Target.php Outdated
@WarLikeLaux
WarLikeLaux requested a review from samdarkJune 1, 2026 18:09
@samdarksamdark changed the title Move Target config to constructor params, deprecate settersFix #146: Move Target configuration to constructor parameters and deprecate the corresponding settersJun 7, 2026
@samdark
samdark merged commit 2e385fb into yiisoft:masterJun 7, 2026
24 checks passed
@samdark

Copy link
Copy Markdown
Member

👍

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

Labels

status:code reviewThe pull request needs review.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@WarLikeLaux@samdark@vjik
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
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

@WarLikeLauxWarLikeLaux commented May 31, 2026

Copy link
Copy Markdown
Contributor
QA
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 = newStreamTarget(
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

codecovBot commented May 31, 2026

Copy link
Copy Markdown

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
ContributorAuthor

@coderabbitai full review

@coderabbitai

Copy link
Copy Markdown
✅ Actions performed

Full review triggered.

@coderabbitai

coderabbitaiBot commented May 31, 2026

Copy link
Copy Markdown

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 nameStatusExplanationResolution
Docstring Coverage⚠️ WarningDocstring 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 nameStatusExplanation
Title check✅ PassedThe pull request title accurately summarizes the main change: moving Target configuration from setters to constructor parameters and deprecating the old setters.
Linked Issues check✅ PassedCheck skipped because no linked issues were found for this pull request.
Out of Scope Changes check✅ PassedCheck skipped because no linked issues were found for this pull request.
Description Check✅ PassedCheck 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
ContributorAuthor

@coderabbitai full review

@coderabbitai

Copy link
Copy Markdown
✅ Actions performed

Full review triggered.

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown

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 threaddocs/guide/ru/README.md Outdated
Comment threadREADME.md Outdated
Comment threadsrc/Message/Formatter.php
Comment threadsrc/Target.php Outdated
Comment threadsrc/Target.php Outdated
Comment threadsrc/Target.php Outdated
Comment threadsrc/Target.php
@WarLikeLaux
WarLikeLaux requested a review from vjikMay 31, 2026 16:12
vjik
vjik approved these changes Jun 1, 2026
@vjik
vjik requested a review from a teamJune 1, 2026 08:06
@vjikvjik added the status:code review The pull request needs review. label Jun 1, 2026
Comment threadsrc/Target.php Outdated
@WarLikeLaux
WarLikeLaux requested a review from samdarkJune 1, 2026 18:09
@samdarksamdark changed the title Move Target config to constructor params, deprecate settersFix #146: Move Target configuration to constructor parameters and deprecate the corresponding settersJun 7, 2026
@samdark
samdark merged commit 2e385fb into yiisoft:masterJun 7, 2026
24 checks passed
@samdark

Copy link
Copy Markdown
Member

👍

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

Labels

status:code reviewThe pull request needs review.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@WarLikeLaux@samdark@vjik
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
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

@WarLikeLauxWarLikeLaux commented May 31, 2026

Copy link
Copy Markdown
Contributor
QA
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 = newStreamTarget(
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

codecovBot commented May 31, 2026

Copy link
Copy Markdown

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
ContributorAuthor

@coderabbitai full review

@coderabbitai

Copy link
Copy Markdown
✅ Actions performed

Full review triggered.

@coderabbitai

coderabbitaiBot commented May 31, 2026

Copy link
Copy Markdown

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 nameStatusExplanationResolution
Docstring Coverage⚠️ WarningDocstring 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 nameStatusExplanation
Title check✅ PassedThe pull request title accurately summarizes the main change: moving Target configuration from setters to constructor parameters and deprecating the old setters.
Linked Issues check✅ PassedCheck skipped because no linked issues were found for this pull request.
Out of Scope Changes check✅ PassedCheck skipped because no linked issues were found for this pull request.
Description Check✅ PassedCheck 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
ContributorAuthor

@coderabbitai full review

@coderabbitai

Copy link
Copy Markdown
✅ Actions performed

Full review triggered.

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown

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 threaddocs/guide/ru/README.md Outdated
Comment threadREADME.md Outdated
Comment threadsrc/Message/Formatter.php
Comment threadsrc/Target.php Outdated
Comment threadsrc/Target.php Outdated
Comment threadsrc/Target.php Outdated
Comment threadsrc/Target.php
@WarLikeLaux
WarLikeLaux requested a review from vjikMay 31, 2026 16:12
vjik
vjik approved these changes Jun 1, 2026
@vjik
vjik requested a review from a teamJune 1, 2026 08:06
@vjikvjik added the status:code review The pull request needs review. label Jun 1, 2026
Comment threadsrc/Target.php Outdated
@WarLikeLaux
WarLikeLaux requested a review from samdarkJune 1, 2026 18:09
@samdarksamdark changed the title Move Target config to constructor params, deprecate settersFix #146: Move Target configuration to constructor parameters and deprecate the corresponding settersJun 7, 2026
@samdark
samdark merged commit 2e385fb into yiisoft:masterJun 7, 2026
24 checks passed
@samdark

Copy link
Copy Markdown
Member

👍

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

Labels

status:code reviewThe pull request needs review.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@WarLikeLaux@samdark@vjik
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
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

@WarLikeLauxWarLikeLaux commented May 31, 2026

Copy link
Copy Markdown
Contributor
QA
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 = newStreamTarget(
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

codecovBot commented May 31, 2026

Copy link
Copy Markdown

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
ContributorAuthor

@coderabbitai full review

@coderabbitai

Copy link
Copy Markdown
✅ Actions performed

Full review triggered.

@coderabbitai

coderabbitaiBot commented May 31, 2026

Copy link
Copy Markdown

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 nameStatusExplanationResolution
Docstring Coverage⚠️ WarningDocstring 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 nameStatusExplanation
Title check✅ PassedThe pull request title accurately summarizes the main change: moving Target configuration from setters to constructor parameters and deprecating the old setters.
Linked Issues check✅ PassedCheck skipped because no linked issues were found for this pull request.
Out of Scope Changes check✅ PassedCheck skipped because no linked issues were found for this pull request.
Description Check✅ PassedCheck 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
ContributorAuthor

@coderabbitai full review

@coderabbitai

Copy link
Copy Markdown
✅ Actions performed

Full review triggered.

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown

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 threaddocs/guide/ru/README.md Outdated
Comment threadREADME.md Outdated
Comment threadsrc/Message/Formatter.php
Comment threadsrc/Target.php Outdated
Comment threadsrc/Target.php Outdated
Comment threadsrc/Target.php Outdated
Comment threadsrc/Target.php
@WarLikeLaux
WarLikeLaux requested a review from vjikMay 31, 2026 16:12
vjik
vjik approved these changes Jun 1, 2026
@vjik
vjik requested a review from a teamJune 1, 2026 08:06
@vjikvjik added the status:code review The pull request needs review. label Jun 1, 2026
Comment threadsrc/Target.php Outdated
@WarLikeLaux
WarLikeLaux requested a review from samdarkJune 1, 2026 18:09
@samdarksamdark changed the title Move Target config to constructor params, deprecate settersFix #146: Move Target configuration to constructor parameters and deprecate the corresponding settersJun 7, 2026
@samdark
samdark merged commit 2e385fb into yiisoft:masterJun 7, 2026
24 checks passed
@samdark

Copy link
Copy Markdown
Member

👍

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

Labels

status:code reviewThe pull request needs review.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@WarLikeLaux@samdark@vjik
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
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

@WarLikeLauxWarLikeLaux commented May 31, 2026

Copy link
Copy Markdown
Contributor
QA
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 = newStreamTarget(
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

codecovBot commented May 31, 2026

Copy link
Copy Markdown

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
ContributorAuthor

@coderabbitai full review

@coderabbitai

Copy link
Copy Markdown
✅ Actions performed

Full review triggered.

@coderabbitai

coderabbitaiBot commented May 31, 2026

Copy link
Copy Markdown

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 nameStatusExplanationResolution
Docstring Coverage⚠️ WarningDocstring 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 nameStatusExplanation
Title check✅ PassedThe pull request title accurately summarizes the main change: moving Target configuration from setters to constructor parameters and deprecating the old setters.
Linked Issues check✅ PassedCheck skipped because no linked issues were found for this pull request.
Out of Scope Changes check✅ PassedCheck skipped because no linked issues were found for this pull request.
Description Check✅ PassedCheck 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
ContributorAuthor

@coderabbitai full review

@coderabbitai

Copy link
Copy Markdown
✅ Actions performed

Full review triggered.

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown

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 threaddocs/guide/ru/README.md Outdated
Comment threadREADME.md Outdated
Comment threadsrc/Message/Formatter.php
Comment threadsrc/Target.php Outdated
Comment threadsrc/Target.php Outdated
Comment threadsrc/Target.php Outdated
Comment threadsrc/Target.php
@WarLikeLaux
WarLikeLaux requested a review from vjikMay 31, 2026 16:12
vjik
vjik approved these changes Jun 1, 2026
@vjik
vjik requested a review from a teamJune 1, 2026 08:06
@vjikvjik added the status:code review The pull request needs review. label Jun 1, 2026
Comment threadsrc/Target.php Outdated
@WarLikeLaux
WarLikeLaux requested a review from samdarkJune 1, 2026 18:09
@samdarksamdark changed the title Move Target config to constructor params, deprecate settersFix #146: Move Target configuration to constructor parameters and deprecate the corresponding settersJun 7, 2026
@samdark
samdark merged commit 2e385fb into yiisoft:masterJun 7, 2026
24 checks passed
@samdark

Copy link
Copy Markdown
Member

👍

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

Labels

status:code reviewThe pull request needs review.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@WarLikeLaux@samdark@vjik
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
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

@WarLikeLauxWarLikeLaux commented May 31, 2026

Copy link
Copy Markdown
Contributor
QA
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 = newStreamTarget(
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

codecovBot commented May 31, 2026

Copy link
Copy Markdown

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
ContributorAuthor

@coderabbitai full review

@coderabbitai

Copy link
Copy Markdown
✅ Actions performed

Full review triggered.

@coderabbitai

coderabbitaiBot commented May 31, 2026

Copy link
Copy Markdown

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 nameStatusExplanationResolution
Docstring Coverage⚠️ WarningDocstring 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 nameStatusExplanation
Title check✅ PassedThe pull request title accurately summarizes the main change: moving Target configuration from setters to constructor parameters and deprecating the old setters.
Linked Issues check✅ PassedCheck skipped because no linked issues were found for this pull request.
Out of Scope Changes check✅ PassedCheck skipped because no linked issues were found for this pull request.
Description Check✅ PassedCheck 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
ContributorAuthor

@coderabbitai full review

@coderabbitai

Copy link
Copy Markdown
✅ Actions performed

Full review triggered.

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown

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 threaddocs/guide/ru/README.md Outdated
Comment threadREADME.md Outdated
Comment threadsrc/Message/Formatter.php
Comment threadsrc/Target.php Outdated
Comment threadsrc/Target.php Outdated
Comment threadsrc/Target.php Outdated
Comment threadsrc/Target.php
@WarLikeLaux
WarLikeLaux requested a review from vjikMay 31, 2026 16:12
vjik
vjik approved these changes Jun 1, 2026
@vjik
vjik requested a review from a teamJune 1, 2026 08:06
@vjikvjik added the status:code review The pull request needs review. label Jun 1, 2026
Comment threadsrc/Target.php Outdated
@WarLikeLaux
WarLikeLaux requested a review from samdarkJune 1, 2026 18:09
@samdarksamdark changed the title Move Target config to constructor params, deprecate settersFix #146: Move Target configuration to constructor parameters and deprecate the corresponding settersJun 7, 2026
@samdark
samdark merged commit 2e385fb into yiisoft:masterJun 7, 2026
24 checks passed
@samdark

Copy link
Copy Markdown
Member

👍

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

Labels

status:code reviewThe pull request needs review.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@WarLikeLaux@samdark@vjik
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
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

@WarLikeLauxWarLikeLaux commented May 31, 2026

Copy link
Copy Markdown
Contributor
QA
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 = newStreamTarget(
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

codecovBot commented May 31, 2026

Copy link
Copy Markdown

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
ContributorAuthor

@coderabbitai full review

@coderabbitai

Copy link
Copy Markdown
✅ Actions performed

Full review triggered.

@coderabbitai

coderabbitaiBot commented May 31, 2026

Copy link
Copy Markdown

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 nameStatusExplanationResolution
Docstring Coverage⚠️ WarningDocstring 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 nameStatusExplanation
Title check✅ PassedThe pull request title accurately summarizes the main change: moving Target configuration from setters to constructor parameters and deprecating the old setters.
Linked Issues check✅ PassedCheck skipped because no linked issues were found for this pull request.
Out of Scope Changes check✅ PassedCheck skipped because no linked issues were found for this pull request.
Description Check✅ PassedCheck 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
ContributorAuthor

@coderabbitai full review

@coderabbitai

Copy link
Copy Markdown
✅ Actions performed

Full review triggered.

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown

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 threaddocs/guide/ru/README.md Outdated
Comment threadREADME.md Outdated
Comment threadsrc/Message/Formatter.php
Comment threadsrc/Target.php Outdated
Comment threadsrc/Target.php Outdated
Comment threadsrc/Target.php Outdated
Comment threadsrc/Target.php
@WarLikeLaux
WarLikeLaux requested a review from vjikMay 31, 2026 16:12
vjik
vjik approved these changes Jun 1, 2026
@vjik
vjik requested a review from a teamJune 1, 2026 08:06
@vjikvjik added the status:code review The pull request needs review. label Jun 1, 2026
Comment threadsrc/Target.php Outdated
@WarLikeLaux
WarLikeLaux requested a review from samdarkJune 1, 2026 18:09
@samdarksamdark changed the title Move Target config to constructor params, deprecate settersFix #146: Move Target configuration to constructor parameters and deprecate the corresponding settersJun 7, 2026
@samdark
samdark merged commit 2e385fb into yiisoft:masterJun 7, 2026
24 checks passed
@samdark

Copy link
Copy Markdown
Member

👍

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

Labels

status:code reviewThe pull request needs review.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@WarLikeLaux@samdark@vjik
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
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

@WarLikeLauxWarLikeLaux commented May 31, 2026

Copy link
Copy Markdown
Contributor
QA
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 = newStreamTarget(
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

codecovBot commented May 31, 2026

Copy link
Copy Markdown

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
ContributorAuthor

@coderabbitai full review

@coderabbitai

Copy link
Copy Markdown
✅ Actions performed

Full review triggered.

@coderabbitai

coderabbitaiBot commented May 31, 2026

Copy link
Copy Markdown

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 nameStatusExplanationResolution
Docstring Coverage⚠️ WarningDocstring 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 nameStatusExplanation
Title check✅ PassedThe pull request title accurately summarizes the main change: moving Target configuration from setters to constructor parameters and deprecating the old setters.
Linked Issues check✅ PassedCheck skipped because no linked issues were found for this pull request.
Out of Scope Changes check✅ PassedCheck skipped because no linked issues were found for this pull request.
Description Check✅ PassedCheck 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
ContributorAuthor

@coderabbitai full review

@coderabbitai

Copy link
Copy Markdown
✅ Actions performed

Full review triggered.

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown

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 threaddocs/guide/ru/README.md Outdated
Comment threadREADME.md Outdated
Comment threadsrc/Message/Formatter.php
Comment threadsrc/Target.php Outdated
Comment threadsrc/Target.php Outdated
Comment threadsrc/Target.php Outdated
Comment threadsrc/Target.php
@WarLikeLaux
WarLikeLaux requested a review from vjikMay 31, 2026 16:12
vjik
vjik approved these changes Jun 1, 2026
@vjik
vjik requested a review from a teamJune 1, 2026 08:06
@vjikvjik added the status:code review The pull request needs review. label Jun 1, 2026
Comment threadsrc/Target.php Outdated
@WarLikeLaux
WarLikeLaux requested a review from samdarkJune 1, 2026 18:09
@samdarksamdark changed the title Move Target config to constructor params, deprecate settersFix #146: Move Target configuration to constructor parameters and deprecate the corresponding settersJun 7, 2026
@samdark
samdark merged commit 2e385fb into yiisoft:masterJun 7, 2026
24 checks passed
@samdark

Copy link
Copy Markdown
Member

👍

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

Labels

status:code reviewThe pull request needs review.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@WarLikeLaux@samdark@vjik