From: Aaron Schulz <aschulz@wikimedia.org>
Date: Fri, 22 Jul 2016 02:32:09 +0000 (-0700)
Subject: Make statsd counts for MWCallableUpdate actually useful
X-Git-Tag: 1.31.0-rc.0~6291^2
X-Git-Url: http://git.cyclocoop.org/%22%20.%20generer_url_aide%28?a=commitdiff_plain;h=16ad2a779e741558db94a05699c64c2002c93930;p=lhc%2Fweb%2Fwiklou.git

Make statsd counts for MWCallableUpdate actually useful

Include the method that made the callback in the key.

Change-Id: Ifc7c486ee5c8d57b2516456569bb724cf7dc2b99
---

diff --git a/autoload.php b/autoload.php
index 5da06d83fb..09a2928394 100644
--- a/autoload.php
+++ b/autoload.php
@@ -330,6 +330,7 @@ $wgAutoloadLocalClasses = [
 	'DateFormats' => __DIR__ . '/maintenance/language/date-formats.php',
 	'DateFormatter' => __DIR__ . '/includes/parser/DateFormatter.php',
 	'DeadendPagesPage' => __DIR__ . '/includes/specials/SpecialDeadendpages.php',
+	'DeferrableCallback' => __DIR__ . '/includes/deferred/DeferrableCallback.php',
 	'DeferrableUpdate' => __DIR__ . '/includes/deferred/DeferrableUpdate.php',
 	'DeferredStringifier' => __DIR__ . '/includes/libs/DeferredStringifier.php',
 	'DeferredUpdates' => __DIR__ . '/includes/deferred/DeferredUpdates.php',
diff --git a/includes/deferred/AtomicSectionUpdate.php b/includes/deferred/AtomicSectionUpdate.php
index ccbd6b0eee..0da5d7dde3 100644
--- a/includes/deferred/AtomicSectionUpdate.php
+++ b/includes/deferred/AtomicSectionUpdate.php
@@ -4,7 +4,7 @@
  * Deferrable Update for closure/callback updates via IDatabase::doAtomicSection()
  * @since 1.27
  */
-class AtomicSectionUpdate implements DeferrableUpdate {
+class AtomicSectionUpdate implements DeferrableUpdate, DeferrableCallback {
 	/** @var IDatabase */
 	private $dbw;
 	/** @var string */
@@ -39,4 +39,8 @@ class AtomicSectionUpdate implements DeferrableUpdate {
 			$this->callback = null;
 		}
 	}
+
+	public function getOrigin() {
+		return $this->fname;
+	}
 }
diff --git a/includes/deferred/AutoCommitUpdate.php b/includes/deferred/AutoCommitUpdate.php
index ddf2bb878d..ef5903b668 100644
--- a/includes/deferred/AutoCommitUpdate.php
+++ b/includes/deferred/AutoCommitUpdate.php
@@ -4,7 +4,7 @@
  * Deferrable Update for closure/callback updates that should use auto-commit mode
  * @since 1.28
  */
-class AutoCommitUpdate implements DeferrableUpdate {
+class AutoCommitUpdate implements DeferrableUpdate, DeferrableCallback {
 	/** @var IDatabase */
 	private $dbw;
 	/** @var string */
@@ -53,4 +53,8 @@ class AutoCommitUpdate implements DeferrableUpdate {
 			$this->callback = null;
 		}
 	}
+
+	public function getOrigin() {
+		return $this->fname;
+	}
 }
diff --git a/includes/deferred/CallableUpdate.php b/includes/deferred/CallableUpdate.php
index 4b19c20066..d63c292ba9 100644
--- a/includes/deferred/CallableUpdate.php
+++ b/includes/deferred/CallableUpdate.php
@@ -3,22 +3,26 @@
 /**
  * Deferrable Update for closure/callback
  */
-class MWCallableUpdate implements DeferrableUpdate {
-	/** @var Closure|callable */
+class MWCallableUpdate implements DeferrableUpdate, DeferrableCallback {
+	/** @var callable */
 	private $callback;
+	/** @var string */
+	private $fname;
 
 	/**
 	 * @param callable $callback
-	 * @throws InvalidArgumentException
+	 * @param string $fname Calling method
 	 */
-	public function __construct( $callback ) {
-		if ( !is_callable( $callback ) ) {
-			throw new InvalidArgumentException( 'Not a valid callback/closure!' );
-		}
+	public function __construct( callable $callback, $fname = 'unknown' ) {
 		$this->callback = $callback;
+		$this->fname = $fname;
 	}
 
 	public function doUpdate() {
 		call_user_func( $this->callback );
 	}
+
+	public function getOrigin() {
+		return $this->fname;
+	}
 }
diff --git a/includes/deferred/DeferrableCallback.php b/includes/deferred/DeferrableCallback.php
new file mode 100644
index 0000000000..2eb0d5dfa0
--- /dev/null
+++ b/includes/deferred/DeferrableCallback.php
@@ -0,0 +1,13 @@
+<?php
+
+/**
+ * Callback wrapper that has an originating method
+ *
+ * @since 1.28
+ */
+interface DeferrableCallback {
+	/**
+	 * @return string Originating method name
+	 */
+	function getOrigin();
+}
diff --git a/includes/deferred/DeferredUpdates.php b/includes/deferred/DeferredUpdates.php
index 1552777a80..9768838c0a 100644
--- a/includes/deferred/DeferredUpdates.php
+++ b/includes/deferred/DeferredUpdates.php
@@ -61,7 +61,7 @@ class DeferredUpdates {
 	}
 
 	/**
-	 * Add a callable update.  In a lot of cases, we just need a callback/closure,
+	 * Add a callable update. In a lot of cases, we just need a callback/closure,
 	 * defining a new DeferrableUpdate object is not necessary
 	 *
 	 * @see MWCallableUpdate::__construct()
@@ -70,7 +70,7 @@ class DeferredUpdates {
 	 * @param integer $type DeferredUpdates constant (PRESEND or POSTSEND) (since 1.27)
 	 */
 	public static function addCallableUpdate( $callable, $type = self::POSTSEND ) {
-		self::addUpdate( new MWCallableUpdate( $callable ), $type );
+		self::addUpdate( new MWCallableUpdate( $callable, wfGetCaller() ), $type );
 	}
 
 	/**
@@ -143,7 +143,11 @@ class DeferredUpdates {
 				} else {
 					$otherUpdates[] = $update;
 				}
-				$stats->increment( 'deferred_updates.' . $method . '.' . get_class( $update ) );
+
+				$name = $update instanceof DeferrableCallback
+					? get_class( $update ) . '-' . $update->getOrigin()
+					: get_class( $update );
+				$stats->increment( 'deferred_updates.' . $method . '.' . $name );
 			}
 
 			// Delegate DataUpdate execution to the DataUpdate class