Better response code+message when queueId cannot be found (#291)

* fix: return 4xx if tx not found

* handle websockets

* remove debug line

Author: arcoraven

src/db/transactions/getTxById.ts

@@ -1,24 +1,29 @@
+import { Static } from "@sinclair/typebox";
 import { PrismaTransaction } from "../../schema/prisma";
+import { transactionResponseSchema } from "../../server/schemas/transaction";
 import { getPrismaWithPostgresTx } from "../client";
 import { cleanTxs } from "./cleanTxs";
 
 interface GetTxByIdParams {
-  pgtx?: PrismaTransaction;
   queueId: string;
+  pgtx?: PrismaTransaction;
 }
 
-export const getTxById = async ({ pgtx, queueId }: GetTxByIdParams) => {
+export const getTxById = async ({
+  pgtx,
+  queueId,
+}: GetTxByIdParams): Promise<Static<
+  typeof transactionResponseSchema
+> | null> => {
   const prisma = getPrismaWithPostgresTx(pgtx);
 
   const tx = await prisma.transactions.findUnique({
     where: {
       id: queueId,
     },
   });
-
   if (!tx) {
-    // TODO: Defined error types
-    throw new Error(`Transaction with queueId ${queueId} not found!`);
+    return null;
   }
 
   const [cleanedTx] = cleanTxs([tx]);

src/server/routes/transaction/status.ts

@@ -99,7 +99,7 @@ export async function checkTxStatus(fastify: FastifyInstance) {
       request.log.info(`Websocket Connection Established for ${queueId}`);
       findOrAddWSConnectionInSharedState(connection, queueId, request);
 
-      const returnData = await getTxById({ queueId: queueId });
+      const returnData = await getTxById({ queueId });
 
       const { message, closeConnection } =
         await getStatusMessageAndConnectionStatus(returnData);

src/server/utils/transaction.ts

@@ -20,6 +20,11 @@ export const cancelTransactionAndUpdate = async ({
   accountAddress,
 }: CancelTransactionAndUpdateParams) => {
   const txData = await getTxById({ queueId });
+  if (!txData) {
+    return {
+      message: `Transaction ${queueId} not found.`,
+    };
+  }
 
   let error = null;
   let transferTransactionResult: TransactionResponse | null = null;

src/server/utils/webhook.ts

@@ -81,6 +81,9 @@ const sendWebhookRequest = async (
 export const sendTxWebhook = async (data: TxWebookParams): Promise<void> => {
   try {
     const txData = await getTxById({ queueId: data.id });
+    if (!txData) {
+      throw new Error(`Transaction ${data.id} not found.`);
+    }
 
     let webhookConfig: SanitizedWebHooksSchema[] | undefined =
       await getWebhookConfig(WebhooksEventTypes.ALL_TX);

src/server/utils/websocket.ts

@@ -126,13 +126,16 @@ type CustomStatusAndConnectionType = {
 };
 
 export const getStatusMessageAndConnectionStatus = async (
-  data: Static<typeof transactionResponseSchema>,
+  data: Static<typeof transactionResponseSchema> | null,
 ): Promise<CustomStatusAndConnectionType> => {
   let message =
     "Request is queued. Waiting for transaction to be picked up by worker.";
   let closeConnection = false;
 
-  if (data.status === TransactionStatusEnum.Mined) {
+  if (!data) {
+    message = `Transaction not found. Make sure the provided ID is correct.`;
+    closeConnection = true;
+  } else if (data.status === TransactionStatusEnum.Mined) {
     message = "Transaction mined. Closing connection.";
     closeConnection = true;
   } else if (data.status === TransactionStatusEnum.Errored) {
@@ -149,12 +152,12 @@ export const getStatusMessageAndConnectionStatus = async (
 };
 
 export const formatSocketMessage = async (
-  data: Static<typeof transactionResponseSchema>,
+  data: Static<typeof transactionResponseSchema> | null,
   message: string,
 ): Promise<string> => {
   const returnData = JSON.stringify({
-    result: JSON.stringify(data),
-    queueId: data.queueId,
+    result: data ? JSON.stringify(data) : undefined,
+    queueId: data?.queueId,
     message,
   });
   return returnData;

src/worker/listeners/updateTxListener.ts

@@ -35,6 +35,7 @@ export const updateTxListener = async (): Promise<void> => {
       const returnData = await getTxById({
         queueId: parsedPayload.identifier,
       });
+
       const { message, closeConnection } =
         await getStatusMessageAndConnectionStatus(returnData);
       userSubscription.socket.send(