Logging: prepare message only if log level is high enough

Also some clean ups on internal method call parameters
Per run logging was not set if flag changed
2023-06-05 09:30:26 +09:00 · 2023-06-02 17:38:09 +09:00 · 2023-06-01 13:03:46 +09:00 · 2023-06-01 12:00:20 +09:00 · 2023-06-01 11:02:53 +09:00 · 2023-06-01 10:58:11 +09:00
8 changed files with 132 additions and 94 deletions
--- a/4dev/tests/Debug/CoreLibsDebugSupportTest.php
+++ b/4dev/tests/Debug/CoreLibsDebugSupportTest.php
@@ -460,16 +460,18 @@ final class CoreLibsDebugSupportTest extends TestCase
 	 * Undocumented function
 	 *
 	 * @cover ::getCallerFileLine
-	 * @testWith ["/storage/var/www/html/developers/clemens/core_data/php_libraries/trunk/www/vendor/phpunit/phpunit/src/Framework/TestCase.php:1608"]
-	 * @testdox getCallerFileLine check if it returns $expected [$_dataName]
+	 * @testWith ["vendor/phpunit/phpunit/src/Framework/TestCase.php:"]
+	 * @testdox getCallerFileLine check based on regex /[\w\-\/]/vendor/phpunit/phpunit/src/Framework/TestCase.php:\d+ [$_dataName]
 	 *
 	 * @param  string $expected
 	 * @return void
 	 */
-	public function testGetCallerFileLine(string $expected): void
+	public function testGetCallerFileLine(): void
 	{
-		$this->assertEquals(
-			$expected,
+		// regex prefix with path "/../" and then fixed vendor + \d+
+		$regex = "/^\/[\w\-\/]+\/vendor\/phpunit\/phpunit\/src\/Framework\/TestCase.php:\d+$/";
+		$this->assertMatchesRegularExpression(
+			$regex,
 			Support::getCallerFileLine()
 		);
 	}
@@ -518,11 +520,17 @@ final class CoreLibsDebugSupportTest extends TestCase
 				break;
 			case 11:
 				// add one "run" before "runBare"
+				// array_splice(
+				// 	$expected,
+				// 	7,
+				// 	0,
+				// 	['run']
+				// );
 				array_splice(
 					$expected,
-					7,
 					0,
-					['run']
+					0,
+					['include']
 				);
 				$this->assertEquals(
 					$expected,
--- a/4dev/tests/Logging/CoreLibsLoggingLoggingTest.php
+++ b/4dev/tests/Logging/CoreLibsLoggingLoggingTest.php
@@ -20,10 +20,15 @@ final class CoreLibsLoggingLoggingTest extends TestCase
 	private const LOG_FOLDER = __DIR__ . DIRECTORY_SEPARATOR . 'log' . DIRECTORY_SEPARATOR;
 	private const REGEX_BASE = "\[[\d\-\s\.:]+\]\s{1}" // date
 		. "\[[\w\.]+(:\d+)?\]\s{1}" // host:port
-		. "\[[\w+\.\/]+:\d+\]\s{1}" // folder/file
+		. "\[[\w\-\.\/]+:\d+\]\s{1}" // folder/file
 		. "\[\w+\]\s{1}" // run id
 		. "{[\w\\\\]+(::\w+)?}\s{1}"; // class

+	public static function tearDownAfterClass(): void
+	{
+		array_map('unlink', glob(self::LOG_FOLDER . '*.log'));
+	}
+
 	/**
 	 * test set for options BASIC
 	 *
@@ -791,6 +796,13 @@ final class CoreLibsLoggingLoggingTest extends TestCase
 		);
 	}

+	// must test flow:
+	// init normal
+	// log -> check file name
+	// set per date
+	// log -> check file name
+	// and same for per_run
+
 	// deprecated calls check?
 }

--- a/www/admin/class_test.logging.php
+++ b/www/admin/class_test.logging.php
@@ -36,7 +36,7 @@ $log = new CoreLibs\Logging\Logging([
 	'log_per_date' => true,
 ]);

-$PAGE_NAME = 'TEST CLASS: DEBUG LOGGING';
+$PAGE_NAME = 'TEST CLASS: LOGGING';
 print "<!DOCTYPE html>";
 print "<html><head><title>" . $PAGE_NAME . "</title><head>";
 print "<body>";
@@ -44,12 +44,12 @@ print '<div><a href="class_test.php">Class Test Master</a></div>';
 print '<div><h1>' . $PAGE_NAME . '</h1></div>';

 $log->logger2Debug();
-
+echo "<hr>";
 print "Level 250: " . Level::fromValue(250)->getName() . "<br>";
-print "Flag: per_run (from int): " . Flag::fromValue(2)->getName() . "<br>";
-print "Flag: per_run getName(): " . Flag::per_class->getName() . "<br>";
-print "Flag: per_run ->name: " . Flag::per_class->name . "<br>";
-print "Flag: per_run ->value: " . Flag::per_class->value . "<br>";
+print "Flag: per_class (16) (from int): " . Flag::fromValue(16)->getName() . "<br>";
+print "Flag: per_class getName(): " . Flag::per_class->getName() . "<br>";
+print "Flag: per_class ->name: " . Flag::per_class->name . "<br>";
+print "Flag: per_class ->value: " . Flag::per_class->value . "<br>";
 $log->setLogUniqueId();
 print "LogUniqId: " . $log->getLogUniqueId() . "<br>";

@@ -76,10 +76,19 @@ with
 and > and <
 EOM));
 $log->info('Info message', ['info' => 'log']);
+$log->notice('Notice message', ['notice' => 'log']);
+$log->warning('Warning message', ['warning' => 'log']);
 $log->error('Cannot process data', ['error' => 'log']);
-
+$log->critical('Critical message', ['critical' => 'log']);
+$log->alert('Alert message', ['Alert' => 'log']);
+$log->emergency('Emergency message', ['Emergency' => 'log']);
 print "Log File: " . $log->getLogFile() . "<br>";

+$log->setLogFlag(Flag::per_run);
+$log->debug('PER RUN', 'per run logging');
+print "Log File: " . $log->getLogFile() . "<br>";
+$log->unsetLogFlag(Flag::per_run);
+
 // init empty
 unset($LOG_FILE_ID);
 $ll = new CoreLibs\Logging\Logging([
--- a/www/lib/CoreLibs/DB/IO.php
+++ b/www/lib/CoreLibs/DB/IO.php
@@ -382,7 +382,7 @@ class IO
 	/** @var array<mixed> */
 	private array $pk_name_table = [];
 	/** @var string internal primary key name, for cross calls in async */
-	private string $pk_name;
+	private string $pk_name = '';
 	/** @var bool if we use RETURNING in the INSERT call */
 	private bool $returning_id = false;
 	/** @var string if a sync is running holds the hash key of the query */
@@ -1267,7 +1267,7 @@ class IO
 					// ONLY insert with set pk name
 					($this->__checkQueryForInsert($this->query, true) && $this->pk_name != 'NULL') ||
 					// insert or update with returning add
-					($this->__checkQueryForInsert($this->query) &&  $this->returning_id)
+					($this->__checkQueryForInsert($this->query) && $this->returning_id)
 				) {
 					$this->__dbSetInsertId(
 						$this->returning_id,
--- a/www/lib/CoreLibs/Debug/Support.php
+++ b/www/lib/CoreLibs/Debug/Support.php
@@ -34,29 +34,29 @@ class Support
 	}

 	/**
-	 * prints a html formatted (pre) array
+	 * prints a html formatted (pre) data
 	 *
-	 * @param  array<mixed> $array   any array
-	 * @param  bool         $no_html default add <pre>
-	 * @return string                formatted array for output with <pre> tag added
+	 * @param  mixed  $data    any data
+	 * @param  bool   $no_html default add <pre>
+	 * @return string          formatted array for output with <pre> tag added
 	 */
-	public static function printAr(array $array, bool $no_html = false): string
+	public static function printAr(mixed $data, bool $no_html = false): string
 	{
 		return $no_html ?
-			print_r($array, true) :
-			'<pre>' . print_r($array, true) . '</pre>';
+			print_r($data, true) :
+			'<pre>' . print_r($data, true) . '</pre>';
 	}

 	/**
 	 * alternate name for printAr function
 	 *
-	 * @param  array<mixed> $array   any array
-	 * @param  bool         $no_html default add <pre>
-	 * @return string                formatted array for output with <pre> tag added
+	 * @param  mixed  $data    any array
+	 * @param  bool   $no_html default add <pre>
+	 * @return string          formatted array for output with <pre> tag added
 	 */
-	public static function printArray(array $array, bool $no_html = false): string
+	public static function printArray(mixed $data, bool $no_html = false): string
 	{
-		return self::printAr($array, $no_html);
+		return self::printAr($data, $no_html);
 	}

 	/**
@@ -65,12 +65,12 @@ class Support
 	 * Do not use this without using it in a string in debug function
 	 * Note: for full data debug dumps use Support::dumpVar()
 	 *
-	 * @param  array<mixed> $a Array to format
-	 * @return string          print_r formated
+	 * @param  mixed  $data Data to print
+	 * @return string       print_r formated
 	 */
-	public static function prAr(array $a): string
+	public static function prAr(mixed $data): string
 	{
-		return self::printAr($a, true);
+		return self::printAr($data, true);
 	}

 	/**
--- a/www/lib/CoreLibs/Logging/Logging.php
+++ b/www/lib/CoreLibs/Logging/Logging.php
@@ -407,13 +407,6 @@ class Logging
 			}
 			$this->setLogFlag($log_flag_key);
 		}
-		// init per run uid
-		if ($this->getLogFlag(Flag::per_run)) {
-			$this->setLogUniqueId();
-		} elseif ($this->getLogFlag(Flag::per_date)) {
-			// init file date
-			$this->log_file_date = date('Y-m-d');
-		}
 	}

 	/**
@@ -535,7 +528,7 @@ class Logging
 	 * Prepare the log message with all needed info blocks:
 	 * [timestamp] [host name] [file path + file] [running uid] {class} <debug level/group id> - message
 	 *
-	 * @param  string  $level_str    Log level we will write to
+	 * @param  Level $level    Log level we will write to
 	 * @param  string|Stringable $message  The message to write
 	 * @param  mixed[] $context Any additional info we want to attach in any format
 	 * @param  string $group_id A group id, only used in DEBUG level,
@@ -543,11 +536,15 @@ class Logging
 	 * @return string
 	 */
 	private function prepareLog(
-		string $level_str,
+		Level $level,
 		string|\Stringable $message,
 		array $context = [],
 		string $group_id = '',
 	): string {
+		// only prepare if to write log level is in set log level
+		if (!$this->checkLogLevel($level)) {
+			return '';
+		}
 		// file + line: call not this but one before (the one that calls this)
 		$file_line = Support::getCallerFileLine(2) ??
 			System::getPageName(System::FULL_PATH);
@@ -562,7 +559,7 @@ class Logging
 		$timestamp = Support::printTime();

 		// if group id is empty replace it with current level
-		$group_str = $level_str;
+		$group_str = $level->getName();
 		if (!empty($group_id)) {
 			$group_str .= ':' . $group_id;
 		}
@@ -776,6 +773,13 @@ class Logging
 	public function setLogFlag(Flag $flag): void
 	{
 		$this->log_flags |= $flag->value;
+		// init per run uid
+		if ($this->getLogFlag(Flag::per_run)) {
+			$this->setLogUniqueId();
+		} elseif ($this->getLogFlag(Flag::per_date)) {
+			// init file date
+			$this->setLogDate();
+		}
 	}

 	/**
@@ -927,9 +931,9 @@ class Logging
 		array $context = []
 	): bool {
 		return $this->writeErrorMsg(
-			$this->log_level,
+			Level::Debug,
 			$this->prepareLog(
-				Level::Debug->getName(),
+				Level::Debug,
 				$prefix . $message,
 				$context,
 				$group_id
@@ -950,7 +954,7 @@ class Logging
 		return $this->writeErrorMsg(
 			Level::Info,
 			$this->prepareLog(
-				Level::Info->getName(),
+				Level::Info,
 				$message,
 				$context,
 			)
@@ -969,7 +973,7 @@ class Logging
 		return $this->writeErrorMsg(
 			Level::Notice,
 			$this->prepareLog(
-				Level::Notice->getName(),
+				Level::Notice,
 				$message,
 				$context,
 			)
@@ -988,7 +992,7 @@ class Logging
 		return $this->writeErrorMsg(
 			Level::Warning,
 			$this->prepareLog(
-				Level::Warning->getName(),
+				Level::Warning,
 				$message,
 				$context,
 			)
@@ -1007,7 +1011,7 @@ class Logging
 		return $this->writeErrorMsg(
 			Level::Error,
 			$this->prepareLog(
-				Level::Error->getName(),
+				Level::Error,
 				$message,
 				$context,
 			)
@@ -1026,7 +1030,7 @@ class Logging
 		return $this->writeErrorMsg(
 			Level::Critical,
 			$this->prepareLog(
-				Level::Critical->getName(),
+				Level::Critical,
 				$message,
 				$context,
 			)
@@ -1045,7 +1049,7 @@ class Logging
 		return $this->writeErrorMsg(
 			Level::Alert,
 			$this->prepareLog(
-				Level::Alert->getName(),
+				Level::Alert,
 				$message,
 				$context,
 			)
@@ -1064,7 +1068,7 @@ class Logging
 		return $this->writeErrorMsg(
 			Level::Emergency,
 			$this->prepareLog(
-				Level::Emergency->getName(),
+				Level::Emergency,
 				$message,
 				$context,
 			)
@@ -1082,12 +1086,12 @@ class Logging
 	 * But this does not wrap it in <pre></pre>
 	 * Do not use this without using it in a string in debug function
 	 *
-	 * @param  array<mixed> $a Array to format
-	 * @return string          print_r formated
+	 * @param  mixed  $data Data to format
+	 * @return string       print_r formated
 	 */
-	public function prAr(array $a): string
+	public function prAr(mixed $data): string
 	{
-		return Support::printArray($a, true);
+		return Support::printArray($data, true);
 	}

 	/**
--- a/www/lib/CoreLibs/Output/Form/Generate.php
+++ b/www/lib/CoreLibs/Output/Form/Generate.php
@@ -232,13 +232,13 @@ class Generate extends \CoreLibs\DB\Extended\ArrayIO
 	/** @var string */
 	public string $col_name; // the name of the columen (before _<type>) [used for order button]
 	/** @var int */
-	public int $yes; // the yes flag that triggers the template to show ALL and not only new/load
+	public int $yes = 0; // the yes flag that triggers the template to show ALL and not only new/load
 	/** @var string */
-	public string $msg; // the error msg
+	public string $msg = ''; // the error msg
 	/** @var int */
-	public int $error; // the error flag set for printing red error msg
+	public int $error = 0; // the error flag set for printing red error msg
 	/** @var int */
-	public int $warning; // warning flag, for information (saved, loaded, etc)
+	public int $warning = 0; // warning flag, for information (saved, loaded, etc)
 	/** @var string */
 	public string $archive_pk_name; // the pk name for the load select form
 	/** @var string */
@@ -282,7 +282,7 @@ class Generate extends \CoreLibs\DB\Extended\ArrayIO
 	public array $login_acl = [];
 	// layout publics
 	/** @var int */
-	public int $table_width;
+	public int $table_width = 0;
 	// internal lang & encoding vars
 	/** @var string */
 	public string $lang_dir = '';
--- a/www/lib/CoreLibs/Template/SmartyExtend.php
+++ b/www/lib/CoreLibs/Template/SmartyExtend.php
@@ -77,79 +77,79 @@ class SmartyExtend extends \Smarty
 	public string $COMPILE_ID = '';
 	// template vars
 	/** @var string */
-	public string $MASTER_TEMPLATE_NAME;
+	public string $MASTER_TEMPLATE_NAME = '';
 	/** @var string */
-	public string $PAGE_FILE_NAME;
+	public string $PAGE_FILE_NAME = '';
 	/** @var string */
-	public string $CONTENT_INCLUDE;
+	public string $CONTENT_INCLUDE = '';
 	/** @var string */
-	public string $FORM_NAME;
+	public string $FORM_NAME = '';
 	/** @var string */
-	public string $FORM_ACTION;
+	public string $FORM_ACTION = '';
 	/** @var string */
-	public string $L_TITLE;
+	public string $L_TITLE = '';
 	/** @var string|int */
 	public string|int $PAGE_WIDTH;
 	// smarty include/set var
 	/** @var string */
-	public string $TEMPLATE_PATH;
+	public string $TEMPLATE_PATH = '';
 	/** @var string */
-	public string $TEMPLATE_NAME;
+	public string $TEMPLATE_NAME = '';
 	/** @var string */
-	public string $INC_TEMPLATE_NAME;
+	public string $INC_TEMPLATE_NAME = '';
 	/** @var string */
-	public string $JS_TEMPLATE_NAME;
+	public string $JS_TEMPLATE_NAME = '';
 	/** @var string */
-	public string $CSS_TEMPLATE_NAME;
+	public string $CSS_TEMPLATE_NAME = '';
 	/** @var string|null */
 	public string|null $TEMPLATE_TRANSLATE;
 	/** @var string|null */
 	public string|null $JS_TRANSLATE;
 	// core group
 	/** @var string */
-	public string $JS_CORE_TEMPLATE_NAME;
+	public string $JS_CORE_TEMPLATE_NAME = '';
 	/** @var string */
-	public string $CSS_CORE_TEMPLATE_NAME;
+	public string $CSS_CORE_TEMPLATE_NAME = '';
 	/** @var string */
-	public string $JS_CORE_INCLUDE;
+	public string $JS_CORE_INCLUDE = '';
 	/** @var string */
-	public string $CSS_CORE_INCLUDE;
+	public string $CSS_CORE_INCLUDE = '';
 	// local names
 	/** @var string */
 	public string $JS_SPECIAL_TEMPLATE_NAME = '';
 	/** @var string */
 	public string $CSS_SPECIAL_TEMPLATE_NAME = '';
 	/** @var string */
-	public string $JS_INCLUDE;
+	public string $JS_INCLUDE = '';
 	/** @var string */
-	public string $CSS_INCLUDE;
+	public string $CSS_INCLUDE = '';
 	/** @var string */
-	public string $JS_SPECIAL_INCLUDE;
+	public string $JS_SPECIAL_INCLUDE = '';
 	/** @var string */
-	public string $CSS_SPECIAL_INCLUDE;
+	public string $CSS_SPECIAL_INCLUDE = '';
 	/** @var string */
-	public string $ADMIN_JAVASCRIPT;
+	public string $ADMIN_JAVASCRIPT = '';
 	/** @var string */
-	public string $ADMIN_STYLESHEET;
+	public string $ADMIN_STYLESHEET = '';
 	/** @var string */
-	public string $FRONTEND_JAVASCRIPT;
+	public string $FRONTEND_JAVASCRIPT = '';
 	/** @var string */
-	public string $FRONTEND_STYLESHEET;
+	public string $FRONTEND_STYLESHEET = '';
 	// other smarty folder vars
 	/** @var string */
-	public string $INCLUDES;
+	public string $INCLUDES = '';
 	/** @var string */
-	public string $JAVASCRIPT;
+	public string $JAVASCRIPT = '';
 	/** @var string */
-	public string $CSS;
+	public string $CSS = '';
 	/** @var string */
-	public string $FONT;
+	public string $FONT = '';
 	/** @var string */
-	public string $PICTURES;
+	public string $PICTURES = '';
 	/** @var string */
-	public string $CACHE_PICTURES;
+	public string $CACHE_PICTURES = '';
 	/** @var string */
-	public string $CACHE_PICTURES_ROOT;
+	public string $CACHE_PICTURES_ROOT = '';

 	// constructor class, just sets the language stuff
 	/**
@@ -373,7 +373,7 @@ class SmartyExtend extends \Smarty
 		// check for template include
 		if (
 			$this->USE_INCLUDE_TEMPLATE === true &&
-			!$this->TEMPLATE_NAME
+			empty($this->TEMPLATE_NAME)
 		) {
 			$this->TEMPLATE_NAME = $this->CONTENT_INCLUDE;
 			// add to cache & compile id
@@ -390,7 +390,7 @@ class SmartyExtend extends \Smarty
 			exit('MASTER TEMPLATE: ' . $this->MASTER_TEMPLATE_NAME . ' could not be found');
 		}
 		if (
-			$this->TEMPLATE_NAME &&
+			!empty($this->TEMPLATE_NAME) &&
 			!file_exists($this->getTemplateDir()[0] . DIRECTORY_SEPARATOR . $this->TEMPLATE_NAME)
 		) {
 			exit('INCLUDE TEMPLATE: ' . $this->TEMPLATE_NAME . ' could not be found');
@@ -418,7 +418,12 @@ class SmartyExtend extends \Smarty
 			}
 		}
 		// if we can't find it, dump it
-		if (!file_exists($this->getTemplateDir()[0] . DIRECTORY_SEPARATOR . $this->TEMPLATE_TRANSLATE)) {
+		if (
+			!file_exists(
+				$this->getTemplateDir()[0] . DIRECTORY_SEPARATOR
+					. $this->TEMPLATE_TRANSLATE
+			)
+		) {
 			$this->TEMPLATE_TRANSLATE = null;
 		}
 		if (empty($this->JS_TRANSLATE)) {
Author	SHA1	Message	Date
Clemens Schwaighofer	ec3ca787fa	Logging: prepare message only if log level is high enough Also some clean ups on internal method call parameters	2023-06-05 09:30:26 +09:00
Clemens Schwaighofer	86acbbb85b	Per run logging was not set if flag changed if setFlag was set for per_run or per_date the init values where not set Fixed that on setFlag it is checked if we have per_date or per_run and then set if not set. Not that for date, set the flag will set a new date, for per run no.	2023-06-02 17:38:09 +09:00
Clemens Schwaighofer	8e0af7a5f7	Class var init fixes	2023-06-01 13:03:46 +09:00
Clemens Schwaighofer	b022662dfc	Removed restrictions for printAr to only accept arrays print_r call takes any value, changed that for all functions array -> mixed	2023-06-01 12:00:20 +09:00
Clemens Schwaighofer	3039ebf913	Unlink files after test	2023-06-01 11:02:53 +09:00
Clemens Schwaighofer	e2e080c404	Bug fix for DB\IO	2023-06-01 10:58:11 +09:00
Clemens Schwaighofer	4671143d1c	phpunit debug fixes	2023-06-01 09:13:59 +09:00
Clemens Schwaighofer	b492558cca	Logging unit test regex fix	2023-06-01 08:54:47 +09:00