Merge pull request #67 from letehaha/feat/add-custom-field-to-rates

feat: Add `custom` field to exchange rates response

src/models/ExchangeRates.model.ts

@@ -8,6 +8,11 @@ import { Op } from 'sequelize';
 import { Transaction } from 'sequelize/types';
 import Currencies from './Currencies.model';
 
+interface ModelOptions {
+  transaction?: Transaction,
+  raw?: boolean,
+}
+
 @Table({
   timestamps: true,
   createdAt: 'date',
@@ -45,7 +50,7 @@ export async function getRatesForCurrenciesPairs(
     baseCode: string;
     quoteCode: string;
   }[],
-  { transaction }: { transaction?: Transaction } = {},
+  modelOptions: ModelOptions,
 ) {
   return ExchangeRates.findAll({
     where: {
@@ -56,6 +61,6 @@ export async function getRatesForCurrenciesPairs(
         }
       }))
     },
-    transaction,
+    ...modelOptions,
   })
 }

src/models/UserExchangeRates.model.ts

@@ -10,6 +10,11 @@ import Currencies, { getCurrencies } from './Currencies.model';
 import Users from './Users.model';
 import { ValidationError } from '@js/errors';
 
+interface ModelOptions {
+  transaction?: Transaction,
+  raw?: boolean,
+}
+
 @Table({ timestamps: true })
 export default class UserExchangeRates extends Model {
   @Column({
@@ -48,11 +53,11 @@ export interface ExchangeRatePair {
 }
 export async function getRates(
   { userId, pair }: { userId: number; pair: ExchangeRatePair },
-  { transaction }: { transaction?: Transaction },
+  modelOptions: ModelOptions,
 );
 export async function getRates(
   { userId, pairs }: { userId: number; pairs: ExchangeRatePair[] },
-  { transaction }: { transaction?: Transaction },
+  modelOptions: ModelOptions,
 );
 export async function getRates(
   {
@@ -64,7 +69,7 @@ export async function getRates(
     pair?: ExchangeRatePair,
     pairs?: ExchangeRatePair[],
   },
-  { transaction }: { transaction?: Transaction } = {},
+  modelOptions: ModelOptions,
 ) {
   const where: Record<string|symbol, unknown> = {
     userId,
@@ -95,7 +100,8 @@ export async function getRates(
 
   return UserExchangeRates.findAll({
     where,
-    transaction,
+    attributes: { exclude: ['userId'] },
+    ...modelOptions,
   })
 }
 

src/services/user-exchange-rate/get-exchange-rate.service.ts

@@ -43,13 +43,16 @@ export async function getExchangeRate(
     const [userExchangeRate] = await UserExchangeRates.getRates({
       userId,
       pair,
-    }, { transaction });
+    }, { transaction, raw: true });
 
-    if (userExchangeRate) return userExchangeRate
+    if (userExchangeRate) {
+      // Add `custom` so client can understand which rate is custom
+      return { ...userExchangeRate, custom: true }
+    }
 
     const [exchangeRate] = await ExchangeRates.getRatesForCurrenciesPairs(
       [pair],
-      { transaction },
+      { transaction, raw: true },
     );
 
     return exchangeRate;

src/services/user-exchange-rate/get-user-exchange-rates.service.ts

@@ -5,6 +5,13 @@ import * as UsersCurrencies from '@models/UsersCurrencies.model';
 
 import { getExchangeRate } from './get-exchange-rate.service';
 
+/**
+ * By default we just return system exchange rates from ExchangeRates table.
+ * If user wants to edit exchange rate, he can add one to UserExchangeRates, so
+ * then we will return and use his custom rate. If user wants to use system rate
+ * back, we need to remove his custom record from UserExchangeRates table
+ */
+
 export async function getUserExchangeRates(
   { userId }: { userId: number },
   { transaction }: { transaction?: Transaction } = {},