feat: [RAF-1083][POS Service]: Add GQL Client for Rafiki BE calls for incoming payment operations (#3546)

Author: zeppelin44

packages/backend/codegen.yml

@@ -61,6 +61,19 @@ generates:
       defaultMapper: Partial<{T}>
       # By default it is T | null. But the service code uses typescript's optional types (`foo?: T`) which are `T | undefined`. This saves the trouble of converting them explicitly.
       inputMaybeValue: T | undefined
+      scalars:
+        UInt8: number
+        UInt64: bigint
+  ../point-of-sale/src/graphql/generated/graphql.ts:
+    plugins:
+      - 'typescript'
+      - 'typescript-resolvers'
+      - 'typescript-operations'
+    documents: ../point-of-sale/src/graphql/**/*.{ts,tsx,graphql}
+    config:
+      omitOperationSuffix: true
+      defaultMapper: Partial<{T}>
+      inputMaybeValue: T | undefined
       scalars:
         UInt8: number
         UInt64: bigint

packages/point-of-sale/jest.env.js

@@ -1,3 +1,8 @@
 // Jest environment configuration for point-of-sale
 process.env.NODE_ENV = 'test'
 process.env.LOG_LEVEL = process.env.LOG_LEVEL || 'silent'
+
+process.env.TENANT_ID = 'tenant_id'
+process.env.TENANT_SECRET = 'tenant_secret'
+process.env.TENANT_SIGNATURE_VERSION = 'tenant_signature_version'
+process.env.GRAPHQL_URL = 'http://127.0.0.1:3003/graphql'

packages/point-of-sale/package.json

@@ -9,6 +9,7 @@
     "test:cov": "pnpm test -- --coverage",
     "test:sincemain": "pnpm test -- --changedSince=main",
     "test:sincemain:cov": "pnpm test:sincemain --coverage",
+    "generate": "graphql-codegen --config codegen.yml",
     "knex": "knex",
     "dev": "ts-node-dev --inspect=0.0.0.0:9229 --respawn --transpile-only src/index.ts",
     "build": "pnpm build:deps && pnpm clean && tsc --build tsconfig.json",
@@ -25,6 +26,8 @@
     "@koa/cors": "^5.0.0",
     "@koa/router": "^12.0.2",
     "dotenv": "^16.4.7",
+    "graphql": "^16.11.0",
+    "json-canonicalize": "^1.0.6",
     "knex": "^3.1.0",
     "koa": "^3.0.0",
     "koa-bodyparser": "^4.4.1",
@@ -36,17 +39,24 @@
     "uuid": "^9.0.1"
   },
   "devDependencies": {
+    "@apollo/client": "^3.11.8",
+    "@graphql-codegen/cli": "5.0.4",
+    "@graphql-codegen/introspection": "4.0.3",
+    "@graphql-codegen/typescript": "4.1.3",
+    "@graphql-codegen/typescript-operations": "^4.4.1",
+    "@graphql-codegen/typescript-resolvers": "4.4.2",
     "@types/koa": "2.15.0",
     "@types/koa-bodyparser": "^4.3.12",
     "@types/koa__cors": "^5.0.0",
     "@types/koa__router": "^12.0.4",
+    "@types/tmp": "^0.2.6",
     "@types/uuid": "^9.0.8",
-    "nock": "14.0.0-beta.19",
+    "cross-fetch": "^4.1.0",
     "jest-environment-node": "^29.7.0",
     "jest-openapi": "^0.14.2",
+    "nock": "14.0.0-beta.19",
+    "node-mocks-http": "^1.16.2",
     "testcontainers": "^10.16.0",
-    "tmp": "^0.2.3",
-    "@types/tmp": "^0.2.6",
-    "node-mocks-http": "^1.16.2"
+    "tmp": "^0.2.3"
   }
 }

packages/point-of-sale/src/config/app.ts

@@ -35,5 +35,9 @@ export const Config = {
   port: envInt('PORT', 3008),
   trustProxy: envBool('TRUST_PROXY', false),
   enableManualMigrations: envBool('ENABLE_MANUAl_MIGRATIONS', false),
-  dbSchema: undefined as string | undefined
+  dbSchema: undefined as string | undefined,
+  tenantId: envString('TENANT_ID'),
+  tenantSecret: envString('TENANT_SECRET'),
+  tenantSignatureVersion: envString('TENANT_SIGNATURE_VERSION'),
+  graphqlUrl: envString('GRAPHQL_URL')
 }

packages/point-of-sale/src/graphql/generated/graphql.ts

