Actor: Get existing reminder by name

[ssm3ll]

Expected Behavior

As per official documentation https://docs.dapr.io/reference/api/actors_api/#get-actor-reminder it is possible to get existing reminder by its name. So Actor should contain method GetReminderAsync(string reminderName) to get existing reminder, that has been previously created using RegisterReminderAsync (string reminderName, byte[] state, TimeSpan dueTime, TimeSpan period) method

Actual Behavior

Currently it's only possible to register or unregister reminder

Steps to Reproduce the Problem

Nor Actor neither DaprHttpInteractor contain method to get existing actor reminder by it's name

[rynowak]

Hi @ssm3ll,

You're right that we don't surface this through the Actors SDK. Do you have a use case in mind here? What do you plan to do with the data you will get?

That information will help us prioritize this as well as determine how it should be designed.

[ssm3ll]

Hi @rynowak,

I assume method should return IActorReminder instance if reminder exists, so it will be possible to read reminder details like due date etc. Main use case is to check if reminder has been already created. We have a method in actor witch receives driver location. If it was the first location for him then a reminder is created. that reminder changes driver state based on last location timestamp.

[tstojecki]

In the absence of this, is there any downside to registering a reminder with the same name with each request in a controller? We have a service that uses an actor to get/set state and want to have one instance of a reminder running at all times.

[fabistb]

@halspang Is it possible to surface this api via the SDK?
Based on my tests the reminder API behavior changes when reminder partitioning is activated.

If reminder partitioning isn't activate UnregisterReminder() returns 200 even if no reminder is currently active.
This makes it possible to call the method in an optimistic if it isn't clear if a reminder is currently active or not.

However if reminder partitioning is activate UnregisterReminder() returns 500 if no reminder is currently active.
With this change the best way is probably to call the Get actor reminder api validate the response and only if a reminder is active utilize the UnregisterReminder() method. So it would be helpful if the Get actor reminder api could also be surfaced via sdk.

[shivamkm07]

/assign

[shivamkm07]

@fabistb @ssm3ll Get Actor Reminder API has been added in Dotnet sdk in 1.11. GetActorReminder returns IActorReminder Object if the reminder exists, otherwise null. Feel free to try this and let us know in case of any issues.
P.S. I will be creating Docs PR soon for the change.

[shivamkm07]

@halspang This issue can be closed now.

[fabistb]

@shivamkm07 thank you very much!
Just tried it and returned all the information I'm interested in.

[ssm3ll]

@fabistb @ssm3ll Get Actor Reminder API has been added in Dotnet sdk in 1.11. GetActorReminder returns IActorReminder Object if the reminder exists, otherwise null. Feel free to try this and let us know in case of any issues. P.S. I will be creating Docs PR soon for the change.

thank you. it works