Move LRO failure detection to the implementing poller (Azure#17758)

Previously, the Poller.Poll() method was determining when an LRO failed. While this works for well-known states, it's not extensible. Instead, the underlying polling implementation should be responsible for determining if it's reached a terminal state (failure or otherwise).
azure-sdk · Apr 28, 2022 · 55c54b4 · 55c54b4
1 parent 297fbb1
commit 55c54b4
Show file tree

Hide file tree

Showing 14 changed files with 144 additions and 182 deletions.
diff --git a/sdk/azcore/internal/pollers/armloc/loc.go b/sdk/azcore/internal/pollers/armloc/loc.go
@@ -60,9 +60,14 @@ func (p *Poller) URL() string {
 	return p.PollURL
 }
 
-// Done returns true if the LRO has reached a terminal state.
-func (p *Poller) Done() bool {
-	return pollers.IsTerminalState(p.Status())
+// State returns the current state of the LRO.
+func (p *Poller) State() pollers.OperationState {
+	if p.CurState == pollers.StatusSucceeded {
+		return pollers.OperationStateSucceeded
+	} else if pollers.IsTerminalState(p.CurState) {
+		return pollers.OperationStateFailed
+	}
+	return pollers.OperationStateInProgress
 }
 
 // Update updates the Poller from the polling response.
@@ -96,8 +101,3 @@ func (p *Poller) Update(resp *http.Response) error {
 func (p *Poller) FinalGetURL() string {
 	return ""
 }
-
-// Status returns the status of the LRO.
-func (p *Poller) Status() string {
-	return p.CurState
-}
diff --git a/sdk/azcore/internal/pollers/armloc/loc_test.go b/sdk/azcore/internal/pollers/armloc/loc_test.go
@@ -13,6 +13,7 @@ import (
 	"strings"
 	"testing"
 
+	"github.com/Azure/azure-sdk-for-go/sdk/azcore/internal/pollers"
 	"github.com/Azure/azure-sdk-for-go/sdk/azcore/internal/shared"
 )
 
@@ -57,13 +58,10 @@ func TestNew(t *testing.T) {
 	if err != nil {
 		t.Fatal(err)
 	}
-	if poller.Done() {
-		t.Fatal("poller should not be done")
-	}
 	if u := poller.FinalGetURL(); u != "" {
 		t.Fatal("expected empty final GET URL")
 	}
-	if s := poller.Status(); s != "InProgress" {
+	if s := poller.State(); s != pollers.OperationStateInProgress {
 		t.Fatalf("unexpected status %s", s)
 	}
 	if u := poller.URL(); u != fakePollingURL1 {
@@ -80,13 +78,13 @@ func TestNew(t *testing.T) {
 	if err := poller.Update(pollingResponse(http.StatusNoContent, http.NoBody)); err != nil {
 		t.Fatal(err)
 	}
-	if s := poller.Status(); s != "Succeeded" {
+	if s := poller.State(); s != pollers.OperationStateSucceeded {
 		t.Fatalf("unexpected status %s", s)
 	}
 	if err := poller.Update(pollingResponse(http.StatusConflict, http.NoBody)); err != nil {
 		t.Fatal(err)
 	}
-	if s := poller.Status(); s != "Failed" {
+	if s := poller.State(); s != pollers.OperationStateFailed {
 		t.Fatalf("unexpected status %s", s)
 	}
 }
@@ -98,13 +96,10 @@ func TestUpdateWithProvState(t *testing.T) {
 	if err != nil {
 		t.Fatal(err)
 	}
-	if poller.Done() {
-		t.Fatal("poller should not be done")
-	}
 	if u := poller.FinalGetURL(); u != "" {
 		t.Fatal("expected empty final GET URL")
 	}
-	if s := poller.Status(); s != "InProgress" {
+	if s := poller.State(); s != pollers.OperationStateInProgress {
 		t.Fatalf("unexpected status %s", s)
 	}
 	if u := poller.URL(); u != fakePollingURL1 {
@@ -121,13 +116,13 @@ func TestUpdateWithProvState(t *testing.T) {
 	if err := poller.Update(pollingResponse(http.StatusOK, strings.NewReader(`{ "properties": { "provisioningState": "Updating" } }`))); err != nil {
 		t.Fatal(err)
 	}
-	if s := poller.Status(); s != "Updating" {
+	if s := poller.State(); s != pollers.OperationStateInProgress {
 		t.Fatalf("unexpected status %s", s)
 	}
 	if err := poller.Update(pollingResponse(http.StatusOK, http.NoBody)); err != nil {
 		t.Fatal(err)
 	}
-	if s := poller.Status(); s != "Succeeded" {
+	if s := poller.State(); s != pollers.OperationStateSucceeded {
 		t.Fatalf("unexpected status %s", s)
 	}
 }
diff --git a/sdk/azcore/internal/pollers/async/async.go b/sdk/azcore/internal/pollers/async/async.go
@@ -85,9 +85,14 @@ func New(resp *http.Response, finalState pollers.FinalStateVia, pollerID string)
 	return p, nil
 }
 
-// Done returns true if the LRO has reached a terminal state.
-func (p *Poller) Done() bool {
-	return pollers.IsTerminalState(p.Status())
+// State returns the current state of the LRO.
+func (p *Poller) State() pollers.OperationState {
+	if p.CurState == pollers.StatusSucceeded {
+		return pollers.OperationStateSucceeded
+	} else if pollers.IsTerminalState(p.CurState) {
+		return pollers.OperationStateFailed
+	}
+	return pollers.OperationStateInProgress
 }
 
 // Update updates the Poller from the polling response.
@@ -125,8 +130,3 @@ func (p *Poller) FinalGetURL() string {
 func (p *Poller) URL() string {
 	return p.AsyncURL
 }
-
-// Status returns the status of the LRO.
-func (p *Poller) Status() string {
-	return p.CurState
-}
diff --git a/sdk/azcore/internal/pollers/async/async_test.go b/sdk/azcore/internal/pollers/async/async_test.go
@@ -13,6 +13,7 @@ import (
 	"strings"
 	"testing"
 
+	"github.com/Azure/azure-sdk-for-go/sdk/azcore/internal/pollers"
 	"github.com/Azure/azure-sdk-for-go/sdk/azcore/internal/shared"
 )
 
@@ -61,13 +62,10 @@ func TestNew(t *testing.T) {
 	if err != nil {
 		t.Fatal(err)
 	}
-	if poller.Done() {
-		t.Fatal("poller should not be done")
-	}
 	if u := poller.FinalGetURL(); u != fakeResourceURL {
 		t.Fatalf("unexpected final get URL %s", u)
 	}
-	if s := poller.Status(); s != "Started" {
+	if s := poller.State(); s != pollers.OperationStateInProgress {
 		t.Fatalf("unexpected status %s", s)
 	}
 	if u := poller.URL(); u != fakePollingURL {
@@ -76,7 +74,7 @@ func TestNew(t *testing.T) {
 	if err := poller.Update(pollingResponse(strings.NewReader(`{ "status": "InProgress" }`))); err != nil {
 		t.Fatal(err)
 	}
-	if s := poller.Status(); s != "InProgress" {
+	if s := poller.State(); s != pollers.OperationStateInProgress {
 		t.Fatalf("unexpected status %s", s)
 	}
 }
@@ -88,10 +86,7 @@ func TestNewDeleteNoProvState(t *testing.T) {
 	if err != nil {
 		t.Fatal(err)
 	}
-	if poller.Done() {
-		t.Fatal("poller should not be done")
-	}
-	if s := poller.Status(); s != "InProgress" {
+	if s := poller.State(); s != pollers.OperationStateInProgress {
 		t.Fatalf("unexpected status %s", s)
 	}
 }
@@ -105,10 +100,7 @@ func TestNewPutNoProvState(t *testing.T) {
 	if err != nil {
 		t.Fatal(err)
 	}
-	if poller.Done() {
-		t.Fatal("poller should not be done")
-	}
-	if s := poller.Status(); s != "InProgress" {
+	if s := poller.State(); s != pollers.OperationStateInProgress {
 		t.Fatalf("unexpected status %s", s)
 	}
 }
@@ -125,8 +117,8 @@ func TestNewFinalGetLocation(t *testing.T) {
 	if err != nil {
 		t.Fatal(err)
 	}
-	if poller.Done() {
-		t.Fatal("poller should not be done")
+	if s := poller.State(); s != pollers.OperationStateInProgress {
+		t.Fatalf("unexpected status %s", s)
 	}
 	if u := poller.FinalGetURL(); u != locURL {
 		t.Fatalf("unexpected final get URL %s", u)
@@ -148,8 +140,8 @@ func TestNewFinalGetOrigin(t *testing.T) {
 	if err != nil {
 		t.Fatal(err)
 	}
-	if poller.Done() {
-		t.Fatal("poller should not be done")
+	if s := poller.State(); s != pollers.OperationStateInProgress {
+		t.Fatalf("unexpected status %s", s)
 	}
 	if u := poller.FinalGetURL(); u != fakeResourceURL {
 		t.Fatalf("unexpected final get URL %s", u)
@@ -168,10 +160,7 @@ func TestNewPutNoProvStateOnUpdate(t *testing.T) {
 	if err != nil {
 		t.Fatal(err)
 	}
-	if poller.Done() {
-		t.Fatal("poller should not be done")
-	}
-	if s := poller.Status(); s != "InProgress" {
+	if s := poller.State(); s != pollers.OperationStateInProgress {
 		t.Fatalf("unexpected status %s", s)
 	}
 	if err := poller.Update(pollingResponse(strings.NewReader("{}"))); err == nil {

diff --git a/sdk/azcore/internal/pollers/body/body.go b/sdk/azcore/internal/pollers/body/body.go
@@ -73,9 +73,14 @@ func (p *Poller) URL() string {
 	return p.PollURL
 }
 
-// Done returns true if the LRO has reached a terminal state.
-func (p *Poller) Done() bool {
-	return pollers.IsTerminalState(p.Status())
+// State returns the current state of the LRO.
+func (p *Poller) State() pollers.OperationState {
+	if p.CurState == pollers.StatusSucceeded {
+		return pollers.OperationStateSucceeded
+	} else if pollers.IsTerminalState(p.CurState) {
+		return pollers.OperationStateFailed
+	}
+	return pollers.OperationStateInProgress
 }
 
 // Update updates the Poller from the polling response.
@@ -102,8 +107,3 @@ func (p *Poller) Update(resp *http.Response) error {
 func (*Poller) FinalGetURL() string {
 	return ""
 }
-
-// Status returns the status of the LRO.
-func (p *Poller) Status() string {
-	return p.CurState
-}
diff --git a/sdk/azcore/internal/pollers/body/body_test.go b/sdk/azcore/internal/pollers/body/body_test.go
@@ -69,13 +69,10 @@ func TestNew(t *testing.T) {
 	if err != nil {
 		t.Fatal(err)
 	}
-	if poller.Done() {
-		t.Fatal("poller should not be done")
-	}
 	if u := poller.FinalGetURL(); u != "" {
 		t.Fatal("expected empty final GET URL")
 	}
-	if s := poller.Status(); s != "Started" {
+	if s := poller.State(); s != pollers.OperationStateInProgress {
 		t.Fatalf("unexpected status %s", s)
 	}
 	if u := poller.URL(); u != fakeResourceURL {
@@ -84,7 +81,7 @@ func TestNew(t *testing.T) {
 	if err := poller.Update(pollingResponse(http.StatusOK, strings.NewReader(`{ "properties": { "provisioningState": "InProgress" } }`))); err != nil {
 		t.Fatal(err)
 	}
-	if s := poller.Status(); s != "InProgress" {
+	if s := poller.State(); s != pollers.OperationStateInProgress {
 		t.Fatalf("unexpected status %s", s)
 	}
 }
@@ -97,13 +94,10 @@ func TestUpdateNoProvStateFail(t *testing.T) {
 	if err != nil {
 		t.Fatal(err)
 	}
-	if poller.Done() {
-		t.Fatal("poller should not be done")
-	}
 	if u := poller.FinalGetURL(); u != "" {
 		t.Fatal("expected empty final GET URL")
 	}
-	if s := poller.Status(); s != "Started" {
+	if s := poller.State(); s != pollers.OperationStateInProgress {
 		t.Fatalf("unexpected status %s", s)
 	}
 	if u := poller.URL(); u != fakeResourceURL {
@@ -126,13 +120,10 @@ func TestUpdateNoProvStateSuccess(t *testing.T) {
 	if err != nil {
 		t.Fatal(err)
 	}
-	if poller.Done() {
-		t.Fatal("poller should not be done")
-	}
 	if u := poller.FinalGetURL(); u != "" {
 		t.Fatal("expected empty final GET URL")
 	}
-	if s := poller.Status(); s != "Started" {
+	if s := poller.State(); s != pollers.OperationStateInProgress {
 		t.Fatalf("unexpected status %s", s)
 	}
 	if u := poller.URL(); u != fakeResourceURL {
@@ -152,13 +143,10 @@ func TestUpdateNoProvState204(t *testing.T) {
 	if err != nil {
 		t.Fatal(err)
 	}
-	if poller.Done() {
-		t.Fatal("poller should not be done")
-	}
 	if u := poller.FinalGetURL(); u != "" {
 		t.Fatal("expected empty final GET URL")
 	}
-	if s := poller.Status(); s != "Started" {
+	if s := poller.State(); s != pollers.OperationStateInProgress {
 		t.Fatalf("unexpected status %s", s)
 	}
 	if u := poller.URL(); u != fakeResourceURL {
@@ -177,13 +165,10 @@ func TestNewNoInitialProvStateOK(t *testing.T) {
 	if err != nil {
 		t.Fatal(err)
 	}
-	if !poller.Done() {
-		t.Fatal("poller not be done")
-	}
 	if u := poller.FinalGetURL(); u != "" {
 		t.Fatal("expected empty final GET URL")
 	}
-	if s := poller.Status(); s != "Succeeded" {
+	if s := poller.State(); s != pollers.OperationStateSucceeded {
 		t.Fatalf("unexpected status %s", s)
 	}
 }
@@ -195,13 +180,10 @@ func TestNewNoInitialProvStateNC(t *testing.T) {
 	if err != nil {
 		t.Fatal(err)
 	}
-	if !poller.Done() {
-		t.Fatal("poller not be done")
-	}
 	if u := poller.FinalGetURL(); u != "" {
 		t.Fatal("expected empty final GET URL")
 	}
-	if s := poller.Status(); s != "Succeeded" {
+	if s := poller.State(); s != pollers.OperationStateSucceeded {
 		t.Fatalf("unexpected status %s", s)
 	}
 }
diff --git a/sdk/azcore/internal/pollers/loc/loc.go b/sdk/azcore/internal/pollers/loc/loc.go
@@ -56,8 +56,14 @@ func (p *Poller) URL() string {
 	return p.PollURL
 }
 
-func (p *Poller) Done() bool {
-	return pollers.IsTerminalState(p.Status())
+func (p *Poller) State() pollers.OperationState {
+	if p.CurState == http.StatusAccepted {
+		return pollers.OperationStateInProgress
+	} else if p.CurState > 199 && p.CurState < 300 {
+		// any 2xx other than a 202 indicates success
+		return pollers.OperationStateSucceeded
+	}
+	return pollers.OperationStateFailed
 }
 
 func (p *Poller) Update(resp *http.Response) error {
@@ -72,13 +78,3 @@ func (p *Poller) Update(resp *http.Response) error {
 func (p *Poller) FinalGetURL() string {
 	return p.FinalGET
 }
-
-func (p *Poller) Status() string {
-	if p.CurState == http.StatusAccepted {
-		return pollers.StatusInProgress
-	} else if p.CurState > 199 && p.CurState < 300 {
-		// any 2xx other than a 202 indicates success
-		return pollers.StatusSucceeded
-	}
-	return pollers.StatusFailed
-}