Add solution providers #127

xepozz · 2024-07-18T09:34:11Z

Q	A
Is bugfix?	❌
New feature?	✔️
Breaks BC?	❌
Fixed issues	#108

vjik · 2024-08-05T06:12:10Z

Looks cool! But I suggest do it in separate package.

xepozz · 2024-10-14T16:47:18Z

Looks cool! But I suggest do it in separate package.

All the rest implementation, but it's base support for all of them

samdark · 2024-12-21T20:01:01Z

@xepozz what's missing here?

xepozz · 2024-12-22T11:04:54Z

I think I lost some files in the original codebase, some of them already moved to bridge for error handling 😁

samdark · 2024-12-23T07:23:48Z

Possible to update it?

codecov · 2024-12-24T19:37:21Z

Codecov Report

❌ Patch coverage is 12.50000% with 7 lines in your changes missing coverage. Please review.
✅ Project coverage is 79.76%. Comparing base (44f49fa) to head (3a8bcc7).
⚠️ Report is 3 commits behind head on master.

Files with missing lines	Patch %	Lines
src/Solution/FriendlyExceptionSolution.php	0.00%	4 Missing ⚠️
src/Renderer/HtmlRenderer.php	25.00%	3 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##             master     #127      +/-   ##
============================================
- Coverage     80.55%   79.76%   -0.80%     
- Complexity      210      213       +3     
============================================
  Files            19       20       +1     
  Lines           679      687       +8     
============================================
+ Hits            547      548       +1     
- Misses          132      139       +7

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

samdark

Looks good. Need a phpdoc for the interface + README + CHANGELOG. Would you please handle these?

src/Solution/SolutionProviderInterface.php

samdark · 2025-08-10T08:52:43Z

@xepozz would you please address static analysis issues? https://github.com/yiisoft/error-handler/actions/runs/16853615512/job/47743450768?pr=127

samdark · 2025-08-10T08:54:04Z

src/Solution/SolutionProviderInterface.php

+namespace Yiisoft\ErrorHandler\Solution;
+
+/**
+* The interface declares an adapter to render a solution for an event.


Suggested change

* The interface declares an adapter to render a solution for an event.

* Solution provider finds and renders a solution for a given throwable.

samdark · 2025-08-10T09:02:23Z

src/Solution/SolutionProviderInterface.php

+
+/**
+* The interface declares an adapter to render a solution for an event.
+* Basically, it renders the error message as-is, but possible could render a button with click-to-fix action that will be handled by an HTTP request (with middleware) back to server.


Suggested change

* Basically, it renders the error message as-is, but possible could render a button with click-to-fix action that will be handled by an HTTP request (with middleware) back to server.

* It may render the message as-is, but it could also provide a button with a click-to-fix action that will be handled by an async HTTP request (using a separate middleware).

samdark · 2025-08-10T09:03:02Z

src/Solution/FriendlyExceptionSolution.php

+
+use Yiisoft\FriendlyException\FriendlyExceptionInterface;
+
+final class FriendlyExceptionSolution implements SolutionProviderInterface


Suggested change

final class FriendlyExceptionSolution implements SolutionProviderInterface

/**

* Renders a friendly exception.

*/

final class FriendlyExceptionSolution implements SolutionProviderInterface

samdark · 2025-08-10T09:05:19Z

src/Solution/SolutionProviderInterface.php

+interface SolutionProviderInterface
+{
+    /**
+    * Returns true if the implementation may suggest more than regular provider.


Suggested change

* Returns true if the implementation may suggest more than regular provider.

* Returns true if solution could be provided for a given throwable.

samdark · 2025-08-10T09:05:45Z

src/Solution/SolutionProviderInterface.php

+    public function supports(\Throwable $e): bool;
+
+    /**
+    * Generates an HTML code with solution which will be clean by {@see \Yiisoft\ErrorHandler\Renderer\HtmlRenderer} and shown to the end user.


What do you mean by "clean by"?

HtmlRenderer has HTML purifier inside, it cleans all the given html tags and attributes except that are in configuration

vjik · 2025-08-10T17:28:44Z

src/Solution/SolutionProviderInterface.php

+* The interface declares an adapter to render a solution for an event.
+* Basically, it renders the error message as-is, but possible could render a button with click-to-fix action that will be handled by an HTTP request (with middleware) back to server.
+*/
+interface SolutionProviderInterface


SolutionProviderInterface must be placed into separate package. yiisoft/error-handler is too heavy dependency for packages, that implement SolutionProviderInterface.

It's not about any solution in the air. It's about the specific contract between web, user, application and error.
It shouldn't be separated. At least for now.

vjik · 2025-08-10T17:29:18Z

src/Solution/SolutionProviderInterface.php

+* The interface declares an adapter to render a solution for an event.
+* Basically, it renders the error message as-is, but possible could render a button with click-to-fix action that will be handled by an HTTP request (with middleware) back to server.
+*/
+interface SolutionProviderInterface


Interface should define format of solution. Users of interface should know about format of solution.

HTML for sure

samdark · 2025-08-10T18:42:37Z

@vjik noted that HTML doesn't suit console handler well. That is true.

xepozz · 2025-08-11T06:53:18Z

SolutionProvider's are in use only in the html renderer.

xepozz and others added 3 commits July 18, 2024 12:33

Add solution providers

f09026b

Move providers to config

85ec4f0

Apply fixes from StyleCI

884f7be

vjik added the status:under development Someone is working on a pull request. label Jul 22, 2024

xepozz added 3 commits August 4, 2024 20:03

Merge branch 'master' into solution

a2574a3

Allow form controls

b67993d

Merge remote-tracking branch 'origin/solution' into solution

a2b5afd

Merge branch 'master' into solution

5c2c4b0

xepozz self-assigned this Oct 14, 2024

xepozz added 2 commits December 21, 2024 15:40

Merge branch 'master' into solution

7c81988

fix test

6e2ceb2

xepozz changed the title ~~[WIP] Add solution providers~~ Add solution providers Dec 21, 2024

Merge branch 'master' into solution

b5e5ddf

xepozz and others added 7 commits July 28, 2025 12:41

Merge branch 'master' into solution

dd29662

Apply fixes from StyleCI

8bf9840

Apply Rector changes (CI)

ce78cfc

refactor: remove generator, pass providers directly

5d41ab0

Apply fixes from StyleCI

e904abf

Apply Rector changes (CI)

6371efe

Apply fixes from StyleCI

4d1259a

samdark reviewed Jul 29, 2025

View reviewed changes

src/Solution/SolutionProviderInterface.php Show resolved Hide resolved

vjik reviewed Aug 1, 2025

View reviewed changes

src/Solution/SolutionProviderInterface.php Show resolved Hide resolved

xepozz commented Aug 9, 2025

View reviewed changes

src/Solution/SolutionProviderInterface.php Show resolved Hide resolved

src/Solution/SolutionProviderInterface.php Show resolved Hide resolved

src/Solution/SolutionProviderInterface.php Show resolved Hide resolved

Apply suggestion from @xepozz

8cfee00

xepozz and others added 4 commits August 9, 2025 23:54

Apply suggestion from @xepozz

850326e

Apply suggestion from @xepozz

a45baf8

Apply fixes from StyleCI

ff4a1a0

Merge branch 'master' into solution

3a8bcc7

samdark requested changes Aug 10, 2025

View reviewed changes

vjik requested changes Aug 10, 2025

View reviewed changes

	* The interface declares an adapter to render a solution for an event.
	* Solution provider finds and renders a solution for a given throwable.

	* Basically, it renders the error message as-is, but possible could render a button with click-to-fix action that will be handled by an HTTP request (with middleware) back to server.
	* It may render the message as-is, but it could also provide a button with a click-to-fix action that will be handled by an async HTTP request (using a separate middleware).


		use Yiisoft\FriendlyException\FriendlyExceptionInterface;

		final class FriendlyExceptionSolution implements SolutionProviderInterface

	* Returns true if the implementation may suggest more than regular provider.
	* Returns true if solution could be provided for a given throwable.

Uh oh!

Add solution providers #127

Are you sure you want to change the base?

Add solution providers #127

Uh oh!

Conversation

xepozz commented Jul 18, 2024

Uh oh!

vjik commented Aug 5, 2024

Uh oh!

xepozz commented Oct 14, 2024

Uh oh!

samdark commented Dec 21, 2024

Uh oh!

xepozz commented Dec 22, 2024

Uh oh!

samdark commented Dec 23, 2024

Uh oh!

codecov bot commented Dec 24, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

samdark left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

samdark commented Aug 10, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

samdark commented Aug 10, 2025

Uh oh!

xepozz commented Aug 11, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

codecov bot commented Dec 24, 2024 •

edited

Loading