Skip to content

Add Invocation Id to Module Private Data #99

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

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Add Invocation Id to Module Private Data #99

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
cbf3fa3
initial commit
bachuv Jul 16, 2025
4a15459
updated GetInvocationIdFromModulePrivateData
bachuv Jul 16, 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
12 changes: 12 additions & 0 deletions src/AzureFunctions.PowerShell.Durable.SDK.psm1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,16 @@ function GetDurableClientFromModulePrivateData {
}
}

function GetInvocationIdFromModulePrivateData {
$PrivateData = $PSCmdlet.MyInvocation.MyCommand.Module.PrivateData
if ($null -eq $PrivateData -or $null -eq $PrivateData['InvocationId']) {
return $null
}
else {
$PrivateData['InvocationId']
}
}

function Get-DurableStatus {
[CmdletBinding()]
param(
Expand Down Expand Up @@ -114,6 +124,8 @@ function Start-DurableOrchestration {
}

$Body = $InputObject | ConvertTo-Json -Compress -Depth 100

$InvocationId = GetInvocationIdFromModulePrivateData

$null = Invoke-RestMethod -Uri $Uri -Method 'POST' -ContentType 'application/json' -Body $Body

Expand Down
2 changes: 2 additions & 0 deletions src/DurableEngine/Utilities/IPowerShellServices.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ public interface IPowerShellServices
{
void SetDurableClient(object durableClient);

void SetInvocationId(string invocationId);

void SetOrchestrationContext(OrchestrationContext orchestrationContext);

void ClearOrchestrationContext();
Expand Down
9 changes: 9 additions & 0 deletions src/DurableEngine/Utilities/PowerShellServices.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,15 @@ public void SetDurableClient(object durableClient)
_hasSetOrchestrationContext = true;
}

public void SetInvocationId(string invocationId)
Copy link
Author

Choose a reason for hiding this comment

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

Where would I actually call this to set the invocation id? I tried to find how SetDurableClient() is getting called, but didn't find it in this SDK.

I looked at the internal SDK implementation and I see that it gets called in DurableController.cs

_powerShellServices.SetDurableClient(durableClient);

Do I need to update the Functions PowerShell worker?

Copy link
Collaborator

Choose a reason for hiding this comment

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

Yes, I believe you would need to move this method to the PowerShell worker and invoke it from there. In fact, the SetDurableClient and SetOrchestrationContext methods do not make sense in this repo, and they were probably just copied over from the worker repo by mistake.

Copy link
Collaborator

@AnatoliB AnatoliB Jul 17, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

But wait, this will require us to deploy a PS worker. Perhaps we can find a way to avoid that. Two ideas:

  1. Ask the customer to invoke Set-FunctionInvocationContext explicitly from their app code. Make this a part of DT enabling instructions (at least temporary, until we are able to update the worker). Do you know if the invocation id is available in the app code?
  2. Perhaps we can make the OTel module invoke Set-FunctionInvocationContext automatically? @andystaples, any thoughts on this?

Copy link
Collaborator

Choose a reason for hiding this comment

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

Have we decided that the invocation id should come from the OTel module? In this case, we can bypass the worker completely by either making the OTel module invoke Set-FunctionInvocationContext directly, or make the Durable SDK module invoke a command from the OTel module, whatever is more convenient. These modules don't have to take a hard dependency on each other, they will just know that cmdlets with certain names may exist, so this will be a dynamic dependency.

Copy link
Collaborator

Choose a reason for hiding this comment

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

In fact, the SetDurableClient and SetOrchestrationContext methods do not make sense in this repo, and they were probably just copied over from the worker repo by mistake.

Hmm, I seem to recall there was a reason - I recall Michael Peng telling me about this class at some point, but to be frank the reasons escape me now. My suggestion - add print statements / obvious failures in this codepath and run a few tests. If indeed it doesn't get called, then yeah just remove this.

{
_pwsh.AddCommand(SetFunctionInvocationContextCommand)
.AddParameter("InvocationId", invocationId)
.InvokeAndClearCommands();

_hasSetOrchestrationContext = true;
}

public void SetOrchestrationContext(OrchestrationContext orchestrationContext)
{
_pwsh.AddCommand(SetFunctionInvocationContextCommand)
Expand Down
12 changes: 12 additions & 0 deletions src/DurableSDK/Commands/Internals/SetFunctionInvocationContextCommand.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ public class SetFunctionInvocationContextCommand : PSCmdlet
{
private const string ContextKey = "OrchestrationContext";
private const string DurableClientKey = "DurableClient";
private const string InvocationIdKey = "InvocationId";

/// <summary>
/// The orchestration context.
Expand All @@ -36,6 +37,12 @@ public class SetFunctionInvocationContextCommand : PSCmdlet
[Parameter(Mandatory = true, ParameterSetName = DurableClientKey)]
public object DurableClient { get; set; }

/// <summary>
/// The function invocation ID.
/// </summary>
[Parameter(Mandatory = true, ParameterSetName = InvocationIdKey)]
public string InvocationId { get; set; }
Copy link
Collaborator

Choose a reason for hiding this comment

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

Let's be careful with this parameter. Unless we make the customer invoke this cmdlet explicitly, we need to remember that whatever invokes this cmdlet may be dealing with an older SDK version that didn't have this parameter yet. So the attempt to invoke it will fail, and we need to make sure that the caller tolerates the error. Nothing special to do in this PR, but please keep this in mind.


/// <summary>
/// Whether or not to clear the privateData of this module.
/// </summary>
Expand Down Expand Up @@ -70,11 +77,16 @@ protected override void EndProcessing()
privateData[DurableClientKey] = DurableClient;
break;

case InvocationIdKey:
privateData[InvocationIdKey] = InvocationId;
break;

default:
if (Clear.IsPresent)
{
privateData.Remove(ContextKey);
privateData.Remove(DurableClientKey);
privateData.Remove(InvocationIdKey);
}
break;
}
Expand Down