Breaking private api [2/X] (#382)

This adds the knex-stringcase library to automatically convert between camelCase in JS/TS land and snake_case in DB-land.

This means that we can only work with camelCase stuff in TypeScript while still using the conventional snake_case names in our database.

Author: 0xCLARITY

@types/knex-stringcase/index.d.ts

@@ -0,0 +1 @@
+declare module 'knex-stringcase'

package-lock.json

@@ -30,6 +30,7 @@
     "boom": "^7.3.0",
     "express": "^4.17.1",
     "knex": "^0.21.1",
+    "knex-stringcase": "^1.4.1",
     "log4js": "^6.2.1",
     "pg": "8.2.1",
     "prom-client": "^12.0.0",

package.json

@@ -10,10 +10,10 @@ export default async function getAllAddressInfoFromDatabase(
   payId: string,
 ): Promise<readonly AddressInformation[]> {
   const addressInformation = await knex
-    .select('address.payment_network', 'address.environment', 'address.details')
+    .select('address.paymentNetwork', 'address.environment', 'address.details')
     .from<Address>('address')
-    .innerJoin('account', 'address.account_id', 'account.id')
-    .where('account.pay_id', payId)
+    .innerJoin('account', 'address.accountId', 'account.id')
+    .where('account.payId', payId)
 
   return addressInformation
 }

src/data-access/payIds.ts

@@ -4,21 +4,21 @@ import { PayIdCount } from '../types/reports'
 /**
  * Retrieve count of PayIDs, grouped by payment network and environment.
  *
- * @returns A list with the number of PayIDs that have a given (payment_network, environment) tuple,
- *          ordered by (payment_network, environment).
+ * @returns A list with the number of PayIDs that have a given (paymentNetwork, environment) tuple,
+ *          ordered by (paymentNetwork, environment).
  */
 export default async function getPayIdCounts(): Promise<PayIdCount[]> {
   const payIdCounts: PayIdCount[] = await knex
-    .select('address.payment_network', 'address.environment')
+    .select('address.paymentNetwork', 'address.environment')
     .count('* as count')
     .from<PayIdCount>('address')
-    .groupBy('address.payment_network', 'address.environment')
-    .orderBy('address.payment_network')
+    .groupBy('address.paymentNetwork', 'address.environment')
+    .orderBy('address.paymentNetwork')
     .orderBy('address.environment')
 
   return payIdCounts.map((record) => {
     return {
-      payment_network: record.payment_network,
+      paymentNetwork: record.paymentNetwork,
       environment: record.environment,
       count: Number(record.count),
     }

src/data-access/reports.ts

@@ -22,14 +22,14 @@ export async function insertUser(
   return knex.transaction(async (transaction: Transaction) => {
     const insertedAddresses = await knex
       .insert({
-        pay_id: payId,
+        payId,
       })
       .into<Account>('account')
       .transacting(transaction)
       .returning('id')
       .then(async (ids) => {
-        const accountID = ids[0]
-        const mappedAddresses = addAccountIDToAddresses(addresses, accountID)
+        const accountId = ids[0]
+        const mappedAddresses = addAccountIdToAddresses(addresses, accountId)
         return insertAddresses(mappedAddresses, transaction)
       })
       .then(transaction.commit)
@@ -55,23 +55,23 @@ export async function replaceUser(
 ): Promise<readonly AddressInformation[] | null> {
   return knex.transaction(async (transaction: Transaction) => {
     const updatedAddresses = await knex<Account>('account')
-      .where('pay_id', oldPayId)
-      .update({ pay_id: newPayId })
+      .where('payId', oldPayId)
+      .update({ payId: newPayId })
       .transacting(transaction)
       .returning('id')
       .then(async (ids) => {
-        const accountID = ids[0]
-        if (accountID === undefined) {
+        const accountId = ids[0]
+        if (accountId === undefined) {
           return null
         }
 
         // Delete existing addresses associated with that user
         await knex<Address>('address')
           .delete()
-          .where('account_id', accountID)
+          .where('accountId', accountId)
           .transacting(transaction)
 
-        const mappedAddresses = addAccountIDToAddresses(addresses, accountID)
+        const mappedAddresses = addAccountIdToAddresses(addresses, accountId)
         return insertAddresses(mappedAddresses, transaction)
       })
       .then(transaction.commit)
@@ -90,7 +90,7 @@ export async function replaceUser(
 export async function removeUser(payId: string): Promise<void> {
   await knex<Account>('account')
     .delete()
-    .where('pay_id', payId)
+    .where('payId', payId)
     .then((count) => {
       /* istanbul ignore if */
       if (count > 1) {
@@ -109,25 +109,25 @@ export async function removeUser(payId: string): Promise<void> {
 // HELPER FUNCTIONS
 
 interface DatabaseAddress extends AddressInformation {
-  account_id: string
+  accountId: string
 }
 
 /**
  * Maps an array of AddressInformation objects into an array of DatabaseAddress objects,
- * by adding an 'account_id' property to each object.
+ * by adding an 'accountId' property to each object.
  *
  * @param addresses - An array of payment addresses we want to insert into the database.
- * @param accountID - The account ID to add to all the addresses to allow inserting the addresses into the database.
+ * @param accountId - The account ID to add to all the addresses to allow inserting the addresses into the database.
  *
- * @returns A new array of DatabaseAddress objects, where each address has a new property 'account_id'.
+ * @returns A new array of DatabaseAddress objects, where each address has a new property 'accountId'.
  */
-function addAccountIDToAddresses(
+function addAccountIdToAddresses(
   addresses: readonly AddressInformation[],
-  accountID: string,
+  accountId: string,
 ): readonly DatabaseAddress[] {
   return addresses.map((address) => ({
-    account_id: accountID,
-    payment_network: address.payment_network.toUpperCase(),
+    accountId,
+    paymentNetwork: address.paymentNetwork.toUpperCase(),
     environment: address.environment?.toUpperCase(),
     details: address.details,
   }))
@@ -151,5 +151,5 @@ async function insertAddresses(
     .insert(addresses)
     .into<Address>('address')
     .transacting(transaction)
-    .returning(['payment_network', 'environment', 'details'])
+    .returning(['paymentNetwork', 'environment', 'details'])
 }

src/data-access/users.ts

@@ -1,27 +1,32 @@
 import * as knexInit from 'knex'
+import * as knexStringcase from 'knex-stringcase'
 
 import config from '../config'
 import { handleDatabaseError } from '../utils/errors'
 
-const knex = knexInit({
+const knexConfig = {
   client: 'pg',
   connection: config.database.connection,
   pool: {
     /* eslint-disable */
-    afterCreate(conn: any, done: Function): void {
-      conn.query('SET timezone="UTC";', (err: Error) => {
-        if (err) return done(err, conn)
+  afterCreate(conn: any, done: Function): void {
+    conn.query('SET timezone="UTC";', (err: Error) => {
+      if (err) return done(err, conn)
 
-        conn.query('SET statement_timeout TO 3000;', (err: Error) => {
-          // if err is not falsy, connection is discarded from pool
-          done(err, conn)
-        })
+      conn.query('SET statement_timeout TO 3000;', (err: Error) => {
+        // if err is not falsy, connection is discarded from pool
+        done(err, conn)
       })
-    },
-    /* eslint-enable */
+    })
   },
-})
+  /* eslint-enable */
+  },
+}
+
+// Convert between camelCase in the Node app to snake_case in the DB
+const knex = knexInit(knexStringcase(knexConfig))
 
+// Handle all database errors by listening on the callback
 knex.on('query-error', (error) => {
   handleDatabaseError(error)
 })

src/db/knex.ts

@@ -109,7 +109,7 @@ export default async function getPaymentInfo(
 
     return handleHttpError(
       HttpStatus.BadRequest,
-      `Missing Accept header. Must have an Accept header of the form "application/{payment_network}(-{environment})+json".
+      `Missing Accept header. Must have an Accept header of the form "application/{paymentNetwork}(-{environment})+json".
       Examples:
       - 'Accept: application/xrpl-mainnet+json'
       - 'Accept: application/btc-testnet+json'
@@ -132,7 +132,7 @@ export default async function getPaymentInfo(
 
     return handleHttpError(
       HttpStatus.BadRequest,
-      `Invalid Accept header. Must be of the form "application/{payment_network}(-{environment})+json".
+      `Invalid Accept header. Must be of the form "application/{paymentNetwork}(-{environment})+json".
       Examples:
       - 'Accept: application/xrpl-mainnet+json'
       - 'Accept: application/btc-testnet+json'
@@ -176,7 +176,7 @@ export default async function getPaymentInfo(
     addressDetailType: AddressDetailType.CryptoAddress,
     addressDetails: addressInformation.details as CryptoAddressDetails,
   }
-  if (addressInformation.payment_network === 'ACH') {
+  if (addressInformation.paymentNetwork === 'ACH') {
     response = {
       addressDetailType: AddressDetailType.AchAddress,
       addressDetails: addressInformation.details as AchAddressDetails,
@@ -191,7 +191,7 @@ export default async function getPaymentInfo(
   res.locals.paymentInformation = response
   res.locals.response = response
   recordPayIdLookupResult(
-    addressInformation.payment_network,
+    addressInformation.paymentNetwork,
     addressInformation.environment ?? 'unknown',
     true,
   )

src/middlewares/payIds.ts

@@ -80,7 +80,7 @@ export async function postUser(
 
   // TODO:(hbergren) Need to test here and in `putUser()` that `req.body.addresses` is well formed.
   // This includes making sure that everything that is not ACH or ILP is in a CryptoAddressDetails format.
-  // And that we `toUpperCase()` payment_network and environment as part of parsing the addresses.
+  // And that we `toUpperCase()` paymentNetwork and environment as part of parsing the addresses.
   await insertUser(payId, req.body.addresses)
 
   // Set HTTP status and save the PayID to generate the Location header in later middleware

src/middlewares/users.ts

@@ -10,7 +10,7 @@ export async function generatePayIdCountMetrics(): Promise<void> {
 
   payIdCounts.forEach((payIdCount) => {
     recordPayIdCount(
-      payIdCount.payment_network,
+      payIdCount.paymentNetwork,
       payIdCount.environment,
       payIdCount.count,
     )

src/services/payIdReport.ts

@@ -5,31 +5,31 @@ import { CryptoAddressDetails, AchAddressDetails } from './publicAPI'
  */
 export interface Account {
   readonly id: string
-  pay_id: string
+  payId: string
 
-  readonly created_at: Date
-  readonly updated_at: Date
+  readonly createdAt: Date
+  readonly updatedAt: Date
 }
 
 /**
  * Model of the Address table schema for the database.
  */
 export interface Address {
   readonly id: number
-  account_id: string
+  accountId: string
 
-  payment_network: string
+  paymentNetwork: string
   environment?: string | null
   details: CryptoAddressDetails | AchAddressDetails
 
-  readonly created_at: Date
-  readonly updated_at: Date
+  readonly createdAt: Date
+  readonly updatedAt: Date
 }
 
 /**
  * The information retrieved from or inserted into the database for a given address.
  */
 export type AddressInformation = Pick<
   Address,
-  'payment_network' | 'environment' | 'details'
+  'paymentNetwork' | 'environment' | 'details'
 >

src/types/database.ts

@@ -1,8 +1,8 @@
 /**
- * Query result record for a count of PayIDs by environment and payment_network.
+ * Query result record for a count of PayIDs by environment and paymentNetwork.
  */
 export interface PayIdCount {
-  payment_network: string
+  paymentNetwork: string
   environment: string
   count: number
 }

src/types/reports.ts

@@ -61,7 +61,7 @@ export function getPreferredPaymentInfo(
   for (const acceptType of sortedAcceptMediaTypes) {
     const addressInformationForAcceptType = addressInformations.find(
       (result) =>
-        result.payment_network === acceptType.paymentNetwork &&
+        result.paymentNetwork === acceptType.paymentNetwork &&
         (result.environment ?? '') === acceptType.environment,
     )
 

src/utils/acceptHeader.ts

@@ -16,7 +16,7 @@ describe('Data Access - Database Errors', function (): void {
 
   const exampleAddresses = [
     {
-      payment_network: 'ABC',
+      paymentNetwork: 'ABC',
       environment: 'XYZ',
       details: {
         address: 'abc.xyz',
@@ -96,7 +96,7 @@ describe('Data Access - Database Errors', function (): void {
     const payId = 'alice$example.com'
     const addresses = [
       {
-        payment_network: 'XRPL',
+        paymentNetwork: 'XRPL',
         environment: 'TESTNET',
       },
     ]
@@ -114,12 +114,12 @@ describe('Data Access - Database Errors', function (): void {
     )
   })
 
-  it('Raises an error when attempting to insert an address with an empty payment_network', async function () {
+  it('Raises an error when attempting to insert an address with an empty paymentNetwork', async function () {
     // GIVEN a PayID and associated addresses to insert
     const payId = 'alice$example.com'
     const addresses = [
       {
-        payment_network: '',
+        paymentNetwork: '',
         environment: 'TESTNET',
         details: {
           address: 'abc',
@@ -143,7 +143,7 @@ describe('Data Access - Database Errors', function (): void {
     const payId = 'alice$example.com'
     const addresses = [
       {
-        payment_network: 'XRPL',
+        paymentNetwork: 'XRPL',
         environment: '',
         details: {
           address: 'abc',
@@ -162,19 +162,19 @@ describe('Data Access - Database Errors', function (): void {
     )
   })
 
-  it('Raises an error when attempting to insert multiple addresses for the same (payment_network, environment)', async function () {
+  it('Raises an error when attempting to insert multiple addresses for the same (paymentNetwork, environment)', async function () {
     // GIVEN a PayID and associated addresses to insert
     const payId = 'alice$example.com'
     const addresses = [
       {
-        payment_network: 'XRPL',
+        paymentNetwork: 'XRPL',
         environment: 'TESTNET',
         details: {
           address: 'abc',
         },
       },
       {
-        payment_network: 'XRPL',
+        paymentNetwork: 'XRPL',
         environment: 'TESTNET',
         details: {
           address: 'xyz',