Make favorite queries/dashboard order by starred at(favorited at)

Author: yoshiokatsuneo

client/app/components/items-list/ItemsList.tsx

@@ -93,7 +93,7 @@ export interface ItemsListWrappedComponentProps<I, P = any> {
 export function wrap<I, P = any>(
   WrappedComponent: React.ComponentType<ItemsListWrappedComponentProps<I>>,
   createItemsSource: () => ItemsSource,
-  createStateStorage: () => StateStorage
+  createStateStorage: ( { ...props }) => StateStorage
 ) {
   class ItemsListWrapper extends React.Component<ItemsListWrapperProps, ItemsListWrapperState<I, P>> {
     private _itemsSource: ItemsSource;
@@ -116,7 +116,7 @@ export function wrap<I, P = any>(
     constructor(props: ItemsListWrapperProps) {
       super(props);
 
-      const stateStorage = createStateStorage();
+      const stateStorage = createStateStorage({ ...props });
       const itemsSource = createItemsSource();
       this._itemsSource = itemsSource;
 

client/app/pages/dashboards/DashboardList.jsx

@@ -81,12 +81,19 @@ function DashboardListExtraActions(props) {
 }
 
 function DashboardList({ controller }) {
+  let usedListColumns = listColumns;
+  if (controller.params.currentPage === "favorites") {
+    usedListColumns = [
+      ...usedListColumns,
+      Columns.dateTime.sortable({ title: "Starred At", field: "starred_at", width: "1%" }),
+    ];
+  }
   const {
     areExtraActionsAvailable,
     listColumns: tableColumns,
     Component: ExtraActionsComponent,
     selectedItems,
-  } = useItemsListExtraActions(controller, listColumns, DashboardListExtraActions);
+  } = useItemsListExtraActions(controller, usedListColumns, DashboardListExtraActions);
 
   return (
     <div className="page-dashboard-list">
@@ -173,7 +180,7 @@ const DashboardListPage = itemsList(
         return item => new Dashboard(item);
       },
     }),
-  () => new UrlStateStorage({ orderByField: "created_at", orderByReverse: true })
+  ({ ...props }) => new UrlStateStorage({ orderByField: props.orderByField ?? "created_at", orderByReverse: true })
 );
 
 routes.register(
@@ -189,7 +196,7 @@ routes.register(
   routeWithUserSession({
     path: "/dashboards/favorites",
     title: "Favorite Dashboards",
-    render: pageProps => <DashboardListPage {...pageProps} currentPage="favorites" />,
+    render: pageProps => <DashboardListPage {...pageProps} currentPage="favorites" orderByField="starred_at" />,
   })
 );
 routes.register(

client/app/pages/home/components/FavoritesList.jsx

@@ -15,7 +15,7 @@ export function FavoriteList({ title, resource, itemUrl, emptyState }) {
   useEffect(() => {
     setLoading(true);
     resource
-      .favorites()
+      .favorites({ order: "-starred_at" })
       .then(({ results }) => setItems(results))
       .finally(() => setLoading(false));
   }, [resource]);

client/app/pages/queries-list/QueriesList.jsx

@@ -108,12 +108,19 @@ function QueriesList({ controller }) {
     };
   }, []);
 
+  let usedListColumns = listColumns;
+  if (controller.params.currentPage === "favorites") {
+    usedListColumns = [
+      ...usedListColumns,
+      Columns.dateTime.sortable({ title: "Starred At", field: "starred_at", width: "1%" }),
+    ];
+  }
   const {
     areExtraActionsAvailable,
     listColumns: tableColumns,
     Component: ExtraActionsComponent,
     selectedItems,
-  } = useItemsListExtraActions(controller, listColumns, QueriesListExtraActions);
+  } = useItemsListExtraActions(controller, usedListColumns, QueriesListExtraActions);
 
   return (
     <div className="page-queries-list">
@@ -199,7 +206,7 @@ const QueriesListPage = itemsList(
         return item => new Query(item);
       },
     }),
-  () => new UrlStateStorage({ orderByField: "created_at", orderByReverse: true })
+  ({ ...props }) => new UrlStateStorage({ orderByField: props.orderByField ?? "created_at", orderByReverse: true })
 );
 
 routes.register(
@@ -215,7 +222,7 @@ routes.register(
   routeWithUserSession({
     path: "/queries/favorites",
     title: "Favorite Queries",
-    render: pageProps => <QueriesListPage {...pageProps} currentPage="favorites" />,
+    render: pageProps => <QueriesListPage {...pageProps} currentPage="favorites" orderByField="starred_at" />,
   })
 );
 routes.register(

redash/handlers/dashboards.py

@@ -26,6 +26,8 @@
     "-name": "-lowercase_name",
     "created_at": "created_at",
     "-created_at": "-created_at",
+    "starred_at": "favorites-created_at",
+    "-starred_at": "-favorites-created_at",
 }
 
 order_results = partial(_order_results, default_order="-created_at", allowed_orders=order_map)

redash/handlers/queries.py

@@ -44,6 +44,8 @@
     "-executed_at": "-query_results-retrieved_at",
     "created_by": "users-name",
     "-created_by": "-users-name",
+    "starred_at": "favorites-created_at",
+    "-starred_at": "-favorites-created_at",
 }
 
 order_results = partial(_order_results, default_order="-created_at", allowed_orders=order_map)

redash/models/__init__.py

@@ -1145,15 +1145,19 @@ def all_tags(cls, org, user):
     def favorites(cls, user, base_query=None):
         if base_query is None:
             base_query = cls.all(user.org, user.group_ids, user.id)
-        return base_query.join(
-            (
-                Favorite,
-                and_(
-                    Favorite.object_type == "Dashboard",
-                    Favorite.object_id == Dashboard.id,
-                ),
+        return (
+            base_query.distinct(cls.lowercase_name, Dashboard.created_at, Dashboard.slug, Favorite.created_at)
+            .join(
+                (
+                    Favorite,
+                    and_(
+                        Favorite.object_type == "Dashboard",
+                        Favorite.object_id == Dashboard.id,
+                    ),
+                )
             )
-        ).filter(Favorite.user_id == user.id)
+            .filter(Favorite.user_id == user.id)
+        )
 
     @classmethod
     def by_user(cls, user):

redash/serializers/__init__.py

@@ -82,9 +82,19 @@ def serialize(self):
         else:
             result = [serialize_query(query, **self.options) for query in self.object_or_list]
             if self.options.get("with_favorite_state", True):
-                favorite_ids = models.Favorite.are_favorites(current_user.id, self.object_or_list)
+                queries = list(self.object_or_list)
+                favorites = models.Favorite.query.filter(
+                    models.Favorite.object_id.in_([o.id for o in queries]),
+                    models.Favorite.object_type == "Query",
+                    models.Favorite.user_id == current_user.id,
+                )
+                favorites_dict = {fav.object_id: fav for fav in favorites}
+
                 for query in result:
-                    query["is_favorite"] = query["id"] in favorite_ids
+                    favorite = favorites_dict.get(query["id"])
+                    query["is_favorite"] = favorite is not None
+                    if favorite:
+                        query["starred_at"] = favorite.created_at
 
         return result
 
@@ -263,9 +273,19 @@ def serialize(self):
         else:
             result = [serialize_dashboard(obj, **self.options) for obj in self.object_or_list]
             if self.options.get("with_favorite_state", True):
-                favorite_ids = models.Favorite.are_favorites(current_user.id, self.object_or_list)
-                for obj in result:
-                    obj["is_favorite"] = obj["id"] in favorite_ids
+                dashboards = list(self.object_or_list)
+                favorites = models.Favorite.query.filter(
+                    models.Favorite.object_id.in_([o.id for o in dashboards]),
+                    models.Favorite.object_type == "Dashboard",
+                    models.Favorite.user_id == current_user.id,
+                )
+                favorites_dict = {fav.object_id: fav for fav in favorites}
+
+                for query in result:
+                    favorite = favorites_dict.get(query["id"])
+                    query["is_favorite"] = favorite is not None
+                    if favorite:
+                        query["starred_at"] = favorite.created_at
 
         return result