Channel Bookmarks (#25449)

* create ChannelBookmarks table

* ChannelBookmark model

* channel bookamrks Store layer

* add GetBookmarksForAllChannelByIdSince

* add channel bookmarks to test store

* Add channel bookmarks to app layer

* remove index for createAt in channel bookmarks migrations

* remove createAt from select channel bookmark query and enable store delete bookmark test

* update reponse of UpdateBookmark

* rename db migration files

* channel bookmarks store update sort order

* channel bookmarks app layer update sort order

* fix lint & tests

* Fix lint and introduce util functions to insert / remove from slice

* remove model etag

* i18n

* defer remove file info after test run

* Fix tests passing the request context

* fix migrations

* fix TestRetry

* Add bookmark permissions (#25560)

* Adds channel bookmarks permissions

* Fix linter

* Remove unnecessary empty lines

* Remove scss change as it's not necessary anymore

* Fix mock store

* Fix mock store and add role entry

* Fix test

* Adds cypress test and update permissions migration to update admin roles

* Adds channel bookmarks roles to default admin roles

* Adds bookmark permissions to default role permissions constant in webapp

* Update mmctl test

* Update permission test after normalising the roles

* fix store tests

* fix app layer tests

* Add new bookmark endpoint (#25624)

* Adds channel bookmarks api scaffold and create endpoint

* Applies review comments to the API docs

* Adds websocket test to create channel bookmark

---------

Co-authored-by: Mattermost Build <build@mattermost.com>

* MM-54426 exclude Channel Bookmarks files from data retention (#25656)

* Augment channel APIs to include bookmarks (#25567)

* update files docs for server 9.4

* Adds update channel bookmark endpoint (#25653)

* Adds update channel bookmark sort order endpoint (#25686)

* Adds update channel bookmark endpoint

* Updates edit app method to return the right deleted bookmark and adds tests

* Adds the update channel bookmark sort order endpoint

* Fix repeated test after merge

* Assign right permissions to each test

* Update store and app layer to return specific errors and add tests

* Adds delete channel bookmark endpoint (#25693)

* Updates edit app method to return the right deleted bookmark and adds tests

* Fix repeated test after merge

* Updates edit app method to return the right deleted bookmark and adds tests

* Adds delete channel bookmark endpoint

* Adds list channel bookmarks endpoint (#25700)

* Add channel moderation to bookmarks (#25716)

* fix migrations index

* fix getChannelsForTeamForUser

* fix getChannelsForTeamForUser

* fix bad merge client4

* fix file api with bookmark permission

* add ChannelBookmarks feature flag

* add missing translations

* Set DB column for type as enum

* use custom type for bookmark query using sqlx

* use transaction when saving bookmark

* return NewErrNotFound instead of Sql.ErrNoRows

* use squirrel for IN query

* add a limit of 1K for records in GetBookmarksForAllChannelByIdSince

* UpdateSortOrder with one single query instead of multiple updates

* fix shadow declaration

* fix channel bookmarks permission string definition in admin console

* fix another shadow declaration

* Fix model conversion

* add SplitSliceInChunks

* remove include bookmarks in channels api

* Cap amount of bookmarks per channel

* add etag back to get channels

* feedback review

* update file info when replacing a bookmark file

* return 501 not implemented when the license is not available

* add detail message when getting channel member on bookmark api

* start audit before permission check on create bookmark api

* use require.Eventuallyf for testing WS events

* remove unnecessary log in app layer

* use require instead of assert to avoid panics

* enforce limit when querying bookmarks since

* prevent to create/update bookmark if file is already attached

* fix lint

* delete file when a bookmark is deleted

* Dot allow to set a fileId and a url at the same time to a bookmark

* fix query to delete a file that belongs to a bookmark

* do not patch the bookmark type

* Server side FeatureFlag check (#26145)

* use ff in server, set ff to false

* turn on FF for unit tests

* defer unset FF for unit tests

* turn ff on for testing

* only allow attaching files that were uploaded for bookmark

* Set feature flag off as default

* fix lint

* update email templates as PR failed

* revert templates

* force the assignment of ID when creating a bookmark

* Fix unit tests

---------

Co-authored-by: Miguel de la Cruz <miguel@mcrx.me>
Co-authored-by: Mattermost Build <build@mattermost.com>
Co-authored-by: Caleb Roseland <caleb@calebroseland.com>
Co-authored-by: Scott Bishel <scott.bishel@mattermost.com>

server/public/model/channel_bookmark_test.go

@@ -0,0 +1,544 @@
+// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+
+package model
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+func TestChannelBookmarkIsValid(t *testing.T) {
+	testCases := []struct {
+		Description     string
+		Bookmark        *ChannelBookmark
+		ExpectedIsValid bool
+	}{
+		{
+			"nil bookmark",
+			&ChannelBookmark{},
+			false,
+		},
+		{
+			"bookmark without create at timestamp",
+			&ChannelBookmark{
+				Id:          NewId(),
+				OwnerId:     NewId(),
+				ChannelId:   "",
+				FileId:      "",
+				DisplayName: "display name",
+				SortOrder:   0,
+				LinkUrl:     "",
+				ImageUrl:    "",
+				Emoji:       "",
+				Type:        ChannelBookmarkLink,
+				CreateAt:    0,
+				UpdateAt:    3,
+				DeleteAt:    4,
+			},
+			false,
+		},
+		{
+			"bookmark without update at timestamp",
+			&ChannelBookmark{
+				Id:          NewId(),
+				OwnerId:     NewId(),
+				ChannelId:   "",
+				FileId:      "",
+				DisplayName: "display name",
+				SortOrder:   0,
+				LinkUrl:     "",
+				ImageUrl:    "",
+				Emoji:       "",
+				Type:        ChannelBookmarkLink,
+				CreateAt:    2,
+				UpdateAt:    0,
+				DeleteAt:    4,
+			},
+			false,
+		},
+		{
+			"bookmark with missing channel id",
+			&ChannelBookmark{
+				Id:          NewId(),
+				OwnerId:     NewId(),
+				ChannelId:   "",
+				FileId:      "",
+				DisplayName: "display name",
+				SortOrder:   0,
+				LinkUrl:     "",
+				ImageUrl:    "",
+				Emoji:       "",
+				Type:        ChannelBookmarkLink,
+				CreateAt:    2,
+				UpdateAt:    3,
+				DeleteAt:    4,
+			},
+			false,
+		},
+		{
+			"bookmark with invalid channel id",
+			&ChannelBookmark{
+				Id:          NewId(),
+				OwnerId:     NewId(),
+				ChannelId:   "invalid",
+				FileId:      "",
+				DisplayName: "display name",
+				SortOrder:   0,
+				LinkUrl:     "",
+				ImageUrl:    "",
+				Emoji:       "",
+				Type:        ChannelBookmarkLink,
+				CreateAt:    2,
+				UpdateAt:    3,
+				DeleteAt:    4,
+			},
+			false,
+		},
+		{
+			"bookmark with missing owner id",
+			&ChannelBookmark{
+				Id:          NewId(),
+				ChannelId:   NewId(),
+				OwnerId:     "",
+				FileId:      "",
+				DisplayName: "display name",
+				SortOrder:   0,
+				LinkUrl:     "",
+				ImageUrl:    "",
+				Emoji:       "",
+				Type:        ChannelBookmarkLink,
+				CreateAt:    2,
+				UpdateAt:    3,
+				DeleteAt:    4,
+			},
+			false,
+		},
+		{
+			"bookmark with invalid user id",
+			&ChannelBookmark{
+				Id:          NewId(),
+				ChannelId:   NewId(),
+				OwnerId:     "invalid",
+				FileId:      "",
+				DisplayName: "display name",
+				SortOrder:   0,
+				LinkUrl:     "",
+				ImageUrl:    "",
+				Emoji:       "",
+				Type:        ChannelBookmarkLink,
+				CreateAt:    2,
+				UpdateAt:    3,
+				DeleteAt:    4,
+			},
+			false,
+		},
+		{
+			"bookmark with missing displayname",
+			&ChannelBookmark{
+				Id:          NewId(),
+				ChannelId:   NewId(),
+				OwnerId:     NewId(),
+				FileId:      "",
+				DisplayName: "",
+				SortOrder:   0,
+				LinkUrl:     "",
+				ImageUrl:    "",
+				Emoji:       "",
+				Type:        ChannelBookmarkLink,
+				CreateAt:    2,
+				UpdateAt:    3,
+				DeleteAt:    4,
+			},
+			false,
+		},
+		{
+			"bookmark with missing type",
+			&ChannelBookmark{
+				Id:          NewId(),
+				ChannelId:   NewId(),
+				OwnerId:     NewId(),
+				FileId:      "",
+				DisplayName: "display name",
+				SortOrder:   0,
+				LinkUrl:     "",
+				ImageUrl:    "",
+				Emoji:       "",
+				Type:        "",
+				CreateAt:    2,
+				UpdateAt:    3,
+				DeleteAt:    4,
+			},
+			false,
+		},
+		{
+			"bookmark with invalid type",
+			&ChannelBookmark{
+				Id:          NewId(),
+				ChannelId:   NewId(),
+				OwnerId:     NewId(),
+				FileId:      "",
+				DisplayName: "display name",
+				SortOrder:   0,
+				LinkUrl:     "",
+				ImageUrl:    "",
+				Emoji:       "",
+				Type:        "invalid",
+				CreateAt:    2,
+				UpdateAt:    3,
+				DeleteAt:    4,
+			},
+			false,
+		},
+		{
+			"bookmark of type link with missing link url",
+			&ChannelBookmark{
+				Id:          NewId(),
+				ChannelId:   NewId(),
+				OwnerId:     NewId(),
+				FileId:      "",
+				DisplayName: "display name",
+				SortOrder:   0,
+				LinkUrl:     "",
+				ImageUrl:    "",
+				Emoji:       "",
+				Type:        ChannelBookmarkLink,
+				CreateAt:    2,
+				UpdateAt:    3,
+				DeleteAt:    4,
+			},
+			false,
+		},
+		{
+			"bookmark of type link with invalid link url",
+			&ChannelBookmark{
+				Id:          NewId(),
+				ChannelId:   NewId(),
+				OwnerId:     NewId(),
+				FileId:      "",
+				DisplayName: "display name",
+				SortOrder:   0,
+				LinkUrl:     "invalid",
+				ImageUrl:    "",
+				Emoji:       "",
+				Type:        ChannelBookmarkLink,
+				CreateAt:    2,
+				UpdateAt:    3,
+				DeleteAt:    4,
+			},
+			false,
+		},
+		{
+			"bookmark of type link with valid link url",
+			&ChannelBookmark{
+				Id:          NewId(),
+				ChannelId:   NewId(),
+				OwnerId:     NewId(),
+				FileId:      "",
+				DisplayName: "display name",
+				SortOrder:   0,
+				LinkUrl:     "https://mattermost.com",
+				ImageUrl:    "",
+				Emoji:       "",
+				Type:        ChannelBookmarkLink,
+				CreateAt:    2,
+				UpdateAt:    3,
+				DeleteAt:    4,
+			},
+			true,
+		},
+		{
+			"bookmark of type link with empty image url",
+			&ChannelBookmark{
+				Id:          NewId(),
+				ChannelId:   NewId(),
+				OwnerId:     NewId(),
+				FileId:      "",
+				DisplayName: "display name",
+				SortOrder:   0,
+				LinkUrl:     "https://mattermost.com",
+				ImageUrl:    "",
+				Emoji:       "",
+				Type:        ChannelBookmarkLink,
+				CreateAt:    2,
+				UpdateAt:    3,
+				DeleteAt:    4,
+			},
+			true,
+		},
+		{
+			"bookmark of type link with invalid image url",
+			&ChannelBookmark{
+				Id:          NewId(),
+				ChannelId:   NewId(),
+				OwnerId:     NewId(),
+				FileId:      "",
+				DisplayName: "display name",
+				SortOrder:   0,
+				LinkUrl:     "https://mattermost.com",
+				ImageUrl:    "invalid",
+				Emoji:       "",
+				Type:        ChannelBookmarkLink,
+				CreateAt:    2,
+				UpdateAt:    3,
+				DeleteAt:    4,
+			},
+			false,
+		},
+		{
+			"bookmark of type link with invalid image url",
+			&ChannelBookmark{
+				Id:          NewId(),
+				ChannelId:   NewId(),
+				OwnerId:     NewId(),
+				FileId:      "",
+				DisplayName: "display name",
+				SortOrder:   0,
+				LinkUrl:     "https://mattermost.com",
+				ImageUrl:    "https://mattermost.com/some-image-without-extension", // we don't care if the URL is an actual image as the client should handle the error
+				Emoji:       "",
+				Type:        ChannelBookmarkLink,
+				CreateAt:    2,
+				UpdateAt:    3,
+				DeleteAt:    4,
+			},
+			true,
+		},
+		{
+			"bookmark of type file with missing file id",
+			&ChannelBookmark{
+				Id:          NewId(),
+				ChannelId:   NewId(),
+				OwnerId:     NewId(),
+				FileId:      "",
+				DisplayName: "display name",
+				SortOrder:   0,
+				LinkUrl:     "",
+				ImageUrl:    "",
+				Emoji:       "",
+				Type:        ChannelBookmarkFile,
+				CreateAt:    2,
+				UpdateAt:    3,
+				DeleteAt:    4,
+			},
+			false,
+		},
+		{
+			"bookmark of type file with invalid file id",
+			&ChannelBookmark{
+				Id:          NewId(),
+				ChannelId:   NewId(),
+				OwnerId:     NewId(),
+				FileId:      "invalid",
+				DisplayName: "display name",
+				SortOrder:   0,
+				LinkUrl:     "",
+				ImageUrl:    "",
+				Emoji:       "",
+				Type:        ChannelBookmarkFile,
+				CreateAt:    2,
+				UpdateAt:    3,
+				DeleteAt:    4,
+			},
+			false,
+		},
+		{
+			"bookmark of type file with valid file id",
+			&ChannelBookmark{
+				Id:          NewId(),
+				ChannelId:   NewId(),
+				OwnerId:     NewId(),
+				FileId:      NewId(),
+				DisplayName: "display name",
+				SortOrder:   0,
+				LinkUrl:     "",
+				ImageUrl:    "",
+				Emoji:       "",
+				Type:        ChannelBookmarkFile,
+				CreateAt:    2,
+				UpdateAt:    3,
+				DeleteAt:    4,
+			},
+			true,
+		},
+		{
+			"bookmark of type file with invalid original id",
+			&ChannelBookmark{
+				Id:          NewId(),
+				ChannelId:   NewId(),
+				OwnerId:     NewId(),
+				FileId:      NewId(),
+				DisplayName: "display name",
+				SortOrder:   0,
+				LinkUrl:     "",
+				ImageUrl:    "",
+				Emoji:       "",
+				Type:        ChannelBookmarkFile,
+				CreateAt:    2,
+				UpdateAt:    3,
+				DeleteAt:    4,
+				OriginalId:  "invalid",
+			},
+			false,
+		},
+		{
+			"bookmark of type file with invalid parent id",
+			&ChannelBookmark{
+				Id:          NewId(),
+				ChannelId:   NewId(),
+				OwnerId:     NewId(),
+				FileId:      NewId(),
+				DisplayName: "display name",
+				SortOrder:   0,
+				LinkUrl:     "",
+				ImageUrl:    "",
+				Emoji:       "",
+				Type:        ChannelBookmarkFile,
+				CreateAt:    2,
+				UpdateAt:    3,
+				DeleteAt:    4,
+				ParentId:    "invalid",
+			},
+			false,
+		},
+		{
+			"bookmark of type link with a file Id attached",
+			&ChannelBookmark{
+				Id:          NewId(),
+				OwnerId:     NewId(),
+				ChannelId:   "",
+				FileId:      NewId(),
+				DisplayName: "display name",
+				SortOrder:   0,
+				LinkUrl:     "http://somelink",
+				ImageUrl:    "",
+				Emoji:       "",
+				Type:        ChannelBookmarkLink,
+				CreateAt:    0,
+				UpdateAt:    3,
+				DeleteAt:    0,
+			},
+			false,
+		},
+		{
+			"bookmark of type file with a url",
+			&ChannelBookmark{
+				Id:          NewId(),
+				OwnerId:     NewId(),
+				ChannelId:   "",
+				FileId:      NewId(),
+				DisplayName: "display name",
+				SortOrder:   0,
+				LinkUrl:     "http://somelink",
+				ImageUrl:    "",
+				Emoji:       "",
+				Type:        ChannelBookmarkFile,
+				CreateAt:    0,
+				UpdateAt:    3,
+				DeleteAt:    0,
+			},
+			false,
+		},
+	}
+
+	for _, testCase := range testCases {
+		t.Run(testCase.Description, func(t *testing.T) {
+			if testCase.ExpectedIsValid {
+				require.Nil(t, testCase.Bookmark.IsValid())
+			} else {
+				require.NotNil(t, testCase.Bookmark.IsValid())
+			}
+		})
+	}
+}
+
+func TestChannelBookmarkPreSave(t *testing.T) {
+	bookmark := &ChannelBookmark{
+		Id:          NewId(),
+		ChannelId:   NewId(),
+		OwnerId:     NewId(),
+		DisplayName: "display name",
+		SortOrder:   0,
+		LinkUrl:     "https://mattermost.com",
+		Type:        ChannelBookmarkLink,
+		DeleteAt:    0,
+	}
+
+	originalBookmark := &ChannelBookmark{
+		Id:          bookmark.Id,
+		ChannelId:   bookmark.ChannelId,
+		OwnerId:     bookmark.OwnerId,
+		DisplayName: bookmark.DisplayName,
+		SortOrder:   bookmark.SortOrder,
+		LinkUrl:     bookmark.LinkUrl,
+		Type:        bookmark.Type,
+		DeleteAt:    bookmark.DeleteAt,
+	}
+
+	bookmark.PreSave()
+	assert.NotEqual(t, 0, bookmark.CreateAt)
+	assert.NotEqual(t, 0, bookmark.UpdateAt)
+
+	originalBookmark.CreateAt = bookmark.CreateAt
+	originalBookmark.UpdateAt = bookmark.UpdateAt
+	assert.Equal(t, originalBookmark, bookmark)
+}
+
+func TestChannelBookmarkPreUpdate(t *testing.T) {
+	bookmark := &ChannelBookmark{
+		Id:          NewId(),
+		ChannelId:   NewId(),
+		OwnerId:     NewId(),
+		DisplayName: "display name",
+		SortOrder:   0,
+		LinkUrl:     "https://mattermost.com",
+		Type:        ChannelBookmarkLink,
+		CreateAt:    2,
+		DeleteAt:    0,
+	}
+
+	originalBookmark := &ChannelBookmark{
+		Id:          bookmark.Id,
+		ChannelId:   bookmark.ChannelId,
+		OwnerId:     bookmark.OwnerId,
+		DisplayName: bookmark.DisplayName,
+		SortOrder:   bookmark.SortOrder,
+		LinkUrl:     bookmark.LinkUrl,
+		Type:        bookmark.Type,
+		DeleteAt:    bookmark.DeleteAt,
+	}
+
+	bookmark.PreSave()
+	assert.NotEqual(t, 0, bookmark.UpdateAt)
+
+	originalBookmark.CreateAt = bookmark.CreateAt
+	originalBookmark.UpdateAt = bookmark.UpdateAt
+	assert.Equal(t, originalBookmark, bookmark)
+
+	bookmark.PreUpdate()
+	assert.Greater(t, bookmark.UpdateAt, originalBookmark.UpdateAt)
+}
+
+func TestChannelBookmarkPatch(t *testing.T) {
+	p := &ChannelBookmarkPatch{
+		DisplayName: NewString(NewId()),
+		SortOrder:   NewInt64(1),
+		LinkUrl:     NewString(NewId()),
+	}
+
+	b := ChannelBookmark{
+		Id:          NewId(),
+		DisplayName: NewId(),
+		Type:        ChannelBookmarkLink, // should not update
+		LinkUrl:     NewId(),
+	}
+	b.Patch(p)
+
+	require.Empty(t, b.FileId)
+	require.Equal(t, *p.DisplayName, b.DisplayName)
+	require.Equal(t, *p.SortOrder, b.SortOrder)
+	require.Equal(t, *p.LinkUrl, b.LinkUrl)
+	require.Equal(t, ChannelBookmarkLink, b.Type)
+}