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

Convert useSplitsExpanded.jsx to tsx #3894

Closed
wants to merge 2 commits into from
Closed

Conversation

joel-jeremy
Copy link
Contributor

No description provided.

@actual-github-bot actual-github-bot bot changed the title Convert useSplitsExpanded.jsx to tsx [WIP] Convert useSplitsExpanded.jsx to tsx Nov 25, 2024
Copy link

netlify bot commented Nov 25, 2024

Deploy Preview for actualbudget ready!

Name Link
🔨 Latest commit a767d99
🔍 Latest deploy log https://app.netlify.com/sites/actualbudget/deploys/67587c743ab5800008c171b8
😎 Deploy Preview https://deploy-preview-3894.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.

@joel-jeremy joel-jeremy changed the title [WIP] Convert useSplitsExpanded.jsx to tsx Convert useSplitsExpanded.jsx to tsx Nov 25, 2024
Copy link
Contributor

github-actions bot commented Nov 25, 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 (+249 B) +0.00%
Changeset
File Δ Size
src/hooks/useSplitsExpanded.tsx 🆕 +3 kB 0 B → 3 kB
node_modules/es-define-property/index.js 📈 +210 B (+60.00%) 350 B → 560 B
node_modules/has-property-descriptors/index.js 📈 +9 B (+1.57%) 573 B → 582 B
node_modules/call-bind/index.js 📈 +9 B (+0.85%) 1.04 kB → 1.05 kB
node_modules/define-data-property/index.js 📈 +9 B (+0.39%) 2.24 kB → 2.25 kB
src/components/transactions/TransactionsTable.jsx 📈 +6 B (+0.01%) 66.54 kB → 66.55 kB
src/hooks/useSplitsExpanded.jsx 🔥 -3 kB (-100%) 3 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 (+237 B) +0.01%
static/js/wide.js 241.29 kB → 241.3 kB (+12 B) +0.00%

Smaller

No assets were smaller

Unchanged

Asset File Size % Changed
static/js/resize-observer.js 18.37 kB 0%
static/js/useAccountPreviewTransactions.js 1.63 kB 0%
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/narrow.js 82.99 kB 0%
static/js/BackgroundImage.js 122.29 kB 0%
static/js/AppliedFilters.js 21.91 kB 0%
static/js/ReportRouter.js 1.52 MB 0%

Copy link
Contributor

github-actions bot commented Nov 25, 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%

Copy link
Contributor

coderabbitai bot commented Nov 25, 2024

Warning

Rate limit exceeded

@joel-jeremy has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 29 minutes and 1 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 f764bf9 and a767d99.

