import React, { useEffect, useRef, useState, useMemo, useCallback, } from 'react'; import path from 'path'; import type { Nullable, IPageHasId, IPageToDeleteWithMeta } from '@growi/core'; import { useTranslation } from 'next-i18next'; import { useRouter } from 'next/router'; import { debounce } from 'throttle-debounce'; import { toastError, toastSuccess } from '~/client/util/toastr'; import { AncestorsChildrenResult, RootPageResult, TargetAndAncestors } from '~/interfaces/page-listing-results'; import { OnDuplicatedFunction, OnDeletedFunction } from '~/interfaces/ui'; import { SocketEventName, UpdateDescCountData, UpdateDescCountRawData } from '~/interfaces/websocket'; import { IPageForPageDuplicateModal, usePageDuplicateModal, usePageDeleteModal, } from '~/stores/modal'; import { mutateAllPageInfo, useCurrentPagePath, useSWRMUTxCurrentPage } from '~/stores/page'; import { useSWRxPageAncestorsChildren, useSWRxRootPage, mutatePageTree, mutatePageList, } from '~/stores/page-listing'; import { mutateSearching } from '~/stores/search'; import { usePageTreeDescCountMap, useSidebarScrollerRef } from '~/stores/ui'; import { useGlobalSocket } from '~/stores/websocket'; import loggerFactory from '~/utils/logger'; import { ItemNode, type TreeItemProps } from '../TreeItem'; import ItemsTreeContentSkeleton from './ItemsTreeContentSkeleton'; import styles from './ItemsTree.module.scss'; const logger = loggerFactory('growi:cli:ItemsTree'); /* * Utility to generate initial node */ const generateInitialNodeBeforeResponse = (targetAndAncestors: Partial[]): ItemNode => { const nodes = targetAndAncestors.map((page): ItemNode => { return new ItemNode(page, []); }); // update children for each node const rootNode = nodes.reduce((child, parent) => { parent.children = [child]; return parent; }); return rootNode; }; const generateInitialNodeAfterResponse = (ancestorsChildren: Record[]>, rootNode: ItemNode): ItemNode => { const paths = Object.keys(ancestorsChildren); let currentNode = rootNode; paths.every((path) => { // stop rendering when non-migrated pages found if (currentNode == null) { return false; } const childPages = ancestorsChildren[path]; currentNode.children = ItemNode.generateNodesFromPages(childPages); const nextNode = currentNode.children.filter((node) => { return paths.includes(node.page.path as string); })[0]; currentNode = nextNode; return true; }); return rootNode; }; // user defined typeguard to assert the arg is not null type RenderingCondition = { ancestorsChildrenResult: AncestorsChildrenResult | undefined, rootPageResult: RootPageResult | undefined, } type SecondStageRenderingCondition = { ancestorsChildrenResult: AncestorsChildrenResult, rootPageResult: RootPageResult, } const isSecondStageRenderingCondition = (condition: RenderingCondition|SecondStageRenderingCondition): condition is SecondStageRenderingCondition => { return condition.ancestorsChildrenResult != null && condition.rootPageResult != null; }; type ItemsTreeProps = { isEnableActions: boolean isReadOnlyUser: boolean targetPath: string targetPathOrId?: Nullable targetAndAncestorsData?: TargetAndAncestors CustomTreeItem: React.FunctionComponent } /* * ItemsTree */ export const ItemsTree = (props: ItemsTreeProps): JSX.Element => { const { targetPath, targetPathOrId, targetAndAncestorsData, isEnableActions, isReadOnlyUser, CustomTreeItem, } = props; const { t } = useTranslation(); const router = useRouter(); const { data: ancestorsChildrenResult, error: error1 } = useSWRxPageAncestorsChildren(targetPath, { suspense: true }); const { data: rootPageResult, error: error2 } = useSWRxRootPage({ suspense: true }); const { data: currentPagePath } = useCurrentPagePath(); const { open: openDuplicateModal } = usePageDuplicateModal(); const { open: openDeleteModal } = usePageDeleteModal(); const { data: sidebarScrollerRef } = useSidebarScrollerRef(); const { data: socket } = useGlobalSocket(); const { data: ptDescCountMap, update: updatePtDescCountMap } = usePageTreeDescCountMap(); // for mutation const { trigger: mutateCurrentPage } = useSWRMUTxCurrentPage(); const [isInitialScrollCompleted, setIsInitialScrollCompleted] = useState(false); const rootElemRef = useRef(null); const renderingCondition = useMemo(() => { return { ancestorsChildrenResult, rootPageResult, }; }, [ancestorsChildrenResult, rootPageResult]); useEffect(() => { if (socket == null) { return; } socket.on(SocketEventName.UpdateDescCount, (data: UpdateDescCountRawData) => { // save to global state const newData: UpdateDescCountData = new Map(Object.entries(data)); updatePtDescCountMap(newData); }); return () => { socket.off(SocketEventName.UpdateDescCount) }; }, [socket, ptDescCountMap, updatePtDescCountMap]); const onRenamed = useCallback((fromPath: string | undefined, toPath: string) => { mutatePageTree(); mutateSearching(); mutatePageList(); if (currentPagePath === fromPath || currentPagePath === toPath) { mutateCurrentPage(); } }, [currentPagePath, mutateCurrentPage]); const onClickDuplicateMenuItem = useCallback((pageToDuplicate: IPageForPageDuplicateModal) => { // eslint-disable-next-line @typescript-eslint/no-unused-vars const duplicatedHandler: OnDuplicatedFunction = (fromPath, toPath) => { toastSuccess(t('duplicated_pages', { fromPath })); mutatePageTree(); mutateSearching(); mutatePageList(); }; openDuplicateModal(pageToDuplicate, { onDuplicated: duplicatedHandler }); }, [openDuplicateModal, t]); const onClickDeleteMenuItem = useCallback((pageToDelete: IPageToDeleteWithMeta) => { const onDeletedHandler: OnDeletedFunction = (pathOrPathsToDelete, isRecursively, isCompletely) => { if (typeof pathOrPathsToDelete !== 'string') { return; } if (isCompletely) { toastSuccess(t('deleted_pages_completely', { path: pathOrPathsToDelete })); } else { toastSuccess(t('deleted_pages', { path: pathOrPathsToDelete })); } mutatePageTree(); mutateSearching(); mutatePageList(); mutateAllPageInfo(); if (currentPagePath === pathOrPathsToDelete) { mutateCurrentPage(); router.push(isCompletely ? path.dirname(pathOrPathsToDelete) : `/trash${pathOrPathsToDelete}`); } }; openDeleteModal([pageToDelete], { onDeleted: onDeletedHandler }); }, [currentPagePath, mutateCurrentPage, openDeleteModal, router, t]); // *************************** Scroll on init *************************** const scrollOnInit = useCallback(() => { const scrollTargetElement = document.getElementById('grw-pagetree-current-page-item'); if (sidebarScrollerRef?.current == null || scrollTargetElement == null) { return; } logger.debug('scrollOnInit has invoked'); const scrollElement = sidebarScrollerRef.current.getScrollElement(); // NOTE: could not use scrollIntoView // https://stackoverflow.com/questions/11039885/scrollintoview-causing-the-whole-page-to-move // calculate the center point const scrollTop = scrollTargetElement.offsetTop - scrollElement.getBoundingClientRect().height / 2; scrollElement.scrollTo({ top: scrollTop }); setIsInitialScrollCompleted(true); }, [sidebarScrollerRef]); const scrollOnInitDebounced = useMemo(() => debounce(500, scrollOnInit), [scrollOnInit]); useEffect(() => { if (!isSecondStageRenderingCondition(renderingCondition) || isInitialScrollCompleted) { return; } const rootElement = rootElemRef.current as HTMLElement | null; if (rootElement == null) { return; } const observerCallback = (mutationRecords: MutationRecord[]) => { mutationRecords.forEach(() => scrollOnInitDebounced()); }; const observer = new MutationObserver(observerCallback); observer.observe(rootElement, { childList: true, subtree: true }); // first call for the situation that all rendering is complete at this point scrollOnInitDebounced(); return () => { observer.disconnect(); }; }, [isInitialScrollCompleted, renderingCondition, scrollOnInitDebounced]); // ******************************* end ******************************* if (error1 != null || error2 != null) { // TODO: improve message toastError('Error occurred while fetching pages to render PageTree'); return <>; } let initialItemNode; /* * Render second stage */ if (isSecondStageRenderingCondition(renderingCondition)) { initialItemNode = generateInitialNodeAfterResponse( renderingCondition.ancestorsChildrenResult.ancestorsChildren, new ItemNode(renderingCondition.rootPageResult.rootPage), ); } /* * Before swr response comes back */ else if (targetAndAncestorsData != null) { initialItemNode = generateInitialNodeBeforeResponse(targetAndAncestorsData.targetAndAncestors); } if (initialItemNode != null) { return (
); } return ; };