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.

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 support for default values #153

Merged
merged 2 commits into from
Sep 26, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,7 @@ public WorkflowDefinition Build()
foreach (var prop in props)
{
var isRequired = prop.GetCustomAttribute<RequiredAttribute>();
var defaultValue = prop.GetCustomAttribute<DefaultValueAttribute>()?.DefaultValue ?? string.Empty;
var description = prop.GetDocSection("summary");

var propertyName = NamingUtil.GetParameterName(prop);
Expand All @@ -116,7 +117,7 @@ public WorkflowDefinition Build()
BuildContext.Inputs.Add(
new JProperty(
propertyName,
new JObject { new JProperty("value", ""), new JProperty("description", $"{description} {requiredString}"), }
new JObject { new JProperty("value", defaultValue), new JProperty("description", $"{description} {requiredString}"), }
)
);
}
Expand Down
12 changes: 12 additions & 0 deletions src/ConductorSharp.Engine/Util/DefaultValueAttribute.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
using System;

namespace ConductorSharp.Engine.Util
{
[AttributeUsage(AttributeTargets.Property)]
public class DefaultValueAttribute : Attribute
{
internal object DefaultValue { get; }

public DefaultValueAttribute(object defaultValue) => DefaultValue = defaultValue;
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
<None Remove="Samples\Workflows\CSharpLambdaWorkflow.json" />
<None Remove="Samples\Workflows\DecisionInDecision.json" />
<None Remove="Samples\Workflows\DecisionTask.json" />
<None Remove="Samples\Workflows\DefaultValueWorkflow.json" />
<None Remove="Samples\Workflows\DynamicTask.json" />
<None Remove="Samples\Workflows\HumanTask.json" />
<None Remove="Samples\Workflows\IndexerWorkflow.json" />
Expand All @@ -33,6 +34,7 @@
</ItemGroup>

<ItemGroup>
<EmbeddedResource Include="Samples\Workflows\DefaultValueWorkflow.json" />
<EmbeddedResource Include="Samples\Workflows\HumanTask.json" />
<EmbeddedResource Include="Samples\Workflows\WaitTask.json" />
<EmbeddedResource Include="Samples\Workflows\CSharpLambdaWorkflow.json">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ public WorkflowBuilderTests()
_containerBuilder.RegisterWorkflow<HumanTaskWorkflow>();
_containerBuilder.RegisterWorkflow<WaitTaskWorkflow>();
_containerBuilder.RegisterWorkflow<IndexerWorkflow>();
_containerBuilder.RegisterWorkflow<DefaultValueWorkflow>();

_container = _containerBuilder.Build();
}
Expand Down Expand Up @@ -236,6 +237,7 @@ public void BuilderReturnsCorrectDefinitionHumanWorkflow()
Assert.Equal(expectedDefinition, definition);
}

[Fact]
public void BuilderReturnsCorrectDefinitionWaitTaskWorkflow()
{
var definition = GetDefinitionFromWorkflow<WaitTaskWorkflow>();
Expand All @@ -244,6 +246,7 @@ public void BuilderReturnsCorrectDefinitionWaitTaskWorkflow()
Assert.Equal(expectedDefinition, definition);
}

[Fact]
public void BuilderReturnsCorrectDefinitionIndexerWorkflow()
{
var definition = GetDefinitionFromWorkflow<IndexerWorkflow>();
Expand All @@ -252,6 +255,15 @@ public void BuilderReturnsCorrectDefinitionIndexerWorkflow()
Assert.Equal(expectedDefinition, definition);
}

[Fact]
public void BuilderReturnsCorrectDefinitionDefaultValueWorkflow()
{
var definition = GetDefinitionFromWorkflow<DefaultValueWorkflow>();
var expectedDefinition = EmbeddedFileHelper.GetLinesFromEmbeddedFile("~/Samples/Workflows/DefaultValueWorkflow.json");

Assert.Equal(expectedDefinition, definition);
}

private string GetDefinitionFromWorkflow<TNameable>() where TNameable : INameable
{
var workflow = _container.Resolve<IEnumerable<WorkflowDefinition>>().First(a => a.Name == NamingUtil.NameOf<TNameable>());
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace ConductorSharp.Engine.Tests.Samples.Workflows
{
public class DefaultValueWorkflowInput : WorkflowInput<DefaultValueWorkflowOutput>
{
[DefaultValue("Default name")]
public string Name { get; set; }

[DefaultValue("Default address")]
public string Address { get; set; }
}

public class DefaultValueWorkflowOutput : WorkflowOutput { }

public class DefaultValueWorkflow : Workflow<DefaultValueWorkflow, DefaultValueWorkflowInput, DefaultValueWorkflowOutput>
{
public EmailPrepareV1 PrepareEmail { get; set; }

public DefaultValueWorkflow(WorkflowDefinitionBuilder<DefaultValueWorkflow, DefaultValueWorkflowInput, DefaultValueWorkflowOutput> builder)
: base(builder) { }

public override void BuildDefinition()
{
_builder.AddTask(wf => wf.PrepareEmail, wf => new() { Name = wf.WorkflowInput.Name, Address = wf.WorkflowInput.Address });
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
{
"ownerApp": null,
"createTime": 0,
"updateTime": 0,
"createdBy": null,
"updatedBy": null,
"name": "default_value_workflow",
"description": "{\"description\":null,\"labels\":null}",
"version": 1,
"tasks": [
{
"queryExpression": null,
"name": "EMAIL_prepare",
"taskReferenceName": "prepare_email",
"description": "{\"description\":null}",
"inputParameters": {
"name": "${workflow.input.name}",
"address": "${workflow.input.address}"
},
"type": "SIMPLE",
"dynamicTaskNameParam": null,
"caseValueParam": null,
"caseExpression": null,
"expression": null,
"evaluatorType": null,
"scriptExpression": null,
"decisionCases": null,
"dynamicForkJoinTasksParam": null,
"dynamicForkTasksParam": null,
"dynamicForkTasksInputParamName": null,
"defaultCase": null,
"forkTasks": null,
"startDelay": 0,
"subWorkflowParam": null,
"joinOn": null,
"sink": null,
"optional": false,
"taskDefinition": null,
"rateLimited": false,
"defaultExclusiveJoinTask": null,
"asyncComplete": false,
"loopCondition": null,
"loopOver": null
}
],
"inputParameters": [
"{\"name\":{\"value\":\"Default name\",\"description\":\" (optional)\"},\"address\":{\"value\":\"Default address\",\"description\":\" (optional)\"}}"
],
"outputParameters": null,
"failureWorkflow": null,
"schemaVersion": 2,
"restartable": true,
"workflowStatusListenerEnabled": true,
"ownerEmail": null,
"timeoutPolicy": null,
"timeoutSeconds": 0,
"variables": null
}