Skip to content

feat: make amount of items sent on email configurable via occ #2673

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

Open
cristianscheid wants to merge 1 commit into
base: master
Choose a base branch
from
+35 −4
Open

feat: make amount of items sent on email configurable via occ #2673

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
19 changes: 15 additions & 4 deletions lib/MailQueueHandler.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@
class MailQueueHandler {
public const CLI_EMAIL_BATCH_SIZE = 500;
public const WEB_EMAIL_BATCH_SIZE = 25;
/** Number of entries we want to list in the email */
public const ENTRY_LIMIT = 200;
public const MAIL_MAX_ITEMS_DEFAULT = 200;
public const MAIL_MAX_ITEMS_CAP = 1000;

protected array $languages;
protected string $senderAddress;
Expand Down Expand Up @@ -191,7 +191,7 @@ private function fetchAffectedUsers(IQueryBuilder $query): array {
*
* @return array [data of the first max. 200 entries, total number of entries]
*/
protected function getItemsForUser(string $affectedUser, int $maxTime, int $maxNumItems = self::ENTRY_LIMIT): array {
protected function getItemsForUser(string $affectedUser, int $maxTime, int $maxNumItems = self::MAIL_MAX_ITEMS_DEFAULT): array {
$query = $this->connection->getQueryBuilder();
$query->select('*')
->from('activity_mq')
Expand Down Expand Up @@ -282,7 +282,7 @@ protected function sendEmailToUser(string $userName, string $email, string $lang
return true;
}

[$mailData, $skippedCount] = $this->getItemsForUser($userName, $maxTime);
[$mailData, $skippedCount] = $this->getItemsForUser($userName, $maxTime, $this->getMailMaxItems());

$l = $this->getLanguage($lang);
$this->activityManager->setCurrentUserId($userName);
Expand Down Expand Up @@ -416,4 +416,15 @@ protected function deleteSentItems(array $affectedUsers, int $maxTime): void {
->andWhere($query->expr()->in('amq_affecteduser', $query->createNamedParameter($affectedUsers, IQueryBuilder::PARAM_STR_ARRAY), IQueryBuilder::PARAM_STR));
$query->executeStatement();
}

private function getMailMaxItems(): int {
$maxItems = $this->appConfig->getValueInt('activity', 'mail_max_items', self::MAIL_MAX_ITEMS_DEFAULT);
if ($maxItems < 1) {
return 1;
}
if ($maxItems > self::MAIL_MAX_ITEMS_CAP) {
return self::MAIL_MAX_ITEMS_CAP;
}
return $maxItems;
}
}
20 changes: 20 additions & 0 deletions tests/MailQueueHandlerTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -403,6 +403,26 @@ public function testSendEmailsSkipsWhenAdminEmailDisabled(): void {
}
}

public function testGetMailMaxItemsReturnsCapWhenValueExceedsCap(): void {
$this->appConfig->method('getValueInt')
->with('activity', 'mail_max_items', $this->mailQueueHandler::MAIL_MAX_ITEMS_DEFAULT)
->willReturn(9999);

$result = self::invokePrivate($this->mailQueueHandler, 'getMailMaxItems', []);

$this->assertSame(MailQueueHandler::MAIL_MAX_ITEMS_CAP, $result);
}

public function testGetMailMaxItemsReturnsOneWhenValueIsBelowOne(): void {
$this->appConfig->method('getValueInt')
->with('activity', 'mail_max_items', $this->mailQueueHandler::MAIL_MAX_ITEMS_DEFAULT)
->willReturn(0);

$result = self::invokePrivate($this->mailQueueHandler, 'getMailMaxItems', []);

$this->assertSame(1, $result);
}

/**
* @param array $users
* @param int $maxTime
Expand Down
Loading