Add report_dashboard.last_viewed_at

- defaults to `now()` (it's intended to be used as a timestamp after which we're *sure* the item hasn't been used, not a definitive timestamp we're sure the dashboard was actually used at) - updated whenever the QP processes a query for a dashcard
metabase · Jul 11, 2024 · 07f058e · 07f058e
1 parent e62d098
commit 07f058e
Show file tree

Hide file tree

Showing 7 changed files with 44 additions and 2 deletions.
diff --git a/enterprise/backend/src/metabase_enterprise/serialization/load.clj b/enterprise/backend/src/metabase_enterprise/serialization/load.clj
@@ -441,6 +441,11 @@
     ;; for a deprecated feature
     (m/update-existing-in p [:values_source_config :card_id] fully-qualified-name->card-id)))
 
+(defn- parse-timestamp [ts]
+  (if (string? ts)
+    (u.date/parse ts)
+    ts))
+
 (defn load-dashboards!
   "Loads `dashboards` (which is a sequence of maps parsed from a YAML dump of dashboards) in a given `context`."
   {:added "0.40.0"}
@@ -449,6 +454,7 @@
                                             (for [dashboard dashboards]
                                               (-> dashboard
                                                   (update :parameters resolve-dashboard-parameters)
+                                                  (update :last_viewed_at parse-timestamp)
                                                   (dissoc :dashboard_cards)
                                                   (assoc :collection_id (:collection context)
                                                          :creator_id    (default-user-id)))))

diff --git a/resources/migrations/001_update_migrations.yaml b/resources/migrations/001_update_migrations.yaml
@@ -8349,6 +8349,26 @@ databaseChangeLog:
             columnName: explicit_reference
             defaultValueBoolean: true
 
+  - changeSet:
+      id: v51.2024-07-10T12:28:10
+      author: johnswanson
+      comment: Add `last_viewed_at` to dashboards
+      changes:
+        - addColumn:
+            tableName: report_dashboard
+            columns:
+              - column:
+                  name: last_viewed_at
+                  type: ${timestamp_type}
+                  remarks: Timestamp of when this dashboard was last viewed
+                  defaultValueComputed: current_timestamp
+                  constraints:
+                    nullable: false
+      rollback:
+        - dropColumn:
+            tableName: report_dashboard
+            columnName: last_viewed_at
+
   # >>>>>>>>>> DO NOT ADD NEW MIGRATIONS BELOW THIS LINE! ADD THEM ABOVE <<<<<<<<<<
 
 ########################################################################################################################

diff --git a/src/metabase/events/view_log.clj b/src/metabase/events/view_log.clj
@@ -57,6 +57,17 @@
       (catch Throwable e
         (log/warnf e "Failed to process view event. %s" topic)))))
 
+(derive ::dashboard-queried :metabase/event)
+(derive :event/dashboard-queried ::dashboard-queried)
+
+(m/defmethod events/publish-event! ::dashboard-queried
+  "Handle processing for a dashboard query being run"
+  [topic {:keys [object-id] :as _event}]
+  (try
+    (t2/update! :model/Dashboard {:id object-id} {:last_viewed_at :%now})
+    (catch Throwable e
+      (log/warnf e "Failed to process dashboard query event. %s" topic))))
+
 (derive ::collection-read-event :metabase/event)
 (derive :event/collection-read ::collection-read-event)
 

diff --git a/src/metabase/models/dashboard.clj b/src/metabase/models/dashboard.clj
@@ -242,7 +242,8 @@
    ;;   lower-numbered positions appearing before higher numbered ones.
    ;; TODO: querying on stats we don't have any dashboard that has a position, maybe we could just drop it?
    :public_uuid :made_public_by_id
-   :position :initially_published_at :view_count])
+   :position :initially_published_at :view_count
+   :last_viewed_at])
 
 (def ^:private excluded-columns-for-dashcard-revision
   [:entity_id :created_at :updated_at :collection_authority_level])

diff --git a/src/metabase/query_processor/dashboard.clj b/src/metabase/query_processor/dashboard.clj
@@ -5,6 +5,7 @@
    [medley.core :as m]
    [metabase.api.common :as api]
    [metabase.driver.common.parameters.operators :as params.ops]
+   [metabase.events :as events]
    [metabase.legacy-mbql.normalize :as mbql.normalize]
    [metabase.lib.schema.id :as lib.schema.id]
    [metabase.models.dashboard :as dashboard :refer [Dashboard]]
@@ -175,6 +176,7 @@
                     :attributes {:dashboard/id dashboard-id
                                  :dashcard/id  dashcard-id
                                  :card/id      card-id}}
+    (events/publish-event! :event/dashboard-queried {:object-id dashboard-id :user-id api/*current-user-id*})
     ;; make sure we can read this Dashboard. Card will get read-checked later on inside
     ;; [[qp.card/process-query-for-card]]
     (api/read-check Dashboard dashboard-id)

diff --git a/test/metabase/api/dashboard_test.clj b/test/metabase/api/dashboard_test.clj
@@ -107,6 +107,7 @@
                  (dissoc :id)
                  (assoc :created_at (boolean created_at)
                         :updated_at (boolean updated_at))
+                 (update :last_viewed_at boolean)
                  (update :entity_id boolean)
                  (update :collection_id boolean)
                  (update :collection boolean)
@@ -206,6 +207,7 @@
    :collection_position     nil
    :collection              true
    :created_at              true ; assuming you call dashboard-response on the results
+   :last_viewed_at          true
    :description             nil
    :embedding_params        nil
    :enable_embedding        false

diff --git a/test/metabase/http_client.clj b/test/metabase/http_client.clj
@@ -83,7 +83,7 @@
 ;;; parse-response
 
 (def ^:private auto-deserialize-dates-keys
-  #{:created_at :updated_at :last_login :date_joined :started_at :finished_at :last_analyzed :last_used_at})
+  #{:created_at :updated_at :last_login :date_joined :started_at :finished_at :last_analyzed :last_used_at :last_viewed_at})
 
 (defn- auto-deserialize-dates
   "Automatically recurse over `response` and look for keys that are known to correspond to dates. Parse their values and