feat(go-client): add poll for processed (#491)

Author: JGAntunes

go/porcelain/deploy.go

@@ -403,11 +403,16 @@ func (n *Netlify) WaitUntilDeployReady(ctx context.Context, d *models.Deploy) (*
 	return n.waitForState(ctx, d, "prepared", "ready")
 }
 
-// WaitUntilDeployLive blocks until the deploy is in the "ready" state. At this point, the deploy is ready to recieve traffic.
+// WaitUntilDeployLive blocks until the deploy is in the "ready" state. At this point, the deploy is ready to receive traffic to all of its URLs.
 func (n *Netlify) WaitUntilDeployLive(ctx context.Context, d *models.Deploy) (*models.Deploy, error) {
 	return n.waitForState(ctx, d, "ready")
 }
 
+// WaitUntilDeployProcessed blocks until the deploy is in the "processed" state. At this point, the deploy is ready to receive traffic via its permalink.
+func (n *Netlify) WaitUntilDeployProcessed(ctx context.Context, d *models.Deploy) (*models.Deploy, error) {
+	return n.waitForState(ctx, d, "processed")
+}
+
 func (n *Netlify) uploadFiles(ctx context.Context, d *models.Deploy, files *deployFiles, observer DeployObserver, t uploadType, timeout time.Duration, skipRetry bool) error {
 	sharedErr := &uploadError{err: nil, mutex: &sync.Mutex{}}
 	sem := make(chan int, n.uploadLimit)

go/porcelain/deploy_test.go

@@ -132,17 +132,64 @@ func TestWaitUntilDeployLive_Timeout(t *testing.T) {
 	}))
 	defer server.Close()
 
-	hu, _ := url.Parse(server.URL)
+	hu, err := url.Parse(server.URL)
+	require.NoError(t, err)
 	tr := apiClient.NewWithClient(hu.Host, "/api/v1", []string{"http"}, http.DefaultClient)
 	client := NewRetryable(tr, strfmt.Default, 1)
 
 	ctx := context.WithAuthInfo(gocontext.Background(), apiClient.BearerToken("token"))
 	ctx, _ = gocontext.WithTimeout(ctx, 50*time.Millisecond)
-	_, err := client.WaitUntilDeployLive(ctx, &models.Deploy{})
+	_, err = client.WaitUntilDeployLive(ctx, &models.Deploy{})
 	assert.Error(t, err)
 	assert.Contains(t, err.Error(), "timed out")
 }
 
+func TestWaitUntilDeployProcessed_Success(t *testing.T) {
+	reqNum := 0
+	server := httptest.NewServer(http.HandlerFunc(func(rw http.ResponseWriter, req *http.Request) {
+		reqNum++
+		rw.Header().Set("Content-Type", "application/json; charset=utf-8")
+
+		// validate the polling actually works
+		if reqNum > 1 {
+			rw.Write([]byte(`{ "state": "processed" }`))
+		} else {
+			rw.Write([]byte(`{ "state": "processing" }`))
+		}
+	}))
+	defer server.Close()
+
+	hu, err := url.Parse(server.URL)
+	require.NoError(t, err)
+	tr := apiClient.NewWithClient(hu.Host, "/api/v1", []string{"http"}, http.DefaultClient)
+	client := NewRetryable(tr, strfmt.Default, 1)
+
+	ctx := context.WithAuthInfo(gocontext.Background(), apiClient.BearerToken("token"))
+	ctx, _ = gocontext.WithTimeout(ctx, 30*time.Second)
+	d, err := client.WaitUntilDeployProcessed(ctx, &models.Deploy{})
+	require.NoError(t, err)
+	assert.Equal(t, "processed", d.State)
+}
+
+func TestWaitUntilDeployProcessed_Timeout(t *testing.T) {
+	server := httptest.NewServer(http.HandlerFunc(func(rw http.ResponseWriter, req *http.Request) {
+		rw.Header().Set("Content-Type", "application/json; charset=utf-8")
+		rw.Write([]byte(`{ "state": "processing" }`))
+	}))
+	defer server.Close()
+
+	hu, err := url.Parse(server.URL)
+	require.NoError(t, err)
+	tr := apiClient.NewWithClient(hu.Host, "/api/v1", []string{"http"}, http.DefaultClient)
+	client := NewRetryable(tr, strfmt.Default, 1)
+
+	ctx := context.WithAuthInfo(gocontext.Background(), apiClient.BearerToken("token"))
+	ctx, _ = gocontext.WithTimeout(ctx, 50*time.Millisecond)
+	_, err = client.WaitUntilDeployProcessed(ctx, &models.Deploy{})
+	require.Error(t, err)
+	assert.Contains(t, err.Error(), "timed out")
+}
+
 func TestWalk_IgnoreNodeModulesInRoot(t *testing.T) {
 	dir, err := ioutil.TempDir("", "deploy")
 	require.Nil(t, err)

swagger.yml

@@ -935,6 +935,7 @@ paths:
           - preparing
           - prepared
           - processing
+          - processed
           - ready
           - error
           - retrying