UIIN-2546/UIIN-2548/UIIN-2549/UIIN-2556/UIIN-2557 Number generator implementation #2408

EthanFreestone · 2024-03-01T12:30:22Z

Purpose

Make use of the service interaction feature "number generator" to handle item barcode, accession number and call number fields in inventory.

This is an implementation to guide usage of the number generator library of components supplied by ui-service-interaction. This is not the only way to use them, and instead represents a guide on how they might be used, with the power of change living with the developer team, this is not a plugin over which you have 0 control, but rather an example implementation of this cross module functionality.

Approach

This comprises of 3 main "feature blocks"

Settings

New settings page - Number generator options.
This is a form containing two accordions, one for holding level interactions and one for item level interactions.

These set up simple checkboxes to turn on/off number generator for the fields in question, with 3 levels of configurability for the number generator:

off (field exists as before)
on without edit (field is disabled, the number generator button is rendered and is the only way to fill the field)
on (field is non disabled, can either be filled in manually or by using the generator)

For items there is an additional ability - use accession number for call number. This will allow the user to specify that the accession number sequences are also the options for call number field, and the two will share the same sequences and counts.

These settings currently make use of mod-configuration, but in reality so long as they can be stored and retrieved it does not matter how these settings are configured.

Side note- The sequences and generators can be configured in the settings page for "service interaction"

Holdings form

Added number generator button to call number field in holdings form

Item form

Added number generator button to call number, accession number and item barcode fields in items form

Initial setup of number generator in inventory, package changes and settings page set up

Added useConfigurationQuery hook in the same style as other hooks in use already, and made use of this in EditItem and CreateItem to pass to ItemForm. Ideally this could just live in ItemForm, but that component is a class component and refactoring that to functional to use a hook is out of scope for this work.

Hooked up itemForm to the settings, small tweaks to settings to avoid softlocking user out of options, some translations

Tweaked settings layouts and translations (WIP, missing a translation still), and refactored ItemForm implementation to make simpler. Also moved majority of render logic to a separate utility method to keep the changes to the actual form component to a minimum

Added translation to the inofPopover in settings and small linting changes

Added safety feature to ensure that if the "use the same generated number for accession number and call number" did get set by accident when accession number and/or call number were "off", then it would ignore that setting

Manually provide styling for disabling of radio buttons since that isn't set up by default in stripes

Small tweaks to translations, added "learn more" button to link to documentation (when written)

Added labels to make modal implementation slightly nicer to view

Added some padding to the text at the top of the joint accession/call number modal, and removed it from the MessageBanner

…number-generator

Update to use servint 3

…number-generator

Added call number generator button to Holdings form, tweaks to settings

…number-generator

Changed Button from fullWidth to scale with text

…number-generator

Change order of ui-inventory NumGen settings UIIN-2557

…number-generator

github-actions · 2024-03-01T12:36:41Z

Jest Unit Test Statistics

    1 files ±0 231 suites +1 12m 9s ⏱️ - 3m 50s
930 tests +1 928 ✔️ +1 2 💤 ±0 0 ❌ ±0
936 runs +1 934 ✔️ +1 2 💤 ±0 0 ❌ ±0

Results for commit b0a16b6. ± Comparison against base commit ad11c96.

♻️ This comment has been updated with latest results.

mariia-aloshyna · 2024-03-06T14:45:43Z

Hi @EthanFreestone could you add the description to the PR, please? Like the purpose, approach, and maybe some screenshots?

EthanFreestone · 2024-03-06T17:00:31Z

Hi @EthanFreestone could you add the description to the PR, please? Like the purpose, approach, and maybe some screenshots?

Hi @mariia-aloshyna I believe the purpose is covered by the linked JIRA tickets, a brief instruction on the approach is now part of the description.

Effectively though - we've created a library of components which can make use of the "number generator" functionality in mod-service-interaction. This is an example of how inventory might wish to implement that functionality, given the JIRA tickets raised.

The component library is highly configurable, and there are (as with all frontend work) many ways to skin this particular cat

…number-generator

mariia-aloshyna · 2024-03-07T16:45:57Z

src/Holding/CreateHolding/CreateHolding.js

@@ -26,6 +26,8 @@ const CreateHolding = ({
  mutator,
 }) => {
  const callout = useCallout();
+  const { configs } = useConfigurationQuery('number_generator');


Move number_generator to constants, please, I see this is used in several places.

mariia-aloshyna · 2024-03-07T16:47:21Z

src/edit/holdings/HoldingsForm.js

+                            component={TextArea}
+                            rows={1}
+                            fullWidth
+                            disabled={this.isFieldBlocked('callNumber') || callNumberGeneratorSettingHoldings === 'useGenerator'}


Move useGenerator string to constants, please

mariia-aloshyna · 2024-03-07T16:47:40Z

src/edit/holdings/HoldingsForm.js

+                        <Row>
+                          {(
+                            callNumberGeneratorSettingHoldings === 'useGenerator' ||
+                            callNumberGeneratorSettingHoldings === 'useBoth'


And useBoth also

mariia-aloshyna · 2024-03-07T16:49:36Z

src/edit/holdings/HoldingsForm.js

-                          fullWidth
-                          disabled={this.isFieldBlocked('callNumber')}
-                        />
+                        <Row>


So currently Row is a child for Col and then there is another nested Col, is that how it was intended?

mariia-aloshyna · 2024-03-07T16:50:01Z

src/edit/holdings/HoldingsForm.js

+                            <Col xs={12}>
+                              <NumberGeneratorModalButton
+                                buttonLabel={<FormattedMessage id="ui-inventory.numberGenerator.generateCallNumber" />}
+                                callback={(generated) => change('callNumber', generated)}


move this to a separate func

mariia-aloshyna · 2024-03-07T16:55:45Z

src/edit/items/getNumberGeneratorModals.js

+  const accessionNumberGeneratorActive = accessionNumberGeneratorSettingItems === 'useGenerator' ||
+  accessionNumberGeneratorSettingItems === 'useBoth';
+
+  const barcodeGeneratorActive = barcodeGeneratorSettingItems === 'useGenerator' ||
+  barcodeGeneratorSettingItems === 'useBoth';
+
+  const callNumberGeneratorActive = callNumberGeneratorSettingItems === 'useGenerator' ||
+  callNumberGeneratorSettingItems === 'useBoth';
+
+  const disableAccessionNumberField = accessionNumberGeneratorSettingItems === 'useGenerator';
+  const disableBarcodeField = barcodeGeneratorSettingItems === 'useGenerator';
+  const disableCallNumberField = callNumberGeneratorSettingItems === 'useGenerator';


All strings should be moved to constants and use the naming pattern, like if your variable is boolean, then call it isAccessionNumberGeneratorActive, isAccessionNumberFieldDisabled etc.

mariia-aloshyna · 2024-03-07T16:58:49Z

src/hooks/useConfigurationQuery.js

+  const query = `query=(module=INVENTORY and configName=${configName})`;
+
+  const queryKey = [namespace, query, 'useConfigurationQuery'];
+


Remove extra empty line, please

mariia-aloshyna · 2024-03-07T17:01:27Z

src/settings/NumberGeneratorOptions/NumberGeneratorOptions.test.js

+import React from 'react';
+
+import { screen } from '@folio/jest-config-stripes/testing-library/react';
+import stripesFinalForm from '@folio/stripes/final-form';


There is renderWithFinalForm helper in ui-inventory, you can use it

mariia-aloshyna · 2024-03-07T17:05:19Z

src/settings/NumberGeneratorOptions/NumberGeneratorOptionsForm.js

Please, cover this component with unit tests

mariia-aloshyna · 2024-03-07T17:06:05Z

package.json

@@ -484,6 +485,14 @@
        ],
        "visible": true
      },
+      {
+        "permissionName": "ui-inventory.settings.numberGenerator.manage",


Add the new permission to translations as well

sonarcloud · 2024-03-28T10:43:54Z

Quality Gate failed

Failed conditions
57.3% Coverage on New Code (required ≥ 80%)

See analysis details on SonarCloud

EthanFreestone added 24 commits March 3, 2023 15:34

feat: Number Generator (Settings)

206be77

Initial setup of number generator in inventory, package changes and settings page set up

feat: ItemForm

575f064

Hooked up itemForm to the settings, small tweaks to settings to avoid softlocking user out of options, some translations

refactor: Tweaks

f7e643a

Tweaked settings layouts and translations (WIP, missing a translation still), and refactored ItemForm implementation to make simpler. Also moved majority of render logic to a separate utility method to keep the changes to the actual form component to a minimum

chore: Translation

5f33597

Added translation to the inofPopover in settings and small linting changes

feat: Safety

23f0456

Added safety feature to ensure that if the "use the same generated number for accession number and call number" did get set by accident when accession number and/or call number were "off", then it would ignore that setting

style: Grey out disabled radio buttons

8e76340

Manually provide styling for disabling of radio buttons since that isn't set up by default in stripes

chore: Slight tweaks

e9024df

Small tweaks to translations, added "learn more" button to link to documentation (when written)

feat: Styling tweaks

e5cebd6

Added labels to make modal implementation slightly nicer to view

style: Padding

685ebae

Added some padding to the text at the top of the joint accession/call number modal, and removed it from the MessageBanner

Merge branch 'master' of github.com:folio-org/ui-inventory into feat/…

e1a9baa

…number-generator

build: OptionalOkapiInterfaces

9e202b8

Update to use servint 3

Merge branch 'master' of github.com:folio-org/ui-inventory into feat/…

391442e

…number-generator

Merge branch 'master' of github.com:folio-org/ui-inventory into feat/…

657d272

…number-generator

feat: Holdings

3592bab

Added call number generator button to Holdings form, tweaks to settings

Merge branch 'master' of github.com:folio-org/ui-inventory into feat/…

beec654

…number-generator

Merge branch 'master' of github.com:folio-org/ui-inventory into feat/…

65fbd3e

…number-generator

chore: Button UX

d2728a4

Changed Button from fullWidth to scale with text

Merge branch 'master' of github.com:folio-org/ui-inventory into feat/…

0bf7177

…number-generator

Merge branch 'master' of github.com:folio-org/ui-inventory into feat/…

2702209

…number-generator

Merge branch 'master' of github.com:folio-org/ui-inventory into feat/…

00644eb

…number-generator

refactor: Settings order

2f1cab6

Change order of ui-inventory NumGen settings UIIN-2557

Merge branch 'master' of github.com:folio-org/ui-inventory into feat/…

a1320ae

…number-generator

chore: Linting and test fixes

1eb29eb

test: More tests and mocks to try and push PR through

8381957

mariia-aloshyna requested review from BogdanDenis, OleksandrHladchenko1, mariia-aloshyna and Dmytro-Melnyshyn March 6, 2024 14:28

Merge branch 'master' of github.com:folio-org/ui-inventory into feat/…

29c9b5c

…number-generator

mariia-aloshyna reviewed Mar 7, 2024

View reviewed changes

build: Change service interaction dependency to ^3.0.0

ea9eccf

chore: Removed "Learn more" button

b0a16b6

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

UIIN-2546/UIIN-2548/UIIN-2549/UIIN-2556/UIIN-2557 Number generator implementation #2408

UIIN-2546/UIIN-2548/UIIN-2549/UIIN-2556/UIIN-2557 Number generator implementation #2408

EthanFreestone commented Mar 1, 2024 •

edited

Loading

github-actions bot commented Mar 1, 2024 •

edited

Loading

mariia-aloshyna commented Mar 6, 2024

EthanFreestone commented Mar 6, 2024 •

edited

Loading

mariia-aloshyna Mar 7, 2024

mariia-aloshyna Mar 7, 2024

mariia-aloshyna Mar 7, 2024

mariia-aloshyna Mar 7, 2024

mariia-aloshyna Mar 7, 2024

mariia-aloshyna Mar 7, 2024

mariia-aloshyna Mar 7, 2024

mariia-aloshyna Mar 7, 2024

mariia-aloshyna Mar 7, 2024

mariia-aloshyna Mar 7, 2024

sonarcloud bot commented Mar 28, 2024

		const query = `query=(module=INVENTORY and configName=${configName})`;

		const queryKey = [namespace, query, 'useConfigurationQuery'];

UIIN-2546/UIIN-2548/UIIN-2549/UIIN-2556/UIIN-2557 Number generator implementation #2408

Are you sure you want to change the base?

UIIN-2546/UIIN-2548/UIIN-2549/UIIN-2556/UIIN-2557 Number generator implementation #2408

Conversation

EthanFreestone commented Mar 1, 2024 • edited Loading

Purpose

Approach

Settings

Side note- The sequences and generators can be configured in the settings page for "service interaction"

Holdings form

Item form

github-actions bot commented Mar 1, 2024 • edited Loading

Jest Unit Test Statistics

mariia-aloshyna commented Mar 6, 2024

EthanFreestone commented Mar 6, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sonarcloud bot commented Mar 28, 2024

Quality Gate failed

EthanFreestone commented Mar 1, 2024 •

edited

Loading

github-actions bot commented Mar 1, 2024 •

edited

Loading

EthanFreestone commented Mar 6, 2024 •

edited

Loading