[UX Review] [REPO] WikibaseRepo and WikibaseClient should not require loading default or example settings files
Closed, ResolvedPublic
Actions

Description

Currently (November 2024), to use Wikibase, you must load the repo example settings or configure some settings yourself: just loading WikibaseRepo will not result in a working installation. (Previously, this was also true of client, but that has already been fixed.) It should be possible to just load WikibaseRepo and have a working default configuration out of the box.

Acceptance criteria:

It is not necessary to load the client example settings
It is not necessary to load the repo example settings

Notes for the “last stretch”:

The only repo setting left is defaultEntityNamespaces. (The namespace definitions in Wikibase.example.php can be ignored; Wikibase also sets these elsewhere – the example file only defines them in case they’re used directly in someone’s LocalSettings.php.)
The production config has already been updated to explicitly set defaultEntityNamespaces to false, so we are free to change the default in Wikibase at any time.
There should be no other changes needed besides merging Change defaultEntityNamespaces default to true.

Details

Related Changes in Gerrit:

Subject	Repo	Branch	Lines +/-
Change defaultEntityNamespaces default to true	mediawiki/extensions/Wikibase	master	+12 -5
Set $wgWBRepoSettings['defaultEntityNamespaces'] to false	operations/mediawiki-config	master	+2 -0
Allow totally missing $wgWBClientSettings	mediawiki/extensions/Wikibase	master	+1 -2
Move namespace registration out of example settings (mostly)	mediawiki/extensions/Wikibase	master	+79 -38
Remove extremely outdated comment from repo example config	mediawiki/extensions/Wikibase	master	+0 -2
Remove shared cache key config from repo example config	mediawiki/extensions/Wikibase	master	+1 -6
client: Remove default configs in the example file	mediawiki/extensions/Wikibase	master	+1 -13
Remove useless code comments and unreachable statements in examples	mediawiki/extensions/Wikibase	master	+0 -180

Customize query in gerrit

Related Objects
Search...

Status	Assigned	Task
Open	None	T97012 Wikibase defaults should be usable out of the box
Resolved	karapayneWMDE	T379347 [EPIC] [SW] Technical Solution for UX Review Before Production
Resolved	Lucas_Werkmeister_WMDE	T291617 [UX Review] [REPO] WikibaseRepo and WikibaseClient should not require loading default or example settings files
Open	None	T292508 Add documentation for settings removed from Wikibase example settings
Resolved	Lucas_Werkmeister_WMDE	T292962 Decide whether to enable new termbox by default in Wikibase

Event Timeline

There are a very large number of changes, so older changes are hidden. Show Older Changes

With the changes uploaded so far, all the things remaining in Wikibase.example.php are related to namespaces (define the namespaces, declare them, register them as entity sources, and mark them to be searched by default). We don’t want to do that unconditionally in the default settings, but we can probably introduce a setting like defaultEntityNamespaces, and try setting up the namespaces in an extension callback. (We should watch out that we don’t run into T288819: NamespaceInfo service missing namespaces if initialized too early.)

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

[mediawiki/extensions/Wikibase@master] Move namespace registration out of example settings (mostly)

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

Further progress on this is currently blocked on T292962: Decide whether to enable new termbox by default in Wikibase.

Maintenance_bot moved this task from incoming to in progress on the Wikidata board.Oct 29 2021, 2:15 PM

Maintenance_bot moved this task from Incoming to In progress on the User-Ladsgroup board.

Michael moved this task from Wikidata-Campsite-Iteration-∞ (On Hold) to Prioritized Wikidata Tech Backlog (prioritised from top to bottom) on the Wikidata-Campsite board.Nov 4 2021, 10:23 AM

Michael edited projects, added Wikidata-Campsite; removed Wikidata-Campsite (Wikidata-Campsite-Iteration-∞ (On Hold)).

Michael moved this task from Prioritized Wikidata Tech Backlog (prioritised from top to bottom) to Wikidata-Campsite-Iteration-∞ (On Hold) on the Wikidata-Campsite board.

