refactor(customer): refactor customer db with storage utils and move trait to domain_models and impl to storage_model by jagan-jaya · Pull Request #7538 · juspay/hyperswitch

jagan-jaya · 2025-03-17T13:49:04Z

Type of Change

Description

Move the Customer db to storage_impl and its interface to hyperswitch_domain_model
Added resource handling implementations in KVRouterStore, RouterStore, With this support all the resource handlers can now directly call these generic functions instead of handling the merchant storage scheme manually

Additional Changes

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

Motivation and Context

As part of Payment method crate seperation, customer DB is required in payment methods so moving it out from router

How did you test it?

Start router service with cargo r

With KV disabled for the merchant

Create Merchant Account, Create API Key

2. Create Customer

Request

curl --location 'http://localhost:8080/customers' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'api-key: dev_gu3raVGqNAtULFRrZ8y503nu1tVIxsZQWTupJcl5xsTLDz37kvLxTfaq6ZCVfb0e' \
--data-raw '{
    "email": "guest@example.com",
    "name": "John Doe",
    "phone": "999999999",
    "phone_country_code": "+65",
    "description": "First customer",
    "metadata": {
        "udf1": "value1",
        "new_customer": "true",
        "login_date": "2019-09-10T10:11:12Z"
    }
}'

Response
{
"customer_id": "cus_LcqiGN9t81YjqIyMgKWt",
"name": "John Doe",
"email": "guest@example.com",
"phone": "999999999",
"phone_country_code": "+65",
"description": "First customer",
"address": null,
"created_at": "2025-03-27T09:06:56.214Z",
"metadata": {
"udf1": "value1",
"new_customer": "true",
"login_date": "2019-09-10T10:11:12Z"
},
"default_payment_method_id": null
}

3. Retrieve Customer

Request

curl --location 'http://localhost:8080/customers/cus_LcqiGN9t81YjqIyMgKWt' \
--header 'Accept: application/json' \
--header 'api-key: dev_gu3raVGqNAtULFRrZ8y503nu1tVIxsZQWTupJcl5xsTLDz37kvLxTfaq6ZCVfb0e'

Response

{
    "customer_id": "cus_LcqiGN9t81YjqIyMgKWt",
    "name": "John Doe",
    "email": "guest@example.com",
    "phone": "999999999",
    "phone_country_code": "+65",
    "description": "First customer",
    "address": null,
    "created_at": "2025-03-27T09:06:56.214Z",
    "metadata": {
        "udf1": "value1",
        "new_customer": "true",
        "login_date": "2019-09-10T10:11:12Z"
    },
    "default_payment_method_id": null
}

4. Update Customer

Request

curl --location 'http://localhost:8080/customers/cus_LcqiGN9t81YjqIyMgKWt' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'api-key: dev_gu3raVGqNAtULFRrZ8y503nu1tVIxsZQWTupJcl5xsTLDz37kvLxTfaq6ZCVfb0e' \
--data-raw '{
    "email": "JohnTest@test.com",
    "name": "John Test",
    "phone_country_code": "+65",
    "phone": "888888888",
    "description": "First customer",
    "metadata": {
        "city": "NY",
        "unit": "245"
    }
}'

Response

{
    "customer_id": "cus_LcqiGN9t81YjqIyMgKWt",
    "name": "John Test",
    "email": "JohnTest@test.com",
    "phone": "888888888",
    "phone_country_code": "+65",
    "description": "First customer",
    "address": null,
    "created_at": "2025-03-27T09:06:56.214Z",
    "metadata": {
        "city": "NY",
        "unit": "245"
    },
    "default_payment_method_id": null
}

5. Delete Customer

Request

curl --location --request DELETE 'http://localhost:8080/customers/cus_LcqiGN9t81YjqIyMgKWt' \
--header 'Accept: application/json' \
--header 'api-key: dev_gu3raVGqNAtULFRrZ8y503nu1tVIxsZQWTupJcl5xsTLDz37kvLxTfaq6ZCVfb0e'

{
    "customer_id": "cus_LcqiGN9t81YjqIyMgKWt",
    "customer_deleted": true,
    "address_deleted": true,
    "payment_methods_deleted": true
}

Response

{
    "customer_id": "cus_LcqiGN9t81YjqIyMgKWt",
    "customer_deleted": true,
    "address_deleted": true,
    "payment_methods_deleted": true
}

With KV enabled for a merchant

Create Merchant Account, Create API Key, Do not start Drainer

2. Enable KV for the merchant

Request

curl --location 'http://localhost:8080/accounts/merchant_1743066953/kv' \
--header 'Content-Type: application/json' \
--header 'api-key: test_admin' \
--data '{
"kv_enabled": true
}'

Response

{
    "merchant_id": "merchant_1743066953",
    "kv_enabled": true
}

3. Create Customer

Request

curl --location 'http://localhost:8080/customers' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'api-key: dev_f3M5W0ZyHHsCUekQ6z1mPraNzaUzrb73No6SPnlDbFGUygPOJtOOfCIyyHUGXmwL' \
--data-raw '{
    "email": "guest@example.com",
    "name": "John Doe",
    "phone": "999999999",
    "phone_country_code": "+65",
    "description": "First customer",
    "metadata": {
        "udf1": "value1",
        "new_customer": "true",
        "login_date": "2019-09-10T10:11:12Z"
    }
}'

Response
{
"customer_id": "cus_hS8uA0hvtVdbBa8ecYOw",
"name": "John Doe",
"email": "guest@example.com",
"phone": "999999999",
"phone_country_code": "+65",
"description": "First customer",
"address": null,
"created_at": "2025-03-27T09:19:49.092Z",
"metadata": {
"udf1": "value1",
"new_customer": "true",
"login_date": "2019-09-10T10:11:12Z"
},
"default_payment_method_id": null
}

4. Retrieve Customer

Request

curl --location 'http://localhost:8080/customers/cus_hS8uA0hvtVdbBa8ecYOw' \
--header 'Accept: application/json' \
--header 'api-key: dev_f3M5W0ZyHHsCUekQ6z1mPraNzaUzrb73No6SPnlDbFGUygPOJtOOfCIyyHUGXmwL'

Response

{
    "customer_id": "cus_hS8uA0hvtVdbBa8ecYOw",
    "name": "John Doe",
    "email": "guest@example.com",
    "phone": "999999999",
    "phone_country_code": "+65",
    "description": "First customer",
    "address": null,
    "created_at": "2025-03-27T09:19:49.092Z",
    "metadata": {
        "udf1": "value1",
        "new_customer": "true",
        "login_date": "2019-09-10T10:11:12Z"
    },
    "default_payment_method_id": null
}

5. Update Customer

Request

curl --location 'http://localhost:8080/customers/cus_hS8uA0hvtVdbBa8ecYOw' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'api-key: dev_f3M5W0ZyHHsCUekQ6z1mPraNzaUzrb73No6SPnlDbFGUygPOJtOOfCIyyHUGXmwL' \
--data-raw '{
    "email": "JohnTest@test.com",
    "name": "John Test",
    "phone_country_code": "+65",
    "phone": "888888888",
    "description": "First customer",
    "metadata": {
        "city": "NY",
        "unit": "245"
    }
}'

Response

{
    "customer_id": "cus_hS8uA0hvtVdbBa8ecYOw",
    "name": "John Test",
    "email": "JohnTest@test.com",
    "phone": "888888888",
    "phone_country_code": "+65",
    "description": "First customer",
    "address": null,
    "created_at": "2025-03-27T09:19:49.092Z",
    "metadata": {
        "city": "NY",
        "unit": "245"
    },
    "default_payment_method_id": null
}

6. Delete Customer

Request

curl --location --request DELETE 'http://localhost:8080/customers/cus_hS8uA0hvtVdbBa8ecYOw' \
--header 'Accept: application/json' \
--header 'api-key: dev_f3M5W0ZyHHsCUekQ6z1mPraNzaUzrb73No6SPnlDbFGUygPOJtOOfCIyyHUGXmwL'

Response

{
    "customer_id": "cus_hS8uA0hvtVdbBa8ecYOw",
    "customer_deleted": true,
    "address_deleted": true,
    "payment_methods_deleted": true
}

7. Retrieve Customer

Request

curl --location 'http://localhost:8080/customers/cus_hS8uA0hvtVdbBa8ecYOw' \
--header 'Accept: application/json' \
--header 'api-key: dev_f3M5W0ZyHHsCUekQ6z1mPraNzaUzrb73No6SPnlDbFGUygPOJtOOfCIyyHUGXmwL'

Response

{
    "customer_id": "cus_hS8uA0hvtVdbBa8ecYOw",
    "name": "Redacted",
    "email": "Redacted",
    "phone": "Redacted",
    "phone_country_code": "Redacted",
    "description": "Redacted",
    "address": null,
    "created_at": "2025-03-27T09:19:49.092Z",
    "metadata": {
        "city": "NY",
        "unit": "245"
    },
    "default_payment_method_id": null
}

Start Drainer

After adding drainer, the KV created customer will be added into db by drainer, so read, update and delete operation should work fine after starting it.

Apply below changes

# In config/docker_compose.toml
[master_database]
host = "host.docker.internal"
[replica_database]
host = "host.docker.internal"
[redis]
host = "host.docker.internal"

