Skip to content
This repository has been archived by the owner on Jun 17, 2024. It is now read-only.

Commit

Permalink
Bug 1877203 - Update Translations Page Settings
Browse files Browse the repository at this point in the history 
The goal of this bug is to have a way to update page settings.

It adds:
* A new action, `UpdatePageSettingAction`
  * This action has four options:
     * `UPDATE_ALWAYS_OFFER_POPUP`
     * `UPDATE_ALWAYS_TRANSLATE_LANGUAGE`
     * `UPDATE_NEVER_TRANSLATE_LANGUAGE`
     * `UPDATE_NEVER_TRANSLATE_SITE`
* Each operation eagerly sets the new setting on the browser store, then
sends the request to the engine. If setting on the engine fails, then
they will re-request the page settings in order to remain in-sync.
  • Loading branch information
@ohall-m
ohall-m committed Feb 13, 2024
1 parent ab76672 commit 3e12723
Show file tree
Hide file tree
Showing 7 changed files with 496 additions and 5 deletions.
15 changes: 15 additions & 0 deletions ...ents/browser/state/src/main/java/mozilla/components/browser/state/action/BrowserAction.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ import mozilla.components.concept.engine.translate.TranslationEngineState
import mozilla.components.concept.engine.translate.TranslationError
import mozilla.components.concept.engine.translate.TranslationOperation
import mozilla.components.concept.engine.translate.TranslationOptions
import mozilla.components.concept.engine.translate.TranslationPageSettingOperation
import mozilla.components.concept.engine.translate.TranslationPageSettings
import mozilla.components.concept.engine.translate.TranslationSupport
import mozilla.components.concept.engine.webextension.WebExtensionBrowserAction
Expand Down Expand Up @@ -970,6 +971,20 @@ sealed class TranslationsAction : BrowserAction() {
val pageSettings: TranslationPageSettings?,
) : TranslationsAction(), ActionWithTab

/**
* Updates the specified page setting operation on the translation engine and ensures the final
* state on the given [tabId]'s store remains in-sync.
*
* @property tabId The ID of the tab the [EngineSession] should be linked to.
* @property operation The page setting update operation to perform.
* @property setting The boolean value of the corresponding [operation].
*/
data class UpdatePageSettingAction(
override val tabId: String,
val operation: TranslationPageSettingOperation,
val setting: Boolean,
) : TranslationsAction(), ActionWithTab

/**
* Sets the list of sites that the user has opted to never translate.
*
Expand Down
188 changes: 187 additions & 1 deletion ...rc/main/java/mozilla/components/browser/state/engine/middleware/TranslationsMiddleware.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ import mozilla.components.concept.engine.EngineSession
import mozilla.components.concept.engine.translate.LanguageSetting
import mozilla.components.concept.engine.translate.TranslationError
import mozilla.components.concept.engine.translate.TranslationOperation
import mozilla.components.concept.engine.translate.TranslationPageSettingOperation
import mozilla.components.concept.engine.translate.TranslationPageSettings
import mozilla.components.lib.state.Middleware
import mozilla.components.lib.state.MiddlewareContext
Expand Down Expand Up @@ -61,6 +62,47 @@ class TranslationsMiddleware(
-> Unit
}
}

is TranslationsAction.UpdatePageSettingAction -> {
when (action.operation) {
TranslationPageSettingOperation.UPDATE_ALWAYS_OFFER_POPUP ->
scope.launch {
updateAlwaysOfferPopupPageSetting(
setting = action.setting,
)
}

TranslationPageSettingOperation.UPDATE_ALWAYS_TRANSLATE_LANGUAGE ->
scope.launch {
updateLanguagePageSetting(
context = context,
tabId = action.tabId,
setting = action.setting,
settingType = LanguageSetting.ALWAYS,
)
}

TranslationPageSettingOperation.UPDATE_NEVER_TRANSLATE_LANGUAGE ->
scope.launch {
updateLanguagePageSetting(
context = context,
tabId = action.tabId,
setting = action.setting,
settingType = LanguageSetting.NEVER,
)
}

TranslationPageSettingOperation.UPDATE_NEVER_TRANSLATE_SITE ->
scope.launch {
updateNeverTranslateSitePageSetting(
context = context,
tabId = action.tabId,
setting = action.setting,
)
}
}
}

else -> {
// no-op
}
Expand All @@ -72,7 +114,7 @@ class TranslationsMiddleware(

/**
* Retrieves the list of supported languages using [scope] and dispatches the result to the
* store via [TranslationsAction.TranslateSetLanguagesAction] or else dispatches the failure
* store via [TranslationsAction.SetSupportedLanguagesAction] or else dispatches the failure
* [TranslationsAction.TranslateExceptionAction].
*
* @param context Context to use to dispatch to the store.
Expand Down Expand Up @@ -240,4 +282,148 @@ class TranslationsMiddleware(
)
}
}

/**
* Updates the always offer popup setting with the [Engine].
*
* @param setting The value of the always offer setting to update.
*/
private fun updateAlwaysOfferPopupPageSetting(
setting: Boolean,
) {
logger.info("Setting the always offer translations popup preference.")
engine.setTranslationsOfferPopup(setting)
}

