Efss backend fixes (#3526)

* [draft] improve ocmd send sourcePath 404 error message

* print error message when forwarding invite fails

* Resolve #3365 (comment)

* changelog entry

* report unexpected response codes from EFSS API

* fix

* Add appropriate PR link in changelog entry

* Also allow 201 responses

* Also throw on EFSS API response codes from other Nextcloud backends

* built

* Fix username in upload call path

* Improved error message

* trying to debug pondersource/sciencemesh-php#100

* Fix pondersource/sciencemesh-php#100

* fix share object in OCM share backend

* Fix double declaration of genID

* info logging

* syntax fix

* Improve 'request not handled' error message

* Init log

* fix pondersource/sciencemesh-php#114

* return JSON share object on ocm/send

* How do we tell Nextcloud which WebDAV server to mount this share from?

* read webdav host from config

* better error messages from OCM /share endpoint

* Fix pondersource/sciencemesh-php#91 (comment)

* Split owner string

* return JSON from invite forward

* message: Success

* Fix merge

* make lint (first try)

* make lint (second try)

* remove unnecessary newlines

* outdent

* gofmt -s pkg/storage/fs/nextcloud/nextcloud_server_mock.

* Fix changelog for calens

* Fix make test

* fix lint

* Prepend /home to all paths in mock server

* Run make lint-fix

* Improve error message on error sending accept post request

* tmpdir for gitpod

* reset server mock

* reset server mock

* Use helpers.TempDir

* integration tests now also use this TempDir

* apply https://github.com/cs3org/reva/pull/3526/files#r1042061882

* tests passing

* uncomment

* /workspace/reva/toolchain/golangci-lint run --fix

* Fix case /some

* make some paths relative

* original/location

* /workspace/reva/toolchain/golangci-lint run --fix

Co-authored-by: root <root@mesh.pondersource.org>
Co-authored-by: Michiel de Jong <michielbdejong@users.noreply.github.com>
Co-authored-by: Giuseppe Lo Presti <giuseppe.lopresti@cern.ch>
Co-authored-by: Vasco Guita <vasco@guita.org>

changelog/unreleased/improve-ocmd-error-logs.md

@@ -0,0 +1,6 @@
+Enhancement: Improve error logging in ocmd flow
+
+https://github.com/cs3org/reva/pull/3526
+https://github.com/cs3org/reva/pull/3419
+https://github.com/cs3org/reva/issues/3365
+https://github.com/cs3org/reva/pull/3369

internal/grpc/services/ocminvitemanager/ocminvitemanager.go

@@ -118,7 +118,7 @@ func (s *service) ForwardInvite(ctx context.Context, req *invitepb.ForwardInvite
 	err := s.im.ForwardInvite(ctx, req.InviteToken, req.OriginSystemProvider)
 	if err != nil {
 		return &invitepb.ForwardInviteResponse{
-			Status: status.NewInternal(ctx, err, "error forwarding invite"),
+			Status: status.NewInternal(ctx, err, "error forwarding invite:"+err.Error()),
 		}, nil
 	}
 
@@ -158,7 +158,7 @@ func (s *service) FindAcceptedUsers(ctx context.Context, req *invitepb.FindAccep
 	acceptedUsers, err := s.im.FindAcceptedUsers(ctx, req.Filter)
 	if err != nil {
 		return &invitepb.FindAcceptedUsersResponse{
-			Status: status.NewInternal(ctx, err, "error finding remote users"),
+			Status: status.NewInternal(ctx, err, "error finding remote users: "+err.Error()),
 		}, nil
 	}
 

internal/grpc/services/ocmshareprovider/ocmshareprovider.go

@@ -177,7 +177,7 @@ func (s *service) CreateOCMShare(ctx context.Context, req *ocm.CreateOCMShareReq
 
 	if err != nil {
 		return &ocm.CreateOCMShareResponse{
-			Status: status.NewInternal(ctx, err, "error creating share"),
+			Status: status.NewInternal(ctx, err, "error creating share: "+err.Error()),
 		}, nil
 	}
 

internal/http/services/ocmd/invites.go

@@ -190,7 +190,7 @@ func (h *invitesHandler) forwardInvite(w http.ResponseWriter, r *http.Request) {
 		return
 	}
 
-	_, err = w.Write([]byte("Accepted invite from: " + html.EscapeString(providerDomain)))
+	_, err = w.Write([]byte("{\"message\": \"Success\", \"providerDomain\":\"" + html.EscapeString(providerDomain) + "\"}"))
 	if err != nil {
 		WriteError(w, r, APIErrorServerError, "error writing token data", err)
 		return
@@ -313,6 +313,7 @@ func (h *invitesHandler) findAcceptedUsers(w http.ResponseWriter, r *http.Reques
 	indentedResponse, _ := json.MarshalIndent(response, "", "   ")
 	w.Header().Set("Content-Type", "application/json")
 	w.WriteHeader(http.StatusOK)
+	log.Debug().Msg("findAcceptedUsers json response: " + string(indentedResponse))
 	if _, err := w.Write(indentedResponse); err != nil {
 		log.Err(err).Msg("Error writing to ResponseWriter")
 	}

internal/http/services/ocmd/ocmd.go

@@ -125,9 +125,10 @@ func (s *svc) Handler() http.Handler {
 			return
 		case "send":
 			s.SendHandler.Handler().ServeHTTP(w, r)
+			return
 		}
 
-		log.Warn().Msg("request not handled")
+		log.Warn().Msgf("request not handled. Try e.g. 'ocm-provider', 'shares', 'notifications', 'invites', or 'send' instead of '%s'", head)
 		w.WriteHeader(http.StatusNotFound)
 	})
 }

internal/http/services/ocmd/send.go

@@ -36,6 +36,7 @@ import (
 	"github.com/cs3org/reva/pkg/appctx"
 	ctxpkg "github.com/cs3org/reva/pkg/ctx"
 	"github.com/cs3org/reva/pkg/rgrpc/todo/pool"
+	"github.com/cs3org/reva/pkg/utils"
 	"google.golang.org/grpc/metadata"
 )
 
@@ -109,13 +110,13 @@ func (h *sendHandler) Handler() http.Handler {
 		req := &provider.StatRequest{Ref: ref}
 		res2, err := gatewayClient.Stat(authCtx, req)
 		if err != nil {
-			log.Error().Msg("error sending: stat file/folder to share")
+			log.Error().Msg("gatewayClient.Stat operation failed; is the storage backend reachable?")
 			w.WriteHeader(http.StatusInternalServerError)
 			return
 		}
 
 		if res2.Status.Code != rpc.Code_CODE_OK {
-			log.Error().Msg("error returned: stat file/folder to share")
+			log.Error().Msgf("sourcePath %s does not exist on the storage backend", sourcePath)
 			w.WriteHeader(http.StatusInternalServerError)
 			return
 		}
@@ -183,17 +184,27 @@ func (h *sendHandler) Handler() http.Handler {
 
 		shareRes, err := gatewayClient.CreateOCMShare(authCtx, shareRequest)
 		if err != nil {
-			log.Error().Msg("error sending: CreateShare")
+			log.Error().Msg("error sending: CreateShare: " + err.Error())
 			w.WriteHeader(http.StatusInternalServerError)
 			return
 		}
 
 		if shareRes.Status.Code != rpc.Code_CODE_OK {
-			log.Error().Msg("error returned: CreateShare")
+			log.Error().Msg("error returned: CreateShare: " + err.Error())
 			w.WriteHeader(http.StatusInternalServerError)
 			return
 		}
 
+		responseBody, err := utils.MarshalProtoV1ToJSON(shareRes)
+		if err != nil {
+			log.Error().Msg("error encoding response: " + err.Error())
+			w.WriteHeader(http.StatusInternalServerError)
+			return
+		}
 		w.WriteHeader(http.StatusOK)
+		_, err = w.Write(responseBody)
+		if err != nil {
+			log.Error().Msg("error writing response body:" + err.Error())
+		}
 	})
 }

internal/http/services/ocmd/shares.go

@@ -100,11 +100,13 @@ func (h *sharesHandler) createShare(w http.ResponseWriter, r *http.Request) {
 	}
 
 	if resource == "" || providerID == "" || owner == "" {
-		WriteError(w, r, APIErrorInvalidParameter, "missing details about resource to be shared", nil)
+		msg := fmt.Sprintf("missing details about resource to be shared (resource='%s', providerID='%s', owner='%s", resource, providerID, owner)
+		WriteError(w, r, APIErrorInvalidParameter, msg, nil)
 		return
 	}
 	if shareWith == "" || protocol["name"] == "" || meshProvider == "" {
-		WriteError(w, r, APIErrorInvalidParameter, "missing request parameters", nil)
+		msg := fmt.Sprintf("missing request parameters (shareWith='%s', protocol.name='%s', meshProvider='%s'", shareWith, protocol["name"], meshProvider)
+		WriteError(w, r, APIErrorInvalidParameter, msg, nil)
 		return
 	}
 
@@ -188,9 +190,13 @@ func (h *sharesHandler) createShare(w http.ResponseWriter, r *http.Request) {
 		return
 	}
 
+	ownerParts := strings.Split(owner, "@")
+	if len(ownerParts) != 2 {
+		WriteError(w, r, APIErrorInvalidParameter, "owner should be opaqueId@webDAVHost", nil)
+	}
 	ownerID := &userpb.UserId{
-		OpaqueId: owner,
-		Idp:      meshProvider,
+		OpaqueId: ownerParts[0],
+		Idp:      ownerParts[1],
 		Type:     userpb.UserType_USER_TYPE_PRIMARY,
 	}
 	createShareReq := &ocmcore.CreateOCMCoreShareRequest{

pkg/auth/manager/nextcloud/nextcloud.go

@@ -22,8 +22,10 @@ package nextcloud
 import (
 	"context"
 	"encoding/json"
+	"fmt"
 	"io"
 	"net/http"
+	"strconv"
 	"strings"
 
 	authpb "github.com/cs3org/go-cs3apis/cs3/auth/provider/v1beta1"
@@ -141,6 +143,9 @@ func (am *Manager) do(ctx context.Context, a Action) (int, []byte, error) {
 	}
 
 	log.Info().Msgf("am.do response %d %s", resp.StatusCode, body)
+	if resp.StatusCode != http.StatusOK && resp.StatusCode != http.StatusCreated {
+		return 0, nil, fmt.Errorf("Unexpected response code from EFSS API: " + strconv.Itoa(resp.StatusCode))
+	}
 	return resp.StatusCode, body, nil
 }
 

pkg/ocm/invite/manager/json/json.go

@@ -34,6 +34,7 @@ import (
 	userpb "github.com/cs3org/go-cs3apis/cs3/identity/user/v1beta1"
 	invitepb "github.com/cs3org/go-cs3apis/cs3/ocm/invite/v1beta1"
 	ocmprovider "github.com/cs3org/go-cs3apis/cs3/ocm/provider/v1beta1"
+	"github.com/cs3org/reva/pkg/appctx"
 	ctxpkg "github.com/cs3org/reva/pkg/ctx"
 	"github.com/cs3org/reva/pkg/errtypes"
 	"github.com/cs3org/reva/pkg/ocm/invite"
@@ -235,7 +236,7 @@ func (m *manager) ForwardInvite(ctx context.Context, invite *invitepb.InviteToke
 		if e != nil {
 			return errors.Wrap(e, "json: error reading request body")
 		}
-		return errors.Wrap(fmt.Errorf("%s: %s", resp.Status, string(respBody)), "json: error sending accept post request")
+		return errors.Wrap(fmt.Errorf("%s: %s", resp.Status, string(respBody)), fmt.Sprintf("json: error sending accept post request to %s", recipientURL))
 	}
 
 	return nil
@@ -272,7 +273,14 @@ func (m *manager) AcceptInvite(ctx context.Context, invite *invitepb.InviteToken
 
 func (m *manager) GetAcceptedUser(ctx context.Context, remoteUserID *userpb.UserId) (*userpb.User, error) {
 	userKey := ctxpkg.ContextMustGetUser(ctx).GetId().GetOpaqueId()
+	log := appctx.GetLogger(ctx)
 	for _, acceptedUser := range m.model.AcceptedUsers[userKey] {
+		log.Info().Msgf("looking for '%s' at '%s' - considering '%s' at '%s'",
+			remoteUserID.OpaqueId,
+			remoteUserID.Idp,
+			acceptedUser.Id.GetOpaqueId(),
+			acceptedUser.Id.GetIdp(),
+		)
 		if (acceptedUser.Id.GetOpaqueId() == remoteUserID.OpaqueId) && (remoteUserID.Idp == "" || acceptedUser.Id.GetIdp() == remoteUserID.Idp) {
 			return acceptedUser, nil
 		}

pkg/ocm/share/manager/json/json.go

@@ -32,6 +32,7 @@ import (
 	ocm "github.com/cs3org/go-cs3apis/cs3/sharing/ocm/v1beta1"
 	provider "github.com/cs3org/go-cs3apis/cs3/storage/provider/v1beta1"
 	typespb "github.com/cs3org/go-cs3apis/cs3/types/v1beta1"
+	"github.com/cs3org/reva/pkg/appctx"
 	ctxpkg "github.com/cs3org/reva/pkg/ctx"
 	"github.com/cs3org/reva/pkg/errtypes"
 	"github.com/cs3org/reva/pkg/ocm/share"
@@ -264,6 +265,15 @@ func (m *mgr) Share(ctx context.Context, md *provider.ResourceId, g *ocm.ShareGr
 			protocol["name"] = "datatx"
 		}
 
+		log := appctx.GetLogger(ctx)
+		log.Info().Msg("pkg/ocm/share/manager/json calls sender.Send")
+		log.Info().Msgf("pkg/ocm/share/manager/json shareWith: %s", g.Grantee.GetUserId().OpaqueId)
+		log.Info().Msgf("pkg/ocm/share/manager/json name: %s", name)
+		log.Info().Msgf("pkg/ocm/share/manager/json providerId: %s", fmt.Sprintf("%s:%s", md.StorageId, md.OpaqueId))
+		log.Info().Msgf("pkg/ocm/share/manager/json owner: %s", userID.OpaqueId)
+		log.Info().Msgf("pkg/ocm/share/manager/json protocol: %s", protocol)
+		log.Info().Msgf("pkg/ocm/share/manager/json meshProvider: %s", userID.Idp)
+
 		requestBodyMap := map[string]interface{}{
 			"shareWith":    g.Grantee.GetUserId().OpaqueId,
 			"name":         name,
@@ -272,7 +282,7 @@ func (m *mgr) Share(ctx context.Context, md *provider.ResourceId, g *ocm.ShareGr
 			"protocol":     protocol,
 			"meshProvider": userID.Idp, // FIXME: move this into the 'owner' string?
 		}
-		err = sender.Send(requestBodyMap, pi)
+		err = sender.Send(ctx, requestBodyMap, pi)
 		if err != nil {
 			err = errors.Wrap(err, "error sending OCM POST")
 			return nil, err