fix(error): add sanity checks before error destructuring

also preserve original stack trace(and print it) in dev mode
This commit is contained in:
zyachel 2024-08-23 03:16:05 +05:30
parent 333d3b107e
commit e320557add
16 changed files with 79 additions and 58 deletions

View File

@ -3,7 +3,7 @@ import Find, { type FindQueryParams } from 'src/interfaces/shared/search';
import basicSearch from 'src/utils/fetchers/basicSearch'; import basicSearch from 'src/utils/fetchers/basicSearch';
import getOrSetApiCache from 'src/utils/getOrSetApiCache'; import getOrSetApiCache from 'src/utils/getOrSetApiCache';
import { findKey } from 'src/utils/constants/keys'; import { findKey } from 'src/utils/constants/keys';
import { AppError, cleanQueryStr } from 'src/utils/helpers'; import { AppError, cleanQueryStr, getErrorProperties } from 'src/utils/helpers';
import { findFilterable } from 'src/utils/constants/find'; import { findFilterable } from 'src/utils/constants/find';
type ResponseData = type ResponseData =
@ -25,8 +25,8 @@ export default async function handler(req: NextApiRequest, res: NextApiResponse<
const results = await getOrSetApiCache(findKey(queryStr), basicSearch, queryStr); const results = await getOrSetApiCache(findKey(queryStr), basicSearch, queryStr);
res.status(200).json({ status: true, data: { title: query, results } }); res.status(200).json({ status: true, data: { title: query, results } });
} catch (error: any) { } catch (error) {
const { message = 'Not found', statusCode = 404 } = error; const { message, statusCode } = getErrorProperties(error);
res.status(statusCode).json({ status: false, message }); res.status(statusCode).json({ status: false, message });
} }
} }

View File

@ -3,7 +3,7 @@ import type Name from 'src/interfaces/shared/name';
import name from 'src/utils/fetchers/name'; import name from 'src/utils/fetchers/name';
import getOrSetApiCache from 'src/utils/getOrSetApiCache'; import getOrSetApiCache from 'src/utils/getOrSetApiCache';
import { nameKey } from 'src/utils/constants/keys'; import { nameKey } from 'src/utils/constants/keys';
import { AppError } from 'src/utils/helpers'; import { AppError, getErrorProperties } from 'src/utils/helpers';
type ResponseData = { status: true; data: Name } | { status: false; message: string }; type ResponseData = { status: true; data: Name } | { status: false; message: string };
@ -15,8 +15,9 @@ export default async function handler(req: NextApiRequest, res: NextApiResponse<
const data = await getOrSetApiCache(nameKey(nameId), name, nameId); const data = await getOrSetApiCache(nameKey(nameId), name, nameId);
res.status(200).json({ status: true, data }); res.status(200).json({ status: true, data });
} catch (error: any) { } catch (error) {
const { message = 'Not found', statusCode = 404 } = error; const { message, statusCode } = getErrorProperties(error);
res.status(statusCode).json({ status: false, message }); res.status(statusCode).json({ status: false, message });
} }
} }

View File

@ -3,7 +3,7 @@ import type Title from 'src/interfaces/shared/title';
import title from 'src/utils/fetchers/title'; import title from 'src/utils/fetchers/title';
import getOrSetApiCache from 'src/utils/getOrSetApiCache'; import getOrSetApiCache from 'src/utils/getOrSetApiCache';
import { titleKey } from 'src/utils/constants/keys'; import { titleKey } from 'src/utils/constants/keys';
import { AppError } from 'src/utils/helpers'; import { AppError, getErrorProperties } from 'src/utils/helpers';
type ResponseData = { status: true; data: Title } | { status: false; message: string }; type ResponseData = { status: true; data: Title } | { status: false; message: string };
@ -14,8 +14,8 @@ export default async function handler(req: NextApiRequest, res: NextApiResponse<
const titleId = req.query.titleId as string; const titleId = req.query.titleId as string;
const data = await getOrSetApiCache(titleKey(titleId), title, titleId); const data = await getOrSetApiCache(titleKey(titleId), title, titleId);
res.status(200).json({ status: true, data }); res.status(200).json({ status: true, data });
} catch (error: any) { } catch (error) {
const { message = 'Not found', statusCode = 404 } = error; const { message, statusCode } = getErrorProperties(error);
res.status(statusCode).json({ status: false, message }); res.status(statusCode).json({ status: false, message });
} }
} }

View File

@ -3,7 +3,7 @@ import type { TitleReviewsCursored } from 'src/interfaces/shared/titleReviews';
import { cursoredReviews } from 'src/utils/fetchers/titleReviews'; import { cursoredReviews } from 'src/utils/fetchers/titleReviews';
import getOrSetApiCache from 'src/utils/getOrSetApiCache'; import getOrSetApiCache from 'src/utils/getOrSetApiCache';
import { titleReviewsKey } from 'src/utils/constants/keys'; import { titleReviewsKey } from 'src/utils/constants/keys';
import { AppError, cleanQueryStr } from 'src/utils/helpers'; import { AppError, cleanQueryStr, getErrorProperties } from 'src/utils/helpers';
import { keys as titleReviewsQueryKeys } from 'src/utils/constants/titleReviewsFilters'; import { keys as titleReviewsQueryKeys } from 'src/utils/constants/titleReviewsFilters';
type ResponseData = type ResponseData =
@ -26,8 +26,8 @@ export default async function handler(req: NextApiRequest, res: NextApiResponse<
queryStr queryStr
); );
res.status(200).json({ status: true, data }); res.status(200).json({ status: true, data });
} catch (error: any) { } catch (error) {
const { message = 'Not found', statusCode = 404 } = error; const { message, statusCode } = getErrorProperties(error);
res.status(statusCode).json({ status: false, message }); res.status(statusCode).json({ status: false, message });
} }
} }

View File

@ -4,7 +4,7 @@ import reviews from 'src/utils/fetchers/titleReviews';
import getOrSetApiCache from 'src/utils/getOrSetApiCache'; import getOrSetApiCache from 'src/utils/getOrSetApiCache';
import { titleReviewsKey } from 'src/utils/constants/keys'; import { titleReviewsKey } from 'src/utils/constants/keys';
import { keys } from 'src/utils/constants/titleReviewsFilters'; import { keys } from 'src/utils/constants/titleReviewsFilters';
import { AppError, cleanQueryStr } from 'src/utils/helpers'; import { AppError, cleanQueryStr, getErrorProperties } from 'src/utils/helpers';
type ResponseData = { status: true; data: TitleReviews } | { status: false; message: string }; type ResponseData = { status: true; data: TitleReviews } | { status: false; message: string };
@ -22,8 +22,8 @@ export default async function handler(req: NextApiRequest, res: NextApiResponse<
queryStr queryStr
); );
res.status(200).json({ status: true, data }); res.status(200).json({ status: true, data });
} catch (error: any) { } catch (error) {
const { message = 'Not found', statusCode = 404 } = error; const { message, statusCode } = getErrorProperties(error);
res.status(statusCode).json({ status: false, message }); res.status(statusCode).json({ status: false, message });
} }
} }

View File

@ -8,7 +8,7 @@ import Find, { FindQueryParams } from 'src/interfaces/shared/search';
import { AppError } from 'src/interfaces/shared/error'; import { AppError } from 'src/interfaces/shared/error';
import basicSearch from 'src/utils/fetchers/basicSearch'; import basicSearch from 'src/utils/fetchers/basicSearch';
import getOrSetApiCache from 'src/utils/getOrSetApiCache'; import getOrSetApiCache from 'src/utils/getOrSetApiCache';
import { cleanQueryStr } from 'src/utils/helpers'; import { cleanQueryStr, getErrorProperties } from 'src/utils/helpers';
import { findKey } from 'src/utils/constants/keys'; import { findKey } from 'src/utils/constants/keys';
import styles from 'src/styles/modules/pages/find/find.module.scss'; import styles from 'src/styles/modules/pages/find/find.module.scss';
import { findFilterable } from 'src/utils/constants/find'; import { findFilterable } from 'src/utils/constants/find';
@ -66,8 +66,8 @@ export const getServerSideProps: GetServerSideProps<Data, FindQueryParams> = asy
return { return {
props: { data: { title: query, results: res }, error: null, originalPath }, props: { data: { title: query, results: res }, error: null, originalPath },
}; };
} catch (error: any) { } catch (error) {
const { message, statusCode } = error; const { message, statusCode } = getErrorProperties(error);
ctx.res.statusCode = statusCode; ctx.res.statusCode = statusCode;
ctx.res.statusMessage = message; ctx.res.statusMessage = message;

View File

@ -8,7 +8,7 @@ import Name from 'src/interfaces/shared/name';
import { AppError } from 'src/interfaces/shared/error'; import { AppError } from 'src/interfaces/shared/error';
import name from 'src/utils/fetchers/name'; import name from 'src/utils/fetchers/name';
import getOrSetApiCache from 'src/utils/getOrSetApiCache'; import getOrSetApiCache from 'src/utils/getOrSetApiCache';
import { getProxiedIMDbImgUrl } from 'src/utils/helpers'; import { getErrorProperties, getProxiedIMDbImgUrl } from 'src/utils/helpers';
import { nameKey } from 'src/utils/constants/keys'; import { nameKey } from 'src/utils/constants/keys';
import styles from 'src/styles/modules/pages/name/name.module.scss'; import styles from 'src/styles/modules/pages/name/name.module.scss';
@ -54,9 +54,8 @@ export const getServerSideProps: GetServerSideProps<Data, Params> = async ctx =>
const data = await getOrSetApiCache(nameKey(nameId), name, nameId); const data = await getOrSetApiCache(nameKey(nameId), name, nameId);
return { props: { data, error: null, originalPath } }; return { props: { data, error: null, originalPath } };
} catch (error: any) { } catch (error) {
const { message, statusCode } = error; const { message, statusCode } = getErrorProperties(error);
ctx.res.statusCode = statusCode; ctx.res.statusCode = statusCode;
ctx.res.statusMessage = message; ctx.res.statusMessage = message;

View File

@ -8,7 +8,7 @@ import Title from 'src/interfaces/shared/title';
import { AppError } from 'src/interfaces/shared/error'; import { AppError } from 'src/interfaces/shared/error';
import getOrSetApiCache from 'src/utils/getOrSetApiCache'; import getOrSetApiCache from 'src/utils/getOrSetApiCache';
import title from 'src/utils/fetchers/title'; import title from 'src/utils/fetchers/title';
import { getProxiedIMDbImgUrl } from 'src/utils/helpers'; import { getErrorProperties, getProxiedIMDbImgUrl } from 'src/utils/helpers';
import { titleKey } from 'src/utils/constants/keys'; import { titleKey } from 'src/utils/constants/keys';
import styles from 'src/styles/modules/pages/title/title.module.scss'; import styles from 'src/styles/modules/pages/title/title.module.scss';
@ -63,8 +63,8 @@ export const getServerSideProps: GetServerSideProps<Data, Params> = async ctx =>
const data = await getOrSetApiCache(titleKey(titleId), title, titleId); const data = await getOrSetApiCache(titleKey(titleId), title, titleId);
return { props: { data, error: null, originalPath } }; return { props: { data, error: null, originalPath } };
} catch (error: any) { } catch (error) {
const { message, statusCode } = error; const { message, statusCode } = getErrorProperties(error);
ctx.res.statusCode = statusCode; ctx.res.statusCode = statusCode;
ctx.res.statusMessage = message; ctx.res.statusMessage = message;

View File

@ -6,7 +6,7 @@ import { BasicCard, Filters, Pagination, Reviews } from 'src/components/titleRev
import { AppError } from 'src/interfaces/shared/error'; import { AppError } from 'src/interfaces/shared/error';
import getOrSetApiCache from 'src/utils/getOrSetApiCache'; import getOrSetApiCache from 'src/utils/getOrSetApiCache';
import { cursoredReviews } from 'src/utils/fetchers/titleReviews'; import { cursoredReviews } from 'src/utils/fetchers/titleReviews';
import { cleanQueryStr } from 'src/utils/helpers'; import { cleanQueryStr, getErrorProperties } from 'src/utils/helpers';
import { titleReviewsKey } from 'src/utils/constants/keys'; import { titleReviewsKey } from 'src/utils/constants/keys';
import styles from 'src/styles/modules/pages/titleReviews/titleReviews.module.scss'; import styles from 'src/styles/modules/pages/titleReviews/titleReviews.module.scss';
import { TitleReviewsCursored } from 'src/interfaces/shared/titleReviews'; import { TitleReviewsCursored } from 'src/interfaces/shared/titleReviews';
@ -60,8 +60,8 @@ export const getServerSideProps: GetServerSideProps<Data, Params> = async ctx =>
); );
return { props: { data, error: null, originalPath } }; return { props: { data, error: null, originalPath } };
} catch (error: any) { } catch (error) {
const { message, statusCode } = error; const { message, statusCode } = getErrorProperties(error);
ctx.res.statusCode = statusCode; ctx.res.statusCode = statusCode;
ctx.res.statusMessage = message; ctx.res.statusMessage = message;

View File

@ -6,7 +6,7 @@ import { Filters, Pagination, Reviews, TitleCard } from 'src/components/titleRev
import { AppError } from 'src/interfaces/shared/error'; import { AppError } from 'src/interfaces/shared/error';
import getOrSetApiCache from 'src/utils/getOrSetApiCache'; import getOrSetApiCache from 'src/utils/getOrSetApiCache';
import titleReviews from 'src/utils/fetchers/titleReviews'; import titleReviews from 'src/utils/fetchers/titleReviews';
import { cleanQueryStr, getProxiedIMDbImgUrl } from 'src/utils/helpers'; import { cleanQueryStr, getErrorProperties, getProxiedIMDbImgUrl } from 'src/utils/helpers';
import { titleReviewsKey } from 'src/utils/constants/keys'; import { titleReviewsKey } from 'src/utils/constants/keys';
import styles from 'src/styles/modules/pages/titleReviews/titleReviews.module.scss'; import styles from 'src/styles/modules/pages/titleReviews/titleReviews.module.scss';
import TitleReviews from 'src/interfaces/shared/titleReviews'; import TitleReviews from 'src/interfaces/shared/titleReviews';
@ -80,8 +80,8 @@ export const getServerSideProps: GetServerSideProps<Data, Params> = async ctx =>
); );
return { props: { data, error: null, originalPath } }; return { props: { data, error: null, originalPath } };
} catch (error: any) { } catch (error) {
const { message, statusCode } = error; const { message, statusCode } = getErrorProperties(error);
ctx.res.statusCode = statusCode; ctx.res.statusCode = statusCode;
ctx.res.statusMessage = message; ctx.res.statusMessage = message;

View File

@ -14,4 +14,7 @@ const axiosInstance = axios.create({
}, },
}); });
export const isSaneError = axios.isAxiosError;
export default axiosInstance; export default axiosInstance;

View File

@ -1,6 +1,6 @@
import * as cheerio from 'cheerio'; import * as cheerio from 'cheerio';
import RawFind from 'src/interfaces/misc/rawFind'; import RawFind from 'src/interfaces/misc/rawFind';
import axiosInstance from 'src/utils/axiosInstance'; import axiosInstance, { isSaneError } from 'src/utils/axiosInstance';
import { AppError } from 'src/utils/helpers'; import { AppError } from 'src/utils/helpers';
import cleanFind from 'src/utils/cleaners/find'; import cleanFind from 'src/utils/cleaners/find';
@ -14,11 +14,10 @@ const basicSearch = async (queryStr: string) => {
const cleanData = cleanFind(parsedRawData); const cleanData = cleanFind(parsedRawData);
return cleanData; return cleanData;
} catch (err: any) { } catch (err) {
if (err.response?.status === 404) if (isSaneError(err) && err.response?.status === 404) throw new AppError('not found', 404, err);
throw new AppError('not found', 404, err.cause);
throw new AppError('something went wrong', 500, err.cause); throw new AppError('something went wrong', 500, err);
} }
}; };

View File

@ -1,6 +1,6 @@
import * as cheerio from 'cheerio'; import * as cheerio from 'cheerio';
import RawName from 'src/interfaces/misc/rawName'; import RawName from 'src/interfaces/misc/rawName';
import axiosInstance from 'src/utils/axiosInstance'; import axiosInstance, { isSaneError } from 'src/utils/axiosInstance';
import cleanName from 'src/utils/cleaners/name'; import cleanName from 'src/utils/cleaners/name';
import { AppError } from 'src/utils/helpers'; import { AppError } from 'src/utils/helpers';
@ -15,10 +15,10 @@ const name = async (nameId: string) => {
const cleanData = cleanName(parsedRawData); const cleanData = cleanName(parsedRawData);
// returning // returning
return cleanData; return cleanData;
} catch (err: any) { } catch (err) {
if (err.response?.status === 404) throw new AppError('not found', 404, err.cause); if (isSaneError(err) && err.response?.status === 404) throw new AppError('not found', 404, err);
throw new AppError('something went wrong', 500, err.cause); throw new AppError('something went wrong', 500, err);
} }
}; };

View File

@ -1,6 +1,6 @@
import * as cheerio from 'cheerio'; import * as cheerio from 'cheerio';
import RawTitle from 'src/interfaces/misc/rawTitle'; import RawTitle from 'src/interfaces/misc/rawTitle';
import axiosInstance from 'src/utils/axiosInstance'; import axiosInstance, { isSaneError } from 'src/utils/axiosInstance';
import cleanTitle from 'src/utils/cleaners/title'; import cleanTitle from 'src/utils/cleaners/title';
import { AppError } from 'src/utils/helpers'; import { AppError } from 'src/utils/helpers';
@ -15,11 +15,10 @@ const title = async (titleId: string) => {
const cleanData = cleanTitle(parsedRawData); const cleanData = cleanTitle(parsedRawData);
// returning // returning
return cleanData; return cleanData;
} catch (err: any) { } catch (err) {
if (err.response?.status === 404) if (isSaneError(err) && err.response?.status === 404) throw new AppError('not found', 404, err);
throw new AppError('not found', 404, err.cause);
throw new AppError('something went wrong', 500, err.cause); throw new AppError('something went wrong', 500, err);
} }
}; };

View File

@ -1,6 +1,6 @@
import { AxiosError } from 'axios'; import { AxiosError } from 'axios';
import * as cheerio from 'cheerio'; import * as cheerio from 'cheerio';
import axiosInstance from 'src/utils/axiosInstance'; import axiosInstance, { isSaneError } from 'src/utils/axiosInstance';
import { AppError } from 'src/utils/helpers'; import { AppError } from 'src/utils/helpers';
const reviews = async (titleId: string, queryStr = '') => { const reviews = async (titleId: string, queryStr = '') => {
@ -27,12 +27,12 @@ const reviews = async (titleId: string, queryStr = '') => {
return { meta, list, cursor }; return { meta, list, cursor };
} catch (err) { } catch (err) {
if (err instanceof AxiosError && err.response?.status === 404) if (isSaneError(err) && err.response?.status === 404)
throw new AppError('not found', 404, err.cause); throw new AppError('not found', 404, err);
if (err instanceof AppError) throw err; if (err instanceof AppError) throw err;
throw new AppError('something went wrong', 500, err instanceof Error ? err.cause : undefined); throw new AppError('something went wrong', 500, err);
} }
}; };
@ -62,12 +62,12 @@ export const cursoredReviews = async (
return { meta: { title, titleId }, list, cursor }; return { meta: { title, titleId }, list, cursor };
} catch (err) { } catch (err) {
if (err instanceof AxiosError && err.response?.status === 404) if (isSaneError(err) && err.response?.status === 404)
throw new AppError('not found', 404, err.cause); throw new AppError('not found', 404, err.cause);
if (err instanceof AppError) throw err; if (err instanceof AppError) throw err;
throw new AppError('something went wrong', 500, err instanceof Error ? err.cause : undefined); throw new AppError('something went wrong', 500, err);
} }
}; };

View File

@ -74,10 +74,12 @@ export const getProxiedIMDbImgUrl = (url: string) => {
}; };
export const AppError = class extends Error { export const AppError = class extends Error {
constructor(message: string, public statusCode: number, cause?: any) { constructor(message: string, public statusCode: number, errorOptions?: unknown) {
super(message, cause); const saneErrorOptions = getErrorOptions(errorOptions);
super(message, saneErrorOptions);
Error.captureStackTrace(this, AppError); Error.captureStackTrace(this, AppError);
if (process.env.NODE_ENV === 'development') console.error(this);
} }
}; };
@ -90,10 +92,7 @@ export const cleanQueryStr = (record: Record<string, string>, filterable: string
return urlSearchParams.toString(); return urlSearchParams.toString();
}; };
export const getResTitleTypeHeading = ( export const getResTitleTypeHeading = (type: ResultMetaTypes, titleType: ResultMetaTitleTypes) => {
type: ResultMetaTypes,
titleType: ResultMetaTitleTypes
) => {
if (type !== 'TITLE') return 'Titles'; if (type !== 'TITLE') return 'Titles';
for (let i = 0; i < resultTitleTypes.types.length; i++) { for (let i = 0; i < resultTitleTypes.types.length; i++) {
@ -102,7 +101,6 @@ export const getResTitleTypeHeading = (
} }
}; };
export const isLocalStorageAvailable = () => { export const isLocalStorageAvailable = () => {
try { try {
localStorage.getItem('test'); localStorage.getItem('test');
@ -111,3 +109,25 @@ export const isLocalStorageAvailable = () => {
return false; return false;
} }
}; };
const getErrorOptions = (error: unknown): ErrorOptions | undefined => {
if (!error || typeof error !== 'object') return undefined;
let cause: unknown;
// @ts-expect-error it's not an error! just that project's ts version is old, which can't be upgraded
if ('cause' in error) cause = error.cause;
// @ts-expect-error it's not an error! just that project's ts version is old, which can't be upgraded
else if ('stack' in error) cause = error.stack;
// @ts-expect-error it's not an error! just that project's ts version is old, which can't be upgraded
return { cause };
};
export const getErrorProperties = (
error: unknown,
message = 'Something went very wrong',
statusCode = 500
) => {
if (error instanceof AppError) return error;
return new AppError(message, statusCode, error);
};