wiki.techinc.nl/maintenance/storage/orphanStats.php
Dreamy Jazz e7393b3cc7 Exclude boilerplate maintenance code from code coverage reports
Why:
* Maintenance scripts in core have bolierplate code that is
  added before and after the class to allow directly running
  the maintenance script.
* Running the maintenance script directly has been deprecated
  since 1.40, so this boilerplate code is only to support a now
  deprecated method of running maintenance scripts.
* This code cannot also be marked as covered, due to PHPUnit
  not recognising code coverage for files.
* Therefore, it is best to ignore this boilerplate code in code
  coverage reports as it cannot be marked as covered and also
  is for deprecated code.

What:
* Wrap the boilerplate code (requiring Maintenance.php and then
  later defining the maintenance script class and running if the
  maintenance script was called directly) with @codeCoverageIgnore
  comments.
* Some files use a different boilerplate code, however, these
  should also be marked as ignored for coverage for the same
  reason that coverage is not properly reported for files.

Bug: T371167
Change-Id: I32f5c6362dfb354149a48ce9c28da9a7fc494f7c
2024-08-27 13:22:29 +01:00

91 lines
2.8 KiB
PHP

<?php
/**
* Show some statistics on the blob_orphans table, created with trackBlobs.php.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @ingroup Maintenance ExternalStorage
*/
// @codeCoverageIgnoreStart
require_once __DIR__ . '/../Maintenance.php';
// @codeCoverageIgnoreEnd
/**
* Maintenance script that shows some statistics on the blob_orphans table,
* created with trackBlobs.php.
*
* @ingroup Maintenance ExternalStorage
*/
class OrphanStats extends Maintenance {
public function __construct() {
parent::__construct();
$this->addDescription(
"Show some statistics on the blob_orphans table, created with trackBlobs.php" );
}
protected function getExternalDB( $db, $cluster ) {
$lbFactory = $this->getServiceContainer()->getDBLoadBalancerFactory();
$lb = $lbFactory->getExternalLB( $cluster );
return $lb->getMaintenanceConnectionRef( $db );
}
public function execute() {
if ( !$this->getDB( DB_PRIMARY )->tableExists( 'blob_orphans', __METHOD__ ) ) {
$this->fatalError( "blob_orphans doesn't seem to exist, need to run trackBlobs.php first" );
}
$dbr = $this->getReplicaDB();
$res = $dbr->newSelectQueryBuilder()
->select( '*' )
->from( 'blob_orphans' )
->caller( __METHOD__ )->fetchResultSet();
$num = 0;
$totalSize = 0;
$hashes = [];
$maxSize = 0;
foreach ( $res as $row ) {
$extDB = $this->getExternalDB( DB_REPLICA, $row->bo_cluster );
$blobRow = $extDB->newSelectQueryBuilder()
->select( '*' )
->from( 'blobs' )
->where( [ 'blob_id' => $row->bo_blob_id ] )
->caller( __METHOD__ )->fetchRow();
$num++;
$size = strlen( $blobRow->blob_text );
$totalSize += $size;
$hashes[sha1( $blobRow->blob_text )] = true;
$maxSize = max( $size, $maxSize );
}
unset( $res );
$this->output( "Number of orphans: $num\n" );
if ( $num > 0 ) {
$this->output( "Average size: " . round( $totalSize / $num, 0 ) . " bytes\n" .
"Max size: $maxSize\n" .
"Number of unique texts: " . count( $hashes ) . "\n" );
}
}
}
// @codeCoverageIgnoreStart
$maintClass = OrphanStats::class;
require_once RUN_MAINTENANCE_IF_MAIN;
// @codeCoverageIgnoreEnd