CommandsFeature execution status and history

brownm · July 25, 2024, 7:25pm

Where is the execution history of the command feature stored, and is it possible to retrieve the status of a command execution?

Ideally, I would like to follow AWS pattern for running long jobs so something like:

StartMyCommand starts the SS Command, returning an ExecutionId
DescribeMyCommand returned the status (Executing, Completed, Error …) for a given ExecutionId
ListMyCommand returns list of commands run with there ExecutionID and final status

mythz · July 25, 2024, 10:31pm

They’re not persisted, they’re only maintained in rolling in-memory collections.

brownm · July 25, 2024, 10:57pm

Are there any workarounds/suggestions?

mythz · July 26, 2024, 3:44am

You can access the collections from the CommandsFeature plugin, (e.g. with HostContext.GetPlugin<CommandsFeature>()) which are maintained in rolling Concurrent Queues whilst the summaries are contained within a Concurrent Dictionary:

github.com

ServiceStack/ServiceStack/blob/22049289f6c38ab849de6b42a02310b6146a88d0/ServiceStack/src/ServiceStack/CommandsFeature.cs#L334-L337


      
          public ConcurrentQueue<CommandResult> CommandResults { get; set; } = [];
          public ConcurrentQueue<CommandResult> CommandFailures { get; set; } = new();
          
          public ConcurrentDictionary<string, CommandSummary> CommandTotals { get; set; } = new();

Commands are not assigned an Id so you’re unlikely to implement what you want.

We intend on creating a backgrounds job feature to execute APIs and Commands that would be persisted which is more aligned to this feature, but we haven’t started on that yet.