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

draft: Introduce conversation property version with lock on updates #13163

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
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
13 changes: 13 additions & 0 deletions lib/Exceptions/RoomLockedException.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<?php

declare(strict_types=1);
/**
* SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
* SPDX-License-Identifier: AGPL-3.0-or-later
*/


namespace OCA\Talk\Exceptions;

class RoomLockedException extends \RuntimeException {
}
56 changes: 51 additions & 5 deletions lib/Service/RoomService.php
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
namespace OCA\Talk\Service;

use InvalidArgumentException;
use OC\Memcache\NullCache;
use OCA\Talk\Config;
use OCA\Talk\Events\AParticipantModifiedEvent;
use OCA\Talk\Events\ARoomModifiedEvent;
Expand All @@ -26,6 +27,7 @@
use OCA\Talk\Events\RoomModifiedEvent;
use OCA\Talk\Events\RoomPasswordVerifyEvent;
use OCA\Talk\Events\RoomSyncedEvent;
use OCA\Talk\Exceptions\RoomLockedException;
use OCA\Talk\Exceptions\RoomNotFoundException;
use OCA\Talk\Manager;
use OCA\Talk\Model\Attendee;
Expand All @@ -37,10 +39,14 @@
use OCP\AppFramework\Utility\ITimeFactory;
use OCP\BackgroundJob\IJobList;
use OCP\Comments\IComment;
use OCP\DB\Exception;
use OCP\DB\QueryBuilder\IQueryBuilder;
use OCP\EventDispatcher\IEventDispatcher;
use OCP\HintException;
use OCP\ICacheFactory;
use OCP\IDBConnection;
use OCP\IMemcache;
use OCP\IRequestId;
use OCP\IUser;
use OCP\Log\Audit\CriticalActionPerformedEvent;
use OCP\Security\Events\ValidatePasswordPolicyEvent;
Expand All @@ -52,6 +58,7 @@
* @psalm-import-type TalkRoom from ResponseDefinitions
*/
class RoomService {
protected IMemcache $cache;

public function __construct(
protected Manager $manager,
Expand All @@ -64,7 +71,46 @@
protected IEventDispatcher $dispatcher,
protected IJobList $jobList,
protected LoggerInterface $logger,
protected IRequestId $requestId,
ICacheFactory $cacheFactory,
) {
$this->cache = $cacheFactory->createLocking('talkroom_');
}

/**
* @throws RoomLockedException
*/
protected function updateRoomPropertyWithLock(Room $room, string $property, int $value): void {
$cacheKey = $this->cache instanceof NullCache ? null : (string)$room->getId();

Check failure on line 84 in lib/Service/RoomService.php

View workflow job for this annotation

GitHub Actions / static-psalm-analysis

UndefinedClass

lib/Service/RoomService.php:84:39: UndefinedClass: Class, interface or enum named OC\Memcache\NullCache does not exist (see https://psalm.dev/019)
if ($cacheKey !== null) {
$this->cache->add($cacheKey, $this->requestId->getId(), 30);
$sleeps = 0;
while ($this->cache->get($cacheKey) !== $this->requestId->getId()) {
if ($sleeps > 30) {
throw new RoomLockedException();
}
usleep(10_000);
$sleeps++;
$this->cache->add($cacheKey, $this->requestId->getId(), 30);
}

if ($sleeps !== 0) {
$room = $this->manager->getRoomById($room->getId());
}
}

$update = $this->db->getQueryBuilder();
$update->update('talk_rooms')
->set($property, $update->createNamedParameter($value, IQueryBuilder::PARAM_INT))
->set('properties_version', $update->func()->add('properties_version', $update->expr()->literal(1, IQueryBuilder::PARAM_INT)))
->where($update->expr()->eq('id', $update->createNamedParameter($room->getId(), IQueryBuilder::PARAM_INT)))
->andWhere($update->expr()->eq('properties_version', $update->createNamedParameter($room->getPropertiesVersion(), IQueryBuilder::PARAM_INT)));
$update->executeStatement();

$room->setPropertiesVersion($room->getPropertiesVersion() + 1);
if ($cacheKey !== null) {
$this->cache->cad($cacheKey, $this->requestId->getId());
}
}

/**
Expand Down Expand Up @@ -213,11 +259,11 @@
// Reset custom user permissions to default
$this->participantService->updateAllPermissions($room, Attendee::PERMISSIONS_MODIFY_SET, Attendee::PERMISSIONS_DEFAULT);

$update = $this->db->getQueryBuilder();
$update->update('talk_rooms')
->set('default_permissions', $update->createNamedParameter($newPermissions, IQueryBuilder::PARAM_INT))
->where($update->expr()->eq('id', $update->createNamedParameter($room->getId(), IQueryBuilder::PARAM_INT)));
$update->executeStatement();
try {
$this->updateRoomPropertyWithLock($room, 'default_permissions', $newPermissions);
} catch (RoomLockedException $e) {
throw new InvalidArgumentException('locked');
}

$room->setDefaultPermissions($newPermissions);

Expand Down
Loading