feat(Tags): Allow users to favorite Tags on CRUD Listview page (apach…

…e#24701)

superset-frontend/src/pages/Tags/index.tsx

@@ -24,7 +24,7 @@ import {
   createErrorHandler,
   Actions,
 } from 'src/views/CRUD/utils';
-import { useListViewResource } from 'src/views/CRUD/hooks';
+import { useListViewResource, useFavoriteStatus } from 'src/views/CRUD/hooks';
 import ConfirmStatusChange from 'src/components/ConfirmStatusChange';
 import SubMenu, { SubMenuProps } from 'src/features/home/SubMenu';
 import ListView, {
@@ -42,6 +42,7 @@ import { deleteTags } from 'src/features/tags/tags';
 import { Tag as AntdTag } from 'antd';
 import { Tag } from 'src/views/CRUD/types';
 import TagCard from 'src/features/tags/TagCard';
+import FaveStar from 'src/components/FaveStar';
 
 const emptyState = {
   title: t('No Tags created'),
@@ -90,6 +91,13 @@ function TagList(props: TagListProps) {
     refreshData,
   } = useListViewResource<Tag>('tag', t('tag'), addDangerToast);
 
+  const tagIds = useMemo(() => tags.map(c => c.id), [tags]);
+  const [saveFavoriteStatus, favoriteStatus] = useFavoriteStatus(
+    'tag',
+    tagIds,
+    addDangerToast,
+  );
+
   // TODO: Fix usage of localStorage keying on the user id
   const userKey = dangerouslyGetItemDoNotUse(userId?.toString(), null);
 
@@ -109,6 +117,25 @@ function TagList(props: TagListProps) {
 
   const columns = useMemo(
     () => [
+      {
+        Cell: ({
+          row: {
+            original: { id },
+          },
+        }: any) =>
+          userId && (
+            <FaveStar
+              itemId={id}
+              saveFaveStar={saveFavoriteStatus}
+              isStarred={favoriteStatus[id]}
+            />
+          ),
+        Header: '',
+        id: 'id',
+        disableSortBy: true,
+        size: 'xs',
+        hidden: !userId,
+      },
       {
         Cell: ({
           row: {

superset-frontend/src/views/CRUD/hooks.ts

@@ -564,10 +564,15 @@ const favoriteApis = {
     method: 'GET',
     endpoint: '/api/v1/dashboard/favorite_status/',
   }),
+  tag: makeApi<Array<string | number>, FavoriteStatusResponse>({
+    requestType: 'rison',
+    method: 'GET',
+    endpoint: '/api/v1/tag/favorite_status/',
+  }),
 };
 
 export function useFavoriteStatus(
-  type: 'chart' | 'dashboard',
+  type: 'chart' | 'dashboard' | 'tag',
   ids: Array<string | number>,
   handleErrorMsg: (message: string) => void,
 ) {

superset/daos/tag.py

@@ -18,15 +18,26 @@
 from operator import and_
 from typing import Any, Optional
 
+from flask import g
 from sqlalchemy.exc import SQLAlchemyError
 
 from superset.daos.base import BaseDAO
 from superset.daos.exceptions import DAOCreateFailedError, DAODeleteFailedError
+from superset.exceptions import MissingUserContextException
 from superset.extensions import db
 from superset.models.dashboard import Dashboard
 from superset.models.slice import Slice
 from superset.models.sql_lab import SavedQuery
-from superset.tags.models import get_tag, ObjectTypes, Tag, TaggedObject, TagTypes
+from superset.tags.commands.exceptions import TagNotFoundError
+from superset.tags.models import (
+    get_tag,
+    ObjectTypes,
+    Tag,
+    TaggedObject,
+    TagTypes,
+    user_favorite_tag_table,
+)
+from superset.utils.core import get_user_id
 
 logger = logging.getLogger(__name__)
 
@@ -257,3 +268,98 @@ def get_tagged_objects_for_tags(
                 for obj in saved_queries
             )
         return results
+
+    @staticmethod
+    def favorite_tag_by_id_for_current_user(  # pylint: disable=invalid-name
+        tag_id: int,
+    ) -> None:
+        """
+        Marks a specific tag as a favorite for the current user.
+        This function will find the tag by the provided id,
+        create a new UserFavoriteTag object that represents
+        the user's preference, add that object to the database
+        session, and commit the session. It uses the currently
+        authenticated user from the global 'g' object.
+        Args:
+            tag_id: The id of the tag that is to be marked as
+                    favorite.
+        Raises:
+            Any exceptions raised by the find_by_id function,
+            the UserFavoriteTag constructor, or the database session's
+            add and commit methods will propagate up to the caller.
+        Returns:
+            None.
+        """
+        tag = TagDAO.find_by_id(tag_id)
+        user = g.user
+
+        if not user:
+            raise MissingUserContextException(message="User doesn't exist")
+        if not tag:
+            raise TagNotFoundError()
+
+        tag.users_favorited.append(user)
+        db.session.commit()
+
+    @staticmethod
+    def remove_user_favorite_tag(tag_id: int) -> None:
+        """
+        Removes a tag from the current user's favorite tags.
+
+        This function will find the tag by the provided id and remove the tag
+        from the user's list of favorite tags. It uses the currently authenticated
+        user from the global 'g' object.
+
+        Args:
+            tag_id: The id of the tag that is to be removed from the favorite tags.
+
+        Raises:
+            Any exceptions raised by the find_by_id function, the database session's
+            commit method will propagate up to the caller.
+
+        Returns:
+            None.
+        """
+        tag = TagDAO.find_by_id(tag_id)
+        user = g.user
+
+        if not user:
+            raise MissingUserContextException(message="User doesn't exist")
+        if not tag:
+            raise TagNotFoundError()
+
+        tag.users_favorited.remove(user)
+
+        # Commit to save the changes
+        db.session.commit()
+
+    @staticmethod
+    def favorited_ids(tags: list[Tag]) -> list[int]:
+        """
+        Returns the IDs of tags that the current user has favorited.
+
+        This function takes in a list of Tag objects, extracts their IDs, and checks
+        which of these IDs exist in the user_favorite_tag_table for the current user.
+        The function returns a list of these favorited tag IDs.
+
+        Args:
+            tags (list[Tag]): A list of Tag objects.
+
+        Returns:
+            list[Any]: A list of IDs corresponding to the tags that are favorited by
+            the current user.
+
+        Example:
+            favorited_ids([tag1, tag2, tag3])
+            Output: [tag_id1, tag_id3]   # if the current user has favorited tag1 and tag3
+        """
+        ids = [tag.id for tag in tags]
+        return [
+            star.tag_id
+            for star in db.session.query(user_favorite_tag_table.c.tag_id)
+            .filter(
+                user_favorite_tag_table.c.tag_id.in_(ids),
+                user_favorite_tag_table.c.user_id == get_user_id(),
+            )
+            .all()
+        ]

superset/exceptions.py

@@ -200,6 +200,10 @@ class DatabaseNotFound(SupersetException):
     status = 400
 
 
+class MissingUserContextException(SupersetException):
+    status = 422
+
+
 class QueryObjectValidationError(SupersetException):
     status = 400
 

superset/migrations/versions/2023-07-12_20-34_e0f6f91c2055_create_user_favorite_table.py

@@ -0,0 +1,53 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+"""create_user_favorite_table
+
+Revision ID: e0f6f91c2055
+Revises: bf646a0c1501
+Create Date: 2023-07-12 20:34:57.553981
+
+"""
+
+# revision identifiers, used by Alembic.
+revision = "e0f6f91c2055"
+down_revision = "bf646a0c1501"
+
+import sqlalchemy as sa
+from alembic import op
+from sqlalchemy.dialects import postgresql
+
+
+def upgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.create_table(
+        "user_favorite_tag",
+        sa.Column("user_id", sa.Integer(), nullable=False),
+        sa.Column("tag_id", sa.Integer(), nullable=False),
+        sa.ForeignKeyConstraint(
+            ["tag_id"],
+            ["tag.id"],
+        ),
+        sa.ForeignKeyConstraint(
+            ["user_id"],
+            ["ab_user.id"],
+        ),
+    )
+    # ### end Alembic commands ###
+
+
+def downgrade():
+    op.drop_table("user_favorite_tag")