VIA-545 SB Enable console logging in lower environments.

Author: acerathereinspirative-nhs-nvir

.env.template

@@ -3,6 +3,7 @@ SSM_PREFIX=/local/
 
 # logging
 PINO_LOG_LEVEL=info
+NEXT_PUBLIC_SUPRESS_CONSOLE=false
 PROFILE_PERFORMANCE=true
 DEPLOY_ENVIRONMENT=local
 

infrastructure/environments/dev/locals.tf

@@ -25,9 +25,10 @@ locals {
   application_environment_variables = {
     SSM_PREFIX = "/${local.prefix}/"
 
-    PINO_LOG_LEVEL      = "info"
-    DEPLOY_ENVIRONMENT  = local.environment
-    PROFILE_PERFORMANCE = "true"
+    PINO_LOG_LEVEL              = "info"
+    NEXT_PUBLIC_SUPRESS_CONSOLE = "false"
+    DEPLOY_ENVIRONMENT          = local.environment
+    PROFILE_PERFORMANCE         = "true"
 
     CONTENT_API_ENDPOINT                     = "https://int.api.service.nhs.uk/"
     CONTENT_CACHE_PATH                       = "s3://${local.content_cache_bucket_name}"

infrastructure/environments/preprod/locals.tf

@@ -25,9 +25,10 @@ locals {
   application_environment_variables = {
     SSM_PREFIX = "/${local.prefix}/"
 
-    PINO_LOG_LEVEL      = "info"
-    DEPLOY_ENVIRONMENT  = local.environment
-    PROFILE_PERFORMANCE = "true"
+    PINO_LOG_LEVEL              = "info"
+    NEXT_PUBLIC_SUPRESS_CONSOLE = "false"
+    DEPLOY_ENVIRONMENT          = local.environment
+    PROFILE_PERFORMANCE         = "true"
 
     CONTENT_API_ENDPOINT                     = "https://int.api.service.nhs.uk/"
     CONTENT_CACHE_PATH                       = "s3://${local.content_cache_bucket_name}"

infrastructure/environments/prod/locals.tf

@@ -25,9 +25,10 @@ locals {
   application_environment_variables = {
     SSM_PREFIX = "/${local.prefix}/"
 
-    PINO_LOG_LEVEL      = "info"
-    DEPLOY_ENVIRONMENT  = local.environment
-    PROFILE_PERFORMANCE = "true"
+    PINO_LOG_LEVEL              = "info"
+    NEXT_PUBLIC_SUPRESS_CONSOLE = "true"
+    DEPLOY_ENVIRONMENT          = local.environment
+    PROFILE_PERFORMANCE         = "true"
 
     CONTENT_API_ENDPOINT                     = "https://api.service.nhs.uk/"
     CONTENT_CACHE_PATH                       = "s3://${local.content_cache_bucket_name}"

infrastructure/environments/test/locals.tf

@@ -25,9 +25,10 @@ locals {
   application_environment_variables = {
     SSM_PREFIX = "/${local.prefix}/"
 
-    PINO_LOG_LEVEL      = "debug"
-    DEPLOY_ENVIRONMENT  = local.environment
-    PROFILE_PERFORMANCE = "true"
+    PINO_LOG_LEVEL              = "debug"
+    NEXT_PUBLIC_SUPRESS_CONSOLE = "true"
+    DEPLOY_ENVIRONMENT          = local.environment
+    PROFILE_PERFORMANCE         = "true"
 
     CONTENT_API_ENDPOINT                     = "https://int.api.service.nhs.uk/"
     CONTENT_CACHE_PATH                       = "s3://${local.content_cache_bucket_name}"

src/app/_components/client-unhandled-error-logger/ClientUnhandledErrorLogger.tsx

@@ -5,18 +5,22 @@ import { ClientSideErrorTypes } from "@src/utils/constants";
 import { useRouter } from "next/navigation";
 import { useEffect } from "react";
 
+const supressConsole = (process.env.NEXT_PUBLIC_SUPRESS_CONSOLE ?? "true") !== "false";
 let router;
 
 const reportClientSideUnhandledError = (errorEvent: ErrorEvent) => {
-  errorEvent.preventDefault();
-  logClientSideError(ClientSideErrorTypes.UNHANDLED_ERROR).catch(() => {
+  if (supressConsole) errorEvent.preventDefault();
+
+  logClientSideError(ClientSideErrorTypes.UNHANDLED_ERROR).catch((err: Error) => {
+    if (!supressConsole) console.error(err.message);
     // do not show anything to the user; catching prevents an infinite loop if the logger itself throws an error which is unhandled
   });
   router.push("/service-failure");
 };
 
 const reportClientSideUnhandledPromiseRejectionError = () => {
-  logClientSideError(ClientSideErrorTypes.UNHANDLED_PROMISE_REJECT_ERROR).catch(() => {
+  logClientSideError(ClientSideErrorTypes.UNHANDLED_PROMISE_REJECT_ERROR).catch((err: Error) => {
+    if (!supressConsole) console.error(err.message);
     // do not show anything to the user; catching prevents an infinite loop if the logger itself throws an error which is unhandled
   });
   router.push("/service-failure");