Merge arm/runtime/poller.go into runtime/poller.go (Azure#17708)

* Merge arm/runtime/poller.go into runtime/poller.go

LRO refactoring has alleviated the need for separation of ARM and
data-plane pollers so the content has been merged into the runtime
package.  The duplicated content under arm/runtime will be removed in a
future release.
The arm/internal/pollers/loc package was renamed to armloc to avoid
colliding with the existing data-plane package.  These will need to be
consolidated in a separate change.
No functional changes to the relocated, internal, pollers.

* update changelog

* clean up deprecation notice

* rebased on main and fixed up tests

Author: jhendrixMSFT

sdk/azcore/CHANGELOG.md

@@ -13,6 +13,8 @@
 ### Bugs Fixed
 
 ### Other Changes
+* The functionality in `arm/runtime/poller.go` has been merged into `runtime/poller.go` so it should be used instead.
+  * `arm/runtime/poller.go` will be removed in a future release.
 
 ## 0.23.1 (2022-04-14)
 

sdk/azcore/arm/internal/pollers/pollers.go

@@ -6,6 +6,8 @@
 
 package runtime
 
+// NOTE: this file will be deleted in a future release
+
 import (
 	"context"
 	"encoding/json"
@@ -14,10 +16,10 @@ import (
 	"net/http"
 	"time"
 
-	"github.com/Azure/azure-sdk-for-go/sdk/azcore/arm/internal/pollers/async"
-	"github.com/Azure/azure-sdk-for-go/sdk/azcore/arm/internal/pollers/body"
-	"github.com/Azure/azure-sdk-for-go/sdk/azcore/arm/internal/pollers/loc"
 	"github.com/Azure/azure-sdk-for-go/sdk/azcore/internal/pollers"
+	"github.com/Azure/azure-sdk-for-go/sdk/azcore/internal/pollers/armloc"
+	"github.com/Azure/azure-sdk-for-go/sdk/azcore/internal/pollers/async"
+	"github.com/Azure/azure-sdk-for-go/sdk/azcore/internal/pollers/body"
 	"github.com/Azure/azure-sdk-for-go/sdk/azcore/runtime"
 	"github.com/Azure/azure-sdk-for-go/sdk/internal/log"
 )
@@ -50,6 +52,7 @@ type NewPollerOptions[T any] struct {
 }
 
 // NewPoller creates a Poller based on the provided initial response.
+// Deprecated: use azcore/runtime.NewPoller instead.
 func NewPoller[T any](resp *http.Response, pl runtime.Pipeline, options *NewPollerOptions[T]) (*Poller[T], error) {
 	if options == nil {
 		options = &NewPollerOptions[T]{}
@@ -68,8 +71,8 @@ func NewPoller[T any](resp *http.Response, pl runtime.Pipeline, options *NewPoll
 	var lro pollers.Operation
 	if async.Applicable(resp) {
 		lro, err = async.New(resp, options.FinalStateVia, tName)
-	} else if loc.Applicable(resp) {
-		lro, err = loc.New(resp, tName)
+	} else if armloc.Applicable(resp) {
+		lro, err = armloc.New(resp, tName)
 	} else if body.Applicable(resp) {
 		// must test body poller last as it's a subset of the other pollers.
 		// TODO: this is ambiguous for PATCH/PUT if it returns a 200 with no polling headers (sync completion)
@@ -98,6 +101,7 @@ type NewPollerFromResumeTokenOptions[T any] struct {
 }
 
 // NewPollerFromResumeToken creates a Poller from a resume token string.
+// Deprecated: use azcore/runtime.NewPollerFromResumeToken instead.
 func NewPollerFromResumeToken[T any](token string, pl runtime.Pipeline, options *NewPollerFromResumeTokenOptions[T]) (*Poller[T], error) {
 	if options == nil {
 		options = &NewPollerFromResumeTokenOptions[T]{}
@@ -116,9 +120,9 @@ func NewPollerFromResumeToken[T any](token string, pl runtime.Pipeline, options
 	case async.Kind:
 		log.Writef(log.EventLRO, "Resuming %s poller.", async.Kind)
 		lro = &async.Poller{}
-	case loc.Kind:
-		log.Writef(log.EventLRO, "Resuming %s poller.", loc.Kind)
-		lro = &loc.Poller{}
+	case armloc.Kind:
+		log.Writef(log.EventLRO, "Resuming %s poller.", armloc.Kind)
+		lro = &armloc.Poller{}
 	case body.Kind:
 		log.Writef(log.EventLRO, "Resuming %s poller.", body.Kind)
 		lro = &body.Poller{}
@@ -142,6 +146,7 @@ type PollUntilDoneOptions struct {
 }
 
 // Poller encapsulates a long-running operation, providing polling facilities until the operation reaches a terminal state.
+// Deprecated: use azcore/runtime.Poller[T] instead.
 type Poller[T any] struct {
 	pt *pollers.Poller
 	rt *T

sdk/azcore/arm/internal/pollers/pollers_test.go

@@ -15,11 +15,11 @@ import (
 	"testing"
 	"time"
 
-	"github.com/Azure/azure-sdk-for-go/sdk/azcore/arm/internal/pollers/async"
-	"github.com/Azure/azure-sdk-for-go/sdk/azcore/arm/internal/pollers/body"
-	"github.com/Azure/azure-sdk-for-go/sdk/azcore/arm/internal/pollers/loc"
 	"github.com/Azure/azure-sdk-for-go/sdk/azcore/internal/exported"
 	"github.com/Azure/azure-sdk-for-go/sdk/azcore/internal/pollers"
+	"github.com/Azure/azure-sdk-for-go/sdk/azcore/internal/pollers/armloc"
+	"github.com/Azure/azure-sdk-for-go/sdk/azcore/internal/pollers/async"
+	"github.com/Azure/azure-sdk-for-go/sdk/azcore/internal/pollers/body"
 	"github.com/Azure/azure-sdk-for-go/sdk/azcore/internal/shared"
 	"github.com/Azure/azure-sdk-for-go/sdk/azcore/policy"
 	"github.com/Azure/azure-sdk-for-go/sdk/azcore/runtime"
@@ -153,7 +153,7 @@ func TestNewPollerLoc(t *testing.T) {
 	if !closed() {
 		t.Fatal("initial response body wasn't closed")
 	}
-	if pt := pollers.PollerType(poller.pt); pt != reflect.TypeOf(&loc.Poller{}) {
+	if pt := pollers.PollerType(poller.pt); pt != reflect.TypeOf(&armloc.Poller{}) {
 		t.Fatalf("unexpected poller type %s", pt.String())
 	}
 	tk, err := poller.ResumeToken()

sdk/azcore/arm/runtime/poller.go

@@ -4,17 +4,16 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
-package loc
+package armloc
 
 import (
 	"errors"
 	"fmt"
 	"net/http"
 
-	armpollers "github.com/Azure/azure-sdk-for-go/sdk/azcore/arm/internal/pollers"
+	"github.com/Azure/azure-sdk-for-go/sdk/azcore/internal/exported"
 	"github.com/Azure/azure-sdk-for-go/sdk/azcore/internal/pollers"
 	"github.com/Azure/azure-sdk-for-go/sdk/azcore/internal/shared"
-	"github.com/Azure/azure-sdk-for-go/sdk/azcore/runtime"
 	"github.com/Azure/azure-sdk-for-go/sdk/internal/log"
 )
 
@@ -72,9 +71,9 @@ func (p *Poller) Update(resp *http.Response) error {
 	if h := resp.Header.Get(shared.HeaderLocation); h != "" {
 		p.PollURL = h
 	}
-	if runtime.HasStatusCode(resp, http.StatusOK, http.StatusCreated) {
+	if exported.HasStatusCode(resp, http.StatusOK, http.StatusCreated) {
 		// if a 200/201 returns a provisioning state, use that instead
-		state, err := armpollers.GetProvisioningState(resp)
+		state, err := pollers.GetProvisioningState(resp)
 		if err != nil && !errors.Is(err, pollers.ErrNoBody) {
 			return err
 		}

sdk/azcore/arm/runtime/poller_test.go

@@ -4,7 +4,7 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
-package loc
+package armloc
 
 import (
 	"io"

sdk/azcore/arm/internal/pollers/loc/loc.go renamed to sdk/azcore/internal/pollers/armloc/loc.go

@@ -11,7 +11,6 @@ import (
 	"fmt"
 	"net/http"
 
-	armpollers "github.com/Azure/azure-sdk-for-go/sdk/azcore/arm/internal/pollers"
 	"github.com/Azure/azure-sdk-for-go/sdk/azcore/internal/pollers"
 	"github.com/Azure/azure-sdk-for-go/sdk/azcore/internal/shared"
 	"github.com/Azure/azure-sdk-for-go/sdk/internal/log"
@@ -68,7 +67,7 @@ func New(resp *http.Response, finalState pollers.FinalStateVia, pollerID string)
 		FinalState: finalState,
 	}
 	// check for provisioning state
-	state, err := armpollers.GetProvisioningState(resp)
+	state, err := pollers.GetProvisioningState(resp)
 	if errors.Is(err, pollers.ErrNoBody) || state == "" {
 		// NOTE: the ARM RPC spec explicitly states that for async PUT the initial response MUST
 		// contain a provisioning state.  to maintain compat with track 1 and other implementations
@@ -93,7 +92,7 @@ func (p *Poller) Done() bool {
 
 // Update updates the Poller from the polling response.
 func (p *Poller) Update(resp *http.Response) error {
-	state, err := armpollers.GetStatus(resp)
+	state, err := pollers.GetStatus(resp)
 	if err != nil {
 		return err
 	} else if state == "" {

sdk/azcore/arm/internal/pollers/loc/loc_test.go renamed to sdk/azcore/internal/pollers/armloc/loc_test.go

@@ -10,7 +10,6 @@ import (
 	"errors"
 	"net/http"
 
-	armpollers "github.com/Azure/azure-sdk-for-go/sdk/azcore/arm/internal/pollers"
 	"github.com/Azure/azure-sdk-for-go/sdk/azcore/internal/pollers"
 	"github.com/Azure/azure-sdk-for-go/sdk/internal/log"
 )
@@ -48,7 +47,7 @@ func New(resp *http.Response, pollerID string) (*Poller, error) {
 	// default initial state to InProgress.  depending on the HTTP
 	// status code and provisioning state, we might change the value.
 	curState := pollers.StatusInProgress
-	provState, err := armpollers.GetProvisioningState(resp)
+	provState, err := pollers.GetProvisioningState(resp)
 	if err != nil && !errors.Is(err, pollers.ErrNoBody) {
 		return nil, err
 	}
@@ -85,7 +84,7 @@ func (p *Poller) Update(resp *http.Response) error {
 		p.CurState = pollers.StatusSucceeded
 		return nil
 	}
-	state, err := armpollers.GetProvisioningState(resp)
+	state, err := pollers.GetProvisioningState(resp)
 	if errors.Is(err, pollers.ErrNoBody) {
 		// a missing response body in non-204 case is an error
 		return err