Page MenuHomePhabricator
Create Task
Maniphest T317793

[EPIC] Deprecate EventLogging::schemaValidate()
Open, Needs TriagePublic
Actions

Description

\MediaWiki\Extension\EventLogging\EventLogging::schemaValidate() allows the caller to validate an object against a JSONSchema. It's not clear which draft of JSONSchema it supports but one code comment suggests that it's pre draft-03.

MediaWiki Core depends on/uses the justinrainbow/json-schema library for validating objects against JSONSchema in production.

All known uses of ::schemaValidate() should be migrated to use the justinrainbow/json-schema library, which supports draft-03 and draft-04, and then the method should be hard deprecated.

TODO

  • Update EventLogging's usage of ::schemaValidate()
  • Update CollaborationKit's usage of ::schemaValidate()
    • CollaborationKit has been archived
  • Update FileAnnotations' usage of ::schemaValidate()
  • Update UploadWizard's usage ::schemaValidate()
  • Hard deprecate ::schemaValidate()
  • Remove ::schemaValidate() and the code in includes/Libs/JsonSchemaValidation after the next MediaWiki release

Related Objects
Search...

StatusSubtypeAssignedTask
 OpenNoneT408059 [GOAL] Tidy up EventLogging
 OpenNoneT317793 [EPIC] Deprecate EventLogging::schemaValidate()

Event Timeline

phuedx created this task.Sep 14 2022, 5:51 PM
Restricted Application added a project: Data-Engineering. · View Herald TranscriptSep 14 2022, 5:51 PM
Restricted Application added a subscriber: Aklapper. · View Herald Transcript
phuedx added projects: Epic, Metrics Platform.Sep 15 2022, 12:27 PM
• EChetty edited projects, added Data-Engineering-Planning; removed Data-Engineering.Sep 27 2022, 2:23 PM
• EChetty moved this task from Backlog to Metrics-Platform-MVP-Release-1 on the Metrics Platform board.Oct 1 2022, 4:19 PM
• EChetty edited projects, added Metrics Platform (Metrics-Platform-MVP-Release-1); removed Metrics Platform.
• EChetty edited projects, added Metrics Platform Icebox; removed Metrics Platform (Metrics-Platform-MVP-Release-1).Oct 1 2022, 4:22 PM
• EChetty moved this task from Backlog to Epics on the Data-Engineering-Planning board.Oct 14 2022, 8:34 AM
JArguello-WMF moved this task from Epics to Backlog on the Data-Engineering-Planning board.Jun 29 2023, 9:41 PM
JArguello-WMF removed a project: Data-Engineering-Planning.Jun 29 2023, 9:44 PM
Restricted Application added a project: Data-Engineering. · View Herald TranscriptJun 29 2023, 9:44 PM
JArguello-WMF moved this task from Incoming (new tickets) to Event Platform Backlog on the Data-Engineering board.Jun 29 2023, 10:30 PM
phuedx mentioned this in T351879: Support i18n in validation errors.Jan 5 2024, 3:31 PM
phuedx renamed this task from [EPIC] Deprecate EventLogging::schemaValidate to [EPIC] Deprecate EventLogging::schemaValidate().Feb 12 2024, 10:09 AM
phuedx mentioned this in T367034: MetricsPlatform Extension: Migrate JS and PHP Client Libraries.Jun 12 2024, 4:52 PM
phuedx moved this task from Backlog to Epics on the MediaWiki-extensions-EventLogging board.Oct 3 2024, 4:54 PM
phuedx edited projects, added Test Kitchen; removed Metrics Platform Icebox.Oct 4 2024, 4:59 AM
phuedx moved this task from Incoming to Epics Timeline on the Test Kitchen board.Oct 24 2024, 3:16 PM
phuedx edited projects, added Test Kitchen (Epics Timeline); removed Test Kitchen.
• VirginiaPoundstone added a project: Experimentation Lab Roadmap.Jan 6 2025, 10:23 PM
• VirginiaPoundstone moved this task from Epics Timeline to NEEDS DISCUSSION on the Test Kitchen board.Jan 6 2025, 10:28 PM
• VirginiaPoundstone edited projects, added Test Kitchen; removed Test Kitchen (Epics Timeline).
Ahoelzl moved this task from Event Platform Backlog to Backlog on the Data-Engineering board.Jan 18 2025, 12:05 AM
Milimetric moved this task from NEEDS DISCUSSION to Incoming on the Test Kitchen board.Jun 3 2025, 3:42 PM
phuedx updated the task description. (Show Details)Jun 24 2025, 4:13 AM
phuedx added a subscriber: MarkTraceur.Jun 24 2025, 9:14 AM

Update FileAnnotations' usage of ::schemaValidate()

I've reached out to @MarkTraceur about FileAnnotations.

phuedx updated the task description. (Show Details)Jul 14 2025, 10:05 AM
Milimetric triaged this task as High priority.Sep 17 2025, 3:21 PM
Milimetric moved this task from Incoming to READY TO GROOM on the Test Kitchen board.
Milimetric moved this task from READY TO GROOM to Backlog on the Test Kitchen board.
Milimetric moved this task from Backlog to READY TO GROOM on the Test Kitchen board.
phuedx added a parent task: T408059: [GOAL] Tidy up EventLogging.Oct 23 2025, 5:32 AM

See T351879#9437753 for notes on localising validation errors thrown by justinrainbow/json-schema.

Sfaci raised the priority of this task from High to Needs Triage.Nov 4 2025, 8:54 AM
Sfaci moved this task from READY TO GROOM to Tidy up EventLogging on the Test Kitchen board.
phuedx mentioned this in T411660: UploadWizard structure tests fail when EventLogging is not loaded.Fri, Dec 5, 1:35 PM
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