Always show direct traffic in sources reports (#2531)

* Remove show_noref behaviour

Removes query param show_noref which was used from React to control
whether to show Direct / None traffic or not. The show_noref behaviour
was untested previously.

Closes #2523

* Add changelog entry

* Fix tests

* Removed files I did not mean to check in :)
pull/2530/head
Uku Taht 4 years ago committed by GitHub
parent 8f20bf0ab2
commit a37b3433d7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -3,10 +3,13 @@ All notable changes to this project will be documented in this file.
## Unreleased
### Changed
- Always show direct traffic in sources reports plausible/analytics#2531
## v1.5.1 - 2022-12-06
### Fixed
- Fallback to empty build metadata when failing to parse $BUILD_METADATA plausible/analytics#2503
- Fallback to empty build metadata when failing to parse $BUILD_METADATA plausible/analytics#2503
## v1.5.0 - 2022-12-02

@ -3,8 +3,8 @@ import { Link, withRouter } from 'react-router-dom'
import Modal from './modal'
import * as api from '../../api'
import numberFormatter, {durationFormatter} from '../../util/number-formatter'
import {parseQuery} from '../../query'
import numberFormatter, { durationFormatter } from '../../util/number-formatter'
import { parseQuery } from '../../query'
const TITLES = {
sources: 'Top Sources',
@ -28,12 +28,12 @@ class SourcesModal extends React.Component {
}
loadSources() {
const {site} = this.props
const {query, page, sources} = this.state
const { site } = this.props
const { query, page, sources } = this.state
const detailed = this.showExtra()
api.get(`/api/stats/${encodeURIComponent(site.domain)}/${this.currentFilter()}`, query, {limit: 100, page, detailed, show_noref: true})
.then((res) => this.setState({loading: false, sources: sources.concat(res), moreResultsAvailable: res.length === 100}))
api.get(`/api/stats/${encodeURIComponent(site.domain)}/${this.currentFilter()}`, query, { limit: 100, page, detailed })
.then((res) => this.setState({ loading: false, sources: sources.concat(res), moreResultsAvailable: res.length === 100 }))
}
componentDidMount() {
@ -42,7 +42,7 @@ class SourcesModal extends React.Component {
componentDidUpdate(prevProps) {
if (this.props.location.pathname !== prevProps.location.pathname) {
this.setState({sources: [], loading: true}, this.loadSources.bind(this))
this.setState({ sources: [], loading: true }, this.loadSources.bind(this))
}
}
@ -60,11 +60,11 @@ class SourcesModal extends React.Component {
}
loadMore() {
this.setState({loading: true, page: this.state.page + 1}, this.loadSources.bind(this))
this.setState({ loading: true, page: this.state.page + 1 }, this.loadSources.bind(this))
}
formatBounceRate(page) {
if (typeof(page.bounce_rate) === 'number') {
if (typeof (page.bounce_rate) === 'number') {
return page.bounce_rate + '%'
} else {
return '-'
@ -72,7 +72,7 @@ class SourcesModal extends React.Component {
}
formatDuration(source) {
if (typeof(source.visit_duration) === 'number') {
if (typeof (source.visit_duration) === 'number') {
return durationFormatter(source.visit_duration)
} else {
return '-'
@ -103,14 +103,14 @@ class SourcesModal extends React.Component {
return (
<tr className="text-sm dark:text-gray-200" key={source.name}>
<td className="p-2">
{ this.icon(source) }
<Link className="hover:underline" to={{search: query.toString(), pathname: '/' + encodeURIComponent(this.props.site.domain)}}>{ source.name }</Link>
{this.icon(source)}
<Link className="hover:underline" to={{ search: query.toString(), pathname: '/' + encodeURIComponent(this.props.site.domain) }}>{source.name}</Link>
</td>
{this.showConversionRate() && <td className="p-2 w-32 font-medium" align="right">{numberFormatter(source.total_visitors)}</td> }
{this.showConversionRate() && <td className="p-2 w-32 font-medium" align="right">{numberFormatter(source.total_visitors)}</td>}
<td className="p-2 w-32 font-medium" align="right">{numberFormatter(source.visitors)}</td>
{this.showExtra() && <td className="p-2 w-32 font-medium" align="right">{this.formatBounceRate(source)}</td> }
{this.showExtra() && <td className="p-2 w-32 font-medium" align="right">{this.formatDuration(source)}</td> }
{this.showConversionRate() && <td className="p-2 w-32 font-medium" align="right">{source.conversion_rate}%</td> }
{this.showExtra() && <td className="p-2 w-32 font-medium" align="right">{this.formatBounceRate(source)}</td>}
{this.showExtra() && <td className="p-2 w-32 font-medium" align="right">{this.formatDuration(source)}</td>}
{this.showConversionRate() && <td className="p-2 w-32 font-medium" align="right">{source.conversion_rate}%</td>}
</tr>
)
}
@ -165,12 +165,12 @@ class SourcesModal extends React.Component {
</tr>
</thead>
<tbody>
{ this.state.sources.map(this.renderSource.bind(this)) }
{this.state.sources.map(this.renderSource.bind(this))}
</tbody>
</table>
</main>
{ this.renderLoading() }
{this.renderLoading()}
</Modal>
)
}

@ -13,7 +13,7 @@ function LinkOption(props) {
if (props.disabled) {
return <span {...props}>{props.children}</span>
} else {
props = Object.assign({}, props, {className: props.className + ' hover:underline'})
props = Object.assign({}, props, { className: props.className + ' hover:underline' })
return <Link {...props}>{props.children}</Link>
}
}
@ -21,7 +21,7 @@ function LinkOption(props) {
export default class Referrers extends React.Component {
constructor(props) {
super(props)
this.state = {loading: true}
this.state = { loading: true }
this.onVisible = this.onVisible.bind(this)
}
@ -32,30 +32,26 @@ export default class Referrers extends React.Component {
componentDidUpdate(prevProps) {
if (this.props.query !== prevProps.query) {
this.setState({loading: true, referrers: null})
this.setState({ loading: true, referrers: null })
this.fetchReferrers()
}
}
showNoRef() {
return this.props.query.period === 'realtime'
}
showConversionRate() {
return !!this.props.query.filters.goal
}
fetchReferrers() {
if (this.props.query.filters.source) {
api.get(`/api/stats/${encodeURIComponent(this.props.site.domain)}/referrers/${encodeURIComponent(this.props.query.filters.source)}`, this.props.query, {show_noref: this.showNoRef()})
api.get(`/api/stats/${encodeURIComponent(this.props.site.domain)}/referrers/${encodeURIComponent(this.props.query.filters.source)}`, this.props.query)
.then((res) => res.search_terms || res.referrers)
.then((referrers) => this.setState({loading: false, referrers: referrers}))
.then((referrers) => this.setState({ loading: false, referrers: referrers }))
} else if (this.props.query.filters.goal) {
api.get(`/api/stats/${encodeURIComponent(this.props.site.domain)}/goal/referrers`, this.props.query)
.then((res) => this.setState({loading: false, referrers: res}))
.then((res) => this.setState({ loading: false, referrers: res }))
} else {
api.get(`/api/stats/${encodeURIComponent(this.props.site.domain)}/referrers`, this.props.query, {show_noref: this.showNoRef()})
.then((res) => this.setState({loading: false, referrers: res}))
api.get(`/api/stats/${encodeURIComponent(this.props.site.domain)}/referrers`, this.props.query)
.then((res) => this.setState({ loading: false, referrers: res }))
}
}
@ -71,7 +67,7 @@ export default class Referrers extends React.Component {
}
renderReferrer(referrer) {
const maxWidthDeduction = this.showConversionRate() ? "10rem" : "5rem"
const maxWidthDeduction = this.showConversionRate() ? "10rem" : "5rem"
const query = new URLSearchParams(window.location.search)
query.set('referrer', referrer.name)
@ -86,7 +82,7 @@ export default class Referrers extends React.Component {
<span className="flex px-2 py-1.5 z-9 relative break-all group">
<LinkOption
className="block md:truncate dark:text-gray-300"
to={{search: query.toString()}}
to={{ search: query.toString() }}
disabled={referrer.name === 'Direct / None'}
>
<img
@ -94,9 +90,9 @@ export default class Referrers extends React.Component {
referrerPolicy="no-referrer"
className="inline w-4 h-4 mr-2 -mt-px align-middle"
/>
{ referrer.name }
{referrer.name}
</LinkOption>
{ this.renderExternalLink(referrer) }
{this.renderExternalLink(referrer)}
</span>
</Bar>
<span className="font-medium dark:text-gray-200">{numberFormatter(referrer.visitors)}</span>
@ -151,7 +147,7 @@ export default class Referrers extends React.Component {
if (this.state.referrers) {
return (
<React.Fragment>
{ this.renderList() }
{this.renderList()}
<MoreLink site={this.props.site} list={this.state.referrers} endpoint={`referrers/${this.props.query.filters.source}`} />
</React.Fragment>
)
@ -165,9 +161,9 @@ export default class Referrers extends React.Component {
>
<LazyLoader onVisible={this.onVisible} className="flex flex-col flex-grow">
<h3 className="font-bold dark:text-gray-100">Top Referrers</h3>
{ this.state.loading && <div className="mx-auto loading mt-44"><div></div></div> }
{this.state.loading && <div className="mx-auto loading mt-44"><div></div></div>}
<FadeIn show={!this.state.loading}>
{ this.renderContent() }
{this.renderContent()}
</FadeIn>
</LazyLoader>
</div>

@ -30,16 +30,12 @@ class AllSources extends React.Component {
}
}
showNoRef() {
return this.props.query.period === 'realtime'
}
showConversionRate() {
return !!this.props.query.filters.goal
}
fetchReferrers() {
api.get(`/api/stats/${encodeURIComponent(this.props.site.domain)}/sources`, this.props.query, { show_noref: this.showNoRef() })
api.get(`/api/stats/${encodeURIComponent(this.props.site.domain)}/sources`, this.props.query)
.then((res) => this.setState({ loading: false, referrers: res }))
}
@ -173,7 +169,7 @@ class UTMSources extends React.Component {
fetchReferrers() {
const endpoint = UTM_TAGS[this.props.tab].endpoint
api.get(`/api/stats/${encodeURIComponent(this.props.site.domain)}/${endpoint}`, this.props.query, { show_noref: this.showNoRef() })
api.get(`/api/stats/${encodeURIComponent(this.props.site.domain)}/${endpoint}`, this.props.query)
.then((res) => this.setState({ loading: false, referrers: res }))
}

@ -371,7 +371,6 @@ defmodule PlausibleWeb.Api.StatsController do
query =
Query.from(site, params)
|> Filters.add_prefix()
|> maybe_hide_noref("visit:source", params)
pagination = parse_pagination(params)
@ -402,7 +401,6 @@ defmodule PlausibleWeb.Api.StatsController do
query =
Query.from(site, params)
|> Filters.add_prefix()
|> maybe_hide_noref("visit:utm_medium", params)
pagination = parse_pagination(params)
@ -432,7 +430,6 @@ defmodule PlausibleWeb.Api.StatsController do
query =
Query.from(site, params)
|> Filters.add_prefix()
|> maybe_hide_noref("visit:utm_campaign", params)
pagination = parse_pagination(params)
@ -462,7 +459,6 @@ defmodule PlausibleWeb.Api.StatsController do
query =
Query.from(site, params)
|> Filters.add_prefix()
|> maybe_hide_noref("visit:utm_content", params)
pagination = parse_pagination(params)
metrics = [:visitors, :bounce_rate, :visit_duration]
@ -491,7 +487,6 @@ defmodule PlausibleWeb.Api.StatsController do
query =
Query.from(site, params)
|> Filters.add_prefix()
|> maybe_hide_noref("visit:utm_term", params)
pagination = parse_pagination(params)
metrics = [:visitors, :bounce_rate, :visit_duration]
@ -520,7 +515,6 @@ defmodule PlausibleWeb.Api.StatsController do
query =
Query.from(site, params)
|> Filters.add_prefix()
|> maybe_hide_noref("visit:utm_source", params)
pagination = parse_pagination(params)
@ -1108,17 +1102,6 @@ defmodule PlausibleWeb.Api.StatsController do
end
end
defp maybe_hide_noref(query, property, params) do
cond do
is_nil(query.filters[property]) and params["show_noref"] != "true" ->
new_filters = Map.put(query.filters, property, {:is_not, "Direct / None"})
%Query{query | filters: new_filters}
true ->
query
end
end
defp add_cr(list, list_without_goals, key_name) do
Enum.map(list, fn item ->
without_goal = Enum.find(list_without_goals, fn s -> s[key_name] === item[key_name] end)

@ -236,6 +236,7 @@ defmodule Plausible.ImportedTest do
assert conn |> json_response(200) |> Enum.sort() == [
%{"name" => "A Nice Newsletter", "visitors" => 1},
%{"name" => "Direct / None", "visitors" => 1},
%{"name" => "DuckDuckGo", "visitors" => 2},
%{"name" => "Google", "visitors" => 4},
%{"name" => "Twitter", "visitors" => 1}
@ -305,6 +306,12 @@ defmodule Plausible.ImportedTest do
"name" => "social",
"visit_duration" => 20,
"visitors" => 3
},
%{
"bounce_rate" => 100.0,
"name" => "Direct / None",
"visit_duration" => 60.0,
"visitors" => 1
}
]
end
@ -388,6 +395,12 @@ defmodule Plausible.ImportedTest do
"visitors" => 2,
"bounce_rate" => 100.0,
"visit_duration" => 50.0
},
%{
"bounce_rate" => 0.0,
"name" => "Direct / None",
"visit_duration" => 100.0,
"visitors" => 1
}
]
end
@ -472,6 +485,12 @@ defmodule Plausible.ImportedTest do
"visitors" => 2,
"bounce_rate" => 100.0,
"visit_duration" => 50.0
},
%{
"bounce_rate" => 0.0,
"name" => "Direct / None",
"visit_duration" => 100.0,
"visitors" => 1
}
]
end
@ -555,6 +574,12 @@ defmodule Plausible.ImportedTest do
"visitors" => 2,
"bounce_rate" => 100.0,
"visit_duration" => 50.0
},
%{
"bounce_rate" => 0.0,
"name" => "Direct / None",
"visit_duration" => 100.0,
"visitors" => 1
}
]
end

@ -1 +1,2 @@
name,conversions,conversion_rate
Direct / None,1,33.3

1 name conversions conversion_rate
2 Direct / None 1 33.3

@ -1 +1,2 @@
name,conversions,conversion_rate
Direct / None,1,33.3

1 name conversions conversion_rate
2 Direct / None 1 33.3

@ -1 +1,2 @@
name,conversions,conversion_rate
Direct / None,1,33.3

1 name conversions conversion_rate
2 Direct / None 1 33.3

@ -1 +1,2 @@
name,conversions,conversion_rate
Direct / None,1,33.3

1 name conversions conversion_rate
2 Direct / None 1 33.3

@ -1 +1,2 @@
name,conversions,conversion_rate
Direct / None,1,33.3

1 name conversions conversion_rate
2 Direct / None 1 33.3

@ -1 +1,2 @@
name,conversions,conversion_rate
Direct / None,1,33.3

1 name conversions conversion_rate
2 Direct / None 1 33.3

@ -1,2 +1,3 @@
name,visitors,bounce_rate,visit_duration
Direct / None,3,100,0
Google,1,0,60

1 name visitors bounce_rate visit_duration
2 Direct / None 3 100 0
3 Google 1 0 60

@ -1,2 +1,3 @@
name,visitors,bounce_rate,visit_duration
Direct / None,3,67,20
ads,1,100,0

1 name visitors bounce_rate visit_duration
2 Direct / None 3 67 20
3 ads 1 100 0

@ -1,2 +1,3 @@
name,visitors,bounce_rate,visit_duration
Direct / None,3,67,20
content,1,100,0

1 name visitors bounce_rate visit_duration
2 Direct / None 3 67 20
3 content 1 100 0

@ -1,2 +1,3 @@
name,visitors,bounce_rate,visit_duration
Direct / None,3,67,20
search,1,100,0

1 name visitors bounce_rate visit_duration
2 Direct / None 3 67 20
3 search 1 100 0

@ -1,2 +1,3 @@
name,visitors,bounce_rate,visit_duration
Direct / None,3,67,20
google,1,100,0

1 name visitors bounce_rate visit_duration
2 Direct / None 3 67 20
3 google 1 100 0

@ -1,2 +1,3 @@
name,visitors,bounce_rate,visit_duration
Direct / None,3,67,20
term,1,100,0

1 name visitors bounce_rate visit_duration
2 Direct / None 3 67 20
3 term 1 100 0

@ -1,2 +1,3 @@
name,visitors,bounce_rate,visit_duration
Direct / None,3,100,0
Google,2,50,30

1 name visitors bounce_rate visit_duration
2 Direct / None 3 100 0
3 Google 2 50 30

@ -1,2 +1,3 @@
name,visitors,bounce_rate,visit_duration
Direct / None,3,67,20
ads,2,100,0

1 name visitors bounce_rate visit_duration
2 Direct / None 3 67 20
3 ads 2 100 0

@ -1,2 +1,3 @@
name,visitors,bounce_rate,visit_duration
Direct / None,4,75,15
content,1,100,0

1 name visitors bounce_rate visit_duration
2 Direct / None 4 75 15
3 content 1 100 0

@ -1,2 +1,3 @@
name,visitors,bounce_rate,visit_duration
Direct / None,4,75,15
search,1,100,0

1 name visitors bounce_rate visit_duration
2 Direct / None 4 75 15
3 search 1 100 0

@ -1,2 +1,3 @@
name,visitors,bounce_rate,visit_duration
Direct / None,4,75,15
google,1,100,0

1 name visitors bounce_rate visit_duration
2 Direct / None 4 75 15
3 google 1 100 0

@ -1,2 +1,3 @@
name,visitors,bounce_rate,visit_duration
Direct / None,4,75,15
term,1,100,0

1 name visitors bounce_rate visit_duration
2 Direct / None 4 75 15
3 term 1 100 0

@ -16,17 +16,27 @@ defmodule PlausibleWeb.Api.StatsController.SourcesTest do
referrer_source: "Google",
referrer: "google.com"
),
build(:pageview,
referrer_source: "Google",
referrer: "google.com"
),
build(:pageview,
referrer_source: "DuckDuckGo",
referrer: "duckduckgo.com"
)
),
build(:pageview,
referrer_source: "DuckDuckGo",
referrer: "duckduckgo.com"
),
build(:pageview)
])
conn = get(conn, "/api/stats/#{site.domain}/sources")
assert json_response(conn, 200) == [
%{"name" => "Google", "visitors" => 2},
%{"name" => "DuckDuckGo", "visitors" => 1}
%{"name" => "Google", "visitors" => 3},
%{"name" => "DuckDuckGo", "visitors" => 2},
%{"name" => "Direct / None", "visitors" => 1}
]
end

Loading…
Cancel
Save