feat(mongodb): add waiters for mongodb api (scaleway#2259)

Author: jremy42

api/mongodb/v1alpha1/mongodb_utils.go

@@ -0,0 +1,117 @@
+package mongodb
+
+import (
+	"time"
+
+	"github.com/scaleway/scaleway-sdk-go/errors"
+	"github.com/scaleway/scaleway-sdk-go/internal/async"
+	"github.com/scaleway/scaleway-sdk-go/scw"
+)
+
+const (
+	defaultInstanceRetryInterval = 15 * time.Second
+	defaultInstanceTimeout       = 15 * time.Minute
+)
+
+// WaitForInstanceRequest is used by WaitForInstance method.
+type WaitForInstanceRequest struct {
+	InstanceID    string
+	Region        scw.Region
+	Timeout       *time.Duration
+	RetryInterval *time.Duration
+}
+
+type WaitForSnapshotRequest struct {
+	InstanceID    string
+	SnapshotID    string
+	Region        scw.Region
+	Timeout       *time.Duration
+	RetryInterval *time.Duration
+}
+
+// WaitForInstance waits for the instance to be in a "terminal state" before returning.
+// This function can be used to wait for an instance to be ready or in another final state.
+func (s *API) WaitForInstance(req *WaitForInstanceRequest, opts ...scw.RequestOption) (*Instance, error) {
+	timeout := defaultInstanceTimeout
+	if req.Timeout != nil {
+		timeout = *req.Timeout
+	}
+	retryInterval := defaultInstanceRetryInterval
+	if req.RetryInterval != nil {
+		retryInterval = *req.RetryInterval
+	}
+
+	terminalStatus := map[InstanceStatus]struct{}{
+		InstanceStatusReady:  {},
+		InstanceStatusLocked: {},
+		InstanceStatusError:  {},
+	}
+
+	instance, err := async.WaitSync(&async.WaitSyncConfig{
+		Get: func() (interface{}, bool, error) {
+			res, err := s.GetInstance(&GetInstanceRequest{
+				Region:     req.Region,
+				InstanceID: req.InstanceID,
+			}, opts...)
+			if err != nil {
+				return nil, false, err
+			}
+
+			// Check if the instance has reached a terminal state
+			_, isTerminal := terminalStatus[res.Status]
+
+			return res, isTerminal, nil
+		},
+		Timeout:          timeout,
+		IntervalStrategy: async.LinearIntervalStrategy(retryInterval),
+	})
+	if err != nil {
+		return nil, errors.Wrap(err, "waiting for instance failed")
+	}
+	return instance.(*Instance), nil
+}
+
+// WaitForSnapshot waits for the snapshot to reach a "terminal state" before returning.
+func (s *API) WaitForSnapshot(req *WaitForSnapshotRequest, opts ...scw.RequestOption) (*Snapshot, error) {
+	timeout := defaultInstanceTimeout
+	if req.Timeout != nil {
+		timeout = *req.Timeout
+	}
+	retryInterval := defaultInstanceRetryInterval
+	if req.RetryInterval != nil {
+		retryInterval = *req.RetryInterval
+	}
+
+	terminalStatus := map[SnapshotStatus]struct{}{
+		SnapshotStatusReady:  {},
+		SnapshotStatusError:  {},
+		SnapshotStatusLocked: {},
+	}
+
+	snapshot, err := async.WaitSync(&async.WaitSyncConfig{
+		Get: func() (interface{}, bool, error) {
+			opts = append(opts, scw.WithAllPages())
+			listSnapshotResponse, err := s.ListSnapshots(&ListSnapshotsRequest{
+				Region:     req.Region,
+				InstanceID: &req.InstanceID,
+			}, opts...)
+			if err != nil {
+				return nil, false, err
+			}
+
+			for _, snapshot := range listSnapshotResponse.Snapshots {
+				if snapshot.ID == req.SnapshotID {
+					_, isTerminal := terminalStatus[snapshot.Status]
+					return snapshot, isTerminal, nil
+				}
+			}
+			return nil, false, nil
+		},
+		Timeout:          timeout,
+		IntervalStrategy: async.LinearIntervalStrategy(retryInterval),
+	})
+	if err != nil {
+		return nil, errors.Wrap(err, "waiting for snapshot failed")
+	}
+	return snapshot.(*Snapshot), nil
+}