refactor: migrate environment to BUILD_CONFIG

toeverything · Sep 12, 2024 · ab82d30 · ab82d30
1 parent ed217ab
commit ab82d30
Show file tree

Hide file tree

Showing 85 changed files with 298 additions and 277 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -34,7 +34,7 @@ const createPattern = packageName => [
   {
     group: ['@affine/env/constant'],
     message:
-      'Do not import from @affine/env/constant. Use `environment.isElectron` instead',
+      'Do not import from @affine/env/constant. Use `BUILD_CONFIG.isElectron` instead',
     importNames: ['isElectron'],
   },
 ];

diff --git a/packages/common/env/src/constant.ts b/packages/common/env/src/constant.ts
@@ -10,9 +10,6 @@ declare global {
   };
 }
 
-//#region runtime variables
-export const isElectron = !!globalThis.__appInfo?.electron;
-//#endregion
 export const DEFAULT_WORKSPACE_NAME = 'Demo Workspace';
 export const UNTITLED_WORKSPACE_NAME = 'Untitled';
 

diff --git a/packages/common/env/src/global.ts b/packages/common/env/src/global.ts
@@ -1,51 +1,47 @@
 /// <reference types="@blocksuite/global" />
-import { assertEquals } from '@blocksuite/global/utils';
-import { z } from 'zod';
 
-import { isElectron } from './constant.js';
 import { UaHelper } from './ua-helper.js';
 
