Skip to content

Make script services always respond when asked#95991

Merged
balloob merged 2 commits into
devfrom
make-script-always-respond
Jul 6, 2023
Merged

Make script services always respond when asked#95991
balloob merged 2 commits into
devfrom
make-script-always-respond

Conversation

@bramkragten
Copy link
Copy Markdown
Member

Proposed change

Script services are registered with SupportsResponse.OPTIONAL meaning:
The service optionally returns response data when asked by the caller.

This PR will make it always return a response when asked by the caller, also when the script itself doesn't return a response.

Previously we would throw because a service should respond a dict and the service responded None.

As follow up we could register script services for scripts that do not include a stop action with response_variable as SupportsResponse.NONE, but a script with a stop action could still return nothing on some paths, so this PR will still be needed.

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 #
  • 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 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.

To help with the load of incoming pull requests:

@home-assistant
Copy link
Copy Markdown
Contributor

home-assistant Bot commented Jul 6, 2023

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

Code owner commands

Code owners of script 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 script Removes the current integration label and assignees on the pull request, add the integration domain after the command.

@bramkragten bramkragten added this to the 2023.7.1 milestone Jul 6, 2023
@emontnemery emontnemery added the second-opinion-wanted Add this label when a reviewer needs a second opinion from another member. label Jul 6, 2023
Copy link
Copy Markdown
Contributor

@emontnemery emontnemery left a comment

Choose a reason for hiding this comment

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

LGTM, thanks @bramkragten 👍

@balloob balloob removed the second-opinion-wanted Add this label when a reviewer needs a second opinion from another member. label Jul 6, 2023
@balloob balloob merged commit 5d9533f into dev Jul 6, 2023
@balloob balloob deleted the make-script-always-respond branch July 6, 2023 14:48
balloob pushed a commit that referenced this pull request Jul 6, 2023
* Make script services always respond when asked

* Update test_init.py
@balloob balloob mentioned this pull request Jul 6, 2023
joostlek pushed a commit to joostlek/core that referenced this pull request Jul 6, 2023
* Make script services always respond when asked

* Update test_init.py
@github-actions github-actions Bot locked and limited conversation to collaborators Jul 7, 2023
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.

3 participants