⛔ Files ignored due to path filters (1)
  • upcoming-release-notes/3894.md is excluded by !**/*.md
📒 Files selected for processing (3)
  • packages/desktop-client/src/components/transactions/TransactionsTable.jsx (3 hunks)
  • packages/desktop-client/src/hooks/useSplitsExpanded.jsx (0 hunks)
  • packages/desktop-client/src/hooks/useSplitsExpanded.tsx (1 hunks)

Walkthrough

This pull request introduces significant modifications to the handling of expanded transaction splits within the TransactionTable component, specifically in the TransactionsTable.jsx file. The method for determining whether a transaction is expanded has been updated from splitsExpanded.expanded to splitsExpanded.isExpanded. This change necessitates adjustments in the component's props, particularly in how the isExpanded prop is utilized, ensuring that the filtering of transactions correctly reflects the new state determination method.

Additionally, the request includes the deletion of the useSplitsExpanded.jsx file, which previously managed the expanded state of splits through a React context and custom hook. A new file, useSplitsExpanded.tsx, has been introduced, providing a more structured approach to managing the expanded state with types for actions and context values. This new implementation encapsulates the logic for handling state transitions and user interactions, while also integrating with Redux for state management.

Possibly related PRs

Suggested labels

:sparkles: Merged

Suggested reviewers

  • matt-fidd
  • MikesGlitch

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

🧹 Outside diff range and nitpick comments (4)
packages/desktop-client/src/components/transactions/TransactionsTable.jsx (2)

Line range hint 1-2595: Update file extension to .tsx

Since this PR is about converting to TypeScript, the file extension should be changed from .jsx to .tsx to properly indicate it's a TypeScript React component file.


Migration from expanded to isExpanded is incomplete

The implementation in useSplitsExpanded.tsx only exports and defines the isExpanded method, but there's still one usage of the old expanded method in TransactionsTable.jsx. This indicates an incomplete migration that needs to be fixed:

  • packages/desktop-client/src/components/transactions/TransactionsTable.jsx: Replace prevSplitsExpanded.current.expanded(t.parent_id) with prevSplitsExpanded.current.isExpanded(t.parent_id) to maintain consistency with the new API.
🔗 Analysis chain

Line range hint 2105-2124: Verify consistent usage of isExpanded method

The change from splitsExpanded.expanded to splitsExpanded.isExpanded appears to be part of a method name migration. While the changes look correct, there are a few points to verify:

  1. Ensure all other usages of expanded have been migrated to isExpanded
  2. Verify that the behavior remains the same between the old and new method names

Let me gather more context about the splitsExpanded implementation to understand if this is a legitimate coexistence of both method names or an incomplete migration.


Let me check the implementation in the useSplitsExpanded hook to understand if this is a transition period where both methods are valid or if there's an inconsistency.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for any remaining usages of the old method name and verify the new method usage

# Check for any remaining .expanded calls that might have been missed
rg "\.expanded\(" 

# Check all usages of the new isExpanded method to ensure consistent usage
rg "\.isExpanded\("

Length of output: 448


Script:

#!/bin/bash
# Let's find the implementation of splitsExpanded to understand the methods
ast-grep --pattern 'class $_ {
  $$$
  expanded($_) {
    $$$
  }
  $$$
}'

ast-grep --pattern 'class $_ {
  $$$
  isExpanded($_) {
    $$$
  }
  $$$
}'

# Also check for any potential interface or type definitions
rg "interface.*Expanded" -A 5
rg "type.*Expanded" -A 5

Length of output: 3706


Script:

#!/bin/bash
# Check the implementation in useSplitsExpanded.tsx
cat packages/desktop-client/src/hooks/useSplitsExpanded.tsx

Length of output: 4182

packages/desktop-client/src/hooks/useSplitsExpanded.tsx (2)

81-81: Simplify Set copying by directly passing the Set to the constructor

When creating a new Set from an existing one, you can pass the existing Set directly to the Set constructor instead of spreading it into an array. This approach is more concise and efficient.

Apply this diff to simplify the code:

- const ids = new Set([...state.ids]);
+ const ids = new Set(state.ids);

Also applies to: 91-91, 101-101, 129-129


155-162: Ensure cleanup of the setTimeout to prevent potential memory leaks

The setTimeout in the useEffect hook is not being cleared if the component unmounts before the timeout completes. While the timeout duration is short, it's good practice to clear timers in useEffect hooks to prevent potential memory leaks.

Apply this diff to include the cleanup:

 useEffect(() => {
+  let timer: ReturnType<typeof setTimeout> | undefined;
   if (state.transitionId != null) {
     // This timeout allows animations to finish
-    setTimeout(() => {
+    timer = setTimeout(() => {
       dispatch({ type: 'finish-switch-mode' });
     }, 250);
   }
+  return () => {
+    if (timer !== undefined) {
+      clearTimeout(timer);
+    }
+  };
 }, [state.transitionId]);
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between c25e3d4 and f764bf9.

⛔ Files ignored due to path filters (1)
  • upcoming-release-notes/3894.md is excluded by !**/*.md
📒 Files selected for processing (3)
  • packages/desktop-client/src/components/transactions/TransactionsTable.jsx (3 hunks)
  • packages/desktop-client/src/hooks/useSplitsExpanded.jsx (0 hunks)
  • packages/desktop-client/src/hooks/useSplitsExpanded.tsx (1 hunks)
💤 Files with no reviewable changes (1)
  • packages/desktop-client/src/hooks/useSplitsExpanded.jsx
🔇 Additional comments (1)
packages/desktop-client/src/components/transactions/TransactionsTable.jsx (1)

2595-2595: LGTM: Consistent prop passing

The isExpanded prop correctly passes the new method name, maintaining consistency with the changes made above.

useEffect(() => {
// In a finished state, cache the state
if (state.transitionId == null) {
reduxDispatch({ type: 'SET_LAST_SPLIT_STATE', splitState: state });
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Avoid storing non-serializable values in Redux state

The ids property in state is a Set, which is not serializable by default. Storing non-serializable values in Redux can lead to issues with debugging and persistence. Consider converting the Set to an Array before dispatching it to the Redux store.

Apply this diff to serialize the ids when caching the state:

 reduxDispatch({
   type: 'SET_LAST_SPLIT_STATE',
   splitState: {
     ...state,
-    ids: state.ids,
+    ids: Array.from(state.ids),
   },
 });

Also, update the initial state to convert the ids array back to a Set:

 const [state, dispatch] = useReducer<typeof splitsExpandedReducer>(
   splitsExpandedReducer,
-  cachedState.current || { ids: new Set(), mode: initialMode },
+  cachedState.current
+    ? {
+        ...cachedState.current,
+        ids: new Set(cachedState.current.ids),
+      }
+    : { ids: new Set(), mode: initialMode },
 );

Committable suggestion skipped: line range outside the PR's diff.

@joel-jeremy
Copy link
Contributor Author

Closing this in favor of #3945

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant