Skip to content

Redact data from zwave_js diagnostics#68348

Merged
raman325 merged 2 commits intohome-assistant:devfrom
raman325:redact
Mar 19, 2022
Merged

Redact data from zwave_js diagnostics#68348
raman325 merged 2 commits intohome-assistant:devfrom
raman325:redact

Conversation

@raman325
Copy link
Copy Markdown
Contributor

@raman325 raman325 commented Mar 18, 2022

Proposed change

We get no value from the home ID and a node's location, so may as well remove them from the diagnostic dumps

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)
  • 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
  • The code has been formatted using Black (black --fast 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.

The integration reached or maintains the following Integration Quality Scale:

  • No score or internal
  • 🥈 Silver
  • 🥇 Gold
  • 🏆 Platinum

To help with the load of incoming pull requests:

@probot-home-assistant
Copy link
Copy Markdown

Hey there @home-assistant/z-wave, mind taking a look at this pull request as it has been labeled with an integration (zwave_js) you are listed as a code owner for? Thanks!
(message by CodeOwnersMention)

Copy link
Copy Markdown
Contributor

@kpine kpine left a comment

Choose a reason for hiding this comment

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

Would be nice to redact lock user codes as well. Not quite as simple a change.

@raman325 raman325 changed the title Redact home ID and location from zwave_js diagnostics Redact data from zwave_js diagnostics Mar 19, 2022
@raman325
Copy link
Copy Markdown
Contributor Author

raman325 commented Mar 19, 2022

That's a great idea. I'll do that in a separate PR since that will require a custom redaction helper. I also want to add the device ID and some entity information for each device and I will have to partially redact the unique ID/device ID to remove the home ID

@raman325 raman325 merged commit 4578de6 into home-assistant:dev Mar 19, 2022
@raman325 raman325 deleted the redact branch March 19, 2022 06:46
@github-actions github-actions bot locked and limited conversation to collaborators Mar 20, 2022
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