Merge pull request #31850 from nextcloud/performance/heartbeat-fetch-status-once

Fetch status in heartbeat controller only once

Author: CarlSchwan

apps/user_status/lib/Connector/UserStatus.php

@@ -46,12 +46,11 @@ class UserStatus implements IUserStatus {
 	/** @var DateTimeImmutable|null */
 	private $clearAt;
 
-	/**
-	 * UserStatus constructor.
-	 *
-	 * @param Db\UserStatus $status
-	 */
+	/** @var Db\UserStatus */
+	private $internalStatus;
+
 	public function __construct(Db\UserStatus $status) {
+		$this->internalStatus = $status;
 		$this->userId = $status->getUserId();
 		$this->status = $status->getStatus();
 		$this->message = $status->getCustomMessage();
@@ -99,4 +98,8 @@ public function getIcon(): ?string {
 	public function getClearAt(): ?DateTimeImmutable {
 		return $this->clearAt;
 	}
+
+	public function getInternal(): Db\UserStatus {
+		return $this->internalStatus;
+	}
 }

apps/user_status/lib/Controller/HeartbeatController.php

@@ -81,21 +81,21 @@ public function heartbeat(string $status): JSONResponse {
 			return new JSONResponse([], Http::STATUS_INTERNAL_SERVER_ERROR);
 		}
 
-		$this->eventDispatcher->dispatchTyped(
-			new UserLiveStatusEvent(
-				$user,
-				$status,
-				$this->timeFactory->getTime()
-			)
+		$event = new UserLiveStatusEvent(
+			$user,
+			$status,
+			$this->timeFactory->getTime()
 		);
 
-		try {
-			$userStatus = $this->service->findByUserId($user->getUID());
-		} catch (DoesNotExistException $ex) {
+		$this->eventDispatcher->dispatchTyped($event);
+
+		$userStatus = $event->getUserStatus();
+		if (!$userStatus) {
 			return new JSONResponse([], Http::STATUS_NO_CONTENT);
 		}
 
-		return new JSONResponse($this->formatStatus($userStatus));
+		/** @psalm-suppress UndefinedInterfaceMethod */
+		return new JSONResponse($this->formatStatus($userStatus->getInternal()));
 	}
 
 	private function formatStatus(UserStatus $status): array {

apps/user_status/lib/Listener/UserLiveStatusListener.php

@@ -26,6 +26,7 @@
 namespace OCA\UserStatus\Listener;
 
 use OCA\UserStatus\Db\UserStatus;
+use OCA\UserStatus\Connector\UserStatus as ConnectorUserStatus;
 use OCA\UserStatus\Db\UserStatusMapper;
 use OCA\UserStatus\Service\StatusService;
 use OCP\AppFramework\Db\DoesNotExistException;
@@ -41,19 +42,9 @@
  * @package OCA\UserStatus\Listener
  */
 class UserLiveStatusListener implements IEventListener {
+	private UserStatusMapper $mapper;
+	private ITimeFactory $timeFactory;
 
-	/** @var UserStatusMapper */
-	private $mapper;
-
-	/** @var ITimeFactory */
-	private $timeFactory;
-
-	/**
-	 * UserLiveStatusListener constructor.
-	 *
-	 * @param UserStatusMapper $mapper
-	 * @param ITimeFactory $timeFactory
-	 */
 	public function __construct(UserStatusMapper $mapper,
 								ITimeFactory $timeFactory) {
 		$this->mapper = $mapper;
@@ -112,5 +103,7 @@ public function handle(Event $event): void {
 				$this->mapper->update($userStatus);
 			}
 		}
+
+		$event->setUserStatus(new ConnectorUserStatus($userStatus));
 	}
 }

lib/public/User/Events/UserLiveStatusEvent.php

@@ -27,6 +27,7 @@
 
 use OCP\EventDispatcher\Event;
 use OCP\IUser;
+use OCP\UserStatus\IUserStatus;
 
 /**
  * @since 20.0.0
@@ -51,19 +52,12 @@ class UserLiveStatusEvent extends Event {
 	 */
 	public const STATUS_OFFLINE = 'offline';
 
-	/** @var IUser */
-	private $user;
-
-	/** @var string */
-	private $status;
-
-	/** @var int */
-	private $timestamp;
+	private IUser $user;
+	private string $status;
+	private int $timestamp;
+	private ?IUserStatus $userStatus = null;
 
 	/**
-	 * @param IUser $user
-	 * @param string $status
-	 * @param int $timestamp
 	 * @since 20.0.0
 	 */
 	public function __construct(IUser $user,
@@ -98,4 +92,19 @@ public function getStatus(): string {
 	public function getTimestamp(): int {
 		return $this->timestamp;
 	}
+
+	/**
+	 * Get the user status that might be available after processing the event
+	 * @since 24.0.0
+	 */
+	public function getUserStatus(): ?IUserStatus {
+		return $this->userStatus;
+	}
+
+	/**
+	 * @since 24.0.0
+	 */
+	public function setUserStatus(IUserStatus $userStatus) {
+		$this->userStatus = $userStatus;
+	}
 }