Skip to content

Redact additional unnecessary diagnostic fields#159546

Merged
allenporter merged 2 commits into
home-assistant:devfrom
allenporter:roborock-redact
Dec 21, 2025
Merged

Redact additional unnecessary diagnostic fields#159546
allenporter merged 2 commits into
home-assistant:devfrom
allenporter:roborock-redact

Conversation

@allenporter
Copy link
Copy Markdown
Contributor

Proposed change

Redact additional unnecessary diagnostic fields

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:
  • Link to developer documentation pull request:
  • Link to frontend pull request:

Checklist

  • I understand the code I am submitting and can explain how it works.
  • 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.
  • Any generated code has been carefully reviewed for correctness and compliance with project standards.

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:

Copilot AI review requested due to automatic review settings December 21, 2025 15:16
@home-assistant
Copy link
Copy Markdown
Contributor

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

Code owner commands

Code owners of roborock 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 roborock 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
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR enhances privacy protection in the Roborock integration by expanding the list of fields that are redacted from diagnostic data. The changes prevent exposure of user-identifiable and authentication-related information when users share diagnostics.

Key changes:

  • Expands the TO_REDACT_CONFIG list to include 8 additional fields: h, k, s, u (IoT service authentication fields within the rriot object), avatarurl, nickname, tuyaUuid, and extra
  • Updates test snapshots to reflect that these fields are now properly redacted as **REDACTED** instead of showing actual values

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
homeassistant/components/roborock/diagnostics.py Expands TO_REDACT_CONFIG list to redact 8 additional sensitive fields (user profile data and IoT authentication credentials)
tests/components/roborock/snapshots/test_diagnostics.ambr Updates test snapshot to verify that avatarurl, nickname, and rriot authentication fields (h, k, s, u) are now properly redacted

The changes appropriately protect user privacy by redacting fields containing personal identifiers (avatar URLs, nicknames) and authentication credentials (IoT service tokens). The test snapshots correctly reflect these redactions. No issues found.

@allenporter allenporter merged commit 0710cf3 into home-assistant:dev Dec 21, 2025
36 checks passed
@github-actions github-actions Bot locked and limited conversation to collaborators Dec 22, 2025
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.

4 participants