chore(market): isolate as much logic as possible (#54)

* chore(market): isolate as much logic as possible

* chore: codacy style fix

modules/venat-module-xiv-market/src/commands/market.command.ts

@@ -7,10 +7,10 @@ import {
 } from '@discord-nestjs/core';
 import { Logger } from '@nestjs/common';
 import { InteractionReplyOptions, MessageEmbed } from 'discord.js';
-import { getMarketListings } from '../data/universalis';
+import { getMarketInfo } from '../data/universalis';
 import { getItemIdByName } from '../data/xivapi';
-import { table } from 'table';
 import { MarketDto } from '../dto/market.dto';
+import { buildTextTable, getMarketInfoByName } from '../data/listings';
 
 @Command({
   description: 'Look up prices for an item on the market board.',
@@ -23,58 +23,21 @@ export class MarketCommand implements DiscordTransformedCommand<MarketDto> {
   public async handler(
     @Payload() dto: MarketDto,
   ): Promise<InteractionReplyOptions> {
-    const itemLookup = await getItemIdByName(dto.item);
-    if (itemLookup.err != null) {
-      this.logger.error(itemLookup.err.message, itemLookup.err.stack);
-      return {
-        content: 'Failed to access XIVAPI; please try again later.',
-      };
+    const getMarketInfoPartial = getMarketInfoByName(
+      getItemIdByName,
+      getMarketInfo,
+      this.logger.error,
+    );
+    const marketInfo = await getMarketInfoPartial(dto.item, dto.server);
+    if (typeof marketInfo === 'string') {
+      return { content: marketInfo };
     }
 
-    if (!itemLookup.success) {
-      return {
-        content:
-          'The item could not be found; please check your spelling and try again.',
-      };
-    }
-
-    const item = itemLookup.value;
-    const marketLookup = await getMarketListings(item.ID, dto.server);
-    if (marketLookup.err != null) {
-      this.logger.error(marketLookup.err.message, marketLookup.err.stack);
-      return {
-        content:
-          'The item could not be found; please check your spelling of the server and try again.',
-      };
-    }
-
-    if (!marketLookup.success) {
-      return {
-        content:
-          'The item could not be found; please check your spelling and try again.',
-      };
-    }
-
-    const { lastUploadTime, listings, worldName, dcName } = marketLookup.value;
+    const { lastUploadTime, listings, worldName, dcName, itemName } =
+      marketInfo;
     const listingsEmbed = new MessageEmbed()
-      .setTitle(`Cheapest listings for ${item.Name} on ${dcName ?? worldName}`)
-      .setDescription(
-        '```' +
-          table([
-            ['HQ', 'Unit Price', 'Quantity', 'Total', 'World'],
-            ...listings
-              .sort((a, b) => a.pricePerUnit - b.pricePerUnit)
-              .slice(0, 10)
-              .map((l) => [
-                l.hq ? 'Yes' : 'No',
-                l.pricePerUnit.toLocaleString('en'),
-                l.quantity.toLocaleString('en'),
-                l.total.toLocaleString('en'),
-                worldName ?? l.worldName,
-              ]),
-          ]) +
-          '```',
-      )
+      .setTitle(`Cheapest listings for ${itemName} on ${dcName ?? worldName}`)
+      .setDescription('```' + buildTextTable(listings, worldName) + '```')
       .setColor('#a58947')
       .setFooter({
         text: 'Last updated:',

modules/venat-module-xiv-market/src/data/listings.ts

@@ -0,0 +1,81 @@
+import { LookupResult } from '@the-convocation/venat-core';
+import { table } from 'table';
+import { UniversalisMarketInfo } from './universalis';
+import { XIVAPIItem } from './xivapi';
+
+export interface MarketListing {
+  pricePerUnit: number;
+  quantity: number;
+  total: number;
+  hq: boolean;
+  worldName?: string;
+}
+
+export interface MarketInfo {
+  itemId: number;
+  itemName: string;
+  worldName?: string;
+  dcName?: string;
+  lastUploadTime: number;
+  listings: MarketListing[];
+}
+
+export function buildTextTable(
+  listings: MarketListing[],
+  worldName?: string,
+): string {
+  return table([
+    ['HQ', 'Unit Price', 'Quantity', 'Total', 'World'],
+    ...listings
+      .sort((a, b) => a.pricePerUnit - b.pricePerUnit)
+      .slice(0, 10)
+      .map((l) => [
+        l.hq ? 'Yes' : 'No',
+        l.pricePerUnit.toLocaleString('en'),
+        l.quantity.toLocaleString('en'),
+        l.total.toLocaleString('en'),
+        worldName ?? l.worldName,
+      ]),
+  ]);
+}
+
+export function getMarketInfoByName(
+  getItemIdByName: (itemName: string) => Promise<LookupResult<XIVAPIItem>>,
+  getMarketInfo: (
+    itemId: number,
+    server: string,
+  ) => Promise<LookupResult<UniversalisMarketInfo>>,
+  logError: (message?: string, stack?: string) => void,
+): (itemName: string, server: string) => Promise<MarketInfo | string> {
+  return async (
+    itemName: string,
+    server: string,
+  ): Promise<MarketInfo | string> => {
+    const itemLookup = await getItemIdByName(itemName);
+    if (itemLookup.err != null) {
+      logError(itemLookup.err.message, itemLookup.err.stack);
+      return 'Failed to access XIVAPI; please try again later.';
+    }
+
+    if (!itemLookup.success) {
+      return 'The item could not be found; please check your spelling and try again.';
+    }
+
+    const item = itemLookup.value;
+    const marketLookup = await getMarketInfo(item.ID, server);
+    if (marketLookup.err != null) {
+      logError(marketLookup.err.message, marketLookup.err.stack);
+      return 'The item could not be found; please check your spelling of the server and try again.';
+    }
+
+    if (!marketLookup.success) {
+      return 'The item could not be found; please check your spelling and try again.';
+    }
+
+    return {
+      ...marketLookup.value,
+      itemId: itemLookup.value.ID,
+      itemName: itemLookup.value.Name,
+    };
+  };
+}

modules/venat-module-xiv-market/src/data/universalis.ts

@@ -15,7 +15,7 @@ export interface UniversalisMarketInfo {
   dcName?: string;
 }
 
-export async function getMarketListings(
+export async function getMarketInfo(
   itemId: number,
   server: string,
 ): Promise<LookupResult<UniversalisMarketInfo>> {