Refactor logging

web/.env.test

@@ -37,7 +37,7 @@ SENDGRID_TEAM_INVITE_TEMPLATE_ID=temporary_test_id
 
 # Datadog
 NEXT_SERVER_DD_API_KEY=
-NEXT_SERVER_DD_SERVICE_NAME=developer-portal
+NEXT_SERVER_DD_SERVICE_NAME=worldcoin-developer-portal
 
 
 # Auth0

web/Dockerfile

@@ -23,7 +23,7 @@ WORKDIR /app
 RUN npm install -g [email protected] && corepack --version
 
 # TODO: Can be further optimized to remove next peer dependency
-RUN corepack enable pnpm && pnpm i [email protected] [email protected] dd-trace@5.12.0
+RUN corepack enable pnpm && pnpm i [email protected] [email protected] dd-trace@5.35.0
 
 # Rebuild the source code only when needed
 FROM base AS builder

web/api/helpers/errors.ts

@@ -8,15 +8,24 @@ export function errorResponse(params: {
   detail?: string;
   attribute?: string | null;
   req: NextRequest;
+  skipLogging?: boolean;
 }) {
   const {
     statusCode,
     code,
     detail = "Something went wrong",
     attribute = null,
     req,
+    skipLogging = false,
   } = params;
 
+  if (skipLogging) {
+    return NextResponse.json(
+      { code, detail, attribute },
+      { status: statusCode },
+    );
+  }
+
   if (statusCode >= 500) {
     logger.error(detail, { req, error: { statusCode, code, attribute } });
   } else {
@@ -89,7 +98,14 @@ export function errorValidation(
   attribute: string | null,
   req: NextRequest,
 ) {
-  return errorResponse({ statusCode: 400, code, detail, attribute, req });
+  return errorResponse({
+    statusCode: 400,
+    code,
+    detail,
+    attribute,
+    req,
+    skipLogging: true,
+  });
 }
 
 export function errorOIDCResponse(

web/api/v2/minikit/app-metadata/[app_id]/index.ts

@@ -51,6 +51,7 @@ export const GET = async (
       detail: "API key not found.",
       attribute: "api_key",
       req,
+      skipLogging: true,
     });
   }
 
@@ -61,6 +62,7 @@ export const GET = async (
       detail: "API key is inactive.",
       attribute: "api_key",
       req,
+      skipLogging: true,
     });
   }
 

web/api/v2/public/apps/index.ts

@@ -15,6 +15,7 @@ import {
 import { getSdk as getWebHighlightsSdk } from "./graphql/get-app-web-highlights.generated";
 
 import { formatAppMetadata, rankApps } from "@/api/helpers/app-store";
+import { logger } from "@/lib/logger";
 import {
   GetHighlightsQuery,
   getSdk as getHighlightsSdk,
@@ -83,7 +84,7 @@ export const GET = async (request: NextRequest) => {
     const { app_rankings } = await getWebHighlightsSdk(client).GetHighlights();
     highlightsIds = app_rankings[0]?.rankings ?? [];
   } catch (error) {
-    console.log(error);
+    logger.error("Error fetching highlights", { error, req: request });
     return errorResponse({
       statusCode: 500,
       code: "server_error",
@@ -115,7 +116,7 @@ export const GET = async (request: NextRequest) => {
     });
     highlightsApps = highlights;
   } catch (error) {
-    console.log(error);
+    logger.error("Error fetching app rankings", { error, req: request });
     return errorResponse({
       statusCode: 500,
       code: "server_error",

web/api/v2/verify/index.ts

@@ -135,6 +135,7 @@ export async function POST(
       detail: "This action does not have a valid external nullifier set.",
       attribute: null,
       req,
+      skipLogging: true,
     });
   }
 
@@ -173,16 +174,17 @@ export async function POST(
         detail: error?.message || "There was an error verifying this proof.",
         attribute: error?.attribute || null,
         req,
+        skipLogging: true,
       });
     }
   } catch (e: any) {
-    console.warn("Error verifying proof", { error: e });
     return errorResponse({
       statusCode: 400,
       code: "verification_error",
       detail: e.message,
       attribute: null,
       req,
+      skipLogging: true,
     });
   }
 
@@ -244,6 +246,7 @@ export async function POST(
         : e.message,
       attribute: null,
       req,
+      skipLogging: true,
     });
   }
 }

web/legacy/backend/errors.ts

@@ -1,4 +1,4 @@
-import { logger } from "@/legacy/lib/logger";
+import { logger } from "@/lib/logger";
 import { NextApiRequest, NextApiResponse } from "next";
 
 export function errorResponse(

web/legacy/backend/jwks.ts

@@ -1,11 +1,11 @@
+import { JWK_TIME_TO_LIVE, JWK_TTL_USABLE } from "@/legacy/lib/constants";
+import { JWKModel } from "@/legacy/lib/models";
+import { logger } from "@/lib/logger";
 import { gql } from "@apollo/client";
 import { createPublicKey } from "crypto";
 import dayjs from "dayjs";
-import { JWKModel } from "@/legacy/lib/models";
 import { getAPIServiceClient } from "./graphql";
 import { createKMSKey, getKMSClient, scheduleKeyDeletion } from "./kms";
-import { JWK_TIME_TO_LIVE, JWK_TTL_USABLE } from "@/legacy/lib/constants";
-import { logger } from "@/legacy/lib/logger";
 
 export type CreateJWKResult = {
   keyId: string;

web/legacy/backend/kms.ts

@@ -2,6 +2,7 @@
  * Contains all functions for interacting with Amazon KMS
  */
 
+import { logger } from "@/lib/logger";
 import {
   CreateKeyCommand,
   DescribeKeyCommand,
@@ -13,7 +14,6 @@ import {
 } from "@aws-sdk/client-kms";
 import { base64url } from "jose";
 import { retrieveJWK } from "./jwks";
-import { logger } from "@/legacy/lib/logger";
 
 export type CreateKeyResult =
   | {

web/legacy/backend/oidc.ts

@@ -1,5 +1,5 @@
-import { logger } from "@/legacy/lib/logger";
 import { ActionModel, AppModel, RedirectModel } from "@/legacy/lib/models";
+import { logger } from "@/lib/logger";
 import { IInternalError, OIDCFlowType, OIDCResponseType } from "@/lib/types";
 import { gql } from "@apollo/client";
 import { VerificationLevel } from "@worldcoin/idkit-core";

web/legacy/backend/verify.ts

@@ -1,6 +1,6 @@
 import { validateABILikeEncoding } from "@/legacy/lib/hashing";
-import { logger } from "@/legacy/lib/logger";
 import { IInternalError } from "@/legacy/lib/types";
+import { logger } from "@/lib/logger";
 import { sequencerMapping } from "@/lib/utils";
 import { ApolloClient, NormalizedCacheObject, gql } from "@apollo/client";
 import { VerificationLevel } from "@worldcoin/idkit-core";

web/lib/logger.ts

@@ -1,5 +1,6 @@
 import { IncomingMessage } from "http";
 import { NextApiRequest } from "next";
+import { NextRequest } from "next/server";
 import winston from "winston";
 
 const apiKey = process.env.NEXT_SERVER_DD_API_KEY;
@@ -58,18 +59,32 @@ const _logger = winston.createLogger({
 });
 
 // NOTE: this is wrapper and formatter for debug request data (this is workaround, because winston don't support async formatters)
-async function requestFormatter(req: NextApiRequest | IncomingMessage) {
+async function requestFormatter(
+  req: NextApiRequest | IncomingMessage | NextRequest,
+) {
   if (!req) {
     return {};
   }
 
-  const ip =
-    req.socket?.remoteAddress ||
-    req.headers["x-forwarded-for"] ||
-    "IP not available";
+  let ip: string | string[] | undefined;
+  if (req instanceof NextRequest) {
+    ip = req.ip;
+  } else {
+    ip =
+      req.socket?.remoteAddress ||
+      req.headers["x-forwarded-for"] ||
+      "IP not available";
+  }
+
   const url = req.url?.replace(/\?.*$/, "");
   const method = req.method;
-  const userAgent = req.headers["user-agent"];
+  let userAgent: string | undefined;
+
+  if (req instanceof NextRequest) {
+    userAgent = req.headers.get("user-agent") ?? undefined;
+  } else {
+    userAgent = req.headers["user-agent"] ?? undefined;
+  }
 
   const query = req.url?.includes("?")
     ? Object.fromEntries(

web/pages/api/_delete-expired-auth-codes.ts

@@ -1,9 +1,9 @@
-import { gql } from "@apollo/client";
+import { errorNotAllowed } from "@/legacy/backend/errors";
 import { getAPIServiceClient } from "@/legacy/backend/graphql";
 import { protectInternalEndpoint } from "@/legacy/backend/utils";
+import { logger } from "@/lib/logger";
+import { gql } from "@apollo/client";
 import { NextApiRequest, NextApiResponse } from "next";
-import { errorNotAllowed } from "@/legacy/backend/errors";
-import { logger } from "@/legacy/lib/logger";
 
 /**
  * Deletes expired auth codes