Penpot/penpot
0
Fork 0
mirror of https://github.com/penpot/penpot.git synced 2025-03-18 18:51:29 -05:00
Code Issues Activity

🎉 Add analytics related event namespace.

Browse source
This commit is contained in:
Andrey Antukh 2021-05-04 15:17:07 +02:00 • committed by Andrés Moya
parent 04ab99c8ad
commit 8835216ca9
4 changed files with 249 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
docker/images/files/config.js
View file

@ -9,3 +9,4 @@
//var penpotOIDCClientID = "<oidc-client-id-here>";
//var penpotLoginWithLDAP = <true|false>;
//var penpotRegistrationEnabled = <true|false>;
//var penpotAnalyticsEnabled = <true|false>;

9
docker/images/files/nginx-entrypoint.sh
View file

@ -97,6 +97,14 @@ update_registration_enabled() {
fi
}
update_registration_enabled() {
if [ -n "$PENPOT_ANALYTICS_ENABLED" ]; then
sed -i \
-e "s|^//var penpotAnalyticsEnabled = .*;|var penpotAnalyticsEnabled = $PENPOT_ANALYTICS_ENABLED;|g" \
"$1"
fi
}
update_public_uri /var/www/app/js/config.js
update_demo_warning /var/www/app/js/config.js
update_allow_demo_users /var/www/app/js/config.js
@ -106,5 +114,6 @@ update_github_client_id /var/www/app/js/config.js
update_oidc_client_id /var/www/app/js/config.js
update_login_with_ldap /var/www/app/js/config.js
update_registration_enabled /var/www/app/js/config.js
update_analytics_enabled /var/www/app/js/config.js
exec "$@";

1
frontend/src/app/config.cljs
View file

@ -76,6 +76,7 @@
(def worker-uri (obj/get global "penpotWorkerURI" "/js/worker.js"))
(def translations (obj/get global "penpotTranslations"))
(def themes (obj/get global "penpotThemes"))
(def analytics (obj/get global "penpotAnalyticsEnabled" false))
(def version (delay (parse-version global)))
(def target (delay (parse-target global)))

238
frontend/src/app/main/data/events.cljs Normal file
View file

@ -0,0 +1,238 @@
;; This Source Code Form is subject to the terms of the Mozilla Public
;; License, v. 2.0. If a copy of the MPL was not distributed with this
;; file, You can obtain one at http://mozilla.org/MPL/2.0/.
;;
;; Copyright (c) UXBOX Labs SL
(ns app.main.data.events
(:require
["ua-parser-js" :as UAParser]
[app.common.data :as d]
[app.main.repo :as rp]
[app.config :as cf]
[app.util.globals :as g]
[app.util.http :as http]
[app.util.object :as obj]
[app.util.storage :refer [storage]]
[app.util.time :as dt]
[app.util.i18n :as i18n]
[beicon.core :as rx]
[lambdaisland.uri :as u]
[potok.core :as ptk]))
;; Defines the maximum buffer size, after events start discarding.
(def max-buffer-size 1024)
;; Defines the maximum number of events that can go in a single batch.
(def max-chunk-size 100)
;; Defines the time window within events belong to the same session.
(def session-timeout
(dt/duration {:minutes 30}))
;; --- CONTEXT
(defn- collect-context
[]
(let [uagent (UAParser.)]
(d/merge
{:app-version (:full @cf/version)
:locale @i18n/locale}
(let [browser (.getBrowser uagent)]
{:browser (obj/get browser "name")
:browser-version (obj/get browser "version")})
(let [engine (.getEngine uagent)]
{:engine (obj/get engine "name")
:engine-version (obj/get engine "version")})
(let [os (.getOS uagent)
name (obj/get os "name")
version (obj/get os "version")]
{:os (str name " " version)
:os-version version})
(let [device (.getDevice uagent)]
(if-let [type (obj/get device "type")]
{:device-type type
:device-vendor (obj/get device "vendor")
:device-model (obj/get device "model")}
{:device-type "unknown"}))
(let [screen (obj/get g/window "screen")
orientation (obj/get screen "orientation")]
{:screen-width (obj/get screen "width")
:screen-height (obj/get screen "height")
:screen-color-depth (obj/get screen "colorDepth")
:screen-orientation (obj/get orientation "type")})
(let [cpu (.getCPU uagent)]
{:device-arch (obj/get cpu "architecture")}))))
(def context
(atom (d/without-nils (collect-context))))
(add-watch i18n/locale ::events #(swap! context assoc :locale %4))
;; --- EVENT TRANSLATION
(defmulti ^:private process-event ptk/type)
(defmethod process-event :default [_] nil)
(defmethod process-event ::event
[event]
(let [data (deref event)]
(when (::name data)
(d/without-nils
{:type (::type data "action")
:name (::name data)
:context (::context data)
:props (dissoc data ::name ::type ::context)}))))
(defmethod process-event :app.util.router/navigated
[event]
(let [match (deref event)
route (get-in match [:data :name])
props {:route (name route)
:team-id (get-in match [:path-params :team-id])
:file-id (get-in match [:path-params :file-id])
:project-id (get-in match [:path-params :project-id])}]
{:name "navigate"
:type "action"
:timestamp (dt/now)
:props (d/without-nils props)}))
(defmethod process-event :app.main.data.users/logged-in
[event]
(let [data (deref event)
mdata (meta data)
props [:email
:auth-backend
:fullname
:is-muted
:default-team-id
:default-project-id]]
{:name "signin"
:type "identify"
:profile-id (:id data)
:props (-> (select-keys data props)
(assoc :signin-source (::source mdata)))}))
(defmethod process-event :app.main.data.dashboard/project-created
[event]
(let [data (deref event)]
{:type "action"
:name "create-page"
:props {:id (:id data)
:team-id (:team-id data)}}))
(defmethod process-event :app.main.data.dashboard/file-created
[event]
(let [data (deref event)]
{:type "action"
:name "create-file"
:props {:id (:id data)
:project-id (:project-id data)}}))
(defmethod process-event :app.main.data.workspace/create-page
[event]
(let [data (deref event)]
{:type "action"
:name "create-page"
:props {:id (:id data)
:file-id (:file-id data)
:project-id (:project-id data)}}))
(defn- event->generic-action
[event name]
{:type "action"
:name name
:props {}})
(defmethod process-event :app.main.data.users/logout
[event]
(event->generic-action event "logout"))
;; --- MAIN LOOP
(defn- append-to-buffer
[buffer item]
(if (>= (count buffer) max-buffer-size)
buffer
(conj buffer item)))
(defn- remove-from-buffer
[buffer items]
(into #queue [] (drop items) buffer))
(defn- persist-events
[events]
(let [uri (u/join cf/public-uri "events")
params {:events events}]
(->> (http/send! {:uri uri
:method :post
:body (http/transit-data params)})
(rx/mapcat rp/handle-response))))
(defmethod ptk/resolve ::persistence
[_ {:keys [buffer] :as params}]
(ptk/reify ::persistence
ptk/EffectEvent
(effect [_ state stream]
(let [events (into [] (take max-chunk-size) @buffer)]
(when-not (empty? events)
(->> (persist-events events)
(rx/subs (fn [_]
(swap! buffer remove-from-buffer (count events))))))))))
(defn initialize
[]
(let [buffer (atom #queue [])]
(ptk/reify ::initialize
ptk/WatchEvent
(watch [_ state stream]
(->> (rx/from-atom buffer)
(rx/filter #(pos? (count %)))
(rx/debounce 2000)
(rx/map #(ptk/event ::persistence {:buffer buffer}))))
ptk/EffectEvent
(effect [_ state stream]
(let [events (methods process-event)
session (atom nil)
profile (->> (rx/from-atom storage {:emit-current-value? true})
(rx/map :profile)
(rx/map :id)
(rx/dedupe))
source (->> stream
(rx/with-latest-from profile)
(rx/map (fn [result]
(let [event (aget result 0)
profile-id (aget result 1)
type (ptk/type event)
impl-fn (get events type)]
(when (fn? impl-fn)
(some-> (impl-fn event)
(update :profile-id #(or % profile-id)))))))
(rx/filter :profile-id)
(rx/map (fn [event]
(let [session* (or @session (dt/now))
context (-> @context
(d/merge (:context event))
(assoc :session session*))]
(swap! session (constantly session*))
(-> event
(assoc :timestamp (dt/now))
(assoc :context context)))))
(rx/share))]
(->> source
(rx/switch-map #(rx/timer (inst-ms session-timeout)))
(rx/subs #(reset! session nil)))
(->> source
(rx/subs (fn [event]
(swap! buffer append-to-buffer event)))))))))
(defmethod ptk/resolve ::initialize
[_ params]
(if cf/analytics
(initialize)
(ptk/data-event ::initialize params)))