From 2f74519da351b235cb366a015077ff8a0ebf918e Mon Sep 17 00:00:00 2001 From: Patrick <50352812+Mueller-Patrick@users.noreply.github.com> Date: Wed, 5 May 2021 23:20:57 +0200 Subject: [PATCH] BETTERZON-76: Adding method descriptions for backend service methods (#40) --- .../models/categories/categories.service.ts | 44 +++--------- .../manufacturers/manufacturers.router.ts | 2 +- .../manufacturers/manufacturers.service.ts | 44 +++--------- Backend/src/models/prices/prices.service.ts | 68 +++++++++---------- .../src/models/products/products.service.ts | 48 ++++--------- Backend/src/models/vendors/vendors.service.ts | 44 +++--------- 6 files changed, 83 insertions(+), 167 deletions(-) diff --git a/Backend/src/models/categories/categories.service.ts b/Backend/src/models/categories/categories.service.ts index 814d6cf..60610d4 100644 --- a/Backend/src/models/categories/categories.service.ts +++ b/Backend/src/models/categories/categories.service.ts @@ -23,6 +23,9 @@ import {Categories} from './categories.interface'; * Service Methods */ +/** + * Fetches and returns all known categories + */ export const findAll = async (): Promise => { let conn; let categRows = []; @@ -54,6 +57,10 @@ export const findAll = async (): Promise => { return categRows; }; +/** + * Fetches and returns the category with the specified id + * @param id The id of the category to fetch + */ export const find = async (id: number): Promise => { let conn; let categ: any; @@ -77,6 +84,10 @@ export const find = async (id: number): Promise => { return categ; }; +/** + * Fetches and returns all categories that match the search term + * @param term the term to match + */ export const findBySearchTerm = async (term: string): Promise => { let conn; let categRows = []; @@ -100,36 +111,3 @@ export const findBySearchTerm = async (term: string): Promise => { return categRows; }; - -// export const create = async (newItem: Product): Promise => { -// let conn; -// try { -// conn = await pool.getConnection(); -// await conn.query(""); -// -// } catch (err) { -// throw err; -// } finally { -// if (conn) conn.end(); -// } -// }; -// -// export const update = async (updatedItem: Product): Promise => { -// if (models.products[updatedItem.product_id]) { -// models.products[updatedItem.product_id] = updatedItem; -// return; -// } -// -// throw new Error("No record found to update"); -// }; -// -// export const remove = async (id: number): Promise => { -// const record: Product = models.products[id]; -// -// if (record) { -// delete models.products[id]; -// return; -// } -// -// throw new Error("No record found to delete"); -// }; diff --git a/Backend/src/models/manufacturers/manufacturers.router.ts b/Backend/src/models/manufacturers/manufacturers.router.ts index 4d64ca9..bbd3c09 100644 --- a/Backend/src/models/manufacturers/manufacturers.router.ts +++ b/Backend/src/models/manufacturers/manufacturers.router.ts @@ -50,7 +50,7 @@ manufacturersRouter.get('/:id', async (req: Request, res: Response) => { } }); -// GET items/:name +// GET items/:term manufacturersRouter.get('/search/:term', async (req: Request, res: Response) => { const term: string = req.params.term; diff --git a/Backend/src/models/manufacturers/manufacturers.service.ts b/Backend/src/models/manufacturers/manufacturers.service.ts index a6f4c1d..2e6444a 100644 --- a/Backend/src/models/manufacturers/manufacturers.service.ts +++ b/Backend/src/models/manufacturers/manufacturers.service.ts @@ -23,6 +23,9 @@ import {Manufacturers} from './manufacturers.interface'; * Service Methods */ +/** + * Fetches and returns all known manufacturers + */ export const findAll = async (): Promise => { let conn; let manRows = []; @@ -54,6 +57,10 @@ export const findAll = async (): Promise => { return manRows; }; +/** + * Fetches and returns the manufacturer with the specified id + * @param id The id of the manufacturer to fetch + */ export const find = async (id: number): Promise => { let conn; let man: any; @@ -77,6 +84,10 @@ export const find = async (id: number): Promise => { return man; }; +/** + * Fetches and returns all manufacturers that match the search term + * @param term the term to match + */ export const findBySearchTerm = async (term: string): Promise => { let conn; let manRows = []; @@ -100,36 +111,3 @@ export const findBySearchTerm = async (term: string): Promise => return manRows; }; - -// export const create = async (newItem: Product): Promise => { -// let conn; -// try { -// conn = await pool.getConnection(); -// await conn.query(""); -// -// } catch (err) { -// throw err; -// } finally { -// if (conn) conn.end(); -// } -// }; -// -// export const update = async (updatedItem: Product): Promise => { -// if (models.products[updatedItem.product_id]) { -// models.products[updatedItem.product_id] = updatedItem; -// return; -// } -// -// throw new Error("No record found to update"); -// }; -// -// export const remove = async (id: number): Promise => { -// const record: Product = models.products[id]; -// -// if (record) { -// delete models.products[id]; -// return; -// } -// -// throw new Error("No record found to delete"); -// }; diff --git a/Backend/src/models/prices/prices.service.ts b/Backend/src/models/prices/prices.service.ts index 8d01bc1..52d811f 100644 --- a/Backend/src/models/prices/prices.service.ts +++ b/Backend/src/models/prices/prices.service.ts @@ -23,6 +23,9 @@ import {Prices} from './prices.interface'; * Service Methods */ +/** + * Fetches and returns all known prices + */ export const findAll = async (): Promise => { let conn; let priceRows = []; @@ -60,6 +63,10 @@ export const findAll = async (): Promise => { return priceRows; }; +/** + * Fetches and returns the price with the specified id + * @param id The id of the price to fetch + */ export const find = async (id: number): Promise => { let conn; let price: any; @@ -83,6 +90,10 @@ export const find = async (id: number): Promise => { return price; }; +/** + * Fetches and returns all prices that belong to the specified product + * @param product the product to fetch the prices for + */ export const findByProduct = async (product: number): Promise => { let conn; let priceRows = []; @@ -106,6 +117,14 @@ export const findByProduct = async (product: number): Promise => { return priceRows; }; +/** + * Fetches and returns prices that belong to the specified product. + * If type is newest, only the newest prices for each vendor will be returned. + * If type is lowest, the lowest daily price for the product is returned. + * Otherwise, all prices for this product are returned. + * @param product The product to fetch the prices for + * @param type The type of prices, e.g. newest / lowest + */ export const findByType = async (product: string, type: string): Promise => { let conn; let priceRows = []; @@ -152,6 +171,15 @@ export const findByType = async (product: string, type: string): Promise return priceRows; }; +/** + * Fetches and returns prices that belong to the specified product and vendor. + * If type is newest, only the newest known price for the product at the vendor is returned. + * If type is lowest, only the lowest ever known price for the product at the vendor is returned. + * Otherwise, all prices for this product are returned. + * @param product The product to fetch the prices for + * @param vendor The vendor to fetch the prices for + * @param type The type of prices, e.g. newest / lowest + */ export const findByVendor = async (product: string, vendor: string, type: string): Promise => { let conn; let priceRows = []; @@ -186,6 +214,11 @@ export const findByVendor = async (product: string, vendor: string, type: string return priceRows; }; +/** + * Fetches and returns the best current deals, i.e. the non-amazon prices that have the biggest difference to amazon prices. + * Only the latest known prices for every vendor are taken into consideration so we only get up-to-date-deals. + * @param amount The amount of deals to return + */ export const getBestDeals = async (amount: number): Promise => { let conn; let priceRows = []; @@ -282,7 +315,7 @@ export const getBestDeals = async (amount: number): Promise => { }; /** - * Get the lowest, latest, non-amazon price for each given product + * Fetches and returns the lowest, latest, non-amazon price for each given product * @param ids the ids of the products */ export const findListByProducts = async (productIds: [number]): Promise => { @@ -344,36 +377,3 @@ export const findListByProducts = async (productIds: [number]): Promise return priceRows; }; - -// export const create = async (newItem: Product): Promise => { -// let conn; -// try { -// conn = await pool.getConnection(); -// await conn.query(""); -// -// } catch (err) { -// throw err; -// } finally { -// if (conn) conn.end(); -// } -// }; -// -// export const update = async (updatedItem: Product): Promise => { -// if (models.products[updatedItem.product_id]) { -// models.products[updatedItem.product_id] = updatedItem; -// return; -// } -// -// throw new Error("No record found to update"); -// }; -// -// export const remove = async (id: number): Promise => { -// const record: Product = models.products[id]; -// -// if (record) { -// delete models.products[id]; -// return; -// } -// -// throw new Error("No record found to delete"); -// }; diff --git a/Backend/src/models/products/products.service.ts b/Backend/src/models/products/products.service.ts index 2c612e2..c0bee72 100644 --- a/Backend/src/models/products/products.service.ts +++ b/Backend/src/models/products/products.service.ts @@ -23,6 +23,9 @@ import {Products} from './products.interface'; * Service Methods */ +/** + * Fetches and returns all known products + */ export const findAll = async (): Promise => { let conn; let prodRows = []; @@ -74,6 +77,10 @@ export const findAll = async (): Promise => { return prodRows; }; +/** + * Fetches and returns the product with the specified id + * @param id The id of the product to fetch + */ export const find = async (id: number): Promise => { let conn; let prod: any; @@ -97,6 +104,10 @@ export const find = async (id: number): Promise => { return prod; }; +/** + * Fetches and returns all products that match the search term + * @param term the term to match + */ export const findBySearchTerm = async (term: string): Promise => { let conn; let prodRows = []; @@ -122,6 +133,10 @@ export const findBySearchTerm = async (term: string): Promise => { return prodRows; }; +/** + * Fetches and returns the product details for the given list of product ids + * @param ids The list of product ids to fetch the details for + */ export const findList = async (ids: [number]): Promise => { let conn; let prodRows = []; @@ -144,36 +159,3 @@ export const findList = async (ids: [number]): Promise => { return prodRows; }; - -// export const create = async (newItem: Product): Promise => { -// let conn; -// try { -// conn = await pool.getConnection(); -// await conn.query(""); -// -// } catch (err) { -// throw err; -// } finally { -// if (conn) conn.end(); -// } -// }; -// -// export const update = async (updatedItem: Product): Promise => { -// if (models.products[updatedItem.product_id]) { -// models.products[updatedItem.product_id] = updatedItem; -// return; -// } -// -// throw new Error("No record found to update"); -// }; -// -// export const remove = async (id: number): Promise => { -// const record: Product = models.products[id]; -// -// if (record) { -// delete models.products[id]; -// return; -// } -// -// throw new Error("No record found to delete"); -// }; diff --git a/Backend/src/models/vendors/vendors.service.ts b/Backend/src/models/vendors/vendors.service.ts index 70c0ef2..ca8bbee 100644 --- a/Backend/src/models/vendors/vendors.service.ts +++ b/Backend/src/models/vendors/vendors.service.ts @@ -23,6 +23,9 @@ import {Vendors} from './vendors.interface'; * Service Methods */ +/** + * Fetches and returns all known vendors + */ export const findAll = async (): Promise => { let conn; let vendorRows = []; @@ -66,6 +69,10 @@ export const findAll = async (): Promise => { return vendorRows; }; +/** + * Fetches and returns the vendor with the specified id + * @param id The id of the vendor to fetch + */ export const find = async (id: number): Promise => { let conn; let vendor: any; @@ -89,6 +96,10 @@ export const find = async (id: number): Promise => { return vendor; }; +/** + * Fetches and returns all vendors that match the search term + * @param term the term to match + */ export const findBySearchTerm = async (term: string): Promise => { let conn; let vendorRows = []; @@ -112,36 +123,3 @@ export const findBySearchTerm = async (term: string): Promise => { return vendorRows; }; - -// export const create = async (newItem: Product): Promise => { -// let conn; -// try { -// conn = await pool.getConnection(); -// await conn.query(""); -// -// } catch (err) { -// throw err; -// } finally { -// if (conn) conn.end(); -// } -// }; -// -// export const update = async (updatedItem: Product): Promise => { -// if (models.products[updatedItem.product_id]) { -// models.products[updatedItem.product_id] = updatedItem; -// return; -// } -// -// throw new Error("No record found to update"); -// }; -// -// export const remove = async (id: number): Promise => { -// const record: Product = models.products[id]; -// -// if (record) { -// delete models.products[id]; -// return; -// } -// -// throw new Error("No record found to delete"); -// };