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

Add option to unmark imported transactions #3810

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

csenel
Copy link

@csenel csenel commented Nov 9, 2024

Fixes: #3358

As described in the feature request, a tooltip was added for transactions after v24.9.0. However as someone who imports & exports budget files between servers, most of the historical transactions are marked as imported. Furthermore when you duplicate to create a new transaction, the imported payee field is also kept the same.

With this change, I have added an option to the transaction table to unmark imported transactions (set imported_payee field to empty string), which will disable the imported payee tooltip.

Please let me know how it looks. This is my first PR ever working on a typescript code base. Even though I have tested the functionality locally, it's likely that I might have missed some things.

@actual-github-bot actual-github-bot bot changed the title Add support to unmark imported transactions [WIP] Add support to unmark imported transactions Nov 9, 2024
Copy link

netlify bot commented Nov 9, 2024

Deploy Preview for actualbudget ready!

Name Link
🔨 Latest commit d8a459b
🔍 Latest deploy log https://app.netlify.com/sites/actualbudget/deploys/6730acc3c7c2c800082e5bfa
😎 Deploy Preview https://deploy-preview-3810.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 Nov 9, 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.34 MB → 5.35 MB (+1.76 kB) +0.03%
Changeset
File Δ Size
node_modules/es-define-property/index.js 📈 +210 B (+60.00%) 350 B → 560 B
src/components/transactions/SelectedTransactionsButton.tsx 📈 +746 B (+9.22%) 7.9 kB → 8.63 kB
node_modules/has-property-descriptors/index.js 📈 +9 B (+1.57%) 573 B → 582 B
src/components/accounts/Account.tsx 📈 +660 B (+1.45%) 44.32 kB → 44.97 kB
src/hooks/useTransactionBatchActions.ts 📈 +82 B (+1.03%) 7.74 kB → 7.82 kB
node_modules/call-bind/index.js 📈 +9 B (+0.85%) 1.04 kB → 1.05 kB
src/components/accounts/Header.tsx 📈 +80 B (+0.43%) 18.34 kB → 18.42 kB
node_modules/define-data-property/index.js 📈 +9 B (+0.39%) 2.24 kB → 2.25 kB
View detailed bundle breakdown

Added

No assets were added

Removed

No assets were removed

Bigger

Asset File Size % Changed
static/js/wide.js 239.81 kB → 241.26 kB (+1.45 kB) +0.61%
static/js/index.js 3.35 MB → 3.35 MB (+319 B) +0.01%

Smaller

No assets were smaller

Unchanged

Asset File Size % Changed
static/js/workbox-window.prod.es5.js 5.69 kB 0%
static/js/indexeddb-main-thread-worker-e59fee74.js 13.5 kB 0%
static/js/BackgroundImage.js 122.29 kB 0%
static/js/AppliedFilters.js 21.3 kB 0%
static/js/usePreviewTransactions.js 1.64 kB 0%
static/js/resize-observer.js 18.37 kB 0%
static/js/narrow.js 82.57 kB 0%
static/js/ReportRouter.js 1.5 MB 0%

Copy link
Contributor

github-actions bot commented Nov 9, 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.27 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.27 MB 0%

@csenel csenel changed the title [WIP] Add support to unmark imported transactions Add support to unmark imported transactions Nov 9, 2024
Copy link
Contributor

coderabbitai bot commented Nov 9, 2024

Warning

Rate limit exceeded

@csenel has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 20 minutes and 42 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 3764d09 and d8a459b.

Walkthrough

The pull request introduces a new method, onUnmarkTransactionsAsImported, within the AccountInternal class, enabling the unmarking of transactions as imported based on their IDs. This method retrieves relevant transactions, checks for the imported_payee property, and updates the field accordingly. The method is integrated into the Account component's render method and passed as a prop to the AccountHeader component, enhancing the UI's functionality.

Additionally, the AccountHeaderProps type is updated to include the new property onUnmarkTransactionsAsImported, which is utilized in the SelectedTransactionsButton component. This component is modified to manage the unmarking action, including a new memoized function to evaluate the status of selected transactions. The useTransactionBatchActions hook is also updated to handle the imported_payee field, allowing for batch processing of transaction modifications. Overall, these changes enhance transaction management within the application.

Assessment against linked issues

