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.

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

fix(analytics): fix first_attempt filter value parsing for Payments #6667

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

fix(analytics): fix first_attempt filter value parsing for Payments #6667

wants to merge 3 commits into from
+2 −1

Conversation

tsdk02
Copy link
Contributor

@tsdk02 tsdk02 commented Nov 26, 2024 •
edited
Loading

Type of Change

  • Bugfix
  • New feature
  • Enhancement
  • Refactoring
  • Dependency updates
  • Documentation
  • CI/CD

Description

  • first_attempt filter takes in true or false as variants.
  • But while it is getting applied in the query, it is being converted into a string:
    'true' or 'false'

This works on latest clickhouse versions, but fails on the older clickhouse versions, with the error:

DB::Exception: Cannot convert string false to type Bool: While processing (first_attempt IN ('false'))

Now, internally converting 'true' to '1' and 'false' to '0' to fix the issue, and this gets accepted in both the versions.

The query which was previously running was:

SELECT connector, status, sum(sign_flag) as count, first_attempt, min(created_at) as start_bucket, max(created_at) as end_bucket FROM sessionizer_payment_attempts WHERE ( first_attempt IN ('false') AND organization_id = 'org_id' AND created_at >= '1731803400' AND created_at <= '1732577400' ) GROUP BY connector, status, first_attempt HAVING sum(sign_flag) >= '1'

Now the query which will run is:

SELECT connector, status, sum(sign_flag) as count, first_attempt, min(created_at) as start_bucket, max(created_at) as end_bucket FROM sessionizer_payment_attempts WHERE ( first_attempt IN ('0') AND organization_id = 'org_id' AND created_at >= '1731803400' AND created_at <= '1732577400' ) GROUP BY connector, status, first_attempt HAVING sum(sign_flag) >= '1'

Additional Changes

  • This PR modifies the API contract
  • This PR modifies the database schema
  • This PR modifies application configuration/environment variables

Motivation and Context

Fix the issue: #6666

How did you test it?

Hit the curl with first_attempt filter containing either true or false:

curl --location 'http://localhost:8080/analytics/v1/org/metrics/payments' \
--header 'Accept: */*' \
--header 'Accept-Language: en-US,en;q=0.9' \
--header 'Connection: keep-alive' \
--header 'Content-Type: application/json' \
--header 'Origin: http://localhost:9000' \
--header 'Referer: http://localhost:9000/' \
--header 'Sec-Fetch-Dest: empty' \
--header 'Sec-Fetch-Mode: cors' \
--header 'Sec-Fetch-Site: same-site' \
--header 'User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/128.0.0.0 Safari/537.36' \
--header 'api-key: test_admin' \
--header 'authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoiNTQ5ZTNkMmItMTY5Yi00NzUzLWJmNTQtZDcxMTM2YjRiN2JkIiwibWVyY2hhbnRfaWQiOiJtZXJjaGFudF8xNzI2MDQ2MzI4Iiwicm9sZV9pZCI6Im9yZ19hZG1pbiIsImV4cCI6MTczMjc5Mjk0OCwib3JnX2lkIjoib3JnX1ZwU0hPanNZZkR2YWJWWUpnQ0FKIiwicHJvZmlsZV9pZCI6InByb192NXNGb0hlODBPZWlVbElvbm9jTSIsInRlbmFudF9pZCI6InB1YmxpYyJ9.Q5ruAj8DwAp5XDj1ktFhma4aZXAHSZBmRSw_EnPk4HE' \
--header 'sec-ch-ua: "Chromium";v="128", "Not;A=Brand";v="24", "Google Chrome";v="128"' \
--header 'sec-ch-ua-mobile: ?0' \
--header 'sec-ch-ua-platform: "macOS"' \
--data '[
    {
        "timeRange": {
            "startTime": "2024-11-17T00:30:00Z",
            "endTime": "2024-11-25T23:30:00Z"
        },
        "groupByNames": [
            "connector"
        ],
        "filters":{
            "first_attempt": [false]
        },
        "source": "BATCH",
        "metrics": [
            "payments_distribution"
        ],
        "delta": true
    }
]'

