Merge pull request #1009 from noplanman/remove_monolog

Remove monolog and improve updates log importer.

Author: noplanman

CHANGELOG.md

@@ -6,15 +6,18 @@ Exclamation symbols (:exclamation:) note something of importance e.g. breaking c
 ## [Unreleased]
 ### Notes
 - [:ledger: View file changes][Unreleased]
+- :exclamation: Built-in logging (Monolog) has been removed, a custom PSR-3 logger must be used now! (see #964 for more info)
 ### Added
 - Code snippet in `GenericmessageCommand` to keep obsolete service message system commands working.
 - Static boolean property `SystemCommand::$execute_deprecated` (must be assigned before handling the request) to try and execute any deprecated system command.
 ### Changed
 - Small readme and code fixes / simplifications. 
 - Upgrade PHPUnit to 8.x and PHPCS to 3.5. For tests now minimum PHP version is 7.2.
+- Updated updates log importer (requires PHP7+).
 ### Deprecated
 ### Removed
 - Service message system commands, which are now handled by `GenericmessageCommand`.
+- [:exclamation:][unreleased-bc-remove-monolog-from-core] Monolog has been removed as built-in logging engine.
 - Assets have been moved to a dedicated repository.
 ### Fixed
 - Boolean value for Polls gets saved correctly in MySQL DB.
@@ -386,6 +389,7 @@ Exclamation symbols (:exclamation:) note something of importance e.g. breaking c
 ### Deprecated
 - Move `hideKeyboard` to `removeKeyboard`.
 
+[unreleased-bc-remove-monolog-from-core]: https://github.com/php-telegram-bot/core/wiki/Breaking-backwards-compatibility#remove-monolog-from-core
 [0.58.0-sql-migration]: https://github.com/php-telegram-bot/core/tree/master/utils/db-schema-update/0.57.0-0.58.0.sql
 [0.58.0-bc-return-value-of-empty-entity-properties]: https://github.com/php-telegram-bot/core/wiki/Breaking-backwards-compatibility#return-value-of-empty-entity-properties
 [0.58.0-bc-startcommand-is-now-a-usercommand]: https://github.com/php-telegram-bot/core/wiki/Breaking-backwards-compatibility#startcommand-is-now-a-usercommand

composer.json

@@ -29,13 +29,13 @@
         "ext-json": "*",
         "ext-mbstring": "*",
         "psr/log": "^1.1",
-        "monolog/monolog": "^1.25",
         "guzzlehttp/guzzle": "^6.3"
     },
     "require-dev": {
         "phpunit/phpunit": "^8.4",
         "squizlabs/php_codesniffer": "^3.4",
-        "dms/phpunit-arraysubset-asserts": "^0.1.0"
+        "dms/phpunit-arraysubset-asserts": "^0.1.0",
+        "monolog/monolog": "^2.0"
     },
     "autoload": {
         "psr-4": {

composer.lock

@@ -15,20 +15,20 @@ The first parameter is the main logger, the second one is used for the raw updat
 
 (in this example we're using [Monolog])
 ```php
+use Longman\TelegramBot\TelegramLog;
 use Monolog\Formatter\LineFormatter;
 use Monolog\Handler\StreamHandler;
 use Monolog\Logger;
-use Longman\TelegramBot\TelegramLog;
 
 TelegramLog::initialize(
-    // Main logger that handles all 'error' and 'debug' logs.
+    // Main logger that handles all 'debug' and 'error' logs.
     new Logger('telegram_bot', [
-        (new StreamHandler(__DIR__ . "/logs/{$bot_username}_debug.log", Logger::DEBUG))->setFormatter(new LineFormatter(null, null, true)),
-        (new StreamHandler(__DIR__ . "/logs/{$bot_username}_error.log", Logger::ERROR))->setFormatter(new LineFormatter(null, null, true)),
+        (new StreamHandler($path_to_debug_log_file, Logger::DEBUG))->setFormatter(new LineFormatter(null, null, true)),
+        (new StreamHandler($path_to_error_log_file, Logger::ERROR))->setFormatter(new LineFormatter(null, null, true)),
     ]),
     // Updates logger for raw updates.
     new Logger('telegram_bot_updates', [
-        (new StreamHandler(__DIR__ . "/logs/{$bot_username}_update.log", Logger::INFO))->setFormatter(new LineFormatter('%message%' . PHP_EOL)),
+        (new StreamHandler($path_to_updates_log_file, Logger::INFO))->setFormatter(new LineFormatter('%message%' . PHP_EOL)),
     ])
 );
 ```