fix: (rafiki backend) Augment Wallet Address response with cardService field (#3552)

* feat: add cardServiceUrl configuration and update related routes

* feat: rename CARD_SERVICE_HOST to CARD_SERVICE_URL for consistency

* fix format

---------

Co-authored-by: HRadry <[email protected]>

Author: MiguelLescasJorgeSebastian

packages/backend/jest.env.js

@@ -16,4 +16,4 @@ process.env.AUTH_ADMIN_API_SECRET = 'test-secret'
 process.env.OPERATOR_TENANT_ID = 'cf5fd7d3-1eb1-4041-8e43-ba45747e9e5d'
 process.env.API_SECRET = 'KQEXlZO65jUJXakXnLxGO7dk387mt71G9tZ42rULSNU='
 process.env.EXCHANGE_RATES_URL = 'http://example.com/rates'
-process.env.CARD_SERVICE_HOST = 'http://127.0.0.1:3007'
+process.env.CARD_SERVICE_URL = 'http://127.0.0.1:3007'

packages/backend/src/card/service.test.ts

@@ -4,7 +4,7 @@ import { Logger } from 'pino'
 
 describe('Card Service', () => {
   let mockAxios: Partial<AxiosInstance>
-  let cardServiceHost: string
+  let cardServiceUrl: string
   let mockLogger: Partial<Logger>
   let cardService: Awaited<ReturnType<typeof createCardService>>
 
@@ -16,10 +16,10 @@ describe('Card Service', () => {
       error: jest.fn(),
       child: jest.fn().mockReturnThis()
     }
-    cardServiceHost = 'http://card-service.test'
+    cardServiceUrl = 'http://card-service.test'
     cardService = await createCardService({
       axios: mockAxios as AxiosInstance,
-      cardServiceHost,
+      cardServiceUrl,
       logger: mockLogger as Logger
     })
   })
@@ -41,7 +41,7 @@ describe('Card Service', () => {
         cardService.sendPaymentEvent(eventDetails)
       ).resolves.toBeUndefined()
       expect(mockAxios.post).toHaveBeenCalledWith(
-        `${cardServiceHost}/payment-event`,
+        `${cardServiceUrl}/payment-event`,
         eventDetails
       )
     })

packages/backend/src/card/service.ts

@@ -15,7 +15,7 @@ export interface CardService {
 
 interface ServiceDependencies {
   axios: AxiosInstance
-  cardServiceHost: string
+  cardServiceUrl: string
   logger: Logger
 }
 
@@ -41,7 +41,7 @@ async function sendPaymentEvent(
   eventDetails: EventDetails
 ) {
   const { status } = await deps.axios.post(
-    `${deps.cardServiceHost}${PAYMENT_FOUNDED_PATH}`,
+    `${deps.cardServiceUrl}${PAYMENT_FOUNDED_PATH}`,
     eventDetails
   )
 

packages/backend/src/config/app.ts

@@ -203,7 +203,7 @@ export const Config = {
     'SEND_TENANT_WEBHOOKS_TO_OPERATOR',
     false
   ),
-  cardServiceHost: envString('CARD_SERVICE_HOST')
+  cardServiceUrl: envString('CARD_SERVICE_URL')
 }
 
 function parseRedisTlsConfig(

packages/backend/src/index.ts

@@ -676,7 +676,7 @@ export function initIocContainer(
     return createCardService({
       axios: await deps.use('axios'),
       logger: await deps.use('logger'),
-      cardServiceHost: config.cardServiceHost
+      cardServiceUrl: config.cardServiceUrl
     })
   })
 

packages/backend/src/open_payments/wallet_address/model.ts

@@ -118,18 +118,21 @@ export class WalletAddress
 
   public toOpenPaymentsType({
     authServer,
-    resourceServer
+    resourceServer,
+    cardService
   }: {
     authServer: string
     resourceServer: string
+    cardService: string
   }): OpenPaymentsWalletAddress {
     const returnVal: OpenPaymentsWalletAddress = {
       id: this.address,
       publicName: this.publicName,
       assetCode: this.asset.code,
       assetScale: this.asset.scale,
       authServer,
-      resourceServer
+      resourceServer,
+      cardService
     }
     if (this.additionalProperties && this.additionalProperties.length) {
       returnVal.additionalProperties = this.additionalProperties

packages/backend/src/open_payments/wallet_address/routes.test.ts

@@ -123,6 +123,7 @@ describe('Wallet Address Routes', (): void => {
         // Ensure the tenant id is returned for auth and resource server:
         authServer: `${config.authServerGrantUrl}/${config.operatorTenantId}`,
         resourceServer: `${config.openPaymentsUrl}/${config.operatorTenantId}`,
+        cardService: `${config.cardServiceUrl}/${config.operatorTenantId}`,
         additionalProperties: {
           [addProp.fieldKey]: addProp.fieldValue
         }
@@ -166,7 +167,8 @@ describe('Wallet Address Routes', (): void => {
         assetScale: walletAddress.asset.scale,
         // Ensure the tenant id is returned for auth and resource server:
         authServer: `${config.authServerGrantUrl}/${walletAddress.tenantId}`,
-        resourceServer: `${config.openPaymentsUrl}/${walletAddress.tenantId}`
+        resourceServer: `${config.openPaymentsUrl}/${walletAddress.tenantId}`,
+        cardService: `${config.cardServiceUrl}/${walletAddress.tenantId}`
       })
     })
   })

packages/backend/src/open_payments/wallet_address/routes.ts

@@ -62,7 +62,8 @@ export async function getWalletAddress(
 
   ctx.body = walletAddress.toOpenPaymentsType({
     authServer: `${ensureTrailingSlash(deps.config.authServerGrantUrl)}${walletAddress.tenantId}`,
-    resourceServer: `${ensureTrailingSlash(deps.config.openPaymentsUrl)}${walletAddress.tenantId}`
+    resourceServer: `${ensureTrailingSlash(deps.config.openPaymentsUrl)}${walletAddress.tenantId}`,
+    cardService: `${ensureTrailingSlash(deps.config.cardServiceUrl)}${walletAddress.tenantId}`
   })
 }
 

packages/card-service/src/config/app.ts

@@ -31,6 +31,7 @@ export const Config = {
   trustProxy: envBool('TRUST_PROXY', false),
   env: envString('NODE_ENV', 'development'),
   cardServicePort: envInt('CARD_SERVICE_PORT', 3007),
+  cardServiceUrl: envString('CARD_SERVICE_URL', 'http://localhost:3007'),
   redisUrl: envString('REDIS_URL', 'redis://127.0.0.1:6379'),
   redisTls: parseRedisTlsConfig(
     process.env.REDIS_TLS_CA_FILE_PATH,

test/testenv/cloud-nine-wallet/docker-compose.yml

@@ -30,7 +30,7 @@ services:
       KEY_ID: keyid-97a3a431-8ee1-48fc-ac85-70e2f5eba8e5
       PRIVATE_KEY_FILE: /workspace/private-key.pem
       AUTH_SERVER_INTROSPECTION_URL: http://cloud-nine-wallet-test-auth:3107
-      CARD_SERVICE_HOST: http://cloud-nine-wallet-card-service:3007
+      CARD_SERVICE_URL: http://cloud-nine-wallet-card-service:3007
       AUTH_SERVER_GRANT_URL: http://cloud-nine-wallet-test-auth:3106
       AUTH_ADMIN_API_URL: 'http://cloud-nine-wallet-test-auth:3003/graphql'
       AUTH_ADMIN_API_SECRET: 'test-secret'