Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add COE API for date ranges #57

Merged
merged 3 commits into from
Oct 6, 2024
Merged

Add COE API for date ranges #57

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2f1fad2
Add COE API for date ranges
ruchernchong Oct 6, 2024
171b54d
Reduce cognitive complexity for the endpoints
ruchernchong Oct 6, 2024
6fb0eb5
Fix filter and sorting not returning data properly
ruchernchong Oct 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
89 changes: 50 additions & 39 deletions src/v1/routes/coe.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import type { COEResult } from "../../types";
import { Collection, OrderBy } from "../../types";
import redis from "../../config/redis";
import { getLatestMonth } from "../../lib/getLatestMonth";
import { parse } from "date-fns";
import { isValid, parse } from "date-fns";

type QueryParams = {
sort?: string;
Expand All @@ -18,24 +18,37 @@ const CACHE_TTL = 60 * 60 * 24; // 1 day in seconds

const app = new Hono();

app.get("/", async (c) => {
const query = c.req.query() as QueryParams;
const { sort, orderBy, ...filterQuery } = query;
const getCachedData = <T>(cacheKey: string) => redis.get<T>(cacheKey);

const CACHE_KEY = `coe:${JSON.stringify(query)}`;
const cachedData = await redis.get<COEResult[]>(CACHE_KEY);
if (cachedData) {
return c.json(cachedData);
}
const setCachedData = <T>(cacheKey: string, data: T) =>
redis.set(cacheKey, data, { ex: CACHE_TTL });

const buildSortQuery = (
sort?: string,
orderBy: OrderBy = OrderBy.DESC,
): Sort => {
const defaultSort: Sort = { month: -1, bidding_no: 1, vehicle_class: 1 };

let sortQuery: Sort = { month: -1, bidding_no: 1, vehicle_class: 1 };
if (sort) {
const sortDirection = orderBy === OrderBy.DESC ? -1 : 1;
sortQuery = { [sort]: sortDirection } as Sort;
return { ...defaultSort, [sort]: orderBy === OrderBy.ASC ? 1 : -1 } as Sort;
}

const mongoQuery: Filter<COEResult> = {};
if (!filterQuery.month) {
return defaultSort;
};

const buildMongoQuery = async <T>(query: QueryParams): Promise<Filter<T>> => {
const { sort, orderBy, from, to, ...filterQuery } = query;
const mongoQuery: Filter<T> = {};

if (from || to) {
mongoQuery.month = {};
if (from && isValid(parse(from, "yyyy-MM", new Date()))) {
mongoQuery.month.$gte = from;
}
if (to && isValid(parse(to, "yyyy-MM", new Date()))) {
mongoQuery.month.$lte = to;
}
} else if (!filterQuery.month) {
const latestMonth = parse(
await getLatestMonth(Collection.COE),
"yyyy-MM",
Expand All @@ -46,46 +59,44 @@ app.get("/", async (c) => {
latestMonth.getMonth() + 1,
1,
);

const pastYearFormatted = pastYear.toISOString().slice(0, 7); // YYYY-MM format
const currentMonthFormatted = latestMonth.toISOString().slice(0, 7); // YYYY-MM format

mongoQuery.month = {
$gte: pastYearFormatted,
$lte: currentMonthFormatted,
$gte: pastYear.toISOString().slice(0, 7),
$lte: latestMonth.toISOString().slice(0, 7),
};
}

for (const [key, value] of Object.entries(filterQuery)) {
mongoQuery[key] = value;
}
return { ...mongoQuery, ...filterQuery };
};

const fetchData = <T>(mongoQuery: Filter<T>, sortQuery: Sort) =>
db.collection<T>(Collection.COE).find(mongoQuery).sort(sortQuery).toArray();

const result = await db
.collection<COEResult[]>(Collection.COE)
.find(mongoQuery)
.sort(sortQuery)
.toArray();
app.get("/", async (c) => {
const query = c.req.query() as QueryParams;
const CACHE_KEY = `coe:${JSON.stringify(query)}`;
const cachedData = await getCachedData<COEResult[]>(CACHE_KEY);
if (cachedData) return c.json(cachedData);

await redis.set(CACHE_KEY, result, { ex: CACHE_TTL });
const sortQuery = buildSortQuery(query.sort, query.orderBy);
const mongoQuery = await buildMongoQuery<COEResult>(query);
const result = await fetchData(mongoQuery, sortQuery);

await setCachedData(CACHE_KEY, result);
return c.json(result);
});

app.get("/latest", async (c) => {
const CACHE_KEY = `coe:latest`;
const cachedData = await redis.get<COEResult[]>(CACHE_KEY);
if (cachedData) {
return c.json(cachedData);
}
const cachedData = await getCachedData<COEResult[]>(CACHE_KEY);
if (cachedData) return c.json(cachedData);

const latestMonth = await getLatestMonth(Collection.COE);
const result = await db
.collection<COEResult[]>(Collection.COE)
.find({ month: latestMonth })
.sort({ bidding_no: 1, vehicle_class: 1 })
.toArray();
const result = await fetchData(
{ month: latestMonth },
{ bidding_no: 1, vehicle_class: 1 },
);

await redis.set(CACHE_KEY, result, { ex: CACHE_TTL });
await setCachedData(CACHE_KEY, result);

return c.json(result);
});
Expand Down