-
Notifications
You must be signed in to change notification settings - Fork 2.4k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Refactored and improved seeds #8695
base: main
Are you sure you want to change the base?
Conversation
lucasbordeau
commented
Nov 22, 2024
- Added all field types on Company seeds
- Added a new Seeder service to help with custom objects
- Added RichTextFieldInput to edit a rich text field directly on the table.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
PR Summary
This PR adds comprehensive seeding functionality and rich text field support across the application, including new demo data and field types for testing.
- Added RichTextFieldInput with BlockNote editor integration for inline rich text editing in tables
- Introduced new SeederService with support for custom objects, composite fields, and improved data seeding capabilities
- Added 10 new demo field types to Company seeds (UUID, RichText, Array, Rating, etc.) with corresponding metadata and views
- Added new seed data files for pets and survey results with 100 records each for testing
- Fixed color naming consistency from 'grey' to 'gray' across multiple theme and UI files
51 file(s) reviewed, 36 comment(s)
Edit PR Review Bot Settings | Greptile
@@ -156,7 +156,7 @@ export const FieldInput = ({ | |||
onShiftTab={onShiftTab} | |||
/> | |||
) : isFieldRichText(fieldDefinition) ? ( | |||
<RichTextFieldInput /> | |||
<RichTextFieldInput onClickOutside={onClickOutside} /> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
logic: RichTextFieldInput is missing onEnter, onEscape, onTab, and onShiftTab handlers that most other field types have
const persistField = usePersistField(); | ||
|
||
const persistRichTextField = (nextValue: PartialBlock[]) => { | ||
if (!nextValue) persistField(null); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
logic: Missing return after setting null - could cause undefined behavior by continuing execution
const draftValueParsed: PartialBlock[] = isNonEmptyString(draftValue) | ||
? JSON.parse(draftValue) | ||
: draftValue; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
logic: JSON.parse could throw if draftValue is malformed JSON - needs try/catch
fieldName: fieldName, | ||
}), | ||
); | ||
const fieldRichTextValue = isFieldRichTextValue(fieldValue) ? fieldValue : ''; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
style: Empty string fallback may not be appropriate for all rich text use cases - consider null or empty block array
fieldName, | ||
); | ||
|
||
const fieldValueParsed = parseJson<PartialBlock[]>(fieldValue); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
logic: parseJson could return undefined/null - need to handle this case explicitly to avoid runtime errors when using fieldValueParsed
await this.seederService.seedCustomObjects( | ||
dataSourceMetadata.id, | ||
workspaceId, | ||
PETS_METADATA_SEEDS, | ||
PETS_DATA_SEEDS, | ||
); | ||
|
||
await this.seederService.seedCustomObjects( | ||
dataSourceMetadata.id, | ||
workspaceId, | ||
SURVEY_RESULTS_METADATA_SEEDS, | ||
SURVEY_RESULTS_DATA_SEEDS, | ||
); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
logic: These sequential seeding operations could fail independently. Consider wrapping them in a transaction or adding error handling to ensure partial seeding doesn't leave the workspace in an inconsistent state.
@WorkspaceIsNullable() | ||
demoRichText: string; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
logic: demoRichText should be typed as FieldRichTextValue or string[] instead of string to match the RichText field type
@WorkspaceIsNullable() | ||
demoRawJSON: JSON | null; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
style: demoRawJSON should be typed as Record<string, unknown> | null instead of JSON | null for better type safety
if (!isDefined(themeColor)) { | ||
console.warn(`Tag color ${color} is not defined in the theme`); | ||
return theme.tag.background.gray; | ||
} else { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
style: Consider throwing an error instead of silently falling back to gray, since an undefined theme color likely indicates a bug that should be fixed
) : ( | ||
<></> | ||
)} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
style: Empty fragment is unnecessary here since the ternary could just return null