Item 10437: Aliquot Field Inheritance

packages/components/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@labkey/components",
-  "version": "2.195.1",
+  "version": "2.196.0",
   "description": "Components, models, actions, and utility functions for LabKey applications and pages",
   "main": "dist/components.js",
   "module": "dist/components.js",

packages/components/releaseNotes/components.md

@@ -1,6 +1,11 @@
 # @labkey/components
 Components, models, actions, and utility functions for LabKey applications and pages.
 
+### version 2.196.0
+*Released*: 7 July 2022
+* Item 10437: Aliquot Field Inheritance
+    * Update DerivationDataScopeFieldOptions, SampleTypeDesigner, EntityInsertPanel and SamplesBulkUpdateForm to support aliquot & sample options
+
 ### version 2.195.1
 *Released*: 7 July 2022
 * Issue 44599: Field editor PHI Level doesn't show correct value for a field if the admin user does not have that level of PHI access

packages/components/src/internal/components/domainproperties/DerivationDataScopeFieldOptions.spec.tsx

@@ -1,65 +1,258 @@
 import { mount } from 'enzyme';
-import React, { ReactNode } from 'react';
+import React from 'react';
 
-import { createFormInputId } from './actions';
-import { DOMAIN_FIELD_DERIVATION_DATA_SCOPE, DOMAIN_FIELD_NOT_LOCKED } from './constants';
+import { Radio } from 'react-bootstrap';
+
+import { Alert } from '../base/Alert';
+
+import { DERIVATION_DATA_SCOPES, DOMAIN_FIELD_NOT_LOCKED } from './constants';
 import { DerivationDataScopeFieldOptions } from './DerivationDataScopeFieldOptions';
