Repository: home-assistant/core
Pull request: Fix duplicated resource issue in System Monitor
<!--
  You are amazing! Thanks for contributing to our project!
  Please, DO NOT DELETE ANY TEXT from this template! (unless instructed).
-->
## Proposed change
<!--
  Describe the big picture of your changes here to communicate to the
  maintainers why we should accept this pull request. If it fixes a bug
  or resolves a feature request, be sure to link to that issue in the
  additional information section.
-->
Given that arguments can be typed in many ways it results in duplicated unique id's.
Slugify the loaded resources in the comparison to avoid this.

## Type of change
<!--
  What type of change does your PR introduce to Home Assistant?
  NOTE: Please, check only 1! box!
  If your PR requires multiple boxes to be checked, you'll most likely need to
  split it into multiple PRs. This makes things easier and faster to code review.
-->

- [ ] Dependency upgrade
- [x] 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
<!--
  Details are important, and help maintainers processing your PR.
  Please be sure to fill out additional details, if applicable.
-->

- This PR fixes or closes issue: fixes #107532
- This PR is related to issue: 
- Link to documentation pull request: 

## Checklist
<!--
  Put an `x` in the boxes that apply. You can also fill these out after
  creating the PR. If you're unsure about any of them, don't hesitate to ask.
  We're here to help! This is simply a reminder of what we are going to look
  for before merging your code.
-->

- [ ] The code change is tested and works locally.
- [x] Local tests pass. **Your PR cannot be merged unless tests pass**
- [x] There is no commented out code in this PR.
- [x] I have followed the [development checklist][dev-checklist]
- [x] I have followed the [perfect PR recommendations][perfect-pr]
- [x] 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:

- [ ] Documentation added/updated for [www.home-assistant.io][docs-repository]

If the code communicates with devices, web services, or third-party tools:

- [ ] The [manifest file][manifest-docs] 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`.

<!--
  This project is very active and we have a high turnover of pull requests.

  Unfortunately, the number of incoming pull requests is higher than what our
  reviewers can review and merge so there is a long backlog of pull requests
  waiting for review. You can help here!
  
  By reviewing another pull request, you will help raise the code quality of
  that pull request and the final review will be faster. This way the general
  pace of pull request reviews will go up and your wait time will go down.
  
  When picking a pull request to review, try to choose one that hasn't yet
  been reviewed.

  Thanks for helping out!
-->

To help with the load of incoming pull requests:

- [x] I have reviewed two other [open pull requests][prs] in this repository.

[prs]: https://github.com/home-assistant/core/pulls?q=is%3Aopen+is%3Apr+-author%3A%40me+-draft%3Atrue+-label%3Awaiting-for-upstream+sort%3Acreated-desc+review%3Anone+-status%3Afailure

<!--
  Thank you for contributing <3

  Below, some useful links you could explore:
-->
[dev-checklist]: https://developers.home-assistant.io/docs/development_checklist/
[manifest-docs]: https://developers.home-assistant.io/docs/creating_integration_manifest/
[quality-scale]: https://developers.home-assistant.io/docs/integration_quality_scale_index/
[docs-repository]: https://github.com/home-assistant/home-assistant.io
[perfect-pr]: https://developers.home-assistant.io/docs/review-process/#creating-the-perfect-pr


Problem statement:
Systemmonitor does not generate unique IDs
### The problem

After update to 2014.1 

Sensor works but HA reports this error.
It's a sensor from the external drive.


Platform systemmonitor does not generate unique IDs. ID disk_use_media_storage already exists - ignoring sensor.disk_use_media_storage
Platform systemmonitor does not generate unique IDs. ID disk_use_percent_media_storage already exists - ignoring sensor.disk_use_percent_media_storage





### What version of Home Assistant Core has the issue?

core-2024.1.2

### What was the last working version of Home Assistant Core?

core-2013.12.4

### What type of installation are you running?

Home Assistant OS

### Integration causing the issue

system monitor

### Link to integration documentation on our website

_No response_

### Diagnostics information

_No response_

### Example YAML snippet

_No response_

### Anything in the logs that might be useful for us?

_No response_

### Additional information

_No response_

Hints from issue discussion:
Hey there @gjohansson-st, mind taking a look at this issue as it has been labeled with an integration (`systemmonitor`) you are listed as a [code owner](https://github.com/home-assistant/core/blob/dev/CODEOWNERS#L1305) for? Thanks!

<details>
<summary>Code owner commands</summary>


Code owners of `systemmonitor` can trigger bot actions by commenting:

- `@home-assistant close` Closes the issue.
- `@home-assistant rename Awesome new title` Renames the issue.
- `@home-assistant reopen` Reopen the issue.
- `@home-assistant unassign systemmonitor` Removes the current integration label and assignees on the issue, 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 issue.
- `@home-assistant remove-label needs-more-information` Remove a label (needs-more-information, problem in dependency, problem in custom component) on the issue.

</details>


<sub><sup>(message by CodeOwnersMention)</sup></sub>

---

[systemmonitor documentation](https://www.home-assistant.io/integrations/systemmonitor)
[systemmonitor source](https://github.com/home-assistant/core/tree/dev/homeassistant/components/systemmonitor)
<sub><sup>(message by IssueLinks)</sup></sub>
Could you have ended up with two config entries for System Monitor somehow?
After updating HA to version 2024.1.2, my configuration was imported from yaml.  All sensors showed up in the UI.  All of them work, but this error is displayed in the log.  Yaml from version 2023.12.4 : sensor:
  #==============================
 # - platform: systemmonitor
 # resources:
 # - type: processor_use
 # - type: load_1m
 # - type: load_5m
 # - type: load_15m
 # - type: memory_use
 # - type: memory_use_percent
 # - type: swap_use
 # - type: swap_use_percent
 # - type: disk_use
 # - type: disk_use_percent
 # - type: disk_use
 # arg: /media/STORAGE/
 # - type: disk_use_percent
 # arg: /media/STORAGE/
 # - type: last_boot
 # - type: network_in
 # arg: end0
 # - type: network_out
 # arg: end0
Thanks. I have spotted the issue and will make a fix for it 👍

Commit message: Fix duplicated resource issue

Patch to review:
diff --git a/homeassistant/components/systemmonitor/sensor.py b/homeassistant/components/systemmonitor/sensor.py
index 28929d07a7c8c..14b55fe562dc5 100644
--- a/homeassistant/components/systemmonitor/sensor.py
+++ b/homeassistant/components/systemmonitor/sensor.py
@@ -405,7 +405,7 @@ async def async_setup_entry(
                 is_enabled = check_legacy_resource(
                     f"{_type}_{argument}", legacy_resources
                 )
-                loaded_resources.add(f"{_type}_{argument}")
+                loaded_resources.add(slugify(f"{_type}_{argument}"))
                 entities.append(
                     SystemMonitorSensor(
                         sensor_registry,
@@ -425,7 +425,7 @@ async def async_setup_entry(
                 is_enabled = check_legacy_resource(
                     f"{_type}_{argument}", legacy_resources
                 )
-                loaded_resources.add(f"{_type}_{argument}")
+                loaded_resources.add(slugify(f"{_type}_{argument}"))
                 entities.append(
                     SystemMonitorSensor(
                         sensor_registry,
@@ -449,7 +449,7 @@ async def async_setup_entry(
                 sensor_registry[(_type, argument)] = SensorData(
                     argument, None, None, None, None
                 )
-                loaded_resources.add(f"{_type}_{argument}")
+                loaded_resources.add(slugify(f"{_type}_{argument}"))
                 entities.append(
                     SystemMonitorSensor(
                         sensor_registry,
@@ -463,7 +463,7 @@ async def async_setup_entry(
 
         sensor_registry[(_type, "")] = SensorData("", None, None, None, None)
         is_enabled = check_legacy_resource(f"{_type}_", legacy_resources)
-        loaded_resources.add(f"{_type}_")
+        loaded_resources.add(slugify(f"{_type}_"))
         entities.append(
             SystemMonitorSensor(
                 sensor_registry,
@@ -479,9 +479,11 @@ async def async_setup_entry(
     for resource in legacy_resources:
         if resource.startswith("disk_"):
             _LOGGER.debug(
-                "Check resource %s already loaded in %s", resource, loaded_resources
+                "Check resource %s already loaded in %s",
+                slugify(resource),
+                loaded_resources,
             )
-            if resource not in loaded_resources:
+            if slugify(resource) not in loaded_resources:
                 split_index = resource.rfind("_")
                 _type = resource[:split_index]
                 argument = resource[split_index + 1 :]


Code review comments:
diff_hunk: @@ -463,7 +463,7 @@ async def async_setup_entry(
 
         sensor_registry[(_type, "")] = SensorData("", None, None, None, None)
         is_enabled = check_legacy_resource(f"{_type}_", legacy_resources)
-        loaded_resources.add(f"{_type}_")
+        loaded_resources.add(slugify(f"{_type}_"))
path: homeassistant/components/systemmonitor/sensor.py
text: @user1:
Is this needed for `_type` as it is used as a key for `SENSOR_TYPES` and should always match the sensor description key?


@user2:
If all types are already slugs we don't need it, I think. But otherwise we do need it to allow the comparison.

@author:
I did it like this to make it easy and comparable (consistent) all the way. Types are already slugs so it's the arguments really which needs to be slugified and obviously then not this one at all.