Skip to content

Consolidate Dataclass data update methods - use DIB for update only#7483

Open
XingY wants to merge 9 commits intodevelopfrom
fb_sourceDIB
Open

Consolidate Dataclass data update methods - use DIB for update only#7483
XingY wants to merge 9 commits intodevelopfrom
fb_sourceDIB

Conversation

@XingY
Copy link
Contributor

@XingY XingY commented Mar 10, 2026

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR consolidates DataClass and Sample update behavior around DataIteratorBuilder (DIB)-based updates, removing LSID as an update/merge key and cleaning up deprecated DataClass storage by dropping the provisioned lsid column via a module upgrade.

Changes:

  • Remove LSID-as-key support for sample/data update & merge; enforce RowId or Name-based keys and ignore LSID when provided alongside valid keys.
  • Introduce shared updateRowsUsingPartitionedDIB() logic in AbstractQueryUpdateService and route Sample/DataClass updates through it.
  • Remove provisioned DataClass lsid column (domain kind + upgrade code + DB scripts) and update integration tests accordingly.

Reviewed changes

Copilot reviewed 15 out of 15 changed files in this pull request and generated 7 comments.

Show a summary per file
File Description
experiment/src/org/labkey/experiment/samples/AbstractExpFolderImporter.java Stops setting the removed UseLsidForUpdate option during TSV import.
experiment/src/org/labkey/experiment/api/SampleTypeUpdateServiceDI.java Routes updates through partitioned DIB; removes LSID-key paths and legacy update methods.
experiment/src/org/labkey/experiment/api/ExpDataImpl.java Selects DataClass provisioned properties by RowId (not LSID) to support dropped provisioned LSID column.
experiment/src/org/labkey/experiment/api/ExpDataClassDataTableImpl.java Enforces RowId/Name keys, blocks LSID-only keying, blocks RowId in merge (behind feature), and uses partitioned DIB updates.
experiment/src/org/labkey/experiment/api/DataClassDomainKind.java Removes lsid from provisioned DataClass base properties, indexes, and FKs.
experiment/src/org/labkey/experiment/ExperimentUpgradeCode.java Adds deferred upgrade to drop provisioned DataClass lsid column (and related indices).
experiment/src/org/labkey/experiment/ExperimentModule.java Bumps schema version to 26.005 and centralizes experimental flag constant usage.
experiment/src/org/labkey/experiment/ExpDataIterators.java Updates derivation/update logic to use RowId/Name instead of LSID-for-update config; removes LSID update config usage.
experiment/src/client/test/integration/DataClassCrud.ispec.ts Expands integration coverage for keying behavior (RowId/Name/LSID) and partitioned-duplicate detection.
experiment/resources/schemas/dbscripts/sqlserver/exp-26.004-26.005.sql Executes Java upgrade to drop provisioned DataClass lsid column (SQL Server).
experiment/resources/schemas/dbscripts/postgresql/exp-26.004-26.005.sql Executes Java upgrade to drop provisioned DataClass lsid column (PostgreSQL).
api/src/org/labkey/api/query/DefaultQueryUpdateService.java Removes conversion-table hook and always uses getDbTable() for convertTypes() entrypoint.
api/src/org/labkey/api/query/AbstractQueryUpdateService.java Adds updateRowsUsingPartitionedDIB() and small null-iterator safety in _pump().
api/src/org/labkey/api/exp/query/ExpDataTable.java Reorders enum constants (no functional behavior change expected).
api/src/org/labkey/api/exp/api/ExperimentService.java Removes UseLsidForUpdate query option; adds shared experimental feature constant.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines +1085 to +1087
// using update from file, verify update using rowId for data that doesn't exist on this datacalss should fail.
errorResp = await ExperimentCRUDUtils.importData(server, "RowId\tDescription\n" + row3RowId + "\tupdate\n", emptyDataClass, "UPDATE", topFolderOptions, editorUserOptions);
expect(errorResp.text).toContain('Data not found for [' + row3RowId + ']');
Copy link

Copilot AI Mar 10, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo in comment: "datacalss" should be "dataclass".

Copilot uses AI. Check for mistakes.
Comment on lines +465 to +466
// update date twice specifying the rowId across multiple partitions
await server.post('query', 'updateRows', {
Copy link

Copilot AI Mar 10, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo in comment: "update date" should be "update data".

Copilot uses AI. Check for mistakes.
Comment on lines +286 to 287
OptionalFeatureService.get().addExperimentalFeatureFlag(ExperimentService.EXPERIMENTAL_FEATURE_ALLOW_ROW_ID_MERGE, "Allow RowId to be accepted when merging samples or dataclass data",
"If the incoming data includes a RowId column we will allow the column but ignore it's values.", false);
Copy link

Copilot AI Mar 10, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Grammar in this feature description: "ignore it's values" should be "ignore its values".

Copilot uses AI. Check for mistakes.
di = new SampleUpdateDerivationDataIterator(di, context, _container, _user, _currentDataType, _checkRequiredParents);
else
di = new DataUpdateDerivationDataIterator(di, context, _container, _user, _currentDataType, _checkRequiredParents);
di = new DataUpdateDerivationDataIterator(di, context, _container, _user, _currentDataType, _checkRequiredParents);//
Copy link

Copilot AI Mar 10, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove the trailing "//" at the end of this line; it looks like leftover debugging text and adds noise to the code.

Copilot uses AI. Check for mistakes.
if (hasNext)
{
String lsid = (String) get(_lsidCol);
String lsid = (String) get(_lsidCol); // why lsid?, insert or merge
Copy link

Copilot AI Mar 10, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please remove the inline comment "// why lsid?, insert or merge". It reads like a note-to-self and doesn't clarify behavior for future readers.

Copilot uses AI. Check for mistakes.
Comment on lines 1299 to +1300
for (Map<String, Object> dataRow : dataRows.values())
lsids.add((String) dataRow.get("lsid"));
lsids.add((String) dataRow.get("lsid")); // ?
Copy link

Copilot AI Mar 10, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove the "// ?" comment here. If there's an open question about whether LSIDs are always present in these rows, it should be resolved in code (e.g., null-check + clear error) rather than left as an inline question.

Copilot uses AI. Check for mistakes.
Comment on lines +446 to 447
// update date twice specifying the name across multiple partitions
await server.post('query', 'updateRows', {
Copy link

Copilot AI Mar 10, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo in comment: "update date" should be "update data".

Copilot uses AI. Check for mistakes.
@labkey-adam
Copy link
Contributor

@XingY there's an exp-26.004-26.005.sql script in 26.3 that should be merged to develop shortly.

@XingY
Copy link
Contributor Author

XingY commented Mar 10, 2026

@XingY there's an exp-26.004-26.005.sql script in 26.3 that should be merged to develop shortly.

OK. Thanks for the heads-up.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants