File size: 7,403 Bytes
5b04ba0
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
<?php

/**
 * Matomo - free/libre analytics platform
 *
 * @link    https://matomo.org
 * @license https://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
 */

namespace Piwik\Plugins\Goals\tests\System;

use Piwik\API\Request;
use Piwik\Common;
use Piwik\DataTable;
use Piwik\Db;
use Piwik\Tests\Framework\TestCase\SystemTestCase;
use Piwik\Tests\Fixtures\SomePageGoalVisitsWithConversions;

/**
 * Tests API methods with goals that do and don't allow multiple
 * conversions per visit.
 *
 * @group TrackGoalsPagesTest
 * @group TrackGoalsPages
 * @group Plugins
 */
class TrackGoalsPagesTest extends SystemTestCase
{
    /**
     * @var SomePageGoalVisitsWithConversions
     */
    public static $fixture = null;

    /**
     * @dataProvider getApiForTesting
     */
    public function testApi($api, $params)
    {
        $this->runApiTests($api, $params);
    }

    public function getApiForTesting()
    {
        return [
            ['Actions.getPageUrls',        ['idSite' => self::$fixture->idSite, 'date' => self::$fixture->dateTime,
                                            'idGoal' => 1, 'period' => 'week']],
            ['Actions.getPageTitles',      ['idSite' => self::$fixture->idSite, 'date' => self::$fixture->dateTime,
                                            'idGoal' => 1, 'period' => 'week']],
            ['Actions.getEntryPageUrls',   ['idSite' => self::$fixture->idSite, 'date' => self::$fixture->dateTime,
                                            'idGoal' => 1, 'period' => 'day', 'otherRequestParameters' =>
                                                              ['filter_update_columns_when_show_all_goals' => 1]]],
            ['Actions.getEntryPageTitles', ['idSite' => self::$fixture->idSite, 'date' => self::$fixture->dateTime,
                                            'idGoal' => 1, 'period' => 'day', 'otherRequestParameters' =>
                                                              ['filter_update_columns_when_show_all_goals' => 1]]],

            ['API.getProcessedReport', [
                'idSite' => self::$fixture->idSite,
                'date' => self::$fixture->dateTime,
                'period' => 'day',
                'testSuffix' => 'showGoalsMetricsSingleGoal',
                'otherRequestParameters' => [
                    'filter_update_columns_when_show_all_goals' => '1',
                    'filter_show_goal_columns_process_goals' => '1',
                    'apiModule' => 'Actions',
                    'apiAction' => 'getEntryPageTitles',
                ],
            ]],
            ['API.getProcessedReport', [
                'idSite' => self::$fixture->idSite,
                'date' => self::$fixture->dateTime,
                'period' => 'day',
                'testSuffix' => 'showGoalsMetricsAllGoals',
                'otherRequestParameters' => [
                    'filter_update_columns_when_show_all_goals' => '1',
                    'apiModule' => 'Actions',
                    'apiAction' => 'getEntryPageTitles',
                ],
            ]],

            ['API.getProcessedReport', [
                'idSite' => self::$fixture->idSite,
                'date' => self::$fixture->dateTime,
                'period' => 'day',
                'testSuffix' => 'showGoalsMetricsPageReport',
                'otherRequestParameters' => [
                    'filter_update_columns_when_show_all_goals' => '1',
                    'filter_show_goal_columns_process_goals' => '1',
                    'apiModule' => 'Actions',
                    'apiAction' => 'getPageTitles',
                ],
            ]],
        ];
    }

    /**
     * Check that the log_conversion.pageviews_before column was correctly calculated
     *
     * @dataProvider getConversionPagesBeforeExpected
     */
    public function testConversionPagesBeforeValues($id, $expected)
    {
        $actual = Db::get()->fetchOne('SELECT pageviews_before FROM ' . Common::prefixTable('log_conversion') .
                                      ' WHERE idlink_va = ?', [$id]);

        $this->assertEquals($expected, $actual);
    }

    public static function getConversionPagesBeforeExpected()
    {
        return [
            ['id' => 5, 'expected' => 4],
            ['id' => 9, 'expected' => 3],
            ['id' => 14, 'expected' => 2],
            ['id' => 18, 'expected' => 5],
            ['id' => 23, 'expected' => 4],
            ['id' => 27, 'expected' => 7],
            ['id' => 29, 'expected' => 1],
            ['id' => 33, 'expected' => 3],
        ];
    }

    /**
     * Regression test for DEV-13925.
     *
     * Subtable page rows in Actions.getPageUrls report goal metrics, but the
     * nb_conversions_page_rate column stays at 0 because the post-processing
     * filter never recurses into subtables. flat=1 surfaces those subtable
     * rows at the top level, which makes the bug user-visible.
     */
    public function testPageRateIsCalculatedForFlattenedSubtableRows()
    {
        /** @var DataTable $urls */
        $urls = Request::processRequest('Actions.getPageUrls', [
            'idSite'        => self::$fixture->idSite,
            'period'        => 'week',
            'date'          => self::$fixture->dateTime,
            'idGoal'        => 1,
            'flat'          => '1',
            'filter_limit'  => -1,
        ]);

        $rowsByLabel = [];
        foreach ($urls->getRows() as $row) {
            $rowsByLabel[(string) $row->getColumn('label')] = $row;
        }

        // Goal 1 has 5 total conversions across the week (visits 1, 2, 4, 5, 6).
        // /page_A/index.html: 5 unique => 5 / 5 = 1
        // /page_A/Z:          2 unique => 2 / 5 = 0.4
        // /page_A/X:          1 unique => 1 / 5 = 0.2
        // Without the fix all three subtable rates are 0.
        $expected = [
            '/page_A/index.html' => ['uniq' => 5, 'rate' => 1.0],
            '/page_A/Z'          => ['uniq' => 2, 'rate' => 0.4],
            '/page_A/X'          => ['uniq' => 1, 'rate' => 0.2],
        ];

        foreach ($expected as $label => $expectedRow) {
            $row = $rowsByLabel[$label] ?? null;
            $this->assertNotNull(
                $row,
                "Row '$label' missing from flattened report. Got labels: " . implode(', ', array_keys($rowsByLabel))
            );

            $goals = $row->getColumn('goals');
            $this->assertIsArray($goals, "'goals' column not an array on $label");
            $this->assertArrayHasKey('idgoal=1', $goals, "Goal 1 data missing on $label");

            $this->assertSame(
                $expectedRow['uniq'],
                (int) ($goals['idgoal=1']['nb_conversions_page_uniq'] ?? 0),
                "Unexpected nb_conversions_page_uniq for $label"
            );

            $actualRate = round((float) ($goals['idgoal=1']['nb_conversions_page_rate'] ?? 0), 3);
            $this->assertSame(
                $expectedRow['rate'],
                $actualRate,
                "Expected nb_conversions_page_rate $expectedRow[rate] for $label but got $actualRate"
            );
        }
    }

    public static function getOutputPrefix()
    {
        return 'trackGoals_pages';
    }

    public static function getPathToTestDirectory()
    {
        return dirname(__FILE__);
    }
}

TrackGoalsPagesTest::$fixture = new SomePageGoalVisitsWithConversions();