Skip to content
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

Fix a navigation bug and a crash from the account pages #3932

Merged

Conversation

jfdoming
Copy link
Contributor

@jfdoming jfdoming commented Dec 5, 2024

Fixes #3922
Fixes #3927

Copy link

netlify bot commented Dec 5, 2024

Deploy Preview for actualbudget ready!

Name Link
🔨 Latest commit d160e3c
🔍 Latest deploy log https://app.netlify.com/sites/actualbudget/deploys/67528b2dc6d16700089bdb35
😎 Deploy Preview https://deploy-preview-3932.demo.actualbudget.org
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

Copy link
Contributor

github-actions bot commented Dec 5, 2024

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
10 5.45 MB → 5.45 MB (-525 B) -0.01%
Changeset
File Δ Size
src/components/mobile/accounts/AccountTransactions.tsx 📈 +30 B (+0.39%) 7.43 kB → 7.46 kB
src/components/mobile/transactions/TransactionEdit.jsx 📉 -555 B (-1.59%) 34.1 kB → 33.55 kB
View detailed bundle breakdown

Added

No assets were added

Removed

No assets were removed

Bigger

Asset File Size % Changed
static/js/narrow.js 82.93 kB → 82.96 kB (+30 B) +0.04%

Smaller

Asset File Size % Changed
static/js/index.js 3.44 MB → 3.44 MB (-555 B) -0.02%

Unchanged

Asset File Size % Changed
static/js/indexeddb-main-thread-worker-e59fee74.js 13.5 kB 0%
static/js/workbox-window.prod.es5.js 5.69 kB 0%
static/js/resize-observer.js 18.37 kB 0%
static/js/BackgroundImage.js 122.29 kB 0%
static/js/useAccountPreviewTransactions.js 1.63 kB 0%
static/js/AppliedFilters.js 21.32 kB 0%
static/js/wide.js 241.19 kB 0%
static/js/ReportRouter.js 1.52 MB 0%

Copy link
Contributor

github-actions bot commented Dec 5, 2024

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.32 MB 0%

Changeset

No files were changed

View detailed bundle breakdown

Added

No assets were added

Removed

No assets were removed

Bigger

No assets were bigger

Smaller

No assets were smaller

Unchanged

Asset File Size % Changed
kcab.worker.js 1.32 MB 0%

@jfdoming jfdoming force-pushed the jfdoming/fix-account-nav-bugs branch 3 times, most recently from bd71589 to 9016693 Compare December 5, 2024 14:17
@joel-jeremy
Copy link
Contributor

This issue is tricky because we have to take in consideration the workflow of adding transactions straight from the budget page (through the + Transaction nav button). This PR breaks that workflow.

Steps to test:

  1. Go to Budget page
  2. Click on Transaction nav button
  3. Add a transaction to an account

Expected: The app should take you to the account where you added the transaction
Actual: The app takes you back to the budget page

@joel-jeremy
Copy link
Contributor

I'm also fine with the app just taking me back to the budget page vs the current behavior. But in that case, we should also remove the useNavigate hook entirely since there's no longer a need for it I believe - but that can be always be done in a separate PR.

@jfdoming
Copy link
Contributor Author

jfdoming commented Dec 6, 2024

I'm also fine with the app just taking me back to the budget page vs the current behavior. But in that case, we should also remove the useNavigate hook entirely since there's no longer a need for it I believe - but that can be always be done in a separate PR.

Thanks for the feedback! Was hoping to get this into the current release so I think let's defer that to a future PR. I do think just going back is more intuitive (vs opening the account page) as then the transaction page acts just like a modal.

@jfdoming jfdoming force-pushed the jfdoming/fix-account-nav-bugs branch 6 times, most recently from 75a7312 to a4eab1f Compare December 6, 2024 05:01
@jfdoming
Copy link
Contributor Author

jfdoming commented Dec 6, 2024

/update-vrt

@jfdoming jfdoming force-pushed the jfdoming/fix-account-nav-bugs branch from e750098 to 499790e Compare December 6, 2024 05:15
@jfdoming
Copy link
Contributor Author

