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 privacy filter #3472

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

Fix privacy filter #3472

wants to merge 7 commits into from

Conversation

joel-jeremy
Copy link
Contributor

No description provided.

@actual-github-bot actual-github-bot bot changed the title Fix privacy filter [WIP] Fix privacy filter Sep 20, 2024
Copy link

coderabbitai bot commented Sep 20, 2024

Important

Review skipped

Review was skipped due to path filters

Files ignored due to path filters (10)
  • packages/desktop-client/e2e/accounts.test.js-snapshots/Accounts-Import-Transactions-import-csv-file-twice-1-chromium-linux.png is excluded by !**/*.png
  • packages/desktop-client/e2e/accounts.test.js-snapshots/Accounts-Import-Transactions-import-csv-file-twice-2-chromium-linux.png is excluded by !**/*.png
  • packages/desktop-client/e2e/accounts.test.js-snapshots/Accounts-Import-Transactions-import-csv-file-twice-3-chromium-linux.png is excluded by !**/*.png
  • packages/desktop-client/e2e/accounts.test.js-snapshots/Accounts-Import-Transactions-imports-transactions-from-a-CSV-file-1-chromium-linux.png is excluded by !**/*.png
  • packages/desktop-client/e2e/accounts.test.js-snapshots/Accounts-Import-Transactions-imports-transactions-from-a-CSV-file-2-chromium-linux.png is excluded by !**/*.png
  • packages/desktop-client/e2e/accounts.test.js-snapshots/Accounts-Import-Transactions-imports-transactions-from-a-CSV-file-3-chromium-linux.png is excluded by !**/*.png
  • packages/desktop-client/e2e/mobile.test.js-snapshots/Mobile-creates-a-transaction-from-accounts-id-page-2-chromium-linux.png is excluded by !**/*.png
  • packages/desktop-client/e2e/mobile.test.js-snapshots/Mobile-creates-a-transaction-from-accounts-id-page-3-chromium-linux.png is excluded by !**/*.png
  • packages/desktop-client/e2e/mobile.test.js-snapshots/Mobile-creates-a-transaction-via-footer-button-2-chromium-linux.png is excluded by !**/*.png
  • packages/desktop-client/e2e/mobile.test.js-snapshots/Mobile-loads-the-budget-page-with-budgeted-amounts-2-chromium-linux.png is excluded by !**/*.png

CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including **/dist/** will override the default block on the dist directory.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The pull request introduces several changes across multiple components in the desktop client. Key modifications include the removal of the PrivacyFilter component from the Balance.jsx file, the transition from inline styles to a CSS-in-JS approach using the glamor library in various budget-related components, and the addition of a PrivacyFilter component in the CellValue.tsx file that conditionally affects the display of cell values based on their type.

Changes

File Path Change Summary
packages/desktop-client/src/components/accounts/Balance.jsx Removed the PrivacyFilter component wrapping CellValueText, maintaining its props and styling.
packages/desktop-client/src/components/budget/BalanceWithCarryover.tsx
packages/desktop-client/src/components/budget/report/ReportComponents.tsx
packages/desktop-client/src/components/budget/rollover/RolloverComponents.tsx
Replaced inline style prop with className using glamor for styling in various components, enhancing separation of concerns and improving modularity.
packages/desktop-client/src/components/spreadsheet/CellValue.tsx Introduced a new PrivacyFilter component to CellValueText, affecting how values are displayed based on their type.

Possibly related PRs

  • Fix React Aria Button hover styles  #3453: This PR involves a transition from inline styles to a CSS-in-JS approach using the glamor library, similar to the changes in the main PR, indicating a related effort to improve maintainability and readability in the codebase.

Suggested labels

sparkles: Merged


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

netlify bot commented Sep 20, 2024

Deploy Preview for actualbudget ready!

Name Link
🔨 Latest commit d8267f7
🔍 Latest deploy log https://app.netlify.com/sites/actualbudget/deploys/66ed4169aaf4520008547e54
😎 Deploy Preview https://deploy-preview-3472.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 Sep 20, 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
9 5.28 MB → 5.28 MB (+167 B) +0.00%
Changeset
File Δ Size
src/components/spreadsheet/CellValue.tsx 📈 +231 B (+26.61%) 868 B → 1.07 kB
src/components/budget/BalanceWithCarryover.tsx 📈 +19 B (+0.31%) 6.04 kB → 6.06 kB
src/components/budget/rollover/RolloverComponents.tsx 📈 +38 B (+0.26%) 14.02 kB → 14.06 kB
src/components/budget/report/ReportComponents.tsx 📈 +19 B (+0.14%) 12.96 kB → 12.98 kB
src/components/accounts/Balance.jsx 📉 -140 B (-2.46%) 5.57 kB → 5.43 kB
View detailed bundle breakdown

Added

No assets were added

Removed

No assets were removed

Bigger

Asset File Size % Changed
static/js/index.js 3.31 MB → 3.31 MB (+307 B) +0.01%

Smaller

Asset File Size % Changed
static/js/wide.js 225.37 kB → 225.23 kB (-140 B) -0.06%

Unchanged

Asset File Size % Changed
static/js/indexeddb-main-thread-worker-e59fee74.js 13.5 kB 0%
static/js/resize-observer.js 18.37 kB 0%
static/js/usePreviewTransactions.js 1.59 kB 0%
static/js/BackgroundImage.js 122.29 kB 0%
static/js/AppliedFilters.js 20.97 kB 0%
static/js/narrow.js 80.95 kB 0%
static/js/ReportRouter.js 1.5 MB 0%

Copy link
Contributor

github-actions bot commented Sep 20, 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.19 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.19 MB 0%

Copy link

@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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between e6bf6da and 523c4b0.

Files ignored due to path filters (1)
  • upcoming-release-notes/3472.md is excluded by !**/*.md
Files selected for processing (5)
  • packages/desktop-client/src/components/accounts/Balance.jsx (1 hunks)
  • packages/desktop-client/src/components/budget/BalanceWithCarryover.tsx (2 hunks)
  • packages/desktop-client/src/components/budget/report/ReportComponents.tsx (2 hunks)
  • packages/desktop-client/src/components/budget/rollover/RolloverComponents.tsx (3 hunks)
  • packages/desktop-client/src/components/spreadsheet/CellValue.tsx (2 hunks)
Files skipped from review due to trivial changes (1)
  • packages/desktop-client/src/components/accounts/Balance.jsx
Additional comments not posted (9)
packages/desktop-client/src/components/spreadsheet/CellValue.tsx (3)

96-96: LGTM!

The rendering logic within the PrivacyFilter component is correct, and the formatting of the cell value remains unchanged.


91-95: Verify the PrivacyFilter component's implementation.

Ensure that the PrivacyFilter component correctly handles the activationFilters prop and applies the privacy filtering logic based on the provided conditions.

Run the following script to verify the component's implementation:

#!/bin/bash
# Description: Verify the `PrivacyFilter` component's implementation.

# Test: Check if the `PrivacyFilter` component correctly handles the `activationFilters` prop. Expect: The component to apply filtering based on the provided conditions.
ast-grep --lang typescript --pattern $'export function PrivacyFilter({ activationFilters, children }) {
  $$$
  if (activationFilters.some($_)) {
    $$$
  }
  $$$
}'

6-6: Verify the PrivacyFilter component.

Ensure that the PrivacyFilter component is correctly defined and exported in the ../PrivacyFilter file.

Run the following script to verify the component:

Verification successful

PrivacyFilter component verified successfully.

The PrivacyFilter component is correctly defined and exported in the ../PrivacyFilter.tsx file. The import statement in CellValue.tsx is valid and will work as expected.

  • The component is defined at packages/desktop-client/src/components/PrivacyFilter.tsx
  • It's exported as a named function: export function PrivacyFilter({ ... }) { ... }
  • The component implementation looks correct, with proper props and logic
Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the `PrivacyFilter` component is correctly defined and exported.

# Test: Check if the `PrivacyFilter` component is defined and exported. Expect: A component definition.
ast-grep --lang typescript --pattern $'export function PrivacyFilter($_) {
  $$$
}'

Length of output: 167


Script:

#!/bin/bash
# Description: Verify the existence and export of the PrivacyFilter component

# Test 1: Search for any export of PrivacyFilter
echo "Searching for PrivacyFilter export:"
ast-grep --lang typescript --pattern 'export $_ PrivacyFilter'

# Test 2: Locate the PrivacyFilter file
echo -e "\nLocating PrivacyFilter file:"
fd PrivacyFilter.tsx

# Test 3: If PrivacyFilter file is found, display its contents
echo -e "\nContents of PrivacyFilter file (if found):"
fd PrivacyFilter.tsx -x cat {}

Length of output: 4744

packages/desktop-client/src/components/budget/BalanceWithCarryover.tsx (2)

9-10: LGTM!

The import statement for the css function from the glamor library is valid and follows the correct syntax. Using CSS-in-JS libraries like glamor can provide a more modular and maintainable approach to styling React components.


182-193: Looks good!

The transition from inline styles to a CSS-in-JS approach using the glamor library for the CellValueText component is a positive change. It improves the separation of concerns between styling and component logic.

The styles are correctly defined using the css function and include the necessary properties such as overflow, textOverflow, textAlign, a conditional cursor style based on the disabled prop, and a hover effect. The syntax follows the expected format for the glamor library.

packages/desktop-client/src/components/budget/report/ReportComponents.tsx (2)

5-6: LGTM!

Importing the css function from the glamor library is a valid approach for CSS-in-JS styling in React components. This change aligns with the modular and reusable styling practices.


372-380: Refactoring to CSS-in-JS is a good approach.

The change from inline styles to CSS-in-JS using the glamor library is a valid refactoring approach. It promotes a more modular and reusable styling pattern while maintaining the same visual behavior.

The styles applied using the css function, including the pointer cursor, hover underline, and the result of makeAmountGrey, achieve the same styling effects as the original inline styles.

This change aligns with best practices for styling React components.

packages/desktop-client/src/components/budget/rollover/RolloverComponents.tsx (2)

364-370: LGTM!

The refactor from inline styles to CSS-in-JS using glamor looks good. It improves maintainability and consistency without altering the component's behavior.


479-484: LGTM!

The refactor from inline styles to CSS-in-JS using glamor looks good. It improves maintainability and consistency without altering the component's behavior.

@joel-jeremy joel-jeremy changed the title [WIP] Fix privacy filter Fix privacy filter Sep 20, 2024
MikesGlitch
MikesGlitch previously approved these changes Sep 20, 2024
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.

Can confirm it's fixed. LGTM

@youngcw youngcw added this to the v24.10.0 milestone Sep 20, 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.

3 participants