refactor(api): move bzz patch under the stewardship endpoint (#2356)

openapi/Swarm.yaml

@@ -232,7 +232,8 @@ paths:
 
   "/bzz/{reference}":
     patch:
-      summary: "Reupload a root hash to the network"
+      summary: "Reupload a root hash to the network; deprecated: use /stewardship/{reference} instead"
+      deprecated: true
       tags:
         - BZZ
       parameters:
@@ -849,3 +850,22 @@ paths:
         default:
           description: Default response
 
+  "/stewardship/{reference}":
+    put:
+      summary: "Reupload a root hash to the network"
+      tags:
+        - Stewardship
+      parameters:
+        - in: path
+          name: reference
+          schema:
+            $ref: "SwarmCommon.yaml#/components/schemas/SwarmReference"
+          required: true
+          description: "Root hash of content (can be of any type: collection, file, chunk)"
+      responses:
+        "200":
+          description: Ok
+        "500":
+          $ref: "SwarmCommon.yaml#/components/responses/500"
+        default:
+          description: Default response
\ No newline at end of file

pkg/api/bzz.go

@@ -522,6 +522,7 @@ func (s *server) manifestFeed(
 	return s.feedFactory.NewLookup(*t, f)
 }
 
+// bzzPatchHandler endpoint has been deprecated; use stewardship endpoint instead.
 func (s *server) bzzPatchHandler(w http.ResponseWriter, r *http.Request) {
 	nameOrHex := mux.Vars(r)["address"]
 	address, err := s.resolveNameOrAddress(nameOrHex)

pkg/api/bzz_test.go

@@ -625,12 +625,3 @@ func TestBzzReupload(t *testing.T) {
 		t.Fatalf("got address %s want %s", m.addr.String(), addr.String())
 	}
 }
-
-type mockSteward struct {
-	addr swarm.Address
-}
-
-func (m *mockSteward) Reupload(_ context.Context, addr swarm.Address) error {
-	m.addr = addr
-	return nil
-}

pkg/api/router.go

@@ -177,6 +177,13 @@ func (s *server) setupRouting() {
 		})),
 	)
 
+	handle("/stewardship/{address}", jsonhttp.MethodHandler{
+		"PUT": web.ChainHandlers(
+			s.gatewayModeForbidEndpointHandler,
+			web.FinalHandlerFunc(s.stewardshipPutHandler),
+		),
+	})
+
 	s.Handler = web.ChainHandlers(
 		httpaccess.NewHTTPAccessLogHandler(s.logger, logrus.InfoLevel, s.tracer, "api access"),
 		handlers.CompressHandler,

pkg/api/stewardship.go

+// Copyright 2021 The Swarm Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+package api
+
+import (
+	"net/http"
+
+	"github.com/ethersphere/bee/pkg/jsonhttp"
+	"github.com/gorilla/mux"
+)
+
+//  stewardshipPutHandler re-uploads root hash and all of its underlying
+// associated chunks to the network.
+func (s *server) stewardshipPutHandler(w http.ResponseWriter, r *http.Request) {
+	nameOrHex := mux.Vars(r)["address"]
+	address, err := s.resolveNameOrAddress(nameOrHex)
+	if err != nil {
+		s.logger.Debugf("stewardship put: parse address %s: %v", nameOrHex, err)
+		s.logger.Error("stewardship put: parse address")
+		jsonhttp.NotFound(w, nil)
+		return
+	}
+	err = s.steward.Reupload(r.Context(), address)
+	if err != nil {
+		s.logger.Debugf("stewardship put: re-upload %s: %v", address, err)
+		s.logger.Error("stewardship put: re-upload")
+		jsonhttp.InternalServerError(w, nil)
+		return
+	}
+	jsonhttp.OK(w, nil)
+}

pkg/api/stewardship_test.go

+// Copyright 2021 The Swarm Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+package api_test
+
+import (
+	"context"
+	"io/ioutil"
+	"net/http"
+	"testing"
+
+	"github.com/ethersphere/bee/pkg/jsonhttp"
+	"github.com/ethersphere/bee/pkg/jsonhttp/jsonhttptest"
+	"github.com/ethersphere/bee/pkg/logging"
+	statestore "github.com/ethersphere/bee/pkg/statestore/mock"
+	smock "github.com/ethersphere/bee/pkg/storage/mock"
+	"github.com/ethersphere/bee/pkg/swarm"
+	"github.com/ethersphere/bee/pkg/tags"
+)
+
+func TestStewardshipReUpload(t *testing.T) {
+	var (
+		logger         = logging.New(ioutil.Discard, 0)
+		mockStatestore = statestore.NewStateStore()
+		m              = &mockSteward{}
+		storer         = smock.NewStorer()
+		addr           = swarm.NewAddress([]byte{31: 128})
+	)
+	client, _, _ := newTestServer(t, testServerOptions{
+		Storer:  storer,
+		Tags:    tags.NewTags(mockStatestore, logger),
+		Logger:  logger,
+		Steward: m,
+	})
+	jsonhttptest.Request(t, client, http.MethodPut, "/v1/stewardship/"+addr.String(), http.StatusOK,
+		jsonhttptest.WithExpectedJSONResponse(jsonhttp.StatusResponse{
+			Message: http.StatusText(http.StatusOK),
+			Code:    http.StatusOK,
+		}),
+	)
+	if !m.addr.Equal(addr) {
+		t.Fatalf("\nhave address: %q\nwant address: %q", m.addr.String(), addr.String())
+	}
+}
+
+type mockSteward struct {
+	addr swarm.Address
+}
+
+func (m *mockSteward) Reupload(_ context.Context, addr swarm.Address) error {
+	m.addr = addr
+	return nil
+}