Refactor Database Collector display#5553

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
lonnieezell merged 3 commits into from
Jan 7, 2022
Merged

Refactor Database Collector display #5553

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
973ab18
Refactor Database Collector display
paulbalandan Jan 7, 2022
1a52fbf
Do not reuse `$line` outside of foreach
paulbalandan Jan 7, 2022
1f3d525
Remove first two arrays in trace when called in browser
paulbalandan Jan 7, 2022
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
55 changes: 39 additions & 16 deletions system/Debug/Toolbar/Collectors/Database.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -85,11 +85,19 @@ public static function collect(Query $query)
if (count(static::$queries) < $max) {
$queryString = $query->getQuery();

$backtrace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);

if (! is_cli()) {
// when called in the browser, the first two trace arrays
// are from the DB event trigger, which are unneeded
$backtrace = array_slice($backtrace, 2);
}

static::$queries[] = [
'query' => $query,
'string' => $queryString,
'duplicate' => in_array($queryString, array_column(static::$queries, 'string', null), true),
'trace' => debug_backtrace(),
'trace' => $backtrace,
];
}
}
Expand DownExpand Up@@ -134,23 +142,39 @@ public function display(): array
$data['queries'] = array_map(static function (array $query) {
$isDuplicate = $query['duplicate'] === true;

// Find the first line that doesn't include `system` in the backtrace
$line = [];
$firstNonSystemLine = '';

foreach ($query['trace'] as $index => &$line) {
// simplify file and line
if (isset($line['file'])) {
$line['file'] = clean_path($line['file']) . ':' . $line['line'];
unset($line['line']);
} else {
$line['file'] = '[internal function]';
}

// find the first trace line that does not originate from `system/`
if ($firstNonSystemLine === '' && strpos($line['file'], 'SYSTEMPATH') === false) {
$firstNonSystemLine = $line['file'];
}

foreach ($query['trace'] as &$traceLine) {
// Clean up the file paths
$traceLine['file'] = str_ireplace(APPPATH, 'APPPATH/', $traceLine['file']);
$traceLine['file'] = str_ireplace(SYSTEMPATH, 'SYSTEMPATH/', $traceLine['file']);
if (defined('VENDORPATH')) {
// VENDORPATH is not defined unless `vendor/autoload.php` exists
$traceLine['file'] = str_ireplace(VENDORPATH, 'VENDORPATH/', $traceLine['file']);
// simplify function call
if (isset($line['class'])) {
$line['function'] = $line['class'] . $line['type'] . $line['function'];
unset($line['class'], $line['type']);
}
$traceLine['file'] = str_ireplace(ROOTPATH, 'ROOTPATH/', $traceLine['file']);

if (strpos($traceLine['file'], 'SYSTEMPATH') !== false) {
continue;
if (strrpos($line['function'], '{closure}') === false) {
$line['function'] .= '()';
}
$line = empty($line) ? $traceLine : $line;

$line['function'] = str_repeat(chr(0xC2) . chr(0xA0), 8) . $line['function'];

// add index numbering padded with nonbreaking space
$indexPadded = str_pad(sprintf('%d', $index + 1), 3, ' ', STR_PAD_LEFT);
$indexPadded = preg_replace('/\s/', chr(0xC2) . chr(0xA0), $indexPadded);

$line['index'] = $indexPadded . str_repeat(chr(0xC2) . chr(0xA0), 4);
}

return [
Expand All@@ -159,8 +183,7 @@ public function display(): array
'duration' => ((float) $query['query']->getDuration(5) * 1000) . ' ms',
'sql' => $query['query']->debugToolbarDisplay(),
'trace' => $query['trace'],
'trace-file' => str_replace(ROOTPATH, '/', $line['file'] ?? ''),
'trace-line' => $line['line'] ?? '',
'trace-file' => $firstNonSystemLine,
'qid' => md5($query['query'] . microtime()),
];
}, static::$queries);
Expand Down
5 changes: 3 additions & 2 deletions system/Debug/Toolbar/Views/_database.tpl
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,13 +10,14 @@
<tr class="{class}" title="{hover}" data-toggle="{qid}-trace">
<td class="narrow">{duration}</td>
<td>{! sql !}</td>
<td style="text-align: right">{trace-file}:<strong>{trace-line}</strong></td>
<td style="text-align: right"><strong>{trace-file}</strong></td>
</tr>
<tr class="muted" id="{qid}-trace" style="display:none">
<td></td>
<td colspan="2">
{trace}
{file}:<strong>{line}</strong><br/>
{index}<strong>{file}</strong><br/>
{function}<br/><br/>
{/trace}
</td>
</tr>
Expand Down
61 changes: 61 additions & 0 deletions tests/system/Debug/Toolbar/Collectors/DatabaseTest.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
<?php

/**
* This file is part of CodeIgniter 4 framework.
*
* (c) CodeIgniter Foundation <admin@codeigniter.com>
*
* For the full copyright and license information, please view
* the LICENSE file that was distributed with this source code.
*/

namespace CodeIgniter\Debug\Toolbar\Collectors;

use CodeIgniter\Database\Query;
use CodeIgniter\Test\CIUnitTestCase;
use PHPUnit\Framework\MockObject\MockObject;

/**
* @internal
*/
final class DatabaseTest extends CIUnitTestCase
{
public function testDisplay(): void
{
/** @var MockObject&Query $query */
$query = $this->getMockBuilder(Query::class)
->disableOriginalConstructor()
->getMock();

// set mock returns
$query->method('getQuery')->willReturn('SHOW TABLES;');
$query->method('debugToolbarDisplay')->willReturn('<strong>SHOW</strong> TABLES;');
$query->method('getDuration')->with(5)->willReturn('1.23456');

Database::collect($query); // <== $query will be called here
$collector = new Database();

$queries = $collector->display()['queries'];

$this->assertSame('1234.56 ms', $queries[0]['duration']);
$this->assertSame('<strong>SHOW</strong> TABLES;', $queries[0]['sql']);
$this->assertSame(clean_path(__FILE__) . ':35', $queries[0]['trace-file']);

foreach ($queries[0]['trace'] as $i => $trace) {
// since we added the index numbering
$this->assertArrayHasKey('index', $trace);
$this->assertSame(
sprintf('%s', $i + 1),
preg_replace(sprintf('/%s/', chr(0xC2) . chr(0xA0)), '', $trace['index'])
);

// since we merged file & line together
$this->assertArrayNotHasKey('line', $trace);
$this->assertArrayHasKey('file', $trace);

// since we dropped object & args in the backtrace for performance
// but args MAY STILL BE present in internal calls
$this->assertArrayNotHasKey('object', $trace);
}
}
}
, '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
Refactor Database Collector display#5553

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

lonnieezell
merged 3 commits into

from

Jan 7, 2022
 Merged


Refactor Database Collector display
#5553
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
973ab18

Refactor Database Collector display


paulbalandan Jan 7, 2022
1a52fbf

Do not reuse `$line` outside of foreach


paulbalandan Jan 7, 2022
1f3d525

Remove first two arrays in trace when called in browser


paulbalandan Jan 7, 2022

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


55 changes: 39 additions & 16 deletions
system/Debug/Toolbar/Collectors/Database.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -85,11 +85,19 @@ public static function collect(Query $query)
 if (count(static::$queries) < $max) {
 $queryString = $query->getQuery();

 $backtrace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);

 if (! is_cli()) {
 // when called in the browser, the first two trace arrays
 // are from the DB event trigger, which are unneeded
 $backtrace = array_slice($backtrace, 2);
 }

 static::$queries[] = [
 'query' => $query,
 'string' => $queryString,
 'duplicate' => in_array($queryString, array_column(static::$queries, 'string', null), true),
 'trace' => debug_backtrace(),
 'trace' => $backtrace,
 ];
 }
 }
Expand DownExpand Up@@ -134,23 +142,39 @@ public function display(): array
 $data['queries'] = array_map(static function (array $query) {
 $isDuplicate = $query['duplicate'] === true;

 // Find the first line that doesn't include `system` in the backtrace
 $line = [];
 $firstNonSystemLine = '';

 foreach ($query['trace'] as $index => &$line) {
 // simplify file and line
 if (isset($line['file'])) {
 $line['file'] = clean_path($line['file']) . ':' . $line['line'];
 unset($line['line']);
 } else {
 $line['file'] = '[internal function]';
 }

 // find the first trace line that does not originate from `system/`
 if ($firstNonSystemLine === '' && strpos($line['file'], 'SYSTEMPATH') === false) {
 $firstNonSystemLine = $line['file'];
 }

 foreach ($query['trace'] as &$traceLine) {
 // Clean up the file paths
 $traceLine['file'] = str_ireplace(APPPATH, 'APPPATH/', $traceLine['file']);
 $traceLine['file'] = str_ireplace(SYSTEMPATH, 'SYSTEMPATH/', $traceLine['file']);
 if (defined('VENDORPATH')) {
 // VENDORPATH is not defined unless `vendor/autoload.php` exists
 $traceLine['file'] = str_ireplace(VENDORPATH, 'VENDORPATH/', $traceLine['file']);
 // simplify function call
 if (isset($line['class'])) {
 $line['function'] = $line['class'] . $line['type'] . $line['function'];
 unset($line['class'], $line['type']);
 }
 $traceLine['file'] = str_ireplace(ROOTPATH, 'ROOTPATH/', $traceLine['file']);

 if (strpos($traceLine['file'], 'SYSTEMPATH') !== false) {
continue;
 if (strrpos($line['function'], '{closure}') === false) {
$line['function'] .= '()';
 }
 $line = empty($line) ? $traceLine : $line;

 $line['function'] = str_repeat(chr(0xC2) . chr(0xA0), 8) . $line['function'];

 // add index numbering padded with nonbreaking space
 $indexPadded = str_pad(sprintf('%d', $index + 1), 3, ' ', STR_PAD_LEFT);
 $indexPadded = preg_replace('/\s/', chr(0xC2) . chr(0xA0), $indexPadded);

 $line['index'] = $indexPadded . str_repeat(chr(0xC2) . chr(0xA0), 4);
 }

 return [
Expand All@@ -159,8 +183,7 @@ public function display(): array
 'duration' => ((float) $query['query']->getDuration(5) * 1000) . ' ms',
 'sql' => $query['query']->debugToolbarDisplay(),
 'trace' => $query['trace'],
 'trace-file' => str_replace(ROOTPATH, '/', $line['file'] ?? ''),
 'trace-line' => $line['line'] ?? '',
 'trace-file' => $firstNonSystemLine,
 'qid' => md5($query['query'] . microtime()),
 ];
 }, static::$queries);
Expand Down

5 changes: 3 additions & 2 deletions
system/Debug/Toolbar/Views/_database.tpl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,13 +10,14 @@
 <tr class="{class}" title="{hover}" data-toggle="{qid}-trace">
 <td class="narrow">{duration}</td>
 <td>{! sql !}</td>
 <td style="text-align: right">{trace-file}:<strong>{trace-line}</strong></td>
 <td style="text-align: right"><strong>{trace-file}</strong></td>
 </tr>
 <tr class="muted" id="{qid}-trace" style="display:none">
 <td></td>
 <td colspan="2">
 {trace}
 {file}:<strong>{line}</strong><br/>
 {index}<strong>{file}</strong><br/>
 {function}<br/><br/>
 {/trace}
 </td>
 </tr>
Expand Down

61 changes: 61 additions & 0 deletions
tests/system/Debug/Toolbar/Collectors/DatabaseTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
<?php

/**
 * This file is part of CodeIgniter 4 framework.
 *
 * (c) CodeIgniter Foundation <admin@codeigniter.com>
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace CodeIgniter\Debug\Toolbar\Collectors;

use CodeIgniter\Database\Query;
use CodeIgniter\Test\CIUnitTestCase;
use PHPUnit\Framework\MockObject\MockObject;

/**
 * @internal
 */
final class DatabaseTest extends CIUnitTestCase
{
 public function testDisplay(): void
 {
 /** @var MockObject&Query $query */
 $query = $this->getMockBuilder(Query::class)
 ->disableOriginalConstructor()
 ->getMock();

 // set mock returns
 $query->method('getQuery')->willReturn('SHOW TABLES;');
 $query->method('debugToolbarDisplay')->willReturn('<strong>SHOW</strong> TABLES;');
 $query->method('getDuration')->with(5)->willReturn('1.23456');

 Database::collect($query); // <== $query will be called here
 $collector = new Database();

 $queries = $collector->display()['queries'];

 $this->assertSame('1234.56 ms', $queries[0]['duration']);
 $this->assertSame('<strong>SHOW</strong> TABLES;', $queries[0]['sql']);
 $this->assertSame(clean_path(__FILE__) . ':35', $queries[0]['trace-file']);

 foreach ($queries[0]['trace'] as $i => $trace) {
 // since we added the index numbering
 $this->assertArrayHasKey('index', $trace);
 $this->assertSame(
 sprintf('%s', $i + 1),
 preg_replace(sprintf('/%s/', chr(0xC2) . chr(0xA0)), '', $trace['index'])
 );

 // since we merged file & line together
 $this->assertArrayNotHasKey('line', $trace);
 $this->assertArrayHasKey('file', $trace);

 // since we dropped object & args in the backtrace for performance
 // but args MAY STILL BE present in internal calls
 $this->assertArrayNotHasKey('object', $trace);
 }
 }
}

, '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
Refactor Database Collector display#5553

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

lonnieezell
merged 3 commits into

from

Jan 7, 2022
 Merged


Refactor Database Collector display
#5553
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
973ab18

Refactor Database Collector display


paulbalandan Jan 7, 2022
1a52fbf

Do not reuse `$line` outside of foreach


paulbalandan Jan 7, 2022
1f3d525

Remove first two arrays in trace when called in browser


paulbalandan Jan 7, 2022

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


55 changes: 39 additions & 16 deletions
system/Debug/Toolbar/Collectors/Database.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -85,11 +85,19 @@ public static function collect(Query $query)
 if (count(static::$queries) < $max) {
 $queryString = $query->getQuery();

 $backtrace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);

 if (! is_cli()) {
 // when called in the browser, the first two trace arrays
 // are from the DB event trigger, which are unneeded
 $backtrace = array_slice($backtrace, 2);
 }

 static::$queries[] = [
 'query' => $query,
 'string' => $queryString,
 'duplicate' => in_array($queryString, array_column(static::$queries, 'string', null), true),
 'trace' => debug_backtrace(),
 'trace' => $backtrace,
 ];
 }
 }
Expand DownExpand Up@@ -134,23 +142,39 @@ public function display(): array
 $data['queries'] = array_map(static function (array $query) {
 $isDuplicate = $query['duplicate'] === true;

 // Find the first line that doesn't include `system` in the backtrace
 $line = [];
 $firstNonSystemLine = '';

 foreach ($query['trace'] as $index => &$line) {
 // simplify file and line
 if (isset($line['file'])) {
 $line['file'] = clean_path($line['file']) . ':' . $line['line'];
 unset($line['line']);
 } else {
 $line['file'] = '[internal function]';
 }

 // find the first trace line that does not originate from `system/`
 if ($firstNonSystemLine === '' && strpos($line['file'], 'SYSTEMPATH') === false) {
 $firstNonSystemLine = $line['file'];
 }

 foreach ($query['trace'] as &$traceLine) {
 // Clean up the file paths
 $traceLine['file'] = str_ireplace(APPPATH, 'APPPATH/', $traceLine['file']);
 $traceLine['file'] = str_ireplace(SYSTEMPATH, 'SYSTEMPATH/', $traceLine['file']);
 if (defined('VENDORPATH')) {
 // VENDORPATH is not defined unless `vendor/autoload.php` exists
 $traceLine['file'] = str_ireplace(VENDORPATH, 'VENDORPATH/', $traceLine['file']);
 // simplify function call
 if (isset($line['class'])) {
 $line['function'] = $line['class'] . $line['type'] . $line['function'];
 unset($line['class'], $line['type']);
 }
 $traceLine['file'] = str_ireplace(ROOTPATH, 'ROOTPATH/', $traceLine['file']);

 if (strpos($traceLine['file'], 'SYSTEMPATH') !== false) {
continue;
 if (strrpos($line['function'], '{closure}') === false) {
$line['function'] .= '()';
 }
 $line = empty($line) ? $traceLine : $line;

 $line['function'] = str_repeat(chr(0xC2) . chr(0xA0), 8) . $line['function'];

 // add index numbering padded with nonbreaking space
 $indexPadded = str_pad(sprintf('%d', $index + 1), 3, ' ', STR_PAD_LEFT);
 $indexPadded = preg_replace('/\s/', chr(0xC2) . chr(0xA0), $indexPadded);

 $line['index'] = $indexPadded . str_repeat(chr(0xC2) . chr(0xA0), 4);
 }

 return [
Expand All@@ -159,8 +183,7 @@ public function display(): array
 'duration' => ((float) $query['query']->getDuration(5) * 1000) . ' ms',
 'sql' => $query['query']->debugToolbarDisplay(),
 'trace' => $query['trace'],
 'trace-file' => str_replace(ROOTPATH, '/', $line['file'] ?? ''),
 'trace-line' => $line['line'] ?? '',
 'trace-file' => $firstNonSystemLine,
 'qid' => md5($query['query'] . microtime()),
 ];
 }, static::$queries);
Expand Down

5 changes: 3 additions & 2 deletions
system/Debug/Toolbar/Views/_database.tpl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,13 +10,14 @@
 <tr class="{class}" title="{hover}" data-toggle="{qid}-trace">
 <td class="narrow">{duration}</td>
 <td>{! sql !}</td>
 <td style="text-align: right">{trace-file}:<strong>{trace-line}</strong></td>
 <td style="text-align: right"><strong>{trace-file}</strong></td>
 </tr>
 <tr class="muted" id="{qid}-trace" style="display:none">
 <td></td>
 <td colspan="2">
 {trace}
 {file}:<strong>{line}</strong><br/>
 {index}<strong>{file}</strong><br/>
 {function}<br/><br/>
 {/trace}
 </td>
 </tr>
Expand Down

61 changes: 61 additions & 0 deletions
tests/system/Debug/Toolbar/Collectors/DatabaseTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
<?php

/**
 * This file is part of CodeIgniter 4 framework.
 *
 * (c) CodeIgniter Foundation <admin@codeigniter.com>
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace CodeIgniter\Debug\Toolbar\Collectors;

use CodeIgniter\Database\Query;
use CodeIgniter\Test\CIUnitTestCase;
use PHPUnit\Framework\MockObject\MockObject;

/**
 * @internal
 */
final class DatabaseTest extends CIUnitTestCase
{
 public function testDisplay(): void
 {
 /** @var MockObject&Query $query */
 $query = $this->getMockBuilder(Query::class)
 ->disableOriginalConstructor()
 ->getMock();

 // set mock returns
 $query->method('getQuery')->willReturn('SHOW TABLES;');
 $query->method('debugToolbarDisplay')->willReturn('<strong>SHOW</strong> TABLES;');
 $query->method('getDuration')->with(5)->willReturn('1.23456');

 Database::collect($query); // <== $query will be called here
 $collector = new Database();

 $queries = $collector->display()['queries'];

 $this->assertSame('1234.56 ms', $queries[0]['duration']);
 $this->assertSame('<strong>SHOW</strong> TABLES;', $queries[0]['sql']);
 $this->assertSame(clean_path(__FILE__) . ':35', $queries[0]['trace-file']);

 foreach ($queries[0]['trace'] as $i => $trace) {
 // since we added the index numbering
 $this->assertArrayHasKey('index', $trace);
 $this->assertSame(
 sprintf('%s', $i + 1),
 preg_replace(sprintf('/%s/', chr(0xC2) . chr(0xA0)), '', $trace['index'])
 );

 // since we merged file & line together
 $this->assertArrayNotHasKey('line', $trace);
 $this->assertArrayHasKey('file', $trace);

 // since we dropped object & args in the backtrace for performance
 // but args MAY STILL BE present in internal calls
 $this->assertArrayNotHasKey('object', $trace);
 }
 }
}

, '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
Refactor Database Collector display#5553

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

lonnieezell
merged 3 commits into

from

Jan 7, 2022
 Merged


Refactor Database Collector display
#5553
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
973ab18

Refactor Database Collector display


paulbalandan Jan 7, 2022
1a52fbf

Do not reuse `$line` outside of foreach


paulbalandan Jan 7, 2022
1f3d525

Remove first two arrays in trace when called in browser


paulbalandan Jan 7, 2022

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


55 changes: 39 additions & 16 deletions
system/Debug/Toolbar/Collectors/Database.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -85,11 +85,19 @@ public static function collect(Query $query)
 if (count(static::$queries) < $max) {
 $queryString = $query->getQuery();

 $backtrace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);

 if (! is_cli()) {
 // when called in the browser, the first two trace arrays
 // are from the DB event trigger, which are unneeded
 $backtrace = array_slice($backtrace, 2);
 }

 static::$queries[] = [
 'query' => $query,
 'string' => $queryString,
 'duplicate' => in_array($queryString, array_column(static::$queries, 'string', null), true),
 'trace' => debug_backtrace(),
 'trace' => $backtrace,
 ];
 }
 }
Expand DownExpand Up@@ -134,23 +142,39 @@ public function display(): array
 $data['queries'] = array_map(static function (array $query) {
 $isDuplicate = $query['duplicate'] === true;

 // Find the first line that doesn't include `system` in the backtrace
 $line = [];
 $firstNonSystemLine = '';

 foreach ($query['trace'] as $index => &$line) {
 // simplify file and line
 if (isset($line['file'])) {
 $line['file'] = clean_path($line['file']) . ':' . $line['line'];
 unset($line['line']);
 } else {
 $line['file'] = '[internal function]';
 }

 // find the first trace line that does not originate from `system/`
 if ($firstNonSystemLine === '' && strpos($line['file'], 'SYSTEMPATH') === false) {
 $firstNonSystemLine = $line['file'];
 }

 foreach ($query['trace'] as &$traceLine) {
 // Clean up the file paths
 $traceLine['file'] = str_ireplace(APPPATH, 'APPPATH/', $traceLine['file']);
 $traceLine['file'] = str_ireplace(SYSTEMPATH, 'SYSTEMPATH/', $traceLine['file']);
 if (defined('VENDORPATH')) {
 // VENDORPATH is not defined unless `vendor/autoload.php` exists
 $traceLine['file'] = str_ireplace(VENDORPATH, 'VENDORPATH/', $traceLine['file']);
 // simplify function call
 if (isset($line['class'])) {
 $line['function'] = $line['class'] . $line['type'] . $line['function'];
 unset($line['class'], $line['type']);
 }
 $traceLine['file'] = str_ireplace(ROOTPATH, 'ROOTPATH/', $traceLine['file']);

 if (strpos($traceLine['file'], 'SYSTEMPATH') !== false) {
continue;
 if (strrpos($line['function'], '{closure}') === false) {
$line['function'] .= '()';
 }
 $line = empty($line) ? $traceLine : $line;

 $line['function'] = str_repeat(chr(0xC2) . chr(0xA0), 8) . $line['function'];

 // add index numbering padded with nonbreaking space
 $indexPadded = str_pad(sprintf('%d', $index + 1), 3, ' ', STR_PAD_LEFT);
 $indexPadded = preg_replace('/\s/', chr(0xC2) . chr(0xA0), $indexPadded);

 $line['index'] = $indexPadded . str_repeat(chr(0xC2) . chr(0xA0), 4);
 }

 return [
Expand All@@ -159,8 +183,7 @@ public function display(): array
 'duration' => ((float) $query['query']->getDuration(5) * 1000) . ' ms',
 'sql' => $query['query']->debugToolbarDisplay(),
 'trace' => $query['trace'],
 'trace-file' => str_replace(ROOTPATH, '/', $line['file'] ?? ''),
 'trace-line' => $line['line'] ?? '',
 'trace-file' => $firstNonSystemLine,
 'qid' => md5($query['query'] . microtime()),
 ];
 }, static::$queries);
Expand Down

5 changes: 3 additions & 2 deletions
system/Debug/Toolbar/Views/_database.tpl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,13 +10,14 @@
 <tr class="{class}" title="{hover}" data-toggle="{qid}-trace">
 <td class="narrow">{duration}</td>
 <td>{! sql !}</td>
 <td style="text-align: right">{trace-file}:<strong>{trace-line}</strong></td>
 <td style="text-align: right"><strong>{trace-file}</strong></td>
 </tr>
 <tr class="muted" id="{qid}-trace" style="display:none">
 <td></td>
 <td colspan="2">
 {trace}
 {file}:<strong>{line}</strong><br/>
 {index}<strong>{file}</strong><br/>
 {function}<br/><br/>
 {/trace}
 </td>
 </tr>
Expand Down

61 changes: 61 additions & 0 deletions
tests/system/Debug/Toolbar/Collectors/DatabaseTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
<?php

/**
 * This file is part of CodeIgniter 4 framework.
 *
 * (c) CodeIgniter Foundation <admin@codeigniter.com>
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace CodeIgniter\Debug\Toolbar\Collectors;

use CodeIgniter\Database\Query;
use CodeIgniter\Test\CIUnitTestCase;
use PHPUnit\Framework\MockObject\MockObject;

/**
 * @internal
 */
final class DatabaseTest extends CIUnitTestCase
{
 public function testDisplay(): void
 {
 /** @var MockObject&Query $query */
 $query = $this->getMockBuilder(Query::class)
 ->disableOriginalConstructor()
 ->getMock();

 // set mock returns
 $query->method('getQuery')->willReturn('SHOW TABLES;');
 $query->method('debugToolbarDisplay')->willReturn('<strong>SHOW</strong> TABLES;');
 $query->method('getDuration')->with(5)->willReturn('1.23456');

 Database::collect($query); // <== $query will be called here
 $collector = new Database();

 $queries = $collector->display()['queries'];

 $this->assertSame('1234.56 ms', $queries[0]['duration']);
 $this->assertSame('<strong>SHOW</strong> TABLES;', $queries[0]['sql']);
 $this->assertSame(clean_path(__FILE__) . ':35', $queries[0]['trace-file']);

 foreach ($queries[0]['trace'] as $i => $trace) {
 // since we added the index numbering
 $this->assertArrayHasKey('index', $trace);
 $this->assertSame(
 sprintf('%s', $i + 1),
 preg_replace(sprintf('/%s/', chr(0xC2) . chr(0xA0)), '', $trace['index'])
 );

 // since we merged file & line together
 $this->assertArrayNotHasKey('line', $trace);
 $this->assertArrayHasKey('file', $trace);

 // since we dropped object & args in the backtrace for performance
 // but args MAY STILL BE present in internal calls
 $this->assertArrayNotHasKey('object', $trace);
 }
 }
}

, '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
Refactor Database Collector display#5553

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

lonnieezell
merged 3 commits into

from

Jan 7, 2022
 Merged


Refactor Database Collector display
#5553
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
973ab18

Refactor Database Collector display


paulbalandan Jan 7, 2022
1a52fbf

Do not reuse `$line` outside of foreach


paulbalandan Jan 7, 2022
1f3d525

Remove first two arrays in trace when called in browser


paulbalandan Jan 7, 2022

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


55 changes: 39 additions & 16 deletions
system/Debug/Toolbar/Collectors/Database.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -85,11 +85,19 @@ public static function collect(Query $query)
 if (count(static::$queries) < $max) {
 $queryString = $query->getQuery();

 $backtrace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);

 if (! is_cli()) {
 // when called in the browser, the first two trace arrays
 // are from the DB event trigger, which are unneeded
 $backtrace = array_slice($backtrace, 2);
 }

 static::$queries[] = [
 'query' => $query,
 'string' => $queryString,
 'duplicate' => in_array($queryString, array_column(static::$queries, 'string', null), true),
 'trace' => debug_backtrace(),
 'trace' => $backtrace,
 ];
 }
 }
Expand DownExpand Up@@ -134,23 +142,39 @@ public function display(): array
 $data['queries'] = array_map(static function (array $query) {
 $isDuplicate = $query['duplicate'] === true;

 // Find the first line that doesn't include `system` in the backtrace
 $line = [];
 $firstNonSystemLine = '';

 foreach ($query['trace'] as $index => &$line) {
 // simplify file and line
 if (isset($line['file'])) {
 $line['file'] = clean_path($line['file']) . ':' . $line['line'];
 unset($line['line']);
 } else {
 $line['file'] = '[internal function]';
 }

 // find the first trace line that does not originate from `system/`
 if ($firstNonSystemLine === '' && strpos($line['file'], 'SYSTEMPATH') === false) {
 $firstNonSystemLine = $line['file'];
 }

 foreach ($query['trace'] as &$traceLine) {
 // Clean up the file paths
 $traceLine['file'] = str_ireplace(APPPATH, 'APPPATH/', $traceLine['file']);
 $traceLine['file'] = str_ireplace(SYSTEMPATH, 'SYSTEMPATH/', $traceLine['file']);
 if (defined('VENDORPATH')) {
 // VENDORPATH is not defined unless `vendor/autoload.php` exists
 $traceLine['file'] = str_ireplace(VENDORPATH, 'VENDORPATH/', $traceLine['file']);
 // simplify function call
 if (isset($line['class'])) {
 $line['function'] = $line['class'] . $line['type'] . $line['function'];
 unset($line['class'], $line['type']);
 }
 $traceLine['file'] = str_ireplace(ROOTPATH, 'ROOTPATH/', $traceLine['file']);

 if (strpos($traceLine['file'], 'SYSTEMPATH') !== false) {
continue;
 if (strrpos($line['function'], '{closure}') === false) {
$line['function'] .= '()';
 }
 $line = empty($line) ? $traceLine : $line;

 $line['function'] = str_repeat(chr(0xC2) . chr(0xA0), 8) . $line['function'];

 // add index numbering padded with nonbreaking space
 $indexPadded = str_pad(sprintf('%d', $index + 1), 3, ' ', STR_PAD_LEFT);
 $indexPadded = preg_replace('/\s/', chr(0xC2) . chr(0xA0), $indexPadded);

 $line['index'] = $indexPadded . str_repeat(chr(0xC2) . chr(0xA0), 4);
 }

 return [
Expand All@@ -159,8 +183,7 @@ public function display(): array
 'duration' => ((float) $query['query']->getDuration(5) * 1000) . ' ms',
 'sql' => $query['query']->debugToolbarDisplay(),
 'trace' => $query['trace'],
 'trace-file' => str_replace(ROOTPATH, '/', $line['file'] ?? ''),
 'trace-line' => $line['line'] ?? '',
 'trace-file' => $firstNonSystemLine,
 'qid' => md5($query['query'] . microtime()),
 ];
 }, static::$queries);
Expand Down

5 changes: 3 additions & 2 deletions
system/Debug/Toolbar/Views/_database.tpl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,13 +10,14 @@
 <tr class="{class}" title="{hover}" data-toggle="{qid}-trace">
 <td class="narrow">{duration}</td>
 <td>{! sql !}</td>
 <td style="text-align: right">{trace-file}:<strong>{trace-line}</strong></td>
 <td style="text-align: right"><strong>{trace-file}</strong></td>
 </tr>
 <tr class="muted" id="{qid}-trace" style="display:none">
 <td></td>
 <td colspan="2">
 {trace}
 {file}:<strong>{line}</strong><br/>
 {index}<strong>{file}</strong><br/>
 {function}<br/><br/>
 {/trace}
 </td>
 </tr>
Expand Down

61 changes: 61 additions & 0 deletions
tests/system/Debug/Toolbar/Collectors/DatabaseTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
<?php

/**
 * This file is part of CodeIgniter 4 framework.
 *
 * (c) CodeIgniter Foundation <admin@codeigniter.com>
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace CodeIgniter\Debug\Toolbar\Collectors;

use CodeIgniter\Database\Query;
use CodeIgniter\Test\CIUnitTestCase;
use PHPUnit\Framework\MockObject\MockObject;

/**
 * @internal
 */
final class DatabaseTest extends CIUnitTestCase
{
 public function testDisplay(): void
 {
 /** @var MockObject&Query $query */
 $query = $this->getMockBuilder(Query::class)
 ->disableOriginalConstructor()
 ->getMock();

 // set mock returns
 $query->method('getQuery')->willReturn('SHOW TABLES;');
 $query->method('debugToolbarDisplay')->willReturn('<strong>SHOW</strong> TABLES;');
 $query->method('getDuration')->with(5)->willReturn('1.23456');

 Database::collect($query); // <== $query will be called here
 $collector = new Database();

 $queries = $collector->display()['queries'];

 $this->assertSame('1234.56 ms', $queries[0]['duration']);
 $this->assertSame('<strong>SHOW</strong> TABLES;', $queries[0]['sql']);
 $this->assertSame(clean_path(__FILE__) . ':35', $queries[0]['trace-file']);

 foreach ($queries[0]['trace'] as $i => $trace) {
 // since we added the index numbering
 $this->assertArrayHasKey('index', $trace);
 $this->assertSame(
 sprintf('%s', $i + 1),
 preg_replace(sprintf('/%s/', chr(0xC2) . chr(0xA0)), '', $trace['index'])
 );

 // since we merged file & line together
 $this->assertArrayNotHasKey('line', $trace);
 $this->assertArrayHasKey('file', $trace);

 // since we dropped object & args in the backtrace for performance
 // but args MAY STILL BE present in internal calls
 $this->assertArrayNotHasKey('object', $trace);
 }
 }
}

, '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
Refactor Database Collector display#5553

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

lonnieezell
merged 3 commits into

from

Jan 7, 2022
 Merged


Refactor Database Collector display
#5553
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
973ab18

Refactor Database Collector display


paulbalandan Jan 7, 2022
1a52fbf

Do not reuse `$line` outside of foreach


paulbalandan Jan 7, 2022
1f3d525

Remove first two arrays in trace when called in browser


paulbalandan Jan 7, 2022

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


55 changes: 39 additions & 16 deletions
system/Debug/Toolbar/Collectors/Database.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -85,11 +85,19 @@ public static function collect(Query $query)
 if (count(static::$queries) < $max) {
 $queryString = $query->getQuery();

 $backtrace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);

 if (! is_cli()) {
 // when called in the browser, the first two trace arrays
 // are from the DB event trigger, which are unneeded
 $backtrace = array_slice($backtrace, 2);
 }

 static::$queries[] = [
 'query' => $query,
 'string' => $queryString,
 'duplicate' => in_array($queryString, array_column(static::$queries, 'string', null), true),
 'trace' => debug_backtrace(),
 'trace' => $backtrace,
 ];
 }
 }
Expand DownExpand Up@@ -134,23 +142,39 @@ public function display(): array
 $data['queries'] = array_map(static function (array $query) {
 $isDuplicate = $query['duplicate'] === true;

 // Find the first line that doesn't include `system` in the backtrace
 $line = [];
 $firstNonSystemLine = '';

 foreach ($query['trace'] as $index => &$line) {
 // simplify file and line
 if (isset($line['file'])) {
 $line['file'] = clean_path($line['file']) . ':' . $line['line'];
 unset($line['line']);
 } else {
 $line['file'] = '[internal function]';
 }

 // find the first trace line that does not originate from `system/`
 if ($firstNonSystemLine === '' && strpos($line['file'], 'SYSTEMPATH') === false) {
 $firstNonSystemLine = $line['file'];
 }

 foreach ($query['trace'] as &$traceLine) {
 // Clean up the file paths
 $traceLine['file'] = str_ireplace(APPPATH, 'APPPATH/', $traceLine['file']);
 $traceLine['file'] = str_ireplace(SYSTEMPATH, 'SYSTEMPATH/', $traceLine['file']);
 if (defined('VENDORPATH')) {
 // VENDORPATH is not defined unless `vendor/autoload.php` exists
 $traceLine['file'] = str_ireplace(VENDORPATH, 'VENDORPATH/', $traceLine['file']);
 // simplify function call
 if (isset($line['class'])) {
 $line['function'] = $line['class'] . $line['type'] . $line['function'];
 unset($line['class'], $line['type']);
 }
 $traceLine['file'] = str_ireplace(ROOTPATH, 'ROOTPATH/', $traceLine['file']);

 if (strpos($traceLine['file'], 'SYSTEMPATH') !== false) {
continue;
 if (strrpos($line['function'], '{closure}') === false) {
$line['function'] .= '()';
 }
 $line = empty($line) ? $traceLine : $line;

 $line['function'] = str_repeat(chr(0xC2) . chr(0xA0), 8) . $line['function'];

 // add index numbering padded with nonbreaking space
 $indexPadded = str_pad(sprintf('%d', $index + 1), 3, ' ', STR_PAD_LEFT);
 $indexPadded = preg_replace('/\s/', chr(0xC2) . chr(0xA0), $indexPadded);

 $line['index'] = $indexPadded . str_repeat(chr(0xC2) . chr(0xA0), 4);
 }

 return [
Expand All@@ -159,8 +183,7 @@ public function display(): array
 'duration' => ((float) $query['query']->getDuration(5) * 1000) . ' ms',
 'sql' => $query['query']->debugToolbarDisplay(),
 'trace' => $query['trace'],
 'trace-file' => str_replace(ROOTPATH, '/', $line['file'] ?? ''),
 'trace-line' => $line['line'] ?? '',
 'trace-file' => $firstNonSystemLine,
 'qid' => md5($query['query'] . microtime()),
 ];
 }, static::$queries);
Expand Down

5 changes: 3 additions & 2 deletions
system/Debug/Toolbar/Views/_database.tpl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,13 +10,14 @@
 <tr class="{class}" title="{hover}" data-toggle="{qid}-trace">
 <td class="narrow">{duration}</td>
 <td>{! sql !}</td>
 <td style="text-align: right">{trace-file}:<strong>{trace-line}</strong></td>
 <td style="text-align: right"><strong>{trace-file}</strong></td>
 </tr>
 <tr class="muted" id="{qid}-trace" style="display:none">
 <td></td>
 <td colspan="2">
 {trace}
 {file}:<strong>{line}</strong><br/>
 {index}<strong>{file}</strong><br/>
 {function}<br/><br/>
 {/trace}
 </td>
 </tr>
Expand Down

61 changes: 61 additions & 0 deletions
tests/system/Debug/Toolbar/Collectors/DatabaseTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
<?php

/**
 * This file is part of CodeIgniter 4 framework.
 *
 * (c) CodeIgniter Foundation <admin@codeigniter.com>
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace CodeIgniter\Debug\Toolbar\Collectors;

use CodeIgniter\Database\Query;
use CodeIgniter\Test\CIUnitTestCase;
use PHPUnit\Framework\MockObject\MockObject;

/**
 * @internal
 */
final class DatabaseTest extends CIUnitTestCase
{
 public function testDisplay(): void
 {
 /** @var MockObject&Query $query */
 $query = $this->getMockBuilder(Query::class)
 ->disableOriginalConstructor()
 ->getMock();

 // set mock returns
 $query->method('getQuery')->willReturn('SHOW TABLES;');
 $query->method('debugToolbarDisplay')->willReturn('<strong>SHOW</strong> TABLES;');
 $query->method('getDuration')->with(5)->willReturn('1.23456');

 Database::collect($query); // <== $query will be called here
 $collector = new Database();

 $queries = $collector->display()['queries'];

 $this->assertSame('1234.56 ms', $queries[0]['duration']);
 $this->assertSame('<strong>SHOW</strong> TABLES;', $queries[0]['sql']);
 $this->assertSame(clean_path(__FILE__) . ':35', $queries[0]['trace-file']);

 foreach ($queries[0]['trace'] as $i => $trace) {
 // since we added the index numbering
 $this->assertArrayHasKey('index', $trace);
 $this->assertSame(
 sprintf('%s', $i + 1),
 preg_replace(sprintf('/%s/', chr(0xC2) . chr(0xA0)), '', $trace['index'])
 );

 // since we merged file & line together
 $this->assertArrayNotHasKey('line', $trace);
 $this->assertArrayHasKey('file', $trace);

 // since we dropped object & args in the backtrace for performance
 // but args MAY STILL BE present in internal calls
 $this->assertArrayNotHasKey('object', $trace);
 }
 }
}

, '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
Refactor Database Collector display#5553

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

lonnieezell
merged 3 commits into

from

Jan 7, 2022
 Merged


Refactor Database Collector display
#5553
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
973ab18

Refactor Database Collector display


paulbalandan Jan 7, 2022
1a52fbf

Do not reuse `$line` outside of foreach


paulbalandan Jan 7, 2022
1f3d525

Remove first two arrays in trace when called in browser


paulbalandan Jan 7, 2022

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


55 changes: 39 additions & 16 deletions
system/Debug/Toolbar/Collectors/Database.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -85,11 +85,19 @@ public static function collect(Query $query)
 if (count(static::$queries) < $max) {
 $queryString = $query->getQuery();

 $backtrace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);

 if (! is_cli()) {
 // when called in the browser, the first two trace arrays
 // are from the DB event trigger, which are unneeded
 $backtrace = array_slice($backtrace, 2);
 }

 static::$queries[] = [
 'query' => $query,
 'string' => $queryString,
 'duplicate' => in_array($queryString, array_column(static::$queries, 'string', null), true),
 'trace' => debug_backtrace(),
 'trace' => $backtrace,
 ];
 }
 }
Expand DownExpand Up@@ -134,23 +142,39 @@ public function display(): array
 $data['queries'] = array_map(static function (array $query) {
 $isDuplicate = $query['duplicate'] === true;

 // Find the first line that doesn't include `system` in the backtrace
 $line = [];
 $firstNonSystemLine = '';

 foreach ($query['trace'] as $index => &$line) {
 // simplify file and line
 if (isset($line['file'])) {
 $line['file'] = clean_path($line['file']) . ':' . $line['line'];
 unset($line['line']);
 } else {
 $line['file'] = '[internal function]';
 }

 // find the first trace line that does not originate from `system/`
 if ($firstNonSystemLine === '' && strpos($line['file'], 'SYSTEMPATH') === false) {
 $firstNonSystemLine = $line['file'];
 }

 foreach ($query['trace'] as &$traceLine) {
 // Clean up the file paths
 $traceLine['file'] = str_ireplace(APPPATH, 'APPPATH/', $traceLine['file']);
 $traceLine['file'] = str_ireplace(SYSTEMPATH, 'SYSTEMPATH/', $traceLine['file']);
 if (defined('VENDORPATH')) {
 // VENDORPATH is not defined unless `vendor/autoload.php` exists
 $traceLine['file'] = str_ireplace(VENDORPATH, 'VENDORPATH/', $traceLine['file']);
 // simplify function call
 if (isset($line['class'])) {
 $line['function'] = $line['class'] . $line['type'] . $line['function'];
 unset($line['class'], $line['type']);
 }
 $traceLine['file'] = str_ireplace(ROOTPATH, 'ROOTPATH/', $traceLine['file']);

 if (strpos($traceLine['file'], 'SYSTEMPATH') !== false) {
continue;
 if (strrpos($line['function'], '{closure}') === false) {
$line['function'] .= '()';
 }
 $line = empty($line) ? $traceLine : $line;

 $line['function'] = str_repeat(chr(0xC2) . chr(0xA0), 8) . $line['function'];

 // add index numbering padded with nonbreaking space
 $indexPadded = str_pad(sprintf('%d', $index + 1), 3, ' ', STR_PAD_LEFT);
 $indexPadded = preg_replace('/\s/', chr(0xC2) . chr(0xA0), $indexPadded);

 $line['index'] = $indexPadded . str_repeat(chr(0xC2) . chr(0xA0), 4);
 }

 return [
Expand All@@ -159,8 +183,7 @@ public function display(): array
 'duration' => ((float) $query['query']->getDuration(5) * 1000) . ' ms',
 'sql' => $query['query']->debugToolbarDisplay(),
 'trace' => $query['trace'],
 'trace-file' => str_replace(ROOTPATH, '/', $line['file'] ?? ''),
 'trace-line' => $line['line'] ?? '',
 'trace-file' => $firstNonSystemLine,
 'qid' => md5($query['query'] . microtime()),
 ];
 }, static::$queries);
Expand Down

5 changes: 3 additions & 2 deletions
system/Debug/Toolbar/Views/_database.tpl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,13 +10,14 @@
 <tr class="{class}" title="{hover}" data-toggle="{qid}-trace">
 <td class="narrow">{duration}</td>
 <td>{! sql !}</td>
 <td style="text-align: right">{trace-file}:<strong>{trace-line}</strong></td>
 <td style="text-align: right"><strong>{trace-file}</strong></td>
 </tr>
 <tr class="muted" id="{qid}-trace" style="display:none">
 <td></td>
 <td colspan="2">
 {trace}
 {file}:<strong>{line}</strong><br/>
 {index}<strong>{file}</strong><br/>
 {function}<br/><br/>
 {/trace}
 </td>
 </tr>
Expand Down

61 changes: 61 additions & 0 deletions
tests/system/Debug/Toolbar/Collectors/DatabaseTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
<?php

/**
 * This file is part of CodeIgniter 4 framework.
 *
 * (c) CodeIgniter Foundation <admin@codeigniter.com>
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace CodeIgniter\Debug\Toolbar\Collectors;

use CodeIgniter\Database\Query;
use CodeIgniter\Test\CIUnitTestCase;
use PHPUnit\Framework\MockObject\MockObject;

/**
 * @internal
 */
final class DatabaseTest extends CIUnitTestCase
{
 public function testDisplay(): void
 {
 /** @var MockObject&Query $query */
 $query = $this->getMockBuilder(Query::class)
 ->disableOriginalConstructor()
 ->getMock();

 // set mock returns
 $query->method('getQuery')->willReturn('SHOW TABLES;');
 $query->method('debugToolbarDisplay')->willReturn('<strong>SHOW</strong> TABLES;');
 $query->method('getDuration')->with(5)->willReturn('1.23456');

 Database::collect($query); // <== $query will be called here
 $collector = new Database();

 $queries = $collector->display()['queries'];

 $this->assertSame('1234.56 ms', $queries[0]['duration']);
 $this->assertSame('<strong>SHOW</strong> TABLES;', $queries[0]['sql']);
 $this->assertSame(clean_path(__FILE__) . ':35', $queries[0]['trace-file']);

 foreach ($queries[0]['trace'] as $i => $trace) {
 // since we added the index numbering
 $this->assertArrayHasKey('index', $trace);
 $this->assertSame(
 sprintf('%s', $i + 1),
 preg_replace(sprintf('/%s/', chr(0xC2) . chr(0xA0)), '', $trace['index'])
 );

 // since we merged file & line together
 $this->assertArrayNotHasKey('line', $trace);
 $this->assertArrayHasKey('file', $trace);

 // since we dropped object & args in the backtrace for performance
 // but args MAY STILL BE present in internal calls
 $this->assertArrayNotHasKey('object', $trace);
 }
 }
}

, '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
Refactor Database Collector display#5553

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

lonnieezell
merged 3 commits into

from

Jan 7, 2022
 Merged


Refactor Database Collector display
#5553
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
973ab18

Refactor Database Collector display


paulbalandan Jan 7, 2022
1a52fbf

Do not reuse `$line` outside of foreach


paulbalandan Jan 7, 2022
1f3d525

Remove first two arrays in trace when called in browser


paulbalandan Jan 7, 2022

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


55 changes: 39 additions & 16 deletions
system/Debug/Toolbar/Collectors/Database.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -85,11 +85,19 @@ public static function collect(Query $query)
 if (count(static::$queries) < $max) {
 $queryString = $query->getQuery();

 $backtrace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);

 if (! is_cli()) {
 // when called in the browser, the first two trace arrays
 // are from the DB event trigger, which are unneeded
 $backtrace = array_slice($backtrace, 2);
 }

 static::$queries[] = [
 'query' => $query,
 'string' => $queryString,
 'duplicate' => in_array($queryString, array_column(static::$queries, 'string', null), true),
 'trace' => debug_backtrace(),
 'trace' => $backtrace,
 ];
 }
 }
Expand DownExpand Up@@ -134,23 +142,39 @@ public function display(): array
 $data['queries'] = array_map(static function (array $query) {
 $isDuplicate = $query['duplicate'] === true;

 // Find the first line that doesn't include `system` in the backtrace
 $line = [];
 $firstNonSystemLine = '';

 foreach ($query['trace'] as $index => &$line) {
 // simplify file and line
 if (isset($line['file'])) {
 $line['file'] = clean_path($line['file']) . ':' . $line['line'];
 unset($line['line']);
 } else {
 $line['file'] = '[internal function]';
 }

 // find the first trace line that does not originate from `system/`
 if ($firstNonSystemLine === '' && strpos($line['file'], 'SYSTEMPATH') === false) {
 $firstNonSystemLine = $line['file'];
 }

 foreach ($query['trace'] as &$traceLine) {
 // Clean up the file paths
 $traceLine['file'] = str_ireplace(APPPATH, 'APPPATH/', $traceLine['file']);
 $traceLine['file'] = str_ireplace(SYSTEMPATH, 'SYSTEMPATH/', $traceLine['file']);
 if (defined('VENDORPATH')) {
 // VENDORPATH is not defined unless `vendor/autoload.php` exists
 $traceLine['file'] = str_ireplace(VENDORPATH, 'VENDORPATH/', $traceLine['file']);
 // simplify function call
 if (isset($line['class'])) {
 $line['function'] = $line['class'] . $line['type'] . $line['function'];
 unset($line['class'], $line['type']);
 }
 $traceLine['file'] = str_ireplace(ROOTPATH, 'ROOTPATH/', $traceLine['file']);

 if (strpos($traceLine['file'], 'SYSTEMPATH') !== false) {
continue;
 if (strrpos($line['function'], '{closure}') === false) {
$line['function'] .= '()';
 }
 $line = empty($line) ? $traceLine : $line;

 $line['function'] = str_repeat(chr(0xC2) . chr(0xA0), 8) . $line['function'];

 // add index numbering padded with nonbreaking space
 $indexPadded = str_pad(sprintf('%d', $index + 1), 3, ' ', STR_PAD_LEFT);
 $indexPadded = preg_replace('/\s/', chr(0xC2) . chr(0xA0), $indexPadded);

 $line['index'] = $indexPadded . str_repeat(chr(0xC2) . chr(0xA0), 4);
 }

 return [
Expand All@@ -159,8 +183,7 @@ public function display(): array
 'duration' => ((float) $query['query']->getDuration(5) * 1000) . ' ms',
 'sql' => $query['query']->debugToolbarDisplay(),
 'trace' => $query['trace'],
 'trace-file' => str_replace(ROOTPATH, '/', $line['file'] ?? ''),
 'trace-line' => $line['line'] ?? '',
 'trace-file' => $firstNonSystemLine,
 'qid' => md5($query['query'] . microtime()),
 ];
 }, static::$queries);
Expand Down

5 changes: 3 additions & 2 deletions
system/Debug/Toolbar/Views/_database.tpl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,13 +10,14 @@
 <tr class="{class}" title="{hover}" data-toggle="{qid}-trace">
 <td class="narrow">{duration}</td>
 <td>{! sql !}</td>
 <td style="text-align: right">{trace-file}:<strong>{trace-line}</strong></td>
 <td style="text-align: right"><strong>{trace-file}</strong></td>
 </tr>
 <tr class="muted" id="{qid}-trace" style="display:none">
 <td></td>
 <td colspan="2">
 {trace}
 {file}:<strong>{line}</strong><br/>
 {index}<strong>{file}</strong><br/>
 {function}<br/><br/>
 {/trace}
 </td>
 </tr>
Expand Down

61 changes: 61 additions & 0 deletions
tests/system/Debug/Toolbar/Collectors/DatabaseTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
<?php

/**
 * This file is part of CodeIgniter 4 framework.
 *
 * (c) CodeIgniter Foundation <admin@codeigniter.com>
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace CodeIgniter\Debug\Toolbar\Collectors;

use CodeIgniter\Database\Query;
use CodeIgniter\Test\CIUnitTestCase;
use PHPUnit\Framework\MockObject\MockObject;

/**
 * @internal
 */
final class DatabaseTest extends CIUnitTestCase
{
 public function testDisplay(): void
 {
 /** @var MockObject&Query $query */
 $query = $this->getMockBuilder(Query::class)
 ->disableOriginalConstructor()
 ->getMock();

 // set mock returns
 $query->method('getQuery')->willReturn('SHOW TABLES;');
 $query->method('debugToolbarDisplay')->willReturn('<strong>SHOW</strong> TABLES;');
 $query->method('getDuration')->with(5)->willReturn('1.23456');

 Database::collect($query); // <== $query will be called here
 $collector = new Database();

 $queries = $collector->display()['queries'];

 $this->assertSame('1234.56 ms', $queries[0]['duration']);
 $this->assertSame('<strong>SHOW</strong> TABLES;', $queries[0]['sql']);
 $this->assertSame(clean_path(__FILE__) . ':35', $queries[0]['trace-file']);

 foreach ($queries[0]['trace'] as $i => $trace) {
 // since we added the index numbering
 $this->assertArrayHasKey('index', $trace);
 $this->assertSame(
 sprintf('%s', $i + 1),
 preg_replace(sprintf('/%s/', chr(0xC2) . chr(0xA0)), '', $trace['index'])
 );

 // since we merged file & line together
 $this->assertArrayNotHasKey('line', $trace);
 $this->assertArrayHasKey('file', $trace);

 // since we dropped object & args in the backtrace for performance
 // but args MAY STILL BE present in internal calls
 $this->assertArrayNotHasKey('object', $trace);
 }
 }
}