Skip to content
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.

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

allow printing log messages during occ #873

Merged
merged 2 commits into from
Sep 18, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .github/workflows/psalm-matrix.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ jobs:
# do not stop on another job's failure
fail-fast: false
matrix:
ocp-version: [ 'dev-master', 'dev-stable27', 'dev-stable26', 'dev-stable25']
ocp-version: [ 'dev-master' ]

name: Nextcloud ${{ matrix.ocp-version }}
steps:
Expand Down
4 changes: 4 additions & 0 deletions appinfo/info.xml
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,10 @@
<namespace>LogReader</namespace>
<default_enable/>

<types>
<logging/>
</types>

<category>tools</category>
<website>https://github.com/nextcloud/logreader</website>
<bugs>https://github.com/nextcloud/logreader/issues</bugs>
Expand Down
3 changes: 3 additions & 0 deletions lib/AppInfo/Application.php
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,13 @@

namespace OCA\LogReader\AppInfo;

use OCA\LogReader\Listener\LogListener;
use OCA\LogReader\Log\Formatter;
use OCP\AppFramework\App;
use OCP\AppFramework\Bootstrap\IBootContext;
use OCP\AppFramework\Bootstrap\IBootstrap;
use OCP\AppFramework\Bootstrap\IRegistrationContext;
use OCP\Log\BeforeMessageLoggedEvent;
use Psr\Container\ContainerInterface;

class Application extends App implements IBootstrap {
Expand All @@ -36,6 +38,7 @@
}