@@ -0,0 +1,11 @@
+import { gql } from '@apollo/client'
+
+export const CREATE_INCOMING_PAYMENT = gql`
+  mutation CreateIncomingPayment($input: CreateIncomingPaymentInput!) {
+    createIncomingPayment(input: $input) {
+      payment {
+        id
+      }
+    }
+  }
+`

packages/point-of-sale/src/graphql/mutations/createIncomingPayment.ts

@@ -4,22 +4,37 @@ import { Model } from 'objection'
 import { Config } from './config/app'
 import { App, AppServices } from './app'
 import createLogger from 'pino'
+import {
+  ApolloClient,
+  ApolloLink,
+  createHttpLink,
+  InMemoryCache
+} from '@apollo/client'
+import { onError } from '@apollo/client/link/error'
+import { setContext } from '@apollo/client/link/context'
+import { print } from 'graphql'
+import { canonicalize } from 'json-canonicalize'
+import { createHmac } from 'crypto'
 import { createMerchantService } from './merchant/service'
 import { createPosDeviceService } from './merchant/devices/service'
 import { createMerchantRoutes } from './merchant/routes'
+import { createPaymentService } from './payments/service'
 import { createPosDeviceRoutes } from './merchant/devices/routes'
 
 export function initIocContainer(
   config: typeof Config
 ): IocContract<AppServices> {
   const container: IocContract<AppServices> = new Ioc()
+
   container.singleton('config', async () => config)
+
   container.singleton('logger', async (deps: IocContract<AppServices>) => {
     const config = await deps.use('config')
     const logger = createLogger()
     logger.level = config.logLevel
     return logger
   })
+
   container.singleton('knex', async (deps: IocContract<AppServices>) => {
     const logger = await deps.use('logger')
     const config = await deps.use('config')
@@ -76,6 +91,89 @@ export function initIocContainer(
     })
   })
 
+  container.singleton('apolloClient', async (deps) => {
+    const [logger, config] = await Promise.all([
+      deps.use('logger'),
+      deps.use('config')
+    ])
+
+    const httpLink = createHttpLink({
+      uri: config.graphqlUrl
+    })
+
+    const errorLink = onError(({ graphQLErrors }) => {
+      if (graphQLErrors) {
+        logger.error(graphQLErrors)
+        graphQLErrors.map(({ extensions }) => {
+          if (extensions && extensions.code === 'UNAUTHENTICATED') {
+            logger.error('UNAUTHENTICATED')
+          }
+
+          if (extensions && extensions.code === 'FORBIDDEN') {
+            logger.error('FORBIDDEN')
+          }
+        })
+      }
+    })
+
+    const authLink = setContext((request, { headers }) => {
+      if (!config.tenantSecret || !config.tenantSignatureVersion)
+        return { headers }
+      const timestamp = Date.now()
+      const version = config.tenantSignatureVersion
+
+      const { query, variables, operationName } = request
+      const formattedRequest = {
+        variables,
+        operationName,
+        query: print(query)
+      }
+
+      const payload = `${timestamp}.${canonicalize(formattedRequest)}`
+      const hmac = createHmac('sha256', config.tenantSecret)
+      hmac.update(payload)
+      const digest = hmac.digest('hex')
+
+      const link = {
+        headers: {
+          ...headers,
+          'tenant-id': `${config.tenantId}`,
+          signature: `t=${timestamp}, v${version}=${digest}`
+        }
+      }
+
+      return link
+    })
+
+    const link = ApolloLink.from([errorLink, authLink, httpLink])
+
+    const client = new ApolloClient({
+      cache: new InMemoryCache({}),
+      link: link,
+      defaultOptions: {
+        query: {
+          fetchPolicy: 'no-cache'
+        },
+        mutate: {
+          fetchPolicy: 'no-cache'
+        },
+        watchQuery: {
+          fetchPolicy: 'no-cache'
+        }
+      }
+    })
+
+    return client
+  })
+
+  container.singleton('paymentClient', async (deps) => {
+    return createPaymentService({
+      apolloClient: await deps.use('apolloClient'),
+      logger: await deps.use('logger'),
+      config: await deps.use('config')
+    })
+  })
+
   container.singleton(
     'posDeviceService',
     async (deps: IocContract<AppServices>) => {
@@ -94,6 +192,7 @@ export function initIocContainer(
       posDeviceService: await deps.use('posDeviceService')
     })
   )
+
   return container
 }
 

packages/point-of-sale/src/index.ts

