feat(RecentPages): persist recent pages widget user setting in database

Signed-off-by: Jonas <jonas@freesources.org>

appinfo/routes.php

@@ -38,6 +38,8 @@
 		// collectives userSettings API
 		['name' => 'collectiveUserSettings#pageOrder', 'url' => '/_api/{id}/_userSettings/pageOrder', 'verb' => 'PUT',
 			'requirements' => ['id' => '\d+']],
+		['name' => 'collectiveUserSettings#showRecentPages', 'url' => '/_api/{id}/_userSettings/showRecentPages', 'verb' => 'PUT',
+			'requirements' => ['id' => '\d+']],
 
 		// pages API
 		['name' => 'page#index', 'url' => '/_api/{collectiveId}/_pages',

cypress/e2e/page-landingpage.spec.js

@@ -45,11 +45,30 @@ describe('Page landing page', function() {
 	})
 
 	describe('Displays recent pages', function() {
-		it('Allows to display/close TOC and switch page modes in between', function() {
+		it('Allows to toggle recent pages widget', function() {
 			cy.get('.recent-pages-widget .recent-page-tile')
 				.contains('Page 2')
+
+			cy.get('.recent-pages-widget .recent-pages-title')
 				.click()
+			cy.get('.recent-pages-widget .recent-page-tile')
+				.should('not.exist')
+
+			cy.reload()
 
+			cy.get('.recent-pages-widget .recent-page-tile')
+				.should('not.exist')
+			cy.get('.recent-pages-widget .recent-pages-title')
+				.click()
+			cy.get('.recent-pages-widget .recent-page-tile')
+				.contains('Page 2')
+				.click()
+		})
+
+		it('Allows to open page from recent pages widget', function() {
+			cy.get('.recent-pages-widget .recent-page-tile')
+				.contains('Page 2')
+				.click()
 			cy.url().should('include', `/apps/collectives/${encodeURIComponent(collective)}/${encodeURIComponent('Page 2')}`)
 		})
 	})

lib/Controller/CollectiveUserSettingsController.php

@@ -65,4 +65,23 @@ public function pageOrder(int $id, int $pageOrder): DataResponse {
 			return [];
 		});
 	}
+
+	/**
+	 * @NoAdminRequired
+	 *
+	 * @param int  $id
+	 * @param bool $showRecentPages
+	 *
+	 * @return DataResponse
+	 */
+	public function showRecentPages(int $id, bool $showRecentPages): DataResponse {
+		return $this->prepareResponse(function () use ($id, $showRecentPages): array {
+			$this->service->setShowRecentPages(
+				$id,
+				$this->getUserId(),
+				$showRecentPages
+			);
+			return [];
+		});
+	}
 }

lib/Db/Collective.php

@@ -48,6 +48,8 @@ class Collective extends Entity implements JsonSerializable {
 	];
 	/** @var int */
 	public const defaultPageMode = 0;
+	/** @var bool */
+	public const defaultShowRecentPages = true;
 
 	protected ?string $circleUniqueId = null;
 	protected int $permissions = self::defaultPermissions;

lib/Db/CollectiveUserSettings.php

@@ -24,6 +24,7 @@ class CollectiveUserSettings extends Entity implements JsonSerializable {
 	/** @var array */
 	public const supportedSettings = [
 		'page_order',
+		'show_recent_pages',
 	];
 
 	protected ?int $collectiveId = null;
@@ -81,6 +82,15 @@ public function setPageOrder(int $pageOrder): void {
 		$this->setSetting('page_order', $pageOrder);
 	}
 
+	/**
+	 * @param bool $showRecentPages
+	 *
+	 * @throws NotPermittedException
+	 */
+	public function setShowRecentPages(bool $showRecentPages): void {
+		$this->setSetting('show_recent_pages', $showRecentPages);
+	}
+
 	public function jsonSerialize(): array {
 		return [
 			'id' => $this->id,

lib/Model/CollectiveInfo.php

@@ -19,20 +19,23 @@
  * @method bool getShareEditable()
  * @method void setShareEditable(bool $shareEditable)
  * @method int getUserPageOrder()
+ * @method bool getUserShowRecentPages()
  */
 class CollectiveInfo extends Collective {
 	protected string $name;
 	protected int $level;
 	protected ?string $shareToken;
 	protected bool $shareEditable;
 	protected ?int $userPageOrder;
+	protected ?bool $userShowRecentPages;
 
 	public function __construct(Collective $collective,
 		string $name,
 		int $level = Member::LEVEL_MEMBER,
 		?string $shareToken = null,
 		bool $shareEditable = false,
-		?int $userPageOrder = null) {
+		?int $userPageOrder = Collective::defaultPageOrder,
+		?bool $userShowRecentPages = Collective::defaultShowRecentPages) {
 		$this->id = $collective->getId();
 		$this->circleUniqueId = $collective->getCircleId();
 		$this->emoji = $collective->getEmoji();
@@ -44,6 +47,7 @@ public function __construct(Collective $collective,
 		$this->shareToken = $shareToken;
 		$this->shareEditable = $shareEditable;
 		$this->userPageOrder = $userPageOrder;
+		$this->userShowRecentPages = $userShowRecentPages;
 	}
 
 	/**
@@ -116,6 +120,13 @@ public function setUserPageOrder(int $userPageOrder): void {
 		$this->userPageOrder = $userPageOrder;
 	}
 
+	/**
+	 * @param bool $userShowRecentPages
+	 */
+	public function setUserShowRecentPages(bool $userShowRecentPages): void {
+		$this->userShowRecentPages = $userShowRecentPages;
+	}
+
 	/**
 	 * @return array
 	 */
@@ -135,6 +146,7 @@ public function jsonSerialize(): array {
 			'shareToken' => $this->shareToken,
 			'shareEditable' => $this->canEdit() && $this->shareEditable,
 			'userPageOrder' => $this->userPageOrder,
+			'userShowRecentPages' => $this->userShowRecentPages,
 		];
 	}
 }

lib/Service/CollectiveHelper.php

@@ -52,17 +52,20 @@ public function getCollectivesForUser(string $userId, bool $getLevel = true, boo
 			$circle = $circles[$cid];
 			$level = $getLevel ? $circle->getInitiator()->getLevel(): 0;
 			$userPageOrder = null;
+			$userShowRecentPages = null;
 			if ($getUserSettings) {
 				// TODO: merge queries for collective and user settings into one?
 				$settings = $this->collectiveUserSettingsMapper->findByCollectiveAndUser($c->getId(), $userId);
 				$userPageOrder = ($settings ? $settings->getSetting('page_order') : null) ?? Collective::defaultPageOrder;
+				$userShowRecentPages = ($settings ? $settings->getSetting('show_recent_pages') : null) ?? Collective::defaultShowRecentPages;
 			}
 			$collectiveInfos[] = new CollectiveInfo($c,
 				$circle->getSanitizedName(),
 				$level,
 				null,
 				false,
-				$userPageOrder);
+				$userPageOrder,
+				$userShowRecentPages);
 		}
 		return $collectiveInfos;
 	}

lib/Service/CollectiveService.php

@@ -291,7 +291,8 @@ public function updateCollective(int $id,
 			$collectiveInfo->getLevel(),
 			$collectiveInfo->getShareToken(),
 			$collectiveInfo->getShareEditable(),
-			$collectiveInfo->getUserPageOrder());
+			$collectiveInfo->getUserPageOrder(),
+			$collectiveInfo->getUserShowRecentPages());
 	}
 
 	/**
@@ -322,7 +323,8 @@ public function setPermissionLevel(int $id,
 			$collectiveInfo->getLevel(),
 			$collectiveInfo->getShareToken(),
 			$collectiveInfo->getShareEditable(),
-			$collectiveInfo->getUserPageOrder());
+			$collectiveInfo->getUserPageOrder(),
+			$collectiveInfo->getUserShowRecentPages());
 	}
 
 	/**
@@ -351,7 +353,8 @@ public function setPageMode(int $id,
 			$collectiveInfo->getLevel(),
 			$collectiveInfo->getShareToken(),
 			$collectiveInfo->getShareEditable(),
-			$collectiveInfo->getUserPageOrder());
+			$collectiveInfo->getUserPageOrder(),
+			$collectiveInfo->getUserShowRecentPages());
 	}
 
 	/**
@@ -380,7 +383,8 @@ public function trashCollective(int $id, string $userId): CollectiveInfo {
 			$collectiveInfo->getLevel(),
 			$collectiveInfo->getShareToken(),
 			$collectiveInfo->getShareEditable(),
-			$collectiveInfo->getUserPageOrder());
+			$collectiveInfo->getUserPageOrder(),
+			$collectiveInfo->getUserShowRecentPages());
 	}
 
 	/**
@@ -433,7 +437,8 @@ public function deleteCollective(int $id, string $userId, bool $deleteCircle): C
 			$collectiveInfo->getLevel(),
 			$collectiveInfo->getShareToken(),
 			$collectiveInfo->getShareEditable(),
-			$collectiveInfo->getUserPageOrder());
+			$collectiveInfo->getUserPageOrder(),
+			$collectiveInfo->getUserShowRecentPages());
 	}
 
 	/**
@@ -458,6 +463,7 @@ public function restoreCollective(int $id, string $userId): CollectiveInfo {
 			$collectiveInfo->getLevel(),
 			$collectiveInfo->getShareToken(),
 			$collectiveInfo->getShareEditable(),
-			$collectiveInfo->getUserPageOrder());
+			$collectiveInfo->getUserPageOrder(),
+			$collectiveInfo->getUserShowRecentPages());
 	}
 }

lib/Service/CollectiveUserSettingsService.php

@@ -27,7 +27,7 @@ public function __construct(CollectiveUserSettingsMapper $collectiveUserSettings
 	 * @throws NotFoundException
 	 * @throws NotPermittedException
 	 */
-	private function prepareSettings(int $collectiveId, string $userId): CollectiveUserSettings {
+	private function initSettings(int $collectiveId, string $userId): CollectiveUserSettings {
 		if (null === $this->collectiveMapper->findByIdAndUser($collectiveId, $userId)) {
 			throw new NotFoundException('Collective not found: ' . $collectiveId);
 		}
@@ -50,10 +50,29 @@ private function prepareSettings(int $collectiveId, string $userId): CollectiveU
 	 * @throws NotPermittedException
 	 */
 	public function setPageOrder(int $collectiveId, string $userId, int $pageOrder): void {
-		$settings = $this->prepareSettings($collectiveId, $userId);
+		$settings = $this->initSettings($collectiveId, $userId);
+		$settings->setPageOrder($pageOrder);
+
+		try {
+			$this->collectiveUserSettingsMapper->insertOrUpdate($settings);
+		} catch (Exception $e) {
+			throw new NotPermittedException($e->getMessage(), 0, $e);
+		}
+	}
+
+	/**
+	 * @param int    $collectiveId
+	 * @param string $userId
+	 * @param bool   $showRecentPages
+	 *
+	 * @throws NotFoundException
+	 * @throws NotPermittedException
+	 */
+	public function setShowRecentPages(int $collectiveId, string $userId, bool $showRecentPages): void {
+		$settings = $this->initSettings($collectiveId, $userId);
+		$settings->setShowRecentPages($showRecentPages);
 
 		try {
-			$settings->setPageOrder($pageOrder);
 			$this->collectiveUserSettingsMapper->insertOrUpdate($settings);
 		} catch (Exception $e) {
 			throw new NotPermittedException($e->getMessage(), 0, $e);

src/components/Page/LandingPageWidgets/RecentPagesWidget.vue

@@ -7,10 +7,10 @@
 			<div class="toggle-icon">
 				<ChevronDownButton :size="24"
 					:title="t('collectives', 'Expand recent pages')"
-					:class="{ 'collapsed': !showWidget }" />
+					:class="{ 'collapsed': !showRecentPages }" />
 			</div>
 		</a>
-		<div v-if="showWidget" class="recent-pages-widget-container">
+		<div v-if="showRecentPages" class="recent-pages-widget-container">
 			<div ref="pageslider" class="recent-pages-widget-pages">
 				<RecentPageTile v-for="page in trimmedRecentPages"
 					:key="page.id"
@@ -38,12 +38,14 @@
 
 <script>
 import debounce from 'debounce'
-import { mapGetters } from 'vuex'
+import { mapActions, mapGetters } from 'vuex'
+import { showError } from '@nextcloud/dialogs'
 import ChevronDownButton from 'vue-material-design-icons/ChevronDown.vue'
 import ChevronLeftButton from 'vue-material-design-icons/ChevronLeft.vue'
 import ChevronRightButton from 'vue-material-design-icons/ChevronRight.vue'
 import RecentPageTile from './RecentPageTile.vue'
 import WidgetHeading from './WidgetHeading.vue'
+import { SET_COLLECTIVE_USER_SETTING_SHOW_RECENT_PAGES } from '../../../store/actions.js'
 
 const SLIDE_OFFSET = 198
 
@@ -58,17 +60,17 @@ export default {
 		WidgetHeading,
 	},
 
-	data() {
-		return {
-			showWidget: true,
-		}
-	},
-
 	computed: {
 		...mapGetters([
+			'currentCollective',
+			'isPublic',
 			'recentPages',
 		]),
 
+		showRecentPages() {
+			return this.currentCollective.userShowRecentPages ?? true
+		},
+
 		trimmedRecentPages() {
 			return this.recentPages
 				.slice(0, 10)
@@ -87,9 +89,20 @@ export default {
 	},
 
 	methods: {
+		...mapActions({
+			dispatchSetUserShowRecentPages: SET_COLLECTIVE_USER_SETTING_SHOW_RECENT_PAGES,
+		}),
+
 		toggleWidget() {
-			this.showWidget = !this.showWidget
-			if (this.showWidget) {
+			if (!this.isPublic) {
+				this.dispatchSetUserShowRecentPages({ id: this.currentCollective.id, showRecentPages: !this.showRecentPages })
+					.catch((error) => {
+						console.error(error)
+						showError(t('collectives', 'Could not save recent pages setting for collective'))
+					})
+			}
+
+			if (this.showRecentPages) {
 				this.updateButtons()
 			}
 		},

src/store/actions.js

@@ -20,6 +20,7 @@ export const UPDATE_COLLECTIVE_EDIT_PERMISSIONS = 'UPDATE_COLLECTIVE_EDIT_PERMIS
 export const UPDATE_COLLECTIVE_SHARE_PERMISSIONS = 'UPDATE_COLLECTIVE_SHARE_PERMISSIONS'
 export const UPDATE_COLLECTIVE_PAGE_MODE = 'UPDATE_COLLECTIVE_PAGE_MODE'
 export const SET_COLLECTIVE_USER_SETTING_PAGE_ORDER = 'SET_COLLECTIVE_USER_SETTING_PAGE_ORDER'
+export const SET_COLLECTIVE_USER_SETTING_SHOW_RECENT_PAGES = 'SET_COLLECTIVE_USER_SETTING_SHOW_RECENT_PAGES'
 export const MARK_COLLECTIVE_DELETED = 'MARK_COLLECTIVE_DELETED'
 export const UNMARK_COLLECTIVE_DELETED = 'UNMARK_COLLECTIVE_DELETED'
 export const EXPAND_PARENTS = 'EXPAND_PARENTS'

src/store/collectives.js

@@ -32,6 +32,7 @@ import {
 	UPDATE_COLLECTIVE_SHARE_PERMISSIONS,
 	UPDATE_COLLECTIVE_PAGE_MODE,
 	SET_COLLECTIVE_USER_SETTING_PAGE_ORDER,
+	SET_COLLECTIVE_USER_SETTING_SHOW_RECENT_PAGES,
 	MARK_COLLECTIVE_DELETED,
 	UNMARK_COLLECTIVE_DELETED,
 	GET_COLLECTIVES_FOLDER,
@@ -442,6 +443,14 @@ export default {
 			commit(PATCH_COLLECTIVE_WITH_PROPERTY, { id, property: 'userPageOrder', value: pageOrder })
 		},
 
+		async [SET_COLLECTIVE_USER_SETTING_SHOW_RECENT_PAGES]({ commit, getters }, { id, showRecentPages }) {
+			commit(PATCH_COLLECTIVE_WITH_PROPERTY, { id, property: 'userShowRecentPages', value: showRecentPages })
+			await axios.put(
+				generateUrl('/apps/collectives/_api/' + id + '/_userSettings/showRecentPages'),
+				{ showRecentPages },
+			)
+		},
+
 		[MARK_COLLECTIVE_DELETED]({ commit }, collective) {
 			collective.deleted = true
 			commit(ADD_OR_UPDATE_COLLECTIVE, collective)

tests/Unit/Db/CollectiveUserSettingsTest.php

@@ -58,4 +58,11 @@ public function testSetPageOrderExceptionMax(): void {
 		$this->expectException(NotPermittedException::class);
 		$settings->setPageOrder(max($pageOrders) + 1);
 	}
+
+	public function testSetShowRecentPages(): void {
+		$settings = new CollectiveUserSettings();
+		self::assertEquals(null, $settings->getSetting('show_recent_pages'));
+		$settings->setShowRecentPages(true);
+		self::assertEquals(true, $settings->getSetting('show_recent_pages'));
+	}
 }