Server Updates: Caching, Logging & CORS (#381)

* added cache reset cron + logging updates for apis

* added standardResponseSchema to missing end-points to allow for error reporting

* updated cors & auth to be on Request thus error messages can come in response

* updated ts-node to tsx

* updated logic to return [] for webhooks

* removed console.log

* Added getNonce end-point

* updated get-nonces to get-nonce

* cache cron schedule resets cacheCron

* updated clearCachecron logging and added logic to check for cron schedule values

* Added cron values check for all fields

Author: farhanW3

package.json

@@ -52,6 +52,7 @@
     "cookie": "^0.5.0",
     "cookie-parser": "^1.4.6",
     "copyfiles": "^2.4.1",
+    "cron-parser": "^4.9.0",
     "crypto-js": "^4.1.1",
     "dotenv": "^16.0.3",
     "ethers": "5",

src/db/configuration/getConfiguration.ts

@@ -188,6 +188,7 @@ export const getConfiguration = async (): Promise<Config> => {
         accessControlAllowOrigin: !!process.env.ACCESS_CONTROL_ALLOW_ORIGIN
           ? process.env.ACCESS_CONTROL_ALLOW_ORIGIN
           : mandatoryAllowedCorsUrls.join(","),
+        clearCacheCronSchedule: "*/30 * * * * *",
       },
       update: {},
     });

src/prisma/migrations/20240116172315_clear_cache_cron_to_config/migration.sql

@@ -0,0 +1,2 @@
+-- AlterTable
+ALTER TABLE "configuration" ADD COLUMN     "clearCacheCronSchedule" TEXT NOT NULL DEFAULT '*/30 * * * * *';

src/prisma/schema.prisma

@@ -42,6 +42,7 @@ model Configuration {
   // Wallet balance
   minWalletBalance                   String  @default("20000000000000000") @map("minWalletBalance")
   accessControlAllowOrigin           String  @default("https://thirdweb.com,https://embed.ipfscdn.io") @map("accessControlAllowOrigin")
+  clearCacheCronSchedule             String  @default("*/30 * * * * *") @map("clearCacheCronSchedule")
 
   @@map("configuration")
 }

src/server/index.ts

@@ -4,6 +4,7 @@ import * as fs from "fs";
 import path from "path";
 import { URL } from "url";
 import { deleteAllWalletNonces } from "../db/wallets/deleteAllWalletNonces";
+import { clearCacheCron } from "../utils/cron/clearCacheCron";
 import { env } from "../utils/env";
 import { logger } from "../utils/logger";
 import { updateTxListener } from "./listerners/updateTxListener";
@@ -91,6 +92,7 @@ const main = async () => {
 
   writeOpenApiToFile(server);
   await updateTxListener();
+  await clearCacheCron("server");
 };
 
 main();

src/server/middleware/auth.ts

