8000 fix(connectors): fix inconsistency for connector provider by paul-nicolas · Pull Request #440 · formancehq/payments · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

fix(connectors): fix inconsistency for connector provider #440

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
May 9, 2025
Merged

fix(connectors): fix inconsistency for connector provider #440

merged 2 commits into from
May 9, 2025

Conversation

paul-nicolas
Copy link
Contributor

Fixes PMNT-103

@coderabbitai coderabbitai
Copy link
Contributor
coderabbitai bot commented May 9, 2025 •
edited
Loading

"""

Walkthrough

The .gitignore file was updated to exclude .direnv/ and worktrees/ directories from version control. The MarshalJSON method in the Connector struct was changed to serialize the Provider field using the ToV3Provider transformation, normalizing its format in JSON output. Migration logic and tests were updated to apply the same provider normalization and validate it accordingly. Test data capitalization was adjusted for connector names.

Changes

Files/Paths Change Summary
.gitignore Added .direnv/ and worktrees/ directories to the ignore list.
internal/models/connectors.go Modified Connector.MarshalJSON to serialize Provider using ToV3Provider transformation.
internal/storage/migrations/1-migrate-connectors-from-v2.go Updated migration to convert Provider with ToV3Provider before inserting connectors.
internal/storage/migrations/migrations_test.go Enhanced migration test to verify both connector IDs and normalized provider values.
internal/storage/migrations/v2_migrations_test.sql Capitalized connector name values in test data inserts (e.g., 'adyen' → 'ADYEN').

Sequence Diagram(s)

sequenceDiagram
    participant Connector
    participant ToV3Provider
    participant JSON

    Connector->Connector: MarshalJSON()
    Connector->ToV3Provider: Transform Provider field
    ToV3Provider-->>Connector: Normalized provider string
    Connector->JSON: Serialize with normalized provider
Loading

Assessment against linked issues

Objective Addressed Explanation
Normalize provider field in connector JSON output (PMNT-103) ✅

Suggested reviewers

  • gfyrag
  • laouji

Poem

A tweak to what Git will now ignore,
And connectors’ providers—normalized galore!
JSON now shines with a lowercase view,
While .direnv/ and worktrees bid adieu.
With every commit, things look more neat—
A rabbit’s hop makes change complete! 🐇✨
"""

Tip

⚡️ Faster reviews with caching
  • CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.

Enjoy the performance boost—your workflow just got faster.

📜 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 20494ba and b171acd.

📒 Files selected for processing (3)
  • internal/storage/migrations/1-migrate-connectors-from-v2.go (1 hunks)
  • internal/storage/migrations/migrations_test.go (1 hunks)
  • internal/storage/migrations/v2_migrations_test.sql (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • internal/storage/migrations/v2_migrations_test.sql
🧰 Additional context used
🧬 Code Graph Analysis (1)
internal/storage/migrations/1-migrate-connectors-from-v2.go (1)
internal/models/connectors.go (1)
  • ToV3Provider (82-109)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Tests
🔇 Additional comments (4)
internal/storage/migrations/1-migrate-connectors-from-v2.go (1)

90-90: Good normalization of Provider field during migration.

Using models.ToV3Provider ensures consistent formatting of provider names (lowercase, no hyphens) when migrating from v2 to v3. This aligns with the normalization in Connector.MarshalJSON() mentioned in the summary, providing a uniform representation across the system.

internal/storage/migrations/migrations_test.go (3)

94-97: Good addition of a structured type for connector test data.

Creating a dedicated struct to hold the test data makes the code more readable and maintainable.

99-109: LGTM! Comprehensive test cases for provider normalization.

The test data includes all supported connector providers, with their expected normalized forms. This ensures thorough validation of the normalization logic during migration.

111-119: Good enhancement to test validation.

The test now properly validates both the connector ID and the normalized provider value, ensuring the migration correctly applies the ToV3Provider function to standardize provider names.

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

@codecov Codecov
Copy link
codecov bot commented May 9, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 68.11%. Comparing base (6131a56) to head (b171acd).
Report is 1 commits behind head on main.

Additional details and impacted files 
@@           Coverage Diff           @@
##             main     #440   +/-   ##
=======================================
  Coverage   68.11%   68.11%           
=======================================
  Files         580      580           
  Lines       29461    29461           
=======================================
  Hits        20066    20066           
  Misses       8334     8334           
  Partials     1061     1061

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@paul-nicolas paul-nicolas marked this pull request as ready for review May 9, 2025 12:56
@paul-nicolas paul-nicolas requested a review from a team as a code owner May 9, 2025 12:56
@paul-nicolas paul-nicolas added this pull request to the merge queue May 9, 2025
Merged via the queue into main with commit d238a9a May 9, 2025
9 checks passed
@paul-nicolas paul-nicolas deleted the fix/connectors-provider branch May 9, 2025 13:30
paul-nicolas added a commit that referenced this pull request May 9, 2025
@paul-nicolas
fix(connectors): fix inconsistency for connector provider (#440)
4ff47bd 
* fix(connectors): fix inconsistency for connector provider

* fix(storage): fix migrations when migrating connectors from v2
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@fguery fguery fguery approved these changes

@flemzord flemzord flemzord approved these changes

@laouji laouji laouji approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@paul-nicolas @fguery @flemzord @laouji
0