From b7837d758597768e206384e158e9d5beb95a77ac Mon Sep 17 00:00:00 2001 From: James Maes Date: Tue, 16 Sep 2025 14:13:50 -0500 Subject: [PATCH 01/20] chore: bump snapshot version after release --- pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pom.xml b/pom.xml index b8c2b9d..6f13bec 100644 --- a/pom.xml +++ b/pom.xml @@ -64,7 +64,7 @@ - 0.1.0-SNAPSHOT + 0.3.0-SNAPSHOT -- 2.54.0 From d29b008edc45a34e7d4c1a6de81151d23d438202 Mon Sep 17 00:00:00 2001 From: James Maes Date: Tue, 16 Sep 2025 14:28:06 -0500 Subject: [PATCH 02/20] Update README.md --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index 76648fe..6ad6420 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,5 @@ # QBit: Customizable Table Views - -[![Build Status](https://circleci.com/gh/Kingsrook/qbit-customizable-table-views.svg?style=svg)](https://circleci.com/gh/Kingsrook/qbit-customizable-table-views) +[![Build Status](https://dl.circleci.com/status-badge/img/gh/Kingsrook/qbit-customizable-table-views/tree/develop.svg?style=svg)](https://circleci.com/gh/Kingsrook/qbit-customizable-table-views) [![Maven Central](https://img.shields.io/maven-central/v/com.kingsrook.qbits/qbit-customizable-table-views.svg)](https://central.sonatype.com/namespace/com.kingsrook.qbits) [![Java](https://img.shields.io/badge/java-17+-blue.svg)](https://adoptium.net/) [![License](https://img.shields.io/badge/license-AGPL%203.0-green.svg)](LICENSE.txt) -- 2.54.0 From 2a82f4ea36259db00168fa42d559a634a209de37 Mon Sep 17 00:00:00 2001 From: James Maes Date: Thu, 18 Sep 2025 12:12:56 -0500 Subject: [PATCH 03/20] chore(deps): Updated parent pom and qqq-orb to latest published versions --- .circleci/config.yml | 2 +- pom.xml | 14 +++++++++++--- 2 files changed, 12 insertions(+), 4 deletions(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index 5e48fca..cfe96ba 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -1,7 +1,7 @@ version: 2.1 orbs: - qqq-orb: kingsrook/qqq-orb@0.3.6 + qqq-orb: kingsrook/qqq-orb@0.3.7 workflows: diff --git a/pom.xml b/pom.xml index 6f13bec..c0074ee 100644 --- a/pom.xml +++ b/pom.xml @@ -20,13 +20,16 @@ ~ along with this program. If not, see . --> - - 4.0.0 + + + + 0.2.1 + com.kingsrook qbit-build-parent - 1.1.0 + 1.4.0 com.kingsrook.qbits @@ -38,6 +41,8 @@ Customizable table views module for the QBit framework, providing table personalization and field/widget access control https://github.com/Kingsrook/qbit-customizable-table-views + 4.0.0 + GNU Affero General Public License v3.0 @@ -63,9 +68,12 @@ HEAD +<<<<<<< Updated upstream 0.3.0-SNAPSHOT +======= +>>>>>>> Stashed changes -- 2.54.0 From afa221be9d50dd24dc9d0489547fef04658bff34 Mon Sep 17 00:00:00 2001 From: James Maes Date: Thu, 18 Sep 2025 12:20:19 -0500 Subject: [PATCH 04/20] chore(deps): Updated parent pom and qqq-orb to latest published versions --- pom.xml | 9 +-------- 1 file changed, 1 insertion(+), 8 deletions(-) diff --git a/pom.xml b/pom.xml index c0074ee..05f3f6a 100644 --- a/pom.xml +++ b/pom.xml @@ -23,7 +23,7 @@ - 0.2.1 + 0.3.0-SNAPSHOT @@ -68,13 +68,6 @@ HEAD -<<<<<<< Updated upstream - - 0.3.0-SNAPSHOT - -======= ->>>>>>> Stashed changes - -- 2.54.0 From 11a9b782f1b3d85cc371c70fe9ddc57acfb32552 Mon Sep 17 00:00:00 2001 From: James Maes Date: Mon, 29 Sep 2025 15:31:45 -0500 Subject: [PATCH 05/20] ci(circleci): updated to latest production qqq orb - 0.3.8 --- .circleci/config.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index cfe96ba..7b19ce2 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -1,7 +1,7 @@ version: 2.1 orbs: - qqq-orb: kingsrook/qqq-orb@0.3.7 + qqq-orb: kingsrook/qqq-orb@0.3.8 workflows: -- 2.54.0 From 6b9a6cbcef63fc83f257a1e2b39974e25c06a165 Mon Sep 17 00:00:00 2001 From: CircleCI Date: Mon, 29 Sep 2025 20:33:24 +0000 Subject: [PATCH 06/20] Bump version to 0.2.1 [skip ci] --- pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pom.xml b/pom.xml index 05f3f6a..fcb3d31 100644 --- a/pom.xml +++ b/pom.xml @@ -23,7 +23,7 @@ - 0.3.0-SNAPSHOT + 0.2.1 -- 2.54.0 From bda8753e4c4d121e95248ad8c1c695fec92628bc Mon Sep 17 00:00:00 2001 From: Darin Kelkhoff Date: Thu, 6 Nov 2025 16:10:28 -0600 Subject: [PATCH 07/20] fix: the query for TableViews wasn't being filtered by table name... --- .../logic/CustomizableTableViewsTablePersonalizer.java | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/main/java/com/kingsrook/qbits/customizabletableviews/logic/CustomizableTableViewsTablePersonalizer.java b/src/main/java/com/kingsrook/qbits/customizabletableviews/logic/CustomizableTableViewsTablePersonalizer.java index 4b55671..4b6f180 100644 --- a/src/main/java/com/kingsrook/qbits/customizabletableviews/logic/CustomizableTableViewsTablePersonalizer.java +++ b/src/main/java/com/kingsrook/qbits/customizabletableviews/logic/CustomizableTableViewsTablePersonalizer.java @@ -294,7 +294,9 @@ public class CustomizableTableViewsTablePersonalizer implements TableMetaDataPer { Set roleIds = Arrays.stream(roleIdsString.split(",")).map(Integer::parseInt).collect(Collectors.toSet()); tableViews = new QueryAction().execute(new QueryInput(TableView.TABLE_NAME) - .withFilter(new QQueryFilter().withCriteria(new QFilterCriteria(TableViewRoleInt.TABLE_NAME + ".roleId", QCriteriaOperator.IN, roleIds))) + .withFilter(new QQueryFilter() + .withCriteria(new QFilterCriteria(TableViewRoleInt.TABLE_NAME + ".roleId", QCriteriaOperator.IN, roleIds)) + .withCriteria(new QFilterCriteria(CustomizableTable.TABLE_NAME + ".tableName", QCriteriaOperator.EQUALS, tableName))) .withQueryJoin(new QueryJoin(TableViewRoleInt.TABLE_NAME)) .withIncludeAssociations(true)) .getRecords(); -- 2.54.0 From 735cb27ee41d9a6bccdaa8ecbe6f0c04a3b2d9a1 Mon Sep 17 00:00:00 2001 From: Darin Kelkhoff Date: Thu, 6 Nov 2025 16:11:40 -0600 Subject: [PATCH 08/20] fix: make fields w/ a dynamic default value always be included on insert & update calls. adding this so createDate, modifyDate will be set. Feels right, but we can imagine maybe it isn't always? going with it for now. --- ...stomizableTableViewsTablePersonalizer.java | 51 ++++++++++---- ...izableTableViewsTablePersonalizerTest.java | 69 +++++++++++++++++-- 2 files changed, 101 insertions(+), 19 deletions(-) diff --git a/src/main/java/com/kingsrook/qbits/customizabletableviews/logic/CustomizableTableViewsTablePersonalizer.java b/src/main/java/com/kingsrook/qbits/customizabletableviews/logic/CustomizableTableViewsTablePersonalizer.java index 4b6f180..9892bd0 100644 --- a/src/main/java/com/kingsrook/qbits/customizabletableviews/logic/CustomizableTableViewsTablePersonalizer.java +++ b/src/main/java/com/kingsrook/qbits/customizabletableviews/logic/CustomizableTableViewsTablePersonalizer.java @@ -56,13 +56,16 @@ import com.kingsrook.qqq.backend.core.model.actions.processes.RunBackendStepInpu import com.kingsrook.qqq.backend.core.model.actions.tables.QInputSource; import com.kingsrook.qqq.backend.core.model.actions.tables.delete.DeleteInput; import com.kingsrook.qqq.backend.core.model.actions.tables.get.GetInput; +import com.kingsrook.qqq.backend.core.model.actions.tables.insert.InsertInput; import com.kingsrook.qqq.backend.core.model.actions.tables.query.QCriteriaOperator; import com.kingsrook.qqq.backend.core.model.actions.tables.query.QFilterCriteria; import com.kingsrook.qqq.backend.core.model.actions.tables.query.QQueryFilter; import com.kingsrook.qqq.backend.core.model.actions.tables.query.QueryInput; import com.kingsrook.qqq.backend.core.model.actions.tables.query.QueryJoin; +import com.kingsrook.qqq.backend.core.model.actions.tables.update.UpdateInput; import com.kingsrook.qqq.backend.core.model.data.QRecord; import com.kingsrook.qqq.backend.core.model.metadata.code.QCodeReference; +import com.kingsrook.qqq.backend.core.model.metadata.fields.DynamicDefaultValueBehavior; import com.kingsrook.qqq.backend.core.model.metadata.fields.QFieldMetaData; import com.kingsrook.qqq.backend.core.model.metadata.tables.QFieldSection; import com.kingsrook.qqq.backend.core.model.metadata.tables.QTableMetaData; @@ -103,7 +106,6 @@ public class CustomizableTableViewsTablePersonalizer implements TableMetaDataPer - /*************************************************************************** * ***************************************************************************/ @@ -153,7 +155,7 @@ public class CustomizableTableViewsTablePersonalizer implements TableMetaDataPer if(tableView != null) { - return applyViewToTable(tableView, tableActionInput.getTable().clone()); + return applyViewToTable(tableView, tableActionInput.getTable().clone(), tableActionInput); } return tableActionInput.getTable(); @@ -164,7 +166,7 @@ public class CustomizableTableViewsTablePersonalizer implements TableMetaDataPer /*************************************************************************** * ***************************************************************************/ - QTableMetaData applyViewToTable(TableView tableView, QTableMetaData cloneTable) + QTableMetaData applyViewToTable(TableView tableView, QTableMetaData cloneTable, AbstractTableActionInput tableActionInput) { Map cloneFields = cloneTable.getFields(); if(cloneFields == null) @@ -175,9 +177,10 @@ public class CustomizableTableViewsTablePersonalizer implements TableMetaDataPer Map fieldsToKeep = new LinkedHashMap<>(); - /////////////////////////////////////////// - // figure out which fields the user gets // - /////////////////////////////////////////// + ///////////////////////////////////////////// + // figure out which fields the user gets // + // start with ones in the user's TableView // + ///////////////////////////////////////////// for(TableViewField tableViewField : CollectionUtils.nonNullList(tableView.getFields())) { try @@ -201,19 +204,39 @@ public class CustomizableTableViewsTablePersonalizer implements TableMetaDataPer } } - /////////////////////////////////////////////////////////// - // always keep the primary key field and required fields // - /////////////////////////////////////////////////////////// - Set requiredAndPrimaryKeyFields = new HashSet<>(); + ///////////////////////////////////////////// + // next look for ones that always get kept // + ///////////////////////////////////////////// + boolean isInsertOrUpdate = (tableActionInput instanceof InsertInput) || (tableActionInput instanceof UpdateInput); for(QFieldMetaData field : cloneTable.getFields().values()) { String fieldName = field.getName(); + if(fieldsToKeep.containsKey(fieldName)) + { + continue; + } + + DynamicDefaultValueBehavior x = null; + boolean keep = false; if(field.getIsRequired() || Objects.equals(fieldName, cloneTable.getPrimaryKeyField())) { - if(!fieldsToKeep.containsKey(fieldName)) - { - fieldsToKeep.put(fieldName, cloneFields.get(fieldName)); - } + /////////////////////////////////////////////////////////// + // always keep the primary key field and required fields // + /////////////////////////////////////////////////////////// + keep = true; + } + else if(isInsertOrUpdate && field.getBehaviorOnlyIfSet(DynamicDefaultValueBehavior.class) != null) + { + ////////////////////////////////////////////////////////////////////////////////////////////////////// + // if this is for an insert or update, then keep any fields that have a DynamicDefaultValueBehavior // + // e.g., createDates, modifyDates, things that capture userId // + ////////////////////////////////////////////////////////////////////////////////////////////////////// + keep = true; + } + + if(keep) + { + fieldsToKeep.put(fieldName, cloneFields.get(fieldName)); } } diff --git a/src/test/java/com/kingsrook/qbits/customizabletableviews/logic/CustomizableTableViewsTablePersonalizerTest.java b/src/test/java/com/kingsrook/qbits/customizabletableviews/logic/CustomizableTableViewsTablePersonalizerTest.java index 913591f..eb8178c 100644 --- a/src/test/java/com/kingsrook/qbits/customizabletableviews/logic/CustomizableTableViewsTablePersonalizerTest.java +++ b/src/test/java/com/kingsrook/qbits/customizabletableviews/logic/CustomizableTableViewsTablePersonalizerTest.java @@ -44,6 +44,8 @@ import com.kingsrook.qqq.backend.core.actions.tables.DeleteAction; import com.kingsrook.qqq.backend.core.actions.tables.InsertAction; import com.kingsrook.qqq.backend.core.context.QContext; import com.kingsrook.qqq.backend.core.exceptions.QException; +import com.kingsrook.qqq.backend.core.model.actions.AbstractTableActionInput; +import com.kingsrook.qqq.backend.core.model.actions.metadata.TableMetaDataInput; import com.kingsrook.qqq.backend.core.model.actions.metadata.personalization.TableMetaDataPersonalizerInput; import com.kingsrook.qqq.backend.core.model.actions.tables.QInputSource; import com.kingsrook.qqq.backend.core.model.actions.tables.delete.DeleteInput; @@ -51,6 +53,9 @@ import com.kingsrook.qqq.backend.core.model.actions.tables.insert.InsertInput; import com.kingsrook.qqq.backend.core.model.actions.tables.query.QCriteriaOperator; import com.kingsrook.qqq.backend.core.model.actions.tables.query.QFilterCriteria; import com.kingsrook.qqq.backend.core.model.actions.tables.query.QQueryFilter; +import com.kingsrook.qqq.backend.core.model.actions.tables.query.QueryInput; +import com.kingsrook.qqq.backend.core.model.actions.tables.update.UpdateInput; +import com.kingsrook.qqq.backend.core.model.metadata.fields.DynamicDefaultValueBehavior; import com.kingsrook.qqq.backend.core.model.metadata.fields.QFieldMetaData; import com.kingsrook.qqq.backend.core.model.metadata.fields.QFieldType; import com.kingsrook.qqq.backend.core.model.metadata.tables.QTableMetaData; @@ -400,13 +405,15 @@ class CustomizableTableViewsTablePersonalizerTest extends BaseTest CustomizableTableViewsTablePersonalizer personalizer = new CustomizableTableViewsTablePersonalizer(); QTableMetaData tableMetaData; + TableMetaDataInput tableActionInput = new TableMetaDataInput(); + /////////////////////////// // empty with empty case // /////////////////////////// tableMetaData = personalizer.applyViewToTable( new TableView(), - new QTableMetaData() - ); + new QTableMetaData(), + tableActionInput); assertThat(tableMetaData.getFields()).isNullOrEmpty(); assertThat(tableMetaData.getSections()).isNullOrEmpty(); @@ -426,7 +433,7 @@ class CustomizableTableViewsTablePersonalizerTest extends BaseTest //////////////////////////////////////////////////////////////////////////////// tableMetaData = personalizer.applyViewToTable( new TableView().withFields(List.of()), - baseTable.clone()); + baseTable.clone(), tableActionInput); assertEquals(2, tableMetaData.getFields().size()); QFieldMetaDataAssert.assertThat(tableMetaData.getField("id")).isNotHidden().isNotEditable().isNotRequired(); @@ -449,7 +456,7 @@ class CustomizableTableViewsTablePersonalizerTest extends BaseTest new TableViewField().withFieldName("x.mandatory").withAccessLevel(EDITABLE_OPTIONAL), new TableViewField().withFieldName("x.optional").withAccessLevel(EDITABLE_OPTIONAL) )), - baseTable.clone()); + baseTable.clone(), tableActionInput); assertEquals(4, tableMetaData.getFields().size()); QFieldMetaDataAssert.assertThat(tableMetaData.getField("id")).isNotHidden().isNotEditable().isNotRequired(); @@ -478,7 +485,7 @@ class CustomizableTableViewsTablePersonalizerTest extends BaseTest new TableView().withWidgets(List.of( new TableViewWidget().withWidgetName("lilWidgy").withAccessLevel(WidgetAccessLevel.HAS_ACCESS) )), - baseTable.clone()); + baseTable.clone(), tableActionInput); assertEquals(2, tableMetaData.getFields().size()); assertEquals(3, tableMetaData.getSections().size()); // one for id, one for mandatory, and 1 for our widget assertEquals(List.of("s0", "s1", "w0"), tableMetaData.getSections().stream().map(s -> s.getName()).toList()); @@ -486,6 +493,58 @@ class CustomizableTableViewsTablePersonalizerTest extends BaseTest + /******************************************************************************* + ** + *******************************************************************************/ + @Test + void testDynamicDefaultValueFields() + { + /////////////////////////// + // empty with empty case // + /////////////////////////// + QTableMetaData baseTable = new QTableMetaData() + .withPrimaryKeyField("id") + .withField(new QFieldMetaData("id", QFieldType.STRING).withIsEditable(false)) + .withField(new QFieldMetaData("secret", QFieldType.STRING).withIsHidden(true)) + .withField(new QFieldMetaData("mandatory", QFieldType.STRING).withIsRequired(true)) + .withField(new QFieldMetaData("createDate", QFieldType.DATE_TIME).withBehavior(DynamicDefaultValueBehavior.CREATE_DATE)) + .withField(new QFieldMetaData("optional", QFieldType.STRING)) + .withSection(SectionFactory.defaultT1("id").withName("s0")) + .withSection(SectionFactory.defaultT2("secret", "mandatory").withName("s1")) + .withSection(SectionFactory.defaultT2("optional", "createDate").withName("s2")); + + //////////////////////////////////////////////////////////////////////// + // for actions that aren't insert or update, just get pkey & required // + //////////////////////////////////////////////////////////////////////// + for(AbstractTableActionInput actionInput : List.of(new QueryInput(), new DeleteInput(), new TableMetaDataInput())) + { + QTableMetaData tableMetaData = new CustomizableTableViewsTablePersonalizer().applyViewToTable( + new TableView().withFields(List.of()), + baseTable.clone(), actionInput); + + assertEquals(2, tableMetaData.getFields().size()); + QFieldMetaDataAssert.assertThat(tableMetaData.getField("id")).isNotNull(); + QFieldMetaDataAssert.assertThat(tableMetaData.getField("mandatory")).isNotNull(); + } + + ///////////////////////////////////////////////////// + // for insert or update action, get createDate too // + ///////////////////////////////////////////////////// + for(AbstractTableActionInput actionInput : List.of(new InsertInput(), new UpdateInput())) + { + QTableMetaData tableMetaData = new CustomizableTableViewsTablePersonalizer().applyViewToTable( + new TableView().withFields(List.of()), + baseTable.clone(), actionInput); + + assertEquals(3, tableMetaData.getFields().size()); + QFieldMetaDataAssert.assertThat(tableMetaData.getField("id")).isNotNull(); + QFieldMetaDataAssert.assertThat(tableMetaData.getField("mandatory")).isNotNull(); + QFieldMetaDataAssert.assertThat(tableMetaData.getField("createDate")).isNotNull(); + } + } + + + /******************************************************************************* ** *******************************************************************************/ -- 2.54.0 From ab00b186fe9cff6cabb78c16ad0551130026c3ee Mon Sep 17 00:00:00 2001 From: Darin Kelkhoff Date: Thu, 6 Nov 2025 16:12:11 -0600 Subject: [PATCH 09/20] chore: update pom version to be SNAPSHOT (since this is develop); updating to a qbit-build-parent that exists (1.1.0, not 1.4.0) --- pom.xml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/pom.xml b/pom.xml index fcb3d31..2c09f8a 100644 --- a/pom.xml +++ b/pom.xml @@ -23,19 +23,19 @@ - 0.2.1 + 0.2.2-SNAPSHOT com.kingsrook qbit-build-parent - 1.4.0 + 1.1.0 com.kingsrook.qbits qbit-customizable-table-views ${revision} - jar + jar QBit Customizable Table Views Customizable table views module for the QBit framework, providing table personalization and field/widget access control -- 2.54.0 From a08a3b424ff7b249a6ee606d32d79fc86cb2ddbb Mon Sep 17 00:00:00 2001 From: Darin Kelkhoff Date: Thu, 6 Nov 2025 21:53:43 -0600 Subject: [PATCH 10/20] test: fixed this test It was actually previously passing because of the bug that we fixed, where wee weren't including a criteria on the table name --- ...izableTableViewsTablePersonalizerTest.java | 55 +++++++++---------- 1 file changed, 27 insertions(+), 28 deletions(-) diff --git a/src/test/java/com/kingsrook/qbits/customizabletableviews/logic/CustomizableTableViewsTablePersonalizerTest.java b/src/test/java/com/kingsrook/qbits/customizabletableviews/logic/CustomizableTableViewsTablePersonalizerTest.java index eb8178c..78c7fee 100644 --- a/src/test/java/com/kingsrook/qbits/customizabletableviews/logic/CustomizableTableViewsTablePersonalizerTest.java +++ b/src/test/java/com/kingsrook/qbits/customizabletableviews/logic/CustomizableTableViewsTablePersonalizerTest.java @@ -267,8 +267,10 @@ class CustomizableTableViewsTablePersonalizerTest extends BaseTest { CustomizableTableViewsTablePersonalizer personalizer = new CustomizableTableViewsTablePersonalizer(); - String tableWithoutDefaultView = "tableWithoutDefaultView"; - String tableWithDefaultView = "tableWithDefaultView"; + String tableWithoutDefaultView = "tableWithoutDefaultView"; + String tableWithDefaultView = "tableWithDefaultView"; + Integer tableWithoutDefaultViewId = 1; + Integer tableWithDefaultViewId = 2; QContext.getQInstance().addTable(new QTableMetaData() .withName(tableWithDefaultView) @@ -277,8 +279,8 @@ class CustomizableTableViewsTablePersonalizerTest extends BaseTest .withField(new QFieldMetaData("c", QFieldType.STRING))); new InsertAction().execute(new InsertInput(CustomizableTable.TABLE_NAME).withRecordEntities(List.of( - new CustomizableTable().withId(1).withTableName(tableWithoutDefaultView).withDefaultTableViewId(null), - new CustomizableTable().withId(2).withTableName(tableWithDefaultView).withDefaultTableViewId(1) + new CustomizableTable().withId(tableWithoutDefaultViewId).withTableName(tableWithoutDefaultView).withDefaultTableViewId(null), + new CustomizableTable().withId(tableWithDefaultViewId).withTableName(tableWithDefaultView).withDefaultTableViewId(1) ))); ////////////////////// @@ -298,6 +300,13 @@ class CustomizableTableViewsTablePersonalizerTest extends BaseTest QContext.getQSession().setValue("roleIds", ""); assertEmptyView(personalizer.getEffectiveTableViewForCurrentSession(tableWithoutDefaultView)); + ///////////////////////////////////////////////////////////////////////////////////////////////// + // put roles in session - there still aren't any view-role-int's for this table, so empty view // + ///////////////////////////////////////////////////////////////////////////////////////////////// + QContext.getQSession().setUser(new QUser().withIdReference(UUID.randomUUID().toString())); + QContext.getQSession().setValue("roleIds", "1,2"); + assertEmptyView(personalizer.getEffectiveTableViewForCurrentSession(tableWithoutDefaultView)); + ////////////////////////////////////////////////////////////////////////////////////// // this table has a defaultViewId, but that view doesn't exist, so get null for now // ////////////////////////////////////////////////////////////////////////////////////// @@ -305,31 +314,24 @@ class CustomizableTableViewsTablePersonalizerTest extends BaseTest QContext.getQSession().setValue("roleIds", null); assertEmptyView(personalizer.getEffectiveTableViewForCurrentSession(tableWithDefaultView)); - ///////////////////// - // insert the view // - ///////////////////// + //////////////////////////////////////////////// + // insert that default view, and a few others // + //////////////////////////////////////////////// new InsertAction().execute(new InsertInput(TableView.TABLE_NAME).withRecordEntities(List.of( - new TableView().withId(1).withCustomizableTableId(2).withName("a").withFields(List.of(new TableViewField().withFieldName(tableWithDefaultView + ".a").withAccessLevel(EDITABLE_OPTIONAL))), - new TableView().withId(2).withCustomizableTableId(2).withName("b").withFields(List.of(new TableViewField().withFieldName(tableWithDefaultView + ".b").withAccessLevel(EDITABLE_OPTIONAL))), - new TableView().withId(3).withCustomizableTableId(2).withName("c").withFields(List.of(new TableViewField().withFieldName(tableWithDefaultView + ".c").withAccessLevel(EDITABLE_OPTIONAL))) + new TableView().withId(1).withCustomizableTableId(tableWithDefaultViewId).withName("a").withFields(List.of(new TableViewField().withFieldName(tableWithDefaultView + ".a").withAccessLevel(EDITABLE_OPTIONAL))), + new TableView().withId(2).withCustomizableTableId(tableWithDefaultViewId).withName("b").withFields(List.of(new TableViewField().withFieldName(tableWithDefaultView + ".b").withAccessLevel(EDITABLE_OPTIONAL))), + new TableView().withId(3).withCustomizableTableId(tableWithDefaultViewId).withName("c").withFields(List.of(new TableViewField().withFieldName(tableWithDefaultView + ".c").withAccessLevel(EDITABLE_OPTIONAL))) ))); - /////////////////////// - // now we can get it // - /////////////////////// + //////////////////////////////////////////////////// + // now we can get the default view for this table // + //////////////////////////////////////////////////// QContext.getQSession().setUser(new QUser().withIdReference(UUID.randomUUID().toString())); QContext.getQSession().setValue("roleIds", null); assertThat(personalizer.getEffectiveTableViewForCurrentSession(tableWithDefaultView)) .isNotNull() .extracting("name").isEqualTo("a"); - ///////////////////////////////////////////////////////////// - // put roles in session - but fail to find a view-role-int // - ///////////////////////////////////////////////////////////// - QContext.getQSession().setUser(new QUser().withIdReference(UUID.randomUUID().toString())); - QContext.getQSession().setValue("roleIds", "1,2"); - assertEmptyView(personalizer.getEffectiveTableViewForCurrentSession(tableWithoutDefaultView)); - /////////////////////////////// // build some view-role ints // /////////////////////////////// @@ -344,7 +346,7 @@ class CustomizableTableViewsTablePersonalizerTest extends BaseTest ////////////////////////////////////////// QContext.getQSession().setUser(new QUser().withIdReference(UUID.randomUUID().toString())); QContext.getQSession().setValue("roleIds", "1"); - assertThat(personalizer.getEffectiveTableViewForCurrentSession(tableWithoutDefaultView)) + assertThat(personalizer.getEffectiveTableViewForCurrentSession(tableWithDefaultView)) .isNotNull() .extracting("name").isEqualTo("a"); @@ -353,23 +355,20 @@ class CustomizableTableViewsTablePersonalizerTest extends BaseTest //////////////////////////////////////////////////// QContext.getQSession().setUser(new QUser().withIdReference(UUID.randomUUID().toString())); QContext.getQSession().setValue("roleIds", "2"); - assertThat(personalizer.getEffectiveTableViewForCurrentSession(tableWithoutDefaultView)) + assertThat(personalizer.getEffectiveTableViewForCurrentSession(tableWithDefaultView)) .isNotNull() .extracting("name").isEqualTo("b"); ///////////////////////////////////////////////////////////////////////////// // find 2 views (and when they merge, their name is lost) through role int // + // do this last lookup twice, clearing memory record store // + // in between to demonstrate memoization being used. // ///////////////////////////////////////////////////////////////////////////// QContext.getQSession().setUser(new QUser().withIdReference(UUID.randomUUID().toString())); QContext.getQSession().setValue("roleIds", "2,3"); - - ///////////////////////////////////////////////////////////// - // do this last lookup twice, clearing memory record store // - // in between to demonstrate memoization being used. // - ///////////////////////////////////////////////////////////// for(int i = 0; i < 2; i++) { - TableView effectiveTableViewForCurrentSession = personalizer.getEffectiveTableViewForCurrentSession(tableWithoutDefaultView); + TableView effectiveTableViewForCurrentSession = personalizer.getEffectiveTableViewForCurrentSession(tableWithDefaultView); assertThat(effectiveTableViewForCurrentSession) .isNotNull() .extracting("name").isNull(); -- 2.54.0 From 8db9359d78e6e3b0b92aec22282eb4875fe41d99 Mon Sep 17 00:00:00 2001 From: CircleCI Date: Fri, 7 Nov 2025 03:55:49 +0000 Subject: [PATCH 11/20] Bump version to 0.2.1 [skip ci] --- pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pom.xml b/pom.xml index 2c09f8a..d2cbf17 100644 --- a/pom.xml +++ b/pom.xml @@ -23,7 +23,7 @@ - 0.2.2-SNAPSHOT + 0.2.1 -- 2.54.0 From b0ebc121ebdba8d2c089c23de465cb7b1d610650 Mon Sep 17 00:00:00 2001 From: Darin Kelkhoff Date: Fri, 7 Nov 2025 10:49:12 -0600 Subject: [PATCH 12/20] Update qqq-orb to 0.3.12 (try to fix version automation, wanting to publish 0.2.2-SNAPSHOT) --- .circleci/config.yml | 4 ++-- pom.xml | 9 ++++++++- 2 files changed, 10 insertions(+), 3 deletions(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index 7b19ce2..f71cf62 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -1,7 +1,7 @@ version: 2.1 orbs: - qqq-orb: kingsrook/qqq-orb@0.3.8 + qqq-orb: kingsrook/qqq-orb@0.3.12 workflows: @@ -13,7 +13,7 @@ workflows: branches: ignore: /(develop|main|release/.*|hotfix/.*|integration.*)/ tags: - only: [] + only: [] publish_snapshot: jobs: diff --git a/pom.xml b/pom.xml index d2cbf17..1c7936b 100644 --- a/pom.xml +++ b/pom.xml @@ -23,7 +23,7 @@ - 0.2.1 + 0.2.2-SNAPSHOT @@ -96,6 +96,13 @@ com.kingsrook.qqq qqq-backend-module-rdbms + test + + + com.h2database + h2 + 2.2.220 + test -- 2.54.0 From 3e9453d36eddbe95c2de9761c9e669ad1f790e0c Mon Sep 17 00:00:00 2001 From: Darin Kelkhoff Date: Fri, 5 Dec 2025 12:02:45 -0600 Subject: [PATCH 13/20] fix: handle fields in sections that came from join tables --- ...stomizableTableViewsTablePersonalizer.java | 179 +++++++++++++----- ...izableTableViewsTablePersonalizerTest.java | 70 ++++++- 2 files changed, 199 insertions(+), 50 deletions(-) diff --git a/src/main/java/com/kingsrook/qbits/customizabletableviews/logic/CustomizableTableViewsTablePersonalizer.java b/src/main/java/com/kingsrook/qbits/customizabletableviews/logic/CustomizableTableViewsTablePersonalizer.java index 9892bd0..613da5d 100644 --- a/src/main/java/com/kingsrook/qbits/customizabletableviews/logic/CustomizableTableViewsTablePersonalizer.java +++ b/src/main/java/com/kingsrook/qbits/customizabletableviews/logic/CustomizableTableViewsTablePersonalizer.java @@ -25,8 +25,10 @@ package com.kingsrook.qbits.customizabletableviews.logic; import java.time.Duration; import java.util.ArrayList; import java.util.Arrays; +import java.util.Collections; import java.util.HashMap; import java.util.HashSet; +import java.util.Iterator; import java.util.LinkedHashMap; import java.util.List; import java.util.Map; @@ -66,6 +68,7 @@ import com.kingsrook.qqq.backend.core.model.actions.tables.update.UpdateInput; import com.kingsrook.qqq.backend.core.model.data.QRecord; import com.kingsrook.qqq.backend.core.model.metadata.code.QCodeReference; import com.kingsrook.qqq.backend.core.model.metadata.fields.DynamicDefaultValueBehavior; +import com.kingsrook.qqq.backend.core.model.metadata.fields.FieldAndJoinTable; import com.kingsrook.qqq.backend.core.model.metadata.fields.QFieldMetaData; import com.kingsrook.qqq.backend.core.model.metadata.tables.QFieldSection; import com.kingsrook.qqq.backend.core.model.metadata.tables.QTableMetaData; @@ -167,6 +170,135 @@ public class CustomizableTableViewsTablePersonalizer implements TableMetaDataPer * ***************************************************************************/ QTableMetaData applyViewToTable(TableView tableView, QTableMetaData cloneTable, AbstractTableActionInput tableActionInput) + { + Map fieldsToKeep = getFieldsToKeepForTable(tableView, cloneTable, tableActionInput); + cloneTable.setFields(fieldsToKeep); + + /////////////////////////////////////////////////////////// + // remove field names which aren't present from sections // + /////////////////////////////////////////////////////////// + for(QFieldSection section : CollectionUtils.nonNullList(cloneTable.getSections())) + { + Map> getFieldsToKeepFromJoinTableCache = null; + + Iterator fieldListIterator = CollectionUtils.nonNullList(section.getFieldNames()).iterator(); + while(fieldListIterator.hasNext()) + { + try + { + String fieldName = fieldListIterator.next(); + FieldAndJoinTable fieldAndJoinTable = FieldAndJoinTable.get(cloneTable, fieldName); + + if(fieldAndJoinTable.joinTable().getName().equals(cloneTable.getName())) + { + //////////////////////////////////////////////////////////////////////////////////////////// + // if the field is from this table, then remove it unless it's in the set of ones to keep // + //////////////////////////////////////////////////////////////////////////////////////////// + if(!fieldsToKeep.containsKey(fieldName)) + { + fieldListIterator.remove(); + } + } + else + { + getFieldsToKeepFromJoinTableCache = Objects.requireNonNullElseGet(getFieldsToKeepFromJoinTableCache, HashMap::new); + + /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + // else the field is from a join table - get that join table's allowed fields for the user, and keep or remove based on that // + /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + Set fieldsToKeepFromJoinTable = getFieldsToKeepFromJoinTable(fieldAndJoinTable.joinTable().getName(), tableActionInput, getFieldsToKeepFromJoinTableCache); + if(!fieldsToKeepFromJoinTable.contains(fieldAndJoinTable.field().getName())) + { + fieldListIterator.remove(); + } + } + } + catch(Exception e) + { + ///////////////////////////////////////////////////////// + // an unknown field, let's assume it should be removed // + ///////////////////////////////////////////////////////// + fieldListIterator.remove(); + } + } + } + + ////////////////////////////////////////////////////////// + // remove sections that had all of their fields removed // + ////////////////////////////////////////////////////////// + CollectionUtils.nonNullList(cloneTable.getSections()).removeIf(section -> + section.getFieldNames() != null && section.getFieldNames().isEmpty() && !StringUtils.hasContent(section.getWidgetName())); + + ////////////////////////////////////// + // figure out which widgets we keep // + ////////////////////////////////////// + Set widgetsToKeep = new HashSet<>(); + for(TableViewWidget tableViewWidget : CollectionUtils.nonNullList(tableView.getWidgets())) + { + try + { + String widgetName = tableViewWidget.getWidgetName(); + widgetsToKeep.add(widgetName); + } + catch(Exception e) + { + LOG.warn("Error processing tableViewWidget", e, logPair("widgetName", tableViewWidget.getWidgetName())); + } + } + + ////////////////////////////////////////////////////// + // remove sections w/widgets that we aren't keeping // + ////////////////////////////////////////////////////// + if(cloneTable.getSections() != null) + { + cloneTable.getSections().removeIf(section -> section.getWidgetName() != null && !widgetsToKeep.contains(section.getWidgetName())); + } + + return (cloneTable); + } + + + + /*************************************************************************** + * + ***************************************************************************/ + private Set getFieldsToKeepFromJoinTable(String joinTableName, AbstractTableActionInput tableActionInput, Map> getFieldsToKeepFromJoinTableCache) + { + return (getFieldsToKeepFromJoinTableCache.computeIfAbsent(joinTableName, k -> + { + try + { + if(isTableCustomizable(joinTableName)) + { + //////////////////////////////////////////////////////////////// + // if the table is customizable, return set of fields to keep // + //////////////////////////////////////////////////////////////// + QTableMetaData joinTableClone = QContext.getQInstance().getTable(joinTableName).clone(); + TableView joinTableView = getEffectiveTableViewForCurrentSession(joinTableName); + Map joinTableFieldsToKeep = getFieldsToKeepForTable(joinTableView, joinTableClone, tableActionInput); + return joinTableFieldsToKeep.keySet(); + } + else + { + /////////////////////////////////////////////// + // else, not customizable, return all fields // + /////////////////////////////////////////////// + return (QContext.getQInstance().getTable(joinTableName).getFields().keySet()); + } + } + catch(QException e) + { + return Collections.emptySet(); + } + })); + } + + + + /*************************************************************************** + * + ***************************************************************************/ + private static Map getFieldsToKeepForTable(TableView tableView, QTableMetaData cloneTable, AbstractTableActionInput tableActionInput) { Map cloneFields = cloneTable.getFields(); if(cloneFields == null) @@ -239,52 +371,7 @@ public class CustomizableTableViewsTablePersonalizer implements TableMetaDataPer fieldsToKeep.put(fieldName, cloneFields.get(fieldName)); } } - - cloneTable.setFields(fieldsToKeep); - - /////////////////////////////////////////////////////////// - // remove field names which aren't present from sections // - /////////////////////////////////////////////////////////// - for(QFieldSection section : CollectionUtils.nonNullList(cloneTable.getSections())) - { - if(section.getFieldNames() != null) - { - section.getFieldNames().removeIf(next -> !fieldsToKeep.containsKey(next)); - } - } - - ////////////////////////////////////////////////////////// - // remove sections that had all of their fields removed // - ////////////////////////////////////////////////////////// - CollectionUtils.nonNullList(cloneTable.getSections()).removeIf(section -> - section.getFieldNames() != null && section.getFieldNames().isEmpty() && !StringUtils.hasContent(section.getWidgetName())); - - ////////////////////////////////////// - // figure out which widgets we keep // - ////////////////////////////////////// - Set widgetsToKeep = new HashSet<>(); - for(TableViewWidget tableViewWidget : CollectionUtils.nonNullList(tableView.getWidgets())) - { - try - { - String widgetName = tableViewWidget.getWidgetName(); - widgetsToKeep.add(widgetName); - } - catch(Exception e) - { - LOG.warn("Error processing tableViewWidget", e, logPair("widgetName", tableViewWidget.getWidgetName())); - } - } - - ////////////////////////////////////////////////////// - // remove sections w/widgets that we aren't keeping // - ////////////////////////////////////////////////////// - if(cloneTable.getSections() != null) - { - cloneTable.getSections().removeIf(section -> section.getWidgetName() != null && !widgetsToKeep.contains(section.getWidgetName())); - } - - return (cloneTable); + return fieldsToKeep; } diff --git a/src/test/java/com/kingsrook/qbits/customizabletableviews/logic/CustomizableTableViewsTablePersonalizerTest.java b/src/test/java/com/kingsrook/qbits/customizabletableviews/logic/CustomizableTableViewsTablePersonalizerTest.java index 78c7fee..37f4fda 100644 --- a/src/test/java/com/kingsrook/qbits/customizabletableviews/logic/CustomizableTableViewsTablePersonalizerTest.java +++ b/src/test/java/com/kingsrook/qbits/customizabletableviews/logic/CustomizableTableViewsTablePersonalizerTest.java @@ -58,6 +58,9 @@ import com.kingsrook.qqq.backend.core.model.actions.tables.update.UpdateInput; import com.kingsrook.qqq.backend.core.model.metadata.fields.DynamicDefaultValueBehavior; import com.kingsrook.qqq.backend.core.model.metadata.fields.QFieldMetaData; import com.kingsrook.qqq.backend.core.model.metadata.fields.QFieldType; +import com.kingsrook.qqq.backend.core.model.metadata.joins.JoinOn; +import com.kingsrook.qqq.backend.core.model.metadata.joins.JoinType; +import com.kingsrook.qqq.backend.core.model.metadata.joins.QJoinMetaData; import com.kingsrook.qqq.backend.core.model.metadata.tables.QTableMetaData; import com.kingsrook.qqq.backend.core.model.metadata.tables.SectionFactory; import com.kingsrook.qqq.backend.core.model.session.QUser; @@ -417,6 +420,7 @@ class CustomizableTableViewsTablePersonalizerTest extends BaseTest assertThat(tableMetaData.getSections()).isNullOrEmpty(); QTableMetaData baseTable = new QTableMetaData() + .withName("baseTable") .withPrimaryKeyField("id") .withField(new QFieldMetaData("id", QFieldType.STRING).withIsEditable(false)) .withField(new QFieldMetaData("secret", QFieldType.STRING).withIsHidden(true)) @@ -450,10 +454,10 @@ class CustomizableTableViewsTablePersonalizerTest extends BaseTest /////////////////////////////////////////////////////////////////////////////////////////////////////////////////// tableMetaData = personalizer.applyViewToTable( new TableView().withFields(List.of( - new TableViewField().withFieldName("x.id").withAccessLevel(EDITABLE_OPTIONAL), - new TableViewField().withFieldName("x.secret").withAccessLevel(EDITABLE_OPTIONAL), - new TableViewField().withFieldName("x.mandatory").withAccessLevel(EDITABLE_OPTIONAL), - new TableViewField().withFieldName("x.optional").withAccessLevel(EDITABLE_OPTIONAL) + new TableViewField().withFieldName("baseTable.id").withAccessLevel(EDITABLE_OPTIONAL), + new TableViewField().withFieldName("baseTable.secret").withAccessLevel(EDITABLE_OPTIONAL), + new TableViewField().withFieldName("baseTable.mandatory").withAccessLevel(EDITABLE_OPTIONAL), + new TableViewField().withFieldName("baseTable.optional").withAccessLevel(EDITABLE_OPTIONAL) )), baseTable.clone(), tableActionInput); @@ -608,6 +612,11 @@ class CustomizableTableViewsTablePersonalizerTest extends BaseTest new InsertAction().execute(new InsertInput(CustomizableTable.TABLE_NAME).withRecordEntities(List.of( new CustomizableTable().withTableName(baseTable.getName()).withIsActive(true)))); + //////////////////////////////////////////////////////////////// + // assert system inputSource still gets same as default table // + //////////////////////////////////////////////////////////////// + assertSame(baseTable, personalizer.execute(new TableMetaDataPersonalizerInput().withTableMetaData(baseTable).withInputSource(QInputSource.SYSTEM))); + /////////////////////////////////////////// // assert it's pretty empty with no view // /////////////////////////////////////////// @@ -629,6 +638,11 @@ class CustomizableTableViewsTablePersonalizerTest extends BaseTest new InsertAction().execute(new InsertInput(TableViewRoleInt.TABLE_NAME).withRecordEntities(List.of( new TableViewRoleInt().withRoleId(101).withTableViewId(1)))); + //////////////////////////////////////////////////////////////// + // assert system inputSource still gets same as default table // + //////////////////////////////////////////////////////////////// + assertSame(baseTable, personalizer.execute(new TableMetaDataPersonalizerInput().withTableMetaData(baseTable).withInputSource(QInputSource.SYSTEM))); + QContext.getQSession().setUser(new QUser().withIdReference(UUID.randomUUID().toString())); QContext.getQSession().setValue("roleIds", "101"); @@ -641,6 +655,54 @@ class CustomizableTableViewsTablePersonalizerTest extends BaseTest assertEquals(Set.of("id", "optional"), personalizedTable.getFields().values().stream().map(s -> s.getName()).collect(Collectors.toSet())); assertEquals(3, personalizedTable.getSections().size()); assertEquals(List.of("s0", "s1", "w0"), personalizedTable.getSections().stream().map(s -> s.getName()).toList()); + + ////////////////////////////////////////////////////////////////////////// + // add a join table, and a field from it in the main table's t2 section // + ////////////////////////////////////////////////////////////////////////// + QTableMetaData joinTable = new QTableMetaData() + .withName("joinTable") + .withPrimaryKeyField("id") + .withField(new QFieldMetaData("id", QFieldType.STRING).withIsEditable(false)) + .withField(new QFieldMetaData("joinField", QFieldType.STRING)) + .withSection(SectionFactory.defaultT1("id", "joinField").withName("s0")); + QContext.getQInstance().addTable(joinTable); + QContext.getQInstance().addJoin(new QJoinMetaData().withLeftTable("baseTable").withRightTable("joinTable").withInferredName().withType(JoinType.ONE_TO_ONE).withJoinOn(new JoinOn("id", "joinField"))); + baseTable.getSection("s1").getFieldNames().add("joinTable.joinField"); + + ////////////////////////////////////////// + // by default, should get the joinField // + ////////////////////////////////////////// + personalizedTable = personalizer.execute(input); + assertEquals(List.of("optional", "joinTable.joinField"), personalizedTable.getSection("s1").getFieldNames()); + + ////////////////////////////////////////////////////////////////////////////////// + // activate customization on the join table, which should remove the join field // + ////////////////////////////////////////////////////////////////////////////////// + new InsertAction().execute(new InsertInput(CustomizableTable.TABLE_NAME).withRecordEntities(List.of( + new CustomizableTable().withTableName(joinTable.getName()).withIsActive(true)))); + personalizedTable = personalizer.execute(input); + assertEquals(List.of("optional"), personalizedTable.getSection("s1").getFieldNames()); + + /////////////////////////////////////////////////////////////////////////////////////////////////////////////// + // add a view to the join table, with a field, and attach it to the view - then the user gets the field back // + /////////////////////////////////////////////////////////////////////////////////////////////////////////////// + new InsertAction().execute(new InsertInput(TableView.TABLE_NAME).withRecordEntities(List.of( + new TableView().withId(2).withCustomizableTableId(2).withName("a") + .withFields(List.of(new TableViewField().withFieldName(joinTable.getName() + ".joinField").withAccessLevel(EDITABLE_OPTIONAL)))))); + new InsertAction().execute(new InsertInput(TableViewRoleInt.TABLE_NAME).withRecordEntities(List.of( + new TableViewRoleInt().withRoleId(101).withTableViewId(2)))); + + personalizedTable = personalizer.execute(input); + assertEquals(List.of("optional", "joinTable.joinField"), personalizedTable.getSection("s1").getFieldNames()); + + /////////////////////////////////////////////////////////////////////////////////////////////////////// + // finally, set user to not have this role, make sure the section with the join field disappears // + // (the non-join field will have also gone away by switching to other role, so the section is empty) // + /////////////////////////////////////////////////////////////////////////////////////////////////////// + QContext.getQSession().setUser(new QUser().withIdReference(UUID.randomUUID().toString())); + QContext.getQSession().setValue("roleIds", "102"); + personalizedTable = personalizer.execute(input); + assertNull(personalizedTable.getSection("s1")); } -- 2.54.0 From 983bde771330943a20c38ed757486c371c83b932 Mon Sep 17 00:00:00 2001 From: Darin Kelkhoff Date: Fri, 5 Dec 2025 12:03:10 -0600 Subject: [PATCH 14/20] chore: update version to 0.2.3-SNAPSHOT? --- pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pom.xml b/pom.xml index 1c7936b..0b34c5b 100644 --- a/pom.xml +++ b/pom.xml @@ -23,7 +23,7 @@ - 0.2.2-SNAPSHOT + 0.2.3-SNAPSHOT -- 2.54.0 From 8b94ecedf323b71b1609f0bb3891d965ab256e22 Mon Sep 17 00:00:00 2001 From: James Maes Date: Thu, 25 Dec 2025 19:32:47 -0600 Subject: [PATCH 15/20] chore(license): add AGPL-3.0 license with QRun-IO copyright --- LICENSE | 680 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 680 insertions(+) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..bf20455 --- /dev/null +++ b/LICENSE @@ -0,0 +1,680 @@ +QQQ - Low-code Application Framework for Engineers +Copyright (C) 2021-2025 QRun-IO, LLC +https://www.qrun.io | https://github.com/QRun-IO + +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 . + +-------------------------------------------------------------------------------- + + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + 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 . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +. -- 2.54.0 From 4213148582dc6a22a02797979951c54bd6eb941a Mon Sep 17 00:00:00 2001 From: James Maes Date: Sat, 10 Jan 2026 21:05:10 -0600 Subject: [PATCH 16/20] chore: bump qqq to 0.40.0-SNAPSHOT --- pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pom.xml b/pom.xml index 0b34c5b..836e7e2 100644 --- a/pom.xml +++ b/pom.xml @@ -74,7 +74,7 @@ com.kingsrook.qqq qqq-bom-pom - 0.27.9 + 0.40.0-SNAPSHOT pom import -- 2.54.0 From 0c406e9a4b9e73234639d11a78acd5170a33f1bc Mon Sep 17 00:00:00 2001 From: Darin Kelkhoff Date: Thu, 29 Jan 2026 16:11:01 -0600 Subject: [PATCH 17/20] feat: always keep fields that are part of any record locks on a table, plus any that are marked by the application via supplemental meta-data as always-include --- ...stomizableTableViewsTablePersonalizer.java | 146 +++++++++++++---- .../CustomizableTableViewsFieldMetaData.java | 89 ++++++++++ ...izableTableViewsTablePersonalizerTest.java | 154 ++++++++++++++++++ 3 files changed, 361 insertions(+), 28 deletions(-) create mode 100644 src/main/java/com/kingsrook/qbits/customizabletableviews/model/CustomizableTableViewsFieldMetaData.java diff --git a/src/main/java/com/kingsrook/qbits/customizabletableviews/logic/CustomizableTableViewsTablePersonalizer.java b/src/main/java/com/kingsrook/qbits/customizabletableviews/logic/CustomizableTableViewsTablePersonalizer.java index 613da5d..f46296d 100644 --- a/src/main/java/com/kingsrook/qbits/customizabletableviews/logic/CustomizableTableViewsTablePersonalizer.java +++ b/src/main/java/com/kingsrook/qbits/customizabletableviews/logic/CustomizableTableViewsTablePersonalizer.java @@ -37,6 +37,7 @@ import java.util.Optional; import java.util.Set; import java.util.stream.Collectors; import com.kingsrook.qbits.customizabletableviews.model.CustomizableTable; +import com.kingsrook.qbits.customizabletableviews.model.CustomizableTableViewsFieldMetaData; import com.kingsrook.qbits.customizabletableviews.model.FieldAccessLevel; import com.kingsrook.qbits.customizabletableviews.model.TableView; import com.kingsrook.qbits.customizabletableviews.model.TableViewField; @@ -70,6 +71,9 @@ import com.kingsrook.qqq.backend.core.model.metadata.code.QCodeReference; import com.kingsrook.qqq.backend.core.model.metadata.fields.DynamicDefaultValueBehavior; import com.kingsrook.qqq.backend.core.model.metadata.fields.FieldAndJoinTable; import com.kingsrook.qqq.backend.core.model.metadata.fields.QFieldMetaData; +import com.kingsrook.qqq.backend.core.model.metadata.fields.QSupplementalFieldMetaData; +import com.kingsrook.qqq.backend.core.model.metadata.security.MultiRecordSecurityLock; +import com.kingsrook.qqq.backend.core.model.metadata.security.RecordSecurityLock; import com.kingsrook.qqq.backend.core.model.metadata.tables.QFieldSection; import com.kingsrook.qqq.backend.core.model.metadata.tables.QTableMetaData; import com.kingsrook.qqq.backend.core.model.session.QUser; @@ -262,7 +266,7 @@ public class CustomizableTableViewsTablePersonalizer implements TableMetaDataPer /*************************************************************************** * ***************************************************************************/ - private Set getFieldsToKeepFromJoinTable(String joinTableName, AbstractTableActionInput tableActionInput, Map> getFieldsToKeepFromJoinTableCache) + protected Set getFieldsToKeepFromJoinTable(String joinTableName, AbstractTableActionInput tableActionInput, Map> getFieldsToKeepFromJoinTableCache) { return (getFieldsToKeepFromJoinTableCache.computeIfAbsent(joinTableName, k -> { @@ -298,7 +302,7 @@ public class CustomizableTableViewsTablePersonalizer implements TableMetaDataPer /*************************************************************************** * ***************************************************************************/ - private static Map getFieldsToKeepForTable(TableView tableView, QTableMetaData cloneTable, AbstractTableActionInput tableActionInput) + protected Map getFieldsToKeepForTable(TableView tableView, QTableMetaData cloneTable, AbstractTableActionInput tableActionInput) { Map cloneFields = cloneTable.getFields(); if(cloneFields == null) @@ -339,43 +343,129 @@ public class CustomizableTableViewsTablePersonalizer implements TableMetaDataPer ///////////////////////////////////////////// // next look for ones that always get kept // ///////////////////////////////////////////// - boolean isInsertOrUpdate = (tableActionInput instanceof InsertInput) || (tableActionInput instanceof UpdateInput); for(QFieldMetaData field : cloneTable.getFields().values()) { String fieldName = field.getName(); - if(fieldsToKeep.containsKey(fieldName)) + if(!fieldsToKeep.containsKey(fieldName)) { - continue; - } - - DynamicDefaultValueBehavior x = null; - boolean keep = false; - if(field.getIsRequired() || Objects.equals(fieldName, cloneTable.getPrimaryKeyField())) - { - /////////////////////////////////////////////////////////// - // always keep the primary key field and required fields // - /////////////////////////////////////////////////////////// - keep = true; - } - else if(isInsertOrUpdate && field.getBehaviorOnlyIfSet(DynamicDefaultValueBehavior.class) != null) - { - ////////////////////////////////////////////////////////////////////////////////////////////////////// - // if this is for an insert or update, then keep any fields that have a DynamicDefaultValueBehavior // - // e.g., createDates, modifyDates, things that capture userId // - ////////////////////////////////////////////////////////////////////////////////////////////////////// - keep = true; - } - - if(keep) - { - fieldsToKeep.put(fieldName, cloneFields.get(fieldName)); + if(shouldKeepFieldDueToRules(cloneTable, field, tableActionInput)) + { + fieldsToKeep.put(fieldName, cloneFields.get(fieldName)); + } } } + return fieldsToKeep; } + /*************************************************************************** + * check if any system-defined rules make it so that a field should always + * be kept. + * + *

