Merge branch 'favorite-pages' into dev

Author: gustavotoyota

apps/app-server/src/trpc/api/users/pages/add-favorite-pages.ts

@@ -0,0 +1,46 @@
+import { isNanoID } from '@stdlib/misc';
+import { checkRedlockSignalAborted } from '@stdlib/redlock';
+import { once, union } from 'lodash';
+import type { InferProcedureOpts } from 'src/trpc/helpers';
+import { authProcedure } from 'src/trpc/helpers';
+import { z } from 'zod';
+
+const baseProcedure = authProcedure.input(
+  z.object({
+    pageIds: z.string().refine(isNanoID).array(),
+  }),
+);
+
+export const addFavoritePagesProcedure = once(() =>
+  baseProcedure.mutation(addFavoritePages),
+);
+
+export async function addFavoritePages({
+  ctx,
+  input,
+}: InferProcedureOpts<typeof baseProcedure>) {
+  return await ctx.usingLocks(
+    [[`user-lock:${ctx.userId}`]],
+    async (signals) => {
+      // Get favorite page IDs
+
+      let favoritePageIds: string[] = await ctx.dataAbstraction.hget(
+        'user',
+        ctx.userId,
+        'favorite-page-ids',
+      );
+
+      // Add page ID from favorite page IDs
+
+      favoritePageIds = union(input.pageIds, favoritePageIds);
+
+      checkRedlockSignalAborted(signals);
+
+      // Update favorite page IDs
+
+      await ctx.dataAbstraction.patch('user', ctx.userId, {
+        favorite_page_ids: favoritePageIds,
+      });
+    },
+  );
+}

apps/app-server/src/trpc/api/users/pages/clear-favorite-pages.ts

@@ -0,0 +1,19 @@
+import { once } from 'lodash';
+import type { InferProcedureOpts } from 'src/trpc/helpers';
+import { authProcedure } from 'src/trpc/helpers';
+
+const baseProcedure = authProcedure;
+
+export const clearFavoritePagesProcedure = once(() =>
+  baseProcedure.mutation(clearFavoritePages),
+);
+
+export async function clearFavoritePages({
+  ctx,
+}: InferProcedureOpts<typeof baseProcedure>) {
+  return await ctx.usingLocks([[`user-lock:${ctx.userId}`]], async () => {
+    await ctx.dataAbstraction.patch('user', ctx.userId, {
+      favorite_page_ids: [],
+    });
+  });
+}

apps/app-server/src/trpc/api/users/pages/index.ts

@@ -1,10 +1,13 @@
 import { trpc } from 'src/trpc/server';
 
+import { addFavoritePagesProcedure } from './add-favorite-pages';
+import { clearFavoritePagesProcedure } from './clear-favorite-pages';
 import { clearRecentPagesProcedure } from './clear-recent-pages';
 import { getCurrentPathProcedure } from './get-current-path';
 import { getGroupIdsProcedure } from './get-group-ids';
 import { getStartingPageIdProcedure } from './get-starting-page-id';
 import { notificationsRouter } from './notifications';
+import { removeFavoritePageProcedure } from './remove-favorite-page';
 import { removeRecentPageProcedure } from './remove-recent-page';
 import { setEncryptedDefaultArrowProcedure } from './set-encrypted-default-arrow';
 import { setEncryptedDefaultNoteProcedure } from './set-encrypted-default-note';
