Save Markdown and BlockNote in RICH_TEXT fields (#7613) #9279

eliasylonen · 2024-12-30T12:27:23Z

Make RICH_TEXT field composite: instead of saving only BlockNote also save a lossy copy of the value in Markdown format.
Let user choose between BlockNote and Markdown when importing a field from a CSV.

Fixes #7613
Fixes #7444

github-actions · 2024-12-30T12:28:33Z

TODOs/FIXMEs:

// TODO: Can these be null?: packages/twenty-front/src/modules/object-record/record-field/types/FieldMetadata.ts
// TODO: Check later if and how this works: packages/twenty-server/src/modules/note/standard-objects/note.workspace-entity.ts
// TODO: Check later if and how this works: packages/twenty-server/src/modules/task/standard-objects/task.workspace-entity.ts

Generated by 🚫 dangerJS against 73dfe30

greptile-apps

PR Summary

This PR transforms RICH_TEXT fields into composite fields that store both BlockNote and Markdown formats, enabling dual-format storage and format choice during CSV imports.

Adds new rich-text.composite-type.ts defining the composite structure with nullable blocknote and markdown TEXT fields
Modifies search functionality in task/note entities to use bodyBlocknote instead of body, with a TODO to verify search behavior
Moves RICH_TEXT handling from basicColumnActionFactory to compositeColumnActionFactory for database migrations
Updates OpenAPI schema and Zapier integration to handle RICH_TEXT as a composite field with both formats
Needs proper example values in SettingsCompositeFieldTypeConfigs.ts (currently marked as TODO)

_{22 file(s) reviewed, 11 comment(s)}
_{Edit PR Review Bot Settings | Greptile}

greptile-apps · 2024-12-30T12:28:05Z

...ges/twenty-front/src/modules/object-record/record-field/types/guards/isFieldRichTextValue.ts

+export const richTextSchema: z.ZodType<FieldRichTextValue> = z.object({
+  blocknote: z.string().nullable(),
+  markdown: z.string().nullable(),
+});


style: consider adding validation to ensure at least one of blocknote or markdown is non-null to prevent empty objects

greptile-apps · 2024-12-30T12:28:27Z

.../twenty-front/src/modules/settings/data-model/constants/SettingsCompositeFieldTypeConfigs.ts

+      blocknote: 'TODO', // TODO
+      markdown: 'TODO',


logic: example values are marked as TODO and need to be properly defined with realistic sample data

greptile-apps · 2024-12-30T12:28:27Z

.../twenty-front/src/modules/settings/data-model/constants/SettingsCompositeFieldTypeConfigs.ts

+    label: 'Rich Text',
+    Icon: IllustrationIconText,
+    subFields: ['blocknote', 'markdown'],
+    filterableSubFields: [],


style: consider adding 'markdown' to filterableSubFields to enable searching/filtering by content

greptile-apps · 2024-12-30T12:29:17Z

...query-runner/factories/query-result-getters/handlers/activity-query-result-getter.handler.ts

@@ -21,7 +21,7 @@ export class ActivityQueryResultGetterHandler
      return activity;
    }

-    const body: RichTextBody = JSON.parse(activity.body);
+    const body: RichTextBody = JSON.parse(activity.body.blocknote);


logic: add try/catch around JSON.parse to handle invalid JSON gracefully

greptile-apps · 2024-12-30T12:29:24Z

...er/src/engine/api/rest/core/query-builder/utils/map-field-metadata-to-graphql-query.utils.ts

  }
 };


logic: missing return type for undefined case - could cause runtime issues if field type is not handled

greptile-apps · 2024-12-30T12:30:04Z

...erver/src/engine/metadata-modules/field-metadata/composite-types/rich-text.composite-type.ts

+export type RichTextMetadata = {
+  blocknote: string;
+  markdown: string;
+};


logic: both fields are defined as required in the type but marked as not required in the composite type definition above. This inconsistency could cause runtime issues

greptile-apps · 2024-12-30T12:30:07Z

packages/twenty-server/src/engine/metadata-modules/field-metadata/dtos/default-value.input.ts

 export class FieldMetadataDefaultValueRichText {
-  @ValidateIf((_object, value) => value !== null)
-  @IsString()
-  value: string | null;
+  @ValidateIf((object, value) => value !== null)
+  @IsQuotedString()
+  blocknote: string | null;
+
+  @ValidateIf((object, value) => value !== null)
+  @IsQuotedString()
+  markdown: string | null;
 }


logic: Both blocknote and markdown fields can be null simultaneously. Consider adding validation to ensure at least one format is provided.

greptile-apps · 2024-12-30T12:31:30Z

packages/twenty-server/src/modules/task/standard-objects/task.workspace-entity.ts

@@ -37,7 +38,7 @@ const BODY_FIELD_NAME = 'body';

 export const SEARCH_FIELDS_FOR_TASK: FieldTypeAndNameMetadata[] = [
  { name: TITLE_FIELD_NAME, type: FieldMetadataType.TEXT },
-  { name: BODY_FIELD_NAME, type: FieldMetadataType.RICH_TEXT },
+  { name: `${BODY_FIELD_NAME}Blocknote`, type: FieldMetadataType.RICH_TEXT }, // TODO: Check later if and how this works


logic: search field using 'bodyBlocknote' may break full-text search for existing tasks since the field name changed from 'body' to 'bodyBlocknote'

greptile-apps · 2024-12-30T12:31:35Z

packages/twenty-server/src/modules/note/standard-objects/note.workspace-entity.ts

@@ -35,7 +36,7 @@ const BODY_FIELD_NAME = 'body';

 export const SEARCH_FIELDS_FOR_NOTES: FieldTypeAndNameMetadata[] = [
  { name: TITLE_FIELD_NAME, type: FieldMetadataType.TEXT },
-  { name: BODY_FIELD_NAME, type: FieldMetadataType.RICH_TEXT },
+  { name: `${BODY_FIELD_NAME}Blocknote`, type: FieldMetadataType.RICH_TEXT }, // TODO: Check later if and how this works


logic: search field name change from 'body' to 'bodyBlocknote' may break existing search functionality if not properly migrated

greptile-apps · 2024-12-30T12:31:52Z

packages/twenty-zapier/src/utils/computeInputFields.ts

+        name: 'blocknote',
+        label: 'Blocknote',
+        description: 'Blocknote',


style: inconsistent casing between 'blocknote' and 'BlockNote' in label/description

lucasbordeau · 2024-12-31T13:14:27Z

@eliasylonen Could you link the original issue ?
@FelixMalfait Should we re-activate the field input in this PR also ?

FelixMalfait · 2024-12-31T13:21:54Z

@lucasbordeau I edited the description to add the related issues. I think we should create a separate issue for the input in table views as this PR is going to be quite big already (it's still wip). Would you mind creating it if you can point to the right direction? I'm not sure what has been done/is left to be done

lucasbordeau · 2025-01-03T10:20:25Z

Could we use deprecated instead of old ?

lucasbordeau · 2025-01-03T10:21:48Z

Shouldn't we add the type RICH_TEXT next to the RICH_TEXT_OLD/DEPRECATED ?

eliasylonen · 2025-01-03T17:44:10Z

@lucasbordeau Yes 👍 will do!

ad-elias added 4 commits December 29, 2024 16:09

Make RICH_TEXT composite WiP

dbdfd1a

Make RICH_TEXT composite WiP

45b68d0

Frontend handling of composite RICH_TEXT WiP

4f5ae94

Merge branch 'main' into feat/7613-composite-rich-text

29df7e6

eliasylonen added the -PR: wip label Dec 30, 2024

greptile-apps bot reviewed Dec 30, 2024

View reviewed changes

ad-elias added 3 commits January 2, 2025 12:26

Merge branch 'main' into feat/7613-composite-rich-text

3445e35

Add old RICH_TEXT field as RICH_TEXT_OLD

b65d6f2

Add isFieldRichTextOldValue fn

032c115

Fix errors adding RICH_TEXT_OLD

73dfe30

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Save Markdown and BlockNote in RICH_TEXT fields (#7613) #9279

Save Markdown and BlockNote in RICH_TEXT fields (#7613) #9279

eliasylonen commented Dec 30, 2024 •

edited by FelixMalfait

Loading

github-actions bot commented Dec 30, 2024 •

edited

Loading

greptile-apps bot left a comment

greptile-apps bot Dec 30, 2024

greptile-apps bot Dec 30, 2024

greptile-apps bot Dec 30, 2024

greptile-apps bot Dec 30, 2024

greptile-apps bot Dec 30, 2024

greptile-apps bot Dec 30, 2024

greptile-apps bot Dec 30, 2024

greptile-apps bot Dec 30, 2024

greptile-apps bot Dec 30, 2024

greptile-apps bot Dec 30, 2024

lucasbordeau commented Dec 31, 2024

FelixMalfait commented Dec 31, 2024

lucasbordeau commented Jan 3, 2025

lucasbordeau commented Jan 3, 2025

eliasylonen commented Jan 3, 2025

Save Markdown and BlockNote in RICH_TEXT fields (#7613) #9279

Are you sure you want to change the base?

Save Markdown and BlockNote in RICH_TEXT fields (#7613) #9279

Conversation

eliasylonen commented Dec 30, 2024 • edited by FelixMalfait Loading

github-actions bot commented Dec 30, 2024 • edited Loading

TODOs/FIXMEs:

greptile-apps bot left a comment

Choose a reason for hiding this comment

PR Summary

greptile-apps bot Dec 30, 2024

Choose a reason for hiding this comment

greptile-apps bot Dec 30, 2024

Choose a reason for hiding this comment

greptile-apps bot Dec 30, 2024

Choose a reason for hiding this comment

greptile-apps bot Dec 30, 2024

Choose a reason for hiding this comment

greptile-apps bot Dec 30, 2024

Choose a reason for hiding this comment

greptile-apps bot Dec 30, 2024

Choose a reason for hiding this comment

greptile-apps bot Dec 30, 2024

Choose a reason for hiding this comment

greptile-apps bot Dec 30, 2024

Choose a reason for hiding this comment

greptile-apps bot Dec 30, 2024

Choose a reason for hiding this comment

greptile-apps bot Dec 30, 2024

Choose a reason for hiding this comment

lucasbordeau commented Dec 31, 2024

FelixMalfait commented Dec 31, 2024

lucasbordeau commented Jan 3, 2025

lucasbordeau commented Jan 3, 2025

eliasylonen commented Jan 3, 2025

eliasylonen commented Dec 30, 2024 •

edited by FelixMalfait

Loading

github-actions bot commented Dec 30, 2024 •

edited

Loading