Bug 1848527 - Part 1: Enable OutdatedDocumentation detekt rule in Fenix
[gecko.git] / mobile / android / fenix / app / src / main / java / org / mozilla / fenix / ServiceWorkerSupportFeature.kt
bloba1e7a922c2937e30db80c9e0021883fd5a9888f3
1 /* This Source Code Form is subject to the terms of the Mozilla Public
2  * License, v. 2.0. If a copy of the MPL was not distributed with this
3  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
5 package org.mozilla.fenix
7 import androidx.lifecycle.DefaultLifecycleObserver
8 import androidx.lifecycle.LifecycleOwner
9 import mozilla.components.browser.state.state.SessionState
10 import mozilla.components.concept.engine.EngineSession
11 import mozilla.components.concept.engine.EngineSession.LoadUrlFlags
12 import mozilla.components.concept.engine.serviceworker.ServiceWorkerDelegate
13 import org.mozilla.fenix.ext.components
15 /**
16  * Fenix own version of the `ServiceWorkerSupportFeature` from Android-Components
17  * which adds the ability to navigate to the browser before opening a new tab.
18  *
19  * Will automatically register callbacks for service workers requests and cleanup when [homeActivity] is destroyed.
20  *
21  * @property homeActivity [HomeActivity] used for navigating to browser or accessing various app components.
22  */
23 class ServiceWorkerSupportFeature(
24     private val homeActivity: HomeActivity,
25 ) : ServiceWorkerDelegate, DefaultLifecycleObserver {
26     override fun onDestroy(owner: LifecycleOwner) {
27         homeActivity.components.core.engine.unregisterServiceWorkerDelegate()
28     }
30     override fun onCreate(owner: LifecycleOwner) {
31         homeActivity.components.core.engine.registerServiceWorkerDelegate(this)
32     }
34     override fun addNewTab(engineSession: EngineSession): Boolean {
35         with(homeActivity) {
36             openToBrowser(BrowserDirection.FromHome)
38             components.useCases.tabsUseCases.addTab(
39                 flags = LoadUrlFlags.external(),
40                 engineSession = engineSession,
41                 source = SessionState.Source.Internal.None,
42             )
43         }
45         return true
46     }