Merge pull request #4000 from mboersma/sdk-v2-async-cleanup

Rename "asyncpoller" package to "async"
kubernetes-sigs · Sep 14, 2023 · f261d6e · f261d6e
2 parents 09c96a7 + e5e60ff
commit f261d6e
Show file tree

Hide file tree

Showing 53 changed files with 456 additions and 1,734 deletions.
diff --git a/azure/services/agentpools/agentpools.go b/azure/services/agentpools/agentpools.go
@@ -24,7 +24,7 @@ import (
 	"k8s.io/utils/ptr"
 	infrav1 "sigs.k8s.io/cluster-api-provider-azure/api/v1beta1"
 	"sigs.k8s.io/cluster-api-provider-azure/azure"
-	"sigs.k8s.io/cluster-api-provider-azure/azure/services/asyncpoller"
+	"sigs.k8s.io/cluster-api-provider-azure/azure/services/async"
 	"sigs.k8s.io/cluster-api-provider-azure/util/tele"
 	clusterv1 "sigs.k8s.io/cluster-api/api/v1beta1"
 )
@@ -52,7 +52,7 @@ type AgentPoolScope interface {
 // Service provides operations on Azure resources.
 type Service struct {
 	scope AgentPoolScope
-	asyncpoller.Reconciler
+	async.Reconciler
 }
 
 // New creates a new service.
@@ -63,7 +63,7 @@ func New(scope AgentPoolScope) (*Service, error) {
 	}
 	return &Service{
 		scope: scope,
-		Reconciler: asyncpoller.New[armcontainerservice.AgentPoolsClientCreateOrUpdateResponse,
+		Reconciler: async.New[armcontainerservice.AgentPoolsClientCreateOrUpdateResponse,
 			armcontainerservice.AgentPoolsClientDeleteResponse](scope, client, client),
 	}, nil
 }

diff --git a/azure/services/agentpools/client.go b/azure/services/agentpools/client.go
@@ -23,7 +23,7 @@ import (
 	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/containerservice/armcontainerservice/v4"
 	"github.com/pkg/errors"
 	"sigs.k8s.io/cluster-api-provider-azure/azure"
-	"sigs.k8s.io/cluster-api-provider-azure/azure/services/asyncpoller"
+	"sigs.k8s.io/cluster-api-provider-azure/azure/services/async"
 	"sigs.k8s.io/cluster-api-provider-azure/util/reconciler"
 	"sigs.k8s.io/cluster-api-provider-azure/util/tele"
 )
@@ -89,7 +89,7 @@ func (ac *azureClient) CreateOrUpdateAsync(ctx context.Context, spec azure.Resou
 	ctx, cancel := context.WithTimeout(ctx, reconciler.DefaultAzureCallTimeout)
 	defer cancel()
 
-	pollOpts := &runtime.PollUntilDoneOptions{Frequency: asyncpoller.DefaultPollerFrequency}
+	pollOpts := &runtime.PollUntilDoneOptions{Frequency: async.DefaultPollerFrequency}
 	resp, err := poller.PollUntilDone(ctx, pollOpts)
 	if err != nil {
 		// If an error occurs, return the poller.
@@ -118,7 +118,7 @@ func (ac *azureClient) DeleteAsync(ctx context.Context, spec azure.ResourceSpecG
 	ctx, cancel := context.WithTimeout(ctx, reconciler.DefaultAzureCallTimeout)
 	defer cancel()
 
-	pollOpts := &runtime.PollUntilDoneOptions{Frequency: asyncpoller.DefaultPollerFrequency}
+	pollOpts := &runtime.PollUntilDoneOptions{Frequency: async.DefaultPollerFrequency}
 	_, err = poller.PollUntilDone(ctx, pollOpts)
 	if err != nil {
 		// If an error occurs, return the poller.

diff --git a/azure/services/async/async.go b/azure/services/async/async.go
diff --git a/azure/services/async/async_test.go b/azure/services/async/async_test.go
diff --git a/azure/services/async/interfaces.go b/azure/services/async/interfaces.go
@@ -1,5 +1,5 @@
 /*
-Copyright 2021 The Kubernetes Authors.
+Copyright 2023 The Kubernetes Authors.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
@@ -19,25 +19,17 @@ package async
 import (
 	"context"
 
+	"github.com/Azure/azure-sdk-for-go/sdk/azcore/runtime"
 	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/resources/armresources"
-	azureautorest "github.com/Azure/go-autorest/autorest/azure"
 	"sigs.k8s.io/cluster-api-provider-azure/azure"
 )
 
-// FutureScope is a scope that can perform store futures and conditions in Status.
+// FutureScope stores and retrieves Futures and Conditions.
 type FutureScope interface {
 	azure.AsyncStatusUpdater
 }
 
-// FutureHandler is a client that can check on the progress of a future.
-type FutureHandler interface {
-	// IsDone returns true if the operation is complete.
-	IsDone(ctx context.Context, future azureautorest.FutureAPI) (isDone bool, err error)
-	// Result returns the result of the operation.
-	Result(ctx context.Context, future azureautorest.FutureAPI, futureType string) (result interface{}, err error)
-}
-
-// Getter is an interface that can get a resource.
+// Getter gets a resource.
 type Getter interface {
 	Get(ctx context.Context, spec azure.ResourceSpecGetter) (result interface{}, err error)
 }
@@ -47,20 +39,18 @@ type TagsGetter interface {
 	GetAtScope(ctx context.Context, scope string) (result armresources.TagsResource, err error)
 }
 
-// Creator is a client that can create or update a resource asynchronously.
-type Creator interface {
-	FutureHandler
+// Creator creates or updates a resource asynchronously.
+type Creator[T any] interface {
 	Getter
-	CreateOrUpdateAsync(ctx context.Context, spec azure.ResourceSpecGetter, parameters interface{}) (result interface{}, future azureautorest.FutureAPI, err error)
+	CreateOrUpdateAsync(ctx context.Context, spec azure.ResourceSpecGetter, resumeToken string, parameters interface{}) (result interface{}, poller *runtime.Poller[T], err error)
 }
 
-// Deleter is a client that can delete a resource asynchronously.
-type Deleter interface {
-	FutureHandler
-	DeleteAsync(ctx context.Context, spec azure.ResourceSpecGetter) (future azureautorest.FutureAPI, err error)
+// Deleter deletes a resource asynchronously.
+type Deleter[T any] interface {
+	DeleteAsync(ctx context.Context, spec azure.ResourceSpecGetter, resumeToken string) (poller *runtime.Poller[T], err error)
 }
 
-// Reconciler is a generic interface used to perform asynchronous reconciliation of Azure resources.
+// Reconciler reconciles a resource.
 type Reconciler interface {
 	CreateOrUpdateResource(ctx context.Context, spec azure.ResourceSpecGetter, serviceName string) (result interface{}, err error)
 	DeleteResource(ctx context.Context, spec azure.ResourceSpecGetter, serviceName string) (err error)