Skip to content

[Draft] Adapt yii3 #533

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 3 commits into
base: master
Choose a base branch
from
Draft

[Draft] Adapt yii3 #533

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7e93b17
adapt yii3 debugger
xepozz Mar 3, 2025
6ec3320
adopt yii3 debugger more
xepozz Mar 3, 2025
ce67bd8
Merge branch 'master' into adapt-yii3
xepozz Mar 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,13 +30,18 @@
"require": {
"php": ">=5.4",
"ext-mbstring": "*",
"yiisoft/yii2": "~2.0.13"
"yiisoft/yii2": "~2.0.13",
"samdark/yii2-psr-log-target": "dev-master",
"yiisoft/yii-http": "dev-master"
},
"require-dev": {
"yiisoft/yii2-swiftmailer": "*",
"yiisoft/yii2-coding-standards": "~2.0",
"cweagans/composer-patches": "^1.7",
"phpunit/phpunit": "4.8.34"
"phpunit/phpunit": "4.8.34",
"yiisoft/yii-debug": "dev-master",
"yiisoft/router-fastroute": "^3.0",
"yiisoft/yii-debug-api": "dev-master"
},
"autoload": {
"psr-4": {
Expand Down Expand Up @@ -73,7 +78,8 @@
"config": {
"allow-plugins": {
"cweagans/composer-patches": true,
"yiisoft/yii2-composer": true
"yiisoft/yii2-composer": true,
"yiisoft/config": false
}
}
}
10 changes: 5 additions & 5 deletions src/LogTarget.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ public function __construct($module, $config = [])
{
parent::__construct($config);
$this->module = $module;
$this->tag = uniqid();
//$this->tag = uniqid();
}

/**
Expand All @@ -53,7 +53,7 @@ public function export()
FileHelper::createDirectory($path, $this->module->dirMode);

$summary = $this->collectSummary();
$dataFile = "$path/{$this->tag}.data";
$dataFile = "$path/{$this->module->debugger->getId()}.data";
$data = [];
$exceptions = [];
foreach ($this->module->panels as $id => $panel) {
Expand Down Expand Up @@ -115,7 +115,7 @@ public function loadTagToPanels($tag)
$exceptions = $data['exceptions'];
foreach ($this->module->panels as $id => $panel) {
if (isset($data[$id])) {
$panel->tag = $tag;
$panel->tag = $this->module->debugger->getId();
$panel->load(unserialize($data[$id]));
} else {
unset($this->module->panels[$id]);
Expand Down Expand Up @@ -152,7 +152,7 @@ private function updateIndexFile($indexFile, $summary)
$manifest = unserialize($manifest);
}

$manifest[$this->tag] = $summary;
$manifest[$this->module->debugger->getId()] = $summary;
$this->gc($manifest);

ftruncate($fp, 0);
Expand Down Expand Up @@ -245,7 +245,7 @@ protected function collectSummary()
$request = Yii::$app->getRequest();
$response = Yii::$app->getResponse();
$summary = [
'tag' => $this->tag,
'tag' => $this->module->debugger->getId(),
'url' => $request instanceof yii\console\Request ? "php yii " . implode(' ', $request->getParams()): $request->getAbsoluteUrl(),
'ajax' => $request instanceof yii\console\Request ? 0 : (int) $request->getIsAjax(),
'method' => $request instanceof yii\console\Request ? 'COMMAND' : $request->getMethod(),
Expand Down
155 changes: 137 additions & 18 deletions src/Module.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,42 @@

namespace yii\debug;

use HttpSoft\Message\ServerRequest;
use HttpSoft\Message\Stream;
use HttpSoft\Message\Uri;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Log\NullLogger;
use samdark\log\PsrTarget;
use stdClass;
use Symfony\Component\Console\Event\ConsoleEvent;
use Yii;
use yii\base\Application;
use yii\base\BootstrapInterface;
use yii\base\Event;
use yii\helpers\Html;
use yii\helpers\IpHelper;
use yii\helpers\Json;
use yii\helpers\Url;
use yii\log\Target;
use yii\web\ForbiddenHttpException;
use yii\web\Request;
use yii\web\Response;
use yii\web\View;
use Yiisoft\VarDumper\VarDumper;
use Yiisoft\Yii\Debug\Collector\Console\CommandCollector;
use Yiisoft\Yii\Debug\Collector\LogCollector;
use Yiisoft\Yii\Debug\Collector\LoggerInterfaceProxy;
use Yiisoft\Yii\Debug\Collector\TimelineCollector;
use Yiisoft\Yii\Debug\Collector\VarDumperCollector;
use Yiisoft\Yii\Debug\Collector\VarDumperHandlerInterfaceProxy;
use Yiisoft\Yii\Debug\Collector\Web\RequestCollector;
use Yiisoft\Yii\Debug\Collector\Web\WebAppInfoCollector;
use Yiisoft\Yii\Debug\Debugger;
use Yiisoft\Yii\Debug\Storage\FileStorage;
use Yiisoft\Yii\Debug\Storage\StorageInterface;
use Yiisoft\Yii\Http\Event\AfterRequest;
use Yiisoft\Yii\Http\Event\BeforeRequest;

/**
* The Yii Debug Module provides the debug toolbar and debugger
Expand Down Expand Up @@ -50,7 +76,8 @@ class Module extends \yii\base\Module implements BootstrapInterface
*
* The signature is the following:
*
* function (Action|null $action) The action can be null when called from a non action context (like set debug header)
* function (Action|null $action) The action can be null when called from a non action context (like set debug
* header)
*
* @since 2.1.0
*/
Expand All @@ -63,12 +90,14 @@ class Module extends \yii\base\Module implements BootstrapInterface
* @var LogTarget|array|string the logTarget object, or the configuration for creating the logTarget object.
*/
public $logTarget = 'yii\debug\LogTarget';

/**
* @var \yii\rbac\BaseManager|string|array the RBAC access checker [[BaseManager]] object or the application
* component ID of the AuthManager [[BaseManager]].
* @since 2.1.19
*/
public $authManager = 'authManager';

/**
* @var array|Panel[] list of debug panels. The array keys are the panel IDs, and values are the corresponding
* panel class names or configuration arrays. This will be merged with [[corePanels()]].
Expand Down Expand Up @@ -134,8 +163,8 @@ class Module extends \yii\base\Module implements BootstrapInterface
*/
public $disableCallbackRestrictionWarning = false;
/**
* @var mixed the string with placeholders to be be substituted or an anonymous function that returns the trace line string.
* The placeholders are {file}, {line} and {text} and the string should be as follows:
* @var mixed the string with placeholders to be be substituted or an anonymous function that returns the trace
* line string. The placeholders are {file}, {line} and {text} and the string should be as follows:
*
* `File: {file} - Line: {line} - Text: {text}`
*
Expand Down Expand Up @@ -205,6 +234,9 @@ class Module extends \yii\base\Module implements BootstrapInterface
*/
public $skipAjaxRequestUrl = [];


public Debugger|null $debugger = null;

/**
* Returns the logo URL to be used in `<img src="`
*
Expand Down Expand Up @@ -274,23 +306,63 @@ protected function initPanels()
*/
public function bootstrap($app)
{
if (is_array($this->logTarget)) {
if (!isset($this->logTarget['class'])) {
$this->logTarget['class'] = 'yii\debug\LogTarget';
}
$this->logTarget = Yii::createObject($this->logTarget, [$this]);
} elseif (is_string($this->logTarget)) {
$this->logTarget = Yii::createObject($this->logTarget, [$this]);
// temporary disable debug for console
if ($app instanceof \yii\console\Application) {
return;
}
/* @var $app \yii\base\Application */


$timelineCollector = new TimelineCollector();
$logCollector = new LogCollector($timelineCollector);
$logger = new LoggerInterfaceProxy(new NullLogger(), $logCollector);

$psrTarget = new PsrTarget();
$psrTarget->setLogger($logger);

$varDumperCollector = new VarDumperCollector($timelineCollector);
$varDumper = new VarDumperHandlerInterfaceProxy(VarDumper::getDefaultHandler(), $varDumperCollector);
VarDumper::setDefaultHandler($varDumper);

$requestCollector = new RequestCollector($timelineCollector);
$commandCollector = new CommandCollector($timelineCollector);

$fileStorage = new FileStorage($this->dataPath);

$this->debugger = new Debugger(
$fileStorage,
[
$logCollector,
$requestCollector,
$commandCollector,
new WebAppInfoCollector($timelineCollector),
$varDumperCollector,
],
);
$this->logTarget = $psrTarget;
$app->getLog()->targets['debug'] = $this->logTarget;

Yii::$container->setSingleton(Debugger::class, $this->debugger);
Yii::$container->setSingleton(StorageInterface::class, $fileStorage);

$this->debugger->start(new stdClass());

// delay attaching event handler to the view component after it is fully configured
$app->on(Application::EVENT_BEFORE_REQUEST, function () use ($app) {
$app->getResponse()->on(Response::EVENT_AFTER_PREPARE, [$this, 'setDebugHeaders']);
});
$app->on(Application::EVENT_BEFORE_REQUEST, function (Event $event) use ($app, $requestCollector) {
$requestCollector->collect(
new BeforeRequest($this->createPsr7Request($app->request))
);
});
$app->on(Application::EVENT_AFTER_REQUEST, function (Event $event) use ($app, $requestCollector) {
$requestCollector->collect(
new AfterRequest($this->createPsr7Response($app->response))
);
});
$app->on(Application::EVENT_BEFORE_ACTION, function () use ($app) {
$app->getView()->on(View::EVENT_END_BODY, [$this, 'renderToolbar']);
$app->getView()->on(View::EVENT_END_BODY, [$this, 'stopDebugger']);
});

$app->getUrlManager()->addRules([
Expand All @@ -299,18 +371,53 @@ public function bootstrap($app)
'route' => $this->getUniqueId(),
'pattern' => $this->getUniqueId(),
'normalizer' => false,
'suffix' => false
'suffix' => false,
],
[
'class' => $this->urlRuleClass,
'route' => $this->getUniqueId() . '/api/view',
'pattern' => $this->getUniqueId() . '/api/view/<id:\w+>',
'normalizer' => false,
'suffix' => false,
],
[
'class' => $this->urlRuleClass,
'route' => $this->getUniqueId() . '/<controller>/<action>',
'pattern' => $this->getUniqueId() . '/<controller:[\w\-]+>/<action:[\w\-]+>',
'normalizer' => false,
'suffix' => false
]
'suffix' => false,
],
], false);
}


public function createPsr7Request(Request $request): ServerRequestInterface
{
$request = new ServerRequest(
serverParams: $_SERVER,
uploadedFiles: $_FILES,
cookieParams: $request->getCookies()->toArray(),
queryParams: $request->getQueryParams(),
parsedBody: $request->getRawBody(),
method: $request->method,
uri: new Uri($request->getAbsoluteUrl()),
headers: $request->getHeaders()->toArray()
);

return $request;
}

public function createPsr7Response(Response $response): ResponseInterface
{
$result = new \HttpSoft\Message\Response(
statusCode: $response->getStatusCode(),
headers: $response->getHeaders()->toArray(),
body: $response->content,
);

return $result;
}

/**
* {@inheritdoc}
* @throws \yii\base\InvalidConfigException
Expand Down Expand Up @@ -359,10 +466,10 @@ public function setDebugHeaders($event)
}
$url = Url::toRoute([
'/' . $this->getUniqueId() . '/default/view',
'tag' => $this->logTarget->tag,
//'tag' => $this->debugger->getId(),
]);
$event->sender->getHeaders()
->set('X-Debug-Tag', $this->logTarget->tag)
//->set('X-Debug-Tag', $this->debugger->getId())
->set('X-Debug-Duration', number_format((microtime(true) - YII_BEGIN_TIME) * 1000 + 1))
->set('X-Debug-Link', $url);
}
Expand All @@ -383,7 +490,7 @@ public function getToolbarHtml()
{
$url = Url::toRoute([
'/' . $this->getUniqueId() . '/default/toolbar',
'tag' => $this->logTarget->tag,
//'tag' => $this->debugger->getId(),
]);

if (!empty($this->skipAjaxRequestUrl)) {
Expand All @@ -402,7 +509,7 @@ public function getToolbarHtml()
*/
public function renderToolbar($event)
{
if (!$this->checkAccess() || Yii::$app->getRequest()->getIsAjax()) {
if (!$this->checkAccess() || Yii::$app->getRequest()->getIsAjax() || !$this->debugger->isActive() || true) {
return;
}

Expand All @@ -415,6 +522,18 @@ public function renderToolbar($event)
echo '<script>' . $view->renderPhpFile(__DIR__ . '/assets/js/toolbar.js') . '</script>';
}

/**
* Renders mini-toolbar at the end of page body.
*
* @param \yii\base\Event $event
* @throws \Throwable
*/
public function stopDebugger($event)
{
Yii::getLogger()->flush(true);
$this->debugger->stop();
}

/**
* Checks if current user is allowed to access the module
* @param \yii\base\Action|null $action the action to be executed. May be `null` when called from
Expand Down
Loading
Loading