Page MenuHomePhabricator
Create Task
Maniphest T375619

Pass locale option to the chart renderer service
Closed, ResolvedPublic3 Estimated Story Points
Actions

Description

Apache Echarts supports internationalization and can take a locale as a option when rendering charts.

https://echarts.apache.org/handbook/en/basics/release-note/v5-feature/#internationalization

There are numerous supported locales, though it's much less than what Wikimedia uses, but I am sure more can be added:

https://github.com/apache/echarts/tree/release/src/i18n

Acceptance Criteria:

Notes:

Localization will help enable RTL languages to work better and other language-specific things.

Sign off

Details

Other Assignee
Jdlrobson-WMF
SubjectRepoBranchLines /-
Use axis formatter from chart specmediawiki/extensions/Chartmaster 6 -11
Pass locale code to chart renderer servicemediawiki/extensions/Chartmaster 1 -0
Customize query in gerrit

Related Objects
Search...

Event Timeline

aude created this task.Sep 25 2024, 1:22 PM
Restricted Application added a subscriber: Aklapper. · View Herald TranscriptSep 25 2024, 1:22 PM
aude updated the task description. (Show Details)Sep 25 2024, 1:23 PM
Reedy added a project: I18n.Sep 25 2024, 3:38 PM
Reedy updated the task description. (Show Details)
Jdlrobson triaged this task as High priority.Oct 11 2024, 10:34 PM
CCiufo-WMF moved this task from Backlog to Up Next on the Charts board.Nov 4 2024, 7:42 PM
CCiufo-WMF added a parent task: T372082: Epic: Enable Chart extension for pilot wikis.Nov 12 2024, 8:31 PM
CCiufo-WMF added a parent task: T379689: Deploy Charts to test2wiki Commons.Nov 12 2024, 10:48 PM
CCiufo-WMF removed a parent task: T372082: Epic: Enable Chart extension for pilot wikis.
aude claimed this task.Nov 15 2024, 7:54 PM
CCiufo-WMF moved this task from Up Next to Sprint 10 on the Charts board.Nov 15 2024, 7:55 PM
CCiufo-WMF edited projects, added Charts (Sprint 10); removed Charts.
aude moved this task from Incoming to Doing on the Charts (Sprint 10) board.Nov 15 2024, 8:00 PM
CCiufo-WMF moved this task from Sprint 10 to Up Next on the Charts board.Nov 18 2024, 7:20 PM
CCiufo-WMF edited projects, added Charts; removed Charts (Sprint 10).
CCiufo-WMF moved this task from Up Next to Sprint 11 on the Charts board.Nov 18 2024, 7:39 PM
CCiufo-WMF edited projects, added Charts (Sprint 11); removed Charts.
Jdlrobson set the point value for this task to 3.Nov 18 2024, 7:41 PM
CCiufo-WMF moved this task from Incoming to Doing on the Charts (Sprint 11) board.Nov 18 2024, 7:42 PM
CodeReviewBot added a project: Patch-For-Review.Sun, Nov 24, 11:17 PM

aude opened https://gitlab.wikimedia.org/repos/mediawiki/services/chart-renderer/-/merge_requests/54

Add locale option for chart rendering

gerritbot added a comment.Mon, Nov 25, 1:00 AM

Change #1096737 had a related patch set uploaded (by Aude; author: Aude):

[mediawiki/extensions/Chart@master] Pass locale code to chart renderer service

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

aude moved this task from Doing to Code Review on the Charts (Sprint 11) board.Mon, Nov 25, 7:33 PM
CCiufo-WMF moved this task from Sprint 11 to Sprint 13 on the Charts board.Mon, Dec 2, 7:44 PM
CCiufo-WMF edited projects, added Charts (Sprint 13); removed Charts (Sprint 11).
CCiufo-WMF moved this task from Incoming to Code Review on the Charts (Sprint 13) board.
aude added a comment.Mon, Dec 2, 8:27 PM
const locale = new Intl.Locale( language );
// Note: Only available in modern browsers, older browsers will fall back to LTR.
// https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/Locale/getTextInfo
const isRTL = locale && locale.textInfo && locale.textInfo.direction === 'rtl';

Intl.Locale and getting text direction (rtl) is not available in node

Intl.NumberFormat and Intl.DateTimeFormat are available.

