Page MenuHomePhabricator
Create Task
Maniphest T211608

Librarize includes/services/
Closed, ResolvedPublic
Actions

Description

The contents of includes/services/ (ServiceContainer and friends) do not use any MediaWiki-specific code, as far as I can tell, except for the Assert library. As such, they could be moved to the includes/libs/ directory, to signal this fact more clearly, or even extracted into a separate library published to Packagist.

MediaWiki:

Library:

  • Create repo.
  • Verify GitHub mirror.
  • Set up WMF CI.
  • Set up Packagist hook.
  • Set up code coverage pipeline.
  • Set up doxygen pipeline.
  • Add lib to doc.wikimedia.org.

Details

SubjectRepoBranchLines +/-
doc: Add Services PHP libraryintegration/docrootmaster+7 -0
Use wikimedia/services 2.0.1mediawiki/coremaster+2 -1 K
Add wikimedia/services 2.0.1mediawiki/vendormaster+1 K -3
Initial import from MediaWiki coremediawiki/libs/Servicesmaster+1 K -0
Adjust for Wikimedia\Services movemediawiki/extensions/BlueSpiceFoundationmaster+2 -2
Adjust for Wikimedia\Services movemediawiki/extensions/WikibaseLexememaster+2 -2
Adjust for Wikimedia\Services movemediawiki/extensions/Wikibasemaster+3 -3
Fully extract services framework as a librarymediawiki/coremaster+100 -42
Customize query in gerrit

Related Objects

Event Timeline

Lucas_Werkmeister_WMDE created this task.Dec 10 2018, 4:39 PM
Restricted Application added a subscriber: Aklapper. · View Herald TranscriptDec 10 2018, 4:39 PM
gerritbot subscribed.Dec 10 2018, 5:34 PM

Change 478729 had a related patch set uploaded (by Lucas Werkmeister (WMDE); owner: Lucas Werkmeister (WMDE)):
[mediawiki/core@master] Move includes/services/ into includes/libs/

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

gerritbot added a project: Patch-For-Review.Dec 10 2018, 5:34 PM
gerritbot added a comment.Dec 14 2018, 7:43 PM

Change 479747 had a related patch set uploaded (by Lucas Werkmeister (WMDE); owner: Lucas Werkmeister (WMDE)):
[mediawiki/extensions/Wikibase@master] Adjust for Wikimedia\Services move

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

gerritbot added a comment.Dec 14 2018, 7:43 PM

Change 479748 had a related patch set uploaded (by Lucas Werkmeister (WMDE); owner: Lucas Werkmeister (WMDE)):
[mediawiki/extensions/WikibaseLexeme@master] Adjust for Wikimedia\Services move

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

gerritbot added a comment.Dec 14 2018, 7:43 PM

Change 479749 had a related patch set uploaded (by Lucas Werkmeister (WMDE); owner: Lucas Werkmeister (WMDE)):
[mediawiki/extensions/BlueSpiceFoundation@master] Adjust for Wikimedia\Services move

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

Lucas_Werkmeister_WMDE mentioned this in rEWLE97f536aa94bd: Adjust for Wikimedia\Services move.Dec 14 2018, 7:47 PM
Lucas_Werkmeister_WMDE updated the task description. (Show Details)Dec 14 2018, 7:56 PM
Lucas_Werkmeister_WMDE mentioned this in rEWLE8e002a990b3f: Adjust for Wikimedia\Services move.Dec 14 2018, 8:01 PM
gerritbot added a comment.Jan 16 2019, 6:10 PM

Change 478729 merged by jenkins-bot:
[mediawiki/core@master] Fully extract services framework as a library

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

ReleaseTaggerBot added a project: MW-1.33-notes (1.33.0-wmf.14; 2019-01-22).Jan 16 2019, 7:00 PM
Lucas_Werkmeister_WMDE updated the task description. (Show Details)Jan 17 2019, 5:53 PM
Lucas_Werkmeister_WMDE mentioned this in T214016: Add Wikimedia\Services to phan configuration.Jan 17 2019, 6:06 PM
gerritbot added a comment.Jan 18 2019, 11:39 AM

