plausible/analytics
1
1
Fork 0
mirror of https://github.com/plausible/analytics.git synced 2024-09-11 18:07:33 +03:00
Code Issues Packages Projects Releases Wiki Activity

Revert "Sentry context in live views (#3672)" (#3673)

Browse Source 
This reverts commit 9bb2dc00d0.
This commit is contained in:
hq1 2024-01-08 17:55:08 +01:00 committed by GitHub
parent 9bb2dc00d0
commit c87b165aef
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
16 changed files with 27 additions and 192 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
extra/lib/plausible_web/live/funnel_settings.ex
View File

@ -2,8 +2,9 @@ defmodule PlausibleWeb.Live.FunnelSettings do
@moduledoc """
LiveView allowing listing, creating and deleting funnels.
"""
use PlausibleWeb, :live_view
use Phoenix.LiveView
use Phoenix.HTML
use PlausibleWeb.Live.Flash
use Plausible.Funnel

2
extra/lib/plausible_web/live/funnel_settings/form.ex
View File

@ -5,7 +5,7 @@ defmodule PlausibleWeb.Live.FunnelSettings.Form do
to allow building searchable funnel definitions out of list of goals available.
"""
use PlausibleWeb, :live_view
use Phoenix.LiveView
use Plausible.Funnel
import PlausibleWeb.Live.Components.Form

19
lib/plausible_web.ex
View File

@ -1,19 +1,4 @@
defmodule PlausibleWeb do
def live_view(opts \\ []) do
quote do
use Plausible
use Phoenix.LiveView, global_prefixes: ~w(x-)
use PlausibleWeb.Live.Flash
unless :no_sentry_context in unquote(opts) do
use PlausibleWeb.Live.SentryContext
end
alias PlausibleWeb.Router.Helpers, as: Routes
alias Phoenix.LiveView.JS
end
end
def controller do
quote do
use Phoenix.Controller, namespace: PlausibleWeb
@ -101,8 +86,4 @@ defmodule PlausibleWeb do
defmacro __using__(which) when is_atom(which) do
apply(__MODULE__, which, [])
end
defmacro __using__([{which, opts}]) when is_atom(which) do
apply(__MODULE__, which, [List.wrap(opts)])
end
end

7
lib/plausible_web/endpoint.ex
View File

@ -17,12 +17,7 @@ defmodule PlausibleWeb.Endpoint do
socket("/live", Phoenix.LiveView.Socket,
websocket: [
check_origin: true,
connect_info: [
:peer_data,
:uri,
:user_agent,
session: {__MODULE__, :runtime_session_opts, []}
]
connect_info: [session: {__MODULE__, :runtime_session_opts, []}]
]
)

2
lib/plausible_web/live/choose_plan.ex
View File

@ -2,7 +2,7 @@ defmodule PlausibleWeb.Live.ChoosePlan do
@moduledoc """
LiveView for upgrading to a plan, or changing an existing plan.
"""
use PlausibleWeb, :live_view
use Phoenix.LiveView
use Phoenix.HTML
require Plausible.Billing.Subscription.Status

3
lib/plausible_web/live/goal_settings.ex
View File

@ -2,8 +2,9 @@ defmodule PlausibleWeb.Live.GoalSettings do
@moduledoc """
LiveView allowing listing, creating and deleting goals.
"""
use PlausibleWeb, :live_view
use Phoenix.LiveView
use Phoenix.HTML
use PlausibleWeb.Live.Flash
alias Plausible.{Sites, Goals}

3
lib/plausible_web/live/goal_settings/form.ex
View File

@ -2,7 +2,8 @@ defmodule PlausibleWeb.Live.GoalSettings.Form do
@moduledoc """
Live view for the goal creation form
"""
use PlausibleWeb, :live_view
use Phoenix.LiveView
use Plausible
import PlausibleWeb.Live.Components.Form
alias PlausibleWeb.Live.Components.ComboBox

4
lib/plausible_web/live/plugins/api/settings.ex
View File

@ -2,9 +2,9 @@ defmodule PlausibleWeb.Live.Plugins.API.Settings do
@moduledoc """
LiveView allowing listing, creating and revoking Plugins API tokens.
"""
use PlausibleWeb, :live_view
use Phoenix.LiveView
use Phoenix.HTML
use PlausibleWeb.Live.Flash
alias Plausible.Sites
alias Plausible.Plugins.API.Tokens

2
lib/plausible_web/live/plugins/api/token_form.ex
View File

@ -2,7 +2,7 @@ defmodule PlausibleWeb.Live.Plugins.API.TokenForm do
@moduledoc """
Live view for the goal creation form
"""
use PlausibleWeb, live_view: :no_sentry_context
use Phoenix.LiveView
import PlausibleWeb.Live.Components.Form
alias Plausible.Repo

3
lib/plausible_web/live/props_settings.ex
View File

@ -3,8 +3,9 @@ defmodule PlausibleWeb.Live.PropsSettings do
LiveView allowing listing, allowing and disallowing custom event properties.
"""
use PlausibleWeb, :live_view
use Phoenix.LiveView
use Phoenix.HTML
use PlausibleWeb.Live.Flash
alias PlausibleWeb.Live.Components.ComboBox

2
lib/plausible_web/live/props_settings/form.ex
View File

@ -2,7 +2,7 @@ defmodule PlausibleWeb.Live.PropsSettings.Form do
@moduledoc """
Live view for the custom props creation form
"""
use PlausibleWeb, :live_view
use Phoenix.LiveView
import PlausibleWeb.Live.Components.Form
alias PlausibleWeb.Live.Components.ComboBox

6
lib/plausible_web/live/register_form.ex
View File

@ -3,13 +3,17 @@ defmodule PlausibleWeb.Live.RegisterForm do
LiveView for registration form.
"""
use PlausibleWeb, :live_view
use Phoenix.LiveView
use Phoenix.HTML
use Plausible
import PlausibleWeb.Live.Components.Form
alias Plausible.Auth
alias Plausible.Repo
alias PlausibleWeb.Router.Helpers, as: Routes
def mount(params, _session, socket) do
socket =
assign_new(socket, :invitation, fn ->

2
lib/plausible_web/live/reset_password_form.ex
View File

@ -3,7 +3,7 @@ defmodule PlausibleWeb.Live.ResetPasswordForm do
LiveView for password reset form.
"""
use PlausibleWeb, :live_view
use Phoenix.LiveView
use Phoenix.HTML
import PlausibleWeb.Live.Components.Form

76
lib/plausible_web/live/sentry_context.ex
View File

@ -1,76 +0,0 @@
defmodule PlausibleWeb.Live.SentryContext do
@moduledoc """
This module tries to supply LiveViews with some common Sentry context
(without it, there is practically none).
Use via `use PlausibleWeb.Live.SentryContext` in your LiveView module,
or preferably via `use PlausibleWeb, :live_view`.
In case you have multiple LiveViews, there is `use PlausibleWeb, live_view: :no_sentry_context`
exposed that allows you to skip using this module. This is because
only the root LiveView has access to `connect_info` and an exception will be
thrown otherwise.
"""
defmacro __using__(_) do
quote do
on_mount PlausibleWeb.Live.SentryContext
end
end
def on_mount(:default, _params, session, socket) do
peer = Phoenix.LiveView.get_connect_info(socket, :peer_data)
uri = Phoenix.LiveView.get_connect_info(socket, :uri)
user_agent =
Phoenix.LiveView.get_connect_info(socket, :user_agent)
socket_host =
case socket.host_uri do
:not_mounted_at_router -> :not_mounted_at_router
%URI{host: host} -> host
end
request_context =
%{
host: socket_host,
env: %{
"REMOTE_ADDR" => get_ip(peer),
"REMOTE_PORT" => peer && peer.port,
"SEVER_NAME" => uri && uri.host
}
}
request_context =
if user_agent do
Map.merge(request_context, %{
headers: %{
"User-Agent" => user_agent
}
})
else
request_context
end
Sentry.Context.set_request_context(request_context)
user_id = session["current_user_id"]
if user_id do
Sentry.Context.set_user_context(%{
id: user_id
})
end
{:cont, socket}
end
defp get_ip(%{address: addr}) do
case :inet.ntoa(addr) do
{:error, _} -> ""
address -> to_string(address)
end
end
defp get_ip(_), do: ""
end

7
lib/plausible_web/live/sites.ex
View File

@ -3,7 +3,11 @@ defmodule PlausibleWeb.Live.Sites do
LiveView for sites index.
"""
use PlausibleWeb, :live_view
use Phoenix.LiveView, global_prefixes: ~w(x-)
use PlausibleWeb.Live.Flash
use Plausible
alias Phoenix.LiveView.JS
use Phoenix.HTML
import PlausibleWeb.Components.Generic
@ -14,6 +18,7 @@ defmodule PlausibleWeb.Live.Sites do
alias Plausible.Site
alias Plausible.Sites
alias Plausible.Site.Memberships.Invitations
alias PlausibleWeb.Router.Helpers, as: Routes
def mount(params, %{"current_user_id" => user_id}, socket) do
uri =

78
test/plausible_web/live/sentry_context_test.exs
View File

@ -1,78 +0,0 @@
defmodule PlausibleWeb.Live.SentryContextTest do
use PlausibleWeb.ConnCase, async: true
import Phoenix.LiveViewTest
defmodule SampleLV do
use PlausibleWeb, :live_view
def mount(_params, %{"test" => test_pid}, socket) do
socket = assign(socket, test_pid: test_pid)
{:ok, socket}
end
def render(assigns) do
~H"""
ok computer
"""
end
def handle_event("get_sentry_context", _params, socket) do
context = Sentry.Context.get_all()
send(socket.assigns.test_pid, {:context, context})
{:noreply, socket}
end
end
describe "sentry context" do
test "basic shape", %{conn: conn} do
context_hook(conn)
assert_receive {:context, context}
assert %{
extra: %{},
request: %{
env: %{
"REMOTE_ADDR" => "127.0.0.1",
"REMOTE_PORT" => port,
"SEVER_NAME" => "www.example.com"
},
host: :not_mounted_at_router
},
user: %{},
tags: %{},
breadcrumbs: []
} = context
assert is_integer(port)
end
test "user-agent is included", %{conn: conn} do
conn
|> put_req_header("user-agent", "Firefox")
|> context_hook()
assert_receive {:context, context}
assert context.request.headers["User-Agent"] == "Firefox"
end
test "user_id is included", %{conn: conn} do
context_hook(conn, %{"current_user_id" => 172})
assert_receive {:context, context}
assert context.user.id == 172
end
end
defp context_hook(conn, extra_session \\ %{}) do
lv = get_liveview(conn, extra_session)
assert render(lv) =~ "ok computer"
render_hook(lv, :get_sentry_context, %{})
end
defp get_liveview(conn, extra_session) do
{:ok, lv, _html} =
live_isolated(conn, SampleLV, session: Map.merge(%{"test" => self()}, extra_session))
lv
end
end