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

Update nest to only include the image attachment payload for cameras that support fetching media #124590

Merged
merged 1 commit into from
Aug 31, 2024

Conversation

allenporter
Copy link
Contributor

@allenporter allenporter commented Aug 25, 2024

Proposed change

Follow up to #124554 to only include the "image" attachment based on device properties. When updating the documentation I remembered that not all devices support attachments and now this will be more clear since we can omit the image attachment from the device trigger payload.

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: fixes #
  • This PR is related to issue:
  • Link to documentation pull request:

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.

To help with the load of incoming pull requests:

@bdraco
Copy link
Member

bdraco commented Aug 25, 2024

I think the PR # has a typo in the opening text.

@allenporter
Copy link
Contributor Author

I think the PR # has a typo in the opening text.

Thanks, fixed, should have been 124554

if not (
device_manager := self._hass.data[DOMAIN]
.get(self._config_entry_id, {})
.get(DATA_DEVICE_MANAGER)
) or not (device := device_manager.devices.get(device_id)):
return False
return TraitType.CAMERA_CLIP_PREVIEW in device.traits
return []
Copy link
Member

Choose a reason for hiding this comment

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

Missing coverage on this line

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is complex to test because it involves a race, and is a bit theoretical. This can happen when there is a race on initialization where a pubsub message is received before the device manager has been registered.

The subscriber is started first and registers this callback. Then the device manager is initialized and registered. it happens in this order because otherwise there is a race where the device manager will fetch initial state, then a message is published which isn't received, and we are missing state. Therefore we first subscribe and then fetch initial state.

Adding coverage for this could involve patching and making the device manager block, then sending messages and verifying they are received -- but the integration wouldn't have finished setup by then so its kind of odd.

If you have suggestions for a different approach i am open to it.

@balloob
Copy link
Member

balloob commented Aug 31, 2024

Should this be tagged for the next release?

@allenporter allenporter added this to the 2024.10.0b0 milestone Aug 31, 2024
@allenporter
Copy link
Contributor Author

Yeah good call, i didn't realize this didn't make it in.

@allenporter allenporter merged commit 93afc94 into home-assistant:dev Aug 31, 2024
26 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Sep 1, 2024
@joostlek joostlek modified the milestones: 2024.10.0b0, 2024.9.0 Sep 3, 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.

5 participants