Skip to content

[4.0] Fix "explain" feature in the debug plugin #30580

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

Merged
laoneo merged 4 commits into from
Sep 9, 2020
Merged

[4.0] Fix "explain" feature in the debug plugin #30580

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9797ee1
Fix "explain" feature in the debug plugin
Fedik Sep 6, 2020
1a97abd
Explain for PostgreSQL
Fedik Sep 6, 2020
f88bd43
Update build/media_source/plg_system_debug/widgets/sqlqueries/widget.…
Fedik Sep 6, 2020
8c36884
Update rendering of Explain table
Fedik Sep 8, 2020
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
75 changes: 41 additions & 34 deletions build/media_source/plg_system_debug/widgets/sqlqueries/widget.es5.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,30 +124,50 @@
})
}

var tableExplain
var tableExplain;

function showTableExplain() {
if (tableExplain) {
tableExplain.show();
return;
}

// Render table
tableExplain = $('<table>').addClass(csscls('callstack')).appendTo(li);
tableExplain.append('<tr><th>' + stmt.explain_col.join('</th><th>') + '</th></tr>');

var i, entry, cols;
for (i in stmt.explain) {
cols = []
entry = stmt.explain[i];

stmt.explain_col.forEach(function (key){
cols.push(entry[key]);
});

tableExplain.append('<tr><td>' + cols.join('</td><td>') + '</td></tr>');
}

tableExplain.show();
}

if (stmt.explain && !$.isEmptyObject(stmt.explain)) {
var btnExplain = $('<span title="Explain" />')
.text('Explain')
.addClass(csscls('eye'))
.css('cursor', 'pointer')
.on('click', function () {
if (tableExplain.is(':visible')) {
tableExplain.hide()
btnExplain.addClass(csscls('eye'))
btnExplain.removeClass(csscls('eye-dash'))
} else {
tableExplain.show()
btnExplain.addClass(csscls('eye-dash'))
btnExplain.removeClass(csscls('eye'))
}
})
.appendTo(li)

tableExplain = $('<table><thead>'
+ '<tr><th colspan="10">Explain</th></tr>'
+ '<tr><th>Id</th><th>Select Type</th><th>Table</th><th>Type</th><th>Possible Keys</th><th>Key</th><th>Key Len</th><th>Ref</th><th>Rows</th><th>Extra</th></tr>'
+ '</thead></table>').addClass(csscls('callstack'))
.text('Explain')
.addClass(csscls('eye'))
.css('cursor', 'pointer')
.on('click', function () {
if (tableExplain && tableExplain.is(':visible')) {
tableExplain.hide()
btnExplain.addClass(csscls('eye'))
btnExplain.removeClass(csscls('eye-dash'))
} else {
showTableExplain();
btnExplain.addClass(csscls('eye-dash'))
btnExplain.removeClass(csscls('eye'))
}
})
.appendTo(li)
}

var tableStack
Expand Down Expand Up @@ -214,19 +234,6 @@
}
}

if (tableExplain) {
tableExplain.appendTo(li)
for (i in stmt.explain) {
var entry = stmt.explain[i]
tableExplain.append('<tr>'
+ '<td>' + entry.id + '</td><td>' + entry.select_type + '</td><td>' + entry.table + '</td>'
+ '<td>' + entry.type + '</td><td>' + entry.possible_keys + '</td><td>' + entry.key + '</td>'
+ '<td>' + entry.key_len + '</td><td>' + entry.ref + '</td><td>' + entry.rows + '</td>'
+ '<td>' + entry.Extra + '</td>'
+ '</tr>')
}
}

li.attr('dupeindex', 'dupe-0')
}
})
Expand Down
12 changes: 7 additions & 5 deletions composer.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

19 changes: 15 additions & 4 deletions plugins/system/debug/debug.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -508,7 +508,8 @@ public function onAfterDisconnect(ConnectionEvent $event)

if ($this->params->get('query_explains') && in_array($db->getServerType(), ['mysql', 'postgresql'], true))
{
$logs = $this->queryMonitor->getLogs();
$logs = $this->queryMonitor->getLogs();
$boundParams = $this->queryMonitor->getBoundParams();

foreach ($logs as $k => $query)
{
Expand All @@ -524,12 +525,22 @@ public function onAfterDisconnect(ConnectionEvent $event)
{
try
{
$db->setQuery('EXPLAIN ' . ($dbVersion56 ? 'EXTENDED ' : '') . $query);
$this->explains[$k] = $db->loadAssocList();
$queryInstance = $db->getQuery(true);
$queryInstance->setQuery('EXPLAIN ' . ($dbVersion56 ? 'EXTENDED ' : '') . $query);

if ($boundParams[$k])
{
foreach ($boundParams[$k] as $key => $obj)
{
$queryInstance->bind($key, $obj->value, $obj->dataType, $obj->length, $obj->driverOptions);
}
}

$this->explains[$k] = $db->setQuery($queryInstance)->loadAssocList();
}
catch (Exception $e)
{
$this->explains[$k] = [['Error' => $e->getMessage()]];
$this->explains[$k] = [['error' => $e->getMessage()]];
}
}
}
Expand Down
12 changes: 11 additions & 1 deletion plugins/system/debug/src/DataCollector/QueryCollector.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -233,13 +233,23 @@ private function getStatements(): array
}
}

$explain = $this->explains[$id] ?? [];
$explainColumns = [];

// Extract column labels for Explain table
if ($explain)
{
$explainColumns = array_keys(reset($explain));
}

$statements[] = [
'sql' => $item,
'duration_str' => $this->getDataFormatter()->formatDuration($queryTime),
'memory_str' => $this->getDataFormatter()->formatBytes($queryMemory),
'caller' => $callerLocation,
'callstack' => $trace,
'explain' => $this->explains[$id] ?? [],
'explain' => $explain,
'explain_col' => $explainColumns,
'profile' => $this->profiles[$id] ?? [],
];
}
Expand Down