ApiChangeContentModel.php on line 82
Closed, ResolvedPublicPRODUCTION ERROR
Actions

Description

Steps to reproduce:

use the API sandbox (easiest this way), e.g. on testwiki
select action=changecontentmodel
fill in a title, e.g. User:Lucas Werkmeister (WMDE)/sandbox
select a different model, e.g. text
let the API sandbox auto-fill the token
do not fill in a summary
make request

Error

mwversion: 1.41.0-wmf.16
reqId: 6b4064b7-df04-4193-aa03-576aa07339da
Find reqId in Logstash

normalized_message

[{reqId}] {exception_url}   TypeError: Argument 2 passed to ContentModelChange::doContentModelChange() must be of the type string, null given, called in /srv/mediawiki/php-1.41.0-wmf.16/includes/api/ApiChangeContentModel.php on line 82

exception.trace

from /srv/mediawiki/php-1.41.0-wmf.16/includes/content/ContentModelChange.php(251)
#0 /srv/mediawiki/php-1.41.0-wmf.16/includes/api/ApiChangeContentModel.php(82): ContentModelChange->doContentModelChange(DerivativeContext, NULL, boolean)
#1 /srv/mediawiki/php-1.41.0-wmf.16/includes/api/ApiMain.php(1915): ApiChangeContentModel->execute()
#2 /srv/mediawiki/php-1.41.0-wmf.16/includes/api/ApiMain.php(892): ApiMain->executeAction()
#3 /srv/mediawiki/php-1.41.0-wmf.16/includes/api/ApiMain.php(863): ApiMain->executeActionWithErrorHandling()
#4 /srv/mediawiki/php-1.41.0-wmf.16/api.php(95): ApiMain->execute()
#5 /srv/mediawiki/php-1.41.0-wmf.16/api.php(48): wfApiMain()
#6 /srv/mediawiki/w/api.php(3): require(string)
#7 {main}

Impact

Minor logspam; users can’t change content model without specifying a summary (which is probably discouraged anyways)

Notes

Details

Request URL: https://test.wikipedia.org/w/api.php

	Subject	Repo	Branch	Lines +/-
	api: Default changecontentmodel summary to empty	mediawiki/core	master	+2 -2

Customize query in gerrit

Event Timeline

Lucas_Werkmeister_WMDE created this task.Jul 11 2023, 3:24 PM

Restricted Application added a subscriber: Aklapper. · View Herald TranscriptJul 11 2023, 3:24 PM

I suppose there’s two possible solutions:

default the summary to the empty string

diff --git a/includes/api/ApiChangeContentModel.php b/includes/api/ApiChangeContentModel.php
index 870355c12e..895e61af89 100644
--- a/includes/api/ApiChangeContentModel.php
+++ b/includes/api/ApiChangeContentModel.php
@@ -78,7 +78,7 @@ public function execute() {
 		try {
 			$status = $changer->doContentModelChange(
 				$this->getContext(),
-				$params['summary'],
+				$params['summary'] ?? '',
 				$params['bot']
 			);
 		} catch ( ThrottledError $te ) {

make the summary required

diff --git a/includes/api/ApiChangeContentModel.php b/includes/api/ApiChangeContentModel.php
index 870355c12e..2eacd53b3b 100644
--- a/includes/api/ApiChangeContentModel.php
+++ b/includes/api/ApiChangeContentModel.php
@@ -123,6 +123,7 @@ public function getAllowedParams() {
 			],
 			'summary' => [
 				ParamValidator::PARAM_TYPE => 'string',
+				ParamValidator::PARAM_REQUIRED => true,
 			],
 			'tags' => [
 				ParamValidator::PARAM_TYPE => 'tags',

The former is probably closer to what used to happen before the string parameter type was added to doContentModelChange(); the latter might be considered a breaking change to the API?

Lucas_Werkmeister_WMDE added a project: MediaWiki-Action-API.Jul 11 2023, 4:21 PM

Krinkle triaged this task as High priority.Jul 13 2023, 10:17 PM

Krinkle moved this task from Untriaged to Jul 2023 on the Wikimedia-production-error board.

Looks like the special page doesn’t require a summary either, so let’s just default it to the empty string.

Change 938209 had a related patch set uploaded (by Lucas Werkmeister (WMDE); author: Lucas Werkmeister (WMDE)):

[mediawiki/core@master] api: Default wbchangecontentmodel summary to empty

https://gerrit.wikimedia.org/r/938209

gerritbot added a project: Patch-For-Review.Jul 14 2023, 8:40 AM

Change 938209 merged by jenkins-bot:

[mediawiki/core@master] api: Default changecontentmodel summary to empty

https://gerrit.wikimedia.org/r/938209

Maintenance_bot removed a project: Patch-For-Review.Sep 10 2023, 1:30 PM

ReleaseTaggerBot added a project: MW-1.41-notes (1.41.0-wmf.26; 2023-09-12).Sep 10 2023, 2:00 PM

Umherirrender closed this task as Resolved.Sep 10 2023, 2:09 PM

Umherirrender assigned this task to Lucas_Werkmeister_WMDE.

TypeError: Argument 2 passed to ContentModelChange::doContentModelChange() must be of the type string, null given, called in /srv/mediawiki/php-1.41.0-wmf.16/includes/api/ApiChangeContentModel.php on line 82Closed, ResolvedPublicPRODUCTION ERRORActions