/**
* Updates the language settings with the [Engine].
*
* If an error occurs, then the method will request the page settings be re-fetched and set on
* the browser store.
*
* @param context The context used to request the page settings.
* @param tabId Tab ID associated with the request.
* @param setting The value of the always offer setting to update.
* @param settingType If the boolean to update is from the
* [LanguageSetting.ALWAYS] or [LanguageSetting.NEVER] perspective.
*/
private fun updateLanguagePageSetting(
context: MiddlewareContext<BrowserState, BrowserAction>,
tabId: String,
setting: Boolean,
settingType: LanguageSetting,
) {
logger.info("Preparing to update the translations language preference.")

val pageLanguage = context.store.state.findTab(tabId)
?.translationsState?.translationEngineState?.detectedLanguages?.documentLangTag
val convertedSetting = settingType.toLanguageSetting(setting)

if (pageLanguage == null || convertedSetting == null) {
logger.info("An issue occurred while preparing to update the language setting.")

// Fetch page settings to ensure the state matches the engine.
context.store.dispatch(
TranslationsAction.OperationRequestedAction(
tabId = tabId,
operation = TranslationOperation.FETCH_PAGE_SETTINGS,
),
)
} else {
updateLanguageSetting(context, tabId, pageLanguage, convertedSetting)
}
}

/**
* Updates the language settings with the [Engine].
*
* If an error occurs, then the method will request the page settings be re-fetched and set on
* the browser store.
*
* @param context The context used to request the page settings.
* @param tabId Tab ID associated with the request.
* @param languageCode The BCP-47 language to update.
* @param setting The new language setting for the [languageCode].
*/
private fun updateLanguageSetting(
context: MiddlewareContext<BrowserState, BrowserAction>,
tabId: String,
languageCode: String,
setting: LanguageSetting,
) {
logger.info("Setting the translations language preference.")

engine.setLanguageSetting(
languageCode = languageCode,
languageSetting = setting,

onSuccess = {
logger.info("Successfully updated the language preference.")
},

onError = {
logger.error("Could not update the language preference.", it)

// Fetch page settings to ensure the state matches the engine.
context.store.dispatch(
TranslationsAction.OperationRequestedAction(
tabId = tabId,
operation = TranslationOperation.FETCH_PAGE_SETTINGS,
),
)
},
)
}

/**
* Updates the never translate site settings with the [EngineSession] and ensures the global
* list of never translate sites remains in sync.
*
* If an error occurs, then the method will request the page settings be re-fetched and set on
* the browser store.
*
* Note: This method should be used when on the same page as the requested change.
*
* @param context The context used to request the page settings.
* @param tabId Tab ID associated with the request.
* @param setting The value of the site setting to update.
*/
private fun updateNeverTranslateSitePageSetting(
context: MiddlewareContext<BrowserState, BrowserAction>,
tabId: String,
setting: Boolean,
) {
val engineSession = context.store.state.findTab(tabId)
?.engineState?.engineSession

if (engineSession == null) {
logger.error("Did not receive an engine session to set the never translate site preference.")
} else {
engineSession.setNeverTranslateSiteSetting(
setting = setting,
onResult = {
logger.info("Successfully updated the never translate site preference.")

// Ensure the global sites store is in-sync with the page settings.
context.store.dispatch(
TranslationsAction.OperationRequestedAction(
tabId = tabId,
operation = TranslationOperation.FETCH_NEVER_TRANSLATE_SITES,
),
)
},
onException = {
logger.error("Could not update the never translate site preference.", it)

// Fetch page settings to ensure the state matches the engine.
context.store.dispatch(
TranslationsAction.OperationRequestedAction(
tabId = tabId,
operation = TranslationOperation.FETCH_PAGE_SETTINGS,
),
)
},
)
}
}
}
50 changes: 50 additions & 0 deletions .../state/src/main/java/mozilla/components/browser/state/reducer/TranslationsStateReducer.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,12 @@
package mozilla.components.browser.state.reducer

import mozilla.components.browser.state.action.TranslationsAction
import mozilla.components.browser.state.selector.findTab
import mozilla.components.browser.state.state.BrowserState
import mozilla.components.browser.state.state.TranslationsState
import mozilla.components.concept.engine.translate.TranslationOperation
import mozilla.components.concept.engine.translate.TranslationPageSettingOperation
import mozilla.components.concept.engine.translate.TranslationPageSettings

internal object TranslationsStateReducer {

Expand Down Expand Up @@ -218,6 +221,53 @@ internal object TranslationsStateReducer {
state
}
}

is TranslationsAction.UpdatePageSettingAction -> {
var pageSettings = state.findTab(action.tabId)?.translationsState?.pageSettings
// Initialize page settings, if null.
if (pageSettings == null) {
pageSettings = TranslationPageSettings()
}
when (action.operation) {
TranslationPageSettingOperation.UPDATE_ALWAYS_OFFER_POPUP -> {
pageSettings.alwaysOfferPopup = action.setting
state.copyWithTranslationsState(action.tabId) {
it.copy(
pageSettings = pageSettings,
)
}
}
TranslationPageSettingOperation.UPDATE_ALWAYS_TRANSLATE_LANGUAGE -> {
pageSettings.alwaysTranslateLanguage = action.setting
// Always and never translate sites are always opposites.
pageSettings.neverTranslateLanguage = !action.setting

state.copyWithTranslationsState(action.tabId) {
it.copy(
pageSettings = pageSettings,
)
}
}
TranslationPageSettingOperation.UPDATE_NEVER_TRANSLATE_LANGUAGE -> {
pageSettings.neverTranslateLanguage = action.setting
// Always and never translate sites are always opposites.
pageSettings.alwaysTranslateLanguage = !action.setting
state.copyWithTranslationsState(action.tabId) {
it.copy(
pageSettings = pageSettings,
)
}
}
TranslationPageSettingOperation.UPDATE_NEVER_TRANSLATE_SITE -> {
pageSettings.neverTranslateSite = action.setting
state.copyWithTranslationsState(action.tabId) {
it.copy(
pageSettings = pageSettings,
)
}
}
}
}
}

private inline fun BrowserState.copyWithTranslationsState(
Expand Down
Loading

0 comments on commit 3e12723

Please sign in to comment.