Michael edited projects, added Wikidata-Campsite (Wikidata-Campsite-Iteration-∞ (On Hold)); removed Wikidata-Campsite.

Change 726917 merged by jenkins-bot:

[mediawiki/extensions/Wikibase@master] Remove shared cache key config from repo example config

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

Change 726920 merged by jenkins-bot:

[mediawiki/extensions/Wikibase@master] Remove extremely outdated comment from repo example config

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

ReleaseTaggerBot edited projects, added MW-1.38-notes (1.38.0-wmf.9; 2021-11-16); removed MW-1.38-notes (1.38.0-wmf.4; 2021-10-12).Nov 5 2021, 11:00 AM

Change 727366 merged by jenkins-bot:

[mediawiki/extensions/Wikibase@master] Move namespace registration out of example settings (mostly)

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

Lucas_Werkmeister_WMDE closed subtask T292962: Decide whether to enable new termbox by default in Wikibase as Resolved.Feb 1 2022, 9:50 AM

Addshore moved this task from Wikidata-Campsite-Iteration-∞ (On Hold) to Incoming on the Wikidata-Campsite board.Feb 1 2022, 10:16 AM

Addshore edited projects, added Wikidata-Campsite; removed Wikidata-Campsite (Wikidata-Campsite-Iteration-∞ (On Hold)).

Addshore added projects: Wikibase Release Strategy, Wikibase (3rd party installations).

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

[mediawiki/extensions/Wikibase@master] Allow totally missing $wgWBClientSettings

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

This is no longer blocked on T292962.

The client example settings are already done, and the repo example settings only have two things left:

define namespace constants for Item and Property namespaces (WB_NS_ITEM etc.)
tell Wikibase to register these namespaces (set defaultEntityNamespaces to true)

I think the next steps would be:

set defaultEntityNamespaces explicitly to false in our production config
let defaultEntityNamespaces default to true
- with a release notes entry warning other wiki operators that they might want to set defaultEntityNamespaces to false in their config
remove defaultEntityNamespaces from the example settings

Once that’s done, it should be possible to use WikibaseRepo without the example config. We would still keep the example settings with the constants, for cases where people use those constants in their LocalSettings.php right after loading the example settings; but if you don’t use the example config, then Wikibase will define those namespaces later, and you’re good to go as long as you don’t use the constants in your LocalSettings.php. (If you want to use the constants, e.g. for namespace protections or whatever, then either define them yourself to whatever namespace number you want, or continue using the example settings.)

Edit: this basically just restates the commit message of https://gerrit.wikimedia.org/r/c/mediawiki/extensions/Wikibase/+/727366 btw ^^

WMDE-leszek added a project: Wikibase Suite Team (Wikibase Suite Maintenance Releases Feb 2022).Feb 6 2022, 12:00 PM

WMDE-leszek moved this task from Backlog to Not prioritized/Not Ready/Other on the Wikibase Suite Team (Wikibase Suite Maintenance Releases Feb 2022) board.Feb 6 2022, 12:08 PM

Change 759742 merged by jenkins-bot:

[mediawiki/extensions/Wikibase@master] Allow totally missing $wgWBClientSettings

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

ReleaseTaggerBot edited projects, added MW-1.38-notes (1.38.0-wmf.21; 2022-02-07); removed MW-1.38-notes (1.38.0-wmf.9; 2021-11-16).Feb 7 2022, 10:00 AM

@Lucas_Werkmeister_WMDE is this one still on your plate and being worked on?
I saw it pop into my backlog on Wikibase Suite Team and not sure if I should actually look at it at all? Or rather something to be left on the Wikidata-Campsite / Wikidata-Campsite (Team A Hearth 🏰🔥) ?

I guess I should unassign myself because I’m not working on it at the moment, no. Should be okay for someone else to pick up using the information in T291617#7683730 – I feel like, based on the product need, it belongs more in Team B than Team A?

kostajh subscribed.May 4 2022, 9:29 AM

WMDE-leszek subscribed.Jun 8 2022, 8:49 AM

• Manuel moved this task from Incoming to Miscellaneous on the Wikidata-Campsite board.Jul 12 2022, 12:07 PM

• Manuel moved this task from Miscellaneous to Incoming on the Wikidata-Campsite board.Aug 2 2022, 11:52 AM

• Manuel moved this task from Incoming to Tech realm on the Wikidata-Campsite board.Aug 2 2022, 12:05 PM

Lydia_Pintscher moved this task from in progress to monitoring on the Wikidata board.Aug 10 2022, 1:28 PM

• Manuel removed a project: Wikidata-Campsite.Nov 8 2022, 10:52 AM

WMDE-leszek moved this task from Wikibase Suite Maintenance Releases Feb 2022 to Inbox on the Wikibase Suite Team board.Feb 20 2023, 11:57 AM

WMDE-leszek edited projects, added Wikibase Suite Team; removed Wikibase Suite Team (Wikibase Suite Maintenance Releases Feb 2022).

Addshore unsubscribed.Jun 27 2023, 12:35 PM

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

[operations/mediawiki-config@master] Set $wgWBRepoSettings['defaultEntityNamespaces'] to false

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

Change 933880 merged by jenkins-bot:

[operations/mediawiki-config@master] Set $wgWBRepoSettings['defaultEntityNamespaces'] to false

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