-export const BUILD_CONFIG_SCHEMA = z.object({
-  // this is for the electron app
-  serverUrlPrefix: z.string(),
-  appVersion: z.string(),
-  editorVersion: z.string(),
-  distribution: z.enum(['web', 'desktop', 'admin', 'mobile']),
-  appBuildType: z.union([
-    z.literal('stable'),
-    z.literal('beta'),
-    z.literal('internal'),
-    z.literal('canary'),
-  ]),
-  isSelfHosted: z.boolean().optional(),
-  githubUrl: z.string(),
-  changelogUrl: z.string(),
-  downloadUrl: z.string(),
-  // see: tools/workers
-  imageProxyUrl: z.string(),
-  linkPreviewUrl: z.string(),
-  allowLocalWorkspace: z.boolean(),
-  enablePreloading: z.boolean(),
-  enableNewSettingUnstableApi: z.boolean(),
-  enableExperimentalFeature: z.boolean(),
-  enableThemeEditor: z.boolean(),
-});
-
-export type BUILD_CONFIG_TYPE = z.infer<typeof BUILD_CONFIG_SCHEMA>;
-
-export type Environment = {
-  isDebug: boolean;
-
-  // Edition
+export type BUILD_CONFIG_TYPE = {
+  debug: boolean;
+  distribution: 'web' | 'desktop' | 'admin' | 'mobile';
+  /**
+   * 'web' | 'desktop' | 'admin'
+   */
   isDesktopEdition: boolean;
+  /**
+   * 'mobile'
+   */
   isMobileEdition: boolean;
 
-  // Platform/Entry
   isElectron: boolean;
-  isDesktopWeb: boolean;
+  isWeb: boolean;
   isMobileWeb: boolean;
-  isStandalone?: boolean;
 
+  // this is for the electron app
+  serverUrlPrefix: string;
+  appVersion: string;
+  editorVersion: string;
+  appBuildType: 'stable' | 'beta' | 'internal' | 'canary';
+
+  githubUrl: string;
+  changelogUrl: string;
+  downloadUrl: string;
+  // see: tools/workers
+  imageProxyUrl: string;
+  linkPreviewUrl: string;
+
+  allowLocalWorkspace: boolean;
+  enablePreloading: boolean;
+  enableNewSettingUnstableApi: boolean;
+  enableExperimentalFeature: boolean;
+  enableThemeEditor: boolean;
+
+  // TODO(@forehalo): remove
+  isSelfHosted: boolean;
+};
+
+export type Environment = {
   // Device
   isLinux: boolean;
   isMacOs: boolean;
@@ -55,6 +51,8 @@ export type Environment = {
   isFireFox: boolean;
   isMobile: boolean;
   isChrome: boolean;
+  isPwa: boolean;
+
   chromeVersion?: number;
 };
 
@@ -64,35 +62,23 @@ export function setupGlobal() {
   }
 
   let environment: Environment;
-  const isDebug = process.env.NODE_ENV === 'development';
 
   if (!globalThis.navigator) {
     environment = {
-      isDesktopEdition: false,
-      isMobileEdition: false,
-      isElectron: false,
-      isDesktopWeb: false,
-      isMobileWeb: false,
-      isMobile: false,
-      isDebug,
       isLinux: false,
       isMacOs: false,
       isSafari: false,
       isWindows: false,
       isFireFox: false,
       isChrome: false,
       isIOS: false,
+      isPwa: false,
+      isMobile: false,
     };
   } else {
     const uaHelper = new UaHelper(globalThis.navigator);
 
     environment = {
-      isDesktopEdition: BUILD_CONFIG.distribution !== 'mobile',
-      isMobileEdition: BUILD_CONFIG.distribution === 'mobile',
-      isDesktopWeb: BUILD_CONFIG.distribution === 'web',
-      isMobileWeb: BUILD_CONFIG.distribution === 'mobile',
-      isElectron,
-      isDebug,
       isMobile: uaHelper.isMobile,
       isLinux: uaHelper.isLinux,
       isMacOs: uaHelper.isMacOs,
@@ -101,12 +87,10 @@ export function setupGlobal() {
       isFireFox: uaHelper.isFireFox,
       isChrome: uaHelper.isChrome,
       isIOS: uaHelper.isIOS,
-      isStandalone: uaHelper.isStandalone,
+      isPwa: uaHelper.isStandalone,
     };
     // Chrome on iOS is still Safari
     if (environment.isChrome && !environment.isIOS) {
-      assertEquals(environment.isSafari, false);
-      assertEquals(environment.isFireFox, false);
       environment = {
         ...environment,
         isSafari: false,

diff --git a/packages/common/infra/src/atom/settings.ts b/packages/common/infra/src/atom/settings.ts
@@ -44,7 +44,7 @@ export const dateFormatOptions: DateFormats[] = [
 ];
 
 const appSettingBaseAtom = atomWithStorage<AppSetting>('affine-settings', {
-  clientBorder: environment.isElectron && !environment.isWindows,
+  clientBorder: BUILD_CONFIG.isElectron && !environment.isWindows,
   windowFrameStyle: 'frameless',
   dateFormat: dateFormatOptions[0],
   startWeekOnMonday: false,
@@ -61,7 +61,7 @@ type SetStateAction<Value> = Value | ((prev: Value) => Value);
 const appSettingEffect = atomEffect(get => {
   const settings = get(appSettingBaseAtom);
   // some values in settings should be synced into electron side
-  if (environment.isElectron) {
+  if (BUILD_CONFIG.isElectron) {
     logger.debug('sync settings to electron', settings);
     // this api type in @affine/electron-api, but it is circular dependency this package, use any here
     (window as any).apis?.updater

diff --git a/packages/common/infra/src/livedata/effect/index.ts b/packages/common/infra/src/livedata/effect/index.ts
@@ -75,7 +75,7 @@ export function effect<T, A, B, C, D, E, F>(
 export function effect(...args: any[]) {
   const subject$ = new Subject<any>();
 
-  const effectLocation = environment.isDebug
+  const effectLocation = BUILD_CONFIG.debug
     ? `(${new Error().stack?.split('\n')[2].trim()})`
     : '';
 

diff --git a/packages/common/infra/src/modules/feature-flag/constant.ts b/packages/common/infra/src/modules/feature-flag/constant.ts
@@ -1,7 +1,7 @@
 import type { FlagInfo } from './types';
 
 const isNotStableBuild = BUILD_CONFIG.appBuildType !== 'stable';
-const isDesktopEnvironment = environment.isElectron;
+const isDesktopEnvironment = BUILD_CONFIG.isElectron;
 const isCanaryBuild = BUILD_CONFIG.appBuildType === 'canary';
 
 export const AFFINE_FLAGS = {

diff --git a/packages/frontend/component/.storybook/main.ts b/packages/frontend/component/.storybook/main.ts
@@ -3,7 +3,7 @@ import { StorybookConfig } from '@storybook/react-vite';
 import { vanillaExtractPlugin } from '@vanilla-extract/vite-plugin';
 import swc from 'unplugin-swc';
 import { mergeConfig } from 'vite';
-import { getRuntimeConfig } from '@affine/cli/src/webpack/runtime-config';
+import { getBuildConfig } from '@affine/cli/src/webpack/runtime-config';
 
 export default {
   stories: ['../src/ui/**/*.@(mdx|stories.@(js|jsx|ts|tsx))'],
@@ -54,13 +54,12 @@ export default {
       ],
       define: {
         'process.env.CAPTCHA_SITE_KEY': `"${process.env.CAPTCHA_SITE_KEY}"`,
-        runtimeConfig: getRuntimeConfig({
+        runtimeConfig: getBuildConfig({
           distribution: 'web',
           mode: 'development',
           channel: 'canary',
           static: false,
           coverage: false,
-          static: false,
         }),
       },
     });

diff --git a/packages/frontend/component/src/components/affine-other-page-layout/layout.tsx b/packages/frontend/component/src/components/affine-other-page-layout/layout.tsx
@@ -20,7 +20,7 @@ export const AffineOtherPageLayout = ({
 
   return (
     <div className={styles.root}>
-      {environment.isElectron ? null : (
+      {!BUILD_CONFIG.isElectron && (
         <div className={styles.topNav}>
           <a href="/" rel="noreferrer" className={styles.affineLogo}>
             <Logo1Icon width={24} height={24} />

diff --git a/packages/frontend/component/src/components/auth-components/onboarding-page.tsx b/packages/frontend/component/src/components/auth-components/onboarding-page.tsx
@@ -119,8 +119,8 @@ export const OnboardingPage = ({
     () => questions?.[questionIdx],
     [questionIdx, questions]
   );
-  const isMacosDesktop = environment.isElectron && environment.isMacOs;
-  const isWindowsDesktop = environment.isElectron && environment.isWindows;
+  const isMacosDesktop = BUILD_CONFIG.isElectron && environment.isMacOs;
+  const isWindowsDesktop = BUILD_CONFIG.isElectron && environment.isWindows;
 
   if (!questions) {
     return null;

diff --git a/packages/frontend/component/src/components/theme-provider/index.tsx b/packages/frontend/component/src/components/theme-provider/index.tsx
@@ -10,7 +10,7 @@ const DesktopThemeSync = memo(function DesktopThemeSync() {
   const lastThemeRef = useRef(theme);
   const onceRef = useRef(false);
   if (lastThemeRef.current !== theme || !onceRef.current) {
-    if (environment.isElectron && theme) {
+    if (BUILD_CONFIG.isElectron && theme) {
       apis?.ui
         .handleThemeChange(theme as 'dark' | 'light' | 'system')
         .catch(err => {

diff --git a/packages/frontend/component/src/ui/menu/index.ts b/packages/frontend/component/src/ui/menu/index.ts
@@ -9,12 +9,14 @@ import { MobileMenu } from './mobile/root';
 import { MobileMenuSeparator } from './mobile/separator';
 import { MobileMenuSub } from './mobile/sub';
 
-const MenuItem = environment.isMobileEdition ? MobileMenuItem : DesktopMenuItem;
-const MenuSeparator = environment.isMobileEdition
+const MenuItem = BUILD_CONFIG.isMobileEdition
+  ? MobileMenuItem
+  : DesktopMenuItem;
+const MenuSeparator = BUILD_CONFIG.isMobileEdition
   ? MobileMenuSeparator
   : DesktopMenuSeparator;
-const MenuSub = environment.isMobileEdition ? MobileMenuSub : DesktopMenuSub;
-const Menu = environment.isMobileEdition ? MobileMenu : DesktopMenu;
+const MenuSub = BUILD_CONFIG.isMobileEdition ? MobileMenuSub : DesktopMenuSub;
+const Menu = BUILD_CONFIG.isMobileEdition ? MobileMenu : DesktopMenu;
 
 export {
   DesktopMenu,

diff --git a/packages/frontend/component/src/ui/menu/use-menu-item.tsx b/packages/frontend/component/src/ui/menu/use-menu-item.tsx
@@ -26,7 +26,7 @@ export const useMenuItem = <T extends MenuItemProps>({
       checked,
       selected,
       block,
-      [mobileMenuItem]: environment.isMobileEdition,
+      [mobileMenuItem]: BUILD_CONFIG.isMobileEdition,
     },
     propsClassName
   );

diff --git a/packages/frontend/component/src/ui/modal/modal.tsx b/packages/frontend/component/src/ui/modal/modal.tsx
@@ -149,7 +149,7 @@ export const ModalInner = forwardRef<HTMLDivElement, ModalProps>(
       children,
       contentWrapperClassName,
       contentWrapperStyle,
-      animation = environment.isMobileEdition ? 'slideBottom' : 'fadeScaleTop',
+      animation = BUILD_CONFIG.isMobileEdition ? 'slideBottom' : 'fadeScaleTop',
       fullScreen,
       ...otherProps
     } = props;
@@ -208,15 +208,15 @@ export const ModalInner = forwardRef<HTMLDivElement, ModalProps>(
               `anim-${animation}`,
               styles.modalOverlay,
               overlayClassName,
-              { mobile: environment.isMobileEdition }
+              { mobile: BUILD_CONFIG.isMobileEdition }
             )}
             style={{
               ...overlayStyle,
             }}
             {...otherOverlayOptions}
           >
             <SafeArea
-              bottom={environment.isMobileEdition}
+              bottom={BUILD_CONFIG.isMobileEdition}
               bottomOffset={12}
               data-full-screen={fullScreen}
               data-modal={modal}

diff --git a/packages/frontend/component/src/ui/safe-area/index.tsx b/packages/frontend/component/src/ui/safe-area/index.tsx
@@ -30,7 +30,7 @@ export const SafeArea = forwardRef<HTMLDivElement, SafeAreaProps>(
       <div
         ref={ref}
         className={clsx(safeArea, className)}
-        data-standalone={environment.isStandalone ? '' : undefined}
+        data-standalone={environment.isPwa ? '' : undefined}
         data-bottom={bottom ? '' : undefined}
         data-top={top ? '' : undefined}
         style={{

diff --git a/packages/frontend/core/src/commands/affine-creation.tsx b/packages/frontend/core/src/commands/affine-creation.tsx
@@ -23,7 +23,7 @@ export function registerAffineCreationCommands({
       category: 'affine:creation',
       label: t['com.affine.cmdk.affine.new-page'](),
       icon: <PlusIcon />,
-      keyBinding: environment.isElectron
+      keyBinding: BUILD_CONFIG.isElectron
         ? {
             binding: '$mod+N',
             skipRegister: true,
@@ -73,7 +73,7 @@ export function registerAffineCreationCommands({
       icon: <ImportIcon />,
       label: t['com.affine.cmdk.affine.import-workspace'](),
       preconditionStrategy: () => {
-        return environment.isElectron;
+        return BUILD_CONFIG.isElectron;
       },
       run() {
         track.$.cmdk.workspace.createWorkspace({

diff --git a/packages/frontend/core/src/commands/affine-settings.tsx b/packages/frontend/core/src/commands/affine-settings.tsx
@@ -183,7 +183,7 @@ export function registerAffineSettingsCommands({
         `,
       category: 'affine:settings',
       icon: <SettingsIcon />,
-      preconditionStrategy: () => environment.isElectron,
+      preconditionStrategy: () => BUILD_CONFIG.isElectron,
       run() {
         track.$.cmdk.settings.changeAppSetting({
           key: 'clientBorder',
@@ -231,7 +231,7 @@ export function registerAffineSettingsCommands({
         ]()}`,
       category: 'affine:settings',
       icon: <SettingsIcon />,
-      preconditionStrategy: () => environment.isElectron,
+      preconditionStrategy: () => BUILD_CONFIG.isElectron,
       run() {
         track.$.cmdk.settings.changeAppSetting({
           key: 'enableNoisyBackground',
@@ -257,7 +257,8 @@ export function registerAffineSettingsCommands({
         ]()}`,
       category: 'affine:settings',
       icon: <SettingsIcon />,
-      preconditionStrategy: () => environment.isElectron && environment.isMacOs,
+      preconditionStrategy: () =>
+        BUILD_CONFIG.isElectron && environment.isMacOs,
       run() {
         track.$.cmdk.settings.changeAppSetting({
           key: 'enableBlurBackground',