Skip to content
This repository has been archived by the owner on Feb 10, 2025. It is now read-only.

dynamically load GoCardless handlers #557

Merged
merged 2 commits into from
Feb 5, 2025

Conversation

matt-fidd
Copy link
Contributor

No description provided.

@actual-github-bot actual-github-bot bot changed the title dynamically load GoCardless handlers [WIP] dynamically load GoCardless handlers Jan 27, 2025
@matt-fidd matt-fidd changed the title [WIP] dynamically load GoCardless handlers dynamically load GoCardless handlers Jan 27, 2025
Copy link
Contributor

coderabbitai bot commented Jan 27, 2025

Walkthrough

The pull request introduces a significant refactoring of the bank module loading mechanism in src/app-gocardless/bank-factory.js. The changes replace static imports of bank modules with a dynamic loading approach using Node.js's fs and path modules. The new loadBanks() function reads the banks directory, filters JavaScript files containing an underscore, and dynamically imports these bank modules. This approach allows for more flexible bank module management, enabling the addition of new bank modules without modifying the source code directly. The core functionality remains unchanged, with the default export still searching for a bank by institutionId and falling back to IntegrationBank if no match is found.

Possibly related PRs

Suggested labels

dynamic-loading, refactoring, module-management

Suggested reviewers

  • UnderKoen
  • MatissJanis
✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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)
src/app-gocardless/bank-factory.js (1)

10-24: Consider switching to an asynchronous directory read and adding error handling.

Currently, fs.readdirSync blocks the event loop. Using fs.promises.readdir keeps the code fully async. Additionally, consider handling unexpected files or modules without default exports to prevent runtime errors.

If you’d like, you can replace these lines as shown:

-  const bankHandlers = fs
-    .readdirSync(banksDir)
-    .filter((filename) => filename.includes('_') && filename.endsWith('.js'));
+  const bankHandlers = (await fs.promises.readdir(banksDir))
+    .filter((filename) => filename.includes('_') && filename.endsWith('.js'));

You could also wrap the import() calls in a try/catch block to handle broken or missing default exports gracefully.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 5ada00c and bdde476.

⛔ Files ignored due to path filters (1)
  • upcoming-release-notes/557.md is excluded by !**/*.md
📒 Files selected for processing (1)
  • src/app-gocardless/bank-factory.js (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Build Docker image (alpine)
🔇 Additional comments (3)
src/app-gocardless/bank-factory.js (3)

1-3: Neat usage of Node.js ESM imports.

These imports are consistent with ESM best practices. No issues or improvements are needed here.


7-9: Good approach to replicate __dirname in ESM.

Using fileURLToPath(import.meta.url) with path.resolve is a clean, standard way to manage relative file paths in ESM.


26-26: Verify Node.js environmental support for top-level await.

Node 16+ with "type": "module" is required for top-level await. Run the following script to verify if your project’s Node version is set to 16 or higher:

✅ Verification successful

Environment fully supports top-level await

The project is correctly configured with Node.js >=18.0.0 and "type": "module", meeting all requirements for top-level await usage.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Checking package.json for Node engine requirements and .nvmrc if present
fd 'package.json' . | xargs cat | jq '.engines'
fd '.nvmrc' . | xargs cat

Length of output: 96


Script:

#!/bin/bash
# Checking package.json for type:module configuration
fd 'package.json' . | xargs cat | jq '.type'

Length of output: 51

Copy link
Member

@UnderKoen UnderKoen left a comment

Choose a reason for hiding this comment

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

Awesome!

Would it now be possible to define a custom handler with a docker volume?

@matt-fidd
Copy link
Contributor Author

Awesome!

Would it now be possible to define a custom handler with a docker volume?

Hmm.. perhaps. I don't know too much about docker.

If I understand correctly we might be able to define a specific directory that it would look in for "extras" and mount that as a volume

@matt-fidd
Copy link
Contributor Author

I'll merge this after the freeze since it doesn't actually do anything different to master

@matt-fidd matt-fidd merged commit abeeb05 into actualbudget:master Feb 5, 2025
8 checks passed
@matt-fidd matt-fidd deleted the dynamic-gocardless branch February 5, 2025 22:38
@coderabbitai coderabbitai bot mentioned this pull request Feb 6, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants