common, database, webui: Record web logins in the backend

With this, we should be able to get a better idea of how many
web logins occur over a given time period.

Combining that with the similar info for our other daemons
should let us figure out how many Monthly Active Users we
have.

Author: justinclift

common/postgresql.go

@@ -5326,3 +5326,25 @@ func VisualisationSaveParams(dbOwner, dbName, visName string, visParams VisParam
 	}
 	return
 }
+
+// RecordWebLogin records the start time of a user login session, for stats purposes
+func RecordWebLogin(userName string) (err error) {
+	// Add the new user to the database
+	dbQuery := `
+		WITH u AS (
+			SELECT user_id
+			FROM users
+			WHERE lower(user_name) = lower($1)
+		)
+		INSERT INTO webui_logins (user_id)
+		SELECT (SELECT user_id FROM u)`
+	commandTag, err := pdb.Exec(context.Background(), dbQuery, userName)
+	if err != nil {
+		return
+	}
+	if numRows := commandTag.RowsAffected(); numRows != 1 {
+		err = errors.New(fmt.Sprintf("Wrong number of rows (%d) affected while adding a webUI login record for '%s' to the database",
+			numRows, SanitiseLogString(userName)))
+	}
+	return
+}

database/migrations/000001_initial.down.sql

@@ -1,5 +1,5 @@
 BEGIN;
-DROP TRIGGER track_applied_migrations ON schema_migrations;
-DROP FUNCTION track_applied_migration();
-DROP TABLE schema_migrations_history;
+DROP TRIGGER IF EXISTS track_applied_migrations ON schema_migrations;
+DROP FUNCTION IF EXISTS track_applied_migration();
+DROP TABLE IF EXISTS schema_migrations_history;
 COMMIT;

database/migrations/000002_webui_logins.down.sql

@@ -0,0 +1,4 @@
+BEGIN;
+DROP TABLE IF EXISTS public.webui_logins;
+DROP INDEX IF EXISTS webui_logins_user_id_index;
+COMMIT;

database/migrations/000002_webui_logins.up.sql

@@ -0,0 +1,15 @@
+BEGIN;
+
+CREATE TABLE IF NOT EXISTS public.webui_logins
+(
+    id         bigserial,
+    user_id    bigint
+        constraint webui_logins_users_user_id_fk
+            references public.users (user_id),
+    login_date timestamptz default now() not null
+);
+
+CREATE INDEX IF NOT EXISTS webui_logins_user_id_index
+    on public.webui_logins (user_id);
+
+COMMIT;

webui/main.go

@@ -1,6 +1,7 @@
 package main
 
 import (
+	"context"
 	"crypto/tls"
 	"encoding/csv"
 	"encoding/json"
@@ -108,20 +109,20 @@ func auth0CallbackHandler(w http.ResponseWriter, r *http.Request) {
 	}
 	code := r.URL.Query().Get("code")
 	if code == "" {
-		log.Printf("Login failure from '%v', probably due to blocked 3rd party cookies", r.RemoteAddr)
+		log.Printf("Login failure from '%s', probably due to blocked 3rd party cookies", r.RemoteAddr)
 		errorPage(w, r, http.StatusInternalServerError,
 			"Login failure.  Please allow 3rd party cookies from https://dbhub.eu.auth0.com then try again (it should then work).")
 		return
 	}
-	token, err := conf.Exchange(oauth2.NoContext, code)
+	token, err := conf.Exchange(context.Background(), code)
 	if err != nil {
 		log.Printf("Login failure: %s", err.Error())
 		errorPage(w, r, http.StatusInternalServerError, "Login failed")
 		return
 	}
 
 	// Retrieve the user info (JSON format)
-	conn := conf.Client(oauth2.NoContext, token)
+	conn := conf.Client(context.Background(), token)
 	userInfo, err := conn.Get("https://" + com.Conf.Auth0.Domain + "/userinfo")
 	if err != nil {
 		errorPage(w, r, http.StatusInternalServerError, err.Error())
@@ -170,7 +171,7 @@ func auth0CallbackHandler(w http.ResponseWriter, r *http.Request) {
 	if ok {
 		auth0Conn = co.(string)
 	}
-	if auth0Conn != "Test2DB" { // The Auth0 fallback profile pic's seem pretty lousy, so avoid those
+	if auth0Conn != "Test2DB" { // The Auth0 fallback profile pics seem pretty lousy, so avoid those
 		p, ok := profile["picture"]
 		if ok && p.(string) != "" {
 			avatarURL = p.(string)
@@ -275,7 +276,12 @@ func auth0CallbackHandler(w http.ResponseWriter, r *http.Request) {
 		return
 	}
 
-	// Login completed, so bounce to the users' profile page
+	// Login completed, so record it and bounce them to their profile page
+	err = com.RecordWebLogin(userName)
+	if err != nil {
+		// Although something went wrong here, lets just log it to our backend for admin follow up
+		log.Println(err)
+	}
 	http.Redirect(w, r, "/"+userName, http.StatusSeeOther)
 }