Add auditing of what method was used for data imports, updates, deletes (#1874)

Author: XingY

packages/components/package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@labkey/components",
-  "version": "6.67.3",
+  "version": "6.68.0",
   "description": "Components, models, actions, and utility functions for LabKey applications and pages",
   "sideEffects": false,
   "files": [
@@ -50,7 +50,7 @@
   "homepage": "https://github.com/LabKey/labkey-ui-components#readme",
   "dependencies": {
     "@hello-pangea/dnd": "18.0.1",
-    "@labkey/api": "1.43.1",
+    "@labkey/api": "1.43.2",
     "@testing-library/dom": "~10.4.0",
     "@testing-library/jest-dom": "~6.6.3",
     "@testing-library/react": "~16.3.0",

packages/components/package.json

@@ -1,12 +1,17 @@
 # @labkey/components
 Components, models, actions, and utility functions for LabKey applications and pages
 
+### version 6.68.0
+*Released* 2 November 2025
+- Add auditing of what method was used for CRUD
+  - Modified api.query.insertRows/updateRows/deleteRows/saveRows and moveEntities to accept and process editMethod parameter and record request hash in 'requestSource`
+
 ### version 6.67.3
 *Released*: 1 November 2025
 - Issue 54160: Non US date parsing in the app
-    - Added `getAltNonUSParseFormats` date utility function to provide alternative parse formats for common non-US date/datetime formats
-    - Update DatePickerInput to use alternative parse formats when server date format is non-US
-    - Update parseDate utility function to use alternative non-US parse formats
+  - Added `getAltNonUSParseFormats` date utility function to provide alternative parse formats for common non-US date/datetime formats
+  - Update DatePickerInput to use alternative parse formats when server date format is non-US
+  - Update parseDate utility function to use alternative non-US parse formats
 
 ### version 6.67.2
 *Released* 31 October 2025

packages/components/releaseNotes/components.md

@@ -51,6 +51,7 @@ import {
     applyDevTools,
     arrayEquals,
     blurActiveElement,
+    camelCaseToTitleCase,
     capitalizeFirstChar,
     caseInsensitive,
     debounce,
@@ -218,6 +219,7 @@ import {
     getContainerFilterForFolder,
     getContainerFilterForLookups,
     getQueryDetails,
+    getRequestAuditDetail,
     getVerbForInsertOption,
     importData,
     InsertFormats,
@@ -228,6 +230,7 @@ import {
     loadQueries,
     loadQueriesFromTable,
     QueryCommandResponse,
+    saveRows,
     selectDistinctRows,
     selectRowsDeprecated,
     updateRows,
@@ -252,6 +255,7 @@ import { flattenBrowseDataTreeResponse, loadReports } from './internal/query/rep
 import {
     AssayUploadTabs,
     DataViewInfoTypes,
+    EDIT_METHOD,
     EXPORT_TYPES,
     GRID_CHECKBOX_OPTIONS,
     IMPORT_DATA_FORM_TYPES,
@@ -1189,6 +1193,7 @@ export {
     BreadcrumbCreate,
     buildURL,
     BulkUpdateForm,
+    camelCaseToTitleCase,
     cancelEvent,
     capitalizeFirstChar,
     Cards,
@@ -1282,6 +1287,7 @@ export {
     DropdownButton,
     DropdownMenu,
     DropdownSection,
+    EDIT_METHOD,
     EditableDetailPanel,
     EditableGrid,
     EditableGridEvent,
@@ -1420,6 +1426,7 @@ export {
     getQueryFormLabelFieldName,
     getQueryModelExportParams,
     getQueryParams,
+    getRequestAuditDetail,
     getRolesByUniqueName,
     getSampleDomainDefaultSystemFields,
     getSampleFinderLocalStorageKey,
@@ -1701,6 +1708,7 @@ export {
     SampleTypeModel,
     saveDomain,
     SavedSettings,
+    saveRows,
     SchemaDetails,
     SchemaQuery,
     SCHEMAS,

packages/components/src/index.ts

@@ -22,6 +22,8 @@ import { handleRequestFailure } from '../../request';
 import { AssayProtocolModel } from '../domainproperties/assay/models';
 
 import { AssayUploadResultModel } from './models';
+import { getRequestAuditDetail } from '../../query/api';
+import { EDIT_METHOD } from '../../constants';
 
 let assayDefinitionCache: { [key: string]: Promise<AssayDefinitionModel[]> } = {};
 let protocolCache: Record<string, Promise<AssayProtocolModel>> = {};
@@ -94,12 +96,16 @@ export function getProtocol(options: GetProtocolOptions): Promise<AssayProtocolM
     return protocolCache[key];
 }
 
-export type ImportAssayRunOptions = Omit<AssayDOM.ImportRunOptions, 'success' | 'failure' | 'scope'>;
+export interface ImportAssayRunOptions extends Omit<AssayDOM.ImportRunOptions, 'success' | 'failure' | 'scope'> {
+    editMethod?: EDIT_METHOD;
+}
 
 export function importAssayRun(config: ImportAssayRunOptions): Promise<AssayUploadResultModel> {
     return new Promise((resolve, reject) => {
+        const { editMethod, ...importConfig } = config;
+        importConfig['auditDetails'] = getRequestAuditDetail(editMethod);
         AssayDOM.importRun({
-            ...config,
+            ...importConfig,
             success: rawModel => {
                 resolve(new AssayUploadResultModel(rawModel));
             },

packages/components/src/internal/components/assay/actions.ts

@@ -6,7 +6,7 @@ import { getSelected, getSelectedDataDeprecated } from '../../actions';
 import { SampleOperation } from '../samples/constants';
 import { SchemaQuery } from '../../../public/SchemaQuery';
 import { getFilterForSampleOperation, isSamplesSchema } from '../samples/utils';
-import { importData, InsertOptions } from '../../query/api';
+import { getRequestAuditDetail, importData, InsertOptions } from '../../query/api';
 import { caseInsensitive, generateId } from '../../util/utils';
 import { request } from '../../request';
 import { EntityCreationType } from '../samples/models';
@@ -982,6 +982,7 @@ export function moveEntities(options: MoveEntitiesOptions): Promise<Query.MoveRo
 
         Query.moveRows({
             ...params,
+            auditDetails: getRequestAuditDetail(),
             success: (response: Query.MoveRowsResponse) => {
                 if (response.success) {
                     resolve(response);

packages/components/src/internal/components/entities/actions.ts

@@ -35,6 +35,7 @@ import { SCHEMAS } from '../../schemas';
 
 import {
     getQueryDetails,
+    getRequestAuditDetail,
     invalidateFullQueryDetailsCache,
     ISelectRowsResult,
     selectDistinctRows,
@@ -53,6 +54,7 @@ import { QueryInfo } from '../../../public/QueryInfo';
 import { ALL_AMOUNT_AND_UNITS_COLUMNS_LC, SAMPLE_STORAGE_COLUMNS_LC, STORED_AMOUNT_FIELDS } from './constants';
 import { FindField, GroupedSampleFields, SampleState, SampleStateType } from './models';
 import { executeSql, ExecuteSqlResponseWithSession } from '../../query/executeSql';
+import { EDIT_METHOD } from '../../constants';
 
 export async function getSampleSet(config: IEntityTypeDetails): Promise<any> {
     const response = await request({
@@ -556,7 +558,8 @@ export function updateSampleStorageData(
     sampleStorageData: SampleStorageData[],
     containerPath?: string,
     userComment?: string,
-    isDiscard = false
+    isDiscard = false,
+    editMethod?: EDIT_METHOD
 ): Promise<any> {
     if (sampleStorageData.length === 0) {
         return Promise.resolve();
@@ -568,6 +571,7 @@ export function updateSampleStorageData(
             jsonData: {
                 sampleRows: sampleStorageData,
                 [STORED_AMOUNT_FIELDS.AUDIT_COMMENT]: userComment,
+                ...getRequestAuditDetail(editMethod),
                 isDiscard,
             },
             success: Utils.getCallbackWrapper(response => {

packages/components/src/internal/components/samples/actions.ts

@@ -34,8 +34,8 @@ export const MAX_EDITABLE_GRID_ROWS = MAX_SELECTION_ACTION_ROWS;
 export const LOOKUP_DEFAULT_SIZE = 25;
 
 export enum AssayUploadTabs {
-    Grid = 1,
     Files = 2,
+    Grid = 1,
 }
 
 export enum EXPORT_TYPES {
@@ -49,6 +49,17 @@ export enum EXPORT_TYPES {
     LABEL_TEMPLATE,
 }
 
+export enum EDIT_METHOD {
+    BULK_EDIT = 'BulkEdit',
+    BULK_EDIT_LINEAGE = 'BulkEditLineage',
+    DETAIL_EDIT = 'DetailEdit',
+    DETAIL_EDIT_LINEAGE = 'DetailEditLineage',
+    FORM_INSERT = 'FormInsert',
+    GRID_EDIT = 'GridEdit',
+    GRID_INSERT = 'GridInsert',
+    STORAGE_VIEW_ACTION = 'StorageViewAction',
+}
+
 export enum KEYS {
     Backspace = 8,
     Tab = 9,

packages/components/src/internal/constants.ts

@@ -55,6 +55,7 @@ import {
     insertRows,
     InsertRowsOptions,
     QueryCommandResponse,
+    saveRows,
     saveRowsByContainer,
     SaveRowsOptions,
     SelectDistinctOptions,
@@ -65,6 +66,7 @@ import {
 } from './api';
 import { executeSql, ExecuteSqlOptions, ExecuteSqlResponse } from './executeSql';
 import { selectRows, SelectRowsOptions, SelectRowsResponse } from './selectRows';
+import { EDIT_METHOD } from '../constants';
 
 export interface QueryAPIWrapper {
     clearSelected: (options: ClearSelectedOptions) => Promise<SelectResponse>;
@@ -125,6 +127,7 @@ export interface QueryAPIWrapper {
         inherit: boolean,
         shared: boolean
     ) => Promise<void>;
+    saveRows: (options: SaveRowsOptions) => Promise<Query.SaveRowsResponse>;
     saveRowsByContainer: (options: SaveRowsOptions, containerField?: string) => Promise<Query.SaveRowsResponse>;
     saveSessionView: (
         schemaQuery: SchemaQuery,
@@ -159,6 +162,7 @@ export interface QueryAPIWrapper {
         rows: any[],
         containerPaths: string[],
         auditUserComment: string,
+        editMethod?: EDIT_METHOD,
         containerField?: string
     ) => Promise<Query.SaveRowsResponse | QueryCommandResponse>;
 }
@@ -182,6 +186,7 @@ export class QueryServerAPIWrapper implements QueryAPIWrapper {
     incrementClientSideMetricCount = incrementClientSideMetricCount;
     incrementRowCountMetric = incrementRowCountMetric;
     insertRows = insertRows;
+    saveRows = saveRows;
     renameGridView = renameGridView;
     replaceSelected = replaceSelected;
     saveGridView = saveGridView;
@@ -225,6 +230,7 @@ export function getQueryTestAPIWrapper(
         renameGridView: mockFn(),
         replaceSelected: mockFn(),
         saveGridView: mockFn(),
+        saveRows: mockFn(),
         saveRowsByContainer: mockFn(),
         saveSessionView: mockFn(),
         selectRows: mockFn(),