5364 gis scanner handling #5382

jmbrunskill · 2024-11-12T02:47:47Z

👩🏻‍💻 What does this PR do?

Adds a new endpoint to parse the human readable GS1 AI format data for assets. (NOTE: This is actually an incorrect understanding of how the barcode is structured)
Adds an ability to scan a GS1 formatted barcode and create an asset with pre-populated data.

This is good enough to demo and test the capability, but not the final solution see follow up issue below.

💌 Any notes for the reviewer?

Follow up issues

Correctly handle GS1 2d Data Matrix format Correctly handle GS1 2D data matrix format #5390
Zxing Library is in maintenance mode, should we change our library? Zxing Library is in maintenance mode, should we change our library? #5391
Allow user to enter an asset number when creating an asset via 2d Matrix Barcode Scan Allow user to enter an asset number when creating an asset via 2d Matrix Barcode Scan #5392

🧪 Testing

Using either Android (with camera), or Desktop (with 2d Barcode Scanner)
Open the cold chain equipment section, and click the Scan button (this doesn't show on web)
Scan one of the barcodes below
You should be prompted to create a new asset
If you accept, it should show a new asset with the serial number, asset type, and Warenty date populated
The Installation date should default to today
Scanning the same barcode again, should navigate you to the right asset (once it has been created)

NOTE, scanning these 2d Matrixes in github dark mode or with a black background doesn't work well...

2d Matrix examples:

Here's an example raw string you can use to create new QR Code using https://barcode.tec-it.com/en/DataMatrix

(01)00012345600012(11)241007(21)S12345678(241)E003/002(3121)82(3131)67(3111)63(8013)HBD 116(90)001(91)241007-310101(92){"pqs":"https://apps.who.int/immunization_standards/vaccine_quality/pqs_catalogue/LinkPDF.aspx?UniqueID=3bf9439f-3316-49b4-845e-d50360f8280f&TipoDoc=DataSheet&ID=0”}

PQS Asset Type: E003/002
Serial Number: S1

PQS Asset Type: E003/002
Serial Number: S2

PQS Asset Type: E004/055
Serial Number S1

📃 Documentation

Part of an epic: documentation will be completed for the feature as a whole
No documentation required: no user facing changes or a bug fix which isn't a change in behaviour
These areas should be updated or checked:
1.
2.

github-actions · 2024-11-12T02:52:30Z

Bundle size difference

Comparing this PR to main

Old size	New size	Diff
4.96 MB	4.96 MB	1.62 KB (0.03%)

jmbrunskill · 2024-11-12T23:18:44Z

client/packages/coldchain/src/Equipment/ListView/AddFromScannerButton.tsx

+    onConfirm: () => {
+      if (newAssetData.current) {
+        saveNewAsset(newAssetData.current)
+          .catch(e => error(t('error.unable-to-save-asset', { error: e }))())


This catch doesn't work for some reason!
I tired adding throw e into the useAssets.document.insert(); useMutation:onError but that didn't work.
Help please!

It appears to work fine for me? Though you'd need to add {{ error }} to the 'error.unable-to-save-asset' translation for the error message to show... not entirely sure it should though!

The only time I can seem to see where it doesn't show a message is when newAssetData.current isn't defined.... I think somewhere we have an example of passing data into confirm (so we can pass directly from handleScanResult, and skip the ref thing completely) - but I can't find right now, and I know we're on a time crunch to get something for RC!

Can be a clean up for another PR, maybe as part of that other issue?

I would move the catch below the .then() though! If saveNewAsset errors, we don't want to catch, and then try do the insertLog/redirect, should throw to below that

jmbrunskill · 2024-11-12T23:21:04Z

client/packages/coldchain/src/Equipment/ListView/AddFromScannerButton.tsx

+          .catch(e => error(t('error.unable-to-save-asset', { error: e }))())
+          .then(async () => {
+            if (newAssetData.current) {
+              await insertLog({


This is duplicated functionality as the add new asset modal does this too.
Would be nice to consolidate in #5392

lache-melvin

Sorry James, seem to be getting CCE not found with id errors rather than the create modal? Looks like this is because it is not the expected GS1 format... I thought these data matrices should work though? Otherwise everything behaving as expected - so sorry I'm so late on review 🙈

lache-melvin · 2024-11-13T02:01:42Z

server/service/src/asset/parse.rs

+    let repository = AssetRepository::new(&ctx.connection);
+
+    let mut result =
+        repository.query_by_filter(AssetFilter::new().id(EqualFilter::equal_to(id)))?;


NIT: but any reason to use query_by_filter rather than just find_one_by_id off the row repository?

This won't find deleted items, but I guess either way is ok? If its been deleted what should be the behaviour?

lache-melvin · 2024-11-13T02:05:45Z

server/util/src/gs1.rs

+    }
+
+    pub fn gtin(&self) -> Option<String> {
+        self.gs1.get("01").cloned()


Might be nice to add a comment with link to spec for where you got these from? Though if this is all about to change then maybe fine 😁

It's all changing...

lache-melvin · 2024-11-13T02:33:32Z

client/packages/coldchain/src/Equipment/ListView/AddFromScannerButton.tsx

+    onConfirm: () => {
+      if (newAssetData.current) {
+        saveNewAsset(newAssetData.current)
+          .catch(e => error(t('error.unable-to-save-asset', { error: e }))())


It appears to work fine for me? Though you'd need to add {{ error }} to the 'error.unable-to-save-asset' translation for the error message to show... not entirely sure it should though!

The only time I can seem to see where it doesn't show a message is when newAssetData.current isn't defined.... I think somewhere we have an example of passing data into confirm (so we can pass directly from handleScanResult, and skip the ref thing completely) - but I can't find right now, and I know we're on a time crunch to get something for RC!

Can be a clean up for another PR, maybe as part of that other issue?

lache-melvin · 2024-11-13T02:34:39Z

client/packages/coldchain/src/Equipment/ListView/AddFromScannerButton.tsx

+    onConfirm: () => {
+      if (newAssetData.current) {
+        saveNewAsset(newAssetData.current)
+          .catch(e => error(t('error.unable-to-save-asset', { error: e }))())


I would move the catch below the .then() though! If saveNewAsset errors, we don't want to catch, and then try do the insertLog/redirect, should throw to below that

lache-melvin · 2024-11-13T03:58:54Z

Merge it! We can clean up in RC2 🙏

CarlosNZ and others added 10 commits November 11, 2024 15:35

Add mock GraphQL node

cff29bb

Add front-end functionality for scanning new asset

3356e63

WIP Parsing GS1

45fe39c

GS1 Parsing

fbc3ed4

Return Draft Asset for GS1 Scan Result

0a179bf

Return after no matching asset

fa9a086

Handle asset data

bd6c56c

Update to new back-end API

28770a5

Fix Serial Number Lookup

1385511

Use correct parse_scanned_data api from the Add Scan Button

fa27500

github-actions bot added this to the V2.4.0 milestone Nov 12, 2024

github-actions bot added enhancement New feature or request Epic Team Piwakawaka James, Laché, Carl feature: GAPS labels Nov 12, 2024

jmbrunskill added 2 commits November 13, 2024 10:32

Check model and serial number for duplicate asset, tidy up format check

616280d

Try to catch errors...

76d409d

jmbrunskill marked this pull request as ready for review November 12, 2024 23:17

jmbrunskill commented Nov 12, 2024

View reviewed changes

lache-melvin requested changes Nov 13, 2024

View reviewed changes

re-order try catch

06af3d6

jmbrunskill requested a review from lache-melvin November 13, 2024 03:55

lache-melvin approved these changes Nov 13, 2024

View reviewed changes

jmbrunskill merged commit 8c3928c into develop Nov 13, 2024
6 checks passed

jmbrunskill deleted the 5364-GIS-scanner-handling branch November 13, 2024 03:59

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

5364 gis scanner handling #5382

5364 gis scanner handling #5382

jmbrunskill commented Nov 12, 2024 •

edited

Loading

github-actions bot commented Nov 12, 2024 •

edited

Loading

jmbrunskill Nov 12, 2024

lache-melvin Nov 13, 2024

lache-melvin Nov 13, 2024

jmbrunskill Nov 12, 2024 •

edited

Loading

lache-melvin left a comment •

edited

Loading

lache-melvin Nov 13, 2024

jmbrunskill Nov 13, 2024

lache-melvin Nov 13, 2024

jmbrunskill Nov 13, 2024

lache-melvin Nov 13, 2024

lache-melvin Nov 13, 2024

lache-melvin commented Nov 13, 2024

5364 gis scanner handling #5382

5364 gis scanner handling #5382

Conversation

jmbrunskill commented Nov 12, 2024 • edited Loading

👩🏻‍💻 What does this PR do?

💌 Any notes for the reviewer?

🧪 Testing

📃 Documentation

github-actions bot commented Nov 12, 2024 • edited Loading

Bundle size difference

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jmbrunskill Nov 12, 2024 • edited Loading

Choose a reason for hiding this comment

lache-melvin left a comment • 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

lache-melvin commented Nov 13, 2024

jmbrunskill commented Nov 12, 2024 •

edited

Loading

github-actions bot commented Nov 12, 2024 •

edited

Loading

jmbrunskill Nov 12, 2024 •

edited

Loading

lache-melvin left a comment •

edited

Loading