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

Add data to service extensions for services that lacks metadata #1093

Merged
merged 7 commits into from
May 8, 2024
Merged

Add data to service extensions for services that lacks metadata #1093

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
b1f5b22
Added a way to send data to generated service call extensions for mis…
helto4real May 7, 2024
aaf85ea
Add all generated files in .gitignore
helto4real May 7, 2024
e61dee2
Add the optional data parameters to service declarations too for serv…
helto4real May 7, 2024
fe15b06
Fix test and bug found when doint tests :)
helto4real May 7, 2024
712d00c
Added a non target cast to the test
helto4real May 7, 2024
e96034f
Fix for the target to get passed too
helto4real May 7, 2024
efd030a
Small refactor using helper method to join arguments
FrankBakkerNl May 7, 2024
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
8 changes: 7 additions & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,11 +55,17 @@ codecover_merged.info
# User-specific files
.idea/
appsettings.Development.json
appsettings.development.json

**/core

**/coverage.json

# remove HA integration test files from git
tests/Integration/HA/config/*
!tests/Integration/HA/config/*.yaml
!tests/Integration/HA/config/*.yaml

# remove codegenerated files
HomeAssistantGenerated.cs
EntityMetaData.json
ServicesMetaData.json
4 changes: 2 additions & 2 deletions src/HassModel/NetDaemon.HassModel.CodeGenerator/CodeGeneration/ExtensionMethodsGenerator.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,9 +85,9 @@ private static IEnumerable<MemberDeclarationSyntax> GenerateExtensionMethodsForS
private static MemberDeclarationSyntax ExtensionMethodWithoutArguments(HassService service, string serviceName, string entityTypeName)
{
return ParseMemberDeclaration($$"""
public static void {{GetServiceMethodName(serviceName)}}(this {{entityTypeName}} target)
public static void {{GetServiceMethodName(serviceName)}}(this {{entityTypeName}} target, object? data = null)
{
target.CallService("{{serviceName}}");
target.CallService("{{serviceName}}", data);
}
""")!
.WithSummaryComment(service.Description);
Expand Down
2 changes: 1 addition & 1 deletion src/HassModel/NetDaemon.HassModel.CodeGenerator/CodeGeneration/Generator.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ private static SyntaxTrivia[] GetFileHeader()
// In the template projects we provided a convenience powershell script that will update
// the codegen and nugets to latest versions update_all_dependencies.ps1.
//
// For more information: https://netdaemon.xyz/docs/v3/hass_model/hass_model_codegen
// For more information: https://netdaemon.xyz/docs/user/hass_model/hass_model_codegen
// For more information about NetDaemon: https://netdaemon.xyz/
// </auto-generated>
//------------------------------------------------------------------------------";
Expand Down
2 changes: 2 additions & 0 deletions src/HassModel/NetDaemon.HassModel.CodeGenerator/CodeGeneration/ServicesGenerator.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,8 @@ private static IEnumerable<MemberDeclarationSyntax> GenerateServiceMethod(string

if (serviceArguments is null)
{
targetParam = "object? data";
Copy link
Contributor

Choose a reason for hiding this comment

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

I think traget is the ServiceTarget, eg the Entitiy, Area, Floor etc. This can be present or not regardless of how many servcieArguments there are. So you need to join them like is done at the third yield. (maybe reorganize so the code does not need to be duplicated)

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

This is the case when there are no service arguments, today it does not generate any input. Not sure I follow. I will check it out.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

 // method using arguments as separate parameters
            yield return ParseMemberDeclaration($$"""
                        void {{serviceMethodName}}({{JoinList(targetParam, serviceArguments.GetParametersList())}})

that third yield is when there are service targets. This is the not the case here. I only want to add the data option if there are no targets.

Copy link
Contributor

Choose a reason for hiding this comment

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

It is the correct case indeed, just that you now override the serviceTarget with the data parameter.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I added tests and the case you were talking about in Discord. Actually found the problem when I did the test 👍

targetArg = "null, data";
// method without arguments
yield return ParseMemberDeclaration($$"""
void {{serviceMethodName}}({{targetParam}})
Expand Down
Loading