+import { PropDescType, TEXT_TYPE, UNIQUE_ID_TYPE } from './PropDescType';
 
 describe('DerivationDataScopeFieldOptions', () => {
-    test('Derivation Data Scope Field Options', () => {
-        const label = 'Aliquot properties';
+    test('Default config, new field', () => {
+        const props = {
+            index: 1,
+            domainIndex: 1,
+            label: null,
+            onChange: jest.fn(),
+            lockType: DOMAIN_FIELD_NOT_LOCKED,
+            isExistingField: false,
+        };
+
+        const wrapper = mount(<DerivationDataScopeFieldOptions {...props} />);
+
+        const sectionLabel = wrapper.find({ className: 'domain-field-section-heading domain-field-section-hdr' });
+        expect(sectionLabel.length).toEqual(1);
+        expect(sectionLabel.text()).toEqual('Derivation Data Scope');
+
+        const radios = wrapper.find(Radio);
+        expect(radios).toHaveLength(3);
+        expect(radios.at(0).prop('checked')).toBeTruthy();
+        expect(radios.at(0).prop('disabled')).toBeFalsy();
+        expect(radios.at(0).text()).toBe('Editable for parent data only (default)');
+        expect(radios.at(1).prop('checked')).toBeFalsy();
+        expect(radios.at(1).prop('disabled')).toBeFalsy();
+        expect(radios.at(1).text()).toBe('Editable for child data only');
+        expect(radios.at(2).prop('checked')).toBeFalsy();
+        expect(radios.at(2).prop('disabled')).toBeFalsy();
+        expect(radios.at(2).text()).toBe('Editable for parent and child data independently');
+        expect(wrapper.find(Alert)).toHaveLength(0);
+
+        wrapper.unmount();
+    });
+
+    test('Existing field, value = ParentOnly', () => {
+        const props = {
+            index: 1,
+            domainIndex: 1,
+            label: null,
+            onChange: jest.fn(),
+            lockType: DOMAIN_FIELD_NOT_LOCKED,
+            isExistingField: true,
+            value: DERIVATION_DATA_SCOPES.PARENT_ONLY,
+        };
+
+        const wrapper = mount(<DerivationDataScopeFieldOptions {...props} />);
 
+        const radios = wrapper.find(Radio);
+        expect(radios).toHaveLength(3);
+        expect(radios.at(0).prop('checked')).toBeTruthy();
+        expect(radios.at(0).prop('disabled')).toBeFalsy();
+        expect(radios.at(1).prop('checked')).toBeFalsy();
+        expect(radios.at(1).prop('disabled')).toBeTruthy();
+        expect(radios.at(2).prop('checked')).toBeFalsy();
+        expect(radios.at(2).prop('disabled')).toBeFalsy();
+        expect(wrapper.find(Alert)).toHaveLength(0);
+
+        wrapper.unmount();
+    });
+
+    test('Existing field, value is empty', () => {
+        const props = {
+            index: 1,
+            domainIndex: 1,
+            label: null,
+            onChange: jest.fn(),
+            lockType: DOMAIN_FIELD_NOT_LOCKED,
+            isExistingField: true,
+            value: '',
+        };
+
+        const wrapper = mount(<DerivationDataScopeFieldOptions {...props} />);
+
+        const radios = wrapper.find(Radio);
+        expect(radios).toHaveLength(3);
+        expect(radios.at(0).prop('checked')).toBeTruthy();
+        expect(radios.at(0).prop('disabled')).toBeFalsy();
+        expect(radios.at(1).prop('checked')).toBeFalsy();
+        expect(radios.at(1).prop('disabled')).toBeTruthy();
+        expect(radios.at(2).prop('checked')).toBeFalsy();
+        expect(radios.at(2).prop('disabled')).toBeFalsy();
+        expect(wrapper.find(Alert)).toHaveLength(0);
+
+        wrapper.unmount();
+    });
+
+    test('Existing field, value = ChildOnly', () => {
+        const props = {
+            index: 1,
+            domainIndex: 1,
+            label: null,
+            onChange: jest.fn(),
+            lockType: DOMAIN_FIELD_NOT_LOCKED,
+            isExistingField: true,
+            value: DERIVATION_DATA_SCOPES.CHILD_ONLY,
+        };
+
+        const wrapper = mount(<DerivationDataScopeFieldOptions {...props} />);
+
+        const radios = wrapper.find(Radio);
+        expect(radios).toHaveLength(3);
+        expect(radios.at(0).prop('checked')).toBeFalsy();
+        expect(radios.at(0).prop('disabled')).toBeTruthy();
+        expect(radios.at(0).text()).toBe('Editable for parent data only (default)');
+        expect(radios.at(1).prop('checked')).toBeTruthy();
+        expect(radios.at(1).prop('disabled')).toBeFalsy();
+        expect(radios.at(1).text()).toBe('Editable for child data only');
+        expect(radios.at(2).prop('checked')).toBeFalsy();
+        expect(radios.at(2).prop('disabled')).toBeFalsy();
+        expect(radios.at(2).text()).toBe('Editable for parent and child data independently');
+        expect(wrapper.find(Alert)).toHaveLength(0);
+
+        wrapper.unmount();
+    });
+
+    test('Existing field, value = All', () => {
+        const props = {
+            index: 1,
+            domainIndex: 1,
+            label: null,
+            onChange: jest.fn(),
+            lockType: DOMAIN_FIELD_NOT_LOCKED,
+            isExistingField: true,
+            value: DERIVATION_DATA_SCOPES.ALL,
+        };
+
+        const wrapper = mount(<DerivationDataScopeFieldOptions {...props} />);
+
+        const radios = wrapper.find(Radio);
+        expect(radios).toHaveLength(3);
+        expect(radios.at(0).prop('checked')).toBeFalsy();
+        expect(radios.at(0).prop('disabled')).toBeTruthy();
+        expect(radios.at(1).prop('checked')).toBeFalsy();
+        expect(radios.at(1).prop('disabled')).toBeTruthy();
+        expect(radios.at(2).prop('checked')).toBeTruthy();
+        expect(radios.at(2).prop('disabled')).toBeFalsy();
+        expect(wrapper.find(Alert)).toHaveLength(0);
+
+        wrapper.unmount();
+    });
+
+    test('With config, show = true', () => {
+        const label = 'Sample/Aliquot Options';
+        const warning =
+            "Updating a 'Samples Only' field to be 'Samples and Aliquots' will blank out the field values for all aliquots. This action cannot be undone.";
         const props = {
             index: 1,
             domainIndex: 1,
             label,
             onChange: jest.fn(),
             lockType: DOMAIN_FIELD_NOT_LOCKED,
+            config: {
+                show: true,
+                sectionTitle: 'Sample/Aliquot Options',
+                labelAll: 'Separately editable for samples and aliquots',
+                labelChild: 'Editable for aliquots only',
+                labelParent: 'Editable for samples only (default)',
+                helpLinkNode: <>help</>,
+                scopeChangeWarning: warning,
+            },
+            isExistingField: true,
+            value: DERIVATION_DATA_SCOPES.PARENT_ONLY,
         };
 
-        const aliquot = mount(<DerivationDataScopeFieldOptions {...props} />);
+        const wrapper = mount(<DerivationDataScopeFieldOptions {...props} />);
 
-        // Verify label
-        const sectionLabel = aliquot.find({ className: 'domain-field-section-heading domain-field-section-hdr' });
+        const sectionLabel = wrapper.find({ className: 'domain-field-section-heading domain-field-section-hdr' });
         expect(sectionLabel.length).toEqual(1);
         expect(sectionLabel.text()).toEqual(label);
 
-        const fieldName = createFormInputId(DOMAIN_FIELD_DERIVATION_DATA_SCOPE, 1, 1);
-        // Test format field initial value
-        let checkbox = aliquot.find({ id: fieldName, bsClass: 'checkbox' });
-        expect(checkbox.length).toEqual(1);
-        expect(checkbox.props().checked).toEqual(false);
+        const radios = wrapper.find(Radio);
+        expect(radios).toHaveLength(3);
+        expect(radios.at(0).prop('checked')).toBeTruthy();
+        expect(radios.at(0).text()).toBe('Editable for samples only (default)');
+        expect(radios.at(1).prop('checked')).toBeFalsy();
+        expect(radios.at(1).text()).toBe('Editable for aliquots only');
+        expect(radios.at(2).prop('checked')).toBeFalsy();
+        expect(radios.at(2).text()).toBe('Separately editable for samples and aliquots');
+        expect(wrapper.find(Alert)).toHaveLength(0);
 
-        // Verify format value changes with props
-        aliquot.setProps({ value: 'ChildOnly' });
-        checkbox = aliquot.find({ id: fieldName, bsClass: 'checkbox' });
-        expect(checkbox.props().checked).toEqual(true);
+        wrapper.unmount();
+    });
 
-        aliquot.unmount();
+    test('With config, show = false', () => {
+        const label = 'Sample/Aliquot Options';
+        const props = {
+            index: 1,
+            domainIndex: 1,
+            label,
+            onChange: jest.fn(),
+            lockType: DOMAIN_FIELD_NOT_LOCKED,
+            config: {
+                show: false,
+            },
+        };
+
+        const wrapper = mount(<DerivationDataScopeFieldOptions {...props} />);
+        expect(wrapper).toEqual({});
+        wrapper.unmount();
     });
 
-    test('With config', () => {
-        const label = 'Aliquot field';
+    test('With config, isExistingField is not applicable', () => {
+        const props = {
+            index: 1,
+            domainIndex: 1,
+            label: null,
+            onChange: jest.fn(),
+            lockType: DOMAIN_FIELD_NOT_LOCKED,
+            isExistingField: true,
+            value: DERIVATION_DATA_SCOPES.ALL,
+            config: {
+                show: true,
+                dataTypeFilter: (dataType: PropDescType) => !dataType.isUniqueId(),
+            },
+            fieldDataType: UNIQUE_ID_TYPE,
+        };
+
+        const wrapper = mount(<DerivationDataScopeFieldOptions {...props} />);
 
+        expect(wrapper).toEqual({});
+
+        wrapper.unmount();
+    });
+
+    test('With config, isExistingField is applicable', () => {
         const props = {
             index: 1,
             domainIndex: 1,
-            label,
+            label: null,
             onChange: jest.fn(),
             lockType: DOMAIN_FIELD_NOT_LOCKED,
+            isExistingField: true,
+            value: DERIVATION_DATA_SCOPES.ALL,
             config: {
                 show: true,
-                disable: true,
-                sectionTitle: 'Aliquot field',
-                fieldLabel: 'Aliquot Only',
+                dataTypeFilter: (dataType: PropDescType) => !dataType.isUniqueId(),
             },
+            fieldDataType: TEXT_TYPE,
         };
 
-        const aliquot = mount(<DerivationDataScopeFieldOptions {...props} />);
-        const fieldName = createFormInputId(DOMAIN_FIELD_DERIVATION_DATA_SCOPE, 1, 1);
+        const wrapper = mount(<DerivationDataScopeFieldOptions {...props} />);
+
+        const radios = wrapper.find(Radio);
+        expect(radios).toHaveLength(3);
 
-        const checkbox = aliquot.find({ id: fieldName, bsClass: 'checkbox' });
-        expect(checkbox.props().disabled).toEqual(true);
-        aliquot.unmount();
+        wrapper.unmount();
     });
 });