@@ -0,0 +1,72 @@
+import { createPaymentService } from './service'
+import { ApolloClient, NormalizedCacheObject } from '@apollo/client'
+import { Logger } from 'pino'
+import { AmountInput } from '../graphql/generated/graphql'
+import { IAppConfig } from '../config/app'
+
+const mockLogger = {
+  child: jest.fn().mockReturnThis(),
+  error: jest.fn()
+} as unknown as Logger
+
+const mockConfig = {}
+
+const mockApolloClient = {
+  mutate: jest.fn()
+} as unknown as ApolloClient<NormalizedCacheObject>
+
+const deps = {
+  logger: mockLogger,
+  config: mockConfig as IAppConfig,
+  apolloClient: mockApolloClient
+}
+
+describe('createPaymentService', () => {
+  beforeEach(() => {
+    jest.clearAllMocks()
+  })
+
+  it('should create an incoming payment and return the incoming payment url (id)', async () => {
+    const expectedUrl = 'https://api.example.com/incoming-payments/abc123'
+    mockApolloClient.mutate = jest.fn().mockResolvedValue({
+      data: {
+        payment: {
+          id: expectedUrl
+        }
+      }
+    })
+    const service = createPaymentService(deps)
+    const walletAddressId = 'wallet-123'
+    const incomingAmount: AmountInput = {
+      value: 1000n,
+      assetCode: 'USD',
+      assetScale: 2
+    }
+    const result = await service.createIncomingPayment(
+      walletAddressId,
+      incomingAmount
+    )
+    expect(result).toBe(expectedUrl)
+    expect(mockApolloClient.mutate).toHaveBeenCalled()
+  })
+
+  it('should throw and log error if payment creation fails (no id)', async () => {
+    mockApolloClient.mutate = jest
+      .fn()
+      .mockResolvedValue({ data: { payment: { id: undefined } } })
+    const service = createPaymentService(deps)
+    const walletAddressId = 'wallet-123'
+    const incomingAmount: AmountInput = {
+      value: 1000n,
+      assetCode: 'USD',
+      assetScale: 2
+    }
+    await expect(
+      service.createIncomingPayment(walletAddressId, incomingAmount)
+    ).rejects.toThrow(/Failed to create incoming payment/)
+    expect(mockLogger.error).toHaveBeenCalledWith(
+      { walletAddressId },
+      'Failed to create incoming payment for given walletAddressId'
+    )
+  })
+})

packages/point-of-sale/src/payments/service.test.ts

@@ -0,0 +1,74 @@
+import { Logger } from 'pino'
+import { CREATE_INCOMING_PAYMENT } from '../graphql/mutations/createIncomingPayment'
+import { IAppConfig } from '../config/app'
+import { ApolloClient, NormalizedCacheObject } from '@apollo/client'
+import {
+  AmountInput,
+  CreateIncomingPaymentInput,
+  type Mutation
+} from '../graphql/generated/graphql'
+import { FnWithDeps } from '../shared/types'
+import { v4 } from 'uuid'
+
+type ServiceDependencies = {
+  logger: Logger
+  config: IAppConfig
+  apolloClient: ApolloClient<NormalizedCacheObject>
+}
+
+type PaymentService = {
+  createIncomingPayment: (
+    walletAddressId: string,
+    incomingAmount: AmountInput
+  ) => Promise<string>
+}
+
+export function createPaymentService(
+  deps_: ServiceDependencies
+): PaymentService {
+  const logger = deps_.logger.child({
+    service: 'PaymentService'
+  })
+  const deps = {
+    ...deps_,
+    logger
+  }
+
+  return {
+    createIncomingPayment: (
+      walletAddressId: string,
+      incomingAmount: AmountInput
+    ) => createIncomingPayment(deps, walletAddressId, incomingAmount)
+  }
+}
+
+const createIncomingPayment: FnWithDeps<
+  ServiceDependencies,
+  PaymentService['createIncomingPayment']
+> = async (deps, walletAddressId, incomingAmount) => {
+  const client = deps.apolloClient
+  const { data } = await client.mutate<
+    Mutation['createIncomingPayment'],
+    CreateIncomingPaymentInput
+  >({
+    mutation: CREATE_INCOMING_PAYMENT,
+    variables: {
+      walletAddressId,
+      incomingAmount,
+      idempotencyKey: v4()
+    }
+  })
+
+  const incomingPaymentUrl = data?.payment?.id
+  if (!incomingPaymentUrl) {
+    deps.logger.error(
+      { walletAddressId },
+      'Failed to create incoming payment for given walletAddressId'
+    )
+    throw new Error(
+      `Failed to create incoming payment for given walletAddressId ${walletAddressId}`
+    )
+  }
+
+  return incomingPaymentUrl
+}

packages/point-of-sale/src/payments/service.ts

@@ -0,0 +1,3 @@
+export type FnWithDeps<Deps, Fn> = Fn extends (...args: infer Args) => infer R
+  ? (deps: Deps, ...args: Args) => R
+  : never