Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix schema validation for product_id in picnic integration #109083

Merged
merged 2 commits into from
Jan 31, 2024

Conversation

codesalatdev
Copy link
Contributor

@codesalatdev codesalatdev commented Jan 29, 2024

Proposed change

This PR fixes the schema validation for the product_id field of the picnic integration. In contrast to what the service adding a product to the shopping list currently expects, Picnic actually uses not only numbers for their IDs, but also characters (see s1028538 in the following API output):

>>> picnic.search("Trauben rot")
[{'type': 'CATEGORY', 'id': 'Trauben rot', 'links': [{'type': 'SEARCH', 'href': 'https://storefront-prod.de.picnicinternational.com/api/15/search?search_term=Trauben+rot'}], 'name': 'Trauben rot', 'items': [{'type': 'SINGLE_ARTICLE', 'id': 's1028538', 'decorators': [{'type': 'FRESH_LABEL', 'period': 'P3D'}, {'type': 'UNIT_QUANTITY', 'unit_quantity_text': '500g'}], 'name': 'Trauben rot kernlos', 'display_price': 279, 'price': 279, 'image_id': 'ee870ca05306a7332e5be623e8240c73d58a639c1c98979ed2c30d5efff1f138', 'max_count': 99, 'unit_quantity': '500g', 'unit_quantity_sub': '5.58€/kg', 'tags': []}, {'type': 'SINGLE_ARTICLE', 'id': 's1025963', 'decorators': [{'type': 'PRODUCT_SIZE', 'text': 'XL'}, {'type': 'PRODUCT_CHARACTERISTICS', 'characteristics': [{'type': 'ORGANIC', 'score': None, 'rating': None, 'baby_month': None}, {'type': 'BABY', 'score': None, 'rating': None, 'baby_month': '6+'}]}, {'type': 'UNIT_QUANTITY', 'unit_quantity_text': '6 x 500ml'}], 'name': 'Hipp Bio Frucht + mit Eisen Rote Traube in Apfel', 'display_price': 745, 'price': 745, 'image_id': '8f358558e8b58ff16b79599343b37725bfef9e15148d63710bc36d7336faf8bd', 'max_count': 99, 'unit_quantity': '6 x 500ml', 'unit_quantity_sub': '2.48€/L', 'tags': []}, {'type': 'ITEM_SUGGESTION_DIALOG', 'id': 'item_suggestion_dialog'}], 'level': 1, 'is_included_in_category_tree': False, 'hidden': False}]

The service already casts the ID to a string anyway, so the only thing changed is the validation.

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New integration (thank you!)
  • New feature (which adds functionality to an existing integration)
  • Deprecation (breaking change to happen in the future)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Additional information

  • This PR fixes or closes issue: None found
  • This PR is related to issue: None found
  • Link to documentation pull request: None

Checklist

  • The code change is tested and works locally.
  • Local tests pass. Your PR cannot be merged unless tests pass
  • There is no commented out code in this PR.
  • I have followed the development checklist
  • I have followed the perfect PR recommendations
  • The code has been formatted using Ruff (ruff format homeassistant tests)
  • Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

If the code communicates with devices, web services, or third-party tools:

  • The manifest file has all fields filled out correctly.
    Updated and included derived files by running: python3 -m script.hassfest.
  • New or updated dependencies have been added to requirements_all.txt.
    Updated by running python3 -m script.gen_requirements_all.
  • For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.
  • Untested files have been added to .coveragerc.

To help with the load of incoming pull requests:

Copy link

@home-assistant home-assistant bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @codesalatdev

It seems you haven't yet signed a CLA. Please do so here.

Once you do that we will be able to review and accept this pull request.

Thanks!

@home-assistant home-assistant bot marked this pull request as draft January 29, 2024 22:27
@home-assistant
Copy link

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

@home-assistant
Copy link

Hey there @corneyl, mind taking a look at this pull request as it has been labeled with an integration (picnic) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of picnic can trigger bot actions by commenting:

  • @home-assistant close Closes the pull request.
  • @home-assistant rename Awesome new title Renames the pull request.
  • @home-assistant reopen Reopen the pull request.
  • @home-assistant unassign picnic Removes the current integration label and assignees on the pull request, add the integration domain after the command.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the pull request.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the pull request.

Copy link
Member

@MartinHjelmare MartinHjelmare left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please clean up the no longer needed string copy of product_id on line 74.

@home-assistant home-assistant bot marked this pull request as draft January 30, 2024 08:06
Copy link
Member

@MartinHjelmare MartinHjelmare left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@codesalatdev codesalatdev marked this pull request as ready for review January 30, 2024 21:56
@frenck frenck merged commit 95fca44 into home-assistant:dev Jan 31, 2024
23 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Feb 1, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants