feat: Slack Avatar integration

Our current Avatars are a little dry, using a limited variety of colors
and showing the user's initials. The app could use a little more
personality.

Now given we already have a slack integration and administrators can
configure their `SLACK_API_TOKEN`, I was thinking we can use this
integration to get Slack's avatars integrated in Superset. Given the
popularity of Slack and users familiarity with the avatars there,
I thought it'd be neat to bring a bit more color in Superset.

The approach here is centered around a new endpoint
`/api/v1/user/{id}/avatar.png`, which fetches from a new column in
UserAttribute (our one-to-one extension to FAB's User model) for
avatar_url, and redirects to the destination. When loading for the
first time, if information is empty and Slack is configured, we ask
Slack for the URL, which is secret, but serves the image from outside
the authentication part of their API.

UPDATING.md

@@ -38,6 +38,9 @@ assists people when migrating to a new version.
 - [27697](https://github.com/apache/superset/pull/27697) [minor] flask-session bump leads to them
   deprecating `SESSION_USE_SIGNER`, check your configs as this flag won't do anything moving
   forward.
+- [27849](https://github.com/apache/superset/pull/27849/) More of an FYI, but we have a
+  new config `SLACK_ENABLE_AVATARS` (False by default) that works in conjunction with
+  set `SLACK_API_TOKEN` to fetch and serve Slack avatar links
 
 ## 4.0.0
 

superset-frontend/src/components/FacePile/index.tsx

@@ -33,12 +33,14 @@ interface FacePileProps {
 
 const colorList = getCategoricalSchemeRegistry().get()?.colors ?? [];
 
-const customAvatarStyler = (theme: SupersetTheme) => `
-  width: ${theme.gridUnit * 6}px;
-  height: ${theme.gridUnit * 6}px;
-  line-height: ${theme.gridUnit * 6}px;
-  font-size: ${theme.typography.sizes.m}px;
-`;
+const customAvatarStyler = (theme: SupersetTheme) => {
+  const size = theme.gridUnit * 8;
+  return `
+  width: ${size}px;
+  height: ${size}px;
+  line-height: ${size}px;
+  font-size: ${theme.typography.sizes.s}px;`;
+};
 
 const StyledAvatar = styled(Avatar)`
   ${({ theme }) => customAvatarStyler(theme)}
@@ -58,6 +60,7 @@ export default function FacePile({ users, maxCount = 4 }: FacePileProps) {
         const name = `${first_name} ${last_name}`;
         const uniqueKey = `${id}-${first_name}-${last_name}`;
         const color = getRandomColor(uniqueKey, colorList);
+        const avatarUrl = `/api/v1/user/${id}/avatar.png`;
         return (
           <Tooltip key={name} title={name} placement="top">
             <StyledAvatar
@@ -66,6 +69,7 @@ export default function FacePile({ users, maxCount = 4 }: FacePileProps) {
                 backgroundColor: color,
                 borderColor: color,
               }}
+              src={avatarUrl}
             >
               {first_name?.[0]?.toLocaleUpperCase()}
               {last_name?.[0]?.toLocaleUpperCase()}

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

@@ -357,6 +357,9 @@ function DashboardList(props: DashboardListProps) {
         Header: t('Owners'),
         accessor: 'owners',
         disableSortBy: true,
+        cellProps: {
+          style: { padding: '0px' },
+        },
         size: 'xl',
       },
       {

superset/config.py

@@ -1330,6 +1330,11 @@ def EMAIL_HEADER_MUTATOR(  # pylint: disable=invalid-name,unused-argument
 SLACK_API_TOKEN: Callable[[], str] | str | None = None
 SLACK_PROXY = None
 
+# Whether Superset should use Slack avatars for users.
+# If on, you'll want to add "https://avatars.slack-edge.com" to the list of allowed
+# domains in your TALISMAN_CONFIG
+SLACK_ENABLE_AVATARS = False
+
 # The webdriver to use for generating reports. Use one of the following
 # firefox
 #   Requires: geckodriver and firefox installations
@@ -1454,6 +1459,7 @@ def EMAIL_HEADER_MUTATOR(  # pylint: disable=invalid-name,unused-argument
             "data:",
             "https://apachesuperset.gateway.scarf.sh",
             "https://static.scarf.sh/",
+            # "https://avatars.slack-edge.com", # Uncomment when SLACK_ENABLE_AVATARS is True
         ],
         "worker-src": ["'self'", "blob:"],
         "connect-src": [
@@ -1483,6 +1489,7 @@ def EMAIL_HEADER_MUTATOR(  # pylint: disable=invalid-name,unused-argument
             "data:",
             "https://apachesuperset.gateway.scarf.sh",
             "https://static.scarf.sh/",
+            "https://avatars.slack-edge.com",
         ],
         "worker-src": ["'self'", "blob:"],
         "connect-src": [

superset/daos/user.py

@@ -0,0 +1,43 @@
+# 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.
+from __future__ import annotations
+
+import logging
+
+from flask_appbuilder.security.sqla.models import User
+
+from superset.daos.base import BaseDAO
+from superset.extensions import db
+from superset.models.user_attributes import UserAttribute
+
+logger = logging.getLogger(__name__)
+
+
+class UserDAO(BaseDAO[User]):
+    @staticmethod
+    def get_by_id(user_id: int) -> User:
+        return db.session.query(User).filter_by(id=user_id).one()
+
+    @staticmethod
+    def set_avatar_url(user: User, url: str) -> None:
+        if user.extra_attributes:
+            user.extra_attributes[0].avatar_url = url
+        else:
+            attrs = UserAttribute(avatar_url=url, user_id=user.id)
+            user.extra_attributes = [attrs]
+            db.session.add(attrs)
+            db.session.commit()

superset/initialization/__init__.py

@@ -190,7 +190,7 @@ def init_views(self) -> None:
         )
         from superset.views.sqllab import SqllabView
         from superset.views.tags import TagModelView, TagView
-        from superset.views.users.api import CurrentUserRestApi
+        from superset.views.users.api import CurrentUserRestApi, UserRestApi
 
         #
         # Setup API views
@@ -205,6 +205,7 @@ def init_views(self) -> None:
         appbuilder.add_api(ChartDataRestApi)
         appbuilder.add_api(CssTemplateRestApi)
         appbuilder.add_api(CurrentUserRestApi)
+        appbuilder.add_api(UserRestApi)
         appbuilder.add_api(DashboardFilterStateRestApi)
         appbuilder.add_api(DashboardPermalinkRestApi)
         appbuilder.add_api(DashboardRestApi)

superset/migrations/versions/2024-04-01_22-44_c22cb5c2e546_user_attr_avatar_url.py

@@ -0,0 +1,39 @@
+# 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.
+"""empty message
+
+Revision ID: c22cb5c2e546
+Revises: be1b217cd8cd
+Create Date: 2024-04-01 22:44:40.386543
+
+"""
+import sqlalchemy as sa
+from alembic import op
+from sqlalchemy.dialects import postgresql
+
+# revision identifiers, used by Alembic.
+revision = "c22cb5c2e546"
+down_revision = "be1b217cd8cd"
+
+
+def upgrade():
+    op.add_column(
+        "user_attribute", sa.Column("avatar_url", sa.String(length=100), nullable=True)
+    )
+
+
+def downgrade():
+    op.drop_column("user_attribute", "avatar_url")

superset/migrations/versions/2024-04-11_00-49_bbf146925528_.py

@@ -0,0 +1,38 @@
+# 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.
+"""empty message
+
+Revision ID: bbf146925528
+Revises: ('678eefb4ab44', 'c22cb5c2e546')
+Create Date: 2024-04-11 00:49:51.592325
+
+"""
+
+# revision identifiers, used by Alembic.
+revision = "bbf146925528"
+down_revision = ("678eefb4ab44", "c22cb5c2e546")
+
+import sqlalchemy as sa
+from alembic import op
+
+
+def upgrade():
+    pass
+
+
+def downgrade():
+    pass

superset/models/user_attributes.py

@@ -14,8 +14,9 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
+
 from flask_appbuilder import Model
-from sqlalchemy import Column, ForeignKey, Integer
+from sqlalchemy import Column, ForeignKey, Integer, String
 from sqlalchemy.orm import relationship
 
 from superset import security_manager
@@ -39,6 +40,6 @@ class UserAttribute(Model, AuditMixinNullable):
     user = relationship(
         security_manager.user_model, backref="extra_attributes", foreign_keys=[user_id]
     )
-
     welcome_dashboard_id = Column(Integer, ForeignKey("dashboards.id"))
     welcome_dashboard = relationship("Dashboard")
+    avatar_url = Column(String(100))

superset/reports/notifications/slack.py

@@ -24,7 +24,6 @@
 import pandas as pd
 from flask import g
 from flask_babel import gettext as __
-from slack_sdk import WebClient
 from slack_sdk.errors import (
     BotUserAccessError,
     SlackApiError,
@@ -36,7 +35,6 @@
     SlackTokenRotationError,
 )
 
-from superset import app
 from superset.reports.models import ReportRecipientType
 from superset.reports.notifications.base import BaseNotification
 from superset.reports.notifications.exceptions import (
@@ -47,6 +45,7 @@
 )
 from superset.utils.core import get_email_address_list
 from superset.utils.decorators import statsd_gauge
+from superset.utils.slack import get_slack_client
 
 logger = logging.getLogger(__name__)
 
@@ -181,10 +180,7 @@ def send(self) -> None:
         body = self._get_body()
         global_logs_context = getattr(g, "logs_context", {}) or {}
         try:
-            token = app.config["SLACK_API_TOKEN"]
-            if callable(token):
-                token = token()
-            client = WebClient(token=token, proxy=app.config["SLACK_PROXY"])
+            client = get_slack_client()
             # files_upload returns SlackResponse as we run it in sync mode.
             if files:
                 for file in files:

superset/utils/slack.py

@@ -0,0 +1,59 @@
+# 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.
+
+
+from flask import current_app
+from slack_sdk import WebClient
+
+
+class SlackClientError(Exception):
+    pass
+
+
+def get_slack_client() -> WebClient:
+    token: str = current_app.config["SLACK_API_TOKEN"]
+    if callable(token):
+        token = token()
+    return WebClient(token=token, proxy=current_app.config["SLACK_PROXY"])
+
+
+def get_user_avatar(email: str, client: WebClient = None) -> str:
+    client = client or get_slack_client()
+    print("HEREHREHRHEHRHR")
+    print("HEREHREHRHEHRHR")
+    print("HEREHREHRHEHRHR")
+    print("HEREHREHRHEHRHR")
+    print("HEREHREHRHEHRHR")
+    print("HEREHREHRHEHRHR")
+    try:
+        response = client.users_lookupByEmail(email=email)
+    except Exception as ex:
+        raise SlackClientError(f"Failed to lookup user by email: {email}") from ex
+
+    user = response.data.get("user")
+    if user is None:
+        raise SlackClientError("No user found with that email.")
+
+    profile = user.get("profile")
+    if profile is None:
+        raise SlackClientError("User found but no profile available.")
+
+    avatar_url = profile.get("image_192")
+    if avatar_url is None:
+        raise SlackClientError("Profile image is not available.")
+
+    return avatar_url