feat(core): guard service (#9816)

toeverything · Feb 9, 2025 · 92f4f0c · 92f4f0c
1 parent 879157b
commit 92f4f0c
Show file tree

Hide file tree

Showing 89 changed files with 1,519 additions and 521 deletions.
diff --git a/packages/backend/server/src/core/permission/index.ts b/packages/backend/server/src/core/permission/index.ts
@@ -11,13 +11,13 @@ export class PermissionModule {}
 export { PermissionService } from './service';
 export {
   DOC_ACTIONS,
-  type DocActionPermissions,
+  type DocAction,
   DocRole,
   fixupDocRole,
   mapDocRoleToPermissions,
   mapWorkspaceRoleToPermissions,
   PublicDocMode,
   WORKSPACE_ACTIONS,
-  type WorkspaceActionPermissions,
+  type WorkspaceAction,
   WorkspaceRole,
 } from './types';
diff --git a/packages/backend/server/src/core/permission/types.ts b/packages/backend/server/src/core/permission/types.ts
@@ -146,12 +146,6 @@ type ResourceActionName<T extends keyof typeof Actions> =
 export type WorkspaceAction = ResourceActionName<'Workspace'>;
 export type DocAction = ResourceActionName<'Doc'>;
 export type Action = WorkspaceAction | DocAction;
-export type WorkspaceActionPermissions = {
-  [key in WorkspaceAction]: boolean;
-};
-export type DocActionPermissions = {
-  [key in DocAction]: boolean;
-};
 
 const cache = new WeakMap<object, any>();
 const buildPathReader = (

diff --git a/packages/backend/server/src/core/workspaces/resolvers/doc.ts b/packages/backend/server/src/core/workspaces/resolvers/doc.ts
@@ -31,7 +31,7 @@ import { Models } from '../../../models';
 import { CurrentUser } from '../../auth';
 import {
   DOC_ACTIONS,
-  type DocActionPermissions,
+  DocAction,
   DocRole,
   fixupDocRole,
   mapDocRoleToPermissions,
@@ -41,6 +41,7 @@ import {
 import { PublicUserType } from '../../user';
 import { DocID } from '../../utils/doc';
 import { WorkspaceType } from '../types';
+import { DotToUnderline, mapPermissionToGraphqlPermissions } from './workspace';
 
 registerEnumType(PublicDocMode, {
   name: 'PublicDocMode',
@@ -128,10 +129,12 @@ class GrantedDocUserType {
 @ObjectType()
 class PaginatedGrantedDocUserType extends Paginated(GrantedDocUserType) {}
 
-const DocPermissions = registerObjectType<DocActionPermissions>(
+const DocPermissions = registerObjectType<
+  Record<DotToUnderline<DocAction>, boolean>
+>(
   Object.fromEntries(
     DOC_ACTIONS.map(action => [
-      action,
+      action.replaceAll('.', '_'),
       {
         type: () => Boolean,
         options: {
@@ -143,15 +146,6 @@ const DocPermissions = registerObjectType<DocActionPermissions>(
   { name: 'DocPermissions' }
 );
 
-@ObjectType()
-export class DocRolePermissions {
-  @Field(() => DocRole)
-  role!: DocRole;
-
-  @Field(() => DocPermissions)
-  permissions!: DocActionPermissions;
-}
-
 @Resolver(() => WorkspaceType)
 export class WorkspaceDocResolver {
   private readonly logger = new Logger(WorkspaceDocResolver.name);
@@ -365,7 +359,7 @@ export class DocResolver {
   async permissions(
     @CurrentUser() user: CurrentUser,
     @Parent() doc: DocType
-  ): Promise<DocRolePermissions> {
+  ): Promise<InstanceType<typeof DocPermissions>> {
     const [permission, workspacePermission] = await this.prisma.$transaction(
       tx =>
         Promise.all([
@@ -385,12 +379,11 @@ export class DocResolver {
         ])
     );
 
-    return {
-      role: permission?.type ?? DocRole.External,
-      permissions: mapDocRoleToPermissions(
+    return mapPermissionToGraphqlPermissions(
+      mapDocRoleToPermissions(
         fixupDocRole(workspacePermission?.type, permission?.type)
-      ),
-    };
+      )
+    );
   }
 
   @ResolveField(() => PaginatedGrantedDocUserType, {

diff --git a/packages/backend/server/src/core/workspaces/resolvers/workspace.ts b/packages/backend/server/src/core/workspaces/resolvers/workspace.ts
@@ -38,7 +38,7 @@ import {
   mapWorkspaceRoleToPermissions,
   PermissionService,
   WORKSPACE_ACTIONS,
-  type WorkspaceActionPermissions,
+  WorkspaceAction,
   WorkspaceRole,
 } from '../../permission';
 import { QuotaService, WorkspaceQuotaType } from '../../quota';
@@ -51,6 +51,22 @@ import {
 } from '../types';
 import { WorkspaceService } from './service';
 
+export type DotToUnderline<T extends string> =
+  T extends `${infer Prefix}.${infer Suffix}`
+    ? `${Prefix}_${DotToUnderline<Suffix>}`
+    : T;
+
+export function mapPermissionToGraphqlPermissions<A extends string>(
+  permission: Record<A, boolean>
+): Record<DotToUnderline<A>, boolean> {
+  return Object.fromEntries(
+    Object.entries(permission).map(([key, value]) => [
+      key.replaceAll('.', '_'),
+      value,
+    ])
+  ) as Record<DotToUnderline<A>, boolean>;
+}
+
 @ObjectType()
 export class EditorType implements Partial<Editor> {
   @Field()
@@ -75,10 +91,12 @@ class WorkspacePageMeta {
   updatedBy!: EditorType | null;
 }
 
-const WorkspacePermissions = registerObjectType<WorkspaceActionPermissions>(
+const WorkspacePermissions = registerObjectType<
+  Record<DotToUnderline<WorkspaceAction>, boolean>
+>(
   Object.fromEntries(
     WORKSPACE_ACTIONS.map(action => [
-      action,
+      action.replaceAll('.', '_'),
       {
         type: () => Boolean,
         options: {
@@ -96,7 +114,7 @@ export class WorkspaceRolePermissions {
   role!: WorkspaceRole;
 
   @Field(() => WorkspacePermissions)
-  permissions!: WorkspaceActionPermissions;
+  permissions!: Record<DotToUnderline<WorkspaceAction>, boolean>;
 }
 
 /**
@@ -342,7 +360,7 @@ export class WorkspaceResolver {
   async workspaceRolePermissions(
     @CurrentUser() user: CurrentUser,
     @Args('id') id: string
-  ) {
+  ): Promise<WorkspaceRolePermissions> {
     const workspace = await this.prisma.workspaceUserPermission.findFirst({
       where: { workspaceId: id, userId: user.id },
     });
@@ -351,7 +369,9 @@ export class WorkspaceResolver {
     }
     return {
       role: workspace.type,
-      permissions: mapWorkspaceRoleToPermissions(workspace.type),
+      permissions: mapPermissionToGraphqlPermissions(
+        mapWorkspaceRoleToPermissions(workspace.type)
+      ),
     };
   }
 

diff --git a/packages/frontend/component/src/theme/global.css b/packages/frontend/component/src/theme/global.css
@@ -134,7 +134,7 @@ summary {
 }
 
 a,
-button {
+button:not([disabled]) {
   cursor: pointer;
 }
 

diff --git a/packages/frontend/component/src/ui/button/button.css.ts b/packages/frontend/component/src/ui/button/button.css.ts
@@ -39,7 +39,6 @@ export const button = style({
   outline: 0,
   borderRadius: 8,
   transition: 'all .3s',
-  cursor: 'pointer',
   ['WebkitAppRegion' as string]: 'no-drag',
 
   // hover layer
@@ -169,6 +168,10 @@ export const button = style({
       opacity: 0.5,
     },
 
+    '&:not([data-disabled])': {
+      cursor: 'pointer',
+    },
+
     // default keyboard focus style
     '&:focus-visible::after': {
       content: '""',

diff --git a/packages/frontend/component/src/ui/dnd/drop-target.ts b/packages/frontend/component/src/ui/dnd/drop-target.ts
@@ -316,7 +316,11 @@ export const useDropTarget = <D extends DNDData = DNDData>(
 
         // external data is only available in drop event thus
         // this is the only case for getAdaptedEventArgs
-        const args = getAdaptedEventArgs(_args, options.fromExternalData, true);
+        const args = {
+          ...getAdaptedEventArgs(_args, options.fromExternalData, true),
+          treeInstruction: extractInstruction(_args.self.data),
+          closestEdge: extractClosestEdge(_args.self.data),
+        };
         if (
           isExternalDrag(_args) &&
           options.fromExternalData &&
@@ -329,11 +333,7 @@ export const useDropTarget = <D extends DNDData = DNDData>(
         }
 
         if (args.location.current.dropTargets[0]?.element === element) {
-          options.onDrop?.({
-            ...args,
-            treeInstruction: extractInstruction(args.self.data),
-            closestEdge: extractClosestEdge(args.self.data),
-          } as DropTargetDropEvent<D>);
+          options.onDrop?.(args as DropTargetDropEvent<D>);
         }
       },
       getData: (args: DropTargetGetFeedback<D>) => {

diff --git a/packages/frontend/component/src/ui/menu/styles.css.ts b/packages/frontend/component/src/ui/menu/styles.css.ts
@@ -51,7 +51,7 @@ export const menuItem = style({
     '&.block': {
       maxWidth: '100%',
     },
-    '&[data-disabled]': {
+    '&[data-disabled], &.disabled': {
       vars: {
         [iconColor]: cssVarV2('icon/disable'),
         [labelColor]: cssVarV2('text/secondary'),

diff --git a/packages/frontend/component/src/ui/menu/use-menu-item.tsx b/packages/frontend/component/src/ui/menu/use-menu-item.tsx
@@ -16,13 +16,15 @@ export const useMenuItem = <T extends MenuItemProps>({
   checked,
   selected,
   block,
+  disabled,
   ...otherProps
 }: T) => {
   const className = clsx(
     styles.menuItem,
     {
-      danger: type === 'danger',
-      warning: type === 'warning',
+      danger: disabled ? false : type === 'danger',
+      warning: disabled ? false : type === 'warning',
+      disabled,
       checked,
       selected,
       block,

diff --git a/packages/frontend/component/src/ui/property/property.css.ts b/packages/frontend/component/src/ui/property/property.css.ts
@@ -133,10 +133,12 @@ export const propertyValueContainer = style({
     '&[data-readonly="false"][data-hoverable="true"]': {
       cursor: 'pointer',
     },
-    '&[data-readonly="false"][data-hoverable="true"]:is(:hover, :focus-within)':
-      {
-        backgroundColor: cssVarV2('layer/background/hoverOverlay'),
-      },
+    '&[data-readonly="true"][data-hoverable="true"]': {
+      cursor: 'default',
+    },
+    '&[data-hoverable="true"]:is(:hover, :focus-within)': {
+      backgroundColor: cssVarV2('layer/background/hoverOverlay'),
+    },
   },
 });
 

diff --git a/packages/frontend/component/src/ui/radio/radio.tsx b/packages/frontend/component/src/ui/radio/radio.tsx
@@ -83,6 +83,7 @@ export const RadioGroup = memo(function RadioGroup({
   indicatorStyle,
   iconMode,
   onChange,
+  disabled,
 }: RadioProps) {
   const animationTImerRef = useRef<ReturnType<typeof setTimeout> | null>(null);
   const finalItems = useMemo(() => {
@@ -158,6 +159,7 @@ export const RadioGroup = memo(function RadioGroup({
       className={clsx(styles.radioButtonGroup, className)}
       style={finalStyle}
       data-icon-mode={iconMode}
+      disabled={disabled}
     >
       {finalItems.map(({ customRender, ...item }, index) => {
         const testId = item.testId ? { 'data-testid': item.testId } : {};
@@ -179,6 +181,7 @@ export const RadioGroup = memo(function RadioGroup({
             style={style}
             {...testId}
             {...item.attrs}
+            disabled={disabled}
           >
             <RadixRadioGroup.Indicator
               forceMount

diff --git a/packages/frontend/component/src/ui/radio/styles.css.ts b/packages/frontend/component/src/ui/radio/styles.css.ts
@@ -25,7 +25,7 @@ export const radioButton = style({
     '&[data-state="checked"]': {
       color: cssVarV2('switch/fontColor/primary'),
     },
-    '&[data-state="unchecked"]:hover': {
+    '&[data-state="unchecked"]:hover:not([disabled])': {
       background: cssVarV2('switch/buttonBackground/hover'),
     },
     '[data-icon-mode=true] &': {

diff --git a/packages/frontend/core/src/blocksuite/presets/ai/_common/chat-actions-handle.ts b/packages/frontend/core/src/blocksuite/presets/ai/_common/chat-actions-handle.ts
@@ -199,6 +199,9 @@ const REPLACE_SELECTION = {
   icon: ReplaceIcon,
   title: 'Replace selection',
   showWhen: (host: EditorHost) => {
+    if (host.std.store.readonly$.value) {
+      return false;
+    }
     const textSelection = host.selection.find(TextSelection);
     const blockSelections = host.selection.filter(BlockSelection);
     if (
@@ -252,7 +255,12 @@ const REPLACE_SELECTION = {
 const INSERT_BELOW = {
   icon: InsertBelowIcon,
   title: 'Insert below',
-  showWhen: () => true,
+  showWhen: (host: EditorHost) => {
+    if (host.std.store.readonly$.value) {
+      return false;
+    }
+    return true;
+  },
   toast: 'Successfully inserted',
   handler: async (
     host: EditorHost,
@@ -282,7 +290,12 @@ const SAVE_CHAT_TO_BLOCK_ACTION: ChatAction = {
   icon: BlockIcon,
   title: 'Save chat to block',
   toast: 'Successfully saved chat to a block',
-  showWhen: () => true,
+  showWhen: (host: EditorHost) => {
+    if (host.std.store.readonly$.value) {
+      return false;
+    }
+    return true;
+  },
   handler: async (
     host: EditorHost,
     _,
@@ -378,7 +391,12 @@ const SAVE_CHAT_TO_BLOCK_ACTION: ChatAction = {
 const ADD_TO_EDGELESS_AS_NOTE = {
   icon: CreateIcon,
   title: 'Add to edgeless as note',
-  showWhen: () => true,
+  showWhen: (host: EditorHost) => {
+    if (host.std.store.readonly$.value) {
+      return false;
+    }
+    return true;
+  },
   toast: 'New note created',
   handler: async (host: EditorHost, content: string) => {
     reportResponse('result:add-note');
@@ -451,7 +469,12 @@ const CREATE_AS_DOC = {
 const CREATE_AS_LINKED_DOC = {
   icon: CreateIcon,
   title: 'Create as a linked doc',
-  showWhen: () => true,
+  showWhen: (host: EditorHost) => {
+    if (host.std.store.readonly$.value) {
+      return false;
+    }
+    return true;
+  },
   toast: 'New doc created',
   handler: async (host: EditorHost, content: string) => {
     reportResponse('result:add-page');
-Original file line number
+Diff line change
@@ Expand Up / @@ -134,7 +134,7 @@ summary { @@
     }
     a,
-    button {
+    button:not([disabled]) {
       cursor: pointer;
     }
@@ Expand Down @@