@@ -15,8 +18,12 @@ export const pagesRouter = trpc.router({
   getStartingPageId: getStartingPageIdProcedure(),
   getCurrentPath: getCurrentPathProcedure(),
 
-  clearRecentPages: clearRecentPagesProcedure(),
   removeRecentPage: removeRecentPageProcedure(),
+  clearRecentPages: clearRecentPagesProcedure(),
+
+  addFavoritePages: addFavoritePagesProcedure(),
+  removeFavoritePage: removeFavoritePageProcedure(),
+  clearFavoritePages: clearFavoritePagesProcedure(),
 
   setEncryptedDefaultNote: setEncryptedDefaultNoteProcedure(),
   setEncryptedDefaultArrow: setEncryptedDefaultArrowProcedure(),

apps/app-server/src/trpc/api/users/pages/remove-favorite-page.ts

@@ -0,0 +1,54 @@
+import { isNanoID } from '@stdlib/misc';
+import { checkRedlockSignalAborted } from '@stdlib/redlock';
+import { TRPCError } from '@trpc/server';
+import { once, pull } from 'lodash';
+import type { InferProcedureOpts } from 'src/trpc/helpers';
+import { authProcedure } from 'src/trpc/helpers';
+import { z } from 'zod';
+
+const baseProcedure = authProcedure.input(
+  z.object({
+    pageId: z.string().refine(isNanoID),
+  }),
+);
+
+export const removeFavoritePageProcedure = once(() =>
+  baseProcedure.mutation(removeFavoritePage),
+);
+
+export async function removeFavoritePage({
+  ctx,
+  input,
+}: InferProcedureOpts<typeof baseProcedure>) {
+  return await ctx.usingLocks(
+    [[`user-lock:${ctx.userId}`]],
+    async (signals) => {
+      // Get favorite page IDs
+
+      const favoritePageIds: string[] = await ctx.dataAbstraction.hget(
+        'user',
+        ctx.userId,
+        'favorite-page-ids',
+      );
+
+      // Remove page ID from favorite page IDs
+
+      const originalLength = favoritePageIds.length;
+
+      if (pull(favoritePageIds, input.pageId).length === originalLength) {
+        throw new TRPCError({
+          message: 'Favorite page not found.',
+          code: 'NOT_FOUND',
+        });
+      }
+
+      checkRedlockSignalAborted(signals);
+
+      // Update favorite page IDs
+
+      await ctx.dataAbstraction.patch('user', ctx.userId, {
+        favorite_page_ids: favoritePageIds,
+      });
+    },
+  );
+}

apps/app-server/src/trpc/api/users/pages/remove-recent-page.ts

@@ -33,7 +33,9 @@ export async function removeRecentPage({
 
       // Remove page ID from recent page IDs
 
-      if (pull(recentPageIds, input.pageId).length === 0) {
+      const originalLength = recentPageIds.length;
+
+      if (pull(recentPageIds, input.pageId).length === originalLength) {
         throw new TRPCError({
           message: 'Recent page not found.',
           code: 'NOT_FOUND',

apps/client/src/code/pages/pages.ts

@@ -18,6 +18,9 @@ export interface IAppReact {
   recentPageIdsOverride?: string[];
   recentPageIds: ComputedRef<string[]>;
 
+  favoritePageIdsOverride?: string[];
+  favoritePageIds: ComputedRef<string[]>;
+
   page: ShallowRef<Page>;
   pageId: ComputedRef<string | undefined>;
   pageIndex: ComputedRef<number>;
@@ -45,6 +48,7 @@ export class Pages {
   parentPageId?: string;
 
   recentPageIdsKeepOverride?: boolean;
+  favoritePageIdsKeepOverride?: boolean;
 
   constructor(input: { factories: Factories }) {
     this.factories = input.factories;
@@ -54,6 +58,7 @@ export class Pages {
 
     this.react = reactive({
       pathPageIds: [],
+
       recentPageIds: computed(() => {
         if (this.recentPageIdsKeepOverride) {
           this.recentPageIdsKeepOverride = undefined;
@@ -70,6 +75,22 @@ export class Pages {
         return this.react.recentPageIdsOverride ?? recentPageIds ?? [];
       }),
 
+      favoritePageIds: computed(() => {
+        if (this.favoritePageIdsKeepOverride) {
+          this.favoritePageIdsKeepOverride = undefined;
+        } else {
+          this.react.favoritePageIdsOverride = undefined;
+        }
+
+        const favoritePageIds = internals.realtime.globalCtx.hget(
+          'user',
+          authStore().userId,
+          'favorite-page-ids',
+        );
+
+        return this.react.favoritePageIdsOverride ?? favoritePageIds ?? [];
+      }),
+
       page: shallowRef(null) as any,
       pageId: computed(() => this.react.page?.id),
       pageIndex: computed(() =>

apps/client/src/layouts/PagesLayout/LeftSidebar/CurrentPath.vue

@@ -36,6 +36,7 @@
   </q-toolbar>
 
   <q-list
+    :id="`${sectionName}List`"
     ref="listRef"
     style="height: 0; overflow-x: hidden; overflow-y: auto"
     :style="{
@@ -55,8 +56,14 @@
 
   <div
     v-if="
-      uiStore().currentPathExpanded &&
-      (uiStore().recentPagesExpanded || uiStore().selectedPagesExpanded)
+      uiStore()[`${sectionName}Expanded`] &&
+      leftSidebarSectionNames.reduce((acc, section, index) => {
+        if (index > sectionIndex) {
+          acc ||= uiStore()[`${section}Expanded`] ? true : false;
+        }
+
+        return acc;
+      }, false)
     "
     style="position: relative"
   >
@@ -72,27 +79,59 @@
 
 <script setup lang="ts">
 import { listenPointerEvents, map, negateProp } from '@stdlib/misc';
+import type { LeftSidebarSectionName } from 'src/stores/ui';
+import {
+  leftSidebarSectionIndexes,
+  leftSidebarSectionNames,
+} from 'src/stores/ui';
 import type { ComponentPublicInstance } from 'vue';
 
 const listRef = ref<ComponentPublicInstance>();
 
+const sectionName = 'currentPath';
+const sectionIndex = leftSidebarSectionIndexes[sectionName];
+
 function resizeHandlePointerDown(downEvent: PointerEvent) {
   listenPointerEvents(downEvent, {
     move(moveEvent) {
-      const clientRect = listRef.value!.$el.getBoundingClientRect();
-
-      const othersHeight = uiStore().height - clientRect.height - 32 * 3 - 2;
-
-      const othersWeight =
-        (uiStore().recentPagesExpanded ? uiStore().recentPagesWeight : 0) +
-        (uiStore().selectedPagesExpanded ? uiStore().selectedPagesWeight : 0);
+      const clientRect = document
+        .querySelector(`#${sectionName}List`)!
+        .getBoundingClientRect();
+
+      const othersHeight =
+        uiStore().height -
+        clientRect.height -
+        32 * leftSidebarSectionNames.length -
+        2;
+
+      const othersWeight = leftSidebarSectionNames.reduce((acc, section) => {
+        if (section !== sectionName) {
+          acc += uiStore()[`${section}Expanded`]
+            ? uiStore()[`${section}Weight`]
+            : 0;
+        }
+
+        return acc;
+      }, 0);
 
       const myNewHeight = moveEvent.clientY - clientRect.y;
 
       const myNewWeight = map(myNewHeight, 0, othersHeight, 0, othersWeight);
 
-      uiStore().recentPagesWeight -= myNewWeight - uiStore().currentPathWeight;
-      uiStore().currentPathWeight = myNewWeight;
+      const nextExpandedSection = leftSidebarSectionNames.reduce(
+        (acc, section, index) => {
+          if (index > sectionIndex) {
+            acc ||= uiStore()[`${section}Expanded`] ? section : null;
+          }
+
+          return acc;
+        },
+        null as LeftSidebarSectionName | null,
+      )!;
+
+      uiStore()[`${nextExpandedSection}Weight`] -=
+        myNewWeight - uiStore()[`${sectionName}Weight`];
+      uiStore()[`${sectionName}Weight`] = myNewWeight;
 
       uiStore().normalizeWeights();
     },
@@ -101,10 +140,12 @@ function resizeHandlePointerDown(downEvent: PointerEvent) {
 
 function resizeHandleDoubleClick() {
   const avgWeight =
-    (uiStore().currentPathWeight + uiStore().recentPagesWeight) / 2;
+    (uiStore()[`${sectionName}Weight`] +
+      uiStore()[`${leftSidebarSectionNames[sectionIndex + 1]}Weight`]) /
+    2;
 
-  uiStore().currentPathWeight = avgWeight;
-  uiStore().recentPagesWeight = avgWeight;
+  uiStore()[`${sectionName}Weight`] = avgWeight;
+  uiStore()[`${leftSidebarSectionNames[sectionIndex + 1]}Weight`] = avgWeight;
 }
 </script>