In docker-compose.yml change drainer as below

 hyperswitch-drainer:
    image: juspaydotin/hyperswitch-drainer:standalone
    pull_policy: always
    command: /local/bin/drainer -f /local/config/docker_compose.toml
    deploy:
      replicas: ${DRAINER_INSTANCE_COUNT:-1}
    extra_hosts:
      - "host.docker.internal:host-gateway"
    networks:
      - router_net
    profiles:
      - full_kv
    volumes:
      - ./config:/local/config
    restart: unless-stopped
    labels:
      logs: "promtail"

Run the drainer with docker-compose up hyperswitch-drainer

With KV disabled for the same merchant

1. Disable KV for the same merchant

Request

curl --location 'http://localhost:8080/accounts/merchant_1743066953/kv' \
--header 'Content-Type: application/json' \
--header 'api-key: test_admin' \
--data '{
"kv_enabled": false
}'

Response

{
    "merchant_id": "merchant_1743066953",
    "kv_enabled": false
}

2. Update Customer details

Request

curl --location 'http://localhost:8080/customers/cus_hS8uA0hvtVdbBa8ecYOw' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'api-key: dev_f3M5W0ZyHHsCUekQ6z1mPraNzaUzrb73No6SPnlDbFGUygPOJtOOfCIyyHUGXmwL' \
--data-raw '{
    "email": "JohnTest@test.com",
    "name": "John Test",
    "phone_country_code": "+65",
    "phone": "888888888",
    "description": "First customer",
    "metadata": {
        "city": "NY",
        "unit": "245"
    }
}'

Response

{
    "error": {
        "type": "invalid_request",
        "message": "Customer has already been redacted",
        "code": "IR_11"
    }
}

3. Get Customer

Request

curl --location 'http://localhost:8080/customers/cus_hS8uA0hvtVdbBa8ecYOw'
--header 'Accept: application/json'
--header 'api-key: dev_f3M5W0ZyHHsCUekQ6z1mPraNzaUzrb73No6SPnlDbFGUygPOJtOOfCIyyHUGXmwL'

Response

{
    "customer_id": "cus_hS8uA0hvtVdbBa8ecYOw",
    "name": "Redacted",
    "email": "Redacted",
    "phone": "Redacted",
    "phone_country_code": "Redacted",
    "description": "Redacted",
    "address": null,
    "created_at": "2025-03-27T09:19:49.092Z",
    "metadata": {
        "city": "NY",
        "unit": "245"
    },
    "default_payment_method_id": null
}

4. Delete Customer

Request

curl --location --request DELETE 'http://localhost:8080/customers/cus_hS8uA0hvtVdbBa8ecYOw' \
--header 'Accept: application/json' \
--header 'api-key: dev_f3M5W0ZyHHsCUekQ6z1mPraNzaUzrb73No6SPnlDbFGUygPOJtOOfCIyyHUGXmwL'

Response

{
    "error": {
        "type": "invalid_request",
        "message": "Customer has already been redacted",
        "code": "IR_11"
    }
}

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

… avoid conversion of errors in storage_impl

…actor-storage-error

…perswitch into refactor-customer-db

semanticdiff-com · 2025-03-17T13:49:06Z

Review changes with

Changed Files

File	Status
crates/hyperswitch_domain_models/src/customer.rs	3% smaller
crates/storage_impl/src/customers.rs	1% smaller
crates/router/src/db/customers.rs	1% smaller
crates/router/src/db.rs	0% smaller
crates/router/src/db/kafka_store.rs	0% smaller
crates/storage_impl/src/lib.rs	0% smaller
crates/storage_impl/src/mock_db.rs	0% smaller
crates/storage_impl/src/payment_method.rs	0% smaller

…rswitch into refactor-customer-db

crates/hyperswitch_domain_models/src/customer.rs

crates/storage_impl/src/customers.rs

crates/hyperswitch_domain_models/src/customer.rs

…acilitapay-pix-pmt * 'main' of github.com:juspay/hyperswitch: feat(docker): add webhook notifiers for installation tracking (#7653) refactor(customer): refactor customer db with storage utils and move trait to domain_models and impl to storage_model (#7538) feat(core): Add support for updating metadata after payment has been authorized (#7776) chore(version): 2025.04.14.0 fix: script for one click docker setup (#7762) fix(payment_link): add validation for return_url during payment link creation (#7802) chore: address Rust 1.86.0 clippy lints (#7735) fix(connector): Add network error message support for payment connectors (#7760) feat(webhook): add filter by event class and type (#7275) ci(cypress): verify if card fields are populated on updating card info (#7743) chore(version): 2025.04.11.0

jagan-jaya and others added 7 commits March 17, 2025 14:42

move customer db out of router

c17ae95

refactor(router): make error_type generic in domain_models inorder to…

1a5cdbb

… avoid conversion of errors in storage_impl

chore: run formatter

cb8cfae

Merge branch 'main' of https://github.com/juspay/hyperswitch into ref…

567aabb

…actor-storage-error

fix clippy errors

d533fda

Merge branch 'refactor-storage-error' of https://github.com/juspay/hy…

8659a08

…perswitch into refactor-customer-db

add utils in mockdb and routerstore

405949e

jagan-jaya and others added 4 commits March 17, 2025 19:19

fix cypress errors

1c19e81

chore: run formatter

c3ddbe8

remove customer db interface and its implementation in router

427e454

Merge branch 'refactor-customer-db' of https://github.com/juspay/hype…

4aa8698

…rswitch into refactor-customer-db

jagan-jaya self-assigned this Mar 17, 2025

jagan-jaya added 4 commits March 18, 2025 01:27

Merge branch 'refactor-storage-error' into refactor-customer-db

0d1dfdb

Merge branch 'main' into refactor-storage-error

c31f957

Merge branch 'refactor-storage-error' into refactor-customer-db

3f701d4

fix clippy errors

a137fcd

jagan-jaya changed the title ~~Refactor customer db~~ refactor(customer): refactor customer db with storage utils and move trait to domain_models and impl to storage_model Mar 18, 2025

jagan-jaya added 2 commits March 19, 2025 14:17

Merge branch 'main' into refactor-storage-error

c7670b5

Merge branch 'refactor-storage-error' into refactor-customer-db

7ac936d

Base automatically changed from refactor-storage-error to main March 21, 2025 14:08

Merge branch 'main' into refactor-customer-db

521e244

jagan-jaya marked this pull request as ready for review March 27, 2025 10:30

jagan-jaya requested review from a team as code owners March 27, 2025 10:30

Merge branch 'main' into refactor-customer-db

ce44b5a

jagan-jaya requested review from ShankarSinghC and jarnura March 27, 2025 12:10

jarnura requested changes Mar 27, 2025

View reviewed changes

crates/hyperswitch_domain_models/src/customer.rs Outdated Show resolved Hide resolved

crates/storage_impl/src/customers.rs Outdated Show resolved Hide resolved

address review comments

b80206b

jagan-jaya added 2 commits April 1, 2025 13:11

address review comments

4415bf2

Merge branch 'main' into refactor-customer-db

e4df59c

jarnura previously approved these changes Apr 1, 2025

View reviewed changes

fix v2 compilation error

4a44239

jagan-jaya dismissed jarnura’s stale review via 4a44239 April 1, 2025 10:11

jagan-jaya added 5 commits April 1, 2025 15:42

Merge branch 'main' into refactor-customer-db

8990f55

fix cargo errors

84cedc9

Merge branch 'main' into refactor-customer-db

f6c4afb

Merge branch 'main' into refactor-customer-db

14abd00

Merge branch 'main' into refactor-customer-db

75b91ef

jarnura requested changes Apr 10, 2025

View reviewed changes

crates/storage_impl/src/customers.rs Outdated Show resolved Hide resolved

crates/storage_impl/src/customers.rs Outdated Show resolved Hide resolved

jarnura requested changes Apr 10, 2025

View reviewed changes

crates/hyperswitch_domain_models/src/customer.rs Outdated Show resolved Hide resolved

fix imports in customer impl and domain models

4a2ead3

jarnura approved these changes Apr 11, 2025

View reviewed changes

ShankarSinghC approved these changes Apr 11, 2025

View reviewed changes

Gnanasundari24 added this pull request to the merge queue Apr 15, 2025

Merged via the queue into main with commit e8e0b5d Apr 15, 2025
16 of 20 checks passed

Gnanasundari24 deleted the refactor-customer-db branch April 15, 2025 07:54

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor(customer): refactor customer db with storage utils and move trait to domain_models and impl to storage_model#7538

refactor(customer): refactor customer db with storage utils and move trait to domain_models and impl to storage_model#7538
Gnanasundari24 merged 29 commits intomainfrom
refactor-customer-db

jagan-jaya commented Mar 17, 2025 •

edited

Loading

Uh oh!

semanticdiff-com bot commented Mar 17, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

jagan-jaya commented Mar 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Type of Change

Description

Additional Changes

Motivation and Context

How did you test it?

With KV disabled for the merchant

With KV enabled for a merchant

Start Drainer

With KV disabled for the same merchant

Checklist

Uh oh!

semanticdiff-com bot commented Mar 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

jagan-jaya commented Mar 17, 2025 •

edited

Loading

semanticdiff-com bot commented Mar 17, 2025 •

edited

Loading