Allow Parsoid to provide category ID hints

This eases deployment dependencies by allowing Parsoid to supply an
appropriate database category ID so that new lint categories can be
appropriately stored during the interval between adding a new lint
category to Parsoid and deploying an Extension:Linter patch to
describe it.

Change-Id: Ib7b2342168fa53ca2abac7d5f54fe313be341eb7

includes/CategoryManager.php

@@ -167,14 +167,25 @@ class CategoryManager {
 	 * Get the int id for the category in lint_categories table
 	 *
 	 * @param string $name
+	 * @param int|null $hint An optional hint, passed along from Parsoid.
+	 *   If the hint contains a suggested category ID but the Linter
+	 *   extension doesn't (yet) have one, use the ID from Parsoid's hint.
+	 *   This allows decoupling the Parsoid deploy of a new category
+	 *   from the corresponding Linter extension deploy.
 	 * @return int
 	 * @throws MissingCategoryException if we can't find the id for the name
+	 *   and there is no hint from Parsoid
 	 */
-	public function getCategoryId( $name ) {
+	public function getCategoryId( $name, $hint = null ) {
 		if ( isset( $this->categoryIds[$name] ) ) {
 			return $this->categoryIds[$name];
 		}
 
+		// Use hint from Parsoid, if available.
+		if ( $hint !== null ) {
+			return $hint;
+		}
+
 		throw new MissingCategoryException( "Cannot find id for '$name'" );
 	}
 }

includes/Database.php

@@ -94,6 +94,7 @@ class Database {
 			$name,
 			[ (int)$row->linter_start, (int)$row->linter_end ],
 			$row->linter_params,
+			$row->linter_cat,
 			(int)$row->linter_id
 		);
 	}
@@ -135,7 +136,7 @@ class Database {
 	private function serializeError( LintError $error ) {
 		return [
 			'linter_page' => $this->pageId,
-			'linter_cat' => $this->categoryManager->getCategoryId( $error->category ),
+			'linter_cat' => $this->categoryManager->getCategoryId( $error->category, $error->catId ),
 			'linter_params' => FormatJson::encode( $error->params, false, FormatJson::ALL_OK ),
 			'linter_start' => $error->location[0],
 			'linter_end' => $error->location[1],

includes/Hooks.php

@@ -159,7 +159,9 @@ class Hooks {
 		$categoryMgr = new CategoryManager();
 		$catCounts = [];
 		foreach ( $data as $info ) {
-			if ( !$categoryMgr->isKnownCategory( $info['type'] ) ) {
+			if ( $categoryMgr->isKnownCategory( $info['type'] ) ) {
+				$info[ 'dbid' ] = null;
+			} elseif ( !isset( $info[ 'dbid' ] ) ) {
 				continue;
 			}
 			$count = $catCounts[$info['type']] ?? 0;

includes/LintError.php

@@ -51,14 +51,25 @@ class LintError {
 	 */
 	public $templateInfo;
 
+	/*
+	 * Optional hint for the linter category ID.
+	 * Passed through from Parsoid when a new category has been added
+	 * that isn't known to PHP yet.
+	 * @var int|null
+	 */
+	public $catId;
+
 	/**
 	 * @param string $category
 	 * @param int[] $location [ start, end ]
 	 * @param string|array $params JSON string or already decoded array
-	 * @param int $lintId linter_id
+	 * @param int|null $catId Optional category ID hint
+	 * @param int $lintId Optional linter_id
 	 */
-	public function __construct( $category, $location, $params, $lintId = 0 ) {
+	public function __construct( $category, $location, $params, $catId = null, $lintId = 0 ) {
 		$this->category = $category;
+		$this->catId = $catId;
+
 		if ( is_string( $params ) ) {
 			$params = FormatJson::decode( $params, true );
 		}
@@ -92,5 +103,4 @@ class LintError {
 
 		return $params;
 	}
-
 }

includes/RecordLintJob.php

@@ -48,7 +48,8 @@ class RecordLintJob extends Job {
 			$error = new LintError(
 				$errorInfo['type'],
 				$errorInfo['location'],
-				$errorInfo['params']
+				$errorInfo['params'],
+				$errorInfo['dbid']
 			);
 			// Use unique id as key to get rid of exact dupes
 			// (e.g. same category of error in same template)

tests/phpunit/LintErrorTest.php

@@ -43,6 +43,7 @@ class LintErrorTest extends \MediaWikiTestCase {
 			'obsolete-tag',
 			[ 10, 20 ],
 			[ 'name' => 'big' ],
+			null,
 			5
 		);
 		$this->assertInstanceOf( LintError::class, $error2 );

tests/phpunit/RecordLintJobTest.php

@@ -50,6 +50,7 @@ class RecordLintJobTest extends \MediaWikiTestCase {
 			'type' => 'fostered',
 			'location' => [ 0, 10 ],
 			'params' => [],
+			'dbid' => null,
 		];
 		$job = new RecordLintJob( $this->getMockTitle(), [
 			'errors' => [ $error ],