Code style

Author: phpfui

src/PHPFUI/MySQLSlowQuery/Entry.php

@@ -40,6 +40,7 @@ public function __construct(array $parameters = [])
 // $session (not object but index in array of sessions) later.
 'Session' => 0,
 ];
+
 if (($this->parameters['parse_mode'] ?? '') == 'mariadb')
 {
 unset($this->fields['Id']);
@@ -102,7 +103,8 @@ public function setFromLine(string $line) : self
 // Unify with mysql log format: replace space with T, replace second space
 // with leading zero, expand YYMMDD value and add microseconds.
 $parts = \explode(' ', \substr($line, 8), 2);
-if ($parts[1][0] === ' ')
+
+if (' ' === $parts[1][0])
 {
 $parts[1][0] = '0';
 }

src/PHPFUI/MySQLSlowQuery/Parser.php

@@ -127,6 +127,14 @@ private function getNextLine() : string
 return $line;
 }
 
+/**
+ * Derive a string value that determines how the log is parsed.
+ */
+private function getParseMode(string $sessionHeaderFirstLine) : string
+{
+return \stripos($sessionHeaderFirstLine, 'MariaDB') ? 'mariadb' : '';
+}
+
 private function parse() : void
 {
 $this->handle = @\fopen($this->fileName, 'r');
@@ -160,7 +168,7 @@ private function parse() : void
 // query in this session. In non backward compatible mode, check this:
 // if it's not a comment line, this is assumed to be the start of the
 // next session header (i.e. there are zero queries in this session).
-if ($parseMode === 'mariadb' && \strlen($line = $this->getNextLine()) > 0)
+if ('mariadb' === $parseMode && \strlen($line = $this->getNextLine()) > 0)
 {
 if ('#' !== $line[0])
 {
@@ -178,43 +186,48 @@ private function parse() : void
 {
 $entry = new \PHPFUI\MySQLSlowQuery\Entry(['parse_mode' => $parseMode]);
 $query = [];
-if ($parseMode === '')
+
+if ('' === $parseMode)
 {
 // Backward compatible parsing:
 // - Ignore comment lines up until "# Time:"
 // - Iarse exactly three lines. If any of these are non-comments,
 // throw an exception.
 // - If there are more than three comment lines, the query below
 // them is ignored.
-if (!\str_starts_with($line, self::TIME))
+if (! \str_starts_with($line, self::TIME))
+{
 continue;
+}
 $entry->setFromLine($line);
 $entry->setFromLine(\fgets($this->handle));
 $entry->setFromLine(\fgets($this->handle));
 }
 else
 {
-$timeLineFound = false;
-// Parse any following comment lines, and interpret the next
-// non-comment line as a query line.
-do
-{
-$entry->setFromLine($line);
-if ($parseMode == 'mariadb' && \str_starts_with($line, self::TIME))
-{
-$timeLineFound = true;
-$previousTimeLine = $line;
-}
-}
-while (\strlen($line = $this->getNextLine()) > 0 && '#' === $line[0]);
-if ($parseMode == 'mariadb' && !$timeLineFound && $previousTimeLine)
+$timeLineFound = false;
+// Parse any following comment lines, and interpret the next
+// non-comment line as a query line.
+do
+{
+$entry->setFromLine($line);
+
+if ('mariadb' == $parseMode && \str_starts_with($line, self::TIME))
 {
-// Always add the Time property. Assume that if it is not in the
-// log, it's the same as the previous logged query, and that the
-// line contains no other properties we don't want to add.
-$entry->setFromLine($previousTimeLine);
+$timeLineFound = true;
+$previousTimeLine = $line;
 }
-$query[] = \trim($line);
+}
+while ((\strlen($line = $this->getNextLine()) > 0) && ('#' === $line[0]));
+
+if ('mariadb' == $parseMode && ! $timeLineFound && $previousTimeLine)
+{
+// Always add the Time property. Assume that if it is not in the
+// log, it's the same as the previous logged query, and that the
+// line contains no other properties we don't want to add.
+$entry->setFromLine($previousTimeLine);
+}
+$query[] = \trim($line);
 }
 
 // gather (more) query lines until a non-query line is reached
@@ -265,12 +278,4 @@ private function pushLine(string $line) : self
 
 return $this;
 }
-
-/**
- * Derive a string value that determines how the log is parsed.
- */
-private function getParseMode(string $sessionHeaderFirstLine) : string
-{
-return \stripos($sessionHeaderFirstLine, 'MariaDB') ? 'mariadb' : '';
-}
 }

src/PHPFUI/MySQLSlowQuery/Session.php

@@ -29,7 +29,8 @@ public function __construct(array $sessionData = [], $parseMode = '')
 $this->Server = \trim(\str_replace('. started with:', '', $sessionData[0] ?? 'unknown'));
 $this->Version = \substr(\strstr($this->Server, 'Version: ') ?: '', 9);
 
-$delimiter = $parseMode == 'mariadb' ? ' ' : ', ';
+$delimiter = 'mariadb' == $parseMode ? ' ' : ', ';
+
 if (\strpos($sessionData[1] ?? '', $delimiter))
 {
 [$this->Port, $this->Transport] = \explode($delimiter, \trim($sessionData[1]));

tests/UnitTest.php

@@ -54,6 +54,46 @@ public function testMissingFile() : void
 $parser->getSessions();
 }
 
+public function testMysqlVsMariadb() : void
+{
+$parser = new \PHPFUI\MySQLSlowQuery\Parser(__DIR__ . '/logs/ignoredData.log');
+$sessions = $parser->getSessions();
+$entries = $parser->getEntries();
+$this->assertCount(9, $sessions);
+// See comments in logfile for why session 3-6 are buggy and 7-9 are not.
+$this->assertEquals('c:\wamp64\bin\mysql\mysql8.0.21\bin\mysqld.exe, Version: 8.0.21 (MySQL Community Server - GPL)', $sessions[0]->Server);
+$this->assertEquals('c:\wamp64\bin\mysql\mysql8.0.21\bin\mysqld.exe, Version: 8.0.21 (MySQL Community Server - GPL)', $sessions[1]->Server);
+$this->assertEquals('Tcp Port: 3306, Named Pipe: /tmp/mysql.sock', $sessions[2]->Server);
+$this->assertEquals('Tcp port: 0 Unix socket: /run/mysqld/mysqld.sock', $sessions[3]->Server);
+$this->assertEquals('Tcp port: 0 Unix socket: /run/mysqld/mysqld.sock', $sessions[4]->Server);
+$this->assertEquals('Tcp port: 0 Unix socket: /run/mysqld/mysqld.sock', $sessions[5]->Server);
+$this->assertEquals('mysqld, Version: 10.7.1-MariaDB-1:10.7.1+maria~focal-log (mariadb.org binary distribution)', $sessions[6]->Server);
+// It took until the previous session for mariadb to kick in, but going
+// forward "sessions without query entries" are parsed OK.
+$this->assertEquals('mysqld, Version: 10.7.1-MariaDB-1:10.7.1+maria~focal-log (mariadb.org binary distribution)', $sessions[7]->Server);
+$this->assertEquals('mysqld, Version: 10.7.1-MariaDB-1:10.7.1+maria~focal-log (mariadb.org binary distribution)', $sessions[8]->Server);
+$this->assertEquals('Unix socket: /run/mysqld/mysqld.sock', $sessions[8]->Transport);
+// See comments in logfile for why the query is not found in the first/third
+// entry (backward compatible style parsing). The comments are swept up into
+// a seventh fake entry.
+$this->assertCount(7, $entries);
+$this->assertEmpty($entries[0]->Query);
+$this->assertNotEmpty($entries[1]->Query);
+$this->assertEmpty($entries[2]->Query);
+$this->assertNotEmpty($entries[3]->Query);
+$this->assertNotEmpty($entries[4]->Query);
+$this->assertNotEmpty($entries[5]->Query);
+// Done on Mariadb only:
+// Comments above "Time: " are parsed:
+$this->assertEquals('0.001519', $entries[4]->Query_time);
+// Extra properties:
+$this->assertEquals('1', $entries[4]->Rows_affected);
+// "Time: 220907 18:55:33" is reformatted to be the same as mysql:
+$this->assertEquals('2022-09-07T18:55:33.000000Z', $entries[4]->Time);
+// Time is copied into next entry if not present in comment header:
+$this->assertEquals('2022-09-07T18:55:33.000000Z', $entries[5]->Time);
+}
+
 public function testSingleSession() : void
 {
 $parser = new \PHPFUI\MySQLSlowQuery\Parser(__DIR__ . '/logs/singleSession.log');
@@ -120,44 +160,4 @@ public function testTripleSession() : void
 $this->assertEquals('0', $entry->Rows_sent);
 $this->assertEquals('6', $entry->Rows_examined);
 }
-
-public function testMysqlVsMariadb() : void
-{
-$parser = new \PHPFUI\MySQLSlowQuery\Parser(__DIR__ . '/logs/ignoredData.log');
-$sessions = $parser->getSessions();
-$entries = $parser->getEntries();
-$this->assertCount(9, $sessions);
-// See comments in logfile for why session 3-6 are buggy and 7-9 are not.
-$this->assertEquals('c:\wamp64\bin\mysql\mysql8.0.21\bin\mysqld.exe, Version: 8.0.21 (MySQL Community Server - GPL)', $sessions[0]->Server);
-$this->assertEquals('c:\wamp64\bin\mysql\mysql8.0.21\bin\mysqld.exe, Version: 8.0.21 (MySQL Community Server - GPL)', $sessions[1]->Server);
-$this->assertEquals('Tcp Port: 3306, Named Pipe: /tmp/mysql.sock', $sessions[2]->Server);
-$this->assertEquals('Tcp port: 0 Unix socket: /run/mysqld/mysqld.sock', $sessions[3]->Server);
-$this->assertEquals('Tcp port: 0 Unix socket: /run/mysqld/mysqld.sock', $sessions[4]->Server);
-$this->assertEquals('Tcp port: 0 Unix socket: /run/mysqld/mysqld.sock', $sessions[5]->Server);
-$this->assertEquals('mysqld, Version: 10.7.1-MariaDB-1:10.7.1+maria~focal-log (mariadb.org binary distribution)', $sessions[6]->Server);
-// It took until the previous session for mariadb to kick in, but going
-// forward "sessions without query entries" are parsed OK.
-$this->assertEquals('mysqld, Version: 10.7.1-MariaDB-1:10.7.1+maria~focal-log (mariadb.org binary distribution)', $sessions[7]->Server);
-$this->assertEquals('mysqld, Version: 10.7.1-MariaDB-1:10.7.1+maria~focal-log (mariadb.org binary distribution)', $sessions[8]->Server);
-$this->assertEquals('Unix socket: /run/mysqld/mysqld.sock', $sessions[8]->Transport);
-// See comments in logfile for why the query is not found in the first/third
-// entry (backward compatible style parsing). The comments are swept up into
-// a seventh fake entry.
-$this->assertCount(7, $entries);
-$this->assertEmpty($entries[0]->Query);
-$this->assertNotEmpty($entries[1]->Query);
-$this->assertEmpty($entries[2]->Query);
-$this->assertNotEmpty($entries[3]->Query);
-$this->assertNotEmpty($entries[4]->Query);
-$this->assertNotEmpty($entries[5]->Query);
-// Done on Mariadb only:
-// Comments above "Time: " are parsed:
-$this->assertEquals('0.001519', $entries[4]->Query_time);
-// Extra properties:
-$this->assertEquals('1', $entries[4]->Rows_affected);
-// "Time: 220907 18:55:33" is reformatted to be the same as mysql:
-$this->assertEquals('2022-09-07T18:55:33.000000Z', $entries[4]->Time);
-// Time is copied into next entry if not present in comment header:
-$this->assertEquals('2022-09-07T18:55:33.000000Z', $entries[5]->Time);
-}
 }