From 369d5010713659b12071b8ca6e4294d43654e712 Mon Sep 17 00:00:00 2001
From: Darin Kelkhoff <darin.kelkhoff@gmail.com>
Date: Mon, 2 Jun 2025 12:02:07 -0500
Subject: [PATCH] Add doCheckTableApiVersion, so apps can avoid new error if
 table version isn't in api

---
 .../api/actions/GetTableApiFieldsAction.java  |  3 +-
 .../model/actions/GetTableApiFieldsInput.java | 37 +++++++++++++++++++
 .../actions/GetTableApiFieldsActionTest.java  | 13 ++++++-
 3 files changed, 50 insertions(+), 3 deletions(-)

diff --git a/qqq-middleware-api/src/main/java/com/kingsrook/qqq/api/actions/GetTableApiFieldsAction.java b/qqq-middleware-api/src/main/java/com/kingsrook/qqq/api/actions/GetTableApiFieldsAction.java
index 86332a51..2bc62942 100644
--- a/qqq-middleware-api/src/main/java/com/kingsrook/qqq/api/actions/GetTableApiFieldsAction.java
+++ b/qqq-middleware-api/src/main/java/com/kingsrook/qqq/api/actions/GetTableApiFieldsAction.java
@@ -46,6 +46,7 @@ import com.kingsrook.qqq.backend.core.model.metadata.fields.QFieldMetaData;
 import com.kingsrook.qqq.backend.core.model.metadata.tables.QTableMetaData;
 import com.kingsrook.qqq.backend.core.utils.CollectionUtils;
 import com.kingsrook.qqq.backend.core.utils.ObjectUtils;
+import org.apache.commons.lang3.BooleanUtils;
 import static com.kingsrook.qqq.backend.core.logging.LogUtils.logPair;
 
 
@@ -153,7 +154,7 @@ public class GetTableApiFieldsAction extends AbstractQActionFunction<GetTableApi
       APIVersion version = new APIVersion(input.getVersion());
 
       APIVersionRange tableApiVersionRange = getApiVersionRange(input.getApiName(), table);
-      if(!tableApiVersionRange.includes(version))
+      if(BooleanUtils.isTrue(input.getDoCheckTableApiVersion()) && !tableApiVersionRange.includes(version))
       {
          throw (new QNotFoundException("Table [" + input.getTableName() + "] was not found in this version of this api."));
       }
diff --git a/qqq-middleware-api/src/main/java/com/kingsrook/qqq/api/model/actions/GetTableApiFieldsInput.java b/qqq-middleware-api/src/main/java/com/kingsrook/qqq/api/model/actions/GetTableApiFieldsInput.java
index 2a2f991b..4b0f0552 100644
--- a/qqq-middleware-api/src/main/java/com/kingsrook/qqq/api/model/actions/GetTableApiFieldsInput.java
+++ b/qqq-middleware-api/src/main/java/com/kingsrook/qqq/api/model/actions/GetTableApiFieldsInput.java
@@ -34,6 +34,12 @@ public class GetTableApiFieldsInput extends AbstractActionInput
    private String tableName;
    private String version;
 
+   /////////////////////////////////////////////////////////////////////////////////////
+   // by default, this action will throw if the input table isn't in the api version. //
+   // but, to preserve legacy behavior where that didn't happen, allow this input.    //
+   /////////////////////////////////////////////////////////////////////////////////////
+   private Boolean doCheckTableApiVersion = true;
+
 
 
    /*******************************************************************************
@@ -127,4 +133,35 @@ public class GetTableApiFieldsInput extends AbstractActionInput
       return (this);
    }
 
+
+
+   /*******************************************************************************
+    ** Getter for doCheckTableApiVersion
+    *******************************************************************************/
+   public Boolean getDoCheckTableApiVersion()
+   {
+      return (this.doCheckTableApiVersion);
+   }
+
+
+
+   /*******************************************************************************
+    ** Setter for doCheckTableApiVersion
+    *******************************************************************************/
+   public void setDoCheckTableApiVersion(Boolean doCheckTableApiVersion)
+   {
+      this.doCheckTableApiVersion = doCheckTableApiVersion;
+   }
+
+
+
+   /*******************************************************************************
+    ** Fluent setter for doCheckTableApiVersion
+    *******************************************************************************/
+   public GetTableApiFieldsInput withDoCheckTableApiVersion(Boolean doCheckTableApiVersion)
+   {
+      this.doCheckTableApiVersion = doCheckTableApiVersion;
+      return (this);
+   }
+
 }
diff --git a/qqq-middleware-api/src/test/java/com/kingsrook/qqq/api/actions/GetTableApiFieldsActionTest.java b/qqq-middleware-api/src/test/java/com/kingsrook/qqq/api/actions/GetTableApiFieldsActionTest.java
index c1eac159..e03de16a 100644
--- a/qqq-middleware-api/src/test/java/com/kingsrook/qqq/api/actions/GetTableApiFieldsActionTest.java
+++ b/qqq-middleware-api/src/test/java/com/kingsrook/qqq/api/actions/GetTableApiFieldsActionTest.java
@@ -66,6 +66,7 @@ class GetTableApiFieldsActionTest extends BaseTest
    }
 
 
+
    /*******************************************************************************
     **
     *******************************************************************************/
@@ -132,8 +133,8 @@ class GetTableApiFieldsActionTest extends BaseTest
    @Test
    void testTablesNotFound() throws QException
    {
-      String tableNameVersion2plus = "tableNameVersion2plus";
-      QInstance qInstance = QContext.getQInstance();
+      String    tableNameVersion2plus = "tableNameVersion2plus";
+      QInstance qInstance             = QContext.getQInstance();
       qInstance.addTable(new QTableMetaData()
          .withName(tableNameVersion2plus)
          .withSupplementalMetaData(new ApiTableMetaDataContainer().withApiTableMetaData(TestUtils.API_NAME, new ApiTableMetaData().withInitialVersion("2")))
@@ -165,6 +166,14 @@ class GetTableApiFieldsActionTest extends BaseTest
       assertThatThrownBy(() -> getFields(tableNameVersion2through4, "5")).isInstanceOf(QNotFoundException.class);
 
       assertThatThrownBy(() -> getFields(tableNameNoApis, "1")).isInstanceOf(QNotFoundException.class);
+
+      ///////////////////////////////////////////////////////////////////////////////////////////////////////
+      // test the withDoCheckTableApiVersion input flag.                                                   //
+      // set up an input that'll fail (verify it fails) - then set the flag to false and make sure no fail //
+      ///////////////////////////////////////////////////////////////////////////////////////////////////////
+      GetTableApiFieldsInput input = new GetTableApiFieldsInput().withApiName(TestUtils.API_NAME).withTableName(tableNameVersion2through4).withVersion("1");
+      assertThatThrownBy(() -> new GetTableApiFieldsAction().execute(input));
+      new GetTableApiFieldsAction().execute(input.withDoCheckTableApiVersion(false));
    }
 
 }
\ No newline at end of file