perf: cache pre-fetched mailboxes on the HTTP level

Signed-off-by: Richard Steinmetz <[email protected]>

Author: st3iny

lib/Controller/MessagesController.php

@@ -136,7 +136,8 @@ public function index(int $mailboxId,
 		?int $cursor = null,
 		?string $filter = null,
 		?int $limit = null,
-		?string $view = null): JSONResponse {
+		?string $view = null,
+		?string $etag = null /* Is sent to guarantee unique urls for the cache */): JSONResponse {
 		try {
 			$mailbox = $this->mailManager->getMailbox($this->currentUserId, $mailboxId);
 			$account = $this->accountService->find($this->currentUserId, $mailbox->getAccountId());
@@ -145,7 +146,7 @@ public function index(int $mailboxId,
 		}
 
 		$this->logger->debug("loading messages of mailbox <$mailboxId>");
-		$sort = $this->preferences->getPreference($this->currentUserId, 'sort-order', 'newest') === 'newest' ? IMailSearch::ORDER_NEWEST_FIRST: IMailSearch::ORDER_OLDEST_FIRST;
+		$sort = $this->preferences->getPreference($this->currentUserId, 'sort-order', 'newest') === 'newest' ? IMailSearch::ORDER_NEWEST_FIRST : IMailSearch::ORDER_OLDEST_FIRST;
 
 		$view = $view === 'singleton' ? IMailSearch::VIEW_SINGLETON : IMailSearch::VIEW_THREADED;
 
@@ -159,9 +160,12 @@ public function index(int $mailboxId,
 			$this->currentUserId,
 			$view
 		);
-		return new JSONResponse(
-			$messages
-		);
+
+		$response = new JSONResponse($messages);
+		if ($etag) {
+			$response->cacheFor(7 * 24 * 3600, false, true);
+		}
+		return $response;
 	}
 
 	/**

lib/Db/Mailbox.php

@@ -141,6 +141,16 @@ public function getStats(): MailboxStats {
 		return new MailboxStats($this->getMessages(), $this->getUnseen());
 	}
 
+	public function getEtag(): string {
+		$hash = hash('md5', implode('|', [
+			(string)$this->getId(),
+			$this->getSyncNewToken() ?? 'null',
+			$this->getSyncChangedToken() ?? 'null',
+			$this->getSyncVanishedToken() ?? 'null',
+		]));
+		return "\"$hash\"";
+	}
+
 	#[\Override]
 	#[ReturnTypeWillChange]
 	public function jsonSerialize() {
@@ -160,6 +170,7 @@ public function jsonSerialize() {
 			'unread' => $this->unseen,
 			'myAcls' => $this->myAcls,
 			'shared' => $this->shared === true,
+			'etag' => $this->getEtag(),
 		];
 	}
 }

src/components/Mailbox.vue

@@ -274,6 +274,7 @@ export default {
 					const envelopes = await this.mainStore.fetchEnvelopes({
 						mailboxId: mailbox.databaseId,
 						limit: this.initialPageSize,
+						includeEtag: true,
 					})
 					this.syncedMailboxes.add(mailbox.databaseId)
 					logger.debug(`Prefetched ${envelopes.length} envelopes for folder ${mailbox.displayName} (${mailbox.databaseId})`)

src/service/MessageService.js

@@ -32,7 +32,7 @@ export function fetchEnvelope(accountId, id) {
 		})
 }
 
-export function fetchEnvelopes(accountId, mailboxId, query, cursor, limit, sort, view) {
+export function fetchEnvelopes(accountId, mailboxId, query, cursor, limit, sort, view, etag) {
 	const url = generateUrl('/apps/mail/api/messages')
 	const params = {
 		mailboxId,
@@ -53,6 +53,9 @@ export function fetchEnvelopes(accountId, mailboxId, query, cursor, limit, sort,
 	if (view) {
 		params.view = view
 	}
+	if (etag) {
+		params.etag = etag
+	}
 
 	return axios
 		.get(url, {

src/store/mainStore/actions.js

@@ -662,6 +662,7 @@ export default function mainStoreActions() {
 			mailboxId,
 			query,
 			addToUnifiedMailboxes = true,
+			includeEtag = false,
 		}) {
 			return handleHttpAuthErrors(async () => {
 				const mailbox = this.getMailbox(mailboxId)
@@ -709,7 +710,7 @@ export default function mainStoreActions() {
 							}),
 						),
 					),
-				)(mailbox.accountId, mailboxId, query, undefined, PAGE_SIZE, this.getPreference('sort-order'), this.getPreference('layout-message-view'))
+				)(mailbox.accountId, mailboxId, query, undefined, PAGE_SIZE, this.getPreference('sort-order'), this.getPreference('layout-message-view'), includeEtag ? mailbox.etag : undefined)
 			})
 		},
 		async fetchNextEnvelopePage({