From 96a0cc3721f17735f886c56044d524e5a9eaff4d Mon Sep 17 00:00:00 2001 From: Anna Larch Date: Mon, 10 Nov 2025 07:22:55 +0100 Subject: [PATCH] feat: track overly long activities For activities with very long content, track them and add them to the setup check Signed-off-by: Anna Larch --- lib/private/Activity/Event.php | 84 +++++++++++------------ lib/private/Activity/Manager.php | 41 ++++++------ lib/private/Server.php | 4 +- tests/lib/Activity/ManagerTest.php | 104 +++++++++++++++++++++++++++++ 4 files changed, 169 insertions(+), 64 deletions(-) diff --git a/lib/private/Activity/Event.php b/lib/private/Activity/Event.php index 6a2bc5dba7777..d90871fc3f48d 100644 --- a/lib/private/Activity/Event.php +++ b/lib/private/Activity/Event.php @@ -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> */ - 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> */ - 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, ) { } @@ -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; diff --git a/lib/private/Activity/Manager.php b/lib/private/Activity/Manager.php index 9868abe512726..40f894c5442e1 100644 --- a/lib/private/Activity/Manager.php +++ b/lib/private/Activity/Manager.php @@ -19,6 +19,7 @@ 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; @@ -26,20 +27,13 @@ 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, @@ -49,17 +43,20 @@ public function __construct( 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)) { @@ -92,7 +89,7 @@ protected function getConsumers(): array { * @return IEvent */ public function generateEvent(): IEvent { - return new Event($this->validator, $this->richTextFormatter); + return new Event($this->validator, $this->richTextFormatter, $this->logger, $this->appConfig); } /** @@ -163,10 +160,10 @@ public function registerConsumer(\Closure $callable): void { } /** @var string[] */ - protected $filterClasses = []; + protected array $filterClasses = []; /** @var IFilter[] */ - protected $filters = []; + protected array $filters = []; /** * @param string $filter Class must implement OCA\Activity\IFilter @@ -210,10 +207,10 @@ public function getFilterById(string $id): IFilter { } /** @var string[] */ - protected $providerClasses = []; + protected array $providerClasses = []; /** @var IProvider[] */ - protected $providers = []; + protected array $providers = []; /** * @param string $provider Class must implement OCA\Activity\IProvider @@ -244,10 +241,10 @@ public function getProviders(): array { } /** @var string[] */ - protected $settingsClasses = []; + protected array $settingsClasses = []; /** @var ISetting[] */ - protected $settings = []; + protected array $settings = []; /** * @param string $setting Class must implement OCA\Activity\ISetting diff --git a/lib/private/Server.php b/lib/private/Server.php index 04db3eea842f5..f553c47075689 100644 --- a/lib/private/Server.php +++ b/lib/private/Server.php @@ -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), ); }); diff --git a/tests/lib/Activity/ManagerTest.php b/tests/lib/Activity/ManagerTest.php index 70b6ab1c4f6ed..f142c809de15b 100644 --- a/tests/lib/Activity/ManagerTest.php +++ b/tests/lib/Activity/ManagerTest.php @@ -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; @@ -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 { @@ -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(); @@ -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, @@ -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')); @@ -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 {