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

Dkhalife/ts/categorytransactions #3959

Merged

Conversation

dkhalife
Copy link

Another small refactor for #1483

Copy link

netlify bot commented Dec 11, 2024

Deploy Preview for actualbudget ready!

Name Link
🔨 Latest commit 63fd7dd
🔍 Latest deploy log https://app.netlify.com/sites/actualbudget/deploys/67590da770adfe00088196c4
😎 Deploy Preview https://deploy-preview-3959.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 11, 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.47 MB → 5.47 MB (+25 B) +0.00%
Changeset
File Δ Size
src/components/mobile/budget/CategoryTransactions.tsx 🆕 +2.92 kB 0 B → 2.92 kB
src/components/mobile/budget/CategoryTransactions.jsx 🔥 -2.89 kB (-100%) 2.89 kB → 0 B
View detailed bundle breakdown

Added

No assets were added

Removed

No assets were removed

Bigger

Asset File Size % Changed
static/js/index.js 3.45 MB → 3.45 MB (+25 B) +0.00%

Smaller

No assets were smaller

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/useAccountPreviewTransactions.js 1.63 kB 0%
static/js/AppliedFilters.js 21.91 kB 0%
static/js/BackgroundImage.js 122.29 kB 0%
static/js/narrow.js 82.99 kB 0%
static/js/wide.js 241.46 kB 0%
static/js/ReportRouter.js 1.52 MB 0%

Copy link
Contributor

github-actions bot commented Dec 11, 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%

@dkhalife dkhalife marked this pull request as ready for review December 11, 2024 04:03
Copy link
Contributor

coderabbitai bot commented Dec 11, 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/src/components/mobile/budget/CategoryTransactions.tsx

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 TypeScript type annotations to the CategoryTransactions component located in CategoryTransactions.tsx. A new type, CategoryTransactionsProps, is defined to enforce that the category prop is of type CategoryEntity and the month prop is a string. The function signature for CategoryTransactions is updated to use this new type for its props. Furthermore, the onOpenTransaction callback function's parameter is explicitly typed as TransactionEntity. The getCategoryMonthFilter function is also modified to include type annotations for its parameters, specifying that category is of type CategoryEntity and month is a string. Additionally, the import statements are updated to include the new types from loot-core/types/models. The overall structure and logic of the component remain unchanged, with the primary focus on enhancing type safety through TypeScript.

Possibly related PRs

Suggested labels

sparkles: Merged

Suggested reviewers

  • MikesGlitch
  • youngcw

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 generate docstrings to generate docstrings for this PR. (Experiment)
  • @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/budget/CategoryTransactions.tsx (3)

28-31: Consider strengthening type constraints

While the types are correctly defined, consider adding more specific constraints:

  • The month prop could use a template literal type to enforce YYYY-MM format
  • Consider marking props as optional if they can be null/undefined
 type CategoryTransactionsProps = {
   category: CategoryEntity;
-  month: string;
+  month: `${number}-${number}`; // YYYY-MM format
 };

Line range hint 137-142: Consider consistent type constraints with props

If you implement the suggested month format type in CategoryTransactionsProps, ensure it's consistently used here as well.

-function getCategoryMonthFilter(category: CategoryEntity, month: string) {
+function getCategoryMonthFilter(category: CategoryEntity, month: `${number}-${number}`) {
   return {
     category: category.id,
     date: { $transform: '$month', $eq: month },
   };
 }

131-131: Remove unnecessary undefined assignment

The explicit undefined assignment to onRefresh prop is unnecessary as omitting the prop would have the same effect.

-        onRefresh={undefined}
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 62d8358 and 63fd7dd.

⛔ Files ignored due to path filters (1)
  • upcoming-release-notes/3959.md is excluded by !**/*.md
📒 Files selected for processing (1)
  • packages/desktop-client/src/components/mobile/budget/CategoryTransactions.tsx (4 hunks)
🔇 Additional comments (3)
packages/desktop-client/src/components/mobile/budget/CategoryTransactions.tsx (3)

14-17: LGTM! Well-structured type imports

The type-only imports are correctly implemented and follow TypeScript best practices.


33-36: LGTM! Proper TypeScript component definition

The component signature is correctly typed with proper prop destructuring.


Line range hint 89-95: Verify the referenced commit's preview transaction handling

The code contains a reference to commit 05e58279 regarding preview transaction handling. Let's verify if all relevant logic has been properly migrated.

✅ Verification successful

Let me gather more information about the preview transaction handling implementation.


Comment about preview transactions can be safely kept

The referenced commit 05e58279 is not accessible, but the codebase analysis reveals that preview transaction handling is well-implemented across the application:

  • The isPreviewId function in loot-core/src/shared/transactions.ts provides a simple check for preview transactions
  • Preview transactions are consistently handled in both mobile and desktop components using this function
  • The current implementation in CategoryTransactions.tsx follows the same pattern as other components (e.g., AccountTransactions.tsx)

The comment can serve as a historical reference without impacting functionality.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check the referenced commit for preview transaction handling
git show 05e58279 | grep -A 10 "preview.*transaction"

# Look for other preview transaction handling in the codebase
rg "isPreviewId|preview.*transaction" --type ts

Length of output: 2907


Script:

#!/bin/bash
# Check the implementation of isPreviewId function
ast-grep --pattern 'export function isPreviewId($_) {
  $$$
}'

# Look for preview transaction handling in mobile/native context
rg -B 2 -A 2 "preview.*transaction.*mobile|preview.*transaction.*native" --type ts

Length of output: 380

Copy link
Contributor

@MikesGlitch MikesGlitch left a comment

Choose a reason for hiding this comment

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

Looks good! Thanks!

@MikesGlitch MikesGlitch merged commit 9e6a486 into actualbudget:master Dec 11, 2024
20 checks passed
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.

2 participants