built-in rules are:

+ *
    + *
  • field is required
    • + *
  • field is primary key
    • + *
  • field is part of table's security locks
    • + *
  • there's supplemental metadata from this qbit that says to keep the field
    • + *
  • this is an insert or update, and there's a {@link DynamicDefaultValueBehavior}
    • + *
+ * + * also - an application could override this method in a subclass to add + * additional rules. + ***************************************************************************/ + protected boolean shouldKeepFieldDueToRules(QTableMetaData cloneTable, QFieldMetaData field, AbstractTableActionInput tableActionInput) + { + if(field.getIsRequired() || Objects.equals(field.getName(), cloneTable.getPrimaryKeyField())) + { + /////////////////////////////////////////////////////////// + // always keep the primary key field and required fields // + /////////////////////////////////////////////////////////// + return (true); + } + + if(doRecordSecurityLocksContainField(cloneTable.getRecordSecurityLocks(), field)) + { + ///////////////////////////////////////////////////////////// + // keep fields that are part of the table's security locks // + ///////////////////////////////////////////////////////////// + return (true); + } + + if(doesSupplementalMetaDataSayToKeepField(field)) + { + ////////////////////////////////////////////////////////// + // keep a field if it's marked as being always-included // + ////////////////////////////////////////////////////////// + return (true); + } + + boolean isInsertOrUpdate = (tableActionInput instanceof InsertInput) || (tableActionInput instanceof UpdateInput); + if(isInsertOrUpdate && field.getBehaviorOnlyIfSet(DynamicDefaultValueBehavior.class) != null) + { + ////////////////////////////////////////////////////////////////////////////////////////////////////// + // if this is for an insert or update, then keep any fields that have a DynamicDefaultValueBehavior // + // e.g., createDates, modifyDates, things that capture userId // + ////////////////////////////////////////////////////////////////////////////////////////////////////// + return (true); + } + + //////////////////////////////////////////// + // by default, no rule matched, so say no // + //////////////////////////////////////////// + return (false); + } + + + + /*************************************************************************** + * Check if the supplemental meta data from this qbit for a field says + * that the field should always be kept. + ***************************************************************************/ + protected boolean doesSupplementalMetaDataSayToKeepField(QFieldMetaData field) + { + QSupplementalFieldMetaData supplementalMetaData = field.getSupplementalMetaData(CustomizableTableViewsFieldMetaData.TYPE); + if(supplementalMetaData instanceof CustomizableTableViewsFieldMetaData customizableTableViewsFieldMetaData) + { + if(CustomizableTableViewsFieldMetaData.Rule.ALWAYS_KEEP_FIELD.equals(customizableTableViewsFieldMetaData.getRule())) + { + return (true); + } + } + + return (false); + } + + + + /*************************************************************************** + * Check if a list of record security locks include a field, recursively + * processing {@link MultiRecordSecurityLock}s + ***************************************************************************/ + protected boolean doRecordSecurityLocksContainField(List locks, QFieldMetaData field) + { + for(RecordSecurityLock recordSecurityLock : CollectionUtils.nonNullList(locks)) + { + if(recordSecurityLock instanceof MultiRecordSecurityLock multiRecordSecurityLock) + { + if(doRecordSecurityLocksContainField(multiRecordSecurityLock.getLocks(), field)) + { + return (true); + } + } + else if(field.getName().equals(recordSecurityLock.getFieldName())) + { + return true; + } + } + + return false; + } + + + /*************************************************************************** * the assumption is, that this method is called AFTER we've identified that * a table is customizable (and customizaztion is active) - so - if we fail diff --git a/src/main/java/com/kingsrook/qbits/customizabletableviews/model/CustomizableTableViewsFieldMetaData.java b/src/main/java/com/kingsrook/qbits/customizabletableviews/model/CustomizableTableViewsFieldMetaData.java new file mode 100644 index 0000000..a3163ed --- /dev/null +++ b/src/main/java/com/kingsrook/qbits/customizabletableviews/model/CustomizableTableViewsFieldMetaData.java @@ -0,0 +1,89 @@ +/* + * QQQ - Low-code Application Framework for Engineers. + * Copyright (C) 2021-2026. 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 . + */ + +package com.kingsrook.qbits.customizabletableviews.model; + + +import com.kingsrook.qqq.backend.core.model.metadata.fields.QSupplementalFieldMetaData; + + +/******************************************************************************* + ** + *******************************************************************************/ +public class CustomizableTableViewsFieldMetaData extends QSupplementalFieldMetaData +{ + public static final String TYPE = CustomizableTableViewsFieldMetaData.class.getName(); + + private Rule rule; + + public enum Rule + { + ALWAYS_KEEP_FIELD + } + + /*************************************************************************** + * + ***************************************************************************/ + @Override + public String getType() + { + return TYPE; + } + + + /******************************************************************************* + * Getter for rule + * @see #withRule(Rule) + *******************************************************************************/ + public Rule getRule() + { + return (this.rule); + } + + + + /******************************************************************************* + * Setter for rule + * @see #withRule(Rule) + *******************************************************************************/ + public void setRule(Rule rule) + { + this.rule = rule; + } + + + + /******************************************************************************* + * Fluent setter for rule + * + * @param rule + * TODO document this property + * + * @return this + *******************************************************************************/ + public CustomizableTableViewsFieldMetaData withRule(Rule rule) + { + this.rule = rule; + return (this); + } + + +} diff --git a/src/test/java/com/kingsrook/qbits/customizabletableviews/logic/CustomizableTableViewsTablePersonalizerTest.java b/src/test/java/com/kingsrook/qbits/customizabletableviews/logic/CustomizableTableViewsTablePersonalizerTest.java index 37f4fda..4d081f4 100644 --- a/src/test/java/com/kingsrook/qbits/customizabletableviews/logic/CustomizableTableViewsTablePersonalizerTest.java +++ b/src/test/java/com/kingsrook/qbits/customizabletableviews/logic/CustomizableTableViewsTablePersonalizerTest.java @@ -34,6 +34,7 @@ import java.util.stream.Collectors; import com.kingsrook.qbits.customizabletableviews.BaseTest; import com.kingsrook.qbits.customizabletableviews.QFieldMetaDataAssert; import com.kingsrook.qbits.customizabletableviews.model.CustomizableTable; +import com.kingsrook.qbits.customizabletableviews.model.CustomizableTableViewsFieldMetaData; import com.kingsrook.qbits.customizabletableviews.model.FieldAccessLevel; import com.kingsrook.qbits.customizabletableviews.model.TableView; import com.kingsrook.qbits.customizabletableviews.model.TableViewField; @@ -61,6 +62,8 @@ import com.kingsrook.qqq.backend.core.model.metadata.fields.QFieldType; import com.kingsrook.qqq.backend.core.model.metadata.joins.JoinOn; import com.kingsrook.qqq.backend.core.model.metadata.joins.JoinType; import com.kingsrook.qqq.backend.core.model.metadata.joins.QJoinMetaData; +import com.kingsrook.qqq.backend.core.model.metadata.security.MultiRecordSecurityLock; +import com.kingsrook.qqq.backend.core.model.metadata.security.RecordSecurityLock; import com.kingsrook.qqq.backend.core.model.metadata.tables.QTableMetaData; import com.kingsrook.qqq.backend.core.model.metadata.tables.SectionFactory; import com.kingsrook.qqq.backend.core.model.session.QUser; @@ -548,6 +551,157 @@ class CustomizableTableViewsTablePersonalizerTest extends BaseTest + /******************************************************************************* + ** + *******************************************************************************/ + @Test + void testFieldsInSecurityLocks() + { + /////////////////////////// + // empty with empty case // + /////////////////////////// + QTableMetaData baseTable = new QTableMetaData() + .withPrimaryKeyField("id") + .withField(new QFieldMetaData("id", QFieldType.STRING).withIsEditable(false)) + .withField(new QFieldMetaData("a", QFieldType.STRING)) + .withField(new QFieldMetaData("b", QFieldType.STRING)) + .withField(new QFieldMetaData("c", QFieldType.STRING)) + .withField(new QFieldMetaData("d", QFieldType.STRING)); + + ////////////////////////////////////////////////////// + // with no security field, only id should come back // + ////////////////////////////////////////////////////// + { + QTableMetaData tableMetaData = new CustomizableTableViewsTablePersonalizer().applyViewToTable( + new TableView().withFields(List.of()), + baseTable.clone(), new QueryInput()); + + assertEquals(1, tableMetaData.getFields().size()); + QFieldMetaDataAssert.assertThat(tableMetaData.getField("id")).isNotNull(); + } + + /////////////////////////////////////////////////////// + // with a simple security field, it should come back // + /////////////////////////////////////////////////////// + baseTable.setRecordSecurityLocks(List.of( + new RecordSecurityLock().withFieldName("a") + )); + { + QTableMetaData tableMetaData = new CustomizableTableViewsTablePersonalizer().applyViewToTable( + new TableView().withFields(List.of()), + baseTable.clone(), new QueryInput()); + + assertEquals(2, tableMetaData.getFields().size()); + QFieldMetaDataAssert.assertThat(tableMetaData.getField("id")).isNotNull(); + QFieldMetaDataAssert.assertThat(tableMetaData.getField("a")).isNotNull(); + } + + ///////////////////////////////////////////////////////////// + // with a multi-lock, all included fields should come back // + ///////////////////////////////////////////////////////////// + baseTable.setRecordSecurityLocks(List.of( + new MultiRecordSecurityLock() + .withOperator(MultiRecordSecurityLock.BooleanOperator.OR) + .withLocks(List.of( + new RecordSecurityLock().withFieldName("b"), + new MultiRecordSecurityLock() + .withOperator(MultiRecordSecurityLock.BooleanOperator.AND) + .withLocks(List.of( + new RecordSecurityLock().withFieldName("c"), + new RecordSecurityLock().withFieldName("d") + )) + )) + )); + { + QTableMetaData tableMetaData = new CustomizableTableViewsTablePersonalizer().applyViewToTable( + new TableView().withFields(List.of()), + baseTable.clone(), new QueryInput()); + + assertEquals(4, tableMetaData.getFields().size()); + QFieldMetaDataAssert.assertThat(tableMetaData.getField("id")).isNotNull(); + QFieldMetaDataAssert.assertThat(tableMetaData.getField("b")).isNotNull(); + QFieldMetaDataAssert.assertThat(tableMetaData.getField("c")).isNotNull(); + QFieldMetaDataAssert.assertThat(tableMetaData.getField("d")).isNotNull(); + } + + /////////////////////////////////////////////////////////// + // make sure lock field from join table doesn't break us // + /////////////////////////////////////////////////////////// + baseTable.setRecordSecurityLocks(List.of( + new RecordSecurityLock().withFieldName("join.a") + )); + { + QTableMetaData tableMetaData = new CustomizableTableViewsTablePersonalizer().applyViewToTable( + new TableView().withFields(List.of()), + baseTable.clone(), new QueryInput()); + + assertEquals(1, tableMetaData.getFields().size()); + QFieldMetaDataAssert.assertThat(tableMetaData.getField("id")).isNotNull(); + } + } + + + + /******************************************************************************* + ** + *******************************************************************************/ + @Test + void testFieldsWithSupplementalMetaData() + { + /////////////////////////// + // empty with empty case // + /////////////////////////// + QTableMetaData baseTable = new QTableMetaData() + .withPrimaryKeyField("id") + .withField(new QFieldMetaData("id", QFieldType.STRING).withIsEditable(false)) + .withField(new QFieldMetaData("a", QFieldType.STRING)) + .withField(new QFieldMetaData("b", QFieldType.STRING)) + .withField(new QFieldMetaData("c", QFieldType.STRING)) + .withField(new QFieldMetaData("d", QFieldType.STRING)); + + ////////////////////////////////// + // base case, should just be id // + ////////////////////////////////// + { + QTableMetaData tableMetaData = new CustomizableTableViewsTablePersonalizer().applyViewToTable( + new TableView().withFields(List.of()), + baseTable.clone(), new QueryInput()); + + assertEquals(1, tableMetaData.getFields().size()); + QFieldMetaDataAssert.assertThat(tableMetaData.getField("id")).isNotNull(); + } + + /////////////////////////////////////////////////////////////////////// + // supplemental meta data, but without a rule should not be included // + /////////////////////////////////////////////////////////////////////// + baseTable.getField("a").withSupplementalMetaData(new CustomizableTableViewsFieldMetaData()); + { + QTableMetaData tableMetaData = new CustomizableTableViewsTablePersonalizer().applyViewToTable( + new TableView().withFields(List.of()), + baseTable.clone(), new QueryInput()); + + assertEquals(1, tableMetaData.getFields().size()); + QFieldMetaDataAssert.assertThat(tableMetaData.getField("id")).isNotNull(); + } + + ////////////////////////////////////////////////////////////////////// + // supplemental meta data, with the include rule should be included // + ////////////////////////////////////////////////////////////////////// + baseTable.getField("b").withSupplementalMetaData(new CustomizableTableViewsFieldMetaData() + .withRule(CustomizableTableViewsFieldMetaData.Rule.ALWAYS_KEEP_FIELD)); + { + QTableMetaData tableMetaData = new CustomizableTableViewsTablePersonalizer().applyViewToTable( + new TableView().withFields(List.of()), + baseTable.clone(), new QueryInput()); + + assertEquals(2, tableMetaData.getFields().size()); + QFieldMetaDataAssert.assertThat(tableMetaData.getField("id")).isNotNull(); + QFieldMetaDataAssert.assertThat(tableMetaData.getField("b")).isNotNull(); + } + } + + + /******************************************************************************* ** *******************************************************************************/ -- 2.54.0 From 2f3938929b48a3553d3a3835b21d0e302ce5fc62 Mon Sep 17 00:00:00 2001 From: Darin Kelkhoff Date: Mon, 9 Mar 2026 09:00:03 -0500 Subject: [PATCH 18/20] feat(virtualFields): add baseline support for virtualFields --- ...stomizableTableViewsTablePersonalizer.java | 53 ++++++++++++ .../model/CustomizableTableFieldPVS.java | 14 +++- .../model/FieldAccessLevel.java | 3 +- .../customizers/TableViewFieldCustomizer.java | 2 +- ...izableTableViewsTablePersonalizerTest.java | 80 +++++++++++++++++++ .../model/CustomizableTableFieldPVSTest.java | 60 ++++++++++++++ .../model/FieldAccessLevelTest.java | 31 +++++++ .../TableViewFieldCustomizerTest.java | 22 +++++ 8 files changed, 262 insertions(+), 3 deletions(-) diff --git a/src/main/java/com/kingsrook/qbits/customizabletableviews/logic/CustomizableTableViewsTablePersonalizer.java b/src/main/java/com/kingsrook/qbits/customizabletableviews/logic/CustomizableTableViewsTablePersonalizer.java index f46296d..4a20f38 100644 --- a/src/main/java/com/kingsrook/qbits/customizabletableviews/logic/CustomizableTableViewsTablePersonalizer.java +++ b/src/main/java/com/kingsrook/qbits/customizabletableviews/logic/CustomizableTableViewsTablePersonalizer.java @@ -72,6 +72,7 @@ import com.kingsrook.qqq.backend.core.model.metadata.fields.DynamicDefaultValueB import com.kingsrook.qqq.backend.core.model.metadata.fields.FieldAndJoinTable; import com.kingsrook.qqq.backend.core.model.metadata.fields.QFieldMetaData; import com.kingsrook.qqq.backend.core.model.metadata.fields.QSupplementalFieldMetaData; +import com.kingsrook.qqq.backend.core.model.metadata.fields.QVirtualFieldMetaData; import com.kingsrook.qqq.backend.core.model.metadata.security.MultiRecordSecurityLock; import com.kingsrook.qqq.backend.core.model.metadata.security.RecordSecurityLock; import com.kingsrook.qqq.backend.core.model.metadata.tables.QFieldSection; @@ -178,6 +179,9 @@ public class CustomizableTableViewsTablePersonalizer implements TableMetaDataPer Map fieldsToKeep = getFieldsToKeepForTable(tableView, cloneTable, tableActionInput); cloneTable.setFields(fieldsToKeep); + Map virtualFieldsToKeep = getVirtualFieldsToKeepForTable(tableView, cloneTable, tableActionInput); + cloneTable.setVirtualFields(virtualFieldsToKeep); + /////////////////////////////////////////////////////////// // remove field names which aren't present from sections // /////////////////////////////////////////////////////////// @@ -360,6 +364,55 @@ public class CustomizableTableViewsTablePersonalizer implements TableMetaDataPer + /*************************************************************************** + * + ***************************************************************************/ + protected Map getVirtualFieldsToKeepForTable(TableView tableView, QTableMetaData cloneTable, AbstractTableActionInput tableActionInput) + { + Map cloneFields = cloneTable.getVirtualFields(); + if(cloneFields == null) + { + return Collections.emptyMap(); + } + + Map fieldsToKeep = new LinkedHashMap<>(); + + ///////////////////////////////////////////// + // figure out which fields the user gets // + // start with ones in the user's TableView // + ///////////////////////////////////////////// + for(TableViewField tableViewField : CollectionUtils.nonNullList(tableView.getFields())) + { + try + { + String fieldName = tableViewField.getFieldName().split("\\.")[1]; + QVirtualFieldMetaData fieldMetaData = cloneFields.get(fieldName); + if(fieldMetaData != null) + { + FieldAccessLevel fieldAccessLevel = FieldAccessLevel.getById(tableViewField.getAccessLevel()); + if(fieldAccessLevel != null) + { + fieldAccessLevel.apply(fieldMetaData); + } + + fieldsToKeep.put(fieldName, fieldMetaData); + } + } + catch(Exception e) + { + LOG.warn("Error processing tableViewField", e, logPair("fieldName", tableViewField.getFieldName())); + } + } + + /////////////////////////////////////////////////////////////////////////////// + // unlike normal fields, there are no 'always keep' rules for virtual fields // + /////////////////////////////////////////////////////////////////////////////// + + return fieldsToKeep; + } + + + /*************************************************************************** * check if any system-defined rules make it so that a field should always * be kept. diff --git a/src/main/java/com/kingsrook/qbits/customizabletableviews/model/CustomizableTableFieldPVS.java b/src/main/java/com/kingsrook/qbits/customizabletableviews/model/CustomizableTableFieldPVS.java index 4b1f502..b5857f7 100644 --- a/src/main/java/com/kingsrook/qbits/customizabletableviews/model/CustomizableTableFieldPVS.java +++ b/src/main/java/com/kingsrook/qbits/customizabletableviews/model/CustomizableTableFieldPVS.java @@ -96,6 +96,12 @@ public class CustomizableTableFieldPVS implements QCustomPossibleValueProvider(idString, fieldMetaData.getLabel())); } + + fieldMetaData = table.getVirtualFields().get(fieldName); + if(fieldMetaData != null) + { + return (new QPossibleValue<>(idString, fieldMetaData.getLabel())); + } } } @@ -128,7 +134,13 @@ public class CustomizableTableFieldPVS implements QCustomPossibleValueProvider fields = new ArrayList<>(table.getFields().values()); + if(table.getVirtualFields() != null) + { + fields.addAll(table.getVirtualFields().values()); + } + + for(QFieldMetaData field : fields) { if(field.getName().equals(table.getPrimaryKeyField())) { diff --git a/src/main/java/com/kingsrook/qbits/customizabletableviews/model/FieldAccessLevel.java b/src/main/java/com/kingsrook/qbits/customizabletableviews/model/FieldAccessLevel.java index 038e2b5..35808ea 100644 --- a/src/main/java/com/kingsrook/qbits/customizabletableviews/model/FieldAccessLevel.java +++ b/src/main/java/com/kingsrook/qbits/customizabletableviews/model/FieldAccessLevel.java @@ -24,6 +24,7 @@ package com.kingsrook.qbits.customizabletableviews.model; import java.util.Objects; import com.kingsrook.qqq.backend.core.model.metadata.fields.QFieldMetaData; +import com.kingsrook.qqq.backend.core.model.metadata.fields.QVirtualFieldMetaData; import com.kingsrook.qqq.backend.core.model.metadata.possiblevalues.PossibleValueEnum; import com.kingsrook.qqq.backend.core.model.metadata.producers.annotations.QMetaDataProducingPossibleValueEnum; @@ -204,7 +205,7 @@ public enum FieldAccessLevel implements PossibleValueEnum return ("This field is defined as hidden by the system - you may not make it " + getLabel()); } - if(!fieldMetaData.getIsEditable()) + if(!fieldMetaData.getIsEditable() || fieldMetaData instanceof QVirtualFieldMetaData) { if(this == READ_ONLY) { diff --git a/src/main/java/com/kingsrook/qbits/customizabletableviews/tables/customizers/TableViewFieldCustomizer.java b/src/main/java/com/kingsrook/qbits/customizabletableviews/tables/customizers/TableViewFieldCustomizer.java index 089f559..5e21127 100644 --- a/src/main/java/com/kingsrook/qbits/customizabletableviews/tables/customizers/TableViewFieldCustomizer.java +++ b/src/main/java/com/kingsrook/qbits/customizabletableviews/tables/customizers/TableViewFieldCustomizer.java @@ -64,7 +64,7 @@ public class TableViewFieldCustomizer implements TableCustomizerInterface String tableName = parts[0]; fieldName = parts[1]; - QFieldMetaData field = QContext.getQInstance().getTable(tableName).getField(fieldName); + QFieldMetaData field = QContext.getQInstance().getTable(tableName).getFieldOrVirtualField(fieldName); FieldAccessLevel fieldAccessLevel = FieldAccessLevel.getById(accessLevelId); if(fieldAccessLevel != null) diff --git a/src/test/java/com/kingsrook/qbits/customizabletableviews/logic/CustomizableTableViewsTablePersonalizerTest.java b/src/test/java/com/kingsrook/qbits/customizabletableviews/logic/CustomizableTableViewsTablePersonalizerTest.java index 4d081f4..7b47a5d 100644 --- a/src/test/java/com/kingsrook/qbits/customizabletableviews/logic/CustomizableTableViewsTablePersonalizerTest.java +++ b/src/test/java/com/kingsrook/qbits/customizabletableviews/logic/CustomizableTableViewsTablePersonalizerTest.java @@ -59,6 +59,7 @@ import com.kingsrook.qqq.backend.core.model.actions.tables.update.UpdateInput; import com.kingsrook.qqq.backend.core.model.metadata.fields.DynamicDefaultValueBehavior; import com.kingsrook.qqq.backend.core.model.metadata.fields.QFieldMetaData; import com.kingsrook.qqq.backend.core.model.metadata.fields.QFieldType; +import com.kingsrook.qqq.backend.core.model.metadata.fields.QVirtualFieldMetaData; import com.kingsrook.qqq.backend.core.model.metadata.joins.JoinOn; import com.kingsrook.qqq.backend.core.model.metadata.joins.JoinType; import com.kingsrook.qqq.backend.core.model.metadata.joins.QJoinMetaData; @@ -499,6 +500,85 @@ class CustomizableTableViewsTablePersonalizerTest extends BaseTest + /******************************************************************************* + ** + *******************************************************************************/ + @Test + void testApplyViewToTableWithVirtualFields() + { + CustomizableTableViewsTablePersonalizer personalizer = new CustomizableTableViewsTablePersonalizer(); + TableMetaDataInput tableActionInput = new TableMetaDataInput(); + + QTableMetaData baseTable = new QTableMetaData() + .withName("vfTable") + .withPrimaryKeyField("id") + .withField(new QFieldMetaData("id", QFieldType.STRING).withIsEditable(false)) + .withField(new QFieldMetaData("optional", QFieldType.STRING)) + .withVirtualField(new QVirtualFieldMetaData("computed", QFieldType.STRING).withLabel("Computed")) + .withVirtualField(new QVirtualFieldMetaData("derived", QFieldType.STRING).withLabel("Derived")) + .withSection(SectionFactory.defaultT1("id").withName("s0")) + .withSection(SectionFactory.defaultT2("optional").withName("s1")); + + ///////////////////////////////////////////////////////////////////////////////// + // empty view - no virtual fields kept (no "always keep" rules for virtuals) // + ///////////////////////////////////////////////////////////////////////////////// + QTableMetaData tableMetaData = personalizer.applyViewToTable( + new TableView().withFields(List.of()), + baseTable.clone(), tableActionInput); + + assertEquals(1, tableMetaData.getFields().size()); + assertNotNull(tableMetaData.getField("id")); + assertTrue(tableMetaData.getVirtualFields().isEmpty()); + + /////////////////////////////////////////////////////////////// + // view references one virtual field - only that one is kept // + /////////////////////////////////////////////////////////////// + tableMetaData = personalizer.applyViewToTable( + new TableView().withFields(List.of( + new TableViewField().withFieldName("vfTable.computed").withAccessLevel(READ_ONLY) + )), + baseTable.clone(), tableActionInput); + + assertEquals(1, tableMetaData.getFields().size()); + assertEquals(1, tableMetaData.getVirtualFields().size()); + assertNotNull(tableMetaData.getVirtualFields().get("computed")); + assertNull(tableMetaData.getVirtualFields().get("derived")); + + ///////////////////////////////////////////////////////////////////////////// + // view references both virtual fields and a regular field - all are kept // + ///////////////////////////////////////////////////////////////////////////// + tableMetaData = personalizer.applyViewToTable( + new TableView().withFields(List.of( + new TableViewField().withFieldName("vfTable.optional").withAccessLevel(EDITABLE_OPTIONAL), + new TableViewField().withFieldName("vfTable.computed").withAccessLevel(READ_ONLY), + new TableViewField().withFieldName("vfTable.derived").withAccessLevel(READ_ONLY) + )), + baseTable.clone(), tableActionInput); + + assertEquals(2, tableMetaData.getFields().size()); // id + optional + assertEquals(2, tableMetaData.getVirtualFields().size()); // computed + derived + + assertEquals(List.of("optional"), tableMetaData.getSection("s1").getFieldNames()); + + ////////////////////////////////////////////////////////////////// + // table with no virtual fields at all - should not break // + ////////////////////////////////////////////////////////////////// + QTableMetaData noVfTable = new QTableMetaData() + .withName("noVfTable") + .withPrimaryKeyField("id") + .withField(new QFieldMetaData("id", QFieldType.STRING).withIsEditable(false)) + .withSection(SectionFactory.defaultT1("id").withName("s0")); + + tableMetaData = personalizer.applyViewToTable( + new TableView().withFields(List.of()), + noVfTable.clone(), tableActionInput); + + assertEquals(1, tableMetaData.getFields().size()); + assertTrue(tableMetaData.getVirtualFields() == null || tableMetaData.getVirtualFields().isEmpty()); + } + + + /******************************************************************************* ** *******************************************************************************/ diff --git a/src/test/java/com/kingsrook/qbits/customizabletableviews/model/CustomizableTableFieldPVSTest.java b/src/test/java/com/kingsrook/qbits/customizabletableviews/model/CustomizableTableFieldPVSTest.java index 664d567..3a775fd 100644 --- a/src/test/java/com/kingsrook/qbits/customizabletableviews/model/CustomizableTableFieldPVSTest.java +++ b/src/test/java/com/kingsrook/qbits/customizabletableviews/model/CustomizableTableFieldPVSTest.java @@ -32,11 +32,15 @@ import com.kingsrook.qqq.backend.core.model.actions.tables.insert.InsertInput; import com.kingsrook.qqq.backend.core.model.actions.values.SearchPossibleValueSourceInput; import com.kingsrook.qqq.backend.core.model.metadata.fields.QFieldMetaData; import com.kingsrook.qqq.backend.core.model.metadata.fields.QFieldType; +import com.kingsrook.qqq.backend.core.model.metadata.fields.QVirtualFieldMetaData; import com.kingsrook.qqq.backend.core.model.metadata.possiblevalues.QPossibleValue; import com.kingsrook.qqq.backend.core.model.metadata.tables.QTableMetaData; import com.kingsrook.qqq.backend.core.model.metadata.tables.SectionFactory; import org.junit.jupiter.api.Test; +import static org.assertj.core.api.Assertions.assertThat; import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertNotNull; +import static org.junit.jupiter.api.Assertions.assertNull; /******************************************************************************* @@ -84,4 +88,60 @@ class CustomizableTableFieldPVSTest extends BaseTest assertEquals("Optional", possibleValues.get(1).getLabel()); } + + + /******************************************************************************* + ** + *******************************************************************************/ + @Test + void testWithVirtualFields() throws QException + { + QTableMetaData testTable = new QTableMetaData() + .withName("testTable") + .withPrimaryKeyField("id") + .withField(new QFieldMetaData("id", QFieldType.STRING).withIsEditable(false)) + .withField(new QFieldMetaData("optional", QFieldType.STRING).withLabel("Optional")) + .withVirtualField(new QVirtualFieldMetaData("computed", QFieldType.STRING).withLabel("Computed")) + .withVirtualField(new QVirtualFieldMetaData("hiddenVirtual", QFieldType.STRING).withIsHidden(true).withLabel("Hidden Virtual")) + .withSection(SectionFactory.defaultT1("id").withName("s0")) + .withSection(SectionFactory.defaultT2("optional").withName("s1")); + QContext.getQInstance().addTable(testTable); + + new InsertAction().execute(new InsertInput(CustomizableTable.TABLE_NAME).withRecordEntities(List.of( + new CustomizableTable().withTableName(testTable.getName()).withIsActive(true)))); + + Integer tableViewId = 17; + new InsertAction().execute(new InsertInput(TableView.TABLE_NAME).withRecordEntities(List.of( + new TableView().withId(tableViewId).withCustomizableTableId(1).withName("a")))); + + ///////////////////////////////////////////////////////////////////// + // search should include the non-hidden virtual field in results // + ///////////////////////////////////////////////////////////////////// + List> possibleValues = new CustomizableTableFieldPVS().search(new SearchPossibleValueSourceInput().withOtherValues(Map.of("tableViewId", tableViewId))); + assertEquals(2, possibleValues.size()); + assertThat(possibleValues) + .anyMatch(pv1 -> "testTable.computed".equals(pv1.getId()) && "Computed".equals(pv1.getLabel())) + .anyMatch(pv1 -> "testTable.optional".equals(pv1.getId()) && "Optional".equals(pv1.getLabel())); + + /////////////////////////////////////////////////////////////////// + // getPossibleValue should resolve a virtual field by table.name // + /////////////////////////////////////////////////////////////////// + QPossibleValue pv = new CustomizableTableFieldPVS().getPossibleValue("testTable.computed"); + assertNotNull(pv); + assertEquals("testTable.computed", pv.getId()); + assertEquals("Computed", pv.getLabel()); + + ///////////////////////////////////////////////////// + // getPossibleValue for a normal field still works // + ///////////////////////////////////////////////////// + QPossibleValue pvNormal = new CustomizableTableFieldPVS().getPossibleValue("testTable.optional"); + assertNotNull(pvNormal); + assertEquals("Optional", pvNormal.getLabel()); + + ///////////////////////////////////////////////////////// + // getPossibleValue for a nonexistent field returns null // + ///////////////////////////////////////////////////////// + assertNull(new CustomizableTableFieldPVS().getPossibleValue("testTable.doesNotExist")); + } + } \ No newline at end of file diff --git a/src/test/java/com/kingsrook/qbits/customizabletableviews/model/FieldAccessLevelTest.java b/src/test/java/com/kingsrook/qbits/customizabletableviews/model/FieldAccessLevelTest.java index 31b2afc..75ad5fa 100644 --- a/src/test/java/com/kingsrook/qbits/customizabletableviews/model/FieldAccessLevelTest.java +++ b/src/test/java/com/kingsrook/qbits/customizabletableviews/model/FieldAccessLevelTest.java @@ -25,12 +25,16 @@ package com.kingsrook.qbits.customizabletableviews.model; import java.util.function.BiFunction; import com.kingsrook.qbits.customizabletableviews.BaseTest; import com.kingsrook.qqq.backend.core.model.metadata.fields.QFieldMetaData; +import com.kingsrook.qqq.backend.core.model.metadata.fields.QFieldType; +import com.kingsrook.qqq.backend.core.model.metadata.fields.QVirtualFieldMetaData; import org.junit.jupiter.api.Test; import static com.kingsrook.qbits.customizabletableviews.QFieldMetaDataAssert.assertThat; import static com.kingsrook.qbits.customizabletableviews.model.FieldAccessLevel.EDITABLE_OPTIONAL; import static com.kingsrook.qbits.customizabletableviews.model.FieldAccessLevel.EDITABLE_REQUIRED; import static com.kingsrook.qbits.customizabletableviews.model.FieldAccessLevel.READ_ONLY; import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertNotNull; +import static org.junit.jupiter.api.Assertions.assertNull; /******************************************************************************* @@ -122,4 +126,31 @@ class FieldAccessLevelTest extends BaseTest assertThat(doApply.apply(READ_ONLY, hiddenField))/*....*/.isHidden().isNotRequired().isEditable(); // no changes } + + + /******************************************************************************* + ** + *******************************************************************************/ + @Test + void testValidateForVirtualField() + { + /////////////////////////////////////////////////////////////////////////////////// + // a virtual field (even if editable) should be treated as read-only by validate // + /////////////////////////////////////////////////////////////////////////////////// + QVirtualFieldMetaData editableVirtualField = new QVirtualFieldMetaData("vf", QFieldType.STRING).withIsEditable(true); + + assertNull(READ_ONLY.validateForField(editableVirtualField)); + assertNotNull(EDITABLE_REQUIRED.validateForField(editableVirtualField)); + assertNotNull(EDITABLE_OPTIONAL.validateForField(editableVirtualField)); + + ///////////////////////////////////////////////// + // a non-editable virtual field - same results // + ///////////////////////////////////////////////// + QVirtualFieldMetaData readOnlyVirtualField = new QVirtualFieldMetaData("vf", QFieldType.STRING).withIsEditable(false); + + assertNull(READ_ONLY.validateForField(readOnlyVirtualField)); + assertNotNull(EDITABLE_REQUIRED.validateForField(readOnlyVirtualField)); + assertNotNull(EDITABLE_OPTIONAL.validateForField(readOnlyVirtualField)); + } + } \ No newline at end of file diff --git a/src/test/java/com/kingsrook/qbits/customizabletableviews/tables/customizers/TableViewFieldCustomizerTest.java b/src/test/java/com/kingsrook/qbits/customizabletableviews/tables/customizers/TableViewFieldCustomizerTest.java index 65c06e8..bb0d21d 100644 --- a/src/test/java/com/kingsrook/qbits/customizabletableviews/tables/customizers/TableViewFieldCustomizerTest.java +++ b/src/test/java/com/kingsrook/qbits/customizabletableviews/tables/customizers/TableViewFieldCustomizerTest.java @@ -32,6 +32,7 @@ import com.kingsrook.qqq.backend.core.exceptions.QException; import com.kingsrook.qqq.backend.core.model.data.QRecord; import com.kingsrook.qqq.backend.core.model.metadata.fields.QFieldMetaData; import com.kingsrook.qqq.backend.core.model.metadata.fields.QFieldType; +import com.kingsrook.qqq.backend.core.model.metadata.fields.QVirtualFieldMetaData; import com.kingsrook.qqq.backend.core.model.metadata.tables.QTableMetaData; import org.junit.jupiter.api.Test; import static org.assertj.core.api.Assertions.assertThat; @@ -74,6 +75,27 @@ class TableViewFieldCustomizerTest extends BaseTest + /******************************************************************************* + ** + *******************************************************************************/ + @Test + void testVirtualField() throws QException + { + QContext.getQInstance().addTable(new QTableMetaData() + .withName("testTable2") + .withField(new QFieldMetaData("id", QFieldType.STRING)) + .withVirtualField(new QVirtualFieldMetaData("virtualField", QFieldType.STRING).withLabel("Virtual"))); + + ////////////////////////////////////////////////////////////////////////////// + // virtual fields are treated as read-only, so only READ_ONLY should pass. // + ////////////////////////////////////////////////////////////////////////////// + assertNoError(new TableViewField().withFieldName("testTable2.virtualField").withAccessLevel(FieldAccessLevel.READ_ONLY)); + assertError(new TableViewField().withFieldName("testTable2.virtualField").withAccessLevel(FieldAccessLevel.EDITABLE_REQUIRED)); + assertError(new TableViewField().withFieldName("testTable2.virtualField").withAccessLevel(FieldAccessLevel.EDITABLE_OPTIONAL)); + } + + + /*************************************************************************** * ***************************************************************************/ -- 2.54.0 From 5c97a017dc3fea5afe3f9dd56d10030dfa2e0e34 Mon Sep 17 00:00:00 2001 From: Darin Kelkhoff Date: Mon, 9 Mar 2026 11:59:59 -0500 Subject: [PATCH 19/20] fix: avoid NPE if table has no virtual fields --- .../customizabletableviews/model/CustomizableTableFieldPVS.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/main/java/com/kingsrook/qbits/customizabletableviews/model/CustomizableTableFieldPVS.java b/src/main/java/com/kingsrook/qbits/customizabletableviews/model/CustomizableTableFieldPVS.java index b5857f7..53ec048 100644 --- a/src/main/java/com/kingsrook/qbits/customizabletableviews/model/CustomizableTableFieldPVS.java +++ b/src/main/java/com/kingsrook/qbits/customizabletableviews/model/CustomizableTableFieldPVS.java @@ -97,7 +97,7 @@ public class CustomizableTableFieldPVS implements QCustomPossibleValueProvider(idString, fieldMetaData.getLabel())); } - fieldMetaData = table.getVirtualFields().get(fieldName); + fieldMetaData = table.getVirtualFields() == null ? null : table.getVirtualFields().get(fieldName); if(fieldMetaData != null) { return (new QPossibleValue<>(idString, fieldMetaData.getLabel())); -- 2.54.0 From 5323d4ed25e07117f78b93219f3081c0e4dd1336 Mon Sep 17 00:00:00 2001 From: CircleCI Date: Fri, 13 Mar 2026 14:57:53 +0000 Subject: [PATCH 20/20] Bump version to 0.4.0-RC.1 [skip ci] --- pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pom.xml b/pom.xml index 56bc553..18d62e9 100644 --- a/pom.xml +++ b/pom.xml @@ -65,7 +65,7 @@ - 0.4.0-SNAPSHOT + 0.4.0-RC.1 -- 2.54.0