Add logging at various increasing levels if more and more records get added to a QueryOutputList

qqq-backend-core/src/main/java/com/kingsrook/qqq/backend/core/model/actions/tables/query/QueryOutput.java

@@ -53,7 +53,7 @@ public class QueryOutput extends AbstractActionOutput implements Serializable
       }
       else
       {
-         storage = new QueryOutputList();
+         storage = new QueryOutputList(queryInput);
       }
    }
 

qqq-backend-core/src/main/java/com/kingsrook/qqq/backend/core/model/actions/tables/query/QueryOutputList.java

@@ -24,7 +24,10 @@ package com.kingsrook.qqq.backend.core.model.actions.tables.query;
 
 import java.util.ArrayList;
 import java.util.List;
+import com.kingsrook.qqq.backend.core.logging.QLogger;
 import com.kingsrook.qqq.backend.core.model.data.QRecord;
+import org.apache.logging.log4j.Level;
+import static com.kingsrook.qqq.backend.core.logging.LogUtils.logPair;
 
 
 /*******************************************************************************
@@ -33,15 +36,50 @@ import com.kingsrook.qqq.backend.core.model.data.QRecord;
  *******************************************************************************/
 class QueryOutputList implements QueryOutputStorageInterface
 {
+   private static final QLogger LOG = QLogger.getLogger(QueryOutputList.class);
+
+   private final String        tableName;
    private       List<QRecord> records = new ArrayList<>();
 
+   private static int LOG_SIZE_INFO_OVER  = 50_000;
+   private static int LOG_SIZE_WARN_OVER  = 100_000;
+   private static int LOG_SIZE_ERROR_OVER = 250_000;
+
 
 
    /*******************************************************************************
     **
     *******************************************************************************/
-   public QueryOutputList()
+   public QueryOutputList(QueryInput queryInput)
    {
+      tableName = queryInput.getTableName();
+   }
+
+
+
+   /*******************************************************************************
+    **
+    *******************************************************************************/
+   private void logSize(int sizeBefore, int sizeAfter)
+   {
+      Level level = null;
+      if(sizeBefore < LOG_SIZE_ERROR_OVER && sizeAfter >= LOG_SIZE_ERROR_OVER)
+      {
+         level = Level.ERROR;
+      }
+      else if(sizeBefore < LOG_SIZE_WARN_OVER && sizeAfter >= LOG_SIZE_WARN_OVER)
+      {
+         level = Level.WARN;
+      }
+      else if(sizeBefore < LOG_SIZE_INFO_OVER && sizeAfter >= LOG_SIZE_INFO_OVER)
+      {
+         level = Level.INFO;
+      }
+
+      if(level != null)
+      {
+         LOG.log(level, "Large number of records in QueryOutputList", new Throwable(), logPair("noRecords", sizeAfter), logPair("tableName", tableName));
+      }
    }
 
 
@@ -52,7 +90,9 @@ class QueryOutputList implements QueryOutputStorageInterface
    @Override
    public void addRecord(QRecord record)
    {
+      int sizeBefore = this.records.size();
       records.add(record);
+      logSize(sizeBefore, this.records.size());
    }
 
 
@@ -63,7 +103,9 @@ class QueryOutputList implements QueryOutputStorageInterface
    @Override
    public void addRecords(List<QRecord> records)
    {
+      int sizeBefore = this.records.size();
       this.records.addAll(records);
+      logSize(sizeBefore, this.records.size());
    }
 
 
@@ -77,4 +119,36 @@ class QueryOutputList implements QueryOutputStorageInterface
       return (records);
    }
 
+
+
+   /*******************************************************************************
+    ** Setter for LOG_SIZE_INFO_OVER
+    **
+    *******************************************************************************/
+   public static void setLogSizeInfoOver(int logSizeInfoOver)
+   {
+      QueryOutputList.LOG_SIZE_INFO_OVER = logSizeInfoOver;
+   }
+
+
+
+   /*******************************************************************************
+    ** Setter for LOG_SIZE_WARN_OVER
+    **
+    *******************************************************************************/
+   public static void setLogSizeWarnOver(int logSizeWarnOver)
+   {
+      QueryOutputList.LOG_SIZE_WARN_OVER = logSizeWarnOver;
+   }
+
+
+
+   /*******************************************************************************
+    ** Setter for LOG_SIZE_ERROR_OVER
+    **
+    *******************************************************************************/
+   public static void setLogSizeErrorOver(int logSizeErrorOver)
+   {
+      QueryOutputList.LOG_SIZE_ERROR_OVER = logSizeErrorOver;
+   }
 }

qqq-backend-core/src/test/java/com/kingsrook/qqq/backend/core/model/actions/tables/query/QueryOutputListTest.java

@@ -0,0 +1,110 @@
+/*
+ * QQQ - Low-code Application Framework for Engineers.
+ * Copyright (C) 2021-2024.  Kingsrook, LLC
+ * 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
+ * contact@kingsrook.com
+ * https://github.com/Kingsrook/
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+package com.kingsrook.qqq.backend.core.model.actions.tables.query;
+
+
+import java.util.Collections;
+import com.kingsrook.qqq.backend.core.BaseTest;
+import com.kingsrook.qqq.backend.core.exceptions.QException;
+import com.kingsrook.qqq.backend.core.logging.QCollectingLogger;
+import com.kingsrook.qqq.backend.core.logging.QLogger;
+import com.kingsrook.qqq.backend.core.model.data.QRecord;
+import com.kingsrook.qqq.backend.core.utils.TestUtils;
+import org.apache.logging.log4j.Level;
+import org.junit.jupiter.api.Test;
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+
+/*******************************************************************************
+ ** Unit test for QueryOutputList 
+ *******************************************************************************/
+class QueryOutputListTest extends BaseTest
+{
+
+   /*******************************************************************************
+    **
+    *******************************************************************************/
+   @Test
+   void testLogSize() throws QException
+   {
+      QueryInput  queryInput  = new QueryInput(TestUtils.TABLE_NAME_PERSON);
+      QueryOutput queryOutput = new QueryOutput(queryInput);
+
+      QCollectingLogger collectingLogger = QLogger.activateCollectingLoggerForClass(QueryOutputList.class);
+
+      ///////////////////////
+      // set up our limits //
+      ///////////////////////
+      int infoLimit  = 10;
+      int warnLimit  = 20;
+      int errorLimit = 30;
+
+      QueryOutputList.setLogSizeInfoOver(infoLimit);
+      QueryOutputList.setLogSizeWarnOver(warnLimit);
+      QueryOutputList.setLogSizeErrorOver(errorLimit);
+
+      ////////////////////////////
+      // add records one-by-one //
+      ////////////////////////////
+      for(int i = 0; i < errorLimit; i++)
+      {
+         queryOutput.addRecord(new QRecord());
+      }
+
+      ///////////////////////////////////////////////////////////////
+      // assert we got the expected logs as each level was crossed //
+      ///////////////////////////////////////////////////////////////
+      assertEquals(3, collectingLogger.getCollectedMessages().size());
+
+      assertEquals(Level.INFO, collectingLogger.getCollectedMessages().get(0).getLevel());
+      assertThat(collectingLogger.getCollectedMessages().get(0).getMessage())
+         .contains("\"noRecords\":" + infoLimit)
+         .contains("\"tableName\":\"" + TestUtils.TABLE_NAME_PERSON + "\"");
+
+      assertEquals(Level.WARN, collectingLogger.getCollectedMessages().get(1).getLevel());
+      assertThat(collectingLogger.getCollectedMessages().get(1).getMessage())
+         .contains("\"noRecords\":" + warnLimit)
+         .contains("\"tableName\":\"" + TestUtils.TABLE_NAME_PERSON + "\"");
+
+      assertEquals(Level.ERROR, collectingLogger.getCollectedMessages().get(2).getLevel());
+      assertThat(collectingLogger.getCollectedMessages().get(2).getMessage())
+         .contains("\"noRecords\":" + errorLimit)
+         .contains("\"tableName\":\"" + TestUtils.TABLE_NAME_PERSON + "\"");
+
+      //////////////////////////////////////////////////////////////////////////////////////////
+      // reset the logger - then run again, doing a bulk add that goes straight to error size //
+      //////////////////////////////////////////////////////////////////////////////////////////
+      collectingLogger.clear();
+      queryOutput = new QueryOutput(queryInput);
+      int bulkSize = errorLimit + 1;
+      queryOutput.addRecords(Collections.nCopies(bulkSize, new QRecord()));
+
+      assertEquals(1, collectingLogger.getCollectedMessages().size());
+      assertEquals(Level.ERROR, collectingLogger.getCollectedMessages().get(0).getLevel());
+      assertThat(collectingLogger.getCollectedMessages().get(0).getMessage())
+         .contains("\"noRecords\":" + bulkSize)
+         .contains("\"tableName\":\"" + TestUtils.TABLE_NAME_PERSON + "\"");
+
+   }
+
+}