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

[Wait-And-Retry] Decorator output standardization #16603

Merged
merged 2 commits into from
Mar 11, 2025
+35 −48
Merged

[Wait-And-Retry] Decorator output standardization #16603

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
51c906e
git status
Mar 11, 2025
344c233
updated the decorator output as Array instead of object
Mar 11, 2025
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
16 changes: 8 additions & 8 deletions src/Bicep.Core.IntegrationTests/Decorators/RetryOnDecoratorTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,18 +54,18 @@ public void RetryOnDecorator_ValidScenario()
}
");

var retryOnJObject = new JObject
var retryOnJObject = new JArray
{
["exceptionCodes"] = new JArray("ResourceNotFound", "ServerError"),
["retryCount"] = 1
new JArray("ResourceNotFound", "ServerError"),
1
};

using (new AssertionScope())
{
diagnostics.ExcludingLinterDiagnostics().Should().BeEmpty();

template.Should().NotBeNull()
.And.HaveValueAtPath("$.resources[0].options.retryOn", retryOnJObject);
.And.HaveValueAtPath("$.resources[0].@options.retryOn", retryOnJObject);
}
}

Expand Down Expand Up @@ -214,18 +214,18 @@ public void RetryOnDecoratorWithCollections_ValidScenario()
}]
");

var retryOnJObject = new JObject
var retryOnJObject = new JArray
{
["exceptionCodes"] = new JArray("ResourceNotFound", "ServerError"),
["retryCount"] = 1
new JArray("ResourceNotFound", "ServerError"),
1
};

using (new AssertionScope())
{
diagnostics.ExcludingLinterDiagnostics().Should().BeEmpty();

template.Should().NotBeNull()
.And.HaveValueAtPath("$.resources[0].options.retryOn", retryOnJObject);
.And.HaveValueAtPath("$.resources[0].@options.retryOn", retryOnJObject);
}
}

Expand Down
16 changes: 8 additions & 8 deletions src/Bicep.Core.IntegrationTests/Decorators/WaitUntilDecoratorTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,18 +35,18 @@ public void WaitUntilDecorator_ValidScenario(string input, string output)

var (template, diagnostics, _) = CompilationHelper.Compile(services, fileContent);

var waitUntilObject = new JObject
var waitUntilObject = new JArray
{
["expression"] = output,
["maxWaitTime"] = "PT20S"
output,
"PT20S"
};

using (new AssertionScope())
{
diagnostics.ExcludingLinterDiagnostics().Should().BeEmpty();

template.Should().NotBeNull()
.And.HaveValueAtPath("$.resources[0].options.waitUntil", waitUntilObject);
.And.HaveValueAtPath("$.resources[0].@options.waitUntil", waitUntilObject);
}
}

Expand Down Expand Up @@ -183,18 +183,18 @@ public void WaitUntilDecoratorWithCollection_ValidScenario(string input, string

var (template, diagnostics, _) = CompilationHelper.Compile(services, fileContent);

var waitUntilObject = new JObject
var waitUntilObject = new JArray
{
["expression"] = output,
["maxWaitTime"] = "PT20S"
output,
"PT20S"
};

using (new AssertionScope())
{
diagnostics.ExcludingLinterDiagnostics().Should().BeEmpty();

template.Should().NotBeNull()
.And.HaveValueAtPath("$.resources[0].options.waitUntil", waitUntilObject);
.And.HaveValueAtPath("$.resources[0].@options.waitUntil", waitUntilObject);
}
}

Expand Down
16 changes: 11 additions & 5 deletions src/Bicep.Core/Emit/TemplateWriter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1259,21 +1259,27 @@ private void EmitResource(ExpressionEmitter emitter, ImmutableArray<ExtensionExp
// Emit the options property
if (resource.RetryOn is not null || resource.WaitUntil is not null)
{
emitter.EmitObjectProperty("options", () =>
emitter.EmitObjectProperty("@options", () =>
{
if (resource.RetryOn is not null)
{
emitter.EmitObjectProperty("retryOn", () =>
emitter.EmitArrayProperty("retryOn", () =>
{
emitter.EmitObjectProperties(resource.RetryOn);
foreach (var item in resource.RetryOn.Items)
{
emitter.EmitExpression(item);
}
});
}

if (resource.WaitUntil is not null)
{
emitter.EmitObjectProperty("waitUntil", () =>
emitter.EmitArrayProperty("waitUntil", () =>
{
emitter.EmitObjectProperties(resource.WaitUntil);
foreach (var item in resource.WaitUntil.Items)
{
emitter.EmitExpression(item);
}
});
}

Expand Down
4 changes: 2 additions & 2 deletions src/Bicep.Core/Intermediate/Expression.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -493,8 +493,8 @@ public record DeclaredResourceExpression(
Expression Body,
ImmutableArray<ResourceDependencyExpression> DependsOn,
Expression? Description = null,
ObjectExpression? RetryOn = null,
ObjectExpression? WaitUntil = null
ArrayExpression? RetryOn = null,
ArrayExpression? WaitUntil = null
) : DescribableExpression(SourceSyntax, Description)
{
public override void Accept(IExpressionVisitor visitor)
Expand Down
31 changes: 6 additions & 25 deletions src/Bicep.Core/Semantics/Namespaces/SystemNamespaceType.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2036,21 +2036,11 @@ private static Expression WaitUntilEvaluator(FunctionCallExpression functionCall
{
if (decorated is DeclaredResourceExpression declaredResourceExpression)
{
var waitUntilProperties = ImmutableArray.Create<ObjectPropertyExpression>(
new
(
null,
new StringLiteralExpression(null, "expression"),
functionCall.Parameters[0]
),
new
(
null,
new StringLiteralExpression(null, "maxWaitTime"),
var waitUntilParameters = ImmutableArray.Create<Expression>(
functionCall.Parameters[0],
functionCall.Parameters[1]
)
);
return declaredResourceExpression with { WaitUntil = new ObjectExpression(null, waitUntilProperties) };
return declaredResourceExpression with { WaitUntil = new ArrayExpression(null, waitUntilParameters)};
}

return decorated;
Expand All @@ -2060,26 +2050,17 @@ private static Expression RetryOnEvaluator(FunctionCallExpression functionCall,
{
if (decorated is DeclaredResourceExpression declaredResourceExpression)
{
var retryOnProperties = new List<ObjectPropertyExpression>
var retryOnParameters = new List<Expression>
{
new
(
null,
new StringLiteralExpression(null, "exceptionCodes"),
functionCall.Parameters[0]
)
};
if (functionCall.Parameters.Length > 1)
{
retryOnProperties.Add(
new(
null,
new StringLiteralExpression(null, "retryCount"),
retryOnParameters.Add(
functionCall.Parameters[1]
)
);
}
return declaredResourceExpression with { RetryOn = new ObjectExpression(null, [.. retryOnProperties]) };
return declaredResourceExpression with { RetryOn = new ArrayExpression(null, [.. retryOnParameters]) };
}
return decorated;
}
Expand Down
Loading