Mentioned in SAL (#wikimedia-operations) [2023-06-28T13:16:23Z] <reedy@deploy1002> Started scap: Backport for [[gerrit:933880|Set $wgWBRepoSettings['defaultEntityNamespaces'] to false (T291617)]]

Mentioned in SAL (#wikimedia-operations) [2023-06-28T13:17:56Z] <reedy@deploy1002> reedy and lucaswerkmeister-wmde: Backport for [[gerrit:933880|Set $wgWBRepoSettings['defaultEntityNamespaces'] to false (T291617)]] synced to the testservers: mwdebug1002.eqiad.wmnet, mwdebug1001.eqiad.wmnet, mwdebug2001.codfw.wmnet, mwdebug2002.codfw.wmnet

Mentioned in SAL (#wikimedia-operations) [2023-06-28T13:25:42Z] <reedy@deploy1002> Finished scap: Backport for [[gerrit:933880|Set $wgWBRepoSettings['defaultEntityNamespaces'] to false (T291617)]] (duration: 09m 19s)

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

[mediawiki/extensions/Wikibase@master] Change defaultEntityNamespaces default to true

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

In T291617#7683730, @Lucas_Werkmeister_WMDE wrote:

I think the next steps would be:

set defaultEntityNamespaces explicitly to false in our production config

done

let defaultEntityNamespaces default to true

with a release notes entry warning other wiki operators that they might want to set defaultEntityNamespaces to false in their config

remove defaultEntityNamespaces from the example settings

https://gerrit.wikimedia.org/r/c/mediawiki/extensions/Wikibase/+/933906

That change, especially the release notes part, could probably use some more work; that probably belongs with the Wikibase Suite team.

darthmon_wmde moved this task from Inbox to Inherited Backlog on the Wikibase Suite Team board.Aug 25 2023, 6:27 AM

Physikerwelt added a project: NFDI-Germany.Dec 14 2023, 11:37 PM

darthmon_wmde removed a project: [DEPRECATED] wdwb-tech.Dec 22 2023, 11:03 AM

Restricted Application added a project: wmde-wikidata-tech. · View Herald TranscriptDec 22 2023, 11:03 AM

Not sure I fully understand the work remaining in this ticket, but I do smell something in the namespace config in repo and think we, WBS team, should understand and explore this further and make amendments accordingly. The conversations and cautions in this ticket should be a helpful guide. Our existing related test suite should also be helpful to understanding.

Keeping this ticket open and moving it to the backlog for further refinement:

Likely this is a Spike with the goal of better understanding the use and configuration of WikibaseRepo in total, with a focus on what could/should be included in our example configuration with regard to it.

lojo_wmde moved this task from Inherited Backlog to Inbox on the Wikibase Suite Team board.Jan 8 2024, 10:59 AM

lojo_wmde mentioned this in T289461: Decision: Support Client Only Instances?.Jan 8 2024, 11:07 AM

In T291617#8973385, @Lucas_Werkmeister_WMDE wrote:

That change, especially the release notes part, could probably use some more work; that probably belongs with the Wikibase Suite team.

For NFDI, merging https://gerrit.wikimedia.org/r/c/mediawiki/extensions/Wikibase/+/933906 would reduce confusion. For example, only by finding this change on Gerrit I realized that I had to set default entity namespaces to false.

As I understand it, what is remaining in the the example config files seems to be mostly about namespaces. So I wonder if T53051: Set useful and consistent (in client/repo) default namespaces is somehow related to this task here.

In T291617#9459651, @Michael wrote:

As I understand it, what is remaining in the example config files seems to be mostly about namespaces. So I wonder if T53051: Set useful and consistent (in client/repo) default namespaces is somehow related to this task here.

I would assume T53051 is already done. I don't understand why one needs the example config at all

https://github.com/wikimedia/mediawiki-extensions-Wikibase/blob/f2bd35609b6bf3f8d38ef8c78d2f340497906706/repo/includes/RepoHooks.php#L170-L175

does set up the default namespaces if they don't exist. So I guess one could delete the wikibase config example file altogether.

In conclusion, I think the proposed change https://gerrit.wikimedia.org/r/c/mediawiki/extensions/Wikibase/+/933906 improves the situation but can be extended and updated to REL1.42. However, only if someone might be willing to merge the change in due time it makes sense to discuss the details. Otherwise, it's a waste of time.

Lucas_Werkmeister_WMDE moved this task from Incoming to Other Projects on the wmde-wikidata-tech board.Feb 9 2024, 3:09 PM

Michael mentioned this in T53051: Set useful and consistent (in client/repo) default namespaces.Mar 7 2024, 12:11 PM

deprecated as consequence of T356617: Fix Example a.k.a. Separation of code, config and data

darthmon_wmde moved this task from Inbox to Archive (closed) on the Wikibase Suite Team board.Jun 25 2024, 5:48 PM

Thank you.
I still don't fully understand what will happen to

https://gerrit.wikimedia.org/r/c/mediawiki/extensions/Wikibase/+/933906

I implemented that on my wiki locally and took a note that I can undo the local modification once the change was merged...

Reopening, as the above change was never merged and is still relevant as far as I can tell – I don’t see any changes to Wikibase itself in T356617, only to the release pipeline. I’ve just rebased the change to resolve merge conflicts (it now updates RELEASE-NOTES-1.44 rather than RELEASE-NOTES-1.41).

This is also relevant because it should make it easier to include Wikibase in Patch Demo or Catalyst, which would be useful for T379347: [EPIC] [SW] Technical Solution for UX Review Before Production.

Lucas_Werkmeister_WMDE mentioned this in T379347: [EPIC] [SW] Technical Solution for UX Review Before Production.Nov 12 2024, 3:58 PM

Lucas_Werkmeister_WMDE moved this task from Other Projects to Incoming on the wmde-wikidata-tech board.

Lucas_Werkmeister_WMDE mentioned this in T372960: Add Wikibase Repository and Client extensions.Nov 14 2024, 4:13 PM

Lucas_Werkmeister_WMDE renamed this task from WikibaseRepo and WikibaseClient should not require loading default or example settings files to [UX Review] [REPO] WikibaseRepo and WikibaseClient should not require loading default or example settings files.Nov 21 2024, 2:13 PM

Lucas_Werkmeister_WMDE removed darthmon_wmde as the assignee of this task.

Lucas_Werkmeister_WMDE updated the task description. (Show Details)

Lucas_Werkmeister_WMDE removed the point value 5 for this task.