feat: Allow GS1 barcode types to be used in search and read API #9014

hangy · 2023-09-17T13:57:38Z

What

Allows using more barcode types in search and READ API

Related issue(s) and discussion

Fixes Allow GS1 barcode types to be used in search #9013
Depends on feat: Allow scanning more GS1 barcodes #8911

- Remove redundant `$` - Fix scope of `$ai_data_str` - Some regexes

[WIP]

- libzxing-dev requires a the current Debian stable, bookworm. - libapache2-request-perl is only available via backports for bookworm.

@tonycoz

test: Add first unittest for GS1 DataMatrix code Thanks to @tonycoz (TONYC on cpan) for implementing Imager::zxing!

- Ensure that more GS1 Data Link URI formats can be 'normalized' - URIs that cannot be a GS1 Data Link should not be treated as an product code

See #8911 (comment) for discussion

Should possibly have a feature flag, depending on the API version

…rom the code to allow query params in GS1 data URI to be present

…nd `decodeURIComponent`, so that a '/' in the code isn't split.

…rd `gs1_ai_data_str`.

tests/unit/routing.t

codecov-commenter · 2023-09-17T14:42:33Z

Codecov Report

Merging #9014 (a0a551c) into main (c58b690) will increase coverage by 0.28%.
Report is 16 commits behind head on main.
The diff coverage is 72.85%.

@@            Coverage Diff             @@
##             main    #9014      +/-   ##
==========================================
+ Coverage   46.09%   46.37%   +0.28%     
==========================================
  Files          64       64              
  Lines       19837    19905      +68     
  Branches     4801     4811      +10     
==========================================
+ Hits         9143     9231      +88     
+ Misses       9513     9498      -15     
+ Partials     1181     1176       -5

Files Changed	Coverage Δ
lib/ProductOpener/API.pm	`16.81% <0.00%> (ø)`
lib/ProductOpener/APIProductRead.pm	`25.92% <0.00%> (ø)`
lib/ProductOpener/APIProductWrite.pm	`12.59% <0.00%> (ø)`
lib/ProductOpener/Images.pm	`17.31% <65.38%> (+4.58%)`	⬆️
lib/ProductOpener/Routing.pm	`33.67% <80.00%> (+2.90%)`	⬆️
lib/ProductOpener/Products.pm	`48.33% <85.71%> (+1.09%)`	⬆️

... and 6 files with indirect coverage changes

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

The dummy number used before does not have a valid checksum.

…des-in-search

sonarqubecloud · 2023-09-19T08:23:39Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
No Duplication information

stephanegigandet · 2023-09-19T16:51:24Z

This looks great, thanks for adding all the test cases etc. :)

I'm trying to build zxing on stretch (what we have in prod today), no success yet, I'll try harder.

stephanegigandet · 2023-09-19T17:26:39Z

I tested it in docker, it works great. :)

In production though, as we are still on stretch, I'm unable to build zxing. It needs cmake 3.15 and gcc 7, while we have cmake 3.7.2 and gcc 6.3...

So we would have to wait for the migration of off1 to merge and deploy this unfortunately.. :(

hangy · 2023-09-19T20:44:53Z

I tested it in docker, it works great. :)

Nice! 😄

In production though, as we are still on stretch, I'm unable to build zxing. It needs cmake 3.15 and gcc 7, while we have cmake 3.7.2 and gcc 6.3...

We could try building zxing-cpp as a static lib, bundle that as a .deb, and try using that? I don't have too much experience with building Debian packages, but cpack -G DEB seems to handle a lot of stuff for you.

hangy added 24 commits September 11, 2023 21:20

chg: Support GS1 barcodes for code normalization

cd92501

fix: Minor mistakes

47454ba

- Remove redundant `$` - Fix scope of `$ai_data_str` - Some regexes

fix: perl tidy and critic

6fa7311

test: Add some image test

da404c8

[WIP]

chg: Catch GS1::SyntaxEngine exceptions

4a85c92

test: Some more cases

2088571

deps(cpan): Add Imager::zxing to support DataMatrix barcodes

2588f0c

- libzxing-dev requires a the current Debian stable, bookworm. - libapache2-request-perl is only available via backports for bookworm.

feat: Use Imager::zxing to decode DataMatrix codes

698e84f

test: Add first unittest for GS1 DataMatrix code Thanks to @tonycoz (TONYC on cpan) for implementing Imager::zxing!

