fix(server): use new LocalWorkspace ServerFeature instead (#13091)

keep compatibility

close AF-2720



#### PR Dependency Tree


* **PR #13091** 👈

This tree was auto-generated by
[Charcoal](https://github.com/danerwilliams/charcoal)

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

## Summary by CodeRabbit

* **New Features**
* Added a new `LocalWorkspace` feature flag to server configuration,
enabling more flexible feature management.

* **Deprecations**
* The `allowGuestDemoWorkspace` flag is now deprecated and will be
removed in version 0.25.0. Please use the `features` array for feature
checks instead.

* **Bug Fixes**
* Updated UI and logic throughout the app to rely on the new
`LocalWorkspace` feature flag rather than the deprecated boolean flag.

* **Chores**
* Removed references to `allowGuestDemoWorkspace` from configuration,
queries, and type definitions for improved consistency.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->


#### PR Dependency Tree


* **PR #13091** 👈

This tree was auto-generated by
[Charcoal](https://github.com/danerwilliams/charcoal)

packages/backend/server/src/__tests__/e2e/config/resolver.spec.ts

@@ -21,3 +21,13 @@ e2e('should comment feature enabled by default', async t => {
     JSON.stringify(serverConfig, null, 2)
   );
 });
+
+e2e('should enable local workspace feature by default', async t => {
+  const { serverConfig } = await app.gql({ query: serverConfigQuery });
+
+  t.is(
+    serverConfig.features.includes(ServerFeature.LocalWorkspace),
+    true,
+    JSON.stringify(serverConfig, null, 2)
+  );
+});

packages/backend/server/src/core/config/resolver.ts

@@ -85,6 +85,7 @@ export class ServerConfigResolver {
       baseUrl: this.url.requestBaseUrl,
       type: env.DEPLOYMENT_TYPE,
       features: this.server.features,
+      // TODO(@fengmk2): remove this field after the feature 0.25.0 is released
       allowGuestDemoWorkspace: this.config.flags.allowGuestDemoWorkspace,
     };
   }

packages/backend/server/src/core/config/service.ts

@@ -110,6 +110,13 @@ export class ServerService implements OnApplicationBootstrap {
     this.event.emit('config.changed', event);
   }
 
+  @OnEvent('config.changed')
+  onConfigChanged(event: Events['config.changed']) {
+    if ('flags' in event.updates) {
+      this.onFlagsChanged();
+    }
+  }
+
   async revalidateConfig() {
     const overrides = await this.loadDbOverrides();
     this.configFactory.override(overrides);
@@ -122,6 +129,7 @@ export class ServerService implements OnApplicationBootstrap {
     await this.event.emitAsync('config.init', {
       config: this.configFactory.config,
     });
+    this.onFlagsChanged();
   }
 
   private async loadDbOverrides() {
@@ -134,4 +142,13 @@ export class ServerService implements OnApplicationBootstrap {
 
     return overrides;
   }
+
+  private onFlagsChanged() {
+    const flags = this.configFactory.config.flags;
+    if (flags.allowGuestDemoWorkspace) {
+      this.enableFeature(ServerFeature.LocalWorkspace);
+    } else {
+      this.disableFeature(ServerFeature.LocalWorkspace);
+    }
+  }
 }

packages/backend/server/src/core/config/types.ts

@@ -10,6 +10,7 @@ export enum ServerFeature {
   OAuth = 'oauth',
   Indexer = 'indexer',
   Comment = 'comment',
+  LocalWorkspace = 'local_workspace',
 }
 
 registerEnumType(ServerFeature, {
@@ -42,6 +43,8 @@ export class ServerConfigType {
 
   @Field(() => Boolean, {
     description: 'Whether allow guest users to create demo workspaces.',
+    deprecationReason:
+      'This field is deprecated, please use `features` instead. Will be removed in 0.25.0',
   })
   allowGuestDemoWorkspace!: boolean;
 }

packages/backend/server/src/schema.gql

@@ -1760,7 +1760,7 @@ enum SearchTable {
 
 type ServerConfigType {
   """Whether allow guest users to create demo workspaces."""
-  allowGuestDemoWorkspace: Boolean!
+  allowGuestDemoWorkspace: Boolean! @deprecated(reason: "This field is deprecated, please use `features` instead. Will be removed in 0.25.0")
 
   """fetch latest available upgradable release of server"""
   availableUpgrade: ReleaseVersionType
@@ -1802,6 +1802,7 @@ enum ServerFeature {
   Copilot
   CopilotEmbedding
   Indexer
+  LocalWorkspace
   OAuth
   Payment
 }

packages/common/graphql/src/graphql/admin/admin-server-config.gql

@@ -7,7 +7,6 @@ query adminServerConfig {
     baseUrl
     name
     features
-    allowGuestDemoWorkspace
     type
     initialized
     credentialsRequirement {

packages/common/graphql/src/graphql/index.ts

@@ -79,7 +79,6 @@ export const adminServerConfigQuery = {
     baseUrl
     name
     features
-    allowGuestDemoWorkspace
     type
     initialized
     credentialsRequirement {
@@ -2090,7 +2089,6 @@ export const serverConfigQuery = {
     baseUrl
     name
     features
-    allowGuestDemoWorkspace
     type
     initialized
     credentialsRequirement {

packages/common/graphql/src/graphql/server-config.gql

@@ -7,7 +7,6 @@ query serverConfig {
     baseUrl
     name
     features
-    allowGuestDemoWorkspace
     type
     initialized
     credentialsRequirement {

packages/common/graphql/src/schema.ts

@@ -2349,7 +2349,10 @@ export enum SearchTable {
 
 export interface ServerConfigType {
   __typename?: 'ServerConfigType';
-  /** Whether allow guest users to create demo workspaces. */
+  /**
+   * Whether allow guest users to create demo workspaces.
+   * @deprecated This field is deprecated, please use `features` instead. Will be removed in 0.25.0
+   */
   allowGuestDemoWorkspace: Scalars['Boolean']['output'];
   /** fetch latest available upgradable release of server */
   availableUpgrade: Maybe<ReleaseVersionType>;
@@ -2383,6 +2386,7 @@ export enum ServerFeature {
   Copilot = 'Copilot',
   CopilotEmbedding = 'CopilotEmbedding',
   Indexer = 'Indexer',
+  LocalWorkspace = 'LocalWorkspace',
   OAuth = 'OAuth',
   Payment = 'Payment',
 }
@@ -2964,7 +2968,6 @@ export type AdminServerConfigQuery = {
     baseUrl: string;
     name: string;
     features: Array<ServerFeature>;
-    allowGuestDemoWorkspace: boolean;
     type: ServerDeploymentType;
     initialized: boolean;
     availableUserFeatures: Array<FeatureType>;
@@ -5736,7 +5739,6 @@ export type ServerConfigQuery = {
     baseUrl: string;
     name: string;
     features: Array<ServerFeature>;
-    allowGuestDemoWorkspace: boolean;
     type: ServerDeploymentType;
     initialized: boolean;
     credentialsRequirement: {

packages/frontend/core/src/components/hooks/affine/__tests__/use-sign-out.spec.ts

@@ -2,6 +2,7 @@
 /**
  * @vitest-environment happy-dom
  */
+import { ServerFeature } from '@affine/graphql';
 import { renderHook, waitFor } from '@testing-library/react';
 import { beforeEach, describe, expect, test, vi } from 'vitest';
 
@@ -24,8 +25,10 @@ vi.mock('@toeverything/infra', () => {
         server: {
           config$: {
             value: {
-              get allowGuestDemoWorkspace() {
+              get features() {
-                return allowGuestDemo;
+                return allowGuestDemo !== false
+                  ? [ServerFeature.LocalWorkspace]
+                  : [];
               },
             },
           },

packages/frontend/core/src/components/hooks/affine/use-sign-out.ts

@@ -5,6 +5,7 @@ import {
 } from '@affine/component';
 import { AuthService, DefaultServerService } from '@affine/core/modules/cloud';
 import { UserFriendlyError } from '@affine/error';
+import { ServerFeature } from '@affine/graphql';
 import { useI18n } from '@affine/i18n';
 import { useService, useServices } from '@toeverything/infra';
 import { useCallback } from 'react';
@@ -32,12 +33,15 @@ export const useSignOut = ({
 
   const signOut = useCallback(async () => {
     onConfirm?.()?.catch(console.error);
+    const enableLocalWorkspace =
+      BUILD_CONFIG.isNative ||
+      defaultServerService.server.config$.value.features.includes(
+        ServerFeature.LocalWorkspace
+      );
+
     try {
       await authService.signOut();
-      if (
+      if (enableLocalWorkspace) {
-        defaultServerService.server.config$.value.allowGuestDemoWorkspace !==
-        false
-      ) {
         jumpToIndex();
       } else {
         jumpToSignIn();

packages/frontend/core/src/components/workspace-selector/user-with-workspace-list/add-workspace/index.tsx

@@ -1,5 +1,6 @@
 import { MenuItem } from '@affine/component/ui/menu';
 import { DefaultServerService } from '@affine/core/modules/cloud';
+import { ServerFeature } from '@affine/graphql';
 import { useI18n } from '@affine/i18n';
 import { ImportIcon, PlusIcon } from '@blocksuite/icons/rc';
 import { useLiveData, useService } from '@toeverything/infra';
@@ -15,10 +16,13 @@ export const AddWorkspace = ({
 }) => {
   const t = useI18n();
   const defaultServerService = useService(DefaultServerService);
-  const allowGuestDemo = useLiveData(
+  const enableLocalWorkspace = useLiveData(
-    defaultServerService.server.config$.selector(c => c.allowGuestDemoWorkspace)
+    defaultServerService.server.config$.selector(
+      c =>
+        c.features.includes(ServerFeature.LocalWorkspace) ||
+        BUILD_CONFIG.isNative
+    )
   );
-  const guestDemoEnabled = allowGuestDemo !== false;
 
   return (
     <>
@@ -45,7 +49,7 @@ export const AddWorkspace = ({
         className={styles.ItemContainer}
       >
         <div className={styles.ItemText}>
-          {guestDemoEnabled
+          {enableLocalWorkspace
             ? t['com.affine.workspaceList.addWorkspace.create']()
             : t['com.affine.workspaceList.addWorkspace.create-cloud']()}
         </div>

packages/frontend/core/src/components/workspace-selector/user-with-workspace-list/index.tsx

@@ -3,6 +3,7 @@ import { MenuItem } from '@affine/component/ui/menu';
 import { AuthService, DefaultServerService } from '@affine/core/modules/cloud';
 import { GlobalDialogService } from '@affine/core/modules/dialogs';
 import { type WorkspaceMetadata } from '@affine/core/modules/workspace';
+import { ServerFeature } from '@affine/graphql';
 import { useI18n } from '@affine/i18n';
 import { track } from '@affine/track';
 import { Logo1Icon } from '@blocksuite/icons/rc';
@@ -74,11 +75,12 @@ export const UserWithWorkspaceList = ({
   }, [globalDialogService]);
 
   const onNewWorkspace = useCallback(() => {
-    if (
+    const enableLocalWorkspace =
-      !isAuthenticated &&
+      BUILD_CONFIG.isNative ||
-      defaultServerService.server.config$.value.allowGuestDemoWorkspace ===
+      defaultServerService.server.config$.value.features.includes(
-        false
+        ServerFeature.LocalWorkspace
-    ) {
+      );
+    if (!isAuthenticated && !enableLocalWorkspace) {
       return openSignInModal();
     }
     track.$.navigationPanel.workspaceList.createWorkspace();

packages/frontend/core/src/desktop/pages/index/index.tsx

@@ -5,6 +5,7 @@ import {
   buildShowcaseWorkspace,
   createFirstAppData,
 } from '@affine/core/utils/first-app-data';
+import { ServerFeature } from '@affine/graphql';
 import {
   useLiveData,
   useService,
@@ -52,10 +53,12 @@ export const Component = ({
   const loggedIn = useLiveData(
     authService.session.status$.map(s => s === 'authenticated')
   );
-  const allowGuestDemo =
+  const enableLocalWorkspace =
     useLiveData(
       defaultServerService.server.config$.selector(
-        c => c.allowGuestDemoWorkspace
+        c =>
+          c.features.includes(ServerFeature.LocalWorkspace) ||
+          BUILD_CONFIG.isNative
       )
     ) ?? true;
 
@@ -92,7 +95,7 @@ export const Component = ({
       return;
     }
 
-    if (!allowGuestDemo && !loggedIn) {
+    if (!enableLocalWorkspace && !loggedIn) {
       localStorage.removeItem('last_workspace_id');
       jumpToSignIn();
       return;
@@ -125,7 +128,7 @@ export const Component = ({
       openPage(openWorkspace.id, defaultIndexRoute, RouteLogic.REPLACE);
     }
   }, [
-    allowGuestDemo,
+    enableLocalWorkspace,
     createCloudWorkspace,
     list,
     openPage,

packages/frontend/core/src/modules/cloud/constant.ts

@@ -17,7 +17,7 @@ export const BUILD_IN_SERVERS: (ServerMetadata & { config: ServerConfig })[] =
           // since we never build desktop app in selfhosted mode, so it's fine
           config: {
             serverName: 'Affine Selfhost',
-            features: [],
+            features: [ServerFeature.LocalWorkspace],
             oauthProviders: [],
             type: ServerDeploymentType.Selfhosted,
             credentialsRequirement: {
@@ -26,7 +26,6 @@ export const BUILD_IN_SERVERS: (ServerMetadata & { config: ServerConfig })[] =
                 maxLength: 32,
               },
             },
-            allowGuestDemoWorkspace: true,
           },
         },
       ]
@@ -45,6 +44,7 @@ export const BUILD_IN_SERVERS: (ServerMetadata & { config: ServerConfig })[] =
                 ServerFeature.CopilotEmbedding,
                 ServerFeature.OAuth,
                 ServerFeature.Payment,
+                ServerFeature.LocalWorkspace,
               ],
               oauthProviders: [
                 OAuthProviderType.Google,
@@ -57,7 +57,6 @@ export const BUILD_IN_SERVERS: (ServerMetadata & { config: ServerConfig })[] =
                   maxLength: 32,
                 },
               },
-              allowGuestDemoWorkspace: true,
             },
           },
         ]
@@ -78,6 +77,7 @@ export const BUILD_IN_SERVERS: (ServerMetadata & { config: ServerConfig })[] =
                   ServerFeature.CopilotEmbedding,
                   ServerFeature.OAuth,
                   ServerFeature.Payment,
+                  ServerFeature.LocalWorkspace,
                 ],
                 oauthProviders: [
                   OAuthProviderType.Google,
@@ -90,7 +90,6 @@ export const BUILD_IN_SERVERS: (ServerMetadata & { config: ServerConfig })[] =
                     maxLength: 32,
                   },
                 },
-                allowGuestDemoWorkspace: true,
               },
             },
           ]
@@ -111,6 +110,7 @@ export const BUILD_IN_SERVERS: (ServerMetadata & { config: ServerConfig })[] =
                     ServerFeature.CopilotEmbedding,
                     ServerFeature.OAuth,
                     ServerFeature.Payment,
+                    ServerFeature.LocalWorkspace,
                   ],
                   oauthProviders: [
                     OAuthProviderType.Google,
@@ -123,7 +123,6 @@ export const BUILD_IN_SERVERS: (ServerMetadata & { config: ServerConfig })[] =
                       maxLength: 32,
                     },
                   },
-                  allowGuestDemoWorkspace: true,
                 },
               },
             ]
@@ -140,6 +139,7 @@ export const BUILD_IN_SERVERS: (ServerMetadata & { config: ServerConfig })[] =
                       ServerFeature.CopilotEmbedding,
                       ServerFeature.OAuth,
                       ServerFeature.Payment,
+                      ServerFeature.LocalWorkspace,
                     ],
                     oauthProviders: [
                       OAuthProviderType.Google,
@@ -152,7 +152,6 @@ export const BUILD_IN_SERVERS: (ServerMetadata & { config: ServerConfig })[] =
                         maxLength: 32,
                       },
                     },
-                    allowGuestDemoWorkspace: true,
                   },
                 },
               ]
@@ -171,6 +170,7 @@ export const BUILD_IN_SERVERS: (ServerMetadata & { config: ServerConfig })[] =
                         ServerFeature.CopilotEmbedding,
                         ServerFeature.OAuth,
                         ServerFeature.Payment,
+                        ServerFeature.LocalWorkspace,
                       ],
                       oauthProviders: [
                         OAuthProviderType.Google,
@@ -183,7 +183,6 @@ export const BUILD_IN_SERVERS: (ServerMetadata & { config: ServerConfig })[] =
                           maxLength: 32,
                         },
                       },
-                      allowGuestDemoWorkspace: true,
                     },
                   },
                 ]

packages/frontend/core/src/modules/cloud/entities/server.ts

@@ -82,7 +82,6 @@ export class Server extends Entity<{
             credentialsRequirement: config.credentialsRequirement,
             features: config.features,
             oauthProviders: config.oauthProviders,
-            allowGuestDemoWorkspace: config.allowGuestDemoWorkspace,
             serverName: config.name,
             type: config.type,
             version: config.version,

packages/frontend/core/src/modules/cloud/services/servers.ts

@@ -82,7 +82,6 @@ export class ServersService extends Service {
         credentialsRequirement: config.credentialsRequirement,
         features: config.features,
         oauthProviders: config.oauthProviders,
-        allowGuestDemoWorkspace: config.allowGuestDemoWorkspace,
         serverName: config.name,
         type: config.type,
         initialized: config.initialized,

packages/frontend/core/src/modules/cloud/types.ts

@@ -14,7 +14,6 @@ export interface ServerMetadata {
 export interface ServerConfig {
   serverName: string;
   features: ServerFeature[];
-  allowGuestDemoWorkspace: boolean;
   oauthProviders: OAuthProviderType[];
   type: ServerDeploymentType;
   initialized?: boolean;