Azure / Azure/azure-functions-durable-js
An option to exclude output from orchestration status.
- Dominant language
- TypeScript
- Stars
- 142
- Forks
- 66
- Avg merge
- 3d 19h
- Merged PRs (30d)
- 4
Description
Currently, `DurableClient.getStatus()` accepts an `options` parameter object (type `GetStatusOptions`). This `options` object have properties: `showHistory`, `showHistoryOutput` and `showInput`.
My request is add another property `showOutput` to these options, set to `true` as default. Setting it to `false` should omit the orchestration's output altogether. This is required in scenarios where the output is quite large and `getStatus()` is called only to check the `runtimeStatus` and/or `customStatus`.
Next, the same `options` parameter object should also be acceptable by `DurableClient.getStatusAll()` and `DurableClient.getStatusBy()` to allow for similar data pruning.
Reference: The functionality to omit output seems to be available in `azure-functions-core-tools`:
```sh
func durable get-runtime-status --show-output=false
```
Contributor guide
Research direction
Trace the TypeScript definitions and implementations for DurableClient.getStatus(), getStatusAll(), getStatusBy(), and GetStatusOptions. Verify how the existing showHistory, showHistoryOutput, and showInput options are handled, then confirm that disabling showOutput omits orchestration output while the other status fields remain available across all three methods.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- api, backend
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100