jfdoming commented Dec 6, 2024

/update-vrt

@jfdoming jfdoming marked this pull request as ready for review December 6, 2024 06:46
Copy link
Contributor

coderabbitai bot commented Dec 6, 2024

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 eslint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

packages/desktop-client/e2e/page-models/mobile-navigation.js

Oops! Something went wrong! :(

ESLint: 8.57.1

ESLint couldn't find the plugin "eslint-plugin-eslint-plugin".

(The package "eslint-plugin-eslint-plugin" was not found when loaded as a Node module from the directory "/packages/eslint-plugin-actual".)

It's likely that the plugin isn't installed correctly. Try reinstalling by running the following:

npm install eslint-plugin-eslint-plugin@latest --save-dev

The plugin "eslint-plugin-eslint-plugin" was referenced from the config file in "packages/eslint-plugin-actual/.eslintrc.js".

If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team.

Walkthrough

The pull request introduces several changes across multiple files in the mobile client application. A new method, goToUncategorizedPage, is added to the MobileNavigation class, enabling navigation to an uncategorized page. The test suite for mobile transactions is updated to simplify transaction verification and includes two new tests for creating categorized and uncategorized transactions. In the AccountTransactions component, the handling of the accountId prop for the AddTransactionButton is modified to ensure it only passes a valid ID when the account is defined. Additionally, the TransactionEdit component's logic is streamlined to always navigate back to the previous page after saving a transaction, removing conditional navigation based on account changes. Overall, these changes enhance navigation and transaction management within the mobile application.

Assessment against linked issues

Objective Addressed Explanation
Ensure back navigation returns to the uncategorized account (#3922) The changes do not address the back navigation issue.
Fix crash on "Uncategorized transactions" page after adding a transaction (#3927)

Possibly related PRs

Suggested labels

sparkles: Merged

Suggested reviewers

  • youngcw
  • joel-jeremy

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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (3)
packages/desktop-client/src/components/mobile/transactions/TransactionEdit.jsx (3)

Line range hint 539-557: Add validation to prevent saving transactions without an account.

To fix issue #3927 (crash when saving without account), add validation before saving:

  const onSaveInner = useCallback(() => {
    const [unserializedTransaction] = unserializedTransactions;

+   if (!unserializedTransaction.account) {
+     dispatch(
+       pushModal('error', {
+         title: 'Account Required',
+         message: 'Please select an account before saving the transaction.',
+       }),
+     );
+     return;
+   }

    const onConfirmSave = () => {
      let transactionsToSave = unserializedTransactions;
      if (isAdding) {
        transactionsToSave = realizeTempTransactions(unserializedTransactions);
      }

      onSave(transactionsToSave);
      navigate(-1);
    };

Line range hint 32-38: Consider memoizing child components for better performance.

The ChildTransactionEdit component is rendered in a map function. Consider wrapping child components with React.memo or moving them outside the parent component to prevent unnecessary re-renders.


Line range hint 539-557: Add error boundary for transaction operations.

The save operation could fail for various reasons (network issues, validation errors, etc.). Consider wrapping the transaction operations in an error boundary or try-catch block with proper error handling.

  const onSaveInner = useCallback(() => {
+   try {
      const [unserializedTransaction] = unserializedTransactions;
      // ... existing code ...
+   } catch (error) {
+     dispatch(
+       pushModal('error', {
+         title: 'Save Failed',
+         message: 'Failed to save transaction. Please try again.',
+       }),
+     );
+     console.error('Transaction save failed:', error);
+   }
  }, [isAdding, dispatch, navigate, onSave, unserializedTransactions]);

Also applies to: 557-558

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 5e7538f and d160e3c.

⛔ Files ignored due to path filters (10)
  • packages/desktop-client/e2e/transactions.mobile.test.js-snapshots/Mobile-Transactions-creates-a-categorized-transaction-from-accounts-uncategorized-page-1-chromium-linux.png is excluded by !**/*.png
  • packages/desktop-client/e2e/transactions.mobile.test.js-snapshots/Mobile-Transactions-creates-a-categorized-transaction-from-accounts-uncategorized-page-2-chromium-linux.png is excluded by !**/*.png
  • packages/desktop-client/e2e/transactions.mobile.test.js-snapshots/Mobile-Transactions-creates-a-categorized-transaction-from-accounts-uncategorized-page-3-chromium-linux.png is excluded by !**/*.png
  • packages/desktop-client/e2e/transactions.mobile.test.js-snapshots/Mobile-Transactions-creates-a-transaction-via-footer-button-7-chromium-linux.png is excluded by !**/*.png
  • packages/desktop-client/e2e/transactions.mobile.test.js-snapshots/Mobile-Transactions-creates-a-transaction-via-footer-button-8-chromium-linux.png is excluded by !**/*.png
  • packages/desktop-client/e2e/transactions.mobile.test.js-snapshots/Mobile-Transactions-creates-a-transaction-via-footer-button-9-chromium-linux.png is excluded by !**/*.png
  • packages/desktop-client/e2e/transactions.mobile.test.js-snapshots/Mobile-Transactions-creates-an-uncategorized-transaction-from-accounts-uncategorized-page-1-chromium-linux.png is excluded by !**/*.png
  • packages/desktop-client/e2e/transactions.mobile.test.js-snapshots/Mobile-Transactions-creates-an-uncategorized-transaction-from-accounts-uncategorized-page-2-chromium-linux.png is excluded by !**/*.png
  • packages/desktop-client/e2e/transactions.mobile.test.js-snapshots/Mobile-Transactions-creates-an-uncategorized-transaction-from-accounts-uncategorized-page-3-chromium-linux.png is excluded by !**/*.png
  • upcoming-release-notes/3932.md is excluded by !**/*.md
📒 Files selected for processing (4)
  • packages/desktop-client/e2e/page-models/mobile-navigation.js (2 hunks)
  • packages/desktop-client/e2e/transactions.mobile.test.js (2 hunks)
  • packages/desktop-client/src/components/mobile/accounts/AccountTransactions.tsx (1 hunks)
  • packages/desktop-client/src/components/mobile/transactions/TransactionEdit.jsx (2 hunks)
🔇 Additional comments (6)
packages/desktop-client/e2e/page-models/mobile-navigation.js (1)

26-31: LGTM! Well-structured navigation method.

The new goToUncategorizedPage method follows the established pattern of other navigation methods and properly returns a MobileAccountPage instance.

packages/desktop-client/e2e/transactions.mobile.test.js (3)

51-52: LGTM! Simplified transaction verification.

The code has been simplified by directly checking the transaction list count after creation.


83-114: LGTM! Comprehensive test for uncategorized transaction creation.

This test effectively verifies the fix for the navigation bug (Issue #3922) by:

  1. Creating an initial uncategorized transaction
  2. Navigating to the uncategorized page
  3. Creating another transaction
  4. Verifying the transaction appears correctly

116-151: LGTM! Well-structured test for categorized transaction creation.

This test effectively verifies the fix for the crash issue (Issue #3927) by testing the complete flow of creating a categorized transaction from the uncategorized page.

packages/desktop-client/src/components/mobile/accounts/AccountTransactions.tsx (1)

76-78: LGTM! Safe handling of accountId prop.

The change ensures that accountId is only passed when an account exists, preventing the crash described in Issue #3927. This is a robust fix that maintains type safety.

packages/desktop-client/src/components/mobile/transactions/TransactionEdit.jsx (1)

Line range hint 540-557: LGTM: Navigation logic simplified to fix back button issue.

The simplified navigation logic correctly addresses issue #3922 by ensuring consistent back navigation behavior, regardless of account changes.

Copy link
Contributor

@matt-fidd matt-fidd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@matt-fidd matt-fidd merged commit df7bc5d into actualbudget:master Dec 6, 2024
20 checks passed
@jfdoming jfdoming deleted the jfdoming/fix-account-nav-bugs branch December 18, 2024 03:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants