Add queue status system endpoint (#351)

* Add queue status system endpoint

* Update

Author: adam-maj

src/db/transactions/getQueueStatus.ts

@@ -0,0 +1,33 @@
+import { prisma } from "../client";
+
+interface GetQueueStatusParams {
+  walletAddress?: string;
+}
+
+export const getQueueStatus = async ({
+  walletAddress,
+}: GetQueueStatusParams) => {
+  const queued = await prisma.transactions.count({
+    where: {
+      fromAddress: walletAddress?.toLowerCase(),
+      processedAt: null,
+      errorMessage: null,
+    },
+  });
+
+  const pending = await prisma.transactions.count({
+    where: {
+      fromAddress: walletAddress?.toLowerCase(),
+      sentAt: {
+        not: null,
+      },
+      minedAt: null,
+      errorMessage: null,
+    },
+  });
+
+  return {
+    queued,
+    pending,
+  };
+};

src/server/routes/index.ts

@@ -96,9 +96,10 @@ import { revokeRelayer } from "./relayer/revoke";
 import { getAllTransactions } from "./backend-wallet/getTransactions";
 import { sendTransactionBatch } from "./backend-wallet/sendTransactionBatch";
 import { withdraw } from "./backend-wallet/withdraw";
-import { healthCheck } from "./health";
 import { home } from "./home";
 import { updateRelayer } from "./relayer/update";
+import { healthCheck } from "./system/health";
+import { queueStatus } from "./system/queue";
 import { checkGroupStatus } from "./transaction/group";
 import { sendSignedTransaction } from "./transaction/sendSignedTx";
 import { sendSignedUserOp } from "./transaction/sendSignedUserOp";
@@ -208,4 +209,5 @@ export const withRoutes = async (fastify: FastifyInstance) => {
   // System
   await fastify.register(home);
   await fastify.register(healthCheck);
+  await fastify.register(queueStatus);
 };

src/server/routes/health.ts renamed to src/server/routes/system/health.ts

@@ -1,7 +1,7 @@
 import { Static, Type } from "@sinclair/typebox";
 import { FastifyInstance } from "fastify";
 import { StatusCodes } from "http-status-codes";
-import { isDatabaseHealthy } from "../../db/client";
+import { isDatabaseHealthy } from "../../../db/client";
 
 const ReplySchemaOk = Type.Object({
   status: Type.String(),
@@ -19,7 +19,7 @@ export async function healthCheck(fastify: FastifyInstance) {
     Reply: Static<typeof ReplySchema>;
   }>({
     method: "GET",
-    url: "/health",
+    url: "/system/health",
     schema: {
       summary: "Check health",
       description: "Check the system health of Engine",

src/server/routes/system/queue.ts

@@ -0,0 +1,46 @@
+import { Static, Type } from "@sinclair/typebox";
+import { FastifyInstance } from "fastify";
+import { StatusCodes } from "http-status-codes";
+import { getQueueStatus } from "../../../db/transactions/getQueueStatus";
+
+const QuerySchema = Type.Object({
+  walletAddress: Type.Optional(Type.String()),
+});
+
+const ReplySchema = Type.Object({
+  result: Type.Object({
+    queued: Type.Number(),
+    pending: Type.Number(),
+  }),
+});
+
+export async function queueStatus(fastify: FastifyInstance) {
+  fastify.route<{
+    Querystring: Static<typeof QuerySchema>;
+    Reply: Static<typeof ReplySchema>;
+  }>({
+    method: "GET",
+    url: "/system/queue",
+    schema: {
+      summary: "Check queue status",
+      description: "Check the status of the queue",
+      tags: ["System"],
+      operationId: "queueStatus",
+      querystring: QuerySchema,
+      response: {
+        [StatusCodes.OK]: ReplySchema,
+      },
+    },
+    handler: async (req, res) => {
+      const { walletAddress } = req.query;
+
+      const { queued, pending } = await getQueueStatus({ walletAddress });
+      res.status(StatusCodes.OK).send({
+        result: {
+          queued,
+          pending,
+        },
+      });
+    },
+  });
+}