Skip to content

Triggers: support managing columns for data iteration #2938

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
labkey-nicka merged 8 commits into from
Apr 17, 2026
Merged

Triggers: support managing columns for data iteration #2938

Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
136fb60
Initial test coverage
labkey-nicka Apr 6, 2026
d9bc8ba
Revise list test
labkey-nicka Apr 6, 2026
2a72aba
Expand tests
labkey-nicka Apr 6, 2026
37d410a
Review feedback, remove manageColumns flag
labkey-nicka Apr 9, 2026
3d911a7
Support disabling managed columns from a trigger
labkey-nicka Apr 9, 2026
5d9e740
TriggerScriptTest updates
labkey-nicka Apr 10, 2026
d8e8f78
EmployeeLib.js -> SharedTriggerLib.js
labkey-nicka Apr 10, 2026
36fef65
manageColumns disabled test
labkey-nicka Apr 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Review feedback, remove manageColumns flag 
- no longer process non-data iterator pathway for managed columns
  • Loading branch information
@labkey-nicka
labkey-nicka committed Apr 16, 2026
commit 37d410add9672af40dacba1ceac249f4f9c9e3a1
71 changes: 38 additions & 33 deletions src/org/labkey/test/tests/TriggerScriptTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -389,40 +389,41 @@ public void testListManagedColumnsTriggers() throws Exception
insCmd.addRow(Map.of("Name", "Managed Struct Remove", "SSN", "111222336", "Company", "Test Co"));
assertAPIErrorMessage(insCmd, MANAGED_STRUCT_REMOVE_ERROR, cn);

// TODO: Test update via DIB -- how is this invoked? Via file only?
// Setup: insert rows for update tests; include "employeeId" in payload so insert validation passes
insCmd = new InsertRowsCommand(LIST_SCHEMA, LIST_NAME);
insCmd.addRow(Map.of("Name", "MC Update Setup", "SSN", "111222340", "Company", "Setup Co", "employeeId", "OLD-ID"));
insCmd.addRow(Map.of("Name", "MC Struct Setup", "SSN", "111222341", "Company", "Setup Co", "employeeId", "OLD-ID-2"));
insCmd.addRow(Map.of("Name", "MC Struct Remove Setup", "SSN", "111222342", "Company", "Setup Co", "employeeId", "OLD-ID-3"));
resp = insCmd.execute(cn, getProjectName());
Integer updateKey = (Integer) resp.getRows().getFirst().get("Key");
Integer structKey = (Integer) resp.getRows().get(1).get("Key");
Integer structRemoveKey = (Integer) resp.getRows().get(2).get("Key");

// Update: trigger sets both declared managed columns "company" and "employeeId"
UpdateRowsCommand updCmd = new UpdateRowsCommand(LIST_SCHEMA, LIST_NAME);
updCmd.addRow(Map.of("Key", updateKey, "Name", "Managed Update", "SSN", "111222340"));
resp = updCmd.execute(cn, getProjectName());
EmployeeRecord updated = EmployeeRecord.fromMap(resp.getRows().getFirst());
Assert.assertEquals("Trigger should have set company", "Managed Co", updated.company);
Assert.assertEquals("Trigger should have set employeeId", "EMP-UPD", updated.employeeId);

// Update: declared managed column not set by trigger
// "boomerang" is absent from the payload; SSN="-123" causes the trigger to skip setting it
// Name is explicitly provided so the trigger does not accidentally match a named handler
updCmd = new UpdateRowsCommand(LIST_SCHEMA, LIST_NAME);
updCmd.addRow(Map.of("Key", updateKey, "Name", "MC Update Setup", "SSN", "-123", "Company", "Test Co"));
assertAPIErrorMessage(updCmd, "declared the managed column 'boomerang'", cn);

// Update: structural add error — trigger adds a column not declared as managed
updCmd = new UpdateRowsCommand(LIST_SCHEMA, LIST_NAME);
updCmd.addRow(Map.of("Key", structKey, "Name", "Managed Struct", "SSN", "111222341"));
assertAPIErrorMessage(updCmd, MANAGED_STRUCT_ADD_ERROR, cn);

