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 misaligned gocardless credential popover #3942

Merged
merged 2 commits into from
Dec 9, 2024

Conversation

MatissJanis
Copy link
Member

Closes #3854

Additionally..

  • made the file strict TS compliant
  • removed the need to use refs and isOpen state handling - since we are now using React-aria buttons - we can leverage the power of DialogTrigger - which removes the need for ref

@actual-github-bot actual-github-bot bot changed the title 🐛 fix misaligned gocardless credential popover [WIP] 🐛 fix misaligned gocardless credential popover Dec 8, 2024
Copy link

netlify bot commented Dec 8, 2024

Deploy Preview for actualbudget ready!

Name Link
🔨 Latest commit f724974
🔍 Latest deploy log https://app.netlify.com/sites/actualbudget/deploys/6755ebf13868ce0008482551
😎 Deploy Preview https://deploy-preview-3942.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 8, 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.45 MB → 5.46 MB (+2.46 kB) +0.04%
Changeset
File Δ Size
node_modules/@react-aria/overlays/dist/useOverlayTrigger.mjs 🆕 +1.79 kB 0 B → 1.79 kB
node_modules/react-aria-components/dist/Dialog.mjs 📈 +1.49 kB (+47.00%) 3.16 kB → 4.65 kB
src/components/modals/CreateAccountModal.tsx 📉 -832 B (-5.65%) 14.38 kB → 13.57 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.44 MB → 3.44 MB (+2.46 kB) +0.07%

Smaller

No assets were smaller

Unchanged

Asset File Size % Changed
static/js/workbox-window.prod.es5.js 5.69 kB 0%
static/js/indexeddb-main-thread-worker-e59fee74.js 13.5 kB 0%
static/js/useAccountPreviewTransactions.js 1.63 kB 0%
static/js/resize-observer.js 18.37 kB 0%
static/js/AppliedFilters.js 21.32 kB 0%
static/js/BackgroundImage.js 122.29 kB 0%
static/js/narrow.js 82.96 kB 0%
static/js/wide.js 241.53 kB 0%
static/js/ReportRouter.js 1.52 MB 0%

Copy link
Contributor

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

@MatissJanis MatissJanis changed the title [WIP] 🐛 fix misaligned gocardless credential popover 🐛 fix misaligned gocardless credential popover Dec 8, 2024
Copy link
Contributor

coderabbitai bot commented Dec 8, 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/modals/CreateAccountModal.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 modifications to two files: CreateAccountModal.tsx and server-handlers.d.ts. In CreateAccountModal.tsx, the DialogTrigger component from react-aria-components is integrated, replacing local state management for menu visibility with a more streamlined approach. The state variables for GoCardless and SimpleFIN setup completion are updated to explicitly define their types as boolean | null. The accessibility features are enhanced by updating aria-label attributes for buttons to utilize a translation function. In server-handlers.d.ts, the ServerHandlers interface is modified to allow the value parameter of the 'secret-set' method to accept string | null, reflecting a change in input handling. These changes aim to improve type safety, accessibility, and the overall functionality of the components involved.

Assessment against linked issues

Objective Addressed Explanation
Fix the alignment issue of the GoCardless reset credentials button (#3854)

Possibly related PRs

Suggested labels

#sparkles: Merged

Suggested reviewers

  • youngcw
  • joel-jeremy

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
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 (1)
packages/desktop-client/src/components/modals/CreateAccountModal.tsx (1)

Line range hint 127-139: Consider optimizing credential reset functions

The current implementation makes sequential API calls to reset credentials. Consider parallelizing these calls for better performance.

Example optimization for onGoCardlessReset:

 const onGoCardlessReset = () => {
-  send('secret-set', {
-    name: 'gocardless_secretId',
-    value: null,
-  }).then(() => {
-    send('secret-set', {
-      name: 'gocardless_secretKey',
-      value: null,
-    }).then(() => {
-      setIsGoCardlessSetupComplete(false);
-    });
-  });
+  Promise.all([
+    send('secret-set', {
+      name: 'gocardless_secretId',
+      value: null,
+    }),
+    send('secret-set', {
+      name: 'gocardless_secretKey',
+      value: null,
+    })
+  ]).then(() => {
+    setIsGoCardlessSetupComplete(false);
+  });
 };

Similar optimization can be applied to onSimpleFinReset.

Also applies to: 140-152

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between e4b40fb and f724974.

⛔ Files ignored due to path filters (1)
  • upcoming-release-notes/3942.md is excluded by !**/*.md
📒 Files selected for processing (2)
  • packages/desktop-client/src/components/modals/CreateAccountModal.tsx (7 hunks)
  • packages/loot-core/src/types/server-handlers.d.ts (1 hunks)
🔇 Additional comments (4)
packages/loot-core/src/types/server-handlers.d.ts (1)

181-181: Verify the impact of the breaking type change

The type signature change from string to string | null for the value parameter aligns with the credential reset functionality. However, we should verify that this breaking change doesn't affect other callers of this method.

✅ Verification successful

Type change for secret-set is safe and already supported by all callers

The type signature change from string to string | null for the value parameter is not a breaking change as all existing callers already handle both cases:

  • GoCardlessInitialiseModal.tsx: Sets string values for credentials
  • CreateAccountModal.tsx: Sets null values during reset operations
  • SimpleFinInitialiseModal.tsx: Sets string values for tokens

The type change actually makes the interface more accurate by reflecting the existing behavior in the codebase.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for all calls to secret-set to verify they handle the new type
ast-grep --pattern 'send("secret-set", { $$$, value: $_$$$ })'

Length of output: 64


Script:

#!/bin/bash
# Let's try a different pattern to find secret-set usage
rg -l "secret-set" 

# Then examine the content of these files
rg "secret-set" -A 2 -B 2

Length of output: 4235

packages/desktop-client/src/components/modals/CreateAccountModal.tsx (3)

33-38: LGTM! Type annotations improve code clarity

The explicit type annotations for state variables enhance type safety and make the code more maintainable.


Line range hint 248-275: Great improvement using DialogTrigger!

The implementation:

  • Fixes the misaligned popover issue
  • Improves accessibility with proper aria-labels
  • Simplifies state management by removing manual isOpen handling

Line range hint 311-334: LGTM! Consistent implementation with GoCardless menu

The SimpleFIN menu follows the same pattern as the GoCardless menu, maintaining consistency in the codebase.

Copy link
Contributor

@matt-fidd matt-fidd left a comment

Choose a reason for hiding this comment

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

LGTM!

@MatissJanis MatissJanis merged commit d649eec into master Dec 9, 2024
20 checks passed
@MatissJanis MatissJanis deleted the matiss/fix-3854 branch December 9, 2024 21:59
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.

[Bug]: GoCardless reset credentials button misaligned
2 participants