Add api to get all stored state names for the actor

[yaron2]

https://docs.microsoft.com/en-us/dotnet/api/microsoft.servicefabric.actors.runtime.iactorstatemanager.getstatenamesasync?view=azure-dotnet#Microsoft_ServiceFabric_Actors_Runtime_IActorStateManager_GetStateNamesAsync_System_Threading_CancellationToken_

[youngbupark]

@yaron2 JFYI - I will work on this issue.

[yaron2]

Sure

[lukekim]

@youngbupark to sync with @amanbha on this issue and produce a small write-up/spec of what we need to deliver including a definition of done for the issue.

[youngbupark]

This issue has the dependency on #130 . So we pushed this item back to To do

[youngbupark]

Design Proposal

Overview

This proposes new API allowing user code or SDK to retrieve all stored states' names for the actor. Once Action Actor supports granular state management (#130), it stores the multiple states for the single actor id. This proposed API returns the array which enumerates all state names which have ActionsID-actorType-actorID- prefix in the backend state store.

Proposal

Issue #130 is addressing SaveState improvement to set the multiple states and stores the state in the backend state store with the below key format.

ActionsID-actorType-actorID-[state_name]

New GetStateNames API returns the array which includes the list of state names starting with ActionsID-actorType-actorID- key prefix in the backend state store.

Proposed API signature

GetStateNames(req *GetStateRequest) (*StateNamesResponse, error)

Return type:

struct StateNamesResponse {
    StateNames []string
}

Example

Assume that user code save the below 3 states in Redis State store:

ActionsID-actorType-actorID-key1
ActionsID-actorType-actorID-key2
ActionsID-actorType-actorID-key3

GetStateNames will return the below state names as an array without the prefix ActionsID-actorType-actorID-

{
    StateNames: [ "key1", "key2", "key3" ]
}

References

• ServiceFabric Actors Runtime - GetStateNamesAsync

[yaron2]

Looks good to me!

Bear in mind this needs to be implemented for the gRPC API server as well, most likely since we're going to transition from using HTTP to gRPC for the Actor SDKs

[msfussell]

Deprioritizing this issue based on review. Can revisit in the future as needed.