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>

api/v4/source/bookmarks.yaml

@@ -0,0 +1,291 @@
+  /api/v4/channels/{channel_id}/bookmarks:
+    get:
+      tags:
+        - bookmarks
+      summary: Get channel bookmarks for Channel
+      description: |
+        __Minimum server version__: 9.5
+      operationId: ListChannelBookmarksForChannel
+      parameters:
+        - name: channel_id
+          in: path
+          description: Channel GUID
+          required: true
+          schema:
+            type: string
+        - name: bookmarks_since
+          in: query
+          description: |
+            Timestamp to filter the bookmarks with. If set, the
+            endpoint returns bookmarks that have been added, updated
+            or deleted since its value
+          required: false
+          schema:
+            type: number
+            format: int64
+      responses:
+        "201":
+          description: Channel Bookmarks retrieval successful
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: "#/components/schemas/ChannelBookmarkWithFileInfo"
+        "400":
+          $ref: "#/components/responses/BadRequest"
+        "401":
+          $ref: "#/components/responses/Unauthorized"
+        "403":
+          $ref: "#/components/responses/Forbidden"
+
+    post:
+      tags:
+        - bookmarks
+      summary: Create channel bookmark
+      description: |
+        Creates a new channel bookmark for this channel.
+
+        __Minimum server version__: 9.5
+
+        ##### Permissions
+        Must have the `add_bookmark_public_channel` or
+        `add_bookmark_private_channel` depending on the channel
+        type. If the channel is a DM or GM, must be a non-guest
+        member.
+      operationId: CreateChannelBookmark
+      parameters:
+        - name: channel_id
+          in: path
+          description: Channel GUID
+          required: true
+          schema:
+            type: string
+      body:
+      requestBody:
+        content:
+          application/json:
+            schema:
+              type: object
+              required:
+                - display_name
+                - type
+              properties:
+                file_id:
+                  type: string
+                  description: The ID of the file associated with the channel bookmark. Required for bookmarks of type 'file'
+                display_name:
+                  type: string
+                  description: The name of the channel bookmark
+                link_url:
+                  type: string
+                  description: The URL associated with the channel bookmark. Required for bookmarks of type 'link'
+                image_url:
+                  type: string
+                  description: The URL of the image associated with the channel bookmark. Optional, only applies for bookmarks of type 'link'
+                emoji:
+                  type: string
+                  description: The emoji of the channel bookmark
+                type:
+                  type: string
+                  enum: [link, file]
+                  description: |
+                    * `link` for channel bookmarks that reference a link. `link_url` is requied
+                    * `file` for channel bookmarks that reference a file. `file_id` is required
+        description: Channel Bookmark object to be created
+        required: true
+      responses:
+        "201":
+          description: Channel Bookmark creation successful
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ChannelBookmarkWithFileInfo"
+        "400":
+          $ref: "#/components/responses/BadRequest"
+        "401":
+          $ref: "#/components/responses/Unauthorized"
+        "403":
+          $ref: "#/components/responses/Forbidden"
+
+  /api/v4/channels/{channel_id}/bookmarks/{bookmark_id}:
+    patch:
+      tags:
+        - bookmarks
+      summary: Update channel bookmark
+      description: |
+        Partially update a channel bookmark by providing only the
+        fields you want to update. Ommited fields will not be
+        updated. The fields that can be updated are defined in the
+        request body, all other provided fields will be ignored.
+
+        __Minimum server version__: 9.5
+
+        ##### Permissions
+        Must have the `edit_bookmark_public_channel` or
+        `edit_bookmark_private_channel` depending on the channel
+        type. If the channel is a DM or GM, must be a non-guest
+        member.
+      operationId: UpdateChannelBookmark
+      parameters:
+        - name: channel_id
+          in: path
+          description: Channel GUID
+          required: true
+          schema:
+            type: string
+        - name: bookmark_id
+          in: path
+          description: Bookmark GUID
+          required: true
+          schema:
+            type: string
+      body:
+      requestBody:
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                file_id:
+                  type: string
+                  description: The ID of the file associated with the channel bookmark. Required for bookmarks of type 'file'
+                display_name:
+                  type: string
+                  description: The name of the channel bookmark
+                sort_order:
+                  type: integer
+                  format: int64
+                  description: The order of the channel bookmark
+                link_url:
+                  type: string
+                  description: The URL associated with the channel bookmark. Required for type bookmarks of type 'link'
+                image_url:
+                  type: string
+                  description: The URL of the image associated with the channel bookmark
+                emoji:
+                  type: string
+                  description: The emoji of the channel bookmark
+                type:
+                  type: string
+                  enum: [link, file]
+                  description: |
+                    * `link` for channel bookmarks that reference a link. `link_url` is requied
+                    * `file` for channel bookmarks that reference a file. `file_id` is required
+        description: Channel Bookmark object to be updated
+        required: true
+      responses:
+        "200":
+          description: Channel Bookmark update successful
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/UpdateChannelBookmarkResponse"
+        "400":
+          $ref: "#/components/responses/BadRequest"
+        "401":
+          $ref: "#/components/responses/Unauthorized"
+        "403":
+          $ref: "#/components/responses/Forbidden"
+        "404":
+          $ref: "#/components/responses/NotFound"
+
+    delete:
+      tags:
+        - bookmarks
+      summary: Delete channel bookmark
+      description: |
+        Archives a channel bookmark. This will set the `deleteAt` to
+        the current timestamp in the database.
+
+        __Minimum server version__: 9.5
+
+        ##### Permissions
+        Must have the `delete_bookmark_public_channel` or
+        `delete_bookmark_private_channel` depending on the channel
+        type. If the channel is a DM or GM, must be a non-guest
+        member.
+      operationId: DeleteChannelBookmark
+      parameters:
+        - name: channel_id
+          in: path
+          description: Channel GUID
+          required: true
+          schema:
+            type: string
+        - name: bookmark_id
+          in: path
+          description: Bookmark GUID
+          required: true
+          schema:
+            type: string
+      responses:
+        "200":
+          description: Channel Bookmark deletion successful
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ChannelBookmarkWithFileInfo"
+        "400":
+          $ref: "#/components/responses/BadRequest"
+        "401":
+          $ref: "#/components/responses/Unauthorized"
+        "403":
+          $ref: "#/components/responses/Forbidden"
+        "404":
+          $ref: "#/components/responses/NotFound"
+
+  /api/v4/channels/{channel_id}/bookmarks/{bookmark_id}/sort_order:
+    post:
+      tags:
+        - bookmarks
+      summary: Update channel bookmark's order
+      description: |
+        Updates the order of a channel bookmark, setting its new order
+        from the parameters and updating the rest of the bookmarks of
+        the channel to accomodate for this change.
+
+        __Minimum server version__: 9.5
+
+        ##### Permissions
+        Must have the `order_bookmark_public_channel` or
+        `order_bookmark_private_channel` depending on the channel
+        type. If the channel is a DM or GM, must be a non-guest
+        member.
+      operationId: UpdateChannelBookmarkSortOrder
+      parameters:
+        - name: channel_id
+          in: path
+          description: Channel GUID
+          required: true
+          schema:
+            type: string
+        - name: bookmark_id
+          in: path
+          description: Bookmark GUID
+          required: true
+          schema:
+            type: string
+      body:
+      requestBody:
+        content:
+          application/json:
+            schema:
+              type: number
+              format: int64
+              description: The new sort order for the Channel Bookmark
+      responses:
+        "200":
+          description: Channel Bookmark Sort Order update successful
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: "#/components/schemas/ChannelBookmarkWithFileInfo"
+        "400":
+          $ref: "#/components/responses/BadRequest"
+        "401":
+          $ref: "#/components/responses/Unauthorized"
+        "403":
+          $ref: "#/components/responses/Forbidden"

api/v4/source/definitions.yaml

@@ -298,6 +298,68 @@ components:
       type: array
       items:
         $ref: "#/components/schemas/ChannelWithTeamData"
+    ChannelBookmark:
+      type: object
+      properties:
+        id:
+          type: string
+        create_at:
+          description: The time in milliseconds a channel bookmark was created
+          type: integer
+          format: int64
+        update_at:
+          description: The time in milliseconds a channel bookmark was last updated
+          type: integer
+          format: int64
+        delete_at:
+          description: The time in milliseconds a channel bookmark was deleted
+          type: integer
+          format: int64
+        channel_id:
+          type: string
+        owner_id:
+          description: The ID of the user that the channel bookmark belongs to
+          type: string
+        file_id:
+          description: The ID of the file associated with the channel bookmark
+          type: string
+        display_name:
+          type: string
+        sort_order:
+          description: The order of the channel bookmark
+          type: integer
+          format: int64
+        link_url:
+          description: The URL associated with the channel bookmark
+          type: string
+        image_url:
+          description: The URL of the image associated with the channel bookmark
+          type: string
+        emoji:
+          type: string
+        type:
+          type: string
+          enum: [link, file]
+        original_id:
+          description: The ID of the original channel bookmark
+          type: string
+        parent_id:
+          description: The ID of the parent channel bookmark
+          type: string
+    ChannelBookmarkWithFileInfo:
+      allOf:
+        - $ref: "#/components/schemas/ChannelBookmark"
+        - type: object
+          properties:
+            file:
+              $ref: "#/components/schemas/FileInfo"
+    UpdateChannelBookmarkResponse:
+      type: object
+      properties:
+        updated:
+          $ref: "#/components/schemas/ChannelBookmarkWithFileInfo"
+        deleted:
+          $ref: "#/components/schemas/ChannelBookmarkWithFileInfo"
     Post:
       type: object
       properties:

api/v4/source/files.yaml

@@ -19,6 +19,12 @@
         Server versions 4.8 and higher support both types of requests.
 
 
+        __Minimum server version__: 9.4
+
+        Starting with server version 9.4 when uploading a file for a channel bookmark, the bookmark=true query
+        parameter should be included in the query string
+
+
         ##### Permissions
 
         Must have `upload_file` permission.

api/v4/source/introduction.yaml

@@ -490,6 +490,8 @@ tags:
     description: Endpoints for uploading and interacting with files.
   - name: uploads
     description: Endpoints for creating and performing file uploads.
+  - name: bookmarks
+    description: Endpoints for creating, getting and interacting with channel bookmarks.
   - name: preferences
     description: Endpoints for saving and modifying user preferences.
   - name: status
@@ -569,6 +571,7 @@ x-tagGroups:
       - threads
       - files
       - uploads
+      - bookmarks
       - preferences
       - status
       - emoji