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

enhance: net bar graph show net instead of two separate bars #4033

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

UnderKoen
Copy link
Member

Changed the net total bar graph to:
image

Before:
image

@actual-github-bot actual-github-bot bot changed the title enhance: net bar graph show net instead of two separate bars [WIP] enhance: net bar graph show net instead of two separate bars Dec 24, 2024
Copy link

netlify bot commented Dec 24, 2024

Deploy Preview for actualbudget ready!

Name Link
🔨 Latest commit 55bfd84
🔍 Latest deploy log https://app.netlify.com/sites/actualbudget/deploys/676ae6c808c0d700087e72ec
😎 Deploy Preview https://deploy-preview-4033.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

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.64 MB → 5.64 MB (-440 B) -0.01%
Changeset
File Δ Size
src/components/reports/spreadsheets/calculateLegend.ts 📈 +363 B (+49.32%) 736 B → 1.07 kB
src/components/reports/graphs/BarGraph.tsx 📉 -803 B (-8.86%) 8.86 kB → 8.07 kB
View detailed bundle breakdown

Added

No assets were added

Removed

No assets were removed

Bigger

No assets were bigger

Smaller

Asset File Size % Changed
static/js/ReportRouter.js 1.58 MB → 1.58 MB (-440 B) -0.03%

Unchanged

Asset File Size % Changed
static/js/indexeddb-main-thread-worker-e59fee74.js 13.5 kB 0%
static/js/useAccountPreviewTransactions.js 1.63 kB 0%
static/js/workbox-window.prod.es5.js 5.69 kB 0%
static/js/AppliedFilters.js 10.24 kB 0%
static/js/resize-observer.js 18.37 kB 0%
static/js/BackgroundImage.js 122.29 kB 0%
static/js/narrow.js 83.36 kB 0%
static/js/wide.js 104.11 kB 0%
static/js/index.js 3.71 MB 0%

Copy link
Contributor

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%

@UnderKoen UnderKoen changed the title [WIP] enhance: net bar graph show net instead of two separate bars enhance: net bar graph show net instead of two separate bars Dec 24, 2024
Copy link
Contributor

coderabbitai bot commented Dec 24, 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/reports/spreadsheets/calculateLegend.ts

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 modifications to two files in the desktop client's reporting components: BarGraph.tsx and calculateLegend.ts. In BarGraph.tsx, the getVal function has been simplified by removing a specific conditional check related to balanceTypeOp and groupBy. The rendering logic for the Bar component has also been streamlined, eliminating a nested rendering condition for totalDebts.

In calculateLegend.ts, a new internal getColor function was added to centralize the color determination logic for legend items. The chooseData mapping was updated to include the original data item, and the color selection process was refactored to use the new getColor function instead of inline conditional statements. These changes aim to simplify and improve the data representation and color assignment in the reporting graphs.

Possibly related PRs

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. We would love to hear your feedback on Discord.


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. (Beta)
  • @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

🧹 Nitpick comments (1)
packages/desktop-client/src/components/reports/spreadsheets/calculateLegend.ts (1)

28-50: Centralize and streamline color logic
This getColor function neatly encapsulates color-based decision-making. However, consider these refinements:

  1. Reduce code duplication – Lines 43 & 46 both return theme.reportsBlue. Combine them for conciseness.
  2. Future-proofing – If balanceTypeOp gains more options, consider using a lookup table or mapping structure for color mapping instead of multiple if statements.
  3. Validation – Defensive checks on data.totalTotals could be helpful if there's any risk of undefined or null values.

Possible minor refactor example:

function getColor(data: IntervalEntity, index: number) {
  if (graphType === 'DonutGraph') {
    return colorScale[index % colorScale.length];
  }

  if (groupBy === 'Interval') {
    if (balanceTypeOp === 'totalDebts') {
      return theme.reportsRed;
    }

    if (balanceTypeOp === 'totalTotals') {
      if (data?.totalTotals < 0) {
        return theme.reportsRed;
      }
      return theme.reportsBlue;
    }

-   return theme.reportsBlue;
  }

  return colorScale[index % colorScale.length];
}
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 93262e7 and 55bfd84.

⛔ Files ignored due to path filters (1)
  • upcoming-release-notes/4033.md is excluded by !**/*.md
📒 Files selected for processing (2)
  • packages/desktop-client/src/components/reports/graphs/BarGraph.tsx (0 hunks)
  • packages/desktop-client/src/components/reports/spreadsheets/calculateLegend.ts (1 hunks)
💤 Files with no reviewable changes (1)
  • packages/desktop-client/src/components/reports/graphs/BarGraph.tsx
🔇 Additional comments (3)
packages/desktop-client/src/components/reports/spreadsheets/calculateLegend.ts (3)

25-25: Maintain consistent data storage practice
Similar to the previous return statement, ensure that returning the entire GroupedEntity object as data does not introduce extra overhead or potential data leakage.


56-56: Well-defined color usage
Using the new getColor function for each legend item is a straightforward approach. This helps keep color logic in one place, making maintenance simpler.


22-22: Check for potential overexposure of data
Storing the entire IntervalEntity object as data in the legend is convenient for debugging and future expansions. However, ensure there's no sensitive or excessive data that might impact performance or expose PII.

Do you want to confirm that no sensitive fields exist on IntervalEntity objects? If so, here’s a script that attempts to find any references to possibly sensitive fields in the codebase:

✅ Verification successful

No sensitive data exposure found in IntervalEntity

Based on the search results, I can see the complete definition of IntervalEntity type in packages/loot-core/src/types/models/reports.d.ts. The type only contains financial metrics and date fields:

export type IntervalEntity = {
  date?: string;
  change?: number;
  intervalStartDate?: string;
  intervalEndDate?: string;
  totalAssets: number;
  totalDebts: number;
};

None of these fields contain sensitive or personally identifiable information (PII). The data is purely numerical and temporal, representing financial aggregates and time intervals, which is appropriate for reporting purposes.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Searching for specific sensitive field names (like password, token, etc.) within IntervalEntity references
rg -A 5 "IntervalEntity" 

Length of output: 7450

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.

1 participant