13217692330

Committed 08 Feb 2025 05:13PM UTC coverage: 87.762% (+0.01%) from 87.749%

Build # 13217692330

Build Type

push

github

Committed by

web-flow

Commit Message

Merge pull request #290 from eliashaeussler/task/previous-exception

[TASK] Include previous exception in solution exception output

Run Details

6 of 8 new or added lines in 3 files covered. (75.0%)

839 of 956 relevant lines covered (87.76%)

2.38 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

32.14

/Classes/Middleware/SolutionMiddleware.php

<?php

declare(strict_types=1);

/*
 * This file is part of the TYPO3 CMS extension "solver".
 *
 * Copyright (C) 2023-2025 Elias Häußler <elias@haeussler.dev>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <https://www.gnu.org/licenses/>.
 */

namespace EliasHaeussler\Typo3Solver\Middleware;

use EliasHaeussler\SSE;
use EliasHaeussler\Typo3Solver\Authentication;
use EliasHaeussler\Typo3Solver\Cache;
use EliasHaeussler\Typo3Solver\Configuration;
use EliasHaeussler\Typo3Solver\Exception;
use EliasHaeussler\Typo3Solver\Formatter;
use EliasHaeussler\Typo3Solver\ProblemSolving;
use EliasHaeussler\Typo3Solver\Utility;
use Psr\Http\Message;
use Psr\Http\Server;
use TYPO3\CMS\Core;

/**
 * SolutionMiddleware
 *
 * @author Elias Häußler <elias@haeussler.dev>
 * @license GPL-2.0-or-later
 */
final class SolutionMiddleware implements Server\MiddlewareInterface
{
    public const ROUTE_PATH = '/tx_solver/solution';

    public function __construct(
        private readonly Configuration\Configuration $configuration,
        private readonly Cache\ExceptionsCache $exceptionsCache,
        private readonly Formatter\Message\ExceptionStreamFormatter $exceptionFormatter,
        private readonly Formatter\WebStreamFormatter $webFormatter,
        private readonly Authentication\StreamAuthentication $authentication,
    ) {}

    /**
     * @throws SSE\Exception\StreamIsActive
     * @throws SSE\Exception\StreamIsClosed
     * @throws SSE\Exception\StreamIsInactive
     * @throws \JsonException
     */
    public function process(
        Message\ServerRequestInterface $request,
        Server\RequestHandlerInterface $handler,
    ): Message\ResponseInterface {
        // Pass through request if it's not supported
        if (!$this->isRequestSupported($request)) {
            return $handler->handle($request);
        }

        // Create event stream
        $eventStream = SSE\Stream\SelfEmittingEventStream::create();
        $eventStream->open();

        try {
            // Get exception identifier and stream hash
            $hash = $request->getQueryParams()['hash'] ?? null;
            $id = $request->getQueryParams()['exception'] ?? null;

            // Throw exception if stream hash is invalid
            if (!\is_string($hash)) {
                throw Exception\AuthenticationFailureException::create();
            }

            // Authenticate with stream hash
            $this->authentication->authenticate($hash);

            // Throw exception if exception identifier is invalid
            if (!\is_string($id)) {
                throw Exception\UnrecoverableExceptionException::forMissingIdentifier();
            }

            // Restore exception
            $exception = $this->exceptionsCache->get($id);

            // Throw exception if original exception cannot be restored
            if ($exception === null) {
                throw Exception\UnrecoverableExceptionException::create($id);
            }

            // Create solver
            $solver = new ProblemSolving\Solver($this->configuration, $this->webFormatter);

            // Send solution stream
            foreach ($solver->solveStreamed($exception) as $solution) {
                $eventStream->sendMessage('solutionDelta', $solution);
            }
        } catch (\Throwable $exception) {
            $eventStream->sendMessage('solutionError', $this->exceptionFormatter->format($exception));
        } finally {
            $eventStream->close('solutionFinished');
        }

        return new Core\Http\Response();
    }

    private function isRequestSupported(Message\ServerRequestInterface $request): bool
    {
        if (!SSE\Stream\SelfEmittingEventStream::canHandle($request)) {
            return false;
        }

        return Utility\HttpUtility::uriMatchesRequest(self::ROUTE_PATH, $request);
    }
}

1	<?php
2
3	declare(strict_types=1);
4
5	/*
6	* This file is part of the TYPO3 CMS extension "solver".
7	*
8	* Copyright (C) 2023-2025 Elias Häußler <elias@haeussler.dev>
9	*
10	* This program is free software: you can redistribute it and/or modify
11	* it under the terms of the GNU General Public License as published by
12	* the Free Software Foundation, either version 2 of the License, or
13	* (at your option) any later version.
14	*
15	* This program is distributed in the hope that it will be useful,
16	* but WITHOUT ANY WARRANTY; without even the implied warranty of
17	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18	* GNU General Public License for more details.
19	*
20	* You should have received a copy of the GNU General Public License
21	* along with this program. If not, see <https://www.gnu.org/licenses/>.
22	*/
23
24	namespace EliasHaeussler\Typo3Solver\Middleware;
25
26	use EliasHaeussler\SSE;
27	use EliasHaeussler\Typo3Solver\Authentication;
28	use EliasHaeussler\Typo3Solver\Cache;
29	use EliasHaeussler\Typo3Solver\Configuration;
30	use EliasHaeussler\Typo3Solver\Exception;
31	use EliasHaeussler\Typo3Solver\Formatter;
32	use EliasHaeussler\Typo3Solver\ProblemSolving;
33	use EliasHaeussler\Typo3Solver\Utility;
34	use Psr\Http\Message;
35	use Psr\Http\Server;
36	use TYPO3\CMS\Core;
37
38	/**
39	* SolutionMiddleware
40	*
41	* @author Elias Häußler <elias@haeussler.dev>
42	* @license GPL-2.0-or-later
43	*/
44	final class SolutionMiddleware implements Server\MiddlewareInterface
45	{
46	public const ROUTE_PATH = '/tx_solver/solution';
47
48	public function __construct(	2✔
49	private readonly Configuration\Configuration $configuration,
50	private readonly Cache\ExceptionsCache $exceptionsCache,
51	private readonly Formatter\Message\ExceptionStreamFormatter $exceptionFormatter,
52	private readonly Formatter\WebStreamFormatter $webFormatter,
53	private readonly Authentication\StreamAuthentication $authentication,
54	) {}	2✔
55
56	/**
57	* @throws SSE\Exception\StreamIsActive
58	* @throws SSE\Exception\StreamIsClosed
59	* @throws SSE\Exception\StreamIsInactive
60	* @throws \JsonException
61	*/
62	public function process(	2✔
63	Message\ServerRequestInterface $request,
64	Server\RequestHandlerInterface $handler,
65	): Message\ResponseInterface {
66	// Pass through request if it's not supported
67	if (!$this->isRequestSupported($request)) {	2✔
68	return $handler->handle($request);	2✔
69	}
70
71	// Create event stream
72	$eventStream = SSE\Stream\SelfEmittingEventStream::create();	×
73	$eventStream->open();	×
74
75	try {
76	// Get exception identifier and stream hash
77	$hash = $request->getQueryParams()['hash'] ?? null;	×
78	$id = $request->getQueryParams()['exception'] ?? null;	×
79
80	// Throw exception if stream hash is invalid
81	if (!\is_string($hash)) {	×
82	throw Exception\AuthenticationFailureException::create();	×
83	}
84
85	// Authenticate with stream hash
86	$this->authentication->authenticate($hash);	×
87
88	// Throw exception if exception identifier is invalid
89	if (!\is_string($id)) {	×
90	throw Exception\UnrecoverableExceptionException::forMissingIdentifier();	×
91	}
92
93	// Restore exception
94	$exception = $this->exceptionsCache->get($id);	×
95
96	// Throw exception if original exception cannot be restored
97	if ($exception === null) {	×
98	throw Exception\UnrecoverableExceptionException::create($id);	×
99	}
100
101	// Create solver
102	$solver = new ProblemSolving\Solver($this->configuration, $this->webFormatter);	×
103
104	// Send solution stream
105	foreach ($solver->solveStreamed($exception) as $solution) {	×
106	$eventStream->sendMessage('solutionDelta', $solution);	×
107	}
NEW 108	} catch (\Throwable $exception) {	×
NEW 109	$eventStream->sendMessage('solutionError', $this->exceptionFormatter->format($exception));	×
110	} finally {
111	$eventStream->close('solutionFinished');	×
112	}
113
114	return new Core\Http\Response();	×
115	}
116
117	private function isRequestSupported(Message\ServerRequestInterface $request): bool	2✔
118	{
119	if (!SSE\Stream\SelfEmittingEventStream::canHandle($request)) {	2✔
120	return false;	1✔
121	}
122
123	return Utility\HttpUtility::uriMatchesRequest(self::ROUTE_PATH, $request);	1✔
124	}
125	}

eliashaeussler / typo3-solver / 13217692330

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous