feat: ✨ changed error response to success flag (#134)

apps/api/src/routes/v1/graphql/lib.ts

@@ -1,6 +1,5 @@
 import type { BaseContext, HTTPGraphQLResponse } from "@apollo/server";
 import type { IFieldResolver } from "@graphql-tools/utils";
-import { isErrorResponse } from "@peterportal-api/types";
 import type { RawResponse } from "@peterportal-api/types";
 import { GraphQLError } from "graphql/error";
 
@@ -58,7 +57,7 @@ export const proxyRestApi =
  };
  });
 
- if (isErrorResponse(data)) {
+ if (!data.success) {
  throw new GraphQLError(data.message, {
  extensions: {
  code: data.error.toUpperCase().replace(" ", "_"),

libs/lambda/src/response.ts

@@ -47,7 +47,7 @@ export function createOKResult<T>(
 ): APIGatewayProxyResult {
  const statusCode = 200;
  const timestamp = createTimestamp();
- const response: Response<T> = { statusCode, timestamp, requestId, payload };
+ const response: Response<T> = { statusCode, timestamp, requestId, payload, success: true };
  const headers = { ...responseHeaders };
 
  try {
@@ -89,12 +89,12 @@ export function createErrorResult(
  e instanceof Error
  ? `${e.name}: ${e.message}`
  : typeof e === "string"
- ? e
- : "An unknown error has occurred. Please try again.";
+  ? e
+  : "An unknown error has occurred. Please try again.";
 
  const error = httpErrorCodes[statusCode as keyof typeof httpErrorCodes];
 
- const body: ErrorResponse = { timestamp, requestId, statusCode, error, message };
+ const body: ErrorResponse = { timestamp, requestId, statusCode, error, message, success: false };
 
  logger.error(`${body.statusCode} ${body.error}: ${body.message}`);
 

package.json

@@ -47,7 +47,6 @@
  },
  "packageManager": "[email protected]",
  "engines": {
- "node": "20",
  "pnpm": "8"
  }
 }

packages/types/types/response.ts

@@ -25,6 +25,8 @@ export type Response<T> = BaseResponse & {
  * The payload returned by the REST API.
  */
  payload: T;
+
+ success: true;
 };
 
 /**
@@ -39,6 +41,8 @@ export type ErrorResponse = BaseResponse & {
  * The detailed error message.
  */
  message: string;
+
+ success: false;
 };
 
 /**
@@ -54,4 +58,4 @@ export type RawResponse<T> = Response<T> | ErrorResponse;
  * ``ErrorResponse`` or a ``Response<T>``.
  * @param r The object to test.
  */
-export const isErrorResponse = <T>(r: RawResponse<T>): r is ErrorResponse => "error" in r;
+export const isErrorResponse = <T>(r: RawResponse<T>): r is ErrorResponse => r.success == false;

packages/websoc-fuzzy-search/setup.ts

@@ -2,7 +2,6 @@ import { existsSync, mkdirSync, readFileSync, writeFileSync } from "node:fs";
 import { normalize } from "node:path";
 import { gzipSync } from "node:zlib";
 
-import { isErrorResponse } from "@peterportal-api/types";
 import type { Course, Instructor, RawResponse } from "@peterportal-api/types";
 import fetch from "cross-fetch";
 import pluralize from "pluralize";
@@ -219,7 +218,7 @@ async function main() {
  console.time("Data fetched in");
  const coursesRes = await fetch("https://api-next.peterportal.org/v1/rest/courses/all");
  const coursesJson: RawResponse<Course[]> = await coursesRes.json();
- if (isErrorResponse(coursesJson)) throw new Error("Could not fetch courses from API.");
+ if (!coursesJson.success) throw new Error("Could not fetch courses from API.");
  coursesJson.payload.forEach(
  ({ id, department, departmentName, courseNumber, geList, courseLevel, school, title }) => {
  d.courses[id] = {
@@ -235,7 +234,7 @@ async function main() {
  );
  const instructorsRes = await fetch("https://api-next.peterportal.org/v1/rest/instructors/all");
  const instructorsJson: RawResponse<Instructor[]> = await instructorsRes.json();
- if (isErrorResponse(instructorsJson)) throw new Error("Could not fetch instructors from API.");
+ if (!instructorsJson.success) throw new Error("Could not fetch instructors from API.");
  instructorsJson.payload.forEach(({ ucinetid, shortenedName, name, schools, department }) => {
  d.instructors[ucinetid] = {
  ucinetid,