Jdlrobson added a subtask: T381351: Charts treating x axis as date strings.Mon, Dec 2, 11:32 PM
Jdlrobson-WMF moved this task from Code Review to Doing on the Charts (Sprint 13) board.EditedTue, Dec 3, 10:11 PM
Jdlrobson-WMF subscribed.

Service patch is merged.
We will need to upstream a few other changes to address T381351.

To maintain backwards compatibility we'll need to fix this in the client too, so I suggest that we do all the following and make sure they are deployed before we leave for the holidays:

In January, we would then land https://gerrit.wikimedia.org/r/c/mediawiki/extensions/Chart/ /1099833?usp=search and rely on the logic in the server for infering types.

@aude does that sound like a plan?

aude added a comment.Wed, Dec 4, 11:54 PM

Left some comments in:

https://gerrit.wikimedia.org/r/c/mediawiki/extensions/Chart/ /1099827

though perhaps these could be addressed in follow-up tasks. Some charts have very small values that need more decimal place precision, like exchange rates or scientific data:

https://commons.wikimedia.beta.wmflabs.org/wiki/Data:JPYUSD_exchange_rate.chart

Screenshot 2024-12-04 at 6.54.01 PM.png (1×1 px, 106 KB)

with suggested changes:

Screenshot 2024-12-04 at 6.49.44 PM.png (1×1 px, 128 KB)

gerritbot added a comment.Thu, Dec 5, 10:06 PM

Change #1096737 merged by jenkins-bot:

[mediawiki/extensions/Chart@master] Pass locale code to chart renderer service

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

Jdlrobson mentioned this in rECRT6fd03ca7ffa6: Pass locale code to chart renderer service.Thu, Dec 5, 10:07 PM
ReleaseTaggerBot added a project: MW-1.44-notes (1.44.0-wmf.8; 2024-12-17).Thu, Dec 5, 11:00 PM
CCiufo-WMF closed subtask T381351: Charts treating x axis as date strings as Resolved.Fri, Dec 6, 9:38 PM
CodeReviewBot added a comment.Fri, Dec 6, 11:28 PM

aude opened https://gitlab.wikimedia.org/repos/mediawiki/services/chart-renderer/-/merge_requests/56

Align number and date formatting with client-side rendering

gerritbot added a comment.Mon, Dec 9, 1:40 AM

Change #1101235 had a related patch set uploaded (by Aude; author: Aude):

[mediawiki/extensions/Chart@master] Use axis formatter from chart spec

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

Jdlrobson updated Other Assignee, added: Jdlrobson-WMF.Mon, Dec 9, 7:54 PM
Seddon moved this task from Doing to Code Review on the Charts (Sprint 13) board.Mon, Dec 9, 7:57 PM
CodeReviewBot added a comment.Tue, Dec 10, 12:59 AM

jdlrobson merged https://gitlab.wikimedia.org/repos/mediawiki/services/chart-renderer/-/merge_requests/56

Align number and date formatting with client-side rendering

Jdlrobson updated the task description. (Show Details)Tue, Dec 10, 1:28 AM
gerritbot added a comment.Wed, Dec 11, 7:26 PM

Change #1101235 abandoned by Aude:

[mediawiki/extensions/Chart@master] Use axis formatter from chart spec

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

Jdlrobson updated the task description. (Show Details)Thu, Dec 12, 12:59 AM
Jdlrobson updated the task description. (Show Details)
Jdlrobson updated the task description. (Show Details)
Jdlrobson subscribed.

Nice! Looks like we're done here.
Note the two follow up tasks:

Jdlrobson reassigned this task from aude to CCiufo-WMF.Thu, Dec 12, 1:01 AM
Jdlrobson moved this task from Code Review to Ready for Signoff on the Charts (Sprint 13) board.
CCiufo-WMF closed this task as Resolved.Sat, Dec 14, 10:26 AM
In T375619#10381861, @aude wrote:

Left some comments in:

https://gerrit.wikimedia.org/r/c/mediawiki/extensions/Chart/ /1099827

though perhaps these could be addressed in follow-up tasks. Some charts have very small values that need more decimal place precision, like exchange rates or scientific data:

https://commons.wikimedia.beta.wmflabs.org/wiki/Data:JPYUSD_exchange_rate.chart

Screenshot 2024-12-04 at 6.54.01 PM.png (1×1 px, 106 KB)

with suggested changes:

Screenshot 2024-12-04 at 6.49.44 PM.png (1×1 px, 128 KB)

I agree -- the current behavior is strange. Can be addressed as a follow up though!

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