Specify the user country in API queries

[stephanegigandet]

The returned results may differ by country of request. e.g. we currently disable the Eco-Score attribute unless the country is set to France (either by having the "cc" parameter set to "fr", or the query sent to fr.openfoodfacts.org). This may require changes in the openfoodfacts-dart package, I haven't checked yet.

[stephanegigandet]

It does require a change in openfoodfacts-dart: openfoodfacts/openfoodfacts-dart#76

[stephanegigandet]

The openfoodfacts-dart change has been merged: openfoodfacts/openfoodfacts-dart#76

[monsieurtanuki]

@stephanegigandet I cannot see the direct impact of that merge for the moment.
The current code for keyword search is something like that:

await OpenFoodAPIClient.searchProducts(
  ProductQuery.SMOOTH_USER,
  ProductSearchQueryConfiguration(
    fields: ProductQuery.fields,
    parametersList: <Parameter>[
      const PageSize(size: 500),
      TagFilter(
        tagType: 'categories',
        contains: true,
        tagName: keywords,
      )
    ],
    language: LanguageHelper.fromJson(languageCode),
  ),
);

How should we alter the code? adding something like that to the Parameter list?

TagFilter(
  tagType: 'cc',
  contains: true,
  tagName: 'fr',
)

And it is available now or should we use a fresher version than openfoodfacts: ^0.3.14+1?

[stephanegigandet]

The current code for keyword search is something like that:

Ah right, I hadn't noticed there was a specific ProductSearchConfiguration, I will update it.

Then it should be:

await OpenFoodAPIClient.searchProducts(
  ProductQuery.SMOOTH_USER,
  ProductSearchQueryConfiguration(
    fields: ProductQuery.fields,
    parametersList: <Parameter>[
      const PageSize(size: 500),
      TagFilter(
        tagType: 'categories',
        contains: true,
        tagName: keywords,
      )
    ],
    language: LanguageHelper.fromJson(languageCode),
    cc: "fr",
  ),
);

[stephanegigandet]

And it is available now or should we use a fresher version than openfoodfacts: ^0.3.14+1?

I'll push it in 0.3.15 and publish it: openfoodfacts/openfoodfacts-dart#81

[monsieurtanuki]

@stephanegigandet OK then! Tell me when openfoodfacts: ^0.3.15 is available.

[stephanegigandet]

@monsieurtanuki : here is the pull request that adds the cc parameter to ProductSearchQueryConfiguration: openfoodfacts/openfoodfacts-dart#82

[stephanegigandet]

0.3.15 is deployed: https://pub.dev/packages/openfoodfacts

[monsieurtanuki]

@stephanegigandet Cool!

For ProductSearchQueryConfiguration it's OK, I could replace

language: LanguageHelper.fromJson(languageCode),

with

lc: locale.languageCode,
cc: locale.countryCode,

But for Pnns search PnnsGroupQueryConfiguration is used, and doesn't seem to have been impacted the same way...

[monsieurtanuki]

Additional remarks:

• without the cc parameter, the keyword search URL for "tarte" is https://world.openfoodfacts.org/cgi/search.pl?page_size=500&tagtype_0=categories&tag_contains_0=contains&tag_0=tarte&search_terms&lc=fr&fields=%2Cproduct_name%2Cbrands%2Ccode%2Cnutrition_grade_fr%2Cimage_small_url%2Cselected_images%2Cquantity%2Cserving_size%2Cproduct_quantity%2Cnutriments%2Cnutrient_levels%2Cnutriment_energy_unit%2Cadditives_tags%2Cingredients_analysis_tags%2Clabels_tags%2Cenvironment_impact_level_tags%2Ccategories_tags%2Clang%2Cattribute_groups&json=1
• without the cc=fr parameter the size of the result is 5,174,524 bytes
• adding cc=fr the size of the result is 5,481,717 bytes - it's bigger, though my assumption was that it would be smaller (AND/OR confusion in the filters?)
• we've got a problem in flutter: we don't set the countryCode in the Locale (cf. AppLocalizations.supportedLocales), just the language. Interesting thoughts on Locale can be found here. A solution seems to extract the country code from Platform.localeName (dart:io) as the default country code, but in the long run we may have to give the end-user the possibility to change the country

[stephanegigandet]

• adding cc=fr the size of the result is 5,481,717 bytes - it's bigger, though my assumption was that it would be smaller (AND/OR confusion in the filters?)

well you get 500 results in both cases. try with a smaller country: cc=re (Reunion) and you will get 2 results.

but with cc=fr, you get extra data in the attribute_groups as you get the Eco-Score attribute (but the search results are different, so it can also change the size)

[stephanegigandet]

But for Pnns search PnnsGroupQueryConfiguration is used, and doesn't seem to have been impacted the same way...

We can add it, but eventually we will need to remove the queryPnnsGroup functions from the Dart package, they should not be needed. The PNNS queries are just search queries with a filter on a parameter, just like the keywords search queries etc.

[monsieurtanuki]

@stephanegigandet My remarks:

• understood for cc=re
• but the iso country code is supposed to be in capital letters, and that's what I pass as a parameter: country code in capital letters
• and the result is different for cc=re (2 results) and cc=RE (500 results, like for cc=fror no cc; it looks like the unknown cc was discarded)
• hence my question: should we lowercase the country code in flutter or should you manage uppercase country codes on the server side?
• I'm also interested in your comment about PNNS queries - I guess it would make sense to create a dedicated issue about it (should we replace them with our current keywords searches? should we remove the category search from the UI?)

[stephanegigandet]

@monsieurtanuki : I'll fix the cc=RE server side: openfoodfacts/openfoodfacts-server#4833

[stephanegigandet]

• I'm also interested in your comment about PNNS queries - I guess it would make sense to create a dedicated issue about it (should we replace them with our current keywords searches? should we remove the category search from the UI?)

@monsieurtanuki : I was more thinking about the implementation of those PNNS queries in openfoodfacts-dart: we can get the exact same functionality without special code for it. I just filed an issue regarding that: openfoodfacts/openfoodfacts-dart#92

The PNNS category browsing feature is interesting, I was not suggesting to remove it.

[monsieurtanuki]

cf. #19 I guess

[monsieurtanuki]

Hey, by the way this issue can now be closed, on the flutter side at least.

[stephanegigandet]

Server side fix for the uppercase country code: openfoodfacts/openfoodfacts-server#4834
It should be deployed soon.