@@ -167,7 +167,7 @@ export const withAuth = async (server: FastifyInstance) => {
   server.decorateRequest("user", null);
 
   // Add auth validation middleware to check for authenticated requests
-  server.addHook("preHandler", async (req, res) => {
+  server.addHook("onRequest", async (req, res) => {
     if (
       req.url === "/favicon.ico" ||
       req.url === "/" ||

src/server/middleware/cors/cors.ts

@@ -10,6 +10,12 @@ import {
   addOriginToVaryHeader,
 } from "./vary";
 
+declare module "fastify" {
+  interface FastifyRequest {
+    corsPreflightEnabled: boolean;
+  }
+}
+
 interface ArrayOfValueOrArray<T> extends Array<ValueOrArray<T>> {}
 
 type OriginCallback = (
@@ -150,7 +156,7 @@ export const fastifyCors = async (
   next();
 };
 
-function normalizeCorsOptions(opts: FastifyCorsOptions) {
+const normalizeCorsOptions = (opts: FastifyCorsOptions): FastifyCorsOptions => {
   const corsOptions = { ...defaultOptions, ...opts };
   if (Array.isArray(opts.origin) && opts.origin.indexOf("*") !== -1) {
     corsOptions.origin = "*";
@@ -163,7 +169,7 @@ function normalizeCorsOptions(opts: FastifyCorsOptions) {
     corsOptions.cacheControl = undefined;
   }
   return corsOptions;
-}
+};
 
 const addCorsHeadersHandler = (
   fastify: FastifyInstance,

src/server/middleware/cors/index.ts

@@ -2,7 +2,7 @@ import { FastifyInstance } from "fastify";
 import { fastifyCors } from "./cors";
 
 export const withCors = async (server: FastifyInstance) => {
-  server.addHook("preHandler", (request, reply, next) => {
+  server.addHook("onRequest", (request, reply, next) => {
     fastifyCors(
       server,
       request,

src/server/middleware/error.ts

@@ -36,7 +36,7 @@ export const withErrorHandler = async (server: FastifyInstance) => {
     logger({
       service: "server",
       level: "error",
-      message: `Encountered unhandled server error`,
+      message: `Encountered server error`,
       error,
     });
 

src/server/middleware/logs.ts

@@ -5,7 +5,8 @@ export const withRequestLogs = async (server: FastifyInstance) => {
   server.addHook("onRequest", async (request, reply) => {
     if (
       !request.routerPath?.includes("static") &&
-      !request.routerPath?.includes("json")
+      !request.routerPath?.includes("json") &&
+      request.method !== "OPTIONS"
     ) {
       logger({
         service: "server",
@@ -29,13 +30,14 @@ export const withRequestLogs = async (server: FastifyInstance) => {
     if (
       !request.routerPath?.includes("static") &&
       !request.routerPath?.includes("json") &&
-      !request.routerPath?.includes("/backend-wallet/import")
+      !request.routerPath?.includes("/backend-wallet/import") &&
+      request.method !== "OPTIONS"
     ) {
       if (request.body && Object.keys(request.body).length > 0) {
         logger({
           service: "server",
           level: "info",
-          message: `Request body`,
+          message: `Request body - ${request.method} - ${request.routerPath}`,
           data: request.body,
         });
       }
@@ -44,7 +46,7 @@ export const withRequestLogs = async (server: FastifyInstance) => {
         logger({
           service: "server",
           level: "info",
-          message: `Request params`,
+          message: `Request params - ${request.method}`,
           data: request.params,
         });
       }
@@ -53,7 +55,7 @@ export const withRequestLogs = async (server: FastifyInstance) => {
         logger({
           service: "server",
           level: "info",
-          message: `Request querystring`,
+          message: `Request querystring - ${request.method} - ${request.routerPath}`,
           data: request.query,
         });
       }
@@ -63,7 +65,8 @@ export const withRequestLogs = async (server: FastifyInstance) => {
   server.addHook("onResponse", (request, reply, done) => {
     if (
       !request.routerPath?.includes("static") &&
-      !request.routerPath?.includes("json")
+      !request.routerPath?.includes("json") &&
+      request.method !== "OPTIONS"
     ) {
       logger({
         service: "server",

src/server/routes/auth/access-tokens/create.ts

@@ -7,6 +7,7 @@ import { updateConfiguration } from "../../../../db/configuration/updateConfigur
 import { createToken } from "../../../../db/tokens/createToken";
 import { getConfig } from "../../../../utils/cache/getConfig";
 import { env } from "../../../../utils/env";
+import { standardResponseSchema } from "../../../schemas/sharedApiSchemas";
 import { AccessTokenSchema } from "./getAll";
 
 const BodySchema = Type.Object({
@@ -36,6 +37,7 @@ export async function createAccessToken(fastify: FastifyInstance) {
       operationId: "create",
       body: BodySchema,
       response: {
+        ...standardResponseSchema,
         [StatusCodes.OK]: ReplySchema,
       },
     },

src/server/routes/auth/access-tokens/getAll.ts

@@ -2,6 +2,7 @@ import { Static, Type } from "@sinclair/typebox";
 import { FastifyInstance } from "fastify";
 import { StatusCodes } from "http-status-codes";
 import { getAccessTokens } from "../../../../db/tokens/getAccessTokens";
+import { standardResponseSchema } from "../../../schemas/sharedApiSchemas";
 
 export const AccessTokenSchema = Type.Object({
   id: Type.String(),
@@ -28,6 +29,7 @@ export async function getAllAccessTokens(fastify: FastifyInstance) {
       tags: ["Access Tokens"],
       operationId: "getAll",
       response: {
+        ...standardResponseSchema,
         [StatusCodes.OK]: ReplySchema,
       },
     },

src/server/routes/auth/access-tokens/revoke.ts

@@ -2,6 +2,7 @@ import { Static, Type } from "@sinclair/typebox";
 import { FastifyInstance } from "fastify";
 import { StatusCodes } from "http-status-codes";
 import { revokeToken } from "../../../../db/tokens/revokeToken";
+import { standardResponseSchema } from "../../../schemas/sharedApiSchemas";
 
 const BodySchema = Type.Object({
   id: Type.String(),
@@ -27,6 +28,7 @@ export async function revokeAccessToken(fastify: FastifyInstance) {
       operationId: "revoke",
       body: BodySchema,
       response: {
+        ...standardResponseSchema,
         [StatusCodes.OK]: ReplySchema,
       },
     },

src/server/routes/auth/access-tokens/update.ts

@@ -2,6 +2,7 @@ import { Static, Type } from "@sinclair/typebox";
 import { FastifyInstance } from "fastify";
 import { StatusCodes } from "http-status-codes";
 import { updateToken } from "../../../../db/tokens/updateToken";
+import { standardResponseSchema } from "../../../schemas/sharedApiSchemas";
 
 const BodySchema = Type.Object({
   id: Type.String(),
@@ -28,6 +29,7 @@ export async function updateAccessToken(fastify: FastifyInstance) {
       operationId: "update",
       body: BodySchema,
       response: {
+        ...standardResponseSchema,
         [StatusCodes.OK]: ReplySchema,
       },
     },

src/server/routes/auth/permissions/getAll.ts

@@ -2,6 +2,7 @@ import { Static, Type } from "@sinclair/typebox";
 import { FastifyInstance } from "fastify";
 import { StatusCodes } from "http-status-codes";
 import { prisma } from "../../../../db/client";
+import { standardResponseSchema } from "../../../schemas/sharedApiSchemas";
 
 const ReplySchema = Type.Object({
   result: Type.Array(
@@ -25,6 +26,7 @@ export async function getAllPermissions(fastify: FastifyInstance) {
       tags: ["Permissions"],
       operationId: "getAll",
       response: {
+        ...standardResponseSchema,
         [StatusCodes.OK]: ReplySchema,
       },
     },

src/server/routes/auth/permissions/grant.ts

@@ -3,6 +3,7 @@ import { FastifyInstance } from "fastify";
 import { StatusCodes } from "http-status-codes";
 import { updatePermissions } from "../../../../db/permissions/updatePermissions";
 import { PermissionsSchema } from "../../../schemas/auth";
+import { standardResponseSchema } from "../../../schemas/sharedApiSchemas";
 
 const BodySchema = Type.Object({
   walletAddress: Type.String(),
@@ -30,6 +31,7 @@ export async function grantPermissions(fastify: FastifyInstance) {
       operationId: "grant",
       body: BodySchema,
       response: {
+        ...standardResponseSchema,
         [StatusCodes.OK]: ReplySchema,
       },
     },

src/server/routes/auth/permissions/revoke.ts

@@ -2,6 +2,7 @@ import { Static, Type } from "@sinclair/typebox";
 import { FastifyInstance } from "fastify";
 import { StatusCodes } from "http-status-codes";
 import { deletePermissions } from "../../../../db/permissions/deletePermissions";
+import { standardResponseSchema } from "../../../schemas/sharedApiSchemas";
 
 const BodySchema = Type.Object({
   walletAddress: Type.String(),
@@ -27,6 +28,7 @@ export async function revokePermissions(fastify: FastifyInstance) {
       operationId: "revoke",
       body: BodySchema,
       response: {
+        ...standardResponseSchema,
         [StatusCodes.OK]: ReplySchema,
       },
     },

src/server/routes/backend-wallet/getNonce.ts

@@ -0,0 +1,74 @@
+import { Static, Type } from "@sinclair/typebox";
+import { FastifyInstance } from "fastify";
+import { StatusCodes } from "http-status-codes";
+import { getWalletNonce } from "../../../db/wallets/getWalletNonce";
+import { createCustomError } from "../../middleware/error";
+import { standardResponseSchema } from "../../schemas/sharedApiSchemas";
+import { walletParamSchema } from "../../schemas/wallet";
+import { getChainIdFromChain } from "../../utils/chain";
+
+const requestSchema = walletParamSchema;
+
+const responseSchema = Type.Object({
+  result: Type.Object({
+    status: Type.String(),
+    nonce: Type.String(),
+    walletAddress: Type.String(),
+    chain: Type.String(),
+  }),
+});
+
+responseSchema.example = {
+  result: {
+    nonce: "100",
+    walletAddress: "0x...",
+    chain: "1",
+  },
+};
+
+export const getBackendWalletNonce = async (fastify: FastifyInstance) => {
+  fastify.route<{
+    Params: Static<typeof requestSchema>;
+    Reply: Static<typeof responseSchema>;
+  }>({
+    method: "GET",
+    url: "/backend-wallet/:chain/:walletAddress/get-nonce",
+    schema: {
+      summary: "Get backend-wallet nonces from DB",
+      description:
+        "Get nonce for a backend wallets from DB. This is for debugging purposes and does not impact held tokens.",
+      tags: ["Backend Wallet"],
+      operationId: "getNonce",
+      params: requestSchema,
+      response: {
+        ...standardResponseSchema,
+        [StatusCodes.OK]: responseSchema,
+      },
+    },
+    handler: async (req, reply) => {
+      const { chain, walletAddress } = req.params;
+      const chainId = await getChainIdFromChain(chain);
+      const walletNonce = await getWalletNonce({
+        address: walletAddress,
+        chainId,
+      });
+
+      if (!walletNonce) {
+        throw createCustomError(
+          `No wallet nonce found for ${walletAddress} in DB`,
+          StatusCodes.NOT_FOUND,
+          "NOT_FOUND",
+        );
+      }
+
+      reply.status(StatusCodes.OK).send({
+        result: {
+          status: "success",
+          nonce: walletNonce?.nonce.toString() ?? "0",
+          walletAddress,
+          chain,
+        },
+      });
+    },
+  });
+};

src/server/routes/backend-wallet/signMessage.ts

@@ -2,6 +2,7 @@ import { Static, Type } from "@sinclair/typebox";
 import { FastifyInstance } from "fastify";
 import { StatusCodes } from "http-status-codes";
 import { getWallet } from "../../../utils/cache/getWallet";
+import { standardResponseSchema } from "../../schemas/sharedApiSchemas";
 import { walletAuthSchema } from "../../schemas/wallet";
 
 const BodySchema = Type.Object({
@@ -27,6 +28,7 @@ export async function signMessage(fastify: FastifyInstance) {
       body: BodySchema,
       headers: Type.Omit(walletAuthSchema, ["x-account-address"]),
       response: {
+        ...standardResponseSchema,
         [StatusCodes.OK]: ReplySchema,
       },
     },

src/server/routes/backend-wallet/signTransaction.ts

@@ -2,6 +2,7 @@ import { Static, Type } from "@sinclair/typebox";
 import { FastifyInstance } from "fastify";
 import { StatusCodes } from "http-status-codes";
 import { getWallet } from "../../../utils/cache/getWallet";
+import { standardResponseSchema } from "../../schemas/sharedApiSchemas";
 import { walletAuthSchema } from "../../schemas/wallet";
 
 const BodySchema = Type.Object({
@@ -42,6 +43,7 @@ export async function signTransaction(fastify: FastifyInstance) {
       body: BodySchema,
       headers: Type.Omit(walletAuthSchema, ["x-account-address"]),
       response: {
+        ...standardResponseSchema,
         [StatusCodes.OK]: ReplySchema,
       },
     },

src/server/routes/configuration/auth/get.ts

@@ -2,6 +2,7 @@ import { Static, Type } from "@sinclair/typebox";
 import { FastifyInstance } from "fastify";
 import { StatusCodes } from "http-status-codes";
 import { getConfig } from "../../../../utils/cache/getConfig";
+import { standardResponseSchema } from "../../../schemas/sharedApiSchemas";
 
 export const ReplySchema = Type.Object({
   result: Type.Object({
@@ -21,6 +22,7 @@ export async function getAuthConfiguration(fastify: FastifyInstance) {
       tags: ["Configuration"],
       operationId: "getAuthConfiguration",
       response: {
+        ...standardResponseSchema,
         [StatusCodes.OK]: ReplySchema,
       },
     },