refactor: avoid runtime config object (#8202)

2026-02-13 21:05:19 +00:00 · 2024-09-13 07:27:11 +00:00
parent c76b4d70b0
commit 25969a34e8
45 changed files with 117 additions and 156 deletions
--- a/packages/frontend/core/src/bootstrap/first-app-data.ts
+++ b/packages/frontend/core/src/bootstrap/first-app-data.ts
@@ -46,7 +46,7 @@ export async function createFirstAppData(workspacesService: WorkspacesService) {
    return;
  }
  localStorage.setItem('is-first-open', 'false');
-  if (runtimeConfig.enablePreloading) {
+  if (BUILD_CONFIG.enablePreloading) {
    const { meta, defaultDocId } = await buildShowcaseWorkspace(
      workspacesService,
      WorkspaceFlavour.LOCAL,
--- a/packages/frontend/core/src/commands/affine-help.tsx
+++ b/packages/frontend/core/src/commands/affine-help.tsx
@@ -23,7 +23,7 @@ export function registerAffineHelpCommands({
      label: t['com.affine.cmdk.affine.whats-new'](),
      run() {
        track.$.cmdk.help.openChangelog();
-        popupWindow(runtimeConfig.changelogUrl);
+        popupWindow(BUILD_CONFIG.changelogUrl);
      },
    })
  );
--- a/packages/frontend/core/src/components/affine/auth/oauth.tsx
+++ b/packages/frontend/core/src/components/affine/auth/oauth.tsx
@@ -50,7 +50,7 @@ function OAuthProvider({ provider }: { provider: OAuthProviderType }) {

  const onClick = useCallback(() => {
    let oauthUrl =
-      (environment.isElectron ? runtimeConfig.serverUrlPrefix : '') +
+      (environment.isElectron ? BUILD_CONFIG.serverUrlPrefix : '') +
      `/oauth/login?provider=${provider}`;

    if (environment.isElectron) {
--- a/packages/frontend/core/src/components/affine/create-workspace-modal/index.tsx
+++ b/packages/frontend/core/src/components/affine/create-workspace-modal/index.tsx
@@ -48,7 +48,7 @@ interface NameWorkspaceContentProps extends ConfirmModalProps {
  ) => void;
 }

-const shouldEnableCloud = !runtimeConfig.allowLocalWorkspace;
+const shouldEnableCloud = !BUILD_CONFIG.allowLocalWorkspace;

 const NameWorkspaceContent = ({
  loading,
@@ -159,7 +159,7 @@ const NameWorkspaceContent = ({
        {shouldEnableCloud ? (
          <a
            className={styles.cloudTips}
-            href={runtimeConfig.downloadUrl}
+            href={BUILD_CONFIG.downloadUrl}
            target="_blank"
            rel="noreferrer"
          >
@@ -229,7 +229,7 @@ export const CreateWorkspaceModal = ({

      // this will be the last step for web for now
      // fix me later
-      if (runtimeConfig.enablePreloading) {
+      if (BUILD_CONFIG.enablePreloading) {
        const { meta, defaultDocId } = await buildShowcaseWorkspace(
          workspacesService,
          workspaceFlavour,
--- a/packages/frontend/core/src/components/affine/issue-feedback-modal/index.tsx
+++ b/packages/frontend/core/src/components/affine/issue-feedback-modal/index.tsx
@@ -24,7 +24,7 @@ export const IssueFeedbackModal = () => {
      onOpenChange={setOpen}
      description={t['com.affine.issue-feedback.description']()}
      cancelText={t['com.affine.issue-feedback.cancel']()}
-      to={`${runtimeConfig.githubUrl}/issues/new/choose`}
+      to={`${BUILD_CONFIG.githubUrl}/issues/new/choose`}
      confirmText={t['com.affine.issue-feedback.confirm']()}
      confirmButtonOptions={{
        variant: 'primary',
--- a/packages/frontend/core/src/components/affine/setting-modal/general-setting/about/index.tsx
+++ b/packages/frontend/core/src/components/affine/setting-modal/general-setting/about/index.tsx
@@ -21,7 +21,7 @@ export const AboutAffine = () => {
  const t = useI18n();
  const { appSettings, updateSettings } = useAppSettingHelper();
  const { toggleAutoCheck, toggleAutoDownload } = useAppUpdater();
-  const channel = runtimeConfig.appBuildType;
+  const channel = BUILD_CONFIG.appBuildType;
  const appIcon = appIconMap[channel];
  const appName = appNames[channel];

@@ -63,14 +63,14 @@ export const AboutAffine = () => {
      <SettingWrapper title={t['com.affine.aboutAFFiNE.version.title']()}>
        <SettingRow
          name={appName}
-          desc={runtimeConfig.appVersion}
+          desc={BUILD_CONFIG.appVersion}
          className={styles.appImageRow}
        >
          <img src={appIcon} alt={appName} width={56} height={56} />
        </SettingRow>
        <SettingRow
          name={t['com.affine.aboutAFFiNE.version.editor.title']()}
-          desc={runtimeConfig.editorVersion}
+          desc={BUILD_CONFIG.editorVersion}
        />
        {environment.isElectron ? (
          <>
@@ -100,7 +100,7 @@ export const AboutAffine = () => {
              desc={t['com.affine.aboutAFFiNE.changelog.description']()}
              style={{ cursor: 'pointer' }}
              onClick={() => {
-                popupWindow(runtimeConfig.changelogUrl);
+                popupWindow(BUILD_CONFIG.changelogUrl);
              }}
            >
              <ArrowRightSmallIcon />
--- a/packages/frontend/core/src/components/affine/setting-modal/general-setting/appearance/index.tsx
+++ b/packages/frontend/core/src/components/affine/setting-modal/general-setting/appearance/index.tsx
@@ -98,7 +98,7 @@ export const AppearanceSettings = () => {
            />
          </SettingRow>
        ) : null}
-        {runtimeConfig.enableNewSettingUnstableApi && environment.isElectron ? (
+        {BUILD_CONFIG.enableNewSettingUnstableApi && environment.isElectron ? (
          <SettingRow
            name={t['com.affine.appearanceSettings.windowFrame.title']()}
            desc={t['com.affine.appearanceSettings.windowFrame.description']()}
@@ -118,11 +118,11 @@ export const AppearanceSettings = () => {
            />
          </SettingRow>
        ) : null}
-        {runtimeConfig.enableThemeEditor ? <ThemeEditorSetting /> : null}
+        {BUILD_CONFIG.enableThemeEditor ? <ThemeEditorSetting /> : null}
      </SettingWrapper>
      {/* // TODO(@JimmFly): remove Page component when stable release */}
      <Page />
-      {runtimeConfig.enableNewSettingUnstableApi ? (
+      {BUILD_CONFIG.enableNewSettingUnstableApi ? (
        <SettingWrapper title={t['com.affine.appearanceSettings.date.title']()}>
          <SettingRow
            name={t['com.affine.appearanceSettings.dateFormat.title']()}
--- a/packages/frontend/core/src/components/affine/setting-modal/general-setting/index.tsx
+++ b/packages/frontend/core/src/components/affine/setting-modal/general-setting/index.tsx
@@ -107,7 +107,7 @@ export const useGeneralSettingList = (): GeneralSettingList => {
    }
  }

-  if (runtimeConfig.enableExperimentalFeature) {
+  if (BUILD_CONFIG.enableExperimentalFeature) {
    settings.push({
      key: 'experimental-features',
      title: t['com.affine.settings.workspace.experimental-features'](),
--- a/packages/frontend/core/src/components/affine/star-affine-modal/index.tsx
+++ b/packages/frontend/core/src/components/affine/star-affine-modal/index.tsx
@@ -24,7 +24,7 @@ export const StarAFFiNEModal = () => {
      onOpenChange={setOpen}
      description={t['com.affine.star-affine.description']()}
      cancelText={t['com.affine.star-affine.cancel']()}
-      to={runtimeConfig.githubUrl}
+      to={BUILD_CONFIG.githubUrl}
      confirmButtonOptions={{
        variant: 'primary',
      }}
--- a/packages/frontend/core/src/components/blocksuite/block-suite-editor/blocksuite-editor.tsx
+++ b/packages/frontend/core/src/components/blocksuite/block-suite-editor/blocksuite-editor.tsx
@@ -89,22 +89,22 @@ const BlockSuiteEditorImpl = ({

            // provide image proxy endpoint to blocksuite
            editor.host?.std.clipboard.use(
-              customImageProxyMiddleware(runtimeConfig.imageProxyUrl)
+              customImageProxyMiddleware(BUILD_CONFIG.imageProxyUrl)
            );
-            ImageBlockService.setImageProxyURL(runtimeConfig.imageProxyUrl);
+            ImageBlockService.setImageProxyURL(BUILD_CONFIG.imageProxyUrl);

            // provide link preview endpoint to blocksuite
            BookmarkBlockService.setLinkPreviewEndpoint(
-              runtimeConfig.linkPreviewUrl
+              BUILD_CONFIG.linkPreviewUrl
            );
            EmbedGithubBlockService.setLinkPreviewEndpoint(
-              runtimeConfig.linkPreviewUrl
+              BUILD_CONFIG.linkPreviewUrl
            );
            EmbedYoutubeBlockService.setLinkPreviewEndpoint(
-              runtimeConfig.linkPreviewUrl
+              BUILD_CONFIG.linkPreviewUrl
            );
            EmbedLoomBlockService.setLinkPreviewEndpoint(
-              runtimeConfig.linkPreviewUrl
+              BUILD_CONFIG.linkPreviewUrl
            );

            return editor.host?.updateComplete;
--- a/packages/frontend/core/src/components/blocksuite/block-suite-editor/specs/font-extension.ts
+++ b/packages/frontend/core/src/components/blocksuite/block-suite-editor/specs/font-extension.ts
@@ -2,7 +2,7 @@ import { AffineCanvasTextFonts, FontConfigExtension } from '@blocksuite/blocks';

 export function getFontConfigExtension() {
  return FontConfigExtension(
-    runtimeConfig.isSelfHosted
+    BUILD_CONFIG.isSelfHosted
      ? AffineCanvasTextFonts.map(font => ({
          ...font,
          // self-hosted fonts are served from /assets
--- a/packages/frontend/core/src/components/blocksuite/block-suite-header/menu/index.tsx
+++ b/packages/frontend/core/src/components/blocksuite/block-suite-header/menu/index.tsx
@@ -304,16 +304,13 @@ export const PageHeaderMenuButton = ({
      )}

      <MenuSeparator />
-
-      {runtimeConfig.enableInfoModal && (
-        <MenuItem
-          prefixIcon={<InformationIcon />}
-          data-testid="editor-option-menu-info"
-          onSelect={openInfoModal}
-        >
-          {t['com.affine.page-properties.page-info.view']()}
-        </MenuItem>
-      )}
+      <MenuItem
+        prefixIcon={<InformationIcon />}
+        data-testid="editor-option-menu-info"
+        onSelect={openInfoModal}
+      >
+        {t['com.affine.page-properties.page-info.view']()}
+      </MenuItem>
      {currentMode === 'page' ? (
        <MenuItem
          prefixIcon={<TocIcon />}
--- a/packages/frontend/core/src/components/page-list/operation-cell.tsx
+++ b/packages/frontend/core/src/components/page-list/operation-cell.tsx
@@ -173,11 +173,9 @@ export const PageOperationCell = ({
          ? t['com.affine.favoritePageOperation.remove']()
          : t['com.affine.favoritePageOperation.add']()}
      </MenuItem>
-      {runtimeConfig.enableInfoModal ? (
-        <MenuItem onClick={onOpenInfoModal} prefixIcon={<InformationIcon />}>
-          {t['com.affine.page-properties.page-info.view']()}
-        </MenuItem>
-      ) : null}
+      <MenuItem onClick={onOpenInfoModal} prefixIcon={<InformationIcon />}>
+        {t['com.affine.page-properties.page-info.view']()}
+      </MenuItem>

      <MenuItem onClick={onOpenInNewTab} prefixIcon={<OpenInNewIcon />}>
        {t['com.affine.workbench.tab.page-menu-open']()}
--- a/packages/frontend/core/src/components/pure/help-island/index.tsx
+++ b/packages/frontend/core/src/components/pure/help-island/index.tsx
@@ -77,7 +77,7 @@ export const HelpIsland = () => {
            <StyledIconWrapper
              data-testid="right-bottom-change-log-icon"
              onClick={() => {
-                popupWindow(runtimeConfig.changelogUrl);
+                popupWindow(BUILD_CONFIG.changelogUrl);
              }}
            >
              <NewIcon />
--- a/packages/frontend/core/src/components/root-app-sidebar/index.tsx
+++ b/packages/frontend/core/src/components/root-app-sidebar/index.tsx
@@ -176,7 +176,7 @@ export const RootAppSidebar = (): ReactElement => {
      </SidebarContainer>
      <SidebarScrollableContainer>
        <ExplorerFavorites />
-        {runtimeConfig.enableOrganize && <ExplorerOrganize />}
+        <ExplorerOrganize />
        <ExplorerMigrationFavorites />
        <ExplorerCollections />
        <ExplorerTags />
--- a/packages/frontend/core/src/components/workspace-selector/user-with-workspace-list/add-workspace/index.tsx
+++ b/packages/frontend/core/src/components/workspace-selector/user-with-workspace-list/add-workspace/index.tsx
@@ -36,7 +36,7 @@ export const AddWorkspace = ({
        className={styles.ItemContainer}
      >
        <div className={styles.ItemText}>
-          {runtimeConfig.allowLocalWorkspace
+          {BUILD_CONFIG.allowLocalWorkspace
            ? t['com.affine.workspaceList.addWorkspace.create']()
            : t['com.affine.workspaceList.addWorkspace.create-cloud']()}
        </div>
--- a/packages/frontend/core/src/components/workspace-selector/user-with-workspace-list/index.tsx
+++ b/packages/frontend/core/src/components/workspace-selector/user-with-workspace-list/index.tsx
@@ -88,7 +88,7 @@ const UserWithWorkspaceListInner = ({
  }, [setOpenSignIn]);

  const onNewWorkspace = useCallback(() => {
-    if (!isAuthenticated && !runtimeConfig.allowLocalWorkspace) {
+    if (!isAuthenticated && !BUILD_CONFIG.allowLocalWorkspace) {
      return openSignInModal();
    }
    track.$.navigationPanel.workspaceList.createWorkspace();
--- a/packages/frontend/core/src/hooks/affine/use-register-blocksuite-editor-commands.tsx
+++ b/packages/frontend/core/src/hooks/affine/use-register-blocksuite-editor-commands.tsx
@@ -95,9 +95,7 @@ export function useRegisterBlocksuiteEditorCommands(editor: Editor) {
      registerAffineCommand({
        id: `editor:${mode}-view-info`,
        preconditionStrategy: () =>
-          PreconditionStrategy.InPaperOrEdgeless &&
-          !trash &&
-          runtimeConfig.enableInfoModal,
+          PreconditionStrategy.InPaperOrEdgeless && !trash,
        category: `editor:${mode}`,
        icon: mode === 'page' ? <PageIcon /> : <EdgelessIcon />,
        label: t['com.affine.page-properties.page-info.view'](),
--- a/packages/frontend/core/src/hooks/use-app-updater.ts
+++ b/packages/frontend/core/src/hooks/use-app-updater.ts
@@ -177,7 +177,7 @@ export const useAppUpdater = () => {

  const openChangelog = useAsyncCallback(async () => {
    track.$.navigationPanel.bottomButtons.openChangelog();
-    popupWindow(runtimeConfig.changelogUrl);
+    popupWindow(BUILD_CONFIG.changelogUrl);
    await setChangelogUnread(true);
  }, [setChangelogUnread]);

--- a/packages/frontend/core/src/mixpanel/mixpanel.ts
+++ b/packages/frontend/core/src/mixpanel/mixpanel.ts
@@ -32,10 +32,10 @@ function createMixpanel() {
  const wrapped = {
    init() {
      mixpanel.register({
-        appVersion: runtimeConfig.appVersion,
-        environment: runtimeConfig.appBuildType,
-        editorVersion: runtimeConfig.editorVersion,
-        isSelfHosted: Boolean(runtimeConfig.isSelfHosted),
+        appVersion: BUILD_CONFIG.appVersion,
+        environment: BUILD_CONFIG.appBuildType,
+        editorVersion: BUILD_CONFIG.editorVersion,
+        isSelfHosted: Boolean(BUILD_CONFIG.isSelfHosted),
        isDesktop: environment.isElectron,
      });
    },
--- a/packages/frontend/core/src/modules/cloud/services/fetch.ts
+++ b/packages/frontend/core/src/modules/cloud/services/fetch.ts
@@ -6,7 +6,7 @@ import { BackendError, NetworkError } from '../error';

 export function getAffineCloudBaseUrl(): string {
  if (environment.isElectron) {
-    return runtimeConfig.serverUrlPrefix;
+    return BUILD_CONFIG.serverUrlPrefix;
  }
  const { protocol, hostname, port } = window.location;
  return `${protocol}//${hostname}${port ? `:${port}` : ''}`;
--- a/packages/frontend/core/src/modules/create-workspace/views/dialog.tsx
+++ b/packages/frontend/core/src/modules/create-workspace/views/dialog.tsx
@@ -35,7 +35,7 @@ interface NameWorkspaceContentProps extends ConfirmModalProps {
  ) => void;
 }

-const shouldEnableCloud = !runtimeConfig.allowLocalWorkspace;
+const shouldEnableCloud = !BUILD_CONFIG.allowLocalWorkspace;

 const NameWorkspaceContent = ({
  loading,
@@ -146,7 +146,7 @@ const NameWorkspaceContent = ({
        {shouldEnableCloud ? (
          <a
            className={styles.cloudTips}
-            href={runtimeConfig.downloadUrl}
+            href={BUILD_CONFIG.downloadUrl}
            target="_blank"
            rel="noreferrer"
          >
@@ -213,7 +213,7 @@ const CreateWorkspaceDialog = () => {

      // this will be the last step for web for now
      // fix me later
-      if (runtimeConfig.enablePreloading) {
+      if (BUILD_CONFIG.enablePreloading) {
        const { meta, defaultDocId } = await buildShowcaseWorkspace(
          workspacesService,
          workspaceFlavour,
--- a/packages/frontend/core/src/modules/explorer/views/nodes/doc/operations.tsx
+++ b/packages/frontend/core/src/modules/explorer/views/nodes/doc/operations.tsx
@@ -154,21 +154,17 @@ export const useExplorerDocNodeOperations = (
          />
        ),
      },
-      ...(runtimeConfig.enableInfoModal
-        ? [
-            {
-              index: 50,
-              view: (
-                <MenuItem
-                  prefixIcon={<InformationIcon />}
-                  onClick={handleOpenInfoModal}
-                >
-                  {t['com.affine.page-properties.page-info.view']()}
-                </MenuItem>
-              ),
-            },
-          ]
-        : []),
+      {
+        index: 50,
+        view: (
+          <MenuItem
+            prefixIcon={<InformationIcon />}
+            onClick={handleOpenInfoModal}
+          >
+            {t['com.affine.page-properties.page-info.view']()}
+          </MenuItem>
+        ),
+      },
      {
        index: 99,
        view: (
--- a/packages/frontend/core/src/modules/theme-editor/views/custom-theme.tsx
+++ b/packages/frontend/core/src/modules/theme-editor/views/custom-theme.tsx
@@ -11,7 +11,7 @@ export const useCustomTheme = (target: HTMLElement) => {
  const { resolvedTheme } = useTheme();

  useEffect(() => {
-    if (!runtimeConfig.enableThemeEditor) return;
+    if (!BUILD_CONFIG.enableThemeEditor) return;
    if (_provided) return;

    _provided = true;
--- a/packages/frontend/core/src/modules/userspace/impls/user-db-doc-server.ts
+++ b/packages/frontend/core/src/modules/userspace/impls/user-db-doc-server.ts
@@ -36,7 +36,7 @@ export class UserDBDocServer implements DocServer {
    await this.socket.emitWithAck('space:join', {
      spaceType: 'userspace',
      spaceId: this.userId,
-      clientVersion: runtimeConfig.appVersion,
+      clientVersion: BUILD_CONFIG.appVersion,
    });
  }

--- a/packages/frontend/core/src/modules/workspace-engine/impls/engine/awareness-cloud.ts
+++ b/packages/frontend/core/src/modules/workspace-engine/impls/engine/awareness-cloud.ts
@@ -166,7 +166,7 @@ export class CloudAwarenessConnection implements AwarenessConnection {
        spaceType: 'workspace',
        spaceId: this.workspaceId,
        docId: this.workspaceId,
-        clientVersion: runtimeConfig.appVersion,
+        clientVersion: BUILD_CONFIG.appVersion,
      },
      (res: any) => {
        logger.debug('awareness handshake finished', res);
--- a/packages/frontend/core/src/modules/workspace-engine/impls/engine/doc-cloud.ts
+++ b/packages/frontend/core/src/modules/workspace-engine/impls/engine/doc-cloud.ts
@@ -37,7 +37,7 @@ export class CloudDocEngineServer implements DocServer {
    await this.socket.emitWithAck('space:join', {
      spaceType: 'workspace',
      spaceId: this.workspaceId,
-      clientVersion: runtimeConfig.appVersion,
+      clientVersion: BUILD_CONFIG.appVersion,
    });
  }

--- a/packages/frontend/core/src/pages/workspace/detail-page/detail-page-header.tsx
+++ b/packages/frontend/core/src/pages/workspace/detail-page/detail-page-header.tsx
@@ -139,7 +139,7 @@ export function NormalPageHeader({ page, workspace }: PageHeaderProps) {
        {hideCollect ? null : (
          <>
            <FavoriteButton pageId={page?.id} />
-            {runtimeConfig.enableInfoModal ? <InfoButton /> : null}
+            <InfoButton />
          </>
        )}
        <PageHeaderMenuButton
--- a/packages/frontend/core/src/utils/popup.ts
+++ b/packages/frontend/core/src/utils/popup.ts
@@ -1,8 +1,8 @@
 export function popupWindow(target: string) {
-  const url = new URL(runtimeConfig.serverUrlPrefix + '/redirect-proxy');
+  const url = new URL(BUILD_CONFIG.serverUrlPrefix + '/redirect-proxy');
  target = /^https?:\/\//.test(target)
    ? target
-    : runtimeConfig.serverUrlPrefix + target;
+    : BUILD_CONFIG.serverUrlPrefix + target;
  url.searchParams.set('redirect_uri', target);
  return window.open(url, '_blank', `noreferrer noopener`);
 }
--- a/packages/frontend/core/src/utils/url.ts
+++ b/packages/frontend/core/src/utils/url.ts
@@ -8,7 +8,7 @@ interface AppUrlOptions {

 export function buildAppUrl(path: string, opts: AppUrlOptions = {}) {
  // TODO(@EYHN): should use server base url
-  const webBase = runtimeConfig.serverUrlPrefix;
+  const webBase = BUILD_CONFIG.serverUrlPrefix;
  // TODO(@pengx17): how could we know the corresponding app schema in web environment
  if (opts.desktop && appInfo?.schema) {
    const urlCtor = new URL(path, webBase);