Fix VFS pagination on root dir (skipping properly the trash)

web/files/paginated.go

@@ -36,25 +36,63 @@ func newDir(doc *vfs.DirDoc) *dir {
 	return &dir{doc: doc}
 }
 
-func dirData(c echo.Context, statusCode int, doc *vfs.DirDoc) error {
+func getDirData(c echo.Context, doc *vfs.DirDoc) (int, couchdb.Cursor, []vfs.DirOrFileDoc, error) {
 	instance := middlewares.GetInstance(c)
 	fs := instance.VFS()
 
 	cursor, err := jsonapi.ExtractPaginationCursor(c, defPerPage)
 	if err != nil {
-		return err
+		return 0, nil, nil, err
 	}
 
 	count, err := fs.DirLength(doc)
 	if err != nil {
-		return err
+		return 0, nil, nil, err
 	}
-	// Do not count the trash folder when listing the root directory.
-	if count > 0 && doc.ID() == consts.RootDirID {
-		count--
+
+	// Hide the trash folder when listing the root directory.
+	var limit int
+	if doc.ID() == consts.RootDirID {
+		if count > 0 {
+			count--
+		}
+		switch c := cursor.(type) {
+		case *couchdb.StartKeyCursor:
+			limit = c.Limit
+			if c.NextKey == nil {
+				c.Limit++
+			}
+		case *couchdb.SkipCursor:
+			limit = c.Limit
+			if c.Skip == 0 {
+				c.Limit++
+			} else {
+				c.Skip++
+			}
+		}
 	}
 
 	children, err := fs.DirBatch(doc, cursor)
+	if err != nil {
+		return 0, nil, nil, err
+	}
+
+	if doc.ID() == consts.RootDirID {
+		switch c := cursor.(type) {
+		case *couchdb.StartKeyCursor:
+			c.Limit = limit
+		case *couchdb.SkipCursor:
+			c.Limit = limit
+			c.Skip--
+		}
+	}
+
+	return count, cursor, children, nil
+}
+
+func dirData(c echo.Context, statusCode int, doc *vfs.DirDoc) error {
+	instance := middlewares.GetInstance(c)
+	count, cursor, children, err := getDirData(c, doc)
 	if err != nil {
 		return err
 	}
@@ -111,6 +149,7 @@ func dirData(c echo.Context, statusCode int, doc *vfs.DirDoc) error {
 		}
 		next := "/files/" + doc.DocID + "/relationships/contents?" + params.Encode()
 		rel["contents"].Links.Next = next
+		links.Next = "/files/" + doc.DocID + "?" + params.Encode()
 	}
 
 	d := &dir{
@@ -123,24 +162,8 @@ func dirData(c echo.Context, statusCode int, doc *vfs.DirDoc) error {
 }
 
 func dirDataList(c echo.Context, statusCode int, doc *vfs.DirDoc) error {
-	cursor, err := jsonapi.ExtractPaginationCursor(c, defPerPage)
-	if err != nil {
-		return err
-	}
-
 	instance := middlewares.GetInstance(c)
-	fs := instance.VFS()
-
-	count, err := fs.DirLength(doc)
-	if err != nil {
-		return err
-	}
-	// Do not count the trash folder when listing the root directory.
-	if count > 0 && doc.ID() == consts.RootDirID {
-		count--
-	}
-
-	children, err := fs.DirBatch(doc, cursor)
+	count, cursor, children, err := getDirData(c, doc)
 	if err != nil {
 		return err
 	}

web/files/pagination_test.go

@@ -6,6 +6,7 @@ import (
 	"strconv"
 	"testing"
 
+	"github.com/cozy/cozy-stack/pkg/consts"
 	"github.com/cozy/cozy-stack/pkg/couchdb"
 	"github.com/cozy/cozy-stack/web/jsonapi"
 	"github.com/stretchr/testify/assert"
@@ -21,6 +22,81 @@ func getJSON(t *testing.T, url string, out interface{}) error {
 
 }
 
+func TestTrashIsSkipped(t *testing.T) {
+	nb := 15
+	body := "foo"
+	for i := 0; i < nb; i++ {
+		name := "foo" + strconv.Itoa(i)
+		upload(t, "/files/io.cozy.files.root-dir?Type=file&Name="+name, "text/plain", body, "rL0Y20zC+Fzt72VPzMSk2A==")
+	}
+
+	var opts = &url.Values{}
+	opts.Add("page[limit]", "5")
+	var result struct {
+		Data struct {
+			Relationships struct {
+				Contents struct {
+					Links *jsonapi.LinksList
+					Data  []couchdb.DocReference
+				}
+			}
+		}
+		Included []interface{}
+		Links    *jsonapi.LinksList
+	}
+
+	ids := []string{}
+
+	getJSON(t, "/files/io.cozy.files.root-dir?"+opts.Encode(), &result)
+	assert.Len(t, result.Data.Relationships.Contents.Data, 5)
+	assert.Len(t, result.Included, 5)
+
+	for i, ref := range result.Data.Relationships.Contents.Data {
+		id := result.Included[i].(map[string]interface{})["id"].(string)
+		assert.Equal(t, id, ref.ID)
+		assert.NotEqual(t, id, consts.TrashDirID)
+		for _, seen := range ids {
+			assert.NotEqual(t, id, seen)
+		}
+		ids = append(ids, id)
+	}
+
+	next := result.Links.Next
+	assert.NotEmpty(t, next)
+
+	getJSON(t, next, &result)
+	assert.Len(t, result.Data.Relationships.Contents.Data, 5)
+	assert.Len(t, result.Included, 5)
+
+	for i, ref := range result.Data.Relationships.Contents.Data {
+		id := result.Included[i].(map[string]interface{})["id"].(string)
+		assert.Equal(t, id, ref.ID)
+		assert.NotEqual(t, id, consts.TrashDirID)
+		for _, seen := range ids {
+			assert.NotEqual(t, id, seen)
+		}
+		ids = append(ids, id)
+	}
+
+	next = result.Links.Next
+	assert.NotEmpty(t, next)
+
+	opts.Add("page[skip]", "10")
+	getJSON(t, "/files/io.cozy.files.root-dir?"+opts.Encode(), &result)
+	assert.Len(t, result.Data.Relationships.Contents.Data, 5)
+	assert.Len(t, result.Included, 5)
+
+	for i, ref := range result.Data.Relationships.Contents.Data {
+		id := result.Included[i].(map[string]interface{})["id"].(string)
+		assert.Equal(t, id, ref.ID)
+		assert.NotEqual(t, id, consts.TrashDirID)
+		for _, seen := range ids {
+			assert.NotEqual(t, id, seen)
+		}
+		ids = append(ids, id)
+	}
+}
+
 func TestZeroCountIsPresent(t *testing.T) {
 	_, dirdata := createDir(t, "/files/?Type=directory&Name=emptydirectory")
 	dirdata, ok := dirdata["data"].(map[string]interface{})

web/jsonapi/jsonapi.go

@@ -215,21 +215,19 @@ func PaginationCursorToParams(cursor couchdb.Cursor) (url.Values, error) {
 		return v, nil
 	}
 
-	switch cursor.(type) {
+	switch c := cursor.(type) {
 	case *couchdb.StartKeyCursor:
-		skc := cursor.(*couchdb.StartKeyCursor)
-		cursorObj := []interface{}{skc.NextKey, skc.NextDocID}
+		cursorObj := []interface{}{c.NextKey, c.NextDocID}
 		cursorBytes, err := json.Marshal(cursorObj)
 		if err != nil {
 			return nil, err
 		}
-		v.Set("page[limit]", strconv.Itoa(skc.Limit))
+		v.Set("page[limit]", strconv.Itoa(c.Limit))
 		v.Set("page[cursor]", string(cursorBytes))
 
 	case *couchdb.SkipCursor:
-		sc := cursor.(*couchdb.SkipCursor)
-		v.Set("page[limit]", strconv.Itoa(sc.Limit))
-		v.Set("page[skip]", strconv.Itoa(sc.Skip))
+		v.Set("page[limit]", strconv.Itoa(c.Limit))
+		v.Set("page[skip]", strconv.Itoa(c.Skip))
 	}
 
 	return v, nil