зеркало из https://github.com/mozilla/gecko-dev.git
Bug 1809201 - Use regionalPrefsLocales for the weather suggestions temperature unit. r=nanj
This replaces `Services.locale.appLocaleAsBCP47` with `regionalPrefsLocales[0]` when determining the temperature unit to use for weather suggestions. In summary, that means two things: * When the language of the OS locale is the same as the language of the app's locale, weather suggestions will use the OS locale. e.g., if your OS locale is en-CA but your Firefox is en-US, weather will prefer en-CA since both locales are English, and so temperatures will be shown in C. This is a change from the current behavior, where they would be shown in F. * When the user checked the "Use your operating system settings..." checkbox in about:preferences for unit formatting, weather suggestions will always use the OS locale, regardless of the app locale. This is due to how `regionalPrefsLocales` works [1]. This revision also makes a couple of changes to code added in D166216: * Instead of storing both C and F temperatures in the UrlbarResult payload, store only the user's appropriate temperature. This allows the xcpshell test (test_weather.js) to test locale behavior instead of having to do it in a browser test, and there's no reason not to do it anyway. * Replace the hardcoded expected suggestion properties in test_weather.js with the ones from `WEATHER_SUGGESTION`, as was the case before D166216. [1] `regionalPrefsLocales` is implemented [here](https://searchfox.org/mozilla-central/rev/d62c4c4d5547064487006a1506287da394b64724/intl/locale/LocaleService.cpp#485). If `intl.regional_prefs.use_os_locales` is true, `regionalPrefsLocales` returns the user's OS locales. The checkbox for this pref [is visible](https://searchfox.org/mozilla-central/rev/893a8f062ec6144c84403fbfb0a57234418b89cf/browser/components/preferences/main.js#1485-1491) only when the user's primary OS locale doesn't match the app's primary locale. The full label for the checkbox is [here](https://searchfox.org/mozilla-central/rev/d62c4c4d5547064487006a1506287da394b64724/browser/locales/en-US/browser/preferences/preferences.ftl#324). The pref defaults to false. If `intl.regional_prefs.use_os_locales` is false, `regionalPrefsLocales` returns the OS locales only if the OS locale's language is the same as the app locale's language. Otherwise it returns the app's locales. In either case, if an error is encountered, the app's locales are returned. Differential Revision: https://phabricator.services.mozilla.com/D166722
This commit is contained in:
Drew Willcoxon
Родитель
298fa45dea
Коммит
79112dc4a9
|
|
@ -249,8 +249,7 @@ class ProviderQuickSuggest extends UrlbarProvider {
|
|||
* @returns {object} An object describing the view update.
|
||||
*/
|
||||
getViewUpdate(result, idsByName) {
|
||||
let unit = Services.locale.appLocaleAsBCP47 == "en-US" ? "f" : "c";
|
||||
let uppercaseUnit = unit.toUpperCase();
|
||||
let uppercaseUnit = result.payload.temperatureUnit.toUpperCase();
|
||||
|
||||
return {
|
||||
currently: { l10n: { id: "firefox-suggest-weather-currently" } },
|
||||
|
|
@ -258,7 +257,7 @@ class ProviderQuickSuggest extends UrlbarProvider {
|
|||
l10n: {
|
||||
id: "firefox-suggest-weather-temperature",
|
||||
args: {
|
||||
value: result.payload.temperature[unit],
|
||||
value: result.payload.temperature,
|
||||
unit: uppercaseUnit,
|
||||
},
|
||||
},
|
||||
|
|
@ -288,8 +287,8 @@ class ProviderQuickSuggest extends UrlbarProvider {
|
|||
l10n: {
|
||||
id: "firefox-suggest-weather-high-low",
|
||||
args: {
|
||||
high: result.payload.high[unit],
|
||||
low: result.payload.low[unit],
|
||||
high: result.payload.high,
|
||||
low: result.payload.low,
|
||||
unit: uppercaseUnit,
|
||||
},
|
||||
},
|
||||
|
|
@ -899,6 +898,7 @@ class ProviderQuickSuggest extends UrlbarProvider {
|
|||
return null;
|
||||
}
|
||||
|
||||
let unit = Services.locale.regionalPrefsLocales[0] == "en-US" ? "f" : "c";
|
||||
let result = new lazy.UrlbarResult(
|
||||
UrlbarUtils.RESULT_TYPE.DYNAMIC,
|
||||
UrlbarUtils.RESULT_SOURCE.SEARCH,
|
||||
|
|
@ -914,11 +914,12 @@ class ProviderQuickSuggest extends UrlbarProvider {
|
|||
merinoProvider: suggestion.provider,
|
||||
dynamicType: WEATHER_DYNAMIC_TYPE,
|
||||
city: suggestion.city_name,
|
||||
temperature: suggestion.current_conditions.temperature,
|
||||
temperatureUnit: unit,
|
||||
temperature: suggestion.current_conditions.temperature[unit],
|
||||
currentConditions: suggestion.current_conditions.summary,
|
||||
forecast: suggestion.forecast.summary,
|
||||
high: suggestion.forecast.high,
|
||||
low: suggestion.forecast.low,
|
||||
high: suggestion.forecast.high[unit],
|
||||
low: suggestion.forecast.low[unit],
|
||||
isWeather: true,
|
||||
shouldNavigate: true,
|
||||
}
|
||||
|
|
|
|||
|
|
@ -11,8 +11,6 @@ const HISTOGRAM_RESPONSE = "FX_URLBAR_MERINO_RESPONSE_WEATHER";
|
|||
|
||||
const { WEATHER_SUGGESTION } = MerinoTestUtils;
|
||||
|
||||
const EXPECTED_RESULT = makeExpectedResult("f");
|
||||
|
||||
add_task(async function init() {
|
||||
await QuickSuggestTestUtils.ensureQuickSuggestInit();
|
||||
UrlbarPrefs.set("quicksuggest.enabled", true);
|
||||
|
|
@ -101,7 +99,7 @@ async function doBasicDisableAndEnableTest(pref) {
|
|||
});
|
||||
await check_results({
|
||||
context,
|
||||
matches: [EXPECTED_RESULT],
|
||||
matches: [makeExpectedResult()],
|
||||
});
|
||||
}
|
||||
|
||||
|
|
@ -478,34 +476,132 @@ add_task(async function clientTimeout() {
|
|||
});
|
||||
});
|
||||
|
||||
// The UrlbarResult should use the temperature unit appropriate for the user's
|
||||
// locale: F for en-US and C for everything else.
|
||||
add_task(async function localeTemperatureUnit() {
|
||||
// Locale task for when this test runs on an en-US OS.
|
||||
add_task(async function locale_enUS() {
|
||||
await doLocaleTest({
|
||||
shouldRunTask: osLocale => osLocale == "en-US",
|
||||
osUnit: "f",
|
||||
unitsByLocale: {
|
||||
"en-US": "f",
|
||||
// When the app's locale is set to any en-* locale, F will be used because
|
||||
// `regionalPrefsLocales` will prefer the en-US OS locale.
|
||||
"en-CA": "f",
|
||||
"en-GB": "f",
|
||||
de: "c",
|
||||
},
|
||||
});
|
||||
});
|
||||
|
||||
// Locale task for when this test runs on a non-US English OS.
|
||||
add_task(async function locale_nonUSEnglish() {
|
||||
await doLocaleTest({
|
||||
shouldRunTask: osLocale => osLocale.startsWith("en") && osLocale != "en-US",
|
||||
osUnit: "c",
|
||||
unitsByLocale: {
|
||||
// When the app's locale is set to en-US, C will be used because
|
||||
// `regionalPrefsLocales` will prefer the non-US English OS locale.
|
||||
"en-US": "c",
|
||||
"en-CA": "c",
|
||||
"en-GB": "c",
|
||||
de: "c",
|
||||
},
|
||||
});
|
||||
});
|
||||
|
||||
// Locale task for when this test runs on a non-English OS.
|
||||
add_task(async function locale_nonEnglish() {
|
||||
await doLocaleTest({
|
||||
shouldRunTask: osLocale => !osLocale.startsWith("en"),
|
||||
osUnit: "c",
|
||||
unitsByLocale: {
|
||||
"en-US": "f",
|
||||
"en-CA": "c",
|
||||
"en-GB": "c",
|
||||
de: "c",
|
||||
},
|
||||
});
|
||||
});
|
||||
|
||||
/**
|
||||
* Testing locales is tricky due to the weather feature's use of
|
||||
* `Services.locale.regionalPrefsLocales`. By default `regionalPrefsLocales`
|
||||
* prefers the OS locale if its language is the same as the app locale's
|
||||
* language; otherwise it prefers the app locale. For example, assuming the OS
|
||||
* locale is en-CA, then if the app locale is en-US it will prefer en-CA since
|
||||
* both are English, but if the app locale is de it will prefer de. If the pref
|
||||
* `intl.regional_prefs.use_os_locales` is set, then the OS locale is always
|
||||
* preferred.
|
||||
*
|
||||
* This function tests a given set of locales with and without
|
||||
* `intl.regional_prefs.use_os_locales` set.
|
||||
*
|
||||
* @param {object} options
|
||||
* Options
|
||||
* @param {Function} options.shouldRunTask
|
||||
* Called with the OS locale. Should return true if the function should run.
|
||||
* Use this to skip tasks that don't target a desired OS locale.
|
||||
* @param {string} options.osUnit
|
||||
* The expected "c" or "f" unit for the OS locale.
|
||||
* @param {object} options.unitsByLocale
|
||||
* The expected "c" or "f" unit when the app's locale is set to particular
|
||||
* locales. This should be an object that maps locales to expected units. For
|
||||
* each locale in the object, the app's locale is set to that locale and the
|
||||
* actual unit is expected to be the unit in the object.
|
||||
*/
|
||||
async function doLocaleTest({ shouldRunTask, osUnit, unitsByLocale }) {
|
||||
Services.prefs.setBoolPref("intl.regional_prefs.use_os_locales", true);
|
||||
let osLocale = Services.locale.regionalPrefsLocales[0];
|
||||
Services.prefs.clearUserPref("intl.regional_prefs.use_os_locales");
|
||||
|
||||
if (!shouldRunTask(osLocale)) {
|
||||
info("Skipping task, should not run for this OS locale");
|
||||
return;
|
||||
}
|
||||
|
||||
assertEnabled({
|
||||
message: "Sanity check initial state",
|
||||
hasSuggestion: true,
|
||||
pendingFetchCount: 0,
|
||||
});
|
||||
|
||||
let unitsByLocale = {
|
||||
"en-US": "f",
|
||||
"en-CA": "c",
|
||||
"en-GB": "c",
|
||||
de: "c",
|
||||
};
|
||||
// Sanity check initial locale info.
|
||||
Assert.equal(
|
||||
Services.locale.appLocaleAsBCP47,
|
||||
"en-US",
|
||||
"Initial app locale should be en-US"
|
||||
);
|
||||
Assert.ok(
|
||||
!Services.prefs.getBoolPref("intl.regional_prefs.use_os_locales"),
|
||||
"intl.regional_prefs.use_os_locales should be false initially"
|
||||
);
|
||||
|
||||
// Check locales.
|
||||
for (let [locale, expectedUnit] of Object.entries(unitsByLocale)) {
|
||||
await QuickSuggestTestUtils.withLocales([locale], async () => {
|
||||
let context = createContext("", {
|
||||
info("Checking locale: " + locale);
|
||||
await check_results({
|
||||
context: createContext("", {
|
||||
providers: [UrlbarProviderQuickSuggest.name],
|
||||
isPrivate: false,
|
||||
});
|
||||
await check_results({
|
||||
context,
|
||||
}),
|
||||
matches: [makeExpectedResult(expectedUnit)],
|
||||
});
|
||||
|
||||
info(
|
||||
"Checking locale with intl.regional_prefs.use_os_locales: " + locale
|
||||
);
|
||||
Services.prefs.setBoolPref("intl.regional_prefs.use_os_locales", true);
|
||||
await check_results({
|
||||
context: createContext("", {
|
||||
providers: [UrlbarProviderQuickSuggest.name],
|
||||
isPrivate: false,
|
||||
}),
|
||||
matches: [makeExpectedResult(osUnit)],
|
||||
});
|
||||
Services.prefs.clearUserPref("intl.regional_prefs.use_os_locales");
|
||||
});
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
// A weather suggestion should not be returned for a non-empty search string.
|
||||
add_task(async function nonEmptySearchString() {
|
||||
|
|
@ -546,7 +642,7 @@ add_task(async function block() {
|
|||
});
|
||||
await check_results({
|
||||
context,
|
||||
matches: [EXPECTED_RESULT],
|
||||
matches: [makeExpectedResult()],
|
||||
});
|
||||
|
||||
// Block the result.
|
||||
|
|
@ -629,13 +725,19 @@ function assertDisabled({ message, pendingFetchCount }) {
|
|||
);
|
||||
}
|
||||
|
||||
function makeExpectedResult(temperatureUnit) {
|
||||
function makeExpectedResult(temperatureUnit = undefined) {
|
||||
if (!temperatureUnit) {
|
||||
temperatureUnit =
|
||||
Services.locale.regionalPrefsLocales[0] == "en-US" ? "f" : "c";
|
||||
}
|
||||
|
||||
return {
|
||||
type: UrlbarUtils.RESULT_TYPE.DYNAMIC,
|
||||
source: UrlbarUtils.RESULT_SOURCE.SEARCH,
|
||||
heuristic: false,
|
||||
payload: {
|
||||
url: "http://example.com/weather",
|
||||
temperatureUnit,
|
||||
url: WEATHER_SUGGESTION.url,
|
||||
icon: "chrome://global/skin/icons/highlights.svg",
|
||||
helpUrl: QuickSuggest.HELP_URL,
|
||||
helpL10n: {
|
||||
|
|
@ -645,25 +747,17 @@ function makeExpectedResult(temperatureUnit) {
|
|||
blockL10n: {
|
||||
id: "firefox-suggest-urlbar-block",
|
||||
},
|
||||
requestId: "request_id",
|
||||
requestId: MerinoTestUtils.server.response.body.request_id,
|
||||
source: "merino",
|
||||
merinoProvider: "accuweather",
|
||||
dynamicType: "weather",
|
||||
city: "San Francisco",
|
||||
temperature: {
|
||||
c: 15.5,
|
||||
f: 60,
|
||||
},
|
||||
currentConditions: "Mostly cloudy",
|
||||
forecast: "Pleasant Saturday",
|
||||
high: {
|
||||
c: 21.1,
|
||||
f: 70,
|
||||
},
|
||||
low: {
|
||||
c: 13.9,
|
||||
f: 57,
|
||||
},
|
||||
city: WEATHER_SUGGESTION.city_name,
|
||||
temperature:
|
||||
WEATHER_SUGGESTION.current_conditions.temperature[temperatureUnit],
|
||||
currentConditions: WEATHER_SUGGESTION.current_conditions.summary,
|
||||
forecast: WEATHER_SUGGESTION.forecast.summary,
|
||||
high: WEATHER_SUGGESTION.forecast.high[temperatureUnit],
|
||||
low: WEATHER_SUGGESTION.forecast.low[temperatureUnit],
|
||||
isWeather: true,
|
||||
shouldNavigate: true,
|
||||
},
|
||||
|
|
|
|||
Загрузка…
Ссылка в новой задаче