Fix missing context when running script from template entity

[emontnemery]

Proposed change

Fix missing context when running script from template entity

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 Trigger Update Coordinator: Running script requires passing in a context #99914
• 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
• 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.

If user exposed functionality or configuration variables are added/changed:

• Documentation added/updated for www.home-assistant.io

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.

To help with the load of incoming pull requests:

• I have reviewed two other open pull requests in this repository.

[home-assistant]

Hey there @PhracturedBlue, @tetienne, @home-assistant/core, mind taking a look at this pull request as it has been labeled with an integration (template) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of template 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 template 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.

[frenck]

Thanks, @emontnemery 👍

../Frenck

[allenporter]

Thank you for the fix

[akloeckner]

Question: does this new context need to produce an event in order for it to be traceable? As is done for automations? See #21028

[FlorianOosterhof]

Question: does this new context need to produce an event in order for it to be traceable? As is done for automations? See #21028

Sounds like exactly what was done in this PR which was never reviewed and eventually marked stale: #102975

[akloeckner]

Sounds like exactly what was done in this PR which was never reviewed and eventually marked stale: #102975

Yes. That's why I'm asking. (Plus, I'd like to understand more about the way context is supposed to be used.) Here's why the PR's author stopped developing it, in case this helps: #99914 (comment) . Maybe now, with core developers involved, the problem has a better chance to be solved. And be it simply by defining "no event needed". ;-)

[emontnemery]

I think this PR can be merged as is, the behavior is not changed but the warning is gone.

The point of the context is to make it clear in the logbook why something happened, firing an event as done in the linked PR seems a bit roundabout but it is indeed the only way to make that work.

It does however need additional changes, the template integration needs a logbook platform, like this from the automation integration:

core/homeassistant/components/automation/logbook.py

Lines 18 to 40 in 75ec39c

	@callback
	def async_describe_events(hass: HomeAssistant, async_describe_event): # type: ignore[no-untyped-def]
	"""Describe logbook events."""
	@callback
	def async_describe_logbook_event(event: LazyEventPartialState): # type: ignore[no-untyped-def]
	"""Describe a logbook event."""
	data = event.data
	message = "triggered"
	if ATTR_SOURCE in data:
	message = f"{message} by {data[ATTR_SOURCE]}"
	return {
	LOGBOOK_ENTRY_NAME: data.get(ATTR_NAME),
	LOGBOOK_ENTRY_MESSAGE: message,
	LOGBOOK_ENTRY_SOURCE: data.get(ATTR_SOURCE),
	LOGBOOK_ENTRY_ENTITY_ID: data.get(ATTR_ENTITY_ID),
	LOGBOOK_ENTRY_CONTEXT_ID: event.context_id,
	}
	async_describe_event(
	DOMAIN, EVENT_AUTOMATION_TRIGGERED, async_describe_logbook_event
	)

The event data also needs a reference to the trigger:

core/homeassistant/components/automation/__init__.py

Lines 648 to 653 in 75ec39c

	event_data = {
	ATTR_NAME: self.name,
	ATTR_ENTITY_ID: self.entity_id,
	}
	if "trigger" in variables and "description" in variables["trigger"]:
	event_data[ATTR_SOURCE] = variables["trigger"]["description"]

I think we can add that in a follow-up PR, targeting the 2024.4 release.

[akloeckner]

Thanks for clarifying! 👍

[doug-hoffman]

I think this PR can be merged as is, the behavior is not changed but the warning is gone.

Creating a new context without firing an event does change the current behavior, as I mentioned in #99914 (comment).

When we create a new context in the template component, it happens much earlier than when it is done in association with the warning. As a result, it becomes possible that an event may fire and be associated with that context. If the action section is used within the template block, it is very likely an event will fire. (In my testing, I observed this with call_service events being blamed for subsequent state changes.)

[akloeckner]

In my testing, I observed this with call_service events being blamed for subsequent state changes.

TL;DR I was curious and I think this can already happen with the current implementation.

Example

A template with a time trigger and actions will simply update (giving the known warnings) and not blame its change on anything in the logbook:

template:
- trigger:
  - platform: time_pattern
    seconds: "/15"
  action:
  - service: rest_command.signal_receive
    response_variable: response
  sensor:
  - name: Signal message received
    device_class: timestamp
    state: >
      {% set content = response['content'] | from_json %}
      {% if response['status'] == 200 and content is sequence and content|length > 0 %}
        {{ (content[0]['envelope']['timestamp']/1000) | as_datetime }}
      {% else %}
        {{ this.state if this else None }}
      {% endif %}

If I substitute the trigger with a template trigger, (where the sensor.now essentially is now()) the change will be blamed on the service call in the actions (with no warnings):

template:
- trigger:
  - platform: template
    value_template: "{{ as_datetime(states('sensor.now'), now()).second % 15 == 0 }}"
  action:
  - service: rest_command.signal_receive
    response_variable: response
  sensor:
  - name: Signal message received
    device_class: timestamp
    state: >
      {% set content = response['content'] | from_json %}
      {% if response['status'] == 200 and content is sequence and content|length > 0 %}
        {{ (content[0]['envelope']['timestamp']/1000) | as_datetime }}
      {% else %}
        {{ this.state if this else None }}
      {% endif %}

So, in my opinion, the fix here will make it better and a subsequent PR, maybe preceded by some discussion as you suggested, may then clean up the greater context.

[emontnemery]

I think this PR can be merged as is, the behavior is not changed but the warning is gone.

Creating a new context without firing an event does change the current behavior, as I mentioned in #99914 (comment).

When we create a new context in the template component, it happens much earlier than when it is done in association with the warning. As a result, it becomes possible that an event may fire and be associated with that context. If the action section is used within the template block, it is very likely an event will fire. (In my testing, I observed this with call_service events being blamed for subsequent state changes.)

OK, this is an interesting point. Could you share an example of a template entity configuration which causes confusing logbook entries with the changes in this PR?