Jayden/AFFiNE-Mirror
1
0
Fork 0
mirror of https://github.com/toeverything/AFFiNE.git synced 2026-02-12 04:18:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

refactor: add hook transform workspace (#1407)

Browse Source
This commit is contained in:
Himself65
2023-03-08 00:21:01 -06:00
committed by GitHub
parent f172831733
commit b8e45d059c
10 changed files with 176 additions and 166 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
apps/web/src/components/affine/workspace-setting-detail/index.tsx
View File

@@ -13,6 +13,8 @@ import { useIsWorkspaceOwner } from '../../../hooks/affine/use-is-workspace-owne
import { fetcher, QueryKey } from '../../../plugins/affine/fetcher';
import {
AffineOfficialWorkspace,
FlavourToWorkspace,
RemWorkspaceFlavour,
SettingPanel,
settingPanel,
} from '../../../shared';
@@ -33,7 +35,14 @@ export type WorkspaceSettingDetailProps = {
currentTab: SettingPanel;
onChangeTab: (tab: SettingPanel) => void;
onDeleteWorkspace: () => void;
onTransferWorkspace: (targetWorkspaceId: string) => void;
onTransferWorkspace: <
From extends RemWorkspaceFlavour,
To extends RemWorkspaceFlavour
>(
from: From,
to: To,
workspace: FlavourToWorkspace[From]
) => void;
};
export type PanelProps = WorkspaceSettingDetailProps;

18
apps/web/src/components/affine/workspace-setting-detail/panel/collaboration/index.tsx
View File

@@ -15,9 +15,7 @@ import {
} from '@blocksuite/icons';
import React, { useCallback, useState } from 'react';
import { lockMutex } from '../../../../../atoms';
import { useMembers } from '../../../../../hooks/affine/use-members';
import { transformWorkspace } from '../../../../../plugins';
import {
AffineWorkspace,
LocalWorkspace,
@@ -194,16 +192,12 @@ const LocalCollaborationPanel: React.FC<
setOpen(false);
}}
onConform={() => {
// todo(himself65): move this function out of affine component
lockMutex(async () => {
const id = await transformWorkspace(
RemWorkspaceFlavour.LOCAL,
RemWorkspaceFlavour.AFFINE,
workspace
);
onTransferWorkspace(id);
setOpen(false);
});
onTransferWorkspace(
RemWorkspaceFlavour.LOCAL,
RemWorkspaceFlavour.AFFINE,
workspace
);
setOpen(false);
}}
/>
</>

16
apps/web/src/components/affine/workspace-setting-detail/panel/publish/index.tsx
View File

@@ -11,14 +11,12 @@ import { Box } from '@mui/material';
import React, { useCallback, useEffect, useState } from 'react';
import { useToggleWorkspacePublish } from '../../../../../hooks/affine/use-toggle-workspace-publish';
import { transformWorkspace } from '../../../../../plugins';
import {
AffineOfficialWorkspace,
AffineWorkspace,
LocalWorkspace,
RemWorkspaceFlavour,
} from '../../../../../shared';
import { apis } from '../../../../../shared/apis';
import { Unreachable } from '../../../affine-error-eoundary';
import { EnableAffineCloudModal } from '../../../enable-affine-cloud-modal';
import { WorkspaceSettingDetailProps } from '../../index';
@@ -102,8 +100,8 @@ const PublishPanelAffine: React.FC<PublishPanelAffineProps> = ({
onClose={() => {
setOpen(false);
}}
onConfirm={async () => {
await publishWorkspace(true);
onConfirm={() => {
publishWorkspace(true);
setOpen(false);
}}
/>
@@ -144,18 +142,12 @@ const PublishPanelLocal: React.FC<PublishPanelLocalProps> = ({
onClose={() => {
setOpen(false);
}}
onConfirm={async () => {
const id = await transformWorkspace(
onConfirm={() => {
onTransferWorkspace(
RemWorkspaceFlavour.LOCAL,
RemWorkspaceFlavour.AFFINE,
workspace
);
await apis.updateWorkspace({
id,
public: true,
});
// fixme: there imply that reload the whole page
onTransferWorkspace(id);
setOpen(false);
}}
/>

45
apps/web/src/components/blocksuite/header/header-right-items/SyncUser.tsx
View File

@@ -9,9 +9,8 @@ import { assertEquals, assertExists } from '@blocksuite/store';
import { useRouter } from 'next/router';
import React, { useEffect, useState } from 'react';
import { lockMutex } from '../../../../atoms';
import { useCurrentWorkspace } from '../../../../hooks/current/use-current-workspace';
import { transformWorkspace } from '../../../../plugins';
import { useTransformWorkspace } from '../../../../hooks/use-transform-workspace';
import {
AffineOfficialWorkspace,
LocalWorkspace,
@@ -75,6 +74,7 @@ export const SyncUser = () => {
const [open, setOpen] = useState(false);
const { t } = useTranslation();
const transformWorkspace = useTransformWorkspace();
if (status === 'offline') {
return (
@@ -111,28 +111,25 @@ export const SyncUser = () => {
onClose={() => {
setOpen(false);
}}
onConform={() => {
// todo(himself65): move this function out of affine component
lockMutex(async () => {
assertEquals(workspace.flavour, RemWorkspaceFlavour.LOCAL);
const id = await transformWorkspace(
RemWorkspaceFlavour.LOCAL,
RemWorkspaceFlavour.AFFINE,
workspace as LocalWorkspace
);
// fixme(himself65): refactor this
router
.replace({
pathname: `/workspace/[workspaceId]/all`,
query: {
workspaceId: id,
},
})
.then(() => {
router.reload();
});
setOpen(false);
});
onConform={async () => {
assertEquals(workspace.flavour, RemWorkspaceFlavour.LOCAL);
const id = await transformWorkspace(
RemWorkspaceFlavour.LOCAL,
RemWorkspaceFlavour.AFFINE,
workspace as LocalWorkspace
);
// fixme(himself65): refactor this
router
.replace({
pathname: `/workspace/[workspaceId]/all`,
query: {
workspaceId: id,
},
})
.then(() => {
router.reload();
});
setOpen(false);
}}
/>
</>

37
apps/web/src/hooks/use-transform-workspace.ts Normal file
View File

@@ -0,0 +1,37 @@
import { useSetAtom } from 'jotai';
import { useCallback } from 'react';
import { jotaiWorkspacesAtom } from '../atoms';
import { WorkspacePlugins } from '../plugins';
import { FlavourToWorkspace, RemWorkspaceFlavour } from '../shared';
/**
* Transform workspace from one flavour to another
*
* The logic here is to delete the old workspace and create a new one.
*/
export function useTransformWorkspace() {
const set = useSetAtom(jotaiWorkspacesAtom);
return useCallback(
async <From extends RemWorkspaceFlavour, To extends RemWorkspaceFlavour>(
from: From,
to: To,
workspace: FlavourToWorkspace[From]
): Promise<string> => {
await WorkspacePlugins[from].CRUD.delete(workspace as any);
const newId = await WorkspacePlugins[to].CRUD.create(
workspace.blockSuiteWorkspace
);
set(workspaces => {
const idx = workspaces.findIndex(ws => ws.id === workspace.id);
workspaces.splice(idx, 1, {
id: newId,
flavour: to,
});
return [...workspaces];
});
return newId;
},
[set]
);
}

129
apps/web/src/pages/_app.tsx
View File

@@ -11,7 +11,6 @@ import Head from 'next/head';
import { useRouter } from 'next/router';
import React, { memo, ReactElement, Suspense, useEffect, useMemo } from 'react';
import { Helmet, HelmetProvider } from 'react-helmet-async';
import { SWRConfig, SWRConfiguration } from 'swr';
import { jotaiStore } from '../atoms';
import { AffineErrorBoundary } from '../components/affine/affine-error-eoundary';
@@ -38,17 +37,6 @@ const DebugAtoms = memo(function DebugAtoms() {
const clientSideEmotionCache = createEmotionCache();
const helmetContext = {};
const defaultSWRConfig: SWRConfiguration = {
suspense: true,
fetcher: () => {
const error = new Error(
'you might forget to warp your page with AffineSWRConfigProvider'
);
console.log(error);
throw error;
},
};
const App = function App({
Component,
pageProps,
@@ -71,67 +59,62 @@ const App = function App({
<CacheProvider value={emotionCache}>
<I18nextProvider i18n={i18n}>
<DebugAtoms />
<SWRConfig value={defaultSWRConfig}>
<AffineErrorBoundary router={useRouter()}>
<Suspense fallback={<PageLoading key="RootPageLoading" />}>
<ProviderComposer
contexts={useMemo(
() => [
<AffineSWRConfigProvider key="AffineSWRConfigProvider" />,
<Provider key="JotaiProvider" store={jotaiStore} />,
<ThemeProvider key="ThemeProvider" />,
],
[]
)}
>
<HelmetProvider key="HelmetProvider" context={helmetContext}>
<Helmet>
<title>AFFiNE</title>
<meta
name="viewport"
content="initial-scale=1, width=device-width"
/>
</Helmet>
<Head>
<meta name="twitter:card" content="summary_large_image" />
<meta
name="twitter:url"
content="https://app.affine.pro/"
/>
<meta
name="twitter:title"
content="AFFiNE：There can be more than Notion and Miro."
/>
<meta
name="twitter:description"
content="There can be more than Notion and Miro. AFFiNE is a next-gen knowledge base that brings planning, sorting and creating all together."
/>
<meta name="twitter:site" content="@AffineOfficial" />
<meta
name="twitter:image"
content="https://affine.pro/og.jpeg"
/>
<meta
property="og:title"
content="AFFiNE：There can be more than Notion and Miro."
/>
<meta property="og:type" content="website" />
<meta
property="og:description"
content="There can be more than Notion and Miro. AFFiNE is a next-gen knowledge base that brings planning, sorting and creating all together."
/>
<meta property="og:url" content="https://app.affine.pro/" />
<meta
property="og:image"
content="https://affine.pro/og.jpeg"
/>
</Head>
{getLayout(<Component {...pageProps} />)}
</HelmetProvider>
</ProviderComposer>
</Suspense>
</AffineErrorBoundary>
</SWRConfig>
<AffineErrorBoundary router={useRouter()}>
<Suspense fallback={<PageLoading key="RootPageLoading" />}>
<ProviderComposer
contexts={useMemo(
() => [
<AffineSWRConfigProvider key="AffineSWRConfigProvider" />,
<Provider key="JotaiProvider" store={jotaiStore} />,
<ThemeProvider key="ThemeProvider" />,
],
[]
)}
>
<HelmetProvider key="HelmetProvider" context={helmetContext}>
<Helmet>
<title>AFFiNE</title>
<meta
name="viewport"
content="initial-scale=1, width=device-width"
/>
</Helmet>
<Head>
<meta name="twitter:card" content="summary_large_image" />
<meta name="twitter:url" content="https://app.affine.pro/" />
<meta
name="twitter:title"
content="AFFiNE：There can be more than Notion and Miro."
/>
<meta
name="twitter:description"
content="There can be more than Notion and Miro. AFFiNE is a next-gen knowledge base that brings planning, sorting and creating all together."
/>
<meta name="twitter:site" content="@AffineOfficial" />
<meta
name="twitter:image"
content="https://affine.pro/og.jpeg"
/>
<meta
property="og:title"
content="AFFiNE：There can be more than Notion and Miro."
/>
<meta property="og:type" content="website" />
<meta
property="og:description"
content="There can be more than Notion and Miro. AFFiNE is a next-gen knowledge base that brings planning, sorting and creating all together."
/>
<meta property="og:url" content="https://app.affine.pro/" />
<meta
property="og:image"
content="https://affine.pro/og.jpeg"
/>
</Head>
{getLayout(<Component {...pageProps} />)}
</HelmetProvider>
</ProviderComposer>
</Suspense>
</AffineErrorBoundary>
</I18nextProvider>
</CacheProvider>
);

7
apps/web/src/pages/workspace/[workspaceId]/all.tsx
View File

@@ -1,6 +1,7 @@
import { useTranslation } from '@affine/i18n';
import { FolderIcon } from '@blocksuite/icons';
import { assertExists } from '@blocksuite/store';
import Head from 'next/head';
import { useRouter } from 'next/router';
import React, { useCallback } from 'react';
@@ -50,6 +51,9 @@ const AllPage: NextPageWithLayout = () => {
const PageList = WorkspacePlugins[currentWorkspace.flavour].UI.PageList;
return (
<>
<Head>
<title>{t('All Pages')} - AFFiNE</title>
</Head>
<WorkspaceTitle icon={<FolderIcon />}>{t('All pages')}</WorkspaceTitle>
<PageList
onOpenPage={onClickPage}
@@ -61,6 +65,9 @@ const AllPage: NextPageWithLayout = () => {
const PageList = WorkspacePlugins[currentWorkspace.flavour].UI.PageList;
return (
<>
<Head>
<title>{t('All Pages')} - AFFiNE</title>
</Head>
<WorkspaceTitle icon={<FolderIcon />}>{t('All pages')}</WorkspaceTitle>
<PageList
onOpenPage={onClickPage}

41
apps/web/src/pages/workspace/[workspaceId]/setting.tsx
View File

@@ -3,19 +3,21 @@ import { SettingsIcon } from '@blocksuite/icons';
import { assertExists } from '@blocksuite/store';
import { useAtom } from 'jotai';
import { atomWithStorage } from 'jotai/utils';
import Head from 'next/head';
import { useRouter } from 'next/router';
import React, { useCallback, useEffect } from 'react';
import { Helmet } from 'react-helmet-async';
import { Unreachable } from '../../../components/affine/affine-error-eoundary';
import { PageLoading } from '../../../components/pure/loading';
import { WorkspaceTitle } from '../../../components/pure/workspace-title';
import { useCurrentWorkspace } from '../../../hooks/current/use-current-workspace';
import { useSyncRouterWithCurrentWorkspace } from '../../../hooks/use-sync-router-with-current-workspace';
import { useTransformWorkspace } from '../../../hooks/use-transform-workspace';
import { useWorkspacesHelper } from '../../../hooks/use-workspaces';
import { WorkspaceLayout } from '../../../layouts';
import { WorkspacePlugins } from '../../../plugins';
import {
FlavourToWorkspace,
NextPageWithLayout,
RemWorkspaceFlavour,
SettingPanel,
@@ -96,23 +98,25 @@ const SettingPage: NextPageWithLayout = () => {
const onDeleteWorkspace = useCallback(() => {
assertExists(currentWorkspace);
const workspaceId = currentWorkspace.id;
helper.deleteWorkspace(workspaceId);
return helper.deleteWorkspace(workspaceId);
}, [currentWorkspace, helper]);
const transformWorkspace = useTransformWorkspace();
const onTransformWorkspace = useCallback(
(targetWorkspaceId: string) => {
router
.replace({
pathname: `/workspace/[workspaceId]/setting`,
query: {
...router.query,
workspaceId: targetWorkspaceId,
},
})
.then(() => {
router.reload();
});
async <From extends RemWorkspaceFlavour, To extends RemWorkspaceFlavour>(
from: From,
to: To,
workspace: FlavourToWorkspace[From]
): Promise<void> => {
const workspaceId = await transformWorkspace(from, to, workspace);
await router.replace({
pathname: `/workspace/[workspaceId]/setting`,
query: {
...router.query,
workspaceId,
},
});
},
[router]
[router, transformWorkspace]
);
if (!router.isReady) {
return <PageLoading />;
@@ -125,9 +129,9 @@ const SettingPage: NextPageWithLayout = () => {
WorkspacePlugins[currentWorkspace.flavour].UI.SettingsDetail;
return (
<>
<Helmet>
<Head>
<title>{t('Workspace Settings')} - AFFiNE</title>
</Helmet>
</Head>
<WorkspaceTitle icon={<SettingsIcon />}>
{t('Workspace Settings')}
</WorkspaceTitle>
@@ -145,6 +149,9 @@ const SettingPage: NextPageWithLayout = () => {
WorkspacePlugins[currentWorkspace.flavour].UI.SettingsDetail;
return (
<>
<Head>
<title>{t('Workspace Settings')} - AFFiNE</title>
</Head>
<WorkspaceTitle icon={<SettingsIcon />}>
{t('Workspace Settings')}
</WorkspaceTitle>

4
apps/web/src/plugins/affine/index.tsx
View File

@@ -1,6 +1,6 @@
import { createJSONStorage } from 'jotai/utils';
import React from 'react';
import { preload } from 'swr';
import { mutate, preload } from 'swr';
import { z } from 'zod';
import { createAffineProviders } from '../../blocksuite';
@@ -65,6 +65,7 @@ export const AffinePlugin: WorkspacePlugin<RemWorkspaceFlavour.AFFINE> = {
blockSuiteWorkspace.doc
);
const { id } = await apis.createWorkspace(new Blob([binary.buffer]));
await mutate(matcher => matcher === QueryKey.getWorkspaces);
// refresh the local storage
await AffinePlugin.CRUD.list();
return id;
@@ -83,6 +84,7 @@ export const AffinePlugin: WorkspacePlugin<RemWorkspaceFlavour.AFFINE> = {
await apis.deleteWorkspace({
id: workspace.id,
});
await mutate(matcher => matcher === QueryKey.getWorkspaces);
},
get: async workspaceId => {
try {

34
apps/web/src/plugins/index.tsx
View File

@@ -1,6 +1,5 @@
import React from 'react';
import { jotaiStore, jotaiWorkspacesAtom } from '../atoms';
import {
BlockSuiteWorkspace,
FlavourToWorkspace,
@@ -20,7 +19,14 @@ type SettingProps<Flavour extends RemWorkspaceFlavour> =
currentTab: SettingPanel;
onChangeTab: (tab: SettingPanel) => void;
onDeleteWorkspace: () => void;
onTransformWorkspace: (targetWorkspaceId: string) => void;
onTransformWorkspace: <
From extends RemWorkspaceFlavour,
To extends RemWorkspaceFlavour
>(
from: From,
to: To,
workspace: FlavourToWorkspace[From]
) => void;
};
type PageDetailProps<Flavour extends RemWorkspaceFlavour> =
@@ -64,27 +70,3 @@ export const WorkspacePlugins = {
} satisfies {
[Key in RemWorkspaceFlavour]: WorkspacePlugin<Key>;
};
/**
* Transform workspace from one flavour to another
*
* The logic here is to delete the old workspace and create a new one.
*/
export async function transformWorkspace<
From extends RemWorkspaceFlavour,
To extends RemWorkspaceFlavour
>(from: From, to: To, workspace: FlavourToWorkspace[From]): Promise<string> {
// fixme: type cast
await WorkspacePlugins[from].CRUD.delete(workspace as any);
const newId = await WorkspacePlugins[to].CRUD.create(
workspace.blockSuiteWorkspace
);
const workspaces = jotaiStore.get(jotaiWorkspacesAtom);
const idx = workspaces.findIndex(ws => ws.id === workspace.id);
workspaces.splice(idx, 1, {
id: newId,
flavour: to,
});
jotaiStore.set(jotaiWorkspacesAtom, [...workspaces]);
return newId;
}