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(storage): fix payment list sorting #298

Merged
merged 1 commit into from
Jan 28, 2025
Merged

Conversation

paul-nicolas
Copy link
Contributor

Mor modulr, when we create a transfer/payout, we will have the same date for pending/succeeded transaction, so the only thing differenciating the two is the sort_id we added. That way, we can have the last status in the main payment

Copy link
Contributor

coderabbitai bot commented Jan 28, 2025

Walkthrough

The pull request modifies the PaymentsList function in the payments.go file by updating the SQL query's sorting criteria. The change adds a secondary sorting parameter sort_id to the existing created_at ordering. This ensures that when multiple payment adjustments have the same timestamp, the adjustment with the highest sort_id will be selected. A corresponding test function TestPaymentsListSorting has been added to validate this new sorting behavior.

Changes

File Change Summary
internal/storage/payments.go Modified SQL query sorting to include sort_id desc alongside created_at desc
internal/storage/payments_test.go Added TestPaymentsListSorting test function to verify payment status sorting logic

Possibly related PRs

Suggested reviewers

  • laouji

Poem

🐰 A Rabbit's Ode to Sorting Payments 🐰

With timestamps aligned, a sorting quest begins,
Sort_id joins the dance, where precision wins!
Adjustments line up, each with a tale to tell,
Our code now chooses wisely, sorting oh so well!
A payment's journey, sorted with rabbit might! 🥕

✨ 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.

@paul-nicolas paul-nicolas force-pushed the fix/payments-list-sorting branch from 6cc2bf2 to 6412fdb Compare January 28, 2025 14:17
Copy link

codecov bot commented Jan 28, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 73.06%. Comparing base (78e2b50) to head (6412fdb).
Report is 3 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #298   +/-   ##
=======================================
  Coverage   73.05%   73.06%           
=======================================
  Files         537      537           
  Lines       27115    27126   +11     
=======================================
+ Hits        19810    19819    +9     
- Misses       6238     6241    +3     
+ Partials     1067     1066    -1     

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

@paul-nicolas paul-nicolas marked this pull request as ready for review January 28, 2025 14:25
@paul-nicolas paul-nicolas requested a review from a team as a code owner January 28, 2025 14:25
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)
internal/storage/payments_test.go (1)

773-844: The test coverage looks good, consider adding more edge cases.

The test effectively verifies the new sorting behavior with adjustments sharing the same timestamp. To make it more robust, consider adding test cases for:

  1. Multiple payments with adjustments at the same timestamp
  2. Explicit sort_id values to verify the ordering
  3. Edge cases like adjustments with millisecond differences

Here's a suggested additional test case:

 func TestPaymentsListSorting(t *testing.T) {
     // ... existing test code ...
+    t.Run("multiple payments with same timestamp", func(t *testing.T) {
+        // Create two payments with adjustments at the same timestamp
+        // but different sort_ids to verify the ordering
+    })
 }
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 1841401 and 6412fdb.

📒 Files selected for processing (2)
  • internal/storage/payments.go (1 hunks)
  • internal/storage/payments_test.go (1 hunks)
🔇 Additional comments (1)
internal/storage/payments.go (1)

332-332: LGTM! The sorting logic enhancement looks good.

The addition of sort_id as a secondary sorting criterion ensures consistent ordering when multiple payment adjustments share the same timestamp. This effectively addresses the issue of distinguishing between pending and succeeded transactions.

Let's verify that sort_id is being populated correctly in the payment_adjustments table:

✅ Verification successful

✅ Verified: sort_id is properly implemented and maintained

The sort_id column in the payment_adjustments table is:

  • Automatically populated (bigserial)
  • Never null (constraint)
  • Properly indexed for efficient sorting

The ORDER BY clause will work reliably as intended.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check if sort_id column exists and contains valid values
# Expected: Column exists and contains non-null values for recent adjustments

# Check if sort_id column exists in payment_adjustments table
psql -c "\d payment_adjustments" | grep -i "sort_id"

# Check for any NULL sort_ids in recent adjustments
psql -c "SELECT COUNT(*) FROM payment_adjustments WHERE sort_id IS NULL AND created_at > NOW() - INTERVAL '1 day'"

Length of output: 365


Script:

#!/bin/bash
# Search for sort_id in SQL statements and struct definitions
echo "=== SQL Statements with sort_id ==="
rg -i "sort_id" --type sql -A 3 -B 3

echo "=== Go struct definitions and usage ==="
ast-grep --pattern 'type $_ struct {
  $$$
  sort_id $_
  $$$
}'

echo "=== Migration files ==="
fd -e sql migration

Length of output: 24637

@paul-nicolas paul-nicolas merged commit c60dda9 into main Jan 28, 2025
9 checks passed
@paul-nicolas paul-nicolas deleted the fix/payments-list-sorting branch January 28, 2025 14:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants