refactor: migrate environment to BUILD_CONFIG (#8206)

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';
 

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,17 +62,9 @@ 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,
@@ -82,17 +72,13 @@ export function setupGlobal() {
       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,

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

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()})`
     : '';
 

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 = {