Skip to content

feat: track overly long activities #56340

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

Draft
miaulalala wants to merge 1 commit into
base: master
Choose a base branch
from
+169 −64
Draft

feat: track overly long activities #56340

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
84 changes: 43 additions & 41 deletions lib/private/Activity/Event.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,59 +11,43 @@

use OCP\Activity\Exceptions\InvalidValueException;
use OCP\Activity\IEvent;
use OCP\IAppConfig;
use OCP\RichObjectStrings\InvalidObjectExeption;
use OCP\RichObjectStrings\IRichTextFormatter;
use OCP\RichObjectStrings\IValidator;
use Psr\Log\LoggerInterface;

class Event implements IEvent {
/** @var string */
protected $app = '';
/** @var string */
protected $type = '';
/** @var string */
protected $affectedUser = '';
/** @var string */
protected $author = '';
/** @var int */
protected $timestamp = 0;
/** @var string */
protected $subject = '';
/** @var array */
protected $subjectParameters = [];
/** @var string */
protected $subjectParsed = '';
/** @var string */
protected $subjectRich = '';
protected string $app = '';
protected string $type = '';
protected string $affectedUser = '';
protected string $author = '';
protected int $timestamp = 0;
protected string $subject = '';
protected array $subjectParameters = [];
protected string $subjectParsed = '';
protected string $subjectRich = '';
/** @var array<string, array<string, string>> */
protected $subjectRichParameters = [];
/** @var string */
protected $message = '';
/** @var array */
protected $messageParameters = [];
/** @var string */
protected $messageParsed = '';
/** @var string */
protected $messageRich = '';
protected array $subjectRichParameters = [];
protected string $message = '';
protected array $messageParameters = [];
protected string $messageParsed = '';
protected string $messageRich = '';
/** @var array<string, array<string, string>> */
protected $messageRichParameters = [];
/** @var string */
protected $objectType = '';
protected array $messageRichParameters = [];
protected string $objectType = '';
protected string|int $objectId = 0;
/** @var string */
protected $objectName = '';
/** @var string */
protected $link = '';
/** @var string */
protected $icon = '';
/** @var bool */
protected $generateNotification = true;

/** @var IEvent|null */
protected $child;
protected string $objectName = '';
protected string $link = '';
protected string $icon = '';
protected bool $generateNotification = true;
protected ?IEvent $child;

public function __construct(
protected IValidator $richValidator,
protected IRichTextFormatter $richTextFormatter,
protected LoggerInterface $logger,
protected IAppConfig $appConfig,
) {
}

Expand Down Expand Up @@ -164,6 +148,24 @@ public function setSubject(string $subject, array $parameters = []): IEvent {
if (isset($subject[255])) {
throw new InvalidValueException('subject');
}

$counter = $this->appConfig->getValueInt('activity', 'overly_long_activities', 0);
$return = [];
array_walk_recursive($parameters, static function ($a) use (&$return) { $return[] = $a; });
$parameter = implode('', $return);

if (strlen($parameter) > 4000) {
$counter++;
$this->logger->error('Activity with over 4000 characters detected', ['app' => $this->getApp()]);
} elseif (strlen($parameter) > 2000) {
$counter++;
$this->logger->warning('Activity with over 2000 characters detected', ['app' => $this->getApp()]);
}

if ($counter !== 0) {
$this->appConfig->setValueInt('activity', 'overly_long_activities', $counter);
}

$this->subject = $subject;
$this->subjectParameters = $parameters;
return $this;
Expand Down
41 changes: 19 additions & 22 deletions lib/private/Activity/Manager.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,27 +19,21 @@
use OCP\Activity\IProvider;
use OCP\Activity\ISetting;
use OCP\AppFramework\Utility\ITimeFactory;
use OCP\IAppConfig;
use OCP\IConfig;
use OCP\IL10N;
use OCP\IRequest;
use OCP\IUser;
use OCP\IUserSession;
use OCP\RichObjectStrings\IRichTextFormatter;
use OCP\RichObjectStrings\IValidator;
use Psr\Log\LoggerInterface;

class Manager implements IManager {

/** @var string */
protected $formattingObjectType;

/** @var int|string */
protected $formattingObjectId;

/** @var bool */
protected $requirePNG = false;

/** @var string */
protected $currentUserId;
protected string $formattingObjectType;
protected string|int $formattingObjectId;
protected bool $requirePNG = false;
protected ?string $currentUserId;

public function __construct(
protected IRequest $request,
Expand All @@ -49,17 +43,20 @@
protected IRichTextFormatter $richTextFormatter,
protected IL10N $l10n,
protected ITimeFactory $timeFactory,
protected IAppConfig $appConfig,
protected LoggerInterface $logger,
) {
$this->currentUserId = $this->session->getUser()?->getUID();
}

/** @var \Closure[] */
private $consumersClosures = [];
private array $consumersClosures = [];

/** @var IConsumer[] */
private $consumers = [];
private array $consumers = [];

/**
* @return \OCP\Activity\IConsumer[]
* @return IConsumer[]
*/
protected function getConsumers(): array {
if (!empty($this->consumers)) {
Expand Down Expand Up @@ -92,7 +89,7 @@
* @return IEvent
*/
public function generateEvent(): IEvent {
return new Event($this->validator, $this->richTextFormatter);
return new Event($this->validator, $this->richTextFormatter, $this->logger, $this->appConfig);
}

/**
Expand Down Expand Up @@ -163,10 +160,10 @@
}

/** @var string[] */
protected $filterClasses = [];
protected array $filterClasses = [];

/** @var IFilter[] */
protected $filters = [];
protected array $filters = [];

/**
* @param string $filter Class must implement OCA\Activity\IFilter
Expand Down Expand Up @@ -210,10 +207,10 @@
}

/** @var string[] */
protected $providerClasses = [];
protected array $providerClasses = [];

/** @var IProvider[] */
protected $providers = [];
protected array $providers = [];

/**
* @param string $provider Class must implement OCA\Activity\IProvider
Expand Down Expand Up @@ -244,10 +241,10 @@
}

/** @var string[] */
protected $settingsClasses = [];
protected array $settingsClasses = [];

/** @var ISetting[] */
protected $settings = [];
protected array $settings = [];

/**
* @param string $setting Class must implement OCA\Activity\ISetting
Expand Down Expand Up @@ -308,7 +305,7 @@
* @return bool
*/
public function isFormattingFilteredObject(): bool {
return $this->formattingObjectType !== null && $this->formattingObjectId !== null

Check failure on line 308 in lib/private/Activity/Manager.php

View workflow job for this annotation

GitHub Actions / static-code-analysis

RedundantCondition 

lib/private/Activity/Manager.php:308:50: RedundantCondition: int|string can never contain null (see https://psalm.dev/122)

Check failure on line 308 in lib/private/Activity/Manager.php

View workflow job for this annotation

GitHub Actions / static-code-analysis

RedundantCondition 

lib/private/Activity/Manager.php:308:10: RedundantCondition: Type int|string for $this->formattingObjectId is never null (see https://psalm.dev/122)

Check failure on line 308 in lib/private/Activity/Manager.php

View workflow job for this annotation

GitHub Actions / static-code-analysis

RedundantCondition 

lib/private/Activity/Manager.php:308:10: RedundantCondition: string can never contain null (see https://psalm.dev/122)
&& $this->formattingObjectType === $this->request->getParam('object_type')
&& $this->formattingObjectId === (int)$this->request->getParam('object_id');
}
Expand Down
4 changes: 3 additions & 1 deletion lib/private/Server.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -633,13 +633,15 @@ public function __construct($webRoot, \OC\Config $config) {
$this->registerService(\OCP\Activity\IManager::class, function (Server $c) {
$l10n = $this->get(IFactory::class)->get('lib');
return new \OC\Activity\Manager(
$c->getRequest(),
$c->get(IRequest::class),
$c->get(IUserSession::class),
$c->get(\OCP\IConfig::class),
$c->get(IValidator::class),
$c->get(IRichTextFormatter::class),
$l10n,
$c->get(ITimeFactory::class),
$c->get(IAppConfig::class),
$c->get(LoggerInterface::class),
);
});

Expand Down
104 changes: 104 additions & 0 deletions tests/lib/Activity/ManagerTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,13 @@

namespace Test\Activity;

use OC;
use OC\Activity\Manager;
use OCP\Activity\Exceptions\IncompleteActivityException;
use OCP\Activity\IConsumer;
use OCP\Activity\IEvent;
use OCP\AppFramework\Utility\ITimeFactory;
use OCP\IAppConfig;
use OCP\IConfig;
use OCP\IL10N;
use OCP\IRequest;
Expand All @@ -23,6 +25,7 @@
use OCP\RichObjectStrings\IRichTextFormatter;
use OCP\RichObjectStrings\IValidator;
use PHPUnit\Framework\MockObject\MockObject;
use Psr\Log\LoggerInterface;
use Test\TestCase;

class ManagerTest extends TestCase {
Expand All @@ -34,6 +37,8 @@ class ManagerTest extends TestCase {
protected IValidator&MockObject $validator;
protected IRichTextFormatter&MockObject $richTextFormatter;
private ITimeFactory&MockObject $time;
private IAppConfig $appConfig;
private LoggerInterface&MockObject $logger;

protected function setUp(): void {
parent::setUp();
Expand All @@ -44,6 +49,8 @@ protected function setUp(): void {
$this->validator = $this->createMock(IValidator::class);
$this->richTextFormatter = $this->createMock(IRichTextFormatter::class);
$this->time = $this->createMock(ITimeFactory::class);
$this->appConfig = OC::$server->get(IAppConfig::class);
$this->logger = $this->createMock(LoggerInterface::class);

$this->activityManager = new Manager(
$this->request,
Expand All @@ -53,6 +60,8 @@ protected function setUp(): void {
$this->richTextFormatter,
$this->createMock(IL10N::class),
$this->time,
$this->appConfig,
$this->logger,
);

$this->assertSame([], self::invokePrivate($this->activityManager, 'getConsumers'));
Expand Down Expand Up @@ -291,6 +300,101 @@ public function testPublishAllManually(): void {

$this->activityManager->publish($event);
}

public function testPublishWithSuperLongNestedParams(): void {
$this->appConfig->setValueInt('activity', 'overly_long_activities', 0);
$params = [
'level_one' => [
'title' => 'Lorem ipsum dolor sit amet',
'intro' => 'Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.',
'level_two' => [
[
'heading' => 'Sed ut perspiciatis unde omnis',
'body' => 'Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo. Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt.'
],
[
'heading' => 'Neque porro quisquam est',
'body' => 'Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem. Ut enim ad minima veniam, quis nostrum exercitationem ullam corporis suscipit laboriosam.'
]
]
],
'level_three' => [
'section_a' => [
'text' => 'At vero eos et accusamus et iusto odio dignissimos ducimus qui blanditiis praesentium voluptatum deleniti atque corrupti quos dolores et quas molestias excepturi sint occaecati cupiditate non provident, similique sunt in culpa qui officia deserunt mollitia animi, id est laborum et dolorum fuga.',
'more_text' => 'Et harum quidem rerum facilis est et expedita distinctio. Nam libero tempore, cum soluta nobis est eligendi optio cumque nihil impedit quo minus id quod maxime placeat facere possimus, omnis voluptas assumenda est, omnis dolor repellendus.'
],
'section_b' => [
'paragraphs' => [
'Temporibus autem quibusdam et aut officiis debitis aut rerum necessitatibus saepe eveniet ut et voluptates repudiandae sint et molestiae non recusandae. Itaque earum rerum hic tenetur a sapiente delectus.',
'Ut aut reiciendis voluptatibus maiores alias consequatur aut perferendis doloribus asperiores repellat. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.',
'Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.'
]
]
],
'level_four' => [
'deep' => [
'deeper' => [
'block_one' => 'Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam.',
'block_two' => 'Eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo. Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit.',
'block_three' => 'Sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt. Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit.'
]
]
],
'level_five' => [
'massive_text' => 'Sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem. Ut enim ad minima veniam, quis nostrum exercitationem ullam corporis suscipit laboriosam, nisi ut aliquid ex ea commodi consequatur? Quis autem vel eum iure reprehenderit qui in ea voluptate velit esse quam nihil molestiae consequatur, vel illum qui dolorem eum fugiat quo voluptas nulla pariatur. At vero eos et accusamus et iusto odio dignissimos ducimus qui blanditiis praesentium voluptatum deleniti atque corrupti quos dolores et quas molestias excepturi sint occaecati cupiditate non provident, similique sunt in culpa qui officia deserunt mollitia animi, id est laborum et dolorum fuga. Et harum quidem rerum facilis est et expedita distinctio. Nam libero tempore, cum soluta nobis est eligendi optio cumque nihil impedit quo minus id quod maxime placeat facere possimus.'
],
'level_six' => [
'repeat_blocks' => [
[
'text' => 'Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.'
],
[
'text' => 'Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollitia animi.'
],
[
'text' => 'Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo.'
]
]
]
];

$event = $event2 = $this->activityManager->generateEvent();
$event->setApp('test_app')
->setType('test_type')
->setAffectedUser('test_affected')
->setAuthor('test_author')
->setTimestamp(1337)
->setSubject('test_subject', $params)
->setMessage('test_message', ['test_message_params'])
->setObject('test_object_type', 42, 'test_object_name')
->setLink('test_link');

$this->assertEquals(1, $this->appConfig->getValueInt('activity', 'overly_long_activities'));

$event2->setApp('test_app')
->setType('test_type')
->setAffectedUser('test_affected')
->setAuthor('test_author')
->setTimestamp(1337)
->setSubject('test_subject', $params)
->setMessage('test_message', ['test_message_params'])
->setObject('test_object_type', 42, 'test_object_name')
->setLink('test_link');

$consumer = $this->getMockBuilder('OCP\Activity\IConsumer')
->disableOriginalConstructor()
->getMock();
$consumer->method('receive');
$this->activityManager->registerConsumer(function () use ($consumer) {
return $consumer;
});

$this->activityManager->publish($event);
$this->activityManager->publish($event2);
$this->assertEquals(2, $this->appConfig->getValueInt('activity', 'overly_long_activities'));
$this->appConfig->setValueInt('activity', 'overly_long_activities', 0);

}
}

class NoOpConsumer implements IConsumer {
Expand Down
Loading