Azure / Azure/azure-functions-durable-js

An option to filter instances by instanceIdPrefix in DurableClient.getStatusBy()

Open
#634 0 comments 0 reactions 0 assignees View on GitHub
P2
Dominant language
TypeScript
Stars
142
Forks
66
Avg merge
3d 19h
Merged PRs (30d)
4

Description

Currently, `DurableClient.getStatusBy()` accepts an `filters` parameter object (type `OrchestrationFilter`). This `filters` object have properties: `createdTimeFrom`, `createdTimeTo` and `runtimeStatus`.

My request is add another property `instanceIdPrefix` to these options. Setting it to a string should filter the instances that have InstanceID starting with provided prefix.

This would allow faster retrieval of orchestrations and sub-orchestrations that have same (pre-set) prefix.

Reference: The functionality to omit output seems to be available in DurableTask HTTP API:
https://learn.microsoft.com/en-us/azure/azure-functions/durable/durable-functions-http-api#get-all-instances-status

Contributor guide

Open the contributing guide

Research direction

Start at DurableClient.getStatusBy() and the OrchestrationFilter type, then compare the requested instanceIdPrefix behavior with the referenced DurableTask HTTP API documentation. Done means the filter accepts a string prefix and status queries return only instances whose InstanceID starts with it, with coverage for the new behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
backend-api-design
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.