Skip to content

Introduce Home Assistant Labs #156840

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.

Sign up for GitHub

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

Merged
frenck merged 10 commits into from
Nov 20, 2025
Merged

Introduce Home Assistant Labs #156840

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
aa522ff
Introduce Home Assistant Labs
frenck Nov 18, 2025
fe23b0a
Pre-load feature URLs to avoid additional manifest loops
frenck Nov 19, 2025
30c72f4
Add labs_features property to Integration class improving typing
frenck Nov 19, 2025
d85cf6a
Remove async_setup from exported symbols in labs integration and fix …
frenck Nov 19, 2025
d678e4a
Add EventLabsUpdatedData type for improved event handling
frenck Nov 19, 2025
b8d7192
Adjust moment labs is being bootstrapped
frenck Nov 19, 2025
3cf100c
Consistently use the 'preview' term
frenck Nov 19, 2025
e51b914
Add backup feature while changing feature flag
frenck Nov 19, 2025
2270859
Refactor including backup support
frenck Nov 20, 2025
3e1e4d0
Clean up unused fixtures caught by CoPilot
frenck Nov 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CODEOWNERS
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 3 additions & 0 deletions homeassistant/bootstrap.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,6 +176,8 @@
STAGE_0_INTEGRATIONS = (
# Load logging and http deps as soon as possible
("logging, http deps", LOGGING_AND_HTTP_DEPS_INTEGRATIONS, None),
# Setup labs for preview features
("labs", {"labs"}, STAGE_0_SUBSTAGE_TIMEOUT),
# Setup frontend
("frontend", FRONTEND_INTEGRATIONS, None),
# Setup recorder
Expand Down Expand Up @@ -212,6 +214,7 @@
"backup",
"frontend",
"hardware",
"labs",
"logger",
"network",
"system_health",
Expand Down
51 changes: 49 additions & 2 deletions homeassistant/components/kitchen_sink/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,11 @@

import voluptuous as vol

from homeassistant.components.labs import (
EVENT_LABS_UPDATED,
EventLabsUpdatedData,
async_is_preview_feature_enabled,
)
from homeassistant.components.recorder import DOMAIN as RECORDER_DOMAIN, get_instance
from homeassistant.components.recorder.models import (
StatisticData,
Expand All @@ -30,10 +35,14 @@
UnitOfTemperature,
UnitOfVolume,
)
from homeassistant.core import HomeAssistant, ServiceCall, callback
from homeassistant.core import Event, HomeAssistant, ServiceCall, callback
from homeassistant.helpers import config_validation as cv
from homeassistant.helpers.device_registry import DeviceEntry
from homeassistant.helpers.issue_registry import IssueSeverity, async_create_issue
from homeassistant.helpers.issue_registry import (
IssueSeverity,
async_create_issue,
async_delete_issue,
)
from homeassistant.helpers.typing import ConfigType
from homeassistant.util import dt as dt_util
from homeassistant.util.unit_conversion import (
Expand Down Expand Up @@ -110,6 +119,23 @@ async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
# Notify backup listeners
hass.async_create_task(_notify_backup_listeners(hass), eager_start=False)

# Subscribe to labs feature updates for kitchen_sink preview repair
@callback
def _async_labs_updated(event: Event[EventLabsUpdatedData]) -> None:
Copy link
Copy Markdown
Contributor

@mik-laj mik-laj Nov 21, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

I wonder if this API could be simplified a bit by creating a helper function to create this listener function.

I'm thinking of something similar to the one below.

    entry.async_on_unload(
        preview_features.async_listen(
            domain="kitchen_sink", 
            preview_feature="special_repair",
            listener=lambda: _async_update_special_repair(hass)
        )
    )

This way, the integration author does not have to wonder whether Futures Lab uses the event bus and what the message format is.

This will slightly extend the existing public API we currently have.

async_is_preview_feature_enabled(hass, DOMAIN, "special_repair"):

Copy link
Copy Markdown
Member

@MartinHjelmare MartinHjelmare Nov 21, 2025

Choose a reason for hiding this comment

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

Yeah, we tend to avoid using core events nowadays for things that aren't user facing.

"""Handle labs feature update event."""
if (
event.data["domain"] == "kitchen_sink"
Copy link
Copy Markdown
Contributor

@mik-laj mik-laj Nov 21, 2025

Choose a reason for hiding this comment

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

Can we use DOMAIN const here?

Copy link
Copy Markdown
Member Author

@frenck frenck Nov 21, 2025

Choose a reason for hiding this comment

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

we don't have to, it is typed already.

Copy link
Copy Markdown
Member Author

@frenck frenck Nov 21, 2025

Choose a reason for hiding this comment

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

oh sorry the domain constant using kitchen_sink; yeah sure 👍

and event.data["preview_feature"] == "special_repair"
):
_async_update_special_repair(hass)

entry.async_on_unload(
hass.bus.async_listen(EVENT_LABS_UPDATED, _async_labs_updated)
)

# Check if lab feature is currently enabled and create repair if so
_async_update_special_repair(hass)

return True


Expand Down Expand Up @@ -137,6 +163,27 @@ async def async_remove_config_entry_device(
return True


@callback
def _async_update_special_repair(hass: HomeAssistant) -> None:
"""Create or delete the special repair issue.

Creates a repair issue when the special_repair lab feature is enabled,
and deletes it when disabled. This demonstrates how lab features can interact
with Home Assistant's repair system.
"""
if async_is_preview_feature_enabled(hass, DOMAIN, "special_repair"):
async_create_issue(
hass,
DOMAIN,
"kitchen_sink_special_repair_issue",
is_fixable=False,
severity=IssueSeverity.WARNING,
translation_key="special_repair",
)
else:
async_delete_issue(hass, DOMAIN, "kitchen_sink_special_repair_issue")


async def _notify_backup_listeners(hass: HomeAssistant) -> None:
for listener in hass.data.get(DATA_BACKUP_AGENT_LISTENERS, []):
listener()
Expand Down
7 changes: 7 additions & 0 deletions homeassistant/components/kitchen_sink/manifest.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,13 @@
"codeowners": ["@home-assistant/core"],
"documentation": "https://www.home-assistant.io/integrations/kitchen_sink",
"iot_class": "calculated",
"preview_features": {
"special_repair": {
"feedback_url": "https://community.home-assistant.io",
"learn_more_url": "https://www.home-assistant.io/integrations/kitchen_sink",
"report_issue_url": "https://github.com/home-assistant/core/issues/new?template=bug_report.yml&integration_link=https://www.home-assistant.io/integrations/kitchen_sink&integration_name=Kitchen%20Sink"
}
},
"quality_scale": "internal",
"single_config_entry": true
}
12 changes: 12 additions & 0 deletions homeassistant/components/kitchen_sink/strings.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,10 @@
},
"title": "The blinker fluid is empty and needs to be refilled"
},
"special_repair": {
"description": "This is a special repair created by a preview feature! This demonstrates how lab features can interact with the Home Assistant repair system. You can disable this by turning off the kitchen sink special repair feature in Settings > System > Labs.",
"title": "Special repair feature preview"
},
"transmogrifier_deprecated": {
"description": "The transmogrifier component is now deprecated due to the lack of local control available in the new API",
"title": "The transmogrifier component is deprecated"
Expand Down Expand Up @@ -103,6 +107,14 @@
}
}
},
"preview_features": {
"special_repair": {
"description": "Creates a **special repair issue** when enabled.\n\nThis demonstrates how lab features can interact with other Home Assistant integrations.",
"disable_confirmation": "This will remove the special repair issue. Don't worry, this is just a demonstration feature.",
"enable_confirmation": "This will create a special repair issue to demonstrate Labs preview features. This is just an example and won't affect your actual system.",
"name": "Special repair"
}
},
"services": {
"test_service_1": {
"description": "Fake action for testing",
Expand Down
Loading
Loading