Change 479748 merged by jenkins-bot:
[mediawiki/extensions/WikibaseLexeme@master] Adjust for Wikimedia\Services move

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

gerritbot added a comment.Jan 18 2019, 11:39 AM

Change 479747 merged by jenkins-bot:
[mediawiki/extensions/Wikibase@master] Adjust for Wikimedia\Services move

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

Lucas_Werkmeister_WMDE updated the task description. (Show Details)Jan 18 2019, 12:25 PM
Legoktm subscribed.Jan 19 2019, 6:04 AM

What do we want to name the library? "Services"? "ServiceContainer"? I like the latter because it's much harder to confuse it with the nodejs services we have.

Legoktm moved this task from Untriaged to In Dev on the Librarization board.Jan 19 2019, 6:04 AM
daniel subscribed.Jan 19 2019, 9:05 AM

It's now in Wikimedia\Services. ServiceContainer may work though it's a bit too narrow. It would be nice to somehow indicate that this is about in-process service interfaces and DI infrastructure. On the other hand, this is indeed the view that PHP code should have of any node.js services it wants to call. So from PHP's perspective, "services" is correct.

Anyway, it's merged now. The library name should be the same as the namespace name, to avoid confusion. We can change the namespace name, but it would have to happen quickly, before extensions start using it.

Legoktm added a comment.Jan 19 2019, 6:16 PM
In T211608#4894160, @daniel wrote:

It's now in Wikimedia\Services. ServiceContainer may work though it's a bit too narrow. It would be nice to somehow indicate that this is about in-process service interfaces and DI infrastructure. On the other hand, this is indeed the view that PHP code should have of any node.js services it wants to call. So from PHP's perspective, "services" is correct.

It could also be a nonsense/unique name (e.g. "pimple")

Or something distantly related/play on words of "service"..."Ace" (the sports usage of service), "Cutlery" (the dishes/utensils usage of service). I like "Ace" now.

Anyway, it's merged now. The library name should be the same as the namespace name, to avoid confusion. We can change the namespace name, but it would have to happen quickly, before extensions start using it.

It hasn't been included in a stable release yet, so we still have time to change it. We'll have to provide a compat layer anyways (includes/compat/).

daniel added a comment.Jan 20 2019, 8:30 PM

Can we backronym "Ace"? "Augmentable Container Environment"?... naw...

gerritbot added a comment.Apr 12 2019, 2:10 PM

Change 479749 merged by jenkins-bot:
[mediawiki/extensions/BlueSpiceFoundation@master] Adjust for Wikimedia\Services move

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

Lucas_Werkmeister_WMDE updated the task description. (Show Details)Apr 12 2019, 2:47 PM
Legoktm added a comment.Jun 17 2019, 7:35 PM

https://www.mediawiki.org/w/index.php?diff=3280449&oldid=3280448&title=Gerrit/New_repositories/Requests/Entries

gerritbot added a comment.Jun 21 2019, 6:11 AM

Change 518198 had a related patch set uploaded (by Legoktm; owner: Legoktm):
[mediawiki/libs/Services@master] Initial import from MediaWiki core

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

Legoktm renamed this task from Move includes/services/ into includes/libs/ to Librarize includes/services/.Jun 21 2019, 6:13 AM
Legoktm mentioned this in rMLSEd728817dafe0: Initial import from MediaWiki core.Jun 21 2019, 6:14 AM
gerritbot added a comment.Jun 21 2019, 7:09 AM

Change 518198 merged by jenkins-bot:
[mediawiki/libs/Services@master] Initial import from MediaWiki core

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

Lucas_Werkmeister_WMDE added a comment.Jun 21 2019, 9:00 AM

@Legoktm nice, thanks! Should extensions also be updated to require that new library in composer.json?

gerritbot added a comment.Jun 29 2020, 9:07 PM

Change 608461 had a related patch set uploaded (by Legoktm; owner: Legoktm):
[mediawiki/vendor@master] Add wikimedia/services 2.0.1

https://gerrit.wikimedia.org/r/c/mediawiki/vendor/ /608461

gerritbot added a comment.Jun 29 2020, 9:09 PM

Change 608462 had a related patch set uploaded (by Legoktm; owner: Legoktm):
[mediawiki/core@master] Use wikimedia/services 2.0.1

https://gerrit.wikimedia.org/r/c/mediawiki/core/ /608462

Legoktm claimed this task.Jun 29 2020, 9:13 PM
In T211608#5273322, @Lucas_Werkmeister_WMDE wrote:

@Legoktm nice, thanks! Should extensions also be updated to require that new library in composer.json?

No. MediaWiki core will provide the library for extensions to use (though I would think that extensions would depend on MediaWikiServices rather than the underlying container implementation...).

DannyS712 subscribed.Jun 30 2020, 7:25 AM

@Legoktm should ServiceOptions also be moved to the new library? Or even to its own library, since it may have valid uses outside of a "service"?

Legoktm added a comment.Jun 30 2020, 7:29 AM
In T211608#6266577, @DannyS712 wrote:

@Legoktm should ServiceOptions also be moved to the new library? Or even to its own library, since it may have valid uses outside of a "service"?

ServiceOptions is dependent on the \Config class, so I don't think it's appropriate to librarize...or at least put in this library. Also, now that I look at the ServiceOptions class, I'm not the biggest fan of it, but that's another task.

Krinkle updated the task description. (Show Details)Jul 1 2020, 3:52 AM
gerritbot added a comment.Jul 1 2020, 4:07 PM

Change 608461 merged by jenkins-bot:
[mediawiki/vendor@master] Add wikimedia/services 2.0.1

https://gerrit.wikimedia.org/r/c/mediawiki/vendor/ /608461

gerritbot added a comment.Jul 1 2020, 4:08 PM

Change 608462 merged by jenkins-bot:
[mediawiki/core@master] Use wikimedia/services 2.0.1

https://gerrit.wikimedia.org/r/c/mediawiki/core/ /608462

gerritbot added a comment.Jul 1 2020, 4:23 PM

Change 608910 had a related patch set uploaded (by Legoktm; owner: Legoktm):
[integration/docroot@master] doc: Add Services PHP library

https://gerrit.wikimedia.org/r/c/integration/docroot/ /608910

Legoktm updated the task description. (Show Details)Jul 1 2020, 4:24 PM
ReleaseTaggerBot added a project: MW-1.35-notes (1.35.0-wmf.40; 2020-07-07).Jul 1 2020, 5:00 PM
Legoktm added a comment.Jul 1 2020, 5:37 PM
In T211608#6266582, @Legoktm wrote:
In T211608#6266577, @DannyS712 wrote:

@Legoktm should ServiceOptions also be moved to the new library? Or even to its own library, since it may have valid uses outside of a "service"?

ServiceOptions is dependent on the \Config class, so I don't think it's appropriate to librarize...or at least put in this library. Also, now that I look at the ServiceOptions class, I'm not the biggest fan of it, but that's another task.

For reference, this is now T256898: Reconsider usage of ServiceOptions.

gerritbot added a comment.Jul 1 2020, 7:00 PM

Change 608910 merged by jenkins-bot:
[integration/docroot@master] doc: Add Services PHP library

https://gerrit.wikimedia.org/r/c/integration/docroot/ /608910

Legoktm closed this task as Resolved.Jul 7 2020, 12:02 AM
Legoktm updated the task description. (Show Details)
Content licensed under Creative Commons Attribution-ShareAlike (CC BY-SA) 4.0 unless otherwise noted; code licensed under GNU General Public License (GPL) 2.0 or later and other open source licenses. By using this site, you agree to the Terms of Use, Privacy Policy, and Code of Conduct. · Wikimedia Foundation · Privacy Policy · Code of Conduct · Terms of Use · Disclaimer · CC-BY-SA · GPL · Credits