Open source, privacy-first web analytics. Lightweight, cookie-free Google Analytics alternative. Self-hosted or cloud.
TypeScript analyticsanalytics-dashboardclickhouseelixirgoogle-analyticsmarketingopen-source-analyticsphoenixplausible-analyticspostgresqlprivacyprivacy-friendlyself-hostedsimple-analyticsstatisticstailwindcssweb-analyticswebsite-analyticswebsite-statswebsite-tracking
Implement listing user sessions in user settings (#4588)
Adrian Gruntkowski714c03675707
diff --git a/CHANGELOG.md b/CHANGELOG.mdindex 33a93b1fa2..6f061a0ab6 100644--- a/CHANGELOG.md+++ b/CHANGELOG.md@@ -3,6 +3,16 @@ All notable changes to this project will be documented in this file.## Unreleased+### Added++- Add ability to review and revoke particular logged in user sessions++### Removed++### Changed++### Fixed+## v2.1.3 - 2024-09-26### Fixeddiff --git a/lib/plausible/auth/user_sessions.ex b/lib/plausible/auth/user_sessions.exnew file mode 100644index 0000000000..821f94a40e--- /dev/null+++ b/lib/plausible/auth/user_sessions.ex@@ -0,0 +1,33 @@+defmodule Plausible.Auth.UserSessions do+ @moduledoc """+ Functions for interacting with user sessions.+ """++ import Ecto.Query, only: [from: 2]+ alias Plausible.Auth+ alias Plausible.Repo++ @spec list_for_user(Auth.User.t(), NaiveDateTime.t()) :: [Auth.UserSession.t()]+ def list_for_user(user, now \\ NaiveDateTime.utc_now(:second)) do+ Repo.all(+ from us in Auth.UserSession,+ where: us.user_id == ^user.id,+ where: us.timeout_at >= ^now,+ order_by: [desc: us.last_used_at, desc: us.id]+ )+ end++ @spec last_used_humanize(Auth.UserSession.t(), NaiveDateTime.t()) :: String.t()+ def last_used_humanize(user_session, now \\ NaiveDateTime.utc_now(:second)) do+ diff = NaiveDateTime.diff(now, user_session.last_used_at, :hour)+ diff_days = NaiveDateTime.diff(now, user_session.last_used_at, :day)++ cond do+ diff < 1 -> "Just recently"+ diff == 1 -> "1 hour ago"+ diff < 24 -> "#{diff} hours ago"+ diff < 2 * 24 -> "Yesterday"+ true -> "#{diff_days} days ago"+ end+ end+enddiff --git a/lib/plausible_web/controllers/auth_controller.ex b/lib/plausible_web/controllers/auth_controller.exindex 3c9d296d3b..2226be3a48 100644--- a/lib/plausible_web/controllers/auth_controller.ex+++ b/lib/plausible_web/controllers/auth_controller.ex@@ -33,6 +33,7 @@ defmodule PlausibleWeb.AuthController do:new_api_key,:create_api_key,:delete_api_key,+ :delete_session,:delete_me,:activate_form,:activate,@@ -528,9 +529,11 @@ defmodule PlausibleWeb.AuthController dosettings_changeset = Keyword.fetch!(opts, :settings_changeset)email_changeset = Keyword.fetch!(opts, :email_changeset)api_keys = Repo.preload(current_user, :api_keys).api_keys+ user_sessions = Auth.UserSessions.list_for_user(current_user)render(conn, "user_settings.html",api_keys: api_keys,+ user_sessions: user_sessions,settings_changeset: settings_changeset,email_changeset: email_changeset,subscription: current_user.subscription,@@ -584,6 +587,16 @@ defmodule PlausibleWeb.AuthController dologout(conn, params)end+ def delete_session(conn, %{"id" => session_id}) do+ current_user = conn.assigns.current_user++ :ok = UserAuth.revoke_user_session(current_user, session_id)++ conn+ |> put_flash(:success, "Session logged out successfully")+ |> redirect(to: "/settings#user-sessions")+ end+def logout(conn, params) doredirect_to = Map.get(params, "redirect", "/")diff --git a/lib/plausible_web/router.ex b/lib/plausible_web/router.exindex 633c8c85ed..fe6ebbe363 100644--- a/lib/plausible_web/router.ex+++ b/lib/plausible_web/router.ex@@ -334,6 +334,7 @@ defmodule PlausibleWeb.Router doget "/settings/api-keys/new", AuthController, :new_api_keypost "/settings/api-keys", AuthController, :create_api_keydelete "/settings/api-keys/:id", AuthController, :delete_api_key+ delete "/settings/user-sessions/:id", AuthController, :delete_sessionget "/auth/google/callback", AuthController, :google_auth_callbackdiff --git a/lib/plausible_web/templates/auth/user_settings.html.heex b/lib/plausible_web/templates/auth/user_settings.html.heexindex 636d75fd67..d631f4631b 100644--- a/lib/plausible_web/templates/auth/user_settings.html.heex+++ b/lib/plausible_web/templates/auth/user_settings.html.heex@@ -313,11 +313,82 @@<%= submit("Change my email",class:- "inline-block mt-4 px-4 py-2 border border-gray-300 dark:border-gray-500 text-sm leading-5 font-medium rounded-md text-red-700 bg-white dark:bg-gray-800 hover:text-red-500 dark:hover:text-red-400 focus:outline-none focus:border-blue-300 focus:ring active:text-red-800 active:bg-gray-50 transition ease-in-out duration-150"+ "inline-block mt-4 px-4 py-2 border border-gray-300 dark:border-gray-500 text-sm leading-5 font-medium rounded-md text-red-600 dark:text-red-500 bg-white dark:bg-gray-800 hover:text-red-400 focus:outline-none focus:border-blue-300 focus:ring active:text-red-800 active:bg-gray-50 transition ease-in-out duration-150") %><% end %></div>+ <div+ id="user-sessions"+ class="max-w-2xl px-8 pt-6 pb-8 mx-auto mt-16 bg-white border-t-2 border-indigo-100 rounded rounded-t-none shadow-md dark:bg-gray-800 dark:border-indigo-500"+ >+ <h2 class="text-xl font-black dark:text-gray-100">Login Management</h2>++ <div class="my-4 border-b border-gray-300 dark:border-gray-500"></div>++ <p class="text-sm mt-2 text-gray-600 dark:text-gray-400">+ Log out of your account on other devices. Note that logged-in sessions automatically expire after 14 days of inactivity.+ </p>++ <div class="flex flex-col mt-6">+ <div class="-my-2 overflow-x-auto sm:-mx-6 lg:-mx-8">+ <div class="inline-block min-w-full py-2 align-middle sm:px-6 lg:px-8">+ <%= if Enum.any?(@user_sessions) do %>+ <div class="overflow-hidden border-b border-gray-200 shadow dark:border-gray-900 sm:rounded-lg">+ <table class="min-w-full divide-y divide-gray-200 dark:divide-gray-900">+ <thead class="bg-gray-50 dark:bg-gray-900">+ <tr>+ <th+ scope="col"+ class="px-6 py-3 text-xs font-medium tracking-wider text-left text-gray-500 uppercase dark:text-gray-100"+ >+ Device+ </th>+ <th+ scope="col"+ class="px-6 py-3 text-xs font-medium tracking-wider text-left text-gray-500 uppercase dark:text-gray-100"+ >+ Last seen+ </th>+ <th scope="col" class="relative px-6 py-3">+ <span class="sr-only">Log Out</span>+ </th>+ </tr>+ </thead>+ <tbody>+ <%= for session <- @user_sessions do %>+ <tr class="bg-white dark:bg-gray-800">+ <td class="px-6 py-4 text-sm font-medium text-gray-900 dark:text-gray-100 whitespace-nowrap">+ <%= session.device %>+ </td>+ <td class="px-6 py-4 text-sm text-gray-500 dark:text-gray-100 whitespace-nowrap">+ <%= Plausible.Auth.UserSessions.last_used_humanize(session) %>+ </td>+ <td class="px-6 py-4 text-sm font-medium text-right whitespace-nowrap">+ <%= if @current_user_session.id == session.id do %>+ <span class="text-gray-500 dark:text-gray-100">+ Current Session+ </span>+ <% else %>+ <%= button("Log Out",+ to: "/settings/user-sessions/#{session.id}",+ class: "text-red-600 hover:text-red-400 dark:text-red-500",+ method: :delete,+ "data-confirm": "Are you sure you want to log out this session?"+ ) %>+ <% end %>+ </td>+ </tr>+ <% end %>+ </tbody>+ </table>+ </div>+ <% end %>+ </div>+ </div>+ </div>+ </div>+<divid="api-keys"class="max-w-2xl px-8 pt-6 pb-8 mx-auto mt-16 bg-white border-t-2 border-indigo-100 rounded rounded-t-none shadow-md dark:bg-gray-800 dark:border-indigo-500"@@ -368,7 +439,7 @@<td class="px-6 py-4 text-sm font-medium text-right whitespace-nowrap"><%= button("Revoke",to: "/settings/api-keys/#{api_key.id}",- class: "text-red-600 hover:text-red-900",+ class: "text-red-600 hover:text-red-400 dark:text-red-500",method: :delete,"data-confirm":"Are you sure you want to revoke this key? This action cannot be reversed."@@ -415,7 +486,7 @@<%= link("Delete my account",to: "/me",class:- "inline-block mt-4 px-4 py-2 border border-gray-300 dark:border-gray-500 text-sm leading-5 font-medium rounded-md text-red-700 bg-white dark:bg-gray-800 hover:text-red-500 dark:hover:text-red-400 focus:outline-none focus:border-blue-300 focus:ring active:text-red-800 active:bg-gray-50 transition ease-in-out duration-150",+ "inline-block mt-4 px-4 py-2 border border-gray-300 dark:border-gray-500 text-sm leading-5 font-medium rounded-md text-red-700 dark:text-red-500 bg-white dark:bg-gray-800 hover:text-red-500 dark:hover:text-red-400 focus:outline-none focus:border-blue-300 focus:ring active:text-red-800 active:bg-gray-50 transition ease-in-out duration-150",method: "delete",data: [confirm:diff --git a/lib/plausible_web/user_auth.ex b/lib/plausible_web/user_auth.exindex 02cec2c645..e7fbf8e2e2 100644--- a/lib/plausible_web/user_auth.ex+++ b/lib/plausible_web/user_auth.ex@@ -65,6 +65,26 @@ defmodule PlausibleWeb.UserAuth doendend+ @spec revoke_user_session(Auth.User.t(), pos_integer()) :: :ok+ def revoke_user_session(user, session_id) do+ {_, tokens} =+ Repo.delete_all(+ from us in Auth.UserSession,+ where: us.user_id == ^user.id and us.id == ^session_id,+ select: us.token+ )++ case tokens do+ [token] ->+ PlausibleWeb.Endpoint.broadcast(live_socket_id(token), "disconnect", %{})++ _ ->+ :pass+ end++ :ok+ end+@spec revoke_all_user_sessions(Auth.User.t()) :: :okdef revoke_all_user_sessions(user) do{_count, tokens} =diff --git a/test/plausible/auth/user_sessions_test.exs b/test/plausible/auth/user_sessions_test.exsnew file mode 100644index 0000000000..673d2e795f--- /dev/null+++ b/test/plausible/auth/user_sessions_test.exs@@ -0,0 +1,64 @@+defmodule Plausible.Auth.UserSessionsTest do+ use Plausible.DataCase, async: true++ alias Plausible.Auth+ alias Plausible.Auth.UserSessions+ alias Plausible.Repo++ describe "list_for_user/2" do+ test "lists user sessions" do+ user = insert(:user)++ now = NaiveDateTime.utc_now(:second)+ thirty_minutes_ago = NaiveDateTime.shift(now, minute: -30)+ ten_hours_ago = NaiveDateTime.shift(now, hour: -10)+ ten_days_ago = NaiveDateTime.shift(now, day: -10)+ twenty_days_ago = NaiveDateTime.shift(now, day: -20)++ recent_session = insert_session(user, "Recent Device", thirty_minutes_ago)+ old_session = insert_session(user, "Old Device", ten_hours_ago)+ older_session = insert_session(user, "Older Device", ten_days_ago)+ _expired_session = insert_session(user, "Expired Device", twenty_days_ago)+ _rogue_session = insert_session(insert(:user), "Unrelated device", now)++ assert [session1, session2, session3] = UserSessions.list_for_user(user, now)++ assert session1.id == recent_session.id+ assert session2.id == old_session.id+ assert session3.id == older_session.id+ end+ end++ describe "last_used_humanize/2" do+ test "returns humanized relative time" do+ user = insert(:user)+ now = NaiveDateTime.utc_now(:second)+ thirty_minutes_ago = NaiveDateTime.shift(now, minute: -30)+ ninety_minutes_ago = NaiveDateTime.shift(now, minute: -90)+ ten_hours_ago = NaiveDateTime.shift(now, hour: -10)+ twenty_seven_hours_ago = NaiveDateTime.shift(now, hour: -27)+ fifty_hours_ago = NaiveDateTime.shift(now, hour: -50)+ ten_days_ago = NaiveDateTime.shift(now, day: -10)++ assert last_used_humanize(user, now) == "Just recently"+ assert last_used_humanize(user, thirty_minutes_ago) == "Just recently"+ assert last_used_humanize(user, ninety_minutes_ago) == "1 hour ago"+ assert last_used_humanize(user, ten_hours_ago) == "10 hours ago"+ assert last_used_humanize(user, twenty_seven_hours_ago) == "Yesterday"+ assert last_used_humanize(user, fifty_hours_ago) == "2 days ago"+ assert last_used_humanize(user, ten_days_ago) == "10 days ago"+ end+ end++ defp last_used_humanize(user, dt) do+ user+ |> insert_session("Some Device", dt)+ |> UserSessions.last_used_humanize()+ end++ defp insert_session(user, device_name, now) do+ user+ |> Auth.UserSession.new_session(device_name, now)+ |> Repo.insert!()+ end+enddiff --git a/test/plausible_web/controllers/auth_controller_test.exs b/test/plausible_web/controllers/auth_controller_test.exsindex 2b1a6d02fc..19e749c78f 100644--- a/test/plausible_web/controllers/auth_controller_test.exs+++ b/test/plausible_web/controllers/auth_controller_test.exs@@ -1100,6 +1100,27 @@ defmodule PlausibleWeb.AuthControllerTest doassert html_response(conn, 200) =~ "Disable 2FA"end++ test "renders active user sessions with an option to revoke them", %{conn: conn, user: user} do+ now = NaiveDateTime.utc_now(:second)+ seventy_minutes_ago = NaiveDateTime.shift(now, minute: -70)++ another_session =+ user+ |> Auth.UserSession.new_session("Some Device", seventy_minutes_ago)+ |> Repo.insert!()++ conn = get(conn, "/settings")++ assert html = html_response(conn, 200)++ assert html =~ "Unknown"+ assert html =~ "Current Session"+ assert html =~ "Just recently"+ assert html =~ "Some Device"+ assert html =~ "1 hour ago"+ assert html =~ Routes.auth_path(conn, :delete_session, another_session.id)+ endenddescribe "PUT /settings" do@@ -1451,6 +1472,38 @@ defmodule PlausibleWeb.AuthControllerTest doendend+ describe "DELETE /settings/user-sessions/:id" do+ setup [:create_user, :log_in]++ test "deletes session", %{conn: conn, user: user} do+ another_session =+ user+ |> Auth.UserSession.new_session("Some Device")+ |> Repo.insert!()++ conn = delete(conn, "/settings/user-sessions/#{another_session.id}")++ assert Phoenix.Flash.get(conn.assigns.flash, :success) == "Session logged out successfully"++ assert redirected_to(conn, 302) ==+ Routes.auth_path(conn, :user_settings) <> "#user-sessions"++ refute Repo.reload(another_session)+ end++ test "refuses deletion when not logged in" do+ another_session =+ insert(:user)+ |> Auth.UserSession.new_session("Some Device")+ |> Repo.insert!()++ conn = delete(build_conn(), "/settings/user-sessions/#{another_session.id}")++ assert redirected_to(conn, 302) == Routes.auth_path(conn, :login_form)+ assert Repo.reload(another_session)+ end+ end+describe "GET /auth/google/callback" dotest "shows error and redirects back to settings when authentication fails", %{conn: conn} dosite = insert(:site)diff --git a/test/plausible_web/user_auth_test.exs b/test/plausible_web/user_auth_test.exsindex 60d0416e05..5d7f10b058 100644--- a/test/plausible_web/user_auth_test.exs+++ b/test/plausible_web/user_auth_test.exs@@ -223,6 +223,49 @@ defmodule PlausibleWeb.UserAuthTest doendend+ describe "revoke_user_session/2" do+ setup [:create_user, :log_in]++ test "deletes and disconnects user session", %{user: user} do+ assert [active_session] = Repo.preload(user, :sessions).sessions+ live_socket_id = "user_sessions:" <> Base.url_encode64(active_session.token)+ Phoenix.PubSub.subscribe(Plausible.PubSub, live_socket_id)++ another_session =+ user+ |> Auth.UserSession.new_session("Some Device")+ |> Repo.insert!()++ assert :ok = UserAuth.revoke_user_session(user, active_session.id)+ assert [remaining_session] = Repo.preload(user, :sessions).sessions+ assert_broadcast "disconnect", %{}+ assert remaining_session.id == another_session.id+ refute Repo.reload(active_session)+ assert Repo.reload(another_session)+ end++ test "does not delete session of another user", %{user: user} do+ assert [active_session] = Repo.preload(user, :sessions).sessions++ other_session =+ insert(:user)+ |> Auth.UserSession.new_session("Some Device")+ |> Repo.insert!()++ assert :ok = UserAuth.revoke_user_session(user, other_session.id)++ assert Repo.reload(active_session)+ assert Repo.reload(other_session)+ end++ test "executes gracefully when session does not exist", %{user: user} do+ assert [active_session] = Repo.preload(user, :sessions).sessions+ Repo.delete!(active_session)++ assert :ok = UserAuth.revoke_user_session(user, active_session.id)+ end+ end+describe "revoke_all_user_sessions/1" dosetup [:create_user, :log_in]