test: Add tests for GS1 Data URI with QR Code and DataMatrix

8857a17

test: Add tests for some GS1 DataBar variants

6702d93

test: Add additional tests for normalize_code

617c356

- Ensure that more GS1 Data Link URI formats can be 'normalized' - URIs that cannot be a GS1 Data Link should not be treated as an product code

docs: Update POD for normalize_code()

16ebb60

deps: Revert to debian bullseye, and install zxing-cpp 2.1.0 manually

a7f80cb

See #8911 (comment) for discussion

wip: Return AI data string from normalize_requested_code

b19c047

Should possibly have a feature flag, depending on the API version

fix: Export normalize_code_with_gs1_ai

afff0d5

test: Add some integration tests for READ API with simple GS1 cases

dd42c66

chg: Try to detect GTIN from GS1 AI string, data URI, etc.

cf82ac7

test: Add get-existing-product-gs1-data-uri test case

579ed62

test: Add test cases for normalize_code_with_gs1_ai

7d2dbf4

fix: Reverse order of UTF8 decoding and removal of query parameters f…

2169f66

…rom the code to allow query params in GS1 data URI to be present

fix: URI and URL should both be valid in code

543b16b

test: Add test cases for analyze_request with GS1 data uri

b6855ab

fix: Adjust my expectectations, and reverse order of split by '/' , a…

5b043dc

…nd `decodeURIComponent`, so that a '/' in the code isn't split.

fix: Always use results from normalize_code_with_gs1_ai, just disca…

13640c7

…rd `gs1_ai_data_str`.

hangy added barcodes GS1 The producer platform is integrating with the GS1 product data formats. GS1 manages barcodes. labels Sep 17, 2023

hangy self-assigned this Sep 17, 2023

github-actions bot added API Issues related to the Open Food Facts API. More specific labels exist & should be used (API WRITE…) API READ All READ APIs include Product, Search… 🖼️ Images labels Sep 17, 2023

github-actions bot added 🧪 tests Products 🧪 unit tests API v3 labels Sep 17, 2023

hangy changed the title ~~Issue/9013 more barcodes in search~~ feat: Allow GS1 barcode types to be used in search and API Sep 17, 2023

hangy commented Sep 17, 2023

View reviewed changes

tests/unit/routing.t Show resolved Hide resolved

fix: Update expected test results

a0a551c

The dummy number used before does not have a valid checksum.

github-actions bot added 📖 Knowledge Panels https://wiki.openfoodfacts.org/Knowledge_panels 🧪 integration tests labels Sep 18, 2023

hangy marked this pull request as ready for review September 18, 2023 22:04

hangy requested a review from a team as a code owner September 18, 2023 22:04

hangy changed the title ~~feat: Allow GS1 barcode types to be used in search and API~~ feat: Allow GS1 barcode types to be used in search and read API Sep 18, 2023

hangy added 2 commits September 19, 2023 10:03

Merge remote-tracking branch 'origin/main' into issue/9013-more-barco…

290d0f9

…des-in-search

fix: Update expected test results after merge

6376b15

github-actions bot added the 💥 Merge Conflicts 💥 Merge Conflicts label Sep 21, 2023

hangy closed this Sep 28, 2023

hangy deleted the issue/9013-more-barcodes-in-search branch September 28, 2023 16:30

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Allow GS1 barcode types to be used in search and read API #9014

feat: Allow GS1 barcode types to be used in search and read API #9014

hangy commented Sep 17, 2023

codecov-commenter commented Sep 17, 2023 •

edited

Loading

sonarqubecloud bot commented Sep 19, 2023

stephanegigandet commented Sep 19, 2023

stephanegigandet commented Sep 19, 2023

hangy commented Sep 19, 2023

feat: Allow GS1 barcode types to be used in search and read API #9014

feat: Allow GS1 barcode types to be used in search and read API #9014

Conversation

hangy commented Sep 17, 2023

What

Related issue(s) and discussion

codecov-commenter commented Sep 17, 2023 • edited Loading

Codecov Report

sonarqubecloud bot commented Sep 19, 2023

stephanegigandet commented Sep 19, 2023

stephanegigandet commented Sep 19, 2023

hangy commented Sep 19, 2023

codecov-commenter commented Sep 17, 2023 •

edited

Loading