public function register(IRegistrationContext $context): void {
$context->registerEventListener(BeforeMessageLoggedEvent::class, LogListener::class);

Check warning on line 41 in lib/AppInfo/Application.php

View check run for this annotation

Codecov / codecov/patch

lib/AppInfo/Application.php#L41

Added line #L41 was not covered by tests
$context->registerService(Formatter::class, function (ContainerInterface $c) {
return new Formatter(\OC::$SERVERROOT);
});
Expand Down
61 changes: 61 additions & 0 deletions lib/Listener/LogListener.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
<?php

declare(strict_types=1);
/**
* @copyright Copyright (c) 2023 Robin Appelman <[email protected]>
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/

namespace OCA\LogReader\Listener;

use OC\SystemConfig;
use OCA\LogReader\Log\Console;
use OCA\LogReader\Log\Formatter;
use OCP\EventDispatcher\Event;
use OCP\EventDispatcher\IEventListener;
use OCP\Log\BeforeMessageLoggedEvent;
use Symfony\Component\Console\Terminal;

class LogListener implements IEventListener {
private ?Console $console;

public function __construct(Formatter $formatter, SystemConfig $config) {
if (defined('OC_CONSOLE') && \OC_CONSOLE) {
$level = getenv('OCC_LOG');
if ($level) {
$terminal = new Terminal();
$this->console = new Console($formatter, $config, $level, $terminal->getWidth());

Check warning on line 42 in lib/Listener/LogListener.php

View check run for this annotation

Codecov / codecov/patch

lib/Listener/LogListener.php#L39-L42

Added lines #L39 - L42 were not covered by tests
} else {
$this->console = null;

Check warning on line 44 in lib/Listener/LogListener.php

View check run for this annotation

Codecov / codecov/patch

lib/Listener/LogListener.php#L44

Added line #L44 was not covered by tests
}
} else {
$this->console = null;
}
}


public function handle(Event $event): void {
if (!$event instanceof BeforeMessageLoggedEvent) {
return;

Check warning on line 54 in lib/Listener/LogListener.php

View check run for this annotation

Codecov / codecov/patch

lib/Listener/LogListener.php#L54

Added line #L54 was not covered by tests
}

if ($this->console) {
$this->console->log($event->getLevel(), $event->getApp(), $event->getMessage());

Check warning on line 58 in lib/Listener/LogListener.php

View check run for this annotation

Codecov / codecov/patch

lib/Listener/LogListener.php#L58

Added line #L58 was not covered by tests
}
}
}
87 changes: 87 additions & 0 deletions lib/Log/Console.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
<?php

declare(strict_types=1);
/**
* @copyright Copyright (c) 2023 Robin Appelman <[email protected]>
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/

namespace OCA\LogReader\Log;

use OC\Log\LogDetails;
use OC\SystemConfig;
use OCA\LogReader\Command\Tail;

/**
* Utility to write log messages to the console as they are emitted
*/
class Console extends LogDetails {
private int $level;
private int $terminalWidth;
private Formatter $formatter;

public function __construct(Formatter $formatter, SystemConfig $config, string $level, int $terminalWidth) {
parent::__construct($config);
$this->formatter = $formatter;
$this->level = self::parseLogLevel($level);
$this->terminalWidth = $terminalWidth;

Check warning on line 42 in lib/Log/Console.php

View check run for this annotation

Codecov / codecov/patch

lib/Log/Console.php#L38-L42

Added lines #L38 - L42 were not covered by tests
}

public function log(int $level, string $app, array $entry) {
if ($level >= $this->level) {
$messageWidth = $this->terminalWidth - 8 - 18 - 6;

Check warning on line 47 in lib/Log/Console.php

View check run for this annotation

Codecov / codecov/patch

lib/Log/Console.php#L45-L47

Added lines #L45 - L47 were not covered by tests
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

magic numbers (and in following lines are more magic numbers)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

They are the column widths that "seem to work best"

Same number as

$messageWidth = $totalWidth - 8 - 18 - 26 - 6;

Copy link
Member

@blizzz blizzz Jul 12, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Better kept in named constants imo. Anyway, not blocking, up to you.


$entry = $this->logDetails($app, $entry, $level);

Check warning on line 49 in lib/Log/Console.php

View check run for this annotation

Codecov / codecov/patch

lib/Log/Console.php#L49

Added line #L49 was not covered by tests

$lines = explode("\n", $this->formatter->formatMessage($entry, $messageWidth));
$lines[0] = str_pad(Tail::LEVELS[$level], 8) . ' ' .
str_pad(wordwrap($app, 18), 18) . ' ' .
str_pad($lines[0], $messageWidth);

Check warning on line 54 in lib/Log/Console.php

View check run for this annotation

Codecov / codecov/patch

lib/Log/Console.php#L51-L54

Added lines #L51 - L54 were not covered by tests

for ($i = 1; $i < count($lines); $i++) {
$lines[$i] = str_repeat(' ', 8 + 18 + 2) . $lines[$i];

Check warning on line 57 in lib/Log/Console.php

View check run for this annotation

Codecov / codecov/patch

lib/Log/Console.php#L56-L57

Added lines #L56 - L57 were not covered by tests
}

foreach ($lines as $line) {
fwrite(STDERR, $line . "\n");

Check warning on line 61 in lib/Log/Console.php

View check run for this annotation

Codecov / codecov/patch

lib/Log/Console.php#L60-L61

Added lines #L60 - L61 were not covered by tests
}
fwrite(STDERR, "\n");

Check warning on line 63 in lib/Log/Console.php

View check run for this annotation

Codecov / codecov/patch

lib/Log/Console.php#L63

Added line #L63 was not covered by tests
}
}

private static function parseLogLevel(string $level): int {
if (is_numeric($level)) {
return (int)$level;

Check warning on line 69 in lib/Log/Console.php

View check run for this annotation

Codecov / codecov/patch

lib/Log/Console.php#L67-L69

Added lines #L67 - L69 were not covered by tests
}

switch (strtoupper($level)) {
case "DEBUG":
return 0;
case "INFO":
return 1;
case "WARN":
return 2;
case "ERROR":
return 3;
case "FATAL":
return 4;

Check warning on line 82 in lib/Log/Console.php

View check run for this annotation

Codecov / codecov/patch

lib/Log/Console.php#L72-L82

Added lines #L72 - L82 were not covered by tests
default:
throw new \Exception("Unknown log level $level");

Check warning on line 84 in lib/Log/Console.php

View check run for this annotation

Codecov / codecov/patch

lib/Log/Console.php#L84

Added line #L84 was not covered by tests
}
}
}
15 changes: 15 additions & 0 deletions tests/stubs/stub.phpstub
Original file line number Diff line number Diff line change
Expand Up @@ -32,3 +32,18 @@ namespace OC\Core\Command {
class InterruptedException extends \Exception {
}
}

namespace OC {
class SystemConfig {
}
}

namespace OC\Log {
use OC\SystemConfig;
class LogDetails {
public function __construct(SystemConfig $config) {
}
public function logDetails(string $app, $message, int $level): array {
}
}
}
Loading