Compare commits

...

6 Commits

Author SHA1 Message Date
Uku Taht 959b2d5e7a Remove ListReport conditional render 4 years ago
Adam Rutkowski 2ff76dea8b Add changelog entry 4 years ago
Adam Rutkowski cdd8545ffb Add extra tests for returning/filtering by '(not set)' 4 years ago
Adam Rutkowski 30d0df345a Update expectations for export tests 4 years ago
Adam Rutkowski 7859a73f4c Support '(not set)' in breakdown/filters 4 years ago
Adam Rutkowski 90621331c6 Make Device section components aware of (not set)
So that no extra sub-filters are possible when the unset
top item is selected.
4 years ago

@ -7,6 +7,7 @@ All notable changes to this project will be documented in this file.
- 'Last updated X seconds ago' info to 'current visitors' tooltips - 'Last updated X seconds ago' info to 'current visitors' tooltips
### Fixed ### Fixed
- Empty values for Screen Size, OS and Browser are uniformly replaced with "(not set)"
- Fix [more pageviews with session prop filter than with no filters](https://github.com/plausible/analytics/issues/1666) - Fix [more pageviews with session prop filter than with no filters](https://github.com/plausible/analytics/issues/1666)
- Cascade delete sent_renewal_notifications table when user is deleted plausible/analytics#2549 - Cascade delete sent_renewal_notifications table when user is deleted plausible/analytics#2549
- Show appropriate top-stat metric labels on the realtime dashboard when filtering by a goal - Show appropriate top-stat metric labels on the realtime dashboard when filtering by a goal

@ -50,11 +50,11 @@ function filterText(key, rawValue, query) {
return <>{eventName}.{metaKey} {toFilterType(metaValue)} <b>{valueWithoutPrefix(metaValue)}</b></> return <>{eventName}.{metaKey} {toFilterType(metaValue)} <b>{valueWithoutPrefix(metaValue)}</b></>
} }
if (key === "browser_version") { if (key === "browser_version") {
const browserName = query.filters.browser ? query.filters.browser : 'Browser' const browserName = query.filters.browser === '(not set)' ? 'Browser' : query.filters.browser
return <>{browserName}.Version {type} <b>{value}</b></> return <>{browserName}.Version {type} <b>{value}</b></>
} }
if (key === "os_version") { if (key === "os_version") {
const osName = query.filters.os ? query.filters.os : 'OS' const osName = query.filters.os === '(not set)' ? 'OS' : query.filters.os
return <>{osName}.Version {type} <b>{value}</b></> return <>{osName}.Version {type} <b>{value}</b></>
} }
if (key === "country") { if (key === "country") {

@ -5,7 +5,7 @@ import ListReport from '../reports/list'
import * as api from '../../api' import * as api from '../../api'
import * as url from '../../util/url' import * as url from '../../util/url'
function Browsers({query, site}) { function Browsers({ query, site }) {
function fetchData() { function fetchData() {
return api.get(url.apiPath(site, '/browsers'), query) return api.get(url.apiPath(site, '/browsers'), query)
} }
@ -13,29 +13,32 @@ function Browsers({query, site}) {
return ( return (
<ListReport <ListReport
fetchData={fetchData} fetchData={fetchData}
filter={{browser: 'name'}} filter={{ browser: 'name' }}
keyLabel="Browser" keyLabel="Browser"
query={query} query={query}
/> />
) )
} }
function BrowserVersions({query, site}) { function BrowserVersions({ query, site }) {
function fetchData() { function fetchData() {
return api.get(url.apiPath(site, '/browser-versions'), query) return api.get(url.apiPath(site, '/browser-versions'), query)
} }
const browserName = query.filters.browser === '(not set)' ? 'Browser' : query.filters.browser
return ( return (
<ListReport <ListReport
fetchData={fetchData} fetchData={fetchData}
filter={{browser_version: 'name'}} filter={{ browser_version: 'name' }}
keyLabel={query.filters.browser + ' version'} keyLabel={browserName + ' version'}
query={query} query={query}
/> />
) )
} }
function OperatingSystems({query, site}) { function OperatingSystems({ query, site }) {
function fetchData() { function fetchData() {
return api.get(url.apiPath(site, '/operating-systems'), query) return api.get(url.apiPath(site, '/operating-systems'), query)
} }
@ -43,29 +46,32 @@ function OperatingSystems({query, site}) {
return ( return (
<ListReport <ListReport
fetchData={fetchData} fetchData={fetchData}
filter={{os: 'name'}} filter={{ os: 'name' }}
keyLabel="Operating system" keyLabel="Operating system"
query={query} query={query}
/> />
) )
} }
function OperatingSystemVersions({query, site}) { function OperatingSystemVersions({ query, site }) {
function fetchData() { function fetchData() {
return api.get(url.apiPath(site, '/operating-system-versions'), query) return api.get(url.apiPath(site, '/operating-system-versions'), query)
} }
const osName = query.filters.os === '(not set)' ? 'Operating System' : query.filters.os
return ( return (
<ListReport <ListReport
fetchData={fetchData} fetchData={fetchData}
filter={{os_version: 'name'}} filter={{ os_version: 'name' }}
keyLabel={query.filters.os + ' version'} keyLabel={osName + ' version'}
query={query} query={query}
/> />
) )
} }
function ScreenSizes({query, site}) { function ScreenSizes({ query, site }) {
function fetchData() { function fetchData() {
return api.get(url.apiPath(site, '/screen-sizes'), query) return api.get(url.apiPath(site, '/screen-sizes'), query)
} }
@ -81,7 +87,7 @@ function ScreenSizes({query, site}) {
return ( return (
<ListReport <ListReport
fetchData={fetchData} fetchData={fetchData}
filter={{screen: 'name'}} filter={{ screen: 'name' }}
keyLabel="Screen size" keyLabel="Screen size"
query={query} query={query}
renderIcon={renderIcon} renderIcon={renderIcon}
@ -100,38 +106,39 @@ const EXPLANATION = {
function iconFor(screenSize) { function iconFor(screenSize) {
if (screenSize === 'Mobile') { if (screenSize === 'Mobile') {
return ( return (
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" strokeWidth="2" strokeLinecap="round" strokeLinejoin="round" className="-mt-px feather"><rect x="5" y="2" width="14" height="20" rx="2" ry="2"/><line x1="12" y1="18" x2="12" y2="18"/></svg> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" strokeWidth="2" strokeLinecap="round" strokeLinejoin="round" className="-mt-px feather"><rect x="5" y="2" width="14" height="20" rx="2" ry="2" /><line x1="12" y1="18" x2="12" y2="18" /></svg>
) )
} else if (screenSize === 'Tablet') { } else if (screenSize === 'Tablet') {
return ( return (
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" strokeWidth="2" strokeLinecap="round" strokeLinejoin="round" className="-mt-px feather"><rect x="4" y="2" width="16" height="20" rx="2" ry="2" transform="rotate(180 12 12)"/><line x1="12" y1="18" x2="12" y2="18"/></svg> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" strokeWidth="2" strokeLinecap="round" strokeLinejoin="round" className="-mt-px feather"><rect x="4" y="2" width="16" height="20" rx="2" ry="2" transform="rotate(180 12 12)" /><line x1="12" y1="18" x2="12" y2="18" /></svg>
) )
} else if (screenSize === 'Laptop') { } else if (screenSize === 'Laptop') {
return ( return (
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" strokeWidth="2" strokeLinecap="round" strokeLinejoin="round" className="-mt-px feather"><rect x="2" y="3" width="20" height="14" rx="2" ry="2"/><line x1="2" y1="20" x2="22" y2="20"/></svg> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" strokeWidth="2" strokeLinecap="round" strokeLinejoin="round" className="-mt-px feather"><rect x="2" y="3" width="20" height="14" rx="2" ry="2" /><line x1="2" y1="20" x2="22" y2="20" /></svg>
) )
} else if (screenSize === 'Desktop') { } else if (screenSize === 'Desktop') {
return ( return (
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" strokeWidth="2" strokeLinecap="round" strokeLinejoin="round" className="-mt-px feather"><rect x="2" y="3" width="20" height="14" rx="2" ry="2"/><line x1="8" y1="21" x2="16" y2="21"/><line x1="12" y1="17" x2="12" y2="21"/></svg> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" strokeWidth="2" strokeLinecap="round" strokeLinejoin="round" className="-mt-px feather"><rect x="2" y="3" width="20" height="14" rx="2" ry="2" /><line x1="8" y1="21" x2="16" y2="21" /><line x1="12" y1="17" x2="12" y2="21" /></svg>
) )
} else if (screenSize === '(not set)') {
return null
} }
} }
export default class Devices extends React.Component { export default class Devices extends React.Component {
constructor(props) { constructor(props) {
super(props) super(props)
this.tabKey = `deviceTab__${ props.site.domain}` this.tabKey = `deviceTab__${props.site.domain}`
const storedTab = storage.getItem(this.tabKey) const storedTab = storage.getItem(this.tabKey)
this.state = { this.state = {
mode: storedTab || 'size' mode: storedTab || 'size'
} }
} }
setMode(mode) { setMode(mode) {
return () => { return () => {
storage.setItem(this.tabKey, mode) storage.setItem(this.tabKey, mode)
this.setState({mode}) this.setState({ mode })
} }
} }
@ -189,12 +196,12 @@ export default class Devices extends React.Component {
<div className="flex justify-between w-full"> <div className="flex justify-between w-full">
<h3 className="font-bold dark:text-gray-100">Devices</h3> <h3 className="font-bold dark:text-gray-100">Devices</h3>
<div className="flex text-xs font-medium text-gray-500 dark:text-gray-400 space-x-2"> <div className="flex text-xs font-medium text-gray-500 dark:text-gray-400 space-x-2">
{ this.renderPill('Size', 'size') } {this.renderPill('Size', 'size')}
{ this.renderPill('Browser', 'browser') } {this.renderPill('Browser', 'browser')}
{ this.renderPill('OS', 'os') } {this.renderPill('OS', 'os')}
</div> </div>
</div> </div>
{ this.renderContent() } {this.renderContent()}
</div> </div>
</div> </div>
) )

@ -6,6 +6,7 @@ defmodule Plausible.Stats.Base do
# Ecto typespec has not been updated for this PR: https://github.com/elixir-ecto/ecto/pull/3592 # Ecto typespec has not been updated for this PR: https://github.com/elixir-ecto/ecto/pull/3592
@dialyzer {:nowarn_function, add_sample_hint: 2} @dialyzer {:nowarn_function, add_sample_hint: 2}
@no_ref "Direct / None" @no_ref "Direct / None"
@not_set "(not set)"
def base_event_query(site, query) do def base_event_query(site, query) do
events_q = query_events(site, query) events_q = query_events(site, query)
@ -391,6 +392,7 @@ defmodule Plausible.Stats.Base do
defp db_prop_val(:utm_campaign, @no_ref), do: "" defp db_prop_val(:utm_campaign, @no_ref), do: ""
defp db_prop_val(:utm_content, @no_ref), do: "" defp db_prop_val(:utm_content, @no_ref), do: ""
defp db_prop_val(:utm_term, @no_ref), do: "" defp db_prop_val(:utm_term, @no_ref), do: ""
defp db_prop_val(_, @not_set), do: ""
defp db_prop_val(_, val), do: val defp db_prop_val(_, val), do: val
def utc_boundaries(%Query{period: "realtime"}, _timezone) do def utc_boundaries(%Query{period: "realtime"}, _timezone) do

@ -5,6 +5,7 @@ defmodule Plausible.Stats.Breakdown do
alias Plausible.Stats.Query alias Plausible.Stats.Query
alias Plausible.Goals alias Plausible.Goals
@no_ref "Direct / None" @no_ref "Direct / None"
@not_set "(not set)"
@event_metrics [:visitors, :pageviews, :events] @event_metrics [:visitors, :pageviews, :events]
@session_metrics [:visits, :bounce_rate, :visit_duration] @session_metrics [:visits, :bounce_rate, :visit_duration]
@ -512,7 +513,9 @@ defmodule Plausible.Stats.Breakdown do
from( from(
s in q, s in q,
group_by: s.screen_size, group_by: s.screen_size,
select_merge: %{device: s.screen_size}, select_merge: %{
device: fragment("if(empty(?), ?, ?)", s.screen_size, @not_set, s.screen_size)
},
order_by: {:asc, s.screen_size} order_by: {:asc, s.screen_size}
) )
end end
@ -521,7 +524,10 @@ defmodule Plausible.Stats.Breakdown do
from( from(
s in q, s in q,
group_by: s.operating_system, group_by: s.operating_system,
select_merge: %{operating_system: s.operating_system}, select_merge: %{
operating_system:
fragment("if(empty(?), ?, ?)", s.operating_system, @not_set, s.operating_system)
},
order_by: {:asc, s.operating_system} order_by: {:asc, s.operating_system}
) )
end end
@ -530,7 +536,15 @@ defmodule Plausible.Stats.Breakdown do
from( from(
s in q, s in q,
group_by: s.operating_system_version, group_by: s.operating_system_version,
select_merge: %{os_version: s.operating_system_version}, select_merge: %{
os_version:
fragment(
"if(empty(?), ?, ?)",
s.operating_system_version,
@not_set,
s.operating_system_version
)
},
order_by: {:asc, s.operating_system_version} order_by: {:asc, s.operating_system_version}
) )
end end
@ -539,7 +553,9 @@ defmodule Plausible.Stats.Breakdown do
from( from(
s in q, s in q,
group_by: s.browser, group_by: s.browser,
select_merge: %{browser: s.browser}, select_merge: %{
browser: fragment("if(empty(?), ?, ?)", s.browser, @not_set, s.browser)
},
order_by: {:asc, s.browser} order_by: {:asc, s.browser}
) )
end end
@ -548,7 +564,10 @@ defmodule Plausible.Stats.Breakdown do
from( from(
s in q, s in q,
group_by: s.browser_version, group_by: s.browser_version,
select_merge: %{browser_version: s.browser_version}, select_merge: %{
browser_version:
fragment("if(empty(?), ?, ?)", s.browser_version, @not_set, s.browser_version)
},
order_by: {:asc, s.browser_version} order_by: {:asc, s.browser_version}
) )
end end

@ -1,2 +1,2 @@
name,conversions,conversion_rate name,conversions,conversion_rate
,1,50.0 (not set),1,50.0

1 name conversions conversion_rate
2 (not set) 1 50.0

@ -1,2 +1,2 @@
name,conversions,conversion_rate name,conversions,conversion_rate
,1,25.0 (not set),1,25.0

1 name conversions conversion_rate
2 (not set) 1 25.0

@ -1,2 +1,2 @@
name,conversions,conversion_rate name,conversions,conversion_rate
,1,25.0 (not set),1,25.0

1 name conversions conversion_rate
2 (not set) 1 25.0

@ -1,2 +1,2 @@
name,visitors name,visitors
,1 (not set),1

1 name visitors
2 (not set) 1

@ -1,2 +1,2 @@
name,visitors name,visitors
,1 (not set),1

1 name visitors
2 (not set) 1

@ -1,2 +1,2 @@
name,visitors name,visitors
,1 (not set),1

1 name visitors
2 (not set) 1

@ -1,3 +1,3 @@
name,visitors name,visitors
ABrowserName,2 ABrowserName,2
,2 (not set),2

1 name visitors
2 ABrowserName 2
3 (not set) 2

@ -1,2 +1,2 @@
name,visitors name,visitors
,4 (not set),4

1 name visitors
2 (not set) 4

@ -1,2 +1,2 @@
name,visitors name,visitors
,4 (not set),4

1 name visitors
2 (not set) 4

@ -1,3 +1,3 @@
name,visitors name,visitors
ABrowserName,3 ABrowserName,3
,2 (not set),2

1 name visitors
2 ABrowserName 3
3 (not set) 2

@ -1,2 +1,2 @@
name,visitors name,visitors
,5 (not set),5

1 name visitors
2 (not set) 5

@ -1,2 +1,2 @@
name,visitors name,visitors
,5 (not set),5

1 name visitors
2 (not set) 5

@ -129,6 +129,21 @@ defmodule PlausibleWeb.Api.StatsController.BrowsersTest do
%{"name" => "Firefox", "visitors" => 1, "percentage" => 33} %{"name" => "Firefox", "visitors" => 1, "percentage" => 33}
] ]
end end
test "returns (not set) when appropriate", %{conn: conn, site: site} do
populate_stats(site, [
build(:pageview,
user_id: 123,
browser: ""
)
])
conn = get(conn, "/api/stats/#{site.domain}/browsers?period=day")
assert json_response(conn, 200) == [
%{"name" => "(not set)", "visitors" => 1, "percentage" => 100}
]
end
end end
describe "GET /api/stats/:domain/browser-versions" do describe "GET /api/stats/:domain/browser-versions" do
@ -155,5 +170,23 @@ defmodule PlausibleWeb.Api.StatsController.BrowsersTest do
%{"name" => "77.0", "visitors" => 1, "percentage" => 33} %{"name" => "77.0", "visitors" => 1, "percentage" => 33}
] ]
end end
test "returns results for (not set)", %{conn: conn, site: site} do
populate_stats(site, [
build(:pageview, browser: "", browser_version: "")
])
filters = Jason.encode!(%{browser: "(not set)"})
conn =
get(
conn,
"/api/stats/#{site.domain}/browser-versions?period=day&filters=#{filters}"
)
assert json_response(conn, 200) == [
%{"name" => "(not set)", "visitors" => 1, "percentage" => 100}
]
end
end end
end end

@ -19,6 +19,33 @@ defmodule PlausibleWeb.Api.StatsController.OperatingSystemsTest do
] ]
end end
test "returns (not set) when appropriate", %{conn: conn, site: site} do
populate_stats(site, [
build(:pageview,
operating_system: ""
),
build(:pageview,
operating_system: "Linux"
)
])
conn = get(conn, "/api/stats/#{site.domain}/operating-systems?period=day")
assert json_response(conn, 200) == [
%{"name" => "(not set)", "visitors" => 1, "percentage" => 50},
%{"name" => "Linux", "visitors" => 1, "percentage" => 50}
]
filters = Jason.encode!(%{os: "(not set)"})
conn =
get(conn, "/api/stats/#{site.domain}/operating-systems?period=day&filters=#{filters}")
assert json_response(conn, 200) == [
%{"name" => "(not set)", "visitors" => 1, "percentage" => 100}
]
end
test "calculates conversion_rate when filtering for goal", %{conn: conn, site: site} do test "calculates conversion_rate when filtering for goal", %{conn: conn, site: site} do
populate_stats(site, [ populate_stats(site, [
build(:pageview, user_id: 1, operating_system: "Mac"), build(:pageview, user_id: 1, operating_system: "Mac"),

@ -19,6 +19,33 @@ defmodule PlausibleWeb.Api.StatsController.ScreenSizesTest do
] ]
end end
test "returns (not set) when appropriate", %{conn: conn, site: site} do
populate_stats(site, [
build(:pageview,
screen_size: ""
),
build(:pageview,
screen_size: "Desktop"
)
])
conn = get(conn, "/api/stats/#{site.domain}/screen-sizes?period=day")
assert json_response(conn, 200) == [
%{"name" => "(not set)", "visitors" => 1, "percentage" => 50},
%{"name" => "Desktop", "visitors" => 1, "percentage" => 50}
]
conn = get(conn, "/api/stats/#{site.domain}/screen-sizes?period=day")
filters = Jason.encode!(%{screen: "(not set)"})
conn = get(conn, "/api/stats/#{site.domain}/screen-sizes?period=day&filters=#{filters}")
assert json_response(conn, 200) == [
%{"name" => "(not set)", "visitors" => 1, "percentage" => 100}
]
end
test "returns screen sizes with :is filter on custom pageview props", %{ test "returns screen sizes with :is filter on custom pageview props", %{
conn: conn, conn: conn,
site: site site: site

Loading…
Cancel
Save