From 232bdd34a18e8de0901cab4307c99b0a4c937089 Mon Sep 17 00:00:00 2001
From: RobertJoonas <56999674+RobertJoonas@users.noreply.github.com>
Date: Tue, 1 Aug 2023 19:33:53 +0100
Subject: [PATCH] Conversions listreport (#3215)
* rename conversions.js to deprecated-conversions.js
* add a new Conversions component and switch by props FF
* add a Details view to the new Conversions component
* allow querying conversions with pagination
...and keep the current behaviour for DeprecatedConversions, always returning
page=1 and limit=100
* hide some columns on mobile
* prevent ListReport first column header overflow
---
assets/js/dashboard/router.js | 4 +
.../dashboard/stats/behaviours/conversions.js | 144 ++++--------------
.../behaviours/deprecated-conversions.js | 119 +++++++++++++++
assets/js/dashboard/stats/behaviours/index.js | 9 +-
.../js/dashboard/stats/modals/conversions.js | 117 ++++++++++++++
assets/js/dashboard/stats/reports/list.js | 2 +-
.../controllers/api/stats_controller.ex | 3 +-
7 files changed, 282 insertions(+), 116 deletions(-)
create mode 100644 assets/js/dashboard/stats/behaviours/deprecated-conversions.js
create mode 100644 assets/js/dashboard/stats/modals/conversions.js
diff --git a/assets/js/dashboard/router.js b/assets/js/dashboard/router.js
index c74f445d8..a7a9bc22b 100644
--- a/assets/js/dashboard/router.js
+++ b/assets/js/dashboard/router.js
@@ -10,6 +10,7 @@ import EntryPagesModal from './stats/modals/entry-pages'
import ExitPagesModal from './stats/modals/exit-pages'
import ModalTable from './stats/modals/table'
import PropsModal from './stats/modals/props'
+import ConversionsModal from './stats/modals/conversions'
import FilterModal from './stats/modals/filter-modal'
import * as url from './util/url';
@@ -62,6 +63,9 @@ export default function Router({site, loggedIn, currentUserRole}) {
+
+
+
diff --git a/assets/js/dashboard/stats/behaviours/conversions.js b/assets/js/dashboard/stats/behaviours/conversions.js
index 19f2706a5..4013da31e 100644
--- a/assets/js/dashboard/stats/behaviours/conversions.js
+++ b/assets/js/dashboard/stats/behaviours/conversions.js
@@ -1,119 +1,37 @@
import React from 'react';
-import { Link } from 'react-router-dom'
-import FlipMove from 'react-flip-move'
-
-import Bar from '../bar'
-import PropBreakdown from './prop-breakdown'
-import numberFormatter from '../../util/number-formatter'
import * as api from '../../api'
import * as url from '../../util/url'
import { escapeFilterValue } from '../../util/filters'
-import LazyLoader from '../../components/lazy-loader'
-import Money from './money'
-
-export default class Conversions extends React.Component {
- constructor(props) {
- super(props)
- this.htmlNode = React.createRef()
- this.state = { loading: true, }
- this.onVisible = this.onVisible.bind(this)
- this.fetchConversions = this.fetchConversions.bind(this)
- }
-
- componentWillUnmount() {
- document.removeEventListener('tick', this.fetchConversions)
- }
-
- onVisible() {
- this.fetchConversions()
- if (this.props.query.period === 'realtime') {
- document.addEventListener('tick', this.fetchConversions)
- }
- }
-
- componentDidUpdate(prevProps) {
- if (this.props.query !== prevProps.query) {
- const height = this.htmlNode.current.offsetHeight
- this.setState({ loading: true, goals: null, prevHeight: height })
- this.fetchConversions()
- }
- }
-
- fetchConversions() {
- api.get(`/api/stats/${encodeURIComponent(this.props.site.domain)}/conversions`, this.props.query)
- .then((res) => this.setState({ loading: false, goals: res, prevHeight: null }))
- }
-
- renderGoal(goal, renderRevenueColumn) {
- const renderProps = this.props.query.filters['goal'] == goal.name && goal.prop_names
-
- return (
-
-
-
-
- {goal.name}
-
-
-
- {numberFormatter(goal.visitors)}
- {numberFormatter(goal.events)}
- {goal.conversion_rate}%
- {renderRevenueColumn && }
- {renderRevenueColumn && }
-
-
- { renderProps &&
}
-
- )
- }
-
- renderInner() {
- if (this.state.loading) {
- return
- } else if (this.state.goals) {
- const hasRevenue = this.state.goals.some((goal) => goal.total_revenue)
- return (
-
-
-
Goal
-
- Uniques
- Total
- CR
- {hasRevenue && Revenue}
- {hasRevenue && Average}
-
-
-
- { this.state.goals.map((goal) => this.renderGoal.bind(this)(goal, hasRevenue) ) }
-
-
- )
- }
- }
-
- renderConversions() {
- return (
-
-
- {this.renderInner()}
-
-
- )
- }
-
- render() {
- return (
-
- {this.renderConversions()}
-
- )
- }
+import { CR_METRIC } from '../reports/metrics';
+import ListReport from '../reports/list';
+
+export default function Conversions(props) {
+ const {site, query} = props
+
+ function fetchConversions() {
+ return api.get(url.apiPath(site, '/conversions'), query, {limit: 20})
+ }
+
+ function getFilterFor(listItem) {
+ return {goal: escapeFilterValue(listItem.name)}
+ }
+
+ return (
+
+ )
}
diff --git a/assets/js/dashboard/stats/behaviours/deprecated-conversions.js b/assets/js/dashboard/stats/behaviours/deprecated-conversions.js
new file mode 100644
index 000000000..ece6678ea
--- /dev/null
+++ b/assets/js/dashboard/stats/behaviours/deprecated-conversions.js
@@ -0,0 +1,119 @@
+import React from 'react';
+import { Link } from 'react-router-dom'
+import FlipMove from 'react-flip-move'
+
+import Bar from '../bar'
+import PropBreakdown from './prop-breakdown'
+import numberFormatter from '../../util/number-formatter'
+import * as api from '../../api'
+import * as url from '../../util/url'
+import { escapeFilterValue } from '../../util/filters'
+import LazyLoader from '../../components/lazy-loader'
+import Money from './money'
+
+export default class DeprecatedConversions extends React.Component {
+ constructor(props) {
+ super(props)
+ this.htmlNode = React.createRef()
+ this.state = { loading: true, }
+ this.onVisible = this.onVisible.bind(this)
+ this.fetchConversions = this.fetchConversions.bind(this)
+ }
+
+ componentWillUnmount() {
+ document.removeEventListener('tick', this.fetchConversions)
+ }
+
+ onVisible() {
+ this.fetchConversions()
+ if (this.props.query.period === 'realtime') {
+ document.addEventListener('tick', this.fetchConversions)
+ }
+ }
+
+ componentDidUpdate(prevProps) {
+ if (this.props.query !== prevProps.query) {
+ const height = this.htmlNode.current.offsetHeight
+ this.setState({ loading: true, goals: null, prevHeight: height })
+ this.fetchConversions()
+ }
+ }
+
+ fetchConversions() {
+ api.get(`/api/stats/${encodeURIComponent(this.props.site.domain)}/conversions`, this.props.query, {limit: 100})
+ .then((res) => this.setState({ loading: false, goals: res, prevHeight: null }))
+ }
+
+ renderGoal(goal, renderRevenueColumn) {
+ const renderProps = this.props.query.filters['goal'] == goal.name && goal.prop_names
+
+ return (
+
+
+
+
+ {goal.name}
+
+
+
+ {numberFormatter(goal.visitors)}
+ {numberFormatter(goal.events)}
+ {goal.conversion_rate}%
+ {renderRevenueColumn && }
+ {renderRevenueColumn && }
+
+
+ { renderProps &&
}
+
+ )
+ }
+
+ renderInner() {
+ if (this.state.loading) {
+ return
+ } else if (this.state.goals) {
+ const hasRevenue = this.state.goals.some((goal) => goal.total_revenue)
+
+ return (
+
+
+
Goal
+
+ Uniques
+ Total
+ CR
+ {hasRevenue && Revenue}
+ {hasRevenue && Average}
+
+
+
+ { this.state.goals.map((goal) => this.renderGoal.bind(this)(goal, hasRevenue) ) }
+
+
+ )
+ }
+ }
+
+ renderConversions() {
+ return (
+
+
+ {this.renderInner()}
+
+
+ )
+ }
+
+ render() {
+ return (
+
+ {this.renderConversions()}
+
+ )
+ }
+}
diff --git a/assets/js/dashboard/stats/behaviours/index.js b/assets/js/dashboard/stats/behaviours/index.js
index 2f1210376..85e913602 100644
--- a/assets/js/dashboard/stats/behaviours/index.js
+++ b/assets/js/dashboard/stats/behaviours/index.js
@@ -5,6 +5,7 @@ import classNames from 'classnames'
import * as storage from '../../util/storage'
import Conversions from './conversions'
+import DeprecatedConversions from './deprecated-conversions'
import Properties from './props'
import Funnel from './funnel'
import { FeatureSetupNotice } from '../../components/notice'
@@ -123,7 +124,13 @@ export default function Behaviours(props) {
}
function renderConversions() {
- if (site.hasGoals) { return }
+ if (site.hasGoals) {
+ if (site.flags.props) {
+ return
+ } else {
+ return
+ }
+ }
else if (adminAccess) {
return (
{
+ fetchData()
+ }, [])
+
+ function fetchData() {
+ api.get(url.apiPath(site, `/conversions`), query, {limit: 100, page})
+ .then((res) => {
+ setLoading(false)
+ setList(list.concat(res))
+ setPage(page + 1)
+ setMoreResultsAvailable(res.length >= 100)
+ })
+ }
+
+ function loadMore() {
+ setLoading(true)
+ fetchData()
+ }
+
+ function renderLoadMore() {
+ return (
+
+
+
+ )
+ }
+
+ function filterSearchLink(listItem) {
+ const searchParams = new URLSearchParams(window.location.search)
+ searchParams.set('goal', listItem.name)
+ return searchParams.toString()
+ }
+
+ function renderListItem(listItem, hasRevenue) {
+ return (
+
+ |
+
+ {listItem.name}
+
+ |
+ {numberFormatter(listItem.visitors)} |
+ {numberFormatter(listItem.events)} |
+ {listItem.conversion_rate}% |
+ { hasRevenue && | }
+ { hasRevenue && | }
+
+ )
+ }
+
+ function renderLoading() {
+ return
+ }
+
+ function renderBody() {
+ const hasRevenue = list.some((goal) => goal.total_revenue)
+
+ return (
+ <>
+ Goal Conversions
+
+
+
+
+
+
+ | Goal |
+ Uniques |
+ Total |
+ CR |
+ {hasRevenue && Revenue | }
+ {hasRevenue && Average | }
+
+
+
+ { list.map((item) => renderListItem(item, hasRevenue)) }
+
+
+
+ >
+ )
+ }
+
+ return (
+
+ { renderBody() }
+ { loading && renderLoading() }
+ { !loading && moreResultsAvailable && renderLoadMore() }
+
+ )
+}
+
+export default withRouter(ConversionsModal)
diff --git a/assets/js/dashboard/stats/reports/list.js b/assets/js/dashboard/stats/reports/list.js
index a22beb56b..8ccf592eb 100644
--- a/assets/js/dashboard/stats/reports/list.js
+++ b/assets/js/dashboard/stats/reports/list.js
@@ -190,7 +190,7 @@ export default function ListReport(props) {
return (
- { props.keyLabel }
+ { props.keyLabel }
{ metricLabels }
)
diff --git a/lib/plausible_web/controllers/api/stats_controller.ex b/lib/plausible_web/controllers/api/stats_controller.ex
index 5e26d7cbb..54b23be63 100644
--- a/lib/plausible_web/controllers/api/stats_controller.ex
+++ b/lib/plausible_web/controllers/api/stats_controller.ex
@@ -1110,6 +1110,7 @@ defmodule PlausibleWeb.Api.StatsController do
end
def conversions(conn, params) do
+ pagination = parse_pagination(params)
site = Plausible.Repo.preload(conn.assigns.site, :goals)
query = Query.from(site, params) |> Filters.add_prefix()
@@ -1133,7 +1134,7 @@ defmodule PlausibleWeb.Api.StatsController do
conversions =
site
- |> Stats.breakdown(query, "event:goal", metrics, {100, 1})
+ |> Stats.breakdown(query, "event:goal", metrics, pagination)
|> transform_keys(%{goal: :name})
|> Enum.map(fn goal ->
goal