Legacy-free Locale Service, D-Bus API proposal #529

mvidner · 2023-04-11T13:04:26Z

Problem

D-Installer currently have a separate Language service, although it's rather
simplistic. It just allows to set the language of the installed system using
Yast::Language.Set. And it's quite memory demanding for such an unimpressive
task.

That service would be a nice candidate to be rewritten from scratch with no
dependencies on YaST or Ruby. It's small enough and could give us a good
overview on how much can we save.

https://trello.com/c/MCAMvPMZ/3317-3-agama-design-the-service-to-setup-locale-language-keyboard-timezone-etc

Solution

Design document for the new service API

Testing

?

Screenshots

?

coveralls · 2023-04-11T13:08:40Z

Pull Request Test Coverage Report for Build 4787610171

0 of 0 changed or added relevant lines in 0 files are covered.
No unchanged relevant lines lost coverage.
Overall coverage remained the same at 73.786%

Totals
Change from base Build 4755725623:	0.0%
Covered Lines:	4759
Relevant Lines:	6218

💛 - Coveralls

doc/locale_api.md

jreidinger · 2023-04-11T13:30:06Z

doc/locale_api.md

+
+#### Design of Proposal Layer (uppper)
+
+None needed?


well, if we allow change of RTC that we should get here proposal, not?

I think you are confusing the caller and callee of the proposal?

Agama.locale.SetLocale takes a locale and proposes software, keyboard, timezone

Agama.locale.SetLocalRTC does nothing on top of systemd. Something else calls it depending on what disks are there. It is not needed.

local_rtc: Priority<bool> should solve this, right?

jreidinger · 2023-04-11T13:31:22Z

doc/locale_api.md

+
+#### Design of Elementary Layer (lower)
+
+Just use the systemd API, don't add any API of our own. We will use


just to make it clear, by using systemd API you mean ahving own service, but use org.freedesktop.timedate1 interface, right?

Well, I wanted to omit it completely and use systemd directly, but maybe it is worth it to add a forwarder because it uses a different bus (Agama vs system)

Agama.Locale1 service -> Agama/Locale1 object -> freedesktop.timedate1 interface, forwards to freedesktop/timedate1

Well, systemd cannot be used directly as we do not want to modify insts-sys ( or live system ) and only target ( aka installed ) one.

Ah, good point 🤔

jreidinger · 2023-04-12T19:41:28Z

doc/locale_api.md

