Skip to content

Open source, privacy-first web analytics. Lightweight, cookie-free Google Analytics alternative. Self-hosted or cloud.

Fix issue with shared link auth with /current-visitors and segments requests (#5154)

Artur Pata964ca85f684c
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 98da717bc4..535604784a 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -38,6 +38,7 @@ All notable changes to this project will be documented in this file.
- Breakdown modals now display correct comparison values instead of 0 after pagination
- Fix database mismatch between event and session user_ids after rotating salts
- `/api/v2/query` no longer returns a 500 when querying percentage metric without `visitors`
+- Fix current visitors loading when viewing a dashboard with a shared link
## v2.1.5-rc.1 - 2025-01-17
diff --git a/assets/js/dashboard/api.ts b/assets/js/dashboard/api.ts
index 1bc8e50ec1..86256b12a9 100644
--- a/assets/js/dashboard/api.ts
+++ b/assets/js/dashboard/api.ts
@@ -15,12 +15,14 @@ export class ApiError extends Error {
}
}
-function serialize(obj: Record<string, string | boolean | number>) {
+export function serializeUrlParams(
+ params: Record<string, string | boolean | number>
+) {
const str: string[] = []
/* eslint-disable-next-line no-prototype-builtins */
- for (const p in obj)
- if (obj.hasOwnProperty(p)) {
- str.push(`${encodeURIComponent(p)}=${encodeURIComponent(obj[p])}`)
+ for (const p in params)
+ if (params.hasOwnProperty(p)) {
+ str.push(`${encodeURIComponent(p)}=${encodeURIComponent(params[p])}`)
}
return str.join('&')
}
@@ -34,7 +36,7 @@ export function cancelAll() {
abortController = new AbortController()
}
-export function serializeQuery(
+export function queryToSearchParams(
query: DashboardQuery,
extraQuery: unknown[] = []
) {
@@ -57,9 +59,6 @@ export function serializeQuery(
if (query.with_imported) {
queryObj.with_imported = String(query.with_imported)
}
- if (SHARED_LINK_AUTH) {
- queryObj.auth = SHARED_LINK_AUTH
- }
if (query.comparison) {
queryObj.comparison = query.comparison
@@ -74,7 +73,7 @@ export function serializeQuery(
Object.assign(queryObj, ...extraQuery)
- return '?' + serialize(queryObj)
+ return queryObj
}
function getHeaders(): Record<string, string> {
@@ -90,18 +89,28 @@ async function handleApiResponse(response: Response) {
return payload
}
+function getSharedLinkSearchParams(): Record<string, string> {
+ return SHARED_LINK_AUTH ? { auth: SHARED_LINK_AUTH } : {}
+}
+
export async function get(
url: string,
query?: DashboardQuery,
- ...extraQuery: unknown[]
+ ...extraQueryParams: unknown[]
) {
- const response = await fetch(
- query ? url + serializeQuery(query, extraQuery) : url,
- {
- signal: abortController.signal,
- headers: { ...getHeaders(), Accept: 'application/json' }
- }
- )
+ const sharedLinkParams = getSharedLinkSearchParams()
+
+ const queryString = query
+ ? serializeUrlParams(
+ queryToSearchParams(query, [...extraQueryParams, sharedLinkParams])
+ )
+ : serializeUrlParams(sharedLinkParams)
+
+ const response = await fetch(queryString ? `${url}?${queryString}` : url, {
+ signal: abortController.signal,
+ headers: { ...getHeaders(), Accept: 'application/json' }
+ })
+
return handleApiResponse(response)
}
@@ -113,6 +122,7 @@ export const mutation = async <
| { body: TBody; method: 'PATCH' | 'PUT' | 'POST' }
| { method: 'DELETE' }
) => {
+ const queryString = serializeUrlParams(getSharedLinkSearchParams())
const fetchOptions =
options.method === 'DELETE'
? {}
@@ -120,7 +130,7 @@ export const mutation = async <
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify(options.body)
}
- const response = await fetch(url, {
+ const response = await fetch(queryString ? `${url}?${queryString}` : url, {
method: options.method,
headers: {
...getHeaders(),
diff --git a/assets/js/dashboard/stats/graph/stats-export.js b/assets/js/dashboard/stats/graph/stats-export.js
index 1b1dd5b3b0..8fd1442ff4 100644
--- a/assets/js/dashboard/stats/graph/stats-export.js
+++ b/assets/js/dashboard/stats/graph/stats-export.js
@@ -34,8 +34,8 @@ export default function StatsExport() {
function renderExportLink() {
const interval = getCurrentInterval(site, query)
- const queryParams = api.serializeQuery(query, [{ interval, comparison: undefined }])
- const endpoint = `/${encodeURIComponent(site.domain)}/export${queryParams}`
+ const queryParams = api.serializeUrlParams(api.queryToSearchParams(query, [{ interval, comparison: undefined }]))
+ const endpoint = `/${encodeURIComponent(site.domain)}/export?${queryParams}`
return (
<a href={endpoint} download onClick={startExport}>
diff --git a/lib/plausible_web/plugs/feature_flag_check_plug.ex b/lib/plausible_web/plugs/feature_flag_check_plug.ex
deleted file mode 100644
index c04e23e38d..0000000000
--- a/lib/plausible_web/plugs/feature_flag_check_plug.ex
+++ /dev/null
@@ -1,31 +0,0 @@
-defmodule PlausibleWeb.Plugs.FeatureFlagCheckPlug do
- @moduledoc """
- plug(PlausibleWeb.Plugs.FeatureFlagCheckPlug, [:flag_foo, :flag_bar])
- to halt any API connections with 404 where conn.assigns.current_user or conn.assigns.site
- don't have both feature flags true.
- """
- def init(feature_flags) when is_list(feature_flags) and length(feature_flags) > 0 do
- feature_flags
- end
-
- def init(_),
- do: raise(ArgumentError, "The first argument must be a non-empty list of feature flags")
-
- def call(%Plug.Conn{} = conn, flags) do
- if validate(conn.assigns[:current_user], conn.assigns.site, flags) do
- conn
- else
- PlausibleWeb.Api.Helpers.not_found(conn, "Not found")
- end
- end
-
- defp validate(nil = _current_user, site, flags),
- do: Enum.all?(flags, fn flag -> FunWithFlags.enabled?(flag, for: site) end)
-
- defp validate(current_user, site, flags),
- do:
- Enum.all?(flags, fn flag ->
- FunWithFlags.enabled?(flag, for: current_user) ||
- FunWithFlags.enabled?(flag, for: site)
- end)
-end
diff --git a/lib/plausible_web/router.ex b/lib/plausible_web/router.ex
index 3d5e38f2bb..9738e1148e 100644
--- a/lib/plausible_web/router.ex
+++ b/lib/plausible_web/router.ex
@@ -221,10 +221,6 @@ defmodule PlausibleWeb.Router do
end
scope "/:domain/segments", PlausibleWeb.Api.Internal do
- pipeline :segments_endpoints,
- do: plug(PlausibleWeb.Plugs.FeatureFlagCheckPlug, [:saved_segments])
-
- pipe_through :segments_endpoints
get "/", SegmentsController, :index
post "/", SegmentsController, :create
get "/:segment_id", SegmentsController, :get
diff --git a/test/plausible_web/plugs/feature_flag_check_plug_test.exs b/test/plausible_web/plugs/feature_flag_check_plug_test.exs
deleted file mode 100644
index 97aaaf6bbe..0000000000
--- a/test/plausible_web/plugs/feature_flag_check_plug_test.exs
+++ /dev/null
@@ -1,46 +0,0 @@
-defmodule PlausibleWeb.Plugs.FeatureFlagCheckPlugTest do
- use PlausibleWeb.ConnCase, async: true
- use Plausible.Teams.Test
- alias PlausibleWeb.Plugs.{AuthorizeSiteAccess, FeatureFlagCheckPlug}
-
- setup [:create_user, :log_in, :create_site]
-
- test "returns 404 when any of the expected feature flags is not enabled", %{
- conn: conn,
- site: site
- } do
- # currently enabled flags are defined test/test_helper.exs
- required_flags =
- FeatureFlagCheckPlug.init([:missing_feature_flag, :channels, :saved_segments])
-
- conn =
- conn
- |> get_conn_with_current_user_and_site(site)
- |> FeatureFlagCheckPlug.call(required_flags)
-
- assert conn.halted
- assert %{"error" => "Not found"} == json_response(conn, 404)
- end
-
- test "passes conn when required flags are enabled", %{
- conn: conn,
- site: site
- } do
- # currently enabled flags are defined test/test_helper.exs
- required_flags = FeatureFlagCheckPlug.init([:channels, :saved_segments])
-
- conn =
- conn
- |> get_conn_with_current_user_and_site(site)
- |> FeatureFlagCheckPlug.call(required_flags)
-
- assert !conn.halted
- end
-
- defp get_conn_with_current_user_and_site(%Plug.Conn{} = conn, %Plausible.Site{} = site) do
- conn
- |> bypass_through(PlausibleWeb.Router)
- |> get("/plug-tests/api-basic?site=#{site.domain}")
- |> AuthorizeSiteAccess.call(AuthorizeSiteAccess.init({:all_roles, "site"}))
- end
-end