Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
0.00% covered (danger)
0.00%
0 / 62
0.00% covered (danger)
0.00%
0 / 2
CRAP
0.00% covered (danger)
0.00%
0 / 1
TestCompression
0.00% covered (danger)
0.00%
0 / 62
0.00% covered (danger)
0.00%
0 / 2
90
0.00% covered (danger)
0.00%
0 / 1
 __construct
0.00% covered (danger)
0.00%
0 / 5
0.00% covered (danger)
0.00%
0 / 1
2
 execute
0.00% covered (danger)
0.00%
0 / 57
0.00% covered (danger)
0.00%
0 / 1
72
1<?php
2/**
3 * Test revision text compression and decompression.
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
19 *
20 * @file
21 * @ingroup Maintenance ExternalStorage
22 */
23
24use MediaWiki\Revision\RevisionRecord;
25use MediaWiki\Revision\SlotRecord;
26use MediaWiki\Title\Title;
27
28// @codeCoverageIgnoreStart
29require_once __DIR__ . '/../Maintenance.php';
30// @codeCoverageIgnoreEnd
31
32class TestCompression extends Maintenance {
33    public function __construct() {
34        parent::__construct();
35
36        $this->addArg( 'title', 'The page to test' );
37
38        $this->addOption( 'type', 'The HistoryBlob subclass to use', false, true );
39        $this->addOption( 'start', 'The start date', false, true );
40        $this->addOption( 'limit', 'Maximum number of revisions to process', false, true );
41    }
42
43    public function execute() {
44        $lang = $this->getServiceContainer()->getLanguageFactory()->getLanguage( 'en' );
45        $title = Title::newFromText( $this->getArg( 0 ) );
46
47        if ( $this->hasOption( 'start' ) ) {
48            $start = wfTimestamp( TS_MW, strtotime( $this->getOption( 'start' ) ) );
49            echo "Starting from " . $lang->timeanddate( $start ) . "\n";
50        } else {
51            $start = '19700101000000';
52        }
53        if ( $this->hasOption( 'limit' ) ) {
54            $limit = $this->getOption( 'limit' );
55            $untilHappy = false;
56        } else {
57            $limit = 1000;
58            $untilHappy = true;
59        }
60        $type = $this->getOption( 'type', ConcatenatedGzipHistoryBlob::class );
61
62        $dbr = $this->getReplicaDB();
63
64        $revStore = $this->getServiceContainer()->getRevisionStore();
65        $res = $revStore->newSelectQueryBuilder( $dbr )
66            ->joinComment()
67            ->joinPage()
68            ->where( [
69                'page_namespace' => $title->getNamespace(),
70                'page_title' => $title->getDBkey(),
71                $dbr->expr( 'rev_timestamp', '>', $dbr->timestamp( $start ) ),
72            ] )
73            ->limit( $limit )
74            ->caller( __FILE__ )->fetchResultSet();
75
76        $blob = new $type;
77        $hashes = [];
78        $keys = [];
79        $uncompressedSize = 0;
80        $t = -microtime( true );
81        foreach ( $res as $row ) {
82            $revRecord = $revStore->newRevisionFromRow( $row );
83            $text = $revRecord->getSlot( SlotRecord::MAIN, RevisionRecord::RAW )
84                ->getContent()
85                ->serialize();
86            $uncompressedSize += strlen( $text );
87            $hashes[$row->rev_id] = md5( $text );
88            $keys[$row->rev_id] = $blob->addItem( $text );
89            if ( $untilHappy && !$blob->isHappy() ) {
90                break;
91            }
92        }
93
94        $serialized = serialize( $blob );
95        $t += microtime( true );
96        # print_r( $blob->mDiffMap );
97
98        printf( "%s\nCompression ratio for %d revisions: %5.2f, %s -> %d\n",
99            $type,
100            count( $hashes ),
101            $uncompressedSize / strlen( $serialized ),
102            $lang->formatSize( $uncompressedSize ),
103            strlen( $serialized )
104        );
105        printf( "Compression time: %5.2f ms\n", $t * 1000 );
106
107        $t = -microtime( true );
108        $blob = unserialize( $serialized );
109        foreach ( $keys as $id => $key ) {
110            $text = $blob->getItem( $key );
111            if ( md5( $text ) != $hashes[$id] ) {
112                echo "Content hash mismatch for rev_id $id\n";
113                # var_dump( $text );
114            }
115        }
116        $t += microtime( true );
117        printf( "Decompression time: %5.2f ms\n", $t * 1000 );
118    }
119}
120
121// @codeCoverageIgnoreStart
122$maintClass = TestCompression::class;
123require_once RUN_MAINTENANCE_IF_MAIN;
124// @codeCoverageIgnoreEnd