Skip to content
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

Jump to bottom

Set correct response value in service description when async_set_service_schema is used #95985

Merged
merged 4 commits into from
Jul 6, 2023
Merged

Set correct response value in service description when async_set_service_schema is used #95985

merged 4 commits into from
Jul 6, 2023

Conversation

bramkragten
Copy link
Member

@bramkragten bramkragten commented Jul 6, 2023 •
edited
Loading

Proposed change

Set the correct response value when async_set_service_schema is used. This was only done in async_get_all_descriptions, but scripts will never get there as they are added with async_set_service_schema.

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:

@bramkragten bramkragten requested a review from a team as a code owner July 6, 2023 09:41
@bramkragten bramkragten added this to the 2023.7.1 milestone Jul 6, 2023
@home-assistant
Copy link

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.

@MartinHjelmare MartinHjelmare changed the title Mark scripts as response optional, make it always return a response i… Mark scripts as response optional Jul 6, 2023
@emontnemery
Copy link
Contributor

I think this PR should be split in two:

  • A PR which makes it safe for a script to not always return something
  • A PR which adds the response flag to services

@bramkragten bramkragten changed the title Mark scripts as response optional Set correct response value in service description when async_set_service_schema is used Jul 6, 2023
emontnemery
emontnemery approved these changes Jul 6, 2023
View reviewed changes
Copy link
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.

Thanks, @bramkragten 👍

@balloob balloob merged commit 342d07c into dev Jul 6, 2023
@balloob balloob deleted the scripts-response branch July 6, 2023 14:24
balloob pushed a commit that referenced this pull request Jul 6, 2023
@bramkragten @balloob
Set correct response value in service description when `async_set_s…
3540c78 
…ervice_schema` is used (#95985)

* Mark scripts as response optional, make it always return a response if return_response is set

* Update test_init.py

* Revert "Update test_init.py"

This reverts commit 8e113e5.

* Split + add test
@balloob balloob mentioned this pull request Jul 6, 2023
Merged
joostlek pushed a commit to joostlek/core that referenced this pull request Jul 6, 2023
@bramkragten @joostlek
Set correct response value in service description when `async_set_s…
002baab 
…ervice_schema` is used (home-assistant#95985)

* Mark scripts as response optional, make it always return a response if return_response is set

* Update test_init.py

* Revert "Update test_init.py"

This reverts commit 8e113e5.

* Split + add test
@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.
Reviewers

@balloob balloob balloob approved these changes

@emontnemery emontnemery emontnemery approved these changes

Assignees
No one assigned
Labels
bugfix cherry-picked cla-signed core integration: script Quality Scale: internal small-pr PRs with less than 30 lines.
Projects
None yet
Milestone
2023.7.1
Development

Successfully merging this pull request may close these issues.
3 participants
@bramkragten @emontnemery @balloob