Page MenuHomePhabricator

Sensible default values in extension.json (WikispeechServerUrl)
Closed, ResolvedPublic

Description

There are some config variables (at the moment only WikispeechServerUrl) that needs to be set, but for which there are no obvious default values. Figure out what to set these to in extensions.json, to make sure that whoever is setting up the extension knows that they need to be set.

Describe the rules for how we handle these and solve this for the explicit case of WikispeechServerUrl.

Related Objects

Mentioned In
T243376: Determine if an upgrade to manifest version 2 in extension.json is useful
T244345: Remove the Util class for PHP tests
T243384: Remove `require` from PHP tests
T234597: Phase out PHPUnit expected exception annotations from tests
T179229: Decide whether we want the package-lock.json to commit or ignore
T206485: Set root: true in eslintrc.json
rEWIS624274d63b11: Bump manifest version up from 1 to 2
Mentioned Here
T179229: Decide whether we want the package-lock.json to commit or ignore
T206485: Set root: true in eslintrc.json
T234597: Phase out PHPUnit expected exception annotations from tests
T243384: Remove `require` from PHP tests
T244345: Remove the Util class for PHP tests
rEWIS20d9123e26f5: build: Updating mediawiki/mediawiki-codesniffer to 23.0.0
rEWISd8447da7a283: build: Set "root": true, in .eslintrc.json
rEWISf1f11438ad13: build: Updating mediawiki/mediawiki-codesniffer to 24.0.0
rEWIS07e603c36161: Variation improvements to the Wikispeech includes/ dir
rEWIScbfb48785055: build: Updating npm dependencies for security issues
rEWISbcd8507dc041: build: Updating dependencies
rEWIS3225fe24c38b: build: Updating js-yaml to 3.13.1
rEWISebbad49ed2d4: build: Bump mediawiki-codesniffer to 28.0.0 and make a pass
rEWISb831a16f07d0: build: Updating grunt-banana-checker to 0.8.1
rEWIS879bc3102ead: build: Updating mediawiki/minus-x to 0.3.2
rEWIS52931bc131f4: build: Updating npm dependencies
rEWIS24aa5aabd1db: build: Updating dependencies
rEWIS93c9f0b19af4: build: Updating composer dependencies
rEWIS90df124ace42: Remove "require once"-statements in test cases
rEWIS1dbe811f59f7: build: Updating npm dependencies
rEWIS624274d63b11: Bump manifest version up from 1 to 2
rEWIS8a3cc99dc002: Wikispeech: Remove HtmlGenerator
T243376: Determine if an upgrade to manifest version 2 in extension.json is useful

Event Timeline

For WikispeechServerUrl

The sensible default value would be null and we would have to introduce a check to see if the config value is defined.

If not you would want a warning before the pageload calls the Segmenter/Cleaner. There should be no need to check that this is set for the existing API calls.

The warning should at the very least be a console warning but we could also consider a visible warning e.g. dialogue box

Lokal_Profil renamed this task from Sensible default values in extension.json to Sensible default values in extension.json (WikispeechServerUrl).Jun 20 2017, 12:52 PM
Lokal_Profil updated the task description. (Show Details)
Lokal_Profil moved this task from Incoming to Backlog on the Wikispeech board.

I have added a bit of manifest v2 descriptions, committed for review in T243376.

	"config": {
		"WikispeechServerUrl": {
			"description": "URL to location of TTS-server. Developer installation available at http://wikispeech-tts-dev.wmflabs.org/ ",
			"value":  ""
		},

I have added a bit of manifest v2 descriptions, committed for review in T243376.

	"config": {
		"WikispeechServerUrl": {
			"description": "URL to location of TTS-server. Developer installation available at http://wikispeech-tts-dev.wmflabs.org/ ",
			"value":  ""
		},

Based on this an WikispeechServerUrl being the only one needing better defaults I consider this resolved

Lokal_Profil moved this task from 🥴 Backlog to 🤯 Done on the User-kalle board.