// Update: structural remove error — trigger deletes a column not declared as managed
updCmd = new UpdateRowsCommand(LIST_SCHEMA, LIST_NAME);
updCmd.addRow(Map.of("Key", structRemoveKey, "Name", "Managed Struct Remove", "SSN", "111222342"));
assertAPIErrorMessage(updCmd, MANAGED_STRUCT_REMOVE_ERROR, cn);
// insCmd = new InsertRowsCommand(LIST_SCHEMA, LIST_NAME);
// insCmd.addRow(Map.of("Name", "MC Update Setup", "SSN", "111222340", "Company", "Setup Co", "employeeId", "OLD-ID"));
// insCmd.addRow(Map.of("Name", "MC Struct Setup", "SSN", "111222341", "Company", "Setup Co", "employeeId", "OLD-ID-2"));
// insCmd.addRow(Map.of("Name", "MC Struct Remove Setup", "SSN", "111222342", "Company", "Setup Co", "employeeId", "OLD-ID-3"));
// resp = insCmd.execute(cn, getProjectName());
// Integer updateKey = (Integer) resp.getRows().getFirst().get("Key");
// Integer structKey = (Integer) resp.getRows().get(1).get("Key");
// Integer structRemoveKey = (Integer) resp.getRows().get(2).get("Key");
//
// // Update: trigger sets both declared managed columns "company" and "employeeId"
// UpdateRowsCommand updCmd = new UpdateRowsCommand(LIST_SCHEMA, LIST_NAME);
// updCmd.addRow(Map.of("Key", updateKey, "Name", "Managed Update", "SSN", "111222340"));
// resp = updCmd.execute(cn, getProjectName());
// EmployeeRecord updated = EmployeeRecord.fromMap(resp.getRows().getFirst());
// Assert.assertEquals("Trigger should have set company", "Managed Co", updated.company);
// Assert.assertEquals("Trigger should have set employeeId", "EMP-UPD", updated.employeeId);
//
// // Update: declared managed column not set by trigger
// // "boomerang" is absent from the payload; SSN="-123" causes the trigger to skip setting it
// // Name is explicitly provided so the trigger does not accidentally match a named handler
// updCmd = new UpdateRowsCommand(LIST_SCHEMA, LIST_NAME);
// updCmd.addRow(Map.of("Key", updateKey, "Name", "MC Update Setup", "SSN", "-123", "Company", "Test Co"));
// assertAPIErrorMessage(updCmd, "declared the managed column 'boomerang'", cn);
//
// // Update: structural add error — trigger adds a column not declared as managed
// updCmd = new UpdateRowsCommand(LIST_SCHEMA, LIST_NAME);
// updCmd.addRow(Map.of("Key", structKey, "Name", "Managed Struct", "SSN", "111222341"));
// assertAPIErrorMessage(updCmd, MANAGED_STRUCT_ADD_ERROR, cn);
//
// // Update: structural remove error — trigger deletes a column not declared as managed
// updCmd = new UpdateRowsCommand(LIST_SCHEMA, LIST_NAME);
// updCmd.addRow(Map.of("Key", structRemoveKey, "Name", "Managed Struct Remove", "SSN", "111222342"));
// assertAPIErrorMessage(updCmd, MANAGED_STRUCT_REMOVE_ERROR, cn);
}

/** Issue 52098 - ensure trigger scripts have a chance to do custom type conversion with the incoming row */
Expand Down Expand Up @@ -694,6 +695,10 @@ private void doManagedColumnsTriggerTest(String schemaName, String queryName, St
"Managed Struct Remove", "MC-SR-001"));
assertAPIErrorMessage(insCmd, MANAGED_STRUCT_REMOVE_ERROR, cn);

// TODO: Test update via DIB -- how is this invoked? Via file only?
if (DATASET_NAME.equals(queryName))
return;

// Setup: insert rows for update tests with neutral Comments so the trigger fallback fires
InsertRowsCommand setupCmd = new InsertRowsCommand(schemaName, queryName);
setupCmd.addRow(makeSetupRow(keyColumnName, requiresDate, dispatchIsKey, "MC Update Setup", "MC-UPD-001"));
Expand Down