Objective Addressed Explanation
Option to disable imported payee tooltip (#3358) The PR does not implement an option to disable the tooltip as requested.

Possibly related PRs

Suggested labels

:sparkles: Merged

Suggested reviewers

  • youngcw
  • jfdoming

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: 3

🧹 Outside diff range and nitpick comments (2)
packages/desktop-client/src/hooks/useTransactionBatchActions.ts (2)

117-120: Enhance comment and add validation for imported_payee.

While the implementation is correct, consider these improvements:

  1. Make the comment more specific about the impact: "Unmark as imported transaction by setting imported_payee to empty string, which removes the imported tooltip."
  2. Add validation to avoid unnecessary updates when the field is already empty.
 if (name === 'imported_payee') {
-  // Unmark as imported transaction by setting imported payee to empty string.
+  // Unmark as imported transaction by setting imported_payee to empty string,
+  // which removes the imported tooltip.
+  if (trans.imported_payee) {
     valueToSet = '';
+  }
 }

234-235: Consider architectural improvements for better UX.

While the implementation is solid, consider these architectural improvements:

  1. Add a confirmation dialog for bulk unmarking, similar to other batch operations
  2. Add this action to the transaction context menu for single-transaction operations
  3. Consider adding a bulk "Mark as imported" operation for symmetry

Would you like help implementing any of these suggestions?

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 2b72b2f and 3764d09.

⛔ Files ignored due to path filters (1)
  • upcoming-release-notes/3810.md is excluded by !**/*.md
📒 Files selected for processing (4)
  • packages/desktop-client/src/components/accounts/Account.tsx (2 hunks)
  • packages/desktop-client/src/components/accounts/Header.tsx (3 hunks)
  • packages/desktop-client/src/components/transactions/SelectedTransactionsButton.tsx (5 hunks)
  • packages/desktop-client/src/hooks/useTransactionBatchActions.ts (2 hunks)
🧰 Additional context used
🪛 Biome
packages/desktop-client/src/components/transactions/SelectedTransactionsButton.tsx

[error] 158-158: Change to an optional chain.

Unsafe fix: Change to an optional chain.

(lint/complexity/useOptionalChain)

🔇 Additional comments (8)
packages/desktop-client/src/components/transactions/SelectedTransactionsButton.tsx (4)

42-42: LGTM: Prop type definition is well-structured.

The new prop follows the established naming conventions and type patterns in the codebase.


299-306: LGTM: Menu item is well-integrated.

The menu item is properly structured with:

  • Correct placement in the menu
  • Appropriate conditional rendering
  • Proper translation support

335-337: LGTM: Handler implementation is correct.

The new case in the switch statement follows the established pattern and correctly handles the unmark action.


Line range hint 1-361: Verify integration with imported transaction handling.

While the implementation looks good, let's verify the complete flow:

  1. Ensure this component receives the proper callback from its parent
  2. Confirm the tooltip is properly hidden when a transaction is unmarked
✅ Verification successful

Based on the search results, I can now provide a final response since I have enough information to verify the implementation:

Implementation is properly integrated and functional

The code shows proper integration of the unmark imported transactions feature:

  1. The SelectedTransactionsButton component correctly checks for imported transactions using imported_payee field
  2. The feature is properly connected through the component hierarchy:
    • Account.tsx implements the handler onUnmarkTransactionsAsImported
    • Header.tsx passes it down to child components
    • SelectedTransactionsButton.tsx exposes it in the menu when applicable

The implementation aligns with the user needs as it:

  • Only shows the option when there are imported transactions selected
  • Handles batch operations correctly
  • Properly integrates with the undo notification system
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check if the component is properly connected to handle imported transactions
echo "Checking parent components for proper prop passing..."
rg -l "onUnmarkTransactionsAsImported" --type ts --type tsx

# Verify tooltip implementation
echo "Checking tooltip implementation..."
rg "imported_payee.*tooltip" --type ts --type tsx

Length of output: 363


Script:

#!/bin/bash
# Let's try with correct file type flags and broader search patterns
echo "Checking parent components and handlers..."
rg -t typescript -t tsx "onUnmarkTransactionsAsImported"

echo -e "\nChecking tooltip and imported payee related code..."
rg -t typescript -t tsx "imported_payee"

echo -e "\nChecking transaction list component..."
rg -t typescript -t tsx "SelectedTransactionsButton.*props"

Length of output: 571


Script:

#!/bin/bash
# Search without file type flags since they're not recognized
echo "Checking parent components and handlers..."
rg "onUnmarkTransactionsAsImported"

echo -e "\nChecking imported payee related code..."
rg "imported_payee"

echo -e "\nChecking TransactionList component..."
fd "TransactionList" --exec cat {} \; 

Length of output: 43327

🧰 Tools
🪛 Biome

[error] 158-158: Change to an optional chain.

Unsafe fix: Change to an optional chain.

(lint/complexity/useOptionalChain)

packages/desktop-client/src/components/accounts/Header.tsx (3)

116-116: LGTM! Type definition is correctly added.

The onUnmarkTransactionsAsImported property is properly integrated into the AccountHeaderProps type definition, maintaining type safety by inheriting from the SelectedTransactionsButton component.


183-183: LGTM! Prop destructuring is properly implemented.

The onUnmarkTransactionsAsImported prop is correctly destructured from the component props, following the established pattern in the codebase.


372-372: LGTM! Prop is correctly passed to child component.

The onUnmarkTransactionsAsImported prop is properly passed to the SelectedTransactionsButton component, enabling the unmarking of imported transactions as intended.

Let's verify the integration with the SelectedTransactionsButton component:

✅ Verification successful

Prop is correctly integrated and handled in the SelectedTransactionsButton component

The verification confirms:

  • The prop is properly typed in SelectedTransactionsButton component's props interface
  • The prop is correctly destructured in the component parameters
  • The prop is properly invoked with selectedIds when needed
  • The implementation follows a complete chain from Account component through Header to SelectedTransactionsButton
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the SelectedTransactionsButton component accepts and handles the new prop

# Test: Check if SelectedTransactionsButton component properly declares the prop
ast-grep --pattern 'type $_ = {
  $$$
  onUnmarkTransactionsAsImported?: $_
  $$$
}'

# Test: Check if the component implements the unmarking functionality
rg -A 5 'onUnmarkTransactionsAsImported'

Length of output: 5069

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

1778-1780: LGTM!

The prop is correctly passed to the AccountHeader component, following the existing naming conventions and integration patterns.

@csenel csenel changed the title Add support to unmark imported transactions Add option to unmark imported transactions Nov 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Feature]: Option to disable imported payee tooltip
1 participant