Skip to content

Add CustomStatus Size Check for OOP model #3113

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

Merged
merged 6 commits into from
May 27, 2025
Merged

Add CustomStatus Size Check for OOP model #3113

Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
56e3350
initial commit
nytian May 19, 2025
4127540
update exception
nytian May 19, 2025
2e0d381
fix typo
nytian May 19, 2025
19498d1
udpate with reviews
nytian May 22, 2025
4bd3454
make help method static
nytian May 27, 2025
ad8138c
update calling method
nytian May 27, 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
18 changes: 18 additions & 0 deletions src/WebJobs.Extensions.DurableTask/ContextImplementations/RemoteOrchestratorContext.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
#nullable enable
using System;
using System.Collections.Generic;
using System.Text;
using DurableTask.Core;
using DurableTask.Core.Command;
using DurableTask.Core.Entities;
Expand Down Expand Up @@ -73,6 +74,8 @@ internal bool TryGetOrchestrationErrorDetails(out Exception? failure)

internal void SetResult(IEnumerable<OrchestratorAction> actions, string customStatus)
{
this.ValidateCustomStatusSize(customStatus);

var result = new OrchestratorExecutionResult
{
CustomStatus = customStatus,
Expand Down Expand Up @@ -182,5 +185,20 @@ private void SetResultInternal(OrchestratorExecutionResult result)

this.executionResult = result;
}

private void ValidateCustomStatusSize(string customStatus)
{
// Azure Table Storage enforces a 32 KB limit if a property value is a UTF-16 encoded string.
// We apply a 16 KB limit here to align with our in-process model.
const int MaxCustomStatusSizeInKB = 16;
double customStatusSizeInKB = customStatus != null ? Encoding.Unicode.GetByteCount(customStatus) / 1024.0 : 0;
Copy link
Collaborator

Choose a reason for hiding this comment

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

Not a big deal, but do we really need floating-point computation here? Consider defining the constant as 16*1024 and just comparing it with the GetByteCount result. This may be more performant (though the impact is probably negligible) but, more importantly, this will eliminate some mental overhead for the reader of this code.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Thanks for the review, Anatoli! This was changed like this because of this comment .


// If the provided custom status value exceeds 16KB in size, fail the orchestration.
if (customStatusSizeInKB > MaxCustomStatusSizeInKB)
{
throw new ArgumentException(
$"CustomStatus is too large: limit = {MaxCustomStatusSizeInKB} KB (UTF-16), actual = {customStatusSizeInKB:N2} KB.");
}
}
}
}
Loading