import React, { useCallback, useRef, useState, useEffect, } from 'react'; import EventEmitter from 'events'; import { useTranslation } from 'react-i18next'; import { saveOrUpdate } from '~/client/services/page-operation'; import { toastError, toastSuccess } from '~/client/util/apiNotification'; import { apiPost } from '~/client/util/apiv1-client'; import { getOptionsToSave } from '~/client/util/editor'; import { IResHackmdIntegrated, IResHackmdDiscard } from '~/interfaces/hackmd'; import { useCurrentPageId, useCurrentPathname, useHackmdUri, useIsNotFound, } from '~/stores/context'; import { useSWRxSlackChannels, useIsSlackEnabled, usePageTagsForEditors, useIsEnabledUnsavedWarning, } from '~/stores/editor'; import { usePageIdOnHackmd, useHasDraftOnHackmd, useRevisionIdHackmdSynced, useRemoteRevisionId, } from '~/stores/hackmd'; import { useCurrentPagePath, useSWRxCurrentPage, useSWRxTagsInfo } from '~/stores/page'; import { EditorMode, useEditorMode, useSelectedGrant, } from '~/stores/ui'; import loggerFactory from '~/utils/logger'; import HackmdEditor from './PageEditorByHackmd/HackmdEditor'; import { useRouter } from 'next/router'; const logger = loggerFactory('growi:PageEditorByHackmd'); declare const globalEmitter: EventEmitter; type HackEditorRef = { getValue: () => Promise }; export const PageEditorByHackmd = (): JSX.Element => { const { t } = useTranslation(); const router = useRouter(); const { data: isNotFound } = useIsNotFound(); const { data: editorMode, mutate: mutateEditorMode } = useEditorMode(); const { data: currentPagePath } = useCurrentPagePath(); const { data: currentPathname } = useCurrentPathname(); const { data: slackChannelsData } = useSWRxSlackChannels(currentPagePath); const { data: isSlackEnabled } = useIsSlackEnabled(); const { data: pageId, mutate: mutateCurrentPageId } = useCurrentPageId(); const { data: pageTags } = usePageTagsForEditors(pageId); const { mutate: mutateTagsInfo } = useSWRxTagsInfo(pageId); const { data: grant } = useSelectedGrant(); const { data: hackmdUri } = useHackmdUri(); // pageData const { data: pageData, mutate: mutatePageData } = useSWRxCurrentPage(); const revision = pageData?.revision; const slackChannels = slackChannelsData?.toString(); const [isInitialized, setIsInitialized] = useState(false); const [isInitializing, setIsInitializing] = useState(false); // for error const [hasError, setHasError] = useState(false); const [errorMessage, setErrorMessage] = useState(''); const [errorReason, setErrorReason] = useState(''); // state from pageContainer const { data: pageIdOnHackmd, mutate: mutatePageIdOnHackmd } = usePageIdOnHackmd(); const { data: hasDraftOnHackmd, mutate: mutateHasDraftOnHackmd } = useHasDraftOnHackmd(); const { data: revisionIdHackmdSynced, mutate: mutateRevisionIdHackmdSynced } = useRevisionIdHackmdSynced(); const { mutate: mutateIsEnabledUnsavedWarning } = useIsEnabledUnsavedWarning(); const [isHackmdDraftUpdatingInRealtime, setIsHackmdDraftUpdatingInRealtime] = useState(false); const { data: remoteRevisionId, mutate: mutateRemoteRevisionId } = useRemoteRevisionId(revision?._id); const hackmdEditorRef = useRef(null); const saveAndReturnToViewHandler = useCallback(async(opts?: {overwriteScopesOfDescendants: boolean}) => { if (editorMode !== EditorMode.HackMD) { return } try { if (isSlackEnabled == null || currentPathname == null || slackChannels == null || grant == null || revision == null || hackmdEditorRef.current == null) { throw new Error('Some materials to save are invalid'); } let optionsToSave; const currentOptionsToSave = getOptionsToSave( isSlackEnabled, slackChannels, grant.grant, grant.grantedGroup?.id, grant.grantedGroup?.name, pageTags ?? [], true, ); if (opts != null) { optionsToSave = Object.assign(currentOptionsToSave, { ...opts, }); } else { optionsToSave = currentOptionsToSave; } const markdown = await hackmdEditorRef.current.getValue(); const { page } = await saveOrUpdate(optionsToSave, { pageId, path: currentPagePath || currentPathname, revisionId: revision?._id }, markdown); await mutatePageData(); await mutateTagsInfo(); if (page == null) { return; } // The updateFn should be a promise or asynchronous function to handle the remote mutation // it should return updated data. see: https://swr.vercel.app/docs/mutation#optimistic-updates // Moreover, `async() => false` does not work since it's too fast to be calculated. await mutateIsEnabledUnsavedWarning(new Promise(r => setTimeout(() => r(false), 10)), { optimisticData: () => false }); if (isNotFound) { await router.push(`/${page._id}`); } else { await mutateCurrentPageId(page._id); await mutatePageData(); } mutateEditorMode(EditorMode.View); } catch (error) { logger.error('failed to save', error); toastError(error.message); } }, [editorMode, isSlackEnabled, currentPathname, slackChannels, grant, revision, pageTags, pageId, currentPagePath, mutatePageData, mutateTagsInfo, mutateIsEnabledUnsavedWarning, isNotFound, mutateEditorMode, router, mutateCurrentPageId]); // set handler to save and reload Page useEffect(() => { globalEmitter.on('saveAndReturnToView', saveAndReturnToViewHandler); return function cleanup() { globalEmitter.removeListener('saveAndReturnToView', saveAndReturnToViewHandler); }; }, [saveAndReturnToViewHandler]); const resetInitializedStatusHandler = useCallback(() => { setIsInitialized(false); }, []); // set handler to save and reload Page useEffect(() => { globalEmitter.on('resetInitializedHackMdStatus', resetInitializedStatusHandler); return function cleanup() { globalEmitter.removeListener('resetInitializedHackMdStatus', resetInitializedStatusHandler); }; }, [resetInitializedStatusHandler]); const isResume = useCallback(() => { const isPageExistsOnHackmd = (pageIdOnHackmd != null); return (isPageExistsOnHackmd && hasDraftOnHackmd) || isHackmdDraftUpdatingInRealtime; }, [hasDraftOnHackmd, isHackmdDraftUpdatingInRealtime, pageIdOnHackmd]); const startToEdit = useCallback(async() => { if (hackmdUri == null) { // do nothing return; } setIsInitialized(false); setIsInitializing(true); try { const res = await apiPost('/hackmd.integrate', { pageId }); if (!res.ok) { throw new Error(res.error); } mutatePageIdOnHackmd(res.pageIdOnHackmd); mutateRevisionIdHackmdSynced(res.revisionIdHackmdSynced); } catch (err) { toastError(err.message); setHasError(true); setErrorMessage('GROWI server failed to connect to HackMD.'); setErrorReason(err.toString()); } setIsInitialized(true); setIsInitializing(false); }, [pageId, hackmdUri, mutatePageIdOnHackmd, mutateRevisionIdHackmdSynced]); /** * Start to edit w/o any api request */ const resumeToEdit = useCallback(() => { setIsInitialized(true); }, []); const discardChanges = useCallback(async() => { if (pageId == null) { return } try { const res = await apiPost('/hackmd.discard', { pageId }); if (!res.ok) { throw new Error(res.error); } setIsHackmdDraftUpdatingInRealtime(false); mutateHasDraftOnHackmd(false); mutatePageIdOnHackmd(res.pageIdOnHackmd); mutateRemoteRevisionId(res.revisionIdHackmdSynced); mutateRevisionIdHackmdSynced(res.revisionIdHackmdSynced); } catch (err) { logger.error(err); toastError(err.message); } }, [setIsHackmdDraftUpdatingInRealtime, mutateHasDraftOnHackmd, mutatePageIdOnHackmd, mutateRevisionIdHackmdSynced, pageId]); /** * save and update state of containers * @param {string} markdown */ const onSaveWithShortcut = useCallback(async(markdown) => { try { const currentPagePathOrPathname = currentPagePath || currentPathname; if ( isSlackEnabled == null || grant == null || slackChannels == null || pageId == null || revisionIdHackmdSynced == null || currentPagePathOrPathname == null ) { throw new Error('Some materials to save are invalid') } const optionsToSave = getOptionsToSave( isSlackEnabled, slackChannels, grant.grant, grant.grantedGroup?.id, grant.grantedGroup?.name, pageTags ?? [], true, ); const res = await saveOrUpdate(optionsToSave, { pageId, path: currentPagePathOrPathname, revisionId: revisionIdHackmdSynced }, markdown); // update pageData mutatePageData(res); // set updated data mutateRemoteRevisionId(res.revision._id); mutateRevisionIdHackmdSynced(res.page.revisionHackmdSynced); mutateHasDraftOnHackmd(res.page.hasDraftOnHackmd); mutateTagsInfo(); mutateIsEnabledUnsavedWarning(false); logger.debug('success to save'); toastSuccess(t('successfully_saved_the_page')); } catch (error) { logger.error('failed to save', error); toastError(error.message); } }, [isSlackEnabled, grant, slackChannels, pageId, revisionIdHackmdSynced, currentPathname, pageTags, currentPagePath, mutatePageData, mutateRevisionIdHackmdSynced, mutateHasDraftOnHackmd, mutateTagsInfo, mutateIsEnabledUnsavedWarning, t]); /** * onChange event of HackmdEditor handler */ const hackmdEditorChangeHandler = useCallback(async(body) => { if (hackmdUri == null || pageId == null) { // do nothing return; } if (revision?.body === body) { return; } try { await apiPost('/hackmd.saveOnHackmd', { pageId }); } catch (err) { logger.error(err); } }, [pageId, revision?.body, hackmdUri]); const penpalErrorOccuredHandler = useCallback((error) => { toastError(error.message); setHasError(true); setErrorMessage(t('hackmd.fail_to_connect')); setErrorReason(error.toString()); }, [t]); const renderPreInitContent = useCallback(() => { const isPageNotFound = pageId == null; let content; /* * HackMD is not setup */ if (hackmdUri == null) { content = (

{ t('hackmd.not_set_up')}

{/* eslint-disable-next-line react/no-danger */}

); } /* * used HackMD from NotFound Page */ else if (isPageNotFound) { content = (

{ t('hackmd.used_for_not_found') }

{/* eslint-disable-next-line react/no-danger */}

); } /* * Resume to edit or discard changes */ else if (isResume()) { const isHackmdDocumentOutdated = revisionIdHackmdSynced !== remoteRevisionId; content = (

HackMD is READY!

{t('hackmd.unsaved_draft')}

{ isHackmdDocumentOutdated && (
{t('hackmd.draft_outdated')}
{t('hackmd.based_on_revision')}  {revisionIdHackmdSynced?.substr(-8)}
) } { !isHackmdDocumentOutdated && (
) }
); } /* * Start to edit */ else { const isRevisionOutdated = revision?._id !== remoteRevisionId; content = (

HackMD is READY!

{t('hackmd.clone_page_content')}

); } return (
{content}
); }, [discardChanges, isInitializing, isResume, resumeToEdit, startToEdit, t, hackmdUri, pageId, remoteRevisionId, revisionIdHackmdSynced, revision?._id]); if (editorMode == null || revision == null) { return <>; } let content; // TODO: typescriptize // using any because ref cann't used between FC and class conponent with type safe const AnyEditor = HackmdEditor as any; if (isInitialized && hackmdUri != null) { content = ( { onSaveWithShortcut(document); }} onPenpalErrorOccured={penpalErrorOccuredHandler} > ); } else { content = renderPreInitContent(); } return (
{content} { hasError && (

{t('hackmd.integration_failed')}

{errorMessage}

{errorReason}

{/* eslint-disable-next-line react/no-danger */}

) }
); };