Fix reports form submit handlers #3462

joel-jeremy · 2024-09-18T05:56:05Z

coderabbitai · 2024-09-18T05:56:19Z

Walkthrough

The changes involve refactoring the form handling in the SaveReportChoose.tsx and SaveReportName.tsx files by replacing standard HTML <form> elements with the Form component from the react-aria-components library. This transition enhances accessibility and modifies how form submissions are processed, preventing full page reloads and ensuring smoother user interactions. Additionally, a bug fix is introduced to prevent the application from reloading when submitting report names.

Changes

File	Change Summary
`packages/desktop-client/src/components/reports/SaveReportChoose.tsx` `packages/desktop-client/src/components/reports/SaveReportName.tsx`	Transitioned from standard HTML `<form>` to `Form` component, updated event handling for form submissions to prevent default behavior and enhance accessibility.
`upcoming-release-notes/3462.md`	Introduced a bug fix for the form submission handler to prevent full page reloads during report saving, improving user experience.

Assessment against linked issues

Objective	Addressed	Explanation
Prevent app reload when saving a report name (Issue #3439)	✅
Ensure form submissions do not trigger full page reloads (Issue #3439)	✅

Poem

🐰 In the garden where reports bloom,
Forms now dance, dispelling gloom.
No more reloads, just smooth delight,
Saving names with all our might!
Hooray for changes, let’s hop and cheer,
For a seamless journey, we hold dear! 🌼

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 17fd068 and dd17454.

Files selected for processing (3)

packages/desktop-client/src/components/reports/SaveReportChoose.tsx (3 hunks)
packages/desktop-client/src/components/reports/SaveReportName.tsx (3 hunks)
upcoming-release-notes/3462.md (1 hunks)

Additional comments not posted (8)

upcoming-release-notes/3462.md (1)

1-6: LGTM!

The release notes accurately summarize the bug fix based on the information provided in the PR objectives and AI-generated summary. The category, author, and description are appropriate for the changes made in this PR.

packages/desktop-client/src/components/reports/SaveReportChoose.tsx (4)

28-39: Excellent transition to the Form component!

The changes in this code segment significantly improve accessibility and user experience by leveraging the capabilities of the react-aria-components library's Form component. The onSubmit handler is now directly associated with the Form, streamlining the submission process and preventing default form submission behavior.

The inclusion of validation logic ensures that a valid report value is provided before calling the onApply function, maintaining data integrity. Setting an error message for invalid values enhances the user experience by providing immediate feedback.

Overall, these changes demonstrate a strong focus on accessibility and user-centric design.

62-62: Great use of the type="submit" attribute!

Replacing the onPress handler with the type="submit" attribute aligns perfectly with the transition to the Form component. This change allows the button to trigger form submission directly, streamlining the submission process and improving the user experience.

By eliminating the need for a separate onPress handler, the code becomes more concise and easier to understand.

66-66: Properly closed the Form component.

Closing the Form component is essential for maintaining the structural integrity of the JSX code and ensuring that the form and its associated elements function as intended.

2-2: Correctly imported the Form component.

Importing the Form component from the react-aria-components library is essential for using it in the JSX code. This change ensures that the component is available for use in the SaveReportChoose component, enabling the transition from the standard HTML <form> element.

packages/desktop-client/src/components/reports/SaveReportName.tsx (3)

48-56: Excellent use of the <Form> component!

The transition from a standard HTML <form> element to the <Form> component from the react-aria-components library is a great improvement. This change enhances accessibility and aligns with best practices for handling forms in React applications.

By using the onSubmit event of the <Form> component and preventing the default form submission behavior, you've ensured that the form data is processed as intended without causing unexpected page reloads. This improves the user experience and makes the form more usable for all users, including those relying on assistive technologies.

77-77: Good practice: Setting the correct type attribute for form buttons.

Setting the type attribute of the submit button to "submit" is a good practice. This change ensures that the button behaves correctly within the context of the form submission, triggering the onSubmit event handler when clicked.

By explicitly setting the type attribute, you've improved the clarity and correctness of the code, making it easier to understand and maintain.

2-2: Necessary import for using the Form component.

The import statement for the Form component from the react-aria-components library is a necessary addition to the code. This import enables the use of the Form component, which is a key part of the overall changes made in this file.

By importing the Form component, you've laid the foundation for enhancing accessibility and improving the handling of form submissions. This change aligns with the other modifications made in the code and is crucial for the successful implementation of the new form handling approach.

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?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
-- I pushed a fix in commit <commit_id>, please review it.
-- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
-- @coderabbitai generate unit testing code for this file.
-- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
-- @coderabbitai generate interesting stats about this repository and render them as a table.
-- @coderabbitai read src/utils.ts and generate unit testing code.
-- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
-- @coderabbitai help me debug CodeRabbit configuration file.

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)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

netlify · 2024-09-18T05:56:19Z

✅ Deploy Preview for actualbudget ready!

Name	Link
🔨 Latest commit	`dd17454`
🔍 Latest deploy log	https://app.netlify.com/sites/actualbudget/deploys/66ea6bf2d3e16c000876529d
😎 Deploy Preview	https://deploy-preview-3462.demo.actualbudget.org
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

github-actions · 2024-09-18T05:57:20Z

Bundle Stats — desktop-client

Hey 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

Files count	Total bundle size	% Changed
9	5.18 MB → 5.18 MB (-3.08 kB)	-0.06%

Changeset

File	Δ	Size
`src/components/reports/SaveReportName.tsx`	📈 +61 B (+2.73%)	2.19 kB → 2.25 kB
`src/components/reports/SaveReportChoose.tsx`	📈 +43 B (+1.64%)	2.55 kB → 2.6 kB
`home/runner/work/actual/actual/packages/loot-core/src/shared/rules.ts`	📉 -73 B (-1.10%)	6.48 kB → 6.41 kB
`src/components/modals/EditRuleModal.jsx`	📉 -1.67 kB (-4.29%)	38.94 kB → 37.27 kB
`src/components/settings/Experimental.tsx`	📉 -233 B (-4.80%)	4.74 kB → 4.51 kB
`src/hooks/useFeatureFlag.ts`	📉 -27 B (-7.28%)	371 B → 344 B
`src/components/rules/ActionExpression.tsx`	📉 -375 B (-9.12%)	4.01 kB → 3.65 kB
`src/icons/v1/Code.tsx`	🔥 -448 B (-100%)	448 B → 0 B
`src/icons/v1/AlignLeft.tsx`	🔥 -387 B (-100%)	387 B → 0 B

View detailed bundle breakdown

Added

No assets were added

Removed

No assets were removed

Bigger

Asset	File Size	% Changed
static/js/ReportRouter.js	1.5 MB → 1.5 MB (+104 B)	+0.01%

Smaller

Asset	File Size	% Changed
static/js/index.js	3.21 MB → 3.21 MB (-3.18 kB)	-0.10%

Unchanged

Asset	File Size	% Changed
static/js/resize-observer.js	18.37 kB	0%
static/js/indexeddb-main-thread-worker-e59fee74.js	13.5 kB	0%
static/js/BackgroundImage.js	122.29 kB	0%
static/js/narrow.js	80.62 kB	0%
static/js/usePreviewTransactions.js	1.59 kB	0%
static/js/AppliedFilters.js	20.97 kB	0%
static/js/wide.js	225.21 kB	0%

github-actions · 2024-09-18T05:57:21Z

Bundle Stats — loot-core

Hey 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

Files count	Total bundle size	% Changed
1	1.26 MB → 1.19 MB (-74.56 kB)	-5.76%

Changeset

File	Δ	Size
`packages/loot-core/src/shared/rules.ts`	📉 -83 B (-0.92%)	8.8 kB → 8.72 kB
`packages/loot-core/src/server/accounts/rules.ts`	📉 -2.85 kB (-8.45%)	33.74 kB → 30.88 kB
`node_modules/handlebars/dist/cjs/handlebars/compiler/parser.js`	🔥 -200.84 kB (-100%)	200.84 kB → 0 B
`node_modules/handlebars/dist/cjs/handlebars/compiler/javascript-compiler.js`	🔥 -118.53 kB (-100%)	118.53 kB → 0 B
`node_modules/handlebars/dist/cjs/handlebars/compiler/compiler.js`	🔥 -56.75 kB (-100%)	56.75 kB → 0 B
`node_modules/handlebars/dist/cjs/handlebars/runtime.js`	🔥 -43.72 kB (-100%)	43.72 kB → 0 B
`node_modules/handlebars/dist/cjs/handlebars/compiler/whitespace-control.js`	🔥 -22.62 kB (-100%)	22.62 kB → 0 B
`node_modules/handlebars/dist/cjs/handlebars/compiler/helpers.js`	🔥 -18.76 kB (-100%)	18.76 kB → 0 B
`node_modules/handlebars/dist/cjs/handlebars/compiler/code-gen.js`	🔥 -15.51 kB (-100%)	15.51 kB → 0 B
`node_modules/handlebars/dist/cjs/handlebars/compiler/visitor.js`	🔥 -12.33 kB (-100%)	12.33 kB → 0 B
`node_modules/handlebars/dist/cjs/handlebars/utils.js`	🔥 -10.07 kB (-100%)	10.07 kB → 0 B
`node_modules/handlebars/dist/cjs/handlebars/helpers/each.js`	🔥 -9.64 kB (-100%)	9.64 kB → 0 B
`node_modules/handlebars/dist/cjs/handlebars/base.js`	🔥 -9.41 kB (-100%)	9.41 kB → 0 B
`node_modules/handlebars/dist/cjs/handlebars/internal/proto-access.js`	🔥 -8.29 kB (-100%)	8.29 kB → 0 B
`node_modules/handlebars/dist/cjs/handlebars/exception.js`	🔥 -5.81 kB (-100%)	5.81 kB → 0 B
`node_modules/handlebars/dist/cjs/handlebars.js`	🔥 -4.79 kB (-100%)	4.79 kB → 0 B
`node_modules/handlebars/dist/cjs/handlebars.runtime.js`	🔥 -4.5 kB (-100%)	4.5 kB → 0 B
`node_modules/handlebars/dist/cjs/handlebars/helpers/if.js`	🔥 -4.35 kB (-100%)	4.35 kB → 0 B
`node_modules/handlebars/dist/cjs/handlebars/compiler/base.js`	🔥 -3.83 kB (-100%)	3.83 kB → 0 B
`node_modules/handlebars/dist/cjs/handlebars/helpers.js`	🔥 -3.82 kB (-100%)	3.82 kB → 0 B
`node_modules/handlebars/dist/cjs/handlebars/logger.js`	🔥 -3.79 kB (-100%)	3.79 kB → 0 B
`node_modules/handlebars/dist/cjs/handlebars/helpers/block-helper-missing.js`	🔥 -3.74 kB (-100%)	3.74 kB → 0 B
`node_modules/handlebars/dist/cjs/handlebars/helpers/with.js`	🔥 -3.67 kB (-100%)	3.67 kB → 0 B
`node_modules/handlebars/dist/cjs/handlebars/compiler/ast.js`	🔥 -3.34 kB (-100%)	3.34 kB → 0 B
`node_modules/handlebars/dist/cjs/handlebars/decorators/inline.js`	🔥 -2.63 kB (-100%)	2.63 kB → 0 B
`node_modules/handlebars/dist/cjs/handlebars/helpers/log.js`	🔥 -2.45 kB (-100%)	2.45 kB → 0 B
`node_modules/handlebars/dist/cjs/handlebars/no-conflict.js`	🔥 -2.45 kB (-100%)	2.45 kB → 0 B
`node_modules/handlebars/dist/cjs/handlebars/internal/wrapHelper.js`	🔥 -2.14 kB (-100%)	2.14 kB → 0 B
`node_modules/handlebars/dist/cjs/handlebars/helpers/helper-missing.js`	🔥 -1.97 kB (-100%)	1.97 kB → 0 B
`node_modules/handlebars/dist/cjs/handlebars/internal/create-new-lookup-object.js`	🔥 -1.74 kB (-100%)	1.74 kB → 0 B
`node_modules/handlebars/dist/cjs/handlebars/helpers/lookup.js`	🔥 -1.21 kB (-100%)	1.21 kB → 0 B
`node_modules/handlebars/dist/cjs/handlebars/safe-string.js`	🔥 -1.14 kB (-100%)	1.14 kB → 0 B
`node_modules/handlebars/dist/cjs/handlebars/decorators.js`	🔥 -1000 B (-100%)	1000 B → 0 B

View detailed bundle breakdown

Added

No assets were added

Removed

No assets were removed

Bigger

No assets were bigger

Smaller

Asset	File Size	% Changed
kcab.worker.js	1.26 MB → 1.19 MB (-74.56 kB)	-5.76%

Unchanged

No assets were unchanged

Teprifer · 2024-09-18T06:47:36Z

A quick test confirms this resolves the 3 variations of the bug. Thanks!

matt-fidd

LGTM

* Fix form submit handlers * Release notes

* marked files for translation * added release note * fixed linting warnings * 🐛 fix account filters being overridden (#3441) *

Reduce package size (#3443) * reduce package size of all packages * release notes * Update beforePackHook.ts * [Maintenance] Cleanup react aria packages and dedupe (#3450) * Cleanup react aria packages and dedupe * Release notes * ♻️ (synced-prefs) moving the prefs from metadata.json to the db (#3423) *

Restart server silently when adding self signed cert and add some logs (#3431) * restart server silently on add self signed cert and add some logging * release notes * fix name * updating names to be more specific * removing setloading * feedback * ♻️ (synced-prefs) move budget type to synced prefs (#3427) * update synced account balance in db if available (#3452) * 🐛 (synced-prefs) fix bulk-reading not working in import modal (#3460) * fix: csv import deduplication (#3456) * ✨ release simplefin as a first-party feature (#3459) Closes #2272 * Do not allow renaming to an empty category or group name (#3463) * Do not allow renaming to an emoty category or group name * Release notes * [Mobile] Fix #3214 - Pull down to refresh triggering clicks on budget cells (#3374) * Fix #3214 * Fix rollover indicator * VRT * Fix typecheck error * VRT * Release notes * VRT * Update style * Fix budgeted * VRT * VRT * Revert VRT * VRT * Fix style * Revert usePreviewTransactions * Fix error * Fix reports form submit handlers (#3462) * Fix form submit handlers * Release notes *

Remove some old updater code (#3468) * remove some old updater code * remove old updater logic * CSV import e2e tests (#3467) * Fix React Aria Button hover styles (#3453) * Fiox hover styles and use className instead of inline to prepare for future css migration * Release notes * Cleanup * Update edit rule hover style * Undoable auto transfer notes + auto notes for cover (#3411) * Undo auto transfer notes + auto notes for cover * Release notes * Fix notes * Fix notes undo * Do not show clicked category on transfer or cover menus * Fix typecheck error * typecheck * Fix removeCategoriesFromGroups * 🐛 (reports) deleting custom report should remove it from the dashboard (#3469) * Revert "CSV import e2e tests (#3467)" (#3474) This reverts commit 5e12d40. * ♻️ (synced-prefs) separate metadata and local prefs out (#3458) *

Replace deprecated file protocol registration (#3475) * replace deprecated file handler in electron * release notes * types eh * types * update sql regexp to default to empty string when field is null (#3480) * ♻️ rename report/rollover budget to tracking/envelope (#3483) * 🐛 (import) fix csv import checkboxes not working (#3478) * Update tooltip and themes with better visibility (#3298) * Update tooltip and themes with better visibility * Rename merge request # into release notes * rename release note * update VRT * tweak light theme * dont put border on autocomplete menus * update VRT * tweak popover style * simplify * update VRT * update VRT --------- Co-authored-by: Dustin Conlon <dustin@dustinconlon.com> Co-authored-by: Dustin Conlon <58367364+VoltaicGRiD@users.noreply.github.com> Co-authored-by: youngcw <calebyoung94@gmail.com> * fix modals on mobile BudgetTable (#3487) * Fix privacy filter (#3472) * Fix privacy filter * Release notes * Coderabbit suggestion * VRT * VRT * Revert VRT * VRT * VRT * VRT * VRT * Delete VRT * VRT * Revert VRT * 🐛 fix custom reports crashing when opening table (#3484) * 🧪 (tests) adding custom report e2e tests (#3493) * ✨ (dashboards) ability to save filters & timeframes on spending widgets (#3432) * marked files for translation * Revert ":bug: fix account filters being overridden (#3441)" This reverts commit 7336bad. * Revert "Revert ":bug: fix account filters being overridden (#3441)"" This reverts commit 5cbadc4. * Revert changes due to failed rebase * removed import of t * fixed lint warning * added PayeeTableRow.tsx * needed changes * bugfix: pluralization * variables adjustments * removed doubled trans --------- Co-authored-by: Matiss Janis Aboltins <matiss@mja.lv> Co-authored-by: Michael Clark <5285928+MikesGlitch@users.noreply.github.com> Co-authored-by: Joel Jeremy Marquez <joeljeremy.marquez@gmail.com> Co-authored-by: Matt Fiddaman <github@m.fiddaman.uk> Co-authored-by: Koen van Staveren <koenvanstaveren@hotmail.com> Co-authored-by: Ryan Bianchi <1435081+qedi-r@users.noreply.github.com> Co-authored-by: Robert Dyer <rdyer@unl.edu> Co-authored-by: Dustin Conlon <dustin@dustinconlon.com> Co-authored-by: Dustin Conlon <58367364+VoltaicGRiD@users.noreply.github.com> Co-authored-by: youngcw <calebyoung94@gmail.com> Co-authored-by: Tim <hello@timsmart.co>

Fix form submit handlers

f28b5ad

actual-github-bot bot changed the title ~~Fix form submit handlers~~ [WIP] Fix form submit handlers Sep 18, 2024

actual-github-bot bot added the 🚧 WIP label Sep 18, 2024

joel-jeremy changed the title ~~[WIP] Fix form submit handlers~~ Fix reports form submit handlers Sep 18, 2024

actual-github-bot bot added 🔍 Ready for review and removed 🚧 WIP labels Sep 18, 2024

Release notes

dd17454

matt-fidd approved these changes Sep 18, 2024

View reviewed changes

actual-github-bot bot added ✅ Approved and removed 🔍 Ready for review labels Sep 18, 2024

joel-jeremy merged commit b3669b3 into master Sep 18, 2024
20 checks passed

actual-github-bot bot added ✨ Merged and removed ✅ Approved labels Sep 18, 2024

joel-jeremy deleted the fix-form-submit-handlers branch September 18, 2024 13:29

a-gradina pushed a commit to a-gradina/actual that referenced this pull request Sep 24, 2024

Fix reports form submit handlers (actualbudget#3462)

257472c

* Fix form submit handlers * Release notes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix reports form submit handlers #3462

Fix reports form submit handlers #3462

joel-jeremy commented Sep 18, 2024

coderabbitai bot commented Sep 18, 2024 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

netlify bot commented Sep 18, 2024 •

edited

Loading

github-actions bot commented Sep 18, 2024 •

edited

Loading

github-actions bot commented Sep 18, 2024 •

edited

Loading

Teprifer commented Sep 18, 2024

matt-fidd left a comment

Fix reports form submit handlers #3462

Fix reports form submit handlers #3462

Conversation

joel-jeremy commented Sep 18, 2024

coderabbitai bot commented Sep 18, 2024 • edited Loading

Walkthrough

Changes

Assessment against linked issues

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

netlify bot commented Sep 18, 2024 • edited Loading

✅ Deploy Preview for actualbudget ready!

github-actions bot commented Sep 18, 2024 • edited Loading

Bundle Stats — desktop-client

github-actions bot commented Sep 18, 2024 • edited Loading

Bundle Stats — loot-core

Teprifer commented Sep 18, 2024

matt-fidd left a comment

Choose a reason for hiding this comment

coderabbitai bot commented Sep 18, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

netlify bot commented Sep 18, 2024 •

edited

Loading

github-actions bot commented Sep 18, 2024 •

edited

Loading

github-actions bot commented Sep 18, 2024 •

edited

Loading