Page MenuHomePhabricator

Remove descriptions from declareSchema call to reduce bandwidth usage
Closed, DeclinedPublic

Description

There's some interest (e.g. by Jon Robson at https://gerrit.wikimedia.org/r/#/c/91512) in reducing bandwidth usage of EventLogging RL schema modules. Low-hanging fruit for this is removing the human-readable "description" property from the declareSchema call.


Version: unspecified
Severity: normal

Details

Reference
bz56071

Event Timeline

bzimport raised the priority of this task from to Needs Triage.Nov 22 2014, 2:28 AM
bzimport set Reference to bz56071.
bzimport added a subscriber: Unknown Object (MLST).

My patch is not so much about bandwidth but more about consistency with the rest of ResourceLoader modules - the majority of keys are plural and allow strings or arrays (e.g. messages, scripts, styles)

I think removing description property might be a slight micro optimisation.

That said is the description used anywhere?

True, you can have multiple script files, etc. But at the same time, it's encouraged for a module to be a cohesive unit. But that's another topic.

Anyway, the description is not used anywhere on the client side, unless some developer is looking at it in their JavaScript console. The descriptions are for the aid of people reading and modifying the Meta (schema wiki) schema pages. They're documentation.

[moving from MediaWiki extensions to Analytics product - see bug 61946]