Fix inconsistencies in slugify between frontend and core implementation

[Caius-Bonus]

Proposed change

Change behaviour of slugify
Replace all special characters.
Remove commas from in between numbers.
Don't replace & with "and"
Update the language specific letters with the string from the original gist.
Return "unknown" if slug is empty and "" if input is empty.

There are 3 things it doesn't exactly mimic:
The replacement of language specific characters is not done by the same library.
The Decimal and Hex Patterns (decimal and hexadecimal numbers preceded by "&#") are not handled the same way.

Benefits

This solves issues with renaming entity ids when renaming the device in home assistant. If the device id contains specific characters (special characters like ".", "&", etc.), the device name cannot be recognized in the entity id and it will not rename the entity.

Impact

It is a little unclear to me what the impact of this could be, because I don't know if these need to be reproducible. With that I mean: Needing to follow a strict format between different Home Assistant versions to allow for regeneration of the same slugified string for referencing data made with previous versions.

It is used for non-entities here, where I don't know if these need to be reproducible:

frontend/src/common/entity/state_color.ts

Line 67 in 16766f8

const stateKey = slugify(compareState, "_");

frontend/src/panels/lovelace/editor/view-editor/hui-view-editor.ts

Line 124 in 16766f8

config.path === slugify(this._config.title || "", "-"))

frontend/src/panels/lovelace/editor/view-editor/hui-view-editor.ts

Line 126 in 16766f8

config.path = slugify(config.title, "-");

frontend/src/panels/config/lovelace/dashboards/dialog-lovelace-dashboard-detail.ts

Line 246 in 16766f8

const slugifyTitle = slugify(title, "-");

It is used for non-entities here, where they don't seem like they need to be reproducible:

frontend/hassio/src/dialogs/backup/dialog-hassio-backup.ts

Line 355 in 16766f8

`home_assistant_backup_${slugify(this._computeName)}.tar`

frontend/src/panels/config/automation/trigger/types/ha-automation-trigger-webhook.ts

Line 74 in 16766f8

const urlSafeAlias = slugify(this._config?.alias || "", "-");

It is used for entities here (These need to be reproducible with the same format as in the back-end, but are not right now):

frontend/src/panels/config/integrations/integration-panels/zha/zha-device-card.ts

Line 139 in 16766f8

const oldDeviceEntityId = slugify(oldDeviceName);

frontend/src/panels/config/integrations/integration-panels/zha/zha-device-card.ts

Line 140 in 16766f8

const newDeviceEntityId = slugify(newDeviceName);

frontend/src/panels/config/script/ha-script-editor.ts

Line 622 in 16766f8

const aliasSlugify = slugify(alias);

frontend/src/panels/config/devices/ha-config-device-page.ts

Line 1363 in 16766f8

const oldSearch = slugify(oldDeviceName);

frontend/src/panels/config/devices/ha-config-device-page.ts

Line 1368 in 16766f8

slugify(newDeviceName)

Type of change

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

Example configuration

Additional information

• This PR fixes or closes issue: fixes Entity IDs are not always renamed when renaming a device #15757
• This PR is related to issue or discussion:
• Link to documentation pull request:

Checklist

• The code change is tested and works locally.
• There is no commented out code in this PR.
• 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

[home-assistant]

Hello @Caius-Bonus,

When attempting to inspect the commits of your pull request for CLA signature status among all authors we encountered commit(s) which were not linked to a GitHub account, thus not allowing us to determine their status(es).

The commits that are missing a linked GitHub account are the following:

• 4532afe36a1362bacb1df86f13ccf701c80b2dab - No email found attached to the commit.

Unfortunately, we are unable to accept this pull request until this situation is corrected.

Here are your options:

1. If you had an email address set for the commit that simply wasn't linked to your GitHub account you can link that email now and it will retroactively apply to your commits. The simplest way to do this is to click the link to one of the above commits and look for a blue question mark in a blue circle in the top left. Hovering over that bubble will show you what email address you used. Clicking on that button will take you to your email address settings on GitHub. Just add the email address on that page and you're all set. GitHub has more information about this option in their help center.

2. If you didn't use an email address at all, it was an invalid email, or it's one you can't link to your GitHub, you will need to change the authorship information of the commit and your global Git settings so this doesn't happen again going forward. GitHub provides some great instructions on how to change your authorship information in their help center.

   • If you only made a single commit you should be able to run

     git commit --amend --author="Author Name <[email protected]>"
     

     (substituting "Author Name" and "[email protected]" for your actual information) to set the authorship information.
   • If you made more than one commit and the commit with the missing authorship information is not the most recent one you have two options:
     1. You can re-create all commits missing authorship information. This is going to be the easiest solution for developers that aren't extremely confident in their Git and command line skills.
     2. You can use this script that GitHub provides to rewrite history. Please note: this should be used only if you are very confident in your abilities and understand its impacts.
   • Whichever method you choose, I will come by to re-check the pull request once you push the fixes to this branch.

We apologize for this inconvenience, especially since it usually bites new contributors to Home Assistant. We hope you understand the need for us to protect ourselves and the great community we all have built legally. The best thing to come out of this is that you only need to fix this once and it benefits the entire Home Assistant and GitHub community.

Thanks, I look forward to checking this PR again soon! ❤️

[home-assistant]

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.

Stale

[bdraco]

Confirmed this now matches the backend

>>> from homeassistant.util import slugify
>>> slugify("abc.DEF")
'abc_def'
>>> 

[bdraco]

Specifically its used here

frontend/src/panels/config/integrations/integration-panels/zha/zha-device-card.ts

Line 139 in 16766f8

const oldDeviceEntityId = slugify(oldDeviceName);

This seems brittle as it relies on the slugify implementation matching perfectly

[Caius-Bonus]

I agree that this is brittle. As I have understood the functionality, it needs to replace the part of the id that was supposed to be the device name (which should be at the start of the id). I don't know of another way to do this than by string comparison unfortunately.

[Caius-Bonus]

I've looked at the backend code for slugify. I think it is not that complicated. It is a very barebones algorithm. I think I got it working the same now as back-end. However, the behaviour is now significantly altered. As long as nothing depends on the old names, this should be fine and increase compatibility with the back-end.