Skip to content

feat(redis): refactor wait handler to use helper struct #7361

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
GokceGK wants to merge 2 commits into
base: main
Choose a base branch
from
Open

feat(redis): refactor wait handler to use helper struct #7361

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
98e8cac
feat(redis): refactor wait handler to use helper struct
GokceGK May 20, 2026
b2ffcc0
Merge branch 'main' into feat/STACKITSDK-388-redis-refactor-wait-handler
GokceGK May 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -307,6 +307,8 @@
- **Dependencies:** Bump STACKIT SDK core module from `v0.24.1` to `v0.25.0`
- [v0.28.2](services/redis/CHANGELOG.md#v0282)
- **Dependencies:** Bump STACKIT SDK core module from `v0.25.0` to `v0.26.0`
- [v0.29.0](services/redis/CHANGELOG.md#v0290)
- `v1api`: **Improvement**: Use new `WaiterHandler` struct in the Redis WaitHandler
- `resourcemanager`:
- [v0.21.2](services/resourcemanager/CHANGELOG.md#v0212)
- **Dependencies:** Bump STACKIT SDK core module from `v0.24.0` to `v0.24.1`
Expand Down
3 changes: 3 additions & 0 deletions services/redis/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
## v0.29.0
- `v1api`: **Improvement**: Use new `WaiterHandler` struct in the Redis WaitHandler

## v0.28.2
- **Dependencies:** Bump STACKIT SDK core module from `v0.25.0` to `v0.26.0`

Expand Down
2 changes: 1 addition & 1 deletion services/redis/VERSION
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
v0.28.2
v0.29.0
69 changes: 35 additions & 34 deletions services/redis/v1api/wait/wait.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package wait

import (
"context"
"errors"
"fmt"
"net/http"
"strings"
Expand All @@ -26,45 +27,45 @@ const (
)

// CreateInstanceWaitHandler will wait for instance creation
func CreateInstanceWaitHandler(ctx context.Context, a redis.DefaultAPI, projectId, instanceId string) *wait.AsyncActionHandler[redis.Instance] {
handler := wait.New(func() (waitFinished bool, response *redis.Instance, err error) {
s, err := a.GetInstance(ctx, projectId, instanceId).Execute()
if err != nil {
return false, nil, err
}
if s.Status == nil {
return false, nil, fmt.Errorf("create failed for instance with id %s. The response is not valid: the status is missing", instanceId)
}
switch *s.Status {
case INSTANCESTATUS_ACTIVE:
return true, s, nil
case INSTANCESTATUS_FAILED:
return true, s, fmt.Errorf("create failed for instance with id %s: %s", instanceId, s.LastOperation.Description)
}
return false, nil, nil
})
func CreateInstanceWaitHandler(ctx context.Context, client redis.DefaultAPI, projectId, instanceId string) *wait.AsyncActionHandler[redis.Instance] {
Copy link
Copy Markdown
Member

@rubenhoenle rubenhoenle May 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could use shared logic:

func createOrUpdateInstanceWaitHandler(ctx context.Context, client redis.DefaultAPI, projectId, instanceId string) *wait.AsyncActionHandler[redis.Instance] {
	waitConfig := wait.WaiterHelper[redis.Instance, string]{
		FetchInstance: client.GetInstance(ctx, projectId, instanceId).Execute,
		GetState: func(response *redis.Instance) (string, error) {
			if response == nil {
				return "", errors.New("empty response")
			}
			if response.Status == nil {
				return "", errors.New("status is missing in response")
			}
			return *response.Status, nil
		},
		ActiveState: []string{INSTANCESTATUS_ACTIVE},
		ErrorState:  []string{INSTANCESTATUS_FAILED},
	}

	handler := wait.New(waitConfig.Wait())
	handler.SetTimeout(45 * time.Minute)
	return handler
}

func CreateInstanceWaitHandler(ctx context.Context, client redis.DefaultAPI, projectId, instanceId string) *wait.AsyncActionHandler[redis.Instance] {
    return createOrUpdateInstanceWaitHandler(...)
}

func PartialUpdateInstanceWaitHandler(ctx context.Context, client redis.DefaultAPI, projectId, instanceId string) *wait.AsyncActionHandler[redis.Instance] {
    return createOrUpdateInstanceWaitHandler(...)
}

Potentially you can also use shared test logic, see

stackit-sdk-go/services/opensearch/v1api/wait/wait_test.go

Lines 119 to 123 in 8ac1cea

handlers := map[string]func(context.Context, opensearch.DefaultAPI, string, string) *wait.AsyncActionHandler[opensearch.Instance]{
"common logic": createOrUpdateInstanceWaitHandler,
"create": CreateInstanceWaitHandler,
"update": PartialUpdateInstanceWaitHandler,
}

waitConfig := wait.WaiterHelper[redis.Instance, string]{
FetchInstance: client.GetInstance(ctx, projectId, instanceId).Execute,
GetState: func(response *redis.Instance) (string, error) {
if response == nil {
return "", errors.New("empty response")
}
if response.Status == nil {
return "", errors.New("status is missing in response")
}
return *response.Status, nil
},
ActiveState: []string{INSTANCESTATUS_ACTIVE},
ErrorState: []string{INSTANCESTATUS_FAILED},
}

handler := wait.New(waitConfig.Wait())
handler.SetTimeout(45 * time.Minute)
return handler
}

// PartialUpdateInstanceWaitHandler will wait for instance update
func PartialUpdateInstanceWaitHandler(ctx context.Context, a redis.DefaultAPI, projectId, instanceId string) *wait.AsyncActionHandler[redis.Instance] {
handler := wait.New(func() (waitFinished bool, response *redis.Instance, err error) {
s, err := a.GetInstance(ctx, projectId, instanceId).Execute()
if err != nil {
return false, nil, err
}
if s.Status == nil {
return false, nil, fmt.Errorf("update failed for instance with id %s. The response is not valid: the instance id or the status are missing", instanceId)
}
switch *s.Status {
case INSTANCESTATUS_ACTIVE:
return true, s, nil
case INSTANCESTATUS_FAILED:
return true, s, fmt.Errorf("update failed for instance with id %s: %s", instanceId, s.LastOperation.Description)
}
return false, nil, nil
})
func PartialUpdateInstanceWaitHandler(ctx context.Context, client redis.DefaultAPI, projectId, instanceId string) *wait.AsyncActionHandler[redis.Instance] {
waitConfig := wait.WaiterHelper[redis.Instance, string]{
FetchInstance: client.GetInstance(ctx, projectId, instanceId).Execute,
GetState: func(response *redis.Instance) (string, error) {
if response == nil {
return "", errors.New("empty response")
}
if response.Status == nil {
return "", errors.New("status is missing in response")
}
return *response.Status, nil
},
ActiveState: []string{INSTANCESTATUS_ACTIVE},
ErrorState: []string{INSTANCESTATUS_FAILED},
}

handler := wait.New(waitConfig.Wait())
handler.SetTimeout(45 * time.Minute)
return handler
}
Expand Down
14 changes: 14 additions & 0 deletions services/redis/v1api/wait/wait_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,13 @@ func TestCreateInstanceWaitHandler(t *testing.T) {
wantErr: true,
wantResp: true,
},
{
desc: "wrong state in response",
getFails: false,
resourceState: utils.Ptr("wrong state"),
wantErr: true,
wantResp: false,
},
{
desc: "get_fails",
getFails: true,
Expand Down Expand Up @@ -169,6 +176,13 @@ func TestUpdateInstanceWaitHandler(t *testing.T) {
wantErr: true,
wantResp: true,
},
{
desc: "wrong state in response",
getFails: false,
resourceState: utils.Ptr("wrong state"),
wantErr: true,
wantResp: false,
},
{
desc: "get_fails",
getFails: true,
Expand Down
Loading