Response:

{
    "queryData": [
        {
            "payment_success_rate": null,
            "payment_count": null,
            "payment_success_count": null,
            "payment_processed_amount": 0,
            "payment_processed_amount_in_usd": null,
            "payment_processed_count": null,
            "payment_processed_amount_without_smart_retries": 0,
            "payment_processed_amount_without_smart_retries_usd": null,
            "payment_processed_count_without_smart_retries": null,
            "avg_ticket_size": null,
            "payment_error_message": null,
            "retries_count": null,
            "retries_amount_processed": 0,
            "connector_success_rate": null,
            "payments_success_rate_distribution": 100.0,
            "payments_success_rate_distribution_without_smart_retries": null,
            "payments_success_rate_distribution_with_only_retries": 100.0,
            "payments_failure_rate_distribution": 0.0,
            "payments_failure_rate_distribution_without_smart_retries": null,
            "payments_failure_rate_distribution_with_only_retries": 0.0,
            "failure_reason_count": 0,
            "failure_reason_count_without_smart_retries": 0,
            "currency": null,
            "status": null,
            "connector": "stripe_test",
            "authentication_type": null,
            "payment_method": null,
            "payment_method_type": null,
            "client_source": null,
            "client_version": null,
            "profile_id": null,
            "card_network": null,
            "merchant_id": null,
            "card_last_4": null,
            "card_issuer": null,
            "error_reason": null,
            "time_range": {
                "start_time": "2024-11-17T00:30:00.000Z",
                "end_time": "2024-11-25T23:30:00.000Z"
            },
            "time_bucket": "2024-11-17 00:30:00"
        }
    ],
    "metaData": [
        {
            "total_payment_processed_amount": 0,
            "total_payment_processed_amount_in_usd": 0,
            "total_payment_processed_amount_without_smart_retries": 0,
            "total_payment_processed_amount_without_smart_retries_usd": 0,
            "total_payment_processed_count": 0,
            "total_payment_processed_count_without_smart_retries": 0,
            "total_failure_reasons_count": 0,
            "total_failure_reasons_count_without_smart_retries": 0
        }
    ]
}

If smart retries are made, then these fields will show null:

"payments_success_rate_distribution_without_smart_retries": null,
"payments_failure_rate_distribution_without_smart_retries": null,

And these fields will have some value:

"payments_success_rate_distribution_with_only_retries": 100.0,
"payments_failure_rate_distribution_with_only_retries": 0.0,
image image

Checklist

  • I formatted the code cargo +nightly fmt --all
  • I addressed lints thrown by cargo clippy
  • I reviewed the submitted code
  • I added unit tests for my changes where possible

@tsdk02 tsdk02 added C-bug Category: Bug A-Analytics labels Nov 26, 2024
@tsdk02 tsdk02 self-assigned this Nov 26, 2024
@tsdk02 tsdk02 requested a review from a team as a code owner November 26, 2024 13:05
@semanticdiff-com SemanticDiff.com
Copy link

semanticdiff-com bot commented Nov 26, 2024 •
edited
Loading

Review changes with  SemanticDiff

Changed Files
File Status
  crates/analytics/src/query.rs  28% smaller

@tsdk02 tsdk02 linked an issue Nov 26, 2024 that may be closed by this pull request
fix(analytics): fix first_attempt filter value parsing for Payments #6666
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ThisIsMani ThisIsMani ThisIsMani approved these changes

@ShivanshMathurJuspay ShivanshMathurJuspay Awaiting requested review from ShivanshMathurJuspay

At least 2 approving reviews are required to merge this pull request.

Assignees

@tsdk02 tsdk02

Labels
A-Analytics C-bug Category: Bug
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

fix(analytics): fix first_attempt filter value parsing for Payments
2 participants
@tsdk02 @ThisIsMani