fix: import meta of non custom report widgets #3626
Conversation
actual-github-bot
bot
changed the title
✅ Deploy Preview for actualbudget ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Bundle Stats — desktop-clientHey there, this message comes from a GitHub action that helps you and reviewers to understand how these changes affect the size of this project's bundle. As this PR is updated, I'll keep you updated on how the bundle size is impacted. Total
Changeset No files were changed View detailed bundle breakdownAdded No assets were added Removed No assets were removed Bigger No assets were bigger Smaller No assets were smaller Unchanged
|
Bundle Stats — loot-coreHey there, this message comes from a GitHub action that helps you and reviewers to understand how these changes affect the size of this project's bundle. As this PR is updated, I'll keep you updated on how the bundle size is impacted. Total
Changeset
View detailed bundle breakdownAdded No assets were added Removed No assets were removed Bigger
Smaller No assets were smaller Unchanged No assets were unchanged |
UnderKoen
changed the title
WalkthroughThe changes in this pull request focus on the Possibly related PRs
Suggested labels
Suggested reviewers
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Outside diff range and nitpick comments (1)
packages/loot-core/src/server/dashboard/app.ts (1)
Line range hint
14-78: Suggestion: Enhance validation for non-custom report widget meta propertyWhile the change to retain the
metaproperty for non-custom report widgets is good, theexportModel.validatefunction doesn't explicitly validate this property for non-custom report widgets. To ensure data integrity and prevent potential issues during import, consider adding validation for themetaproperty of non-custom report widgets.Here's a suggested modification to the
exportModel.validatefunction:function isExportedCustomReportWidget( widget: ExportImportDashboardWidget, ): widget is ExportImportCustomReportWidget { return widget.type === 'custom-report'; } const exportModel = { validate(dashboard: ExportImportDashboard) { // ... existing validation ... dashboard.widgets.forEach((widget, idx) => { // ... existing validation ... if (isExportedCustomReportWidget(widget)) { reportModel.validate(widget.meta); } else if (widget.meta !== undefined) { // Add validation for non-custom report widget meta if (typeof widget.meta !== 'object' || widget.meta === null) { throw new ValidationError( `Invalid widget.${idx}.meta: it must be an object for non-custom report widgets.` ); } // Add any specific validation for non-custom report widget meta properties here } }); }, };This enhancement will ensure that the
metaproperty is valid for all widget types, improving the robustness of the import process.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
⛔ Files ignored due to path filters (1)
upcoming-release-notes/3626.mdis excluded by!**/*.md
📒 Files selected for processing (1)
- packages/loot-core/src/server/dashboard/app.ts (1 hunks)
🧰 Additional context used
| @@ -194,7 +194,7 @@ async function importDashboard({ filepath }: { filepath: string }) { | |||
| y: widget.y, | |||
| meta: isExportedCustomReportWidget(widget) | |||
| ? { id: widget.meta.id } | |||
| : null, | |||
| : widget.meta, | |||
There was a problem hiding this comment.
💡 Codebase verification
Issues Found: meta Property Not Defined in Widget Types
The widget.meta property is accessed in multiple parts of the codebase but is not explicitly defined in any widget type or interface definitions. This can lead to type safety issues and potential runtime errors.
Recommendations:
- Define the
metaproperty in all relevant widget type or interface definitions to ensure consistent and safe usage across the codebase. - Add null or undefined checks where
widget.metais accessed to handle cases wheremetamight not be set.
🔗 Analysis chain
Approve change with verification suggestion
The modification to allow non-custom report widgets to retain their meta property is a good improvement. This change addresses the PR objective of fixing the import of non-custom report widgets.
However, to ensure robustness, we should verify that all non-custom report widget types have a valid meta property. If there's a possibility of undefined meta properties, we might want to add a fallback.
To verify the usage of meta property in non-custom report widgets, run the following script:
This script will help us understand how the meta property is used across different widget types and ensure our change doesn't introduce any unexpected behavior.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Check usage of meta property in non-custom report widgets
# Search for widget definitions with meta property
echo "Searching for widget definitions with meta property:"
rg --type typescript 'type.*Widget.*=.*\{.*meta.*:' -g '!**/app.ts'
# Search for places where meta is accessed on widgets
echo "\nSearching for places where meta is accessed on widgets:"
rg --type typescript 'widget\.meta' -g '!**/app.ts'
Length of output: 433
Script:
#!/bin/bash
# Description: Check usage of meta property in non-custom report widgets
# Search for widget definitions with meta property
echo "Searching for widget definitions with meta property:"
rg --type ts 'type.*Widget.*=.*\{.*meta.*:' -g '!**/app.ts'
# Search for places where meta is accessed on widgets
echo "\nSearching for places where meta is accessed on widgets:"
rg --type ts 'widget\.meta' -g '!**/app.ts'
Length of output: 1075
Script:
#!/bin/bash
# Description: Verify that all widget type/interface definitions include a meta property
# Search for type definitions of widgets that include a meta property
echo "Searching for widget type definitions with a meta property:"
rg 'type\s+\w+Widget\s*=\s*\{[^}]*meta\s*:' --type ts
# Search for interface definitions of widgets that include a meta property
echo "\nSearching for widget interface definitions with a meta property:"
rg 'interface\s+\w+Widget\s*{\s*[^}]*meta\s*:' --type ts
# Check for default assignments or fallback mechanisms for widget.meta
echo "\nSearching for default assignments or fallback implementations for widget.meta:"
rg 'widget\.meta\s*\?\?|\|\|' --type ts
Length of output: 85183
When importing the exported file of the report dashboard. Names and timeframe data is lost.
Related feature: #3282
Testing:
The following json should fail on edge to be imported (the metadata of text is required)
dashboard (3).json
The following should be import but without custom names for networth
dashboard (4).json
Hope it is clear!