Add support for sample creation actions in workflow jobs (#1951)

labkey-susanh · web-flow · commit 2d7773061529 · 2026-03-25T17:53:34.000-07:00
diff --git a/packages/components/package-lock.json b/packages/components/package-lock.json
diff --git a/packages/components/package.json b/packages/components/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@labkey/components",
-  "version": "7.24.2",
+  "version": "7.25.0",
   "description": "Components, models, actions, and utility functions for LabKey applications and pages",
   "sideEffects": false,
   "files": [
diff --git a/packages/components/releaseNotes/components.md b/packages/components/releaseNotes/components.md
@@ -1,6 +1,13 @@
 # @labkey/components
 Components, models, actions, and utility functions for LabKey applications and pages
 
+### version 7.25.0
+*Released*: 25 March 2026
+- Update `isAllSamplesSchema` to account for move of `JobInputSamples` to `workflow` schema
+- Add placement prop for `DisableableButton`
+- add `fitlerArrayToString` method in QueryModel utils
+- add `pronoun` utility method for the it/they or it/them text choices
+
 ### version 7.24.2
 *Released*: 25 March 2026
 - GitHub Issue 955: limit text choice option length to 200 characters
diff --git a/packages/components/src/index.ts b/packages/components/src/index.ts
@@ -69,6 +69,7 @@ import {
     makeCommaSeparatedString,
     parseCsvString,
     parseScientificInt,
+    pronoun,
     quoteValueWithDelimiters,
     setIsTestEnv,
     uncapitalizeFirstChar,
@@ -541,6 +542,7 @@ import {
     createOrderedSnapshotSelectionKey,
     createSnapshotSelectionKey,
     createSnapshotSelectionKeyStr,
+    filterArrayToString,
     runDetailsColumnsForQueryModel,
 } from './public/QueryModel/utils';
 import { CONFIRM_MESSAGE, useRouteLeave } from './internal/util/RouteLeave';
@@ -1300,6 +1302,7 @@ export {
     FileInput,
     FileTree,
     FilterAction,
+    filterArrayToString,
     FilterCriteriaRenderer,
     FilterStatus,
     FIND_BY_IDS_QUERY_PARAM,
@@ -1594,6 +1597,7 @@ export {
     ProductMenuModel,
     ProductNavigationMenu,
     Progress,
+    pronoun,
     pushParameters,
     QUERY_UPDATE_AUDIT_QUERY,
     QueryColumn,
diff --git a/packages/components/src/internal/app/constants.ts b/packages/components/src/internal/app/constants.ts
@@ -198,6 +198,6 @@ export const FREEZER_MANAGER_APP_PROPERTIES: AppProperties = {
 export const APPLICATION_PROPERTIES = {
     [FREEZER_MANAGER_PRODUCT_ID]: FREEZER_MANAGER_APP_PROPERTIES,
     [SAMPLE_MANAGER_PRODUCT_ID]: SAMPLE_MANAGER_APP_PROPERTIES,
-    [LIMS_PRODUCT_ID] : LIMS_APP_PROPERTIES,
+    [LIMS_PRODUCT_ID]: LIMS_APP_PROPERTIES,
     [BIOLOGICS_PRODUCT_ID]: BIOLOGICS_APP_PROPERTIES
-}
+};
diff --git a/packages/components/src/internal/components/buttons/DisableableButton.tsx b/packages/components/src/internal/components/buttons/DisableableButton.tsx
@@ -1,4 +1,4 @@
-import React, { memo, FC, useMemo, PropsWithChildren } from 'react';
+import React, { FC, memo, PropsWithChildren, useMemo } from 'react';
 
 import { createPortal } from 'react-dom';
 
@@ -10,23 +10,24 @@ interface Props extends PropsWithChildren {
     className?: string;
     disabledMsg?: string;
     onClick?: () => void;
+    placement?: 'bottom' | 'left' | 'right' | 'top';
     title?: string;
 }
 
 export const DisableableButton: FC<Props> = memo(props => {
-    const { bsStyle = 'default', children, className = '', disabledMsg, onClick, title } = props;
+    const { bsStyle = 'default', children, className = '', disabledMsg, onClick, placement = 'bottom', title } = props;
     const { onMouseEnter, onMouseLeave, portalEl, show, targetRef } = useOverlayTriggerState<HTMLButtonElement>(
         'disabled-button-overlay',
         disabledMsg !== undefined,
         false
     );
     const popover = useMemo(
         () => (
-            <Popover id="disabled-button-popover" title={title} placement="bottom" targetRef={targetRef}>
+            <Popover id="disabled-button-popover" placement={placement} targetRef={targetRef} title={title}>
                 {disabledMsg}
             </Popover>
         ),
-        [disabledMsg, targetRef, title]
+        [disabledMsg, placement, targetRef, title]
     );
 
     // Note: we use onPointerEnter/Leave so events propagate when the button is disabled
@@ -37,8 +38,8 @@ export const DisableableButton: FC<Props> = memo(props => {
             onClick={onClick}
             onPointerEnter={onMouseEnter}
             onPointerLeave={onMouseLeave}
-            type="button"
             ref={targetRef}
+            type="button"
         >
             {children}
             {show && createPortal(popover, portalEl)}
diff --git a/packages/components/src/internal/components/entities/EntityMoveConfirmationModal.test.tsx b/packages/components/src/internal/components/entities/EntityMoveConfirmationModal.test.tsx
@@ -44,7 +44,7 @@ describe('EntityMoveConfirmationModal', () => {
         expect(document.body.textContent).toContain('This is an error message.');
     });
 
-    test('no insert perm to any conatiners', async () => {
+    test('no insert perm to any containers', async () => {
         await act(async () => {
             renderWithAppContext(<EntityMoveConfirmationModal {...getDefaultProps()} />, {
                 serverContext: DEFAULT_SERVER_CONTEXT,
diff --git a/packages/components/src/internal/components/entities/EntityMoveModal.tsx b/packages/components/src/internal/components/entities/EntityMoveModal.tsx
@@ -6,7 +6,7 @@ import { LoadingSpinner } from '../base/LoadingSpinner';
 import { Alert } from '../base/Alert';
 import { Container } from '../base/models/Container';
 import { useNotificationsContext } from '../notifications/NotificationsContext';
-import { capitalizeFirstChar, makeCommaSeparatedString } from '../../util/utils';
+import { capitalizeFirstChar, makeCommaSeparatedString, pronoun } from '../../util/utils';
 import { HelpLink, MOVE_SAMPLES_TOPIC } from '../../util/helpLinks';
 import { isLoading, LoadingState } from '../../../public/LoadingState';
 import { AppURL } from '../../url/AppURL';
@@ -241,12 +241,12 @@ export const getMoveConfirmationProperties = (
         text = `${text} ${noun} will be moved.`;
     } else {
         const cannotMoveNoun = numCannotMove === 1 ? nounSingular : nounPlural;
-        const pronoun = numCannotMove === 1 ? 'it' : 'they';
+        const _pronoun = pronoun(numCannotMove, 'they');
         const verb = numCannotMove === 1 ? 'has' : 'have';
         const parts = [];
         if (numNotPermitted > 0) parts.push('you lack the proper permissions');
-        if (numNotAllowed > 0) parts.push(`${pronoun} ${verb} a status or related data that prevents moving`);
-        if (numMissing > 0) parts.push(`${pronoun} may have been deleted`);
+        if (numNotAllowed > 0) parts.push(`${_pronoun} ${verb} a status or related data that prevents moving`);
+        if (numMissing > 0) parts.push(`${_pronoun} may have been deleted`);
         const error = makeCommaSeparatedString(parts, ', or ', '.');
 
         if (numCanMove === 0) {
diff --git a/packages/components/src/internal/components/entities/actions.ts b/packages/components/src/internal/components/entities/actions.ts
@@ -15,7 +15,7 @@ import { getSelected, getSelectedDataDeprecated } from '../../actions';
 
 import { SampleOperation } from '../samples/constants';
 import { SchemaQuery } from '../../../public/SchemaQuery';
-import { getFilterForSampleOperation, isSamplesSchema } from '../samples/utils';
+import { getFilterForSampleOperation, isSamplesSchema, isWorkflowInputSamplesSchema } from '../samples/utils';
 import { getQueryDetails, getRequestAuditDetail, importData, InsertOptions, selectDistinctRows } from '../../query/api';
 import { caseInsensitive, generateId } from '../../util/utils';
 import { request } from '../../request';
@@ -326,6 +326,7 @@ function resolveSampleParentTypes(
  * @param creationType
  * @param isItemSamples
  * @param targetQueryName
+ * @param jobId
  */
 async function initParents(
     initialParents: string[],
@@ -334,7 +335,8 @@ async function initParents(
     isSnapshotSelection: boolean,
     creationType?: EntityCreationType,
     isItemSamples?: boolean,
-    targetQueryName?: string
+    targetQueryName?: string,
+    jobId?: string,
 ): Promise<List<EntityParentType>> {
     const isAliquotParent = creationType === EntityCreationType.Aliquots;
 
@@ -354,6 +356,9 @@ async function initParents(
             Filter.create('RowId', selectionResponse.selected, Filter.Types.IN),
             Filter.create('Container', insertPermissionContainers, Filter.Types.IN),
         ];
+        if (isWorkflowInputSamplesSchema(schemaQuery) && jobId) {
+            filterArray.push(Filter.create('JobId', jobId, Filter.Types.EQUAL));
+        }
         const opFilter = getFilterForSampleOperation(SampleOperation.EditLineage);
         if (opFilter) {
             filterArray.push(opFilter);
@@ -489,7 +494,8 @@ export async function getChosenParentData(
             isSnapshotSelection,
             creationType,
             isItemSamples,
-            targetQueryName
+            targetQueryName,
+            model.jobId
         );
 
         // if we have an initial parent, we want to start with a row in the grid (entityCount = 1) otherwise we start with none
@@ -620,7 +626,6 @@ export async function getFolderConfigurableEntityTypeOptions(
  * @param targetQueryName the name of the listing schema query that represents the initial target for creation.
  * @param allowParents are parents of this entity type allowed or not
  * @param isItemSamples use the selectionKey from inventory.items table to query sample parents
- * @param combineParentTypes
  */
 export function getEntityTypeData(
     model: EntityIdCreationModel,
diff --git a/packages/components/src/internal/components/entities/models.ts b/packages/components/src/internal/components/entities/models.ts
@@ -193,6 +193,7 @@ export class EntityIdCreationModel extends Record({
     initialEntityType: undefined,
     isError: false,
     isInit: false,
+    jobId: undefined,
     originalParents: Array<string>(),
     parentOptions: Map<string, List<IParentOption>>(),
     entityParents: Map<string, List<EntityParentType>>(),
@@ -211,6 +212,7 @@ export class EntityIdCreationModel extends Record({
     declare initialEntityType: any;
     declare isError: boolean;
     declare isInit: boolean;
+    declare jobId: string;
     declare originalParents: string[]; // taken from the query string
     declare parentOptions: Map<string, List<IParentOption>>; // map from query name to the options for the different types of parents allowed
     declare entityParents: Map<string, List<EntityParentType>>; // map from query name to the parents already selected for that query
diff --git a/packages/components/src/internal/components/forms/BulkUpdateForm.tsx b/packages/components/src/internal/components/forms/BulkUpdateForm.tsx
@@ -15,6 +15,7 @@ import {
     getCommonDataValues,
     getUpdatedData,
     makeCommaSeparatedString,
+    pronoun,
 } from '../../util/utils';
 
 import { ComponentsAPIWrapper } from '../../APIWrapper';
@@ -66,8 +67,7 @@ export const SelectionWarning: FC<SelectionWarningProps> = props => {
     }
 
     if (missingCount > 0) {
-        const pronoun = missingCount > 1 ? 'they' : 'it';
-        messages.push(`Cannot edit ${missingCount} of the selected ${nounPlural}, ${pronoun} may have been deleted.`);
+        messages.push(`Cannot edit ${missingCount} of the selected ${nounPlural}, ${pronoun(missingCount, 'they')} may have been deleted.`);
     }
 
     if (messages.length === 0) return null;
@@ -102,12 +102,11 @@ export function errorMessage(
     if (missingCount + notPermittedCount !== selectedCount) return undefined;
 
     const noun = selectedCount > 1 ? nounPlural : nounSingular;
-    const pronoun = selectedCount > 1 ? 'they' : 'it';
     const parts = [];
 
     if (notPermittedCount > 0) parts.push(`you do not have the required permissions`);
 
-    if (missingCount > 0) parts.push(`${pronoun} may have been deleted`);
+    if (missingCount > 0) parts.push(`${pronoun(selectedCount, 'they')} may have been deleted`);
 
     return `Cannot edit selected ${noun}, ${makeCommaSeparatedString(parts, ', or ', '.')}`;
 }
diff --git a/packages/components/src/internal/components/samples/utils.tsx b/packages/components/src/internal/components/samples/utils.tsx
@@ -260,6 +260,15 @@ export function isSamplesSchema(schemaQuery: SchemaQuery): boolean {
     return isAllSamplesSchema(schemaQuery);
 }
 
+export function isWorkflowInputSamplesSchema(schemaQuery: SchemaQuery): boolean {
+    const lcSchemaName = schemaQuery?.schemaName?.toLowerCase();
+    const lcQueryName = schemaQuery?.queryName?.toLowerCase();
+    return (
+        lcSchemaName === SCHEMAS.WORKFLOW.SCHEMA &&
+        lcQueryName === SCHEMAS.WORKFLOW.JOB_INPUT_SAMPLES.queryName.toLowerCase()
+    );
+}
+
 export function isAllSamplesSchema(schemaQuery: SchemaQuery): boolean {
     const lcSchemaName = schemaQuery?.schemaName?.toLowerCase();
     const lcQueryName = schemaQuery?.queryName?.toLowerCase();
@@ -276,15 +285,12 @@ export function isAllSamplesSchema(schemaQuery: SchemaQuery): boolean {
         return true;
 
     if (lcSchemaName === SCHEMAS.SAMPLE_MANAGEMENT.SCHEMA) {
-        return (
-            lcQueryName === SCHEMAS.SAMPLE_MANAGEMENT.SOURCE_SAMPLES.queryName.toLowerCase() ||
-            lcQueryName === SCHEMAS.WORKFLOW.JOB_INPUT_SAMPLES.queryName.toLowerCase()
-        );
+        return lcQueryName === SCHEMAS.SAMPLE_MANAGEMENT.SOURCE_SAMPLES.queryName.toLowerCase();
     }
-
-    return false;
+    return isWorkflowInputSamplesSchema(schemaQuery);
 }
 
+
 export function getSampleDomainDefaultSystemFields(moduleContext?: ModuleContext): SystemField[] {
     return isFreezerManagementEnabled(moduleContext)
         ? SAMPLE_DOMAIN_DEFAULT_SYSTEM_FIELDS.concat(SAMPLE_DOMAIN_INVENTORY_SYSTEM_FIELDS)
diff --git a/packages/components/src/internal/util/utils.test.ts b/packages/components/src/internal/util/utils.test.ts
@@ -50,6 +50,7 @@ import {
     makeCommaSeparatedString,
     parseCsvString,
     parseScientificInt,
+    pronoun,
     quoteValueWithDelimiters,
     styleStringToObj,
     toLowerSafe,
@@ -58,24 +59,22 @@ import {
     withTransformedKeys,
 } from './utils';
 
-const emptyList = List<string>();
-
 describe('toLowerSafe', () => {
     test('strings', () => {
-        expect(toLowerSafe(List<string>(['TEST ', ' Test', 'TeSt', 'test']))).toEqual(
-            List<string>(['test ', ' test', 'test', 'test'])
+        expect(toLowerSafe(['TEST ', ' Test', 'TeSt', 'test'])).toEqual(
+            ['test ', ' test', 'test', 'test']
         );
     });
 
     test('numbers', () => {
-        expect(toLowerSafe(List<string>([1, 2, 3]))).toEqual(emptyList);
-        expect(toLowerSafe(List<string>([1.0]))).toEqual(emptyList);
-        expect(toLowerSafe(List<string>([1.0, 2]))).toEqual(emptyList);
+        expect(toLowerSafe([1, 2, 3])).toEqual([]);
+        expect(toLowerSafe([1.0])).toEqual([]);
+        expect(toLowerSafe([1.0, 2])).toEqual([]);
     });
 
     test('strings and numbers', () => {
-        expect(toLowerSafe(List<string>([1, 2, 'TEST ', ' Test', 3.0, 4.4, 'TeSt', 'test']))).toEqual(
-            List<string>(['test ', ' test', 'test', 'test'])
+        expect(toLowerSafe([1, 2, 'TEST ', ' Test', 3.0, 4.4, 'TeSt', 'test'])).toEqual(
+           ['test ', ' test', 'test', 'test']
         );
     });
 });
@@ -96,6 +95,18 @@ describe('camelCaseToTitleCase', () => {
     });
 });
 
+describe('pronoun', () => {
+    test('singular', () => {
+        expect(pronoun(1)).toBe('it');
+        expect(pronoun(1, 'some')).toBe('it');
+    });
+    test('plural', () => {
+        expect(pronoun(2)).toBe('them');
+        expect(pronoun(2, 'some')).toBe('some');
+        expect(pronoun(undefined)).toBe('them');
+    });
+});
+
 describe('capitalizeFirstChar', () => {
     test('capitalizeFirstChar', () => {
         const testStrings = {
diff --git a/packages/components/src/internal/util/utils.ts b/packages/components/src/internal/util/utils.ts
@@ -90,7 +90,7 @@ export function withTransformedKeys(obj: Record<string, any>, keyTransformFn: (v
 }
 
 /**
- * Returns a copy of List<string> and ensures that in copy all values are lower case strings.
+ * Returns a copy of string[] and ensures that in copy all values are lower case strings.
  * @param a
  */
 export function toLowerSafe(a: string[]): string[] {
@@ -107,6 +107,10 @@ export function camelCaseToTitleCase(text: string): string {
     return saferText.charAt(0).toUpperCase() + saferText.slice(1);
 }
 
+export function pronoun(count, plural = 'them'): string {
+    return count === 1 ? 'it' : plural;
+}
+
 export function not(predicate: (...args: any[]) => boolean): (...args: any[]) => boolean {
     return function () {
         return !predicate.apply(this, arguments);
diff --git a/packages/components/src/public/QueryModel/utils.ts b/packages/components/src/public/QueryModel/utils.ts
@@ -40,6 +40,13 @@ export function filterArraysEqual(a: Filter.IFilter[], b: Filter.IFilter[]): boo
     return aStr === bStr;
 }
 
+export function filterArrayToString(filterArray: Filter.IFilter[]): string {
+    if (!filterArray) {
+        return '';
+    }
+    return filterArray.map(filterToString).sort().join(';');
+}
+
 export function sortsEqual(a: QuerySort, b: QuerySort): boolean {
     return a.toRequestString() === b.toRequestString();
 }

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@labkey/components",`
`3`		`- "version": "7.24.2",`
	`3`	`+ "version": "7.25.0",`
`4`	`4`	`"description": "Components, models, actions, and utility functions for LabKey applications and pages",`
`5`	`5`	`"sideEffects": false,`
`6`	`6`	`"files": [`