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

🔥 remove unused permissions prop from Button components #4085

Merged
merged 1 commit into from
Jan 7, 2025

Conversation

MatissJanis
Copy link
Member

If we wish to add this functionality back - please add it on the consumer level instead of the Button component.

i.e.

<Button isDisabled={hasPermission("something")} />

@actual-github-bot actual-github-bot bot changed the title 🔥 remove unused permissions prop from Button components [WIP] 🔥 remove unused permissions prop from Button components Jan 4, 2025
Copy link

netlify bot commented Jan 4, 2025

Deploy Preview for actualbudget ready!

Name Link
🔨 Latest commit b2e5c09
🔍 Latest deploy log https://app.netlify.com/sites/actualbudget/deploys/6779353a64d68900088e3891
😎 Deploy Preview https://deploy-preview-4085.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 Jan 4, 2025

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 (-220 B) -0.00%
Changeset
File Δ Size
src/components/common/Button.tsx 📉 -101 B (-2.06%) 4.78 kB → 4.68 kB
src/components/common/Button2.tsx 📉 -119 B (-2.29%) 5.08 kB → 4.97 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/index.js 3.71 MB → 3.71 MB (-220 B) -0.01%

Unchanged

Asset File Size % Changed
static/js/resize-observer.js 18.37 kB 0%
static/js/workbox-window.prod.es5.js 5.69 kB 0%
static/js/AppliedFilters.js 10.24 kB 0%
static/js/useAccountPreviewTransactions.js 1.63 kB 0%
static/js/indexeddb-main-thread-worker-e59fee74.js 13.5 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/ReportRouter.js 1.58 MB 0%

Copy link
Contributor

github-actions bot commented Jan 4, 2025

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.33 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.33 MB 0%

@MatissJanis MatissJanis changed the title [WIP] 🔥 remove unused permissions prop from Button components 🔥 remove unused permissions prop from Button components Jan 4, 2025
Copy link
Contributor

coderabbitai bot commented Jan 4, 2025

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/common/Button.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 involves modifications to two button components, Button.tsx and Button2.tsx, located in the desktop client package. The changes primarily focus on removing permission-related logic and imports from these components. Specifically, the permission prop has been deleted from the ButtonProps type definition in both files. The useAuth hook and Permissions type imports have been removed, and the associated permission-checking mechanisms have been eliminated. As a result, the button components' disabled state is now directly controlled by the disabled prop without any additional permission-based restrictions. These modifications simplify the button components' implementation by removing the previous permission-based conditional logic.


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 832fd1e and b2e5c09.

⛔ Files ignored due to path filters (1)
  • upcoming-release-notes/4085.md is excluded by !**/*.md
📒 Files selected for processing (2)
  • packages/desktop-client/src/components/common/Button.tsx (1 hunks)
  • packages/desktop-client/src/components/common/Button2.tsx (1 hunks)
🔇 Additional comments (2)
packages/desktop-client/src/components/common/Button2.tsx (1)

141-141: Removal of permission prop logic is consistent with the PR objective
This revised spread syntax no longer includes a permission prop, matching the stated PR goal of removing unused permission-based functionality. The code is now simpler, and permission checking is rightly delegated to the component consumer.

Feel free to run this script to confirm there are no remaining references to the removed prop in other parts of the codebase:

✅ Verification successful

Let me verify if there are any remaining references to the permission prop specifically in the Button component or its usages.


Let me try a different approach to verify the Button component's permission prop removal.


Let me try one final verification approach.


Removal of permission prop is confirmed and correctly implemented
Based on the verification, the Button2.tsx component's interface ButtonProps and implementation show no traces of the permission prop. While some files that import Button2 do contain permission-related code, these are for user authentication purposes and not related to the Button component's props. The removal aligns with the PR's objective and maintains the component's intended functionality.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify that 'permission' references have been removed from the codebase.
rg -i 'permission' 

Length of output: 4837


Script:

#!/bin/bash
# Search for Button component usages with permission prop
rg -i "Button.*permission" 

# Search for permission prop in Button component files
fd -e tsx -e ts "Button" --exec rg -l "permission.*prop"

Length of output: 85


Script:

#!/bin/bash
# Search for Button component definition and its props
ast-grep --pattern 'interface ButtonProps {
  $$$
}'

# Also check for any direct Button usages with permission
rg -B 2 -A 2 '<Button.*permission'

Length of output: 91


Script:

#!/bin/bash
# Look for Button2.tsx file and show its content
fd -e tsx "Button2" --exec cat {}

# Search for any Button imports and usages with permission
rg -l "from.*Button2" | xargs rg -l "permission"

Length of output: 6728

packages/desktop-client/src/components/common/Button.tsx (1)

189-189: Directly assigning disabled aligns with consumer-driven control
Migrating the responsibility of permission handling to the consuming component is a clean approach and aligns with the PR’s objective. This ensures the button remains a generic UI element, removing unnecessary domain logic.


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.

@MatissJanis MatissJanis merged commit 1f21550 into master Jan 7, 2025
20 checks passed
@MatissJanis MatissJanis deleted the matiss/cleanup-button branch January 7, 2025 18:25
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