+  interface ...Agama.Locale1 {
+    methods:
+      # FIXME: the method part is unclear to me. anyone better at proposals?
+      Commit();


I think we also need proposal method to 1. do initial proposal for given product 2. allow to reset values.
Commit method is fine for me.

jreidinger · 2023-04-12T19:48:29Z

doc/locale_api.md

+simply set what we consider a good default for a newly set locale, because:
+
+1. it is just one setting (as opposed to whole partitioning layout)
+2. the change will be visible in the UI, I assume


not so true for CLI

For CLI, I see two UI modes:
a. if you have a "dumb" CLI, it does not need to give feedback, it does exactly as it is told, except it may throw errors
b. for a "smart" CLI like our proposal logic, it needs to output the resulting state/changes, so that the user does not confuse it with a dumb one

jreidinger · 2023-04-12T20:05:42Z

doc/locale_api.md

+You may know a [similar settings in libzypp][resstatus] where it has 4 levels.
+
+*: maybe this is a crazy optimization? I am not too opposed to use strings for
+this on the bus.


or maybe other way. Just use priority like it is on libzypp repos?

Another thing to consider here is that beside user/machine it can be also controlled by product, so e.g. some locale is not available on ALP Micro ( now only en is there ). So it can remove invalid value with high priority.

re (2) higher priority than Human?? IMHO a bad idea

re (1): priority is a confusing concept, but I have found nothing better ☹️

The basic problem is:

in words, everyone agrees that when lower priority and higher priority meet, the higher priority wins

if you express them in numbers, you have conflicting interpretations:
a. bigger number means bigger=higher priority
b. lower number means higher priority, because a lower number is higher on the page in an ordered list.

Anyway, both my numeric values (23 and 42) and libzypp use the "ordered list" semantic.
So, I don't understand what you mean, actually?

man zypper:

-p, --priority positive-integer

Set priority of the repository. Priority of 1 is the highest, the higher the number the lower the priority. Default priority is 99. Packages from repositories with higher priority will be preferred even in case there is a higher installable version available in the repository with a lower priority.

well, question is if you use words human and machine, what will win? and if we introduce more like machine proposal, product specific, etc. what then will win?

Human always wins. (Haven't you watched Terminator? Haven't you known Asimov's laws since you've been ~~manufactured~~ born??)

Product specific? Then specify how it should work and I will name it.

jreidinger · 2023-04-19T18:50:06Z

doc/locale_api_WIP.md

+
+```
+ListLocales(
+  in  s     display_locale # "en_US.UTF-8"


Do we need this param or should we use what @shundhammer mention on call, so always return label in form english - native e.g. Czech - Čeština

OK, YaST does it the english+native way already

jreidinger · 2023-04-19T18:51:09Z

doc/locale_api_WIP.md

+
+```
+ListX11Keyboards(
+  in  s     display_locale # "en_US.UTF-8"


langtable does not provide localization for keyboard. It contain only id and english only description like

<keyboardId>se(rus_nodeadkeys)</keyboardId> <description>Russian (Sweden, phonetic, eliminate dead keys)</description>

jreidinger · 2023-04-19T19:00:58Z

doc/locale_api_WIP.md

+  in  s locale_id
+  out s tz_id
+)
+```


There will be probably one Commit method to write all of them down. I also miss here some method to get locale/keyboard/timezone as UI should display what user already selected.

jreidinger · 2023-04-21T15:06:57Z

doc/locale_api_WIP.md

+
+```
+ListLocales(
+  out a(sss) id_english_native


what langtable has is not locales specific, but language oriented. So here it makes more sense to have something like out a(sssas) id_english_native_variants where values will be like `(en,English,English,[en_US.UTF-8,en_GB.UTF-8,en_IN.UTF-8,...]). So in UI user can select language and then variant which is not translated. Similar data we can get for territories where is territory like Zambia and locales and languages speaked there.

and when I try to implement it I also found that for some less common languages there are no translations in langtable itself like Central Aymara. I expect it will solve when we also get data for filtering to only supported languages

jreidinger · 2023-04-21T15:07:50Z

doc/locale_api_WIP.md

+
+SetX11Keyboard(in s kb_id)
+
+X11KeyboardForLocale(


and same here. Keyboard is linked to language or territory, but not to locale. So we do not have such data.

jreidinger · 2023-04-21T15:08:38Z

doc/locale_api_WIP.md

+SetTimezone(in s tz_id)
+
+TimezoneForLocale(
+  in  s locale_id


and same here. There are languages or territories for timezone suggestion, but not for locale.

considering langtable, de-emphasizing systemd but not throwing it away just yet because systemd:locale != langtable:(territory+language) well yes but the `+` is a nontrivial operation

mvidner · 2023-04-27T08:55:15Z

@jreidinger
I have

changed the PR target to rust_locale
also rebased this on master so you will be merging master too

Legacy-free Locale Service, API proposal

76da8aa

better formatting

6b0e10f

jreidinger reviewed Apr 11, 2023

View reviewed changes

doc/locale_api.md Outdated Show resolved Hide resolved

jreidinger reviewed Apr 11, 2023

View reviewed changes

mvidner added 2 commits April 12, 2023 17:47

Proposal layer for Agama.Locale1, including Priority<T>

23272f5

fixup, accidental readonly by copy-paste

bf50605

jreidinger reviewed Apr 12, 2023

View reviewed changes

Agama.TimeDate1 proposal layer design, just 2 properties

1db73f2

mvidner changed the title ~~Legacy-free Locale Service, API proposal~~ Legacy-free Locale Service, D-Bus API proposal Apr 17, 2023

mvidner added 2 commits April 17, 2023 15:39

Switch from X11Keyboard to VConsoleKeyboard

9b05440

WIP another try, with langtable backend in mind

3594325

jreidinger reviewed Apr 19, 2023

View reviewed changes

English+native locale labels like YaST; no kb localized labels

75f473b

jreidinger reviewed Apr 21, 2023

View reviewed changes

Update to reflect initial implementation in rust_locale

6d47b48

considering langtable, de-emphasizing systemd but not throwing it away just yet because systemd:locale != langtable:(territory+language) well yes but the `+` is a nontrivial operation

mvidner force-pushed the redesign-locale-api branch from 6b9cc9b to 6d47b48 Compare April 24, 2023 14:36

mvidner changed the base branch from master to rust_locale April 27, 2023 08:52

mvidner merged commit 9ec96f5 into rust_locale Apr 27, 2023
14 checks passed

mvidner deleted the redesign-locale-api branch April 27, 2023 08:57

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Legacy-free Locale Service, D-Bus API proposal #529

Legacy-free Locale Service, D-Bus API proposal #529

mvidner commented Apr 11, 2023

coveralls commented Apr 11, 2023 •

edited

jreidinger Apr 11, 2023

mvidner Apr 11, 2023

mvidner Apr 13, 2023

jreidinger Apr 11, 2023

mvidner Apr 11, 2023

jreidinger Apr 11, 2023

mvidner Apr 13, 2023

jreidinger Apr 12, 2023

jreidinger Apr 12, 2023

mvidner Apr 13, 2023

jreidinger Apr 12, 2023 •

edited by mvidner

mvidner Apr 13, 2023

mvidner Apr 13, 2023 •

edited

mvidner Apr 13, 2023

jreidinger Apr 14, 2023

mvidner Apr 14, 2023

jreidinger Apr 19, 2023

mvidner Apr 21, 2023

jreidinger Apr 19, 2023

jreidinger Apr 19, 2023

jreidinger Apr 21, 2023

jreidinger Apr 21, 2023

jreidinger Apr 21, 2023

jreidinger Apr 21, 2023

mvidner commented Apr 27, 2023


		#### Design of Elementary Layer (lower)

		Just use the systemd API, don't add any API of our own. We will use


		SetX11Keyboard(in s kb_id)

		X11KeyboardForLocale(

Legacy-free Locale Service, D-Bus API proposal #529

Legacy-free Locale Service, D-Bus API proposal #529

Conversation

mvidner commented Apr 11, 2023

Problem

Solution

Testing

Screenshots

coveralls commented Apr 11, 2023 • edited

Pull Request Test Coverage Report for Build 4787610171

💛 - Coveralls

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jreidinger Apr 12, 2023 • edited by mvidner

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mvidner Apr 13, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mvidner commented Apr 27, 2023

coveralls commented Apr 11, 2023 •

edited

jreidinger Apr 12, 2023 •

edited by mvidner

mvidner Apr 13, 2023 •

edited