Supported hidden (deleted) properties for rewards and proposals (#5168)

mattcasey · web-flow · commit 8151543d6bfe · 2025-02-04T08:48:43.000-07:00
* hide deleted properties

* update

* disable editing deleted fields

* fix tests

* update delete modal

* allow undeleting

* fix tests
diff --git a/components/common/DatabaseEditor/components/cardDetail/cardDetailProperties.tsx b/components/common/DatabaseEditor/components/cardDetail/cardDetailProperties.tsx
@@ -39,6 +39,7 @@ type Props = {
   disableEditPropertyOption?: boolean;
   boardType?: 'proposals' | 'rewards';
   showCard?: (cardId: string | null) => void;
+  isTemplate?: boolean; // whether or not to always hide deleted properties
 };
 
 function CardDetailProperties(props: Props) {
@@ -52,7 +53,8 @@ function CardDetailProperties(props: Props) {
     pageUpdatedBy,
     syncWithPageId,
     mutator = defaultMutator,
-    disableEditPropertyOption
+    disableEditPropertyOption,
+    isTemplate
   } = props;
 
   const [newTemplateId, setNewTemplateId] = useState('');
@@ -196,14 +198,10 @@ function CardDetailProperties(props: Props) {
         id: 'CardDetailProperty.confirm-delete-heading',
         defaultMessage: 'Confirm Delete Property'
       }),
-      subText: intl.formatMessage(
-        {
-          id: 'CardDetailProperty.confirm-delete-subtext',
-          defaultMessage:
-            'Are you sure you want to delete the property "{propertyName}"? Deleting it will delete the property from all cards in this board.'
-        },
-        { propertyName: propertyTemplate.name }
-      ),
+      subText:
+        board.id === '__defaultBoard' // __defaultBoard type  sis used to capture reward and proposal properties
+          ? `Are you sure you want to delete the property "${propertyTemplate.name}"?  Deleting it will not destroy data from previous submissions.`
+          : `Are you sure you want to delete the property "${propertyTemplate.name}"? Deleting it will delete the property from all cards in this board.`,
       confirmButtonText: intl.formatMessage({
         id: 'CardDetailProperty.delete-action-button',
         defaultMessage: 'Delete'
@@ -234,6 +232,14 @@ function CardDetailProperties(props: Props) {
     setShowConfirmationDialog(true);
   }
 
+  // only used for proposal and reward boards at this time. we fully delete the properties of other boards
+  function restoreProperty(propertyTemplate: IPropertyTemplate) {
+    mutator.updateProperty(board, propertyTemplate.id, {
+      ...propertyTemplate,
+      deletedAt: undefined
+    });
+  }
+
   function getDeleteDisabled(template: IPropertyTemplate) {
     if (
       views.some((view) => view.fields.viewType === 'calendar' && view.fields.dateDisplayPropertyId === template.id)
@@ -270,11 +276,13 @@ function CardDetailProperties(props: Props) {
     [mutator, props.boardType, board, activeView, isSmallScreen]
   );
 
-  let boardProperties = board.fields.cardProperties || [];
+  let boardProperties = (board.fields.cardProperties || [])
+    // hide deleted properties unless they were deleted before the card was created and it's not a template
+    .filter((p) => !p.deletedAt || (!isTemplate && new Date(p.deletedAt) > new Date(card.createdAt)));
 
   if (board.fields.sourceType === 'proposals') {
     // remove properties that belong to a different template
-    boardProperties = board.fields?.cardProperties.filter(
+    boardProperties = boardProperties.filter(
       (property) => !property.templateId || card.fields.properties[property.id] !== undefined
     );
   }
@@ -299,6 +307,7 @@ function CardDetailProperties(props: Props) {
             showCard={props.showCard}
             deleteDisabledMessage={getDeleteDisabled(propertyTemplate)}
             onDelete={() => onPropertyDeleteSetAndOpenConfirmationDialog(propertyTemplate)}
+            onRestore={() => restoreProperty(propertyTemplate)}
             onTypeAndNameChanged={(newType: PropertyType, newName: string, relationData?: RelationPropertyData) => {
               onPropertyChangeSetAndOpenConfirmationDialog(newType, newName, propertyTemplate, relationData);
             }}
diff --git a/components/common/DatabaseEditor/components/cardProperties/CardDetailProperty.tsx b/components/common/DatabaseEditor/components/cardProperties/CardDetailProperty.tsx
@@ -40,6 +40,7 @@ export function CardDetailProperty({
   board,
   card,
   onDelete,
+  onRestore,
   pageUpdatedBy,
   pageUpdatedAt,
   deleteDisabledMessage,
@@ -56,6 +57,7 @@ export function CardDetailProperty({
   board: Board;
   onTypeAndNameChanged: (newType: PropertyType, newName: string, relationData?: RelationPropertyData) => void;
   onDelete: VoidFunction;
+  onRestore: VoidFunction;
   pageUpdatedAt: string;
   pageUpdatedBy: string;
   deleteDisabledMessage?: string;
@@ -66,7 +68,12 @@ export function CardDetailProperty({
 }) {
   const [isDragging, isOver, columnRef] = useSortable('column', property, !readOnly, onDrop);
   const changePropertyPopupState = usePopupState({ variant: 'popover', popupId: 'card-property' });
-  const propertyTooltip = property.name.length > 20 ? property.name : '';
+  const propertyTooltip = property.deletedAt
+    ? 'This property was deleted'
+    : property.name.length > 20
+      ? property.name
+      : '';
+
   return (
     <Stack
       ref={columnRef}
@@ -83,7 +90,7 @@ export function CardDetailProperty({
       className='octo-propertyrow'
     >
       {(readOnly || disableEditPropertyOption) && (
-        <PropertyLabel tooltip={propertyTooltip} readOnly>
+        <PropertyLabel tooltip={propertyTooltip} readOnly deleted={!!property.deletedAt}>
           {property.name}
         </PropertyLabel>
       )}
@@ -101,14 +108,18 @@ export function CardDetailProperty({
             <DragIndicatorIcon className='icons' fontSize='small' color='secondary' />
             <Tooltip title={propertyTooltip} disableInteractive>
               <span>
-                <Button>{property.name}</Button>
+                <Button deleted={!!property.deletedAt}>{property.name}</Button>
               </span>
             </Tooltip>
           </PropertyNameContainer>
           <Menu {...bindMenu(changePropertyPopupState)}>
             <PropertyMenu
               board={board}
               onDelete={onDelete}
+              onRestore={() => {
+                onRestore();
+                changePropertyPopupState.close();
+              }}
               deleteDisabled={deleteDisabledMessage?.length !== 0}
               property={property}
               onTypeAndNameChanged={(newType, newName, relationData) => {
diff --git a/components/common/DatabaseEditor/components/properties/PropertyLabel.tsx b/components/common/DatabaseEditor/components/properties/PropertyLabel.tsx
@@ -11,6 +11,7 @@ type PropertyLabelProps = {
   highlighted?: boolean;
   fullWidth?: boolean;
   tooltip?: string;
+  deleted?: boolean; // when showing deleted card properties
 };
 
 const Wrapper = styled(({ highlighted, fullWidth, ...props }: any) => <Box {...props} />)<{
@@ -31,7 +32,8 @@ export function PropertyLabel({
   fullWidth,
   tooltip,
   readOnly = true,
-  highlighted
+  highlighted,
+  deleted
 }: PropertyLabelProps) {
   if (readOnly) {
     return (
@@ -42,7 +44,7 @@ export function PropertyLabel({
       >
         <Tooltip title={tooltip} disableInteractive>
           <span>
-            <Button rightIcon icon={required && <Asterisk>&nbsp;*</Asterisk>}>
+            <Button rightIcon icon={required && <Asterisk>&nbsp;*</Asterisk>} deleted={deleted}>
               {children}
             </Button>
           </span>
diff --git a/components/common/DatabaseEditor/widgets/buttons/button.tsx b/components/common/DatabaseEditor/widgets/buttons/button.tsx
@@ -13,6 +13,7 @@ type Props = {
   rightIcon?: boolean;
   disabled?: boolean;
   'data-test'?: string;
+  deleted?: boolean;
 };
 
 function Button({ size = 'small', ...props }: Props): JSX.Element {
@@ -31,6 +32,7 @@ function Button({ size = 'small', ...props }: Props): JSX.Element {
       title={props.title}
       onBlur={props.onBlur}
       disabled={props.disabled}
+      style={{ textDecoration: props.deleted ? 'line-through' : undefined }}
     >
       {!props.rightIcon && props.icon}
       <span>{props.children}</span>
diff --git a/components/common/DatabaseEditor/widgets/propertyMenu.tsx b/components/common/DatabaseEditor/widgets/propertyMenu.tsx
@@ -1,5 +1,6 @@
 import ArrowRightIcon from '@mui/icons-material/ArrowRight';
 import DeleteOutlinedIcon from '@mui/icons-material/DeleteOutlined';
+import RestoreIcon from '@mui/icons-material/RestoreOutlined';
 import {
   ListItemIcon,
   ListItemText,
@@ -25,6 +26,7 @@ import { typeDisplayName } from './typeDisplayName';
 type Props = {
   onTypeAndNameChanged: (newType: PropertyType, newName: string, relationData?: RelationPropertyData) => void;
   onDelete: (id: string) => void;
+  onRestore: (id: string) => void;
   deleteDisabled?: boolean;
   property: IPropertyTemplate;
   board: Board;
@@ -84,12 +86,21 @@ const PropertyMenu = React.memo((props: Props) => {
         </Tooltip>
       </MenuItem>
       <Divider sx={{ my: '0 !important' }} />
-      <MenuItem onClick={() => props.onDelete(propertyId)}>
-        <ListItemIcon>
-          <DeleteOutlinedIcon fontSize='small' />
-        </ListItemIcon>
-        <ListItemText>Delete property</ListItemText>
-      </MenuItem>
+      {props.property.deletedAt ? (
+        <MenuItem onClick={() => props.onRestore(propertyId)}>
+          <ListItemIcon>
+            <RestoreIcon fontSize='small' />
+          </ListItemIcon>
+          <ListItemText>Undelete property</ListItemText>
+        </MenuItem>
+      ) : (
+        <MenuItem onClick={() => props.onDelete(propertyId)}>
+          <ListItemIcon>
+            <DeleteOutlinedIcon fontSize='small' />
+          </ListItemIcon>
+          <ListItemText>Delete property</ListItemText>
+        </MenuItem>
+      )}
       <Menu
         {...bindMenu(changePropertyTypePopupState)}
         anchorOrigin={{
diff --git a/components/proposals/ProposalPage/components/ProposalProperties/components/CustomPropertiesAdapter.tsx b/components/proposals/ProposalPage/components/ProposalProperties/components/CustomPropertiesAdapter.tsx
@@ -78,6 +78,7 @@ export function CustomPropertiesAdapter({ onChange, readOnly, readOnlyProperties
       mutator={mutator ?? undefined}
       readOnlyProperties={readOnlyProperties}
       disableEditPropertyOption={!isAdmin}
+      isTemplate={!proposalFromDb} // templates are not loaded into the proposalsmap
       boardType='proposals'
     />
   );
diff --git a/components/proposals/ProposalPage/components/ProposalProperties/proposalsMutator.ts b/components/proposals/ProposalPage/components/ProposalProperties/proposalsMutator.ts
@@ -80,6 +80,13 @@ export class ProposalsMutator extends Mutator {
     });
   }
 
+  // to enable undeleting properties
+  async updateProperty(board: Board, propertyId: string, updatedProperty: IPropertyTemplate) {
+    this.blocksContext.updateProperty({
+      ...updatedProperty
+    });
+  }
+
   async reorderProperties(boardId: string, cardProperties: IPropertyTemplate[]): Promise<void> {
     const proposalBoardBlock = this.blocksContext.proposalBoardBlock;
     const oldFields = proposalBoardBlock?.fields || {};
diff --git a/components/rewards/components/RewardProperties/CustomPropertiesAdapter.tsx b/components/rewards/components/RewardProperties/CustomPropertiesAdapter.tsx
@@ -87,6 +87,7 @@ export function CustomPropertiesAdapter({ reward, onChange, readOnly }: Props) {
       mutator={mutator ?? undefined}
       disableEditPropertyOption={!isAdmin}
       boardType='rewards'
+      isTemplate={rewardPage?.type === 'bounty_template'}
     />
   );
 }
diff --git a/components/rewards/components/RewardProperties/rewardsMutator.ts b/components/rewards/components/RewardProperties/rewardsMutator.ts
@@ -80,6 +80,13 @@ export class RewardsMutator extends Mutator {
     });
   }
 
+  // to enable undeleting properties
+  async updateProperty(board: Board, propertyId: string, updatedProperty: IPropertyTemplate) {
+    this.blocksContext.updateProperty({
+      ...updatedProperty
+    });
+  }
+
   async reorderProperties(boardId: string, cardProperties: IPropertyTemplate[]): Promise<void> {
     const rewardsBoardBlock = this.blocksContext.rewardsBoardBlock;
     const oldFields = rewardsBoardBlock?.fields || {};
diff --git a/components/rewards/hooks/useRewardsBoard.ts b/components/rewards/hooks/useRewardsBoard.ts
@@ -126,7 +126,14 @@ export function useRewardsBoard() {
         return;
       }
 
-      const updatedProperties = dbBlock.fields.cardProperties.filter((p) => p.id !== propertyTemplateId);
+      const updatedProperties = dbBlock.fields.cardProperties.map((p) =>
+        p.id === propertyTemplateId
+          ? {
+              ...p,
+              deletedAt: new Date().toISOString()
+            }
+          : p
+      );
       const updatedBlock = {
         ...dbBlock,
         fields: { ...(dbBlock.fields as BoardFields), cardProperties: updatedProperties }
diff --git a/hooks/useProposalBlocks.tsx b/hooks/useProposalBlocks.tsx
@@ -175,7 +175,14 @@ export function ProposalBlocksProvider({ children }: { children: ReactNode }) {
         return;
       }
 
-      const updatedProperties = proposalBoardBlock.fields.cardProperties.filter((p) => p.id !== propertyTemplateId);
+      const updatedProperties = proposalBoardBlock.fields.cardProperties.map((p) =>
+        p.id === propertyTemplateId
+          ? {
+              ...p,
+              deletedAt: new Date().toISOString()
+            }
+          : p
+      );
       const updatedBlock = { ...proposalBoardBlock, fields: { cardProperties: updatedProperties } };
       try {
         const res = await updateProposalBlocks([updatedBlock]);
diff --git a/lib/databases/board.ts b/lib/databases/board.ts
@@ -72,6 +72,7 @@ export type IPropertyTemplate<T extends PropertyType = PropertyType> = {
   id: string;
   name: string;
   type: T;
+  deletedAt?: string; // ISODate. If set, the property will be visible based on when the page was created
   options: IPropertyOption[];
   description?: string;
   tooltip?: string;
diff --git a/lib/proposals/createDraftProposal.ts b/lib/proposals/createDraftProposal.ts
@@ -1,6 +1,7 @@
 import type { PageType } from '@charmverse/core/prisma';
 import { prisma } from '@charmverse/core/prisma-client';
 import type { WorkflowEvaluationJson } from '@charmverse/core/proposals';
+import type { BoardFields } from '@root/lib/databases/board';
 import { generatePagePathFromPathAndTitle } from '@root/lib/pages/utils';
 import { createDefaultProjectAndMembersFieldConfig } from '@root/lib/projects/formField';
 import type { FormFieldInput } from '@root/lib/proposals/forms/interfaces';
@@ -31,7 +32,7 @@ export type CreateDraftProposalInput = {
 
 export async function createDraftProposal(input: CreateDraftProposalInput) {
   // get source data
-  const [template, sourcePage, sourcePost] = await Promise.all([
+  const [template, sourcePage, sourcePost, proposalBoardBlock] = await Promise.all([
     input.templateId
       ? await prisma.page.findUniqueOrThrow({
           where: {
@@ -76,7 +77,15 @@ export async function createDraftProposal(input: CreateDraftProposalInput) {
             id: input.sourcePostId
           }
         })
-      : null
+      : null,
+    prisma.proposalBlock.findUnique({
+      where: {
+        id_spaceId: {
+          id: '__defaultBoard',
+          spaceId: input.spaceId
+        }
+      }
+    })
   ]);
 
   const workflow =
@@ -130,6 +139,15 @@ export async function createDraftProposal(input: CreateDraftProposalInput) {
     pendingRewards: []
   };
 
+  // dont create properties that were deleted
+  if (proposalBoardBlock && fields.properties) {
+    (proposalBoardBlock.fields as unknown as BoardFields).cardProperties.forEach((property) => {
+      if (property.deletedAt) {
+        delete fields.properties![property.id];
+      }
+    });
+  }
+
   let formFields: FormFieldInput[] = [];
   if (input.pageType === 'proposal_template' && template?.proposal?.form) {
     formFields = template.proposal.form.formFields.map(
diff --git a/lib/rewards/createReward.ts b/lib/rewards/createReward.ts
@@ -1,11 +1,14 @@
 import type { Page, PagePermission, Prisma } from '@charmverse/core/prisma';
 import { prisma } from '@charmverse/core/prisma-client';
+import type { BoardFields } from '@root/lib/databases/board';
 import { NotFoundError } from '@root/lib/middleware';
 import { generatePagePathFromPathAndTitle } from '@root/lib/pages/utils';
 import { extractPreviewImage } from '@root/lib/prosemirror/extractPreviewImage';
 import { InvalidInputError } from '@root/lib/utils/errors';
 import { v4 } from 'uuid';
 
+import type { RewardFields } from 'lib/rewards/blocks/interfaces';
+
 import { trackOpUserAction } from '../metrics/mixpanel/trackOpUserAction';
 
 import { getRewardOrThrow } from './getReward';
@@ -82,6 +85,24 @@ export async function createReward({
     }
   });
 
+  const rewardBoardBlock = await prisma.rewardBlock.findUnique({
+    where: {
+      id_spaceId: {
+        id: '__defaultBoard',
+        spaceId
+      }
+    }
+  });
+
+  // dont create properties that were deleted
+  if (rewardBoardBlock && (fields as unknown as RewardFields | undefined)?.properties) {
+    (rewardBoardBlock.fields as unknown as BoardFields).cardProperties.forEach((property) => {
+      if (property.deletedAt) {
+        delete (fields as unknown as RewardFields).properties![property.id];
+      }
+    });
+  }
+
   const rewardId = v4();
 
   const isAssignedReward = Array.isArray(assignedSubmitters) && assignedSubmitters.length > 0;
diff --git a/op-backup-02-2025.json b/op-backup-02-2025.json
diff --git a/package-lock.json b/package-lock.json

Original file line number	Diff line number	Diff line change
`@@ -87,6 +87,7 @@ export function CustomPropertiesAdapter({ reward, onChange, readOnly }: Props) {`
`87`	`87`	`mutator={mutator ?? undefined}`
`88`	`88`	`disableEditPropertyOption={!isAdmin}`
`89`	`89`	`boardType='rewards'`
	`90`	`+ isTemplate={rewardPage?.type === 'bounty_template'}`
`90`	`91`	`/>`
`91`	`92`	`);`
`92`	`93`	`}`