Add sync promo to "bookmark added" dialog

Author: CDRussell

app/src/main/java/com/duckduckgo/app/bookmarks/dialog/BookmarkAddedConfirmationDialog.kt

@@ -17,18 +17,25 @@
 package com.duckduckgo.app.bookmarks.dialog
 
 import android.annotation.SuppressLint
+import android.app.Activity
 import android.content.Context
 import android.graphics.Typeface
 import android.text.Spannable
 import android.text.SpannableString
 import android.text.style.StyleSpan
+import android.util.AttributeSet
 import android.view.LayoutInflater
+import android.view.MotionEvent
+import android.view.View
 import android.view.WindowManager
 import android.widget.FrameLayout
+import android.widget.LinearLayout
 import androidx.lifecycle.lifecycleScope
+import com.duckduckgo.app.bookmarks.BookmarkAddedPromotionPlugin
 import com.duckduckgo.app.browser.R
 import com.duckduckgo.app.browser.databinding.BottomSheetAddBookmarkBinding
 import com.duckduckgo.common.utils.ConflatedJob
+import com.duckduckgo.common.utils.plugins.PluginPoint
 import com.duckduckgo.savedsites.api.models.BookmarkFolder
 import com.google.android.material.bottomsheet.BottomSheetBehavior
 import com.google.android.material.bottomsheet.BottomSheetDialog
@@ -37,14 +44,16 @@ import com.google.android.material.shape.MaterialShapeDrawable
 import com.google.android.material.shape.ShapeAppearanceModel
 import kotlinx.coroutines.delay
 import kotlinx.coroutines.launch
+import logcat.logcat
 import com.duckduckgo.mobile.android.R as CommonR
 import com.google.android.material.R as MaterialR
 
 @SuppressLint("NoBottomSheetDialog")
 class BookmarkAddedConfirmationDialog(
-    context: Context,
+    activity: Activity,
     private val bookmarkFolder: BookmarkFolder?,
-) : BottomSheetDialog(context) {
+    private val promoPlugins: PluginPoint<BookmarkAddedPromotionPlugin>,
+) : BottomSheetDialog(activity) {
 
     abstract class EventListener {
         /** Sets a listener to be invoked when favorite state is changed */
@@ -63,6 +72,8 @@ class BookmarkAddedConfirmationDialog(
     override fun show() {
         setContentView(binding.root)
 
+        addInteractionListeners()
+
         window?.clearFlags(WindowManager.LayoutParams.FLAG_DIM_BEHIND)
         behavior.state = BottomSheetBehavior.STATE_EXPANDED
         behavior.isDraggable = false
@@ -84,11 +95,32 @@ class BookmarkAddedConfirmationDialog(
             dismiss()
         }
 
+        lifecycleScope.launch {
+            val promo = promoPlugins.getPlugins().firstNotNullOfOrNull { it.getView(context) }
+            updatePromo(promo)
+        }
+
+        startAutoDismissTimer()
+        super.show()
+    }
+
+    private fun addInteractionListeners() {
+        // any touches anywhere in the dialog will cancel auto-dismiss
+        binding.root.onTouchObserved = { cancelDialogAutoDismiss() }
+    }
+
+    private fun updatePromo(promoView: View?) {
+        logcat { "cdr updating promo. is promo null? ${promoView == null}" }
+        if (promoView == null) return
+
+        binding.promotionContainer.addView(promoView)
+    }
+
+    private fun startAutoDismissTimer() {
         autoDismissDialogJob += lifecycleScope.launch {
             delay(BOOKMARKS_BOTTOM_SHEET_DURATION)
             dismiss()
         }
-        super.show()
     }
 
     private fun cancelDialogAutoDismiss() {
@@ -130,3 +162,23 @@ class BookmarkAddedConfirmationDialog(
         private const val BOOKMARKS_BOTTOM_SHEET_DURATION = 3_500L
     }
 }
+
+/**
+ * A LinearLayout that observes all touch events flowing through it
+ * without interfering with child view touch handling.
+ */
+class TouchObservingLinearLayout @JvmOverloads constructor(
+    context: Context,
+    attrs: AttributeSet? = null,
+    defStyleAttr: Int = 0,
+) : LinearLayout(context, attrs, defStyleAttr) {
+
+    var onTouchObserved: (() -> Unit)? = null
+
+    override fun dispatchTouchEvent(ev: MotionEvent): Boolean {
+        if (ev.action == MotionEvent.ACTION_DOWN) {
+            onTouchObserved?.invoke()
+        }
+        return super.dispatchTouchEvent(ev)
+    }
+}

app/src/main/java/com/duckduckgo/app/bookmarks/dialog/BookmarkAddedConfirmationDialogFactory.kt

@@ -0,0 +1,39 @@
+/*
+ * Copyright (c) 2025 DuckDuckGo
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.duckduckgo.app.bookmarks.dialog
+
+import android.app.Activity
+import com.duckduckgo.app.bookmarks.BookmarkAddedPromotionPlugin
+import com.duckduckgo.common.utils.plugins.PluginPoint
+import com.duckduckgo.di.scopes.AppScope
+import com.duckduckgo.savedsites.api.models.BookmarkFolder
+import com.squareup.anvil.annotations.ContributesBinding
+import javax.inject.Inject
+
+interface BookmarkAddedConfirmationDialogFactory {
+
+    fun create(activity: Activity, bookmarkFolder: BookmarkFolder?): BookmarkAddedConfirmationDialog
+}
+
+@ContributesBinding(AppScope::class)
+class ReadyBookmarkAddedConfirmationDialogFactory @Inject constructor(
+    private val plugins: PluginPoint<BookmarkAddedPromotionPlugin>,
+) : BookmarkAddedConfirmationDialogFactory {
+    override fun create(activity: Activity, bookmarkFolder: BookmarkFolder?): BookmarkAddedConfirmationDialog {
+        return BookmarkAddedConfirmationDialog(activity, bookmarkFolder, plugins)
+    }
+}

app/src/main/java/com/duckduckgo/app/browser/BrowserTabFragment.kt

@@ -98,6 +98,7 @@ import androidx.webkit.WebViewFeature
 import com.duckduckgo.anvil.annotations.InjectWith
 import com.duckduckgo.app.accessibility.data.AccessibilitySettingsDataStore
 import com.duckduckgo.app.bookmarks.dialog.BookmarkAddedConfirmationDialog
+import com.duckduckgo.app.bookmarks.dialog.BookmarkAddedConfirmationDialogFactory
 import com.duckduckgo.app.browser.BrowserTabViewModel.FileChooserRequestedParams
 import com.duckduckgo.app.browser.R.string
 import com.duckduckgo.app.browser.SSLErrorType.NONE
@@ -425,6 +426,9 @@ class BrowserTabFragment :
     @Inject
     lateinit var blobConverterInjector: BlobConverterInjector
 
+    @Inject
+    lateinit var bookmarkAddedConfirmationDialogFactory: BookmarkAddedConfirmationDialogFactory
+
     val tabId get() = requireArguments()[TAB_ID_ARG] as String
     private val customTabToolbarColor get() = requireArguments().getInt(CUSTOM_TAB_TOOLBAR_COLOR_ARG)
     private val tabDisplayedInCustomTabScreen get() = requireArguments().getBoolean(TAB_DISPLAYED_IN_CUSTOM_TAB_SCREEN_ARG)
@@ -3762,8 +3766,8 @@ class BrowserTabFragment :
     }
 
     private fun savedSiteAdded(savedSiteChangedViewState: SavedSiteChangedViewState) {
-        context?.let { ctx ->
-            val dialog = BookmarkAddedConfirmationDialog(ctx, savedSiteChangedViewState.bookmarkFolder)
+        activity?.let { activity ->
+            val dialog = bookmarkAddedConfirmationDialogFactory.create(activity, savedSiteChangedViewState.bookmarkFolder)
             dialog.addEventListener(
                 object : BookmarkAddedConfirmationDialog.EventListener() {
                     override fun onFavoriteStateChangeClicked(isFavorited: Boolean) {

app/src/main/java/com/duckduckgo/app/browser/di/BrowserModule.kt

@@ -24,6 +24,8 @@ import androidx.datastore.preferences.core.Preferences
 import androidx.datastore.preferences.preferencesDataStore
 import androidx.work.WorkManager
 import com.duckduckgo.adclick.api.AdClickManager
+import com.duckduckgo.anvil.annotations.ContributesPluginPoint
+import com.duckduckgo.app.bookmarks.BookmarkAddedPromotionPlugin
 import com.duckduckgo.app.browser.*
 import com.duckduckgo.app.browser.addtohome.AddToHomeCapabilityDetector
 import com.duckduckgo.app.browser.addtohome.AddToHomeSystemCapabilityDetector
@@ -383,3 +385,6 @@ class BrowserModule {
 
 @Qualifier
 annotation class IndonesiaNewTabSection
+
+@ContributesPluginPoint(scope = AppScope::class, boundType = BookmarkAddedPromotionPlugin::class)
+private interface BookmarkAddedPromotionPluginPoint

app/src/main/res/layout/bottom_sheet_add_bookmark.xml

@@ -14,7 +14,7 @@
   ~ limitations under the License.
   -->
 
-<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
+<com.duckduckgo.app.bookmarks.dialog.TouchObservingLinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
     xmlns:app="http://schemas.android.com/apk/res-auto"
     xmlns:tools="http://schemas.android.com/tools"
     android:layout_width="match_parent"
@@ -64,4 +64,11 @@
         app:leadingIconBackground="circular"
         app:primaryText="@string/addBookmarkDialogEditBookmark" />
 
-</LinearLayout>
+    <LinearLayout
+        android:id="@+id/promotionContainer"
+        android:layout_width="match_parent"
+        android:layout_marginTop="@dimen/keyline_6"
+        android:layout_height="wrap_content"
+        android:orientation="vertical" />
+
+</com.duckduckgo.app.bookmarks.dialog.TouchObservingLinearLayout>

browser-api/src/main/java/com/duckduckgo/app/bookmarks/BookmarkAddedPromotionPlugin.kt

@@ -0,0 +1,34 @@
+/*
+ * Copyright (c) 2025 DuckDuckGo
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.duckduckgo.app.bookmarks
+
+import android.content.Context
+import android.view.View
+
+interface BookmarkAddedPromotionPlugin {
+
+    /**
+     * Returns a view to be displayed in the bookmark added confirmation dialog, or null if the promotion should not be shown.
+     * @param context The context to use to inflate the view.
+     * @return Some promotions may require criteria to be met before they are shown. If the criteria is not met, this method should return null.
+     */
+    suspend fun getView(context: Context): View?
+
+    companion object {
+        const val PRIORITY_KEY_BOOKMARK_ADDED_PROMOTION = 100
+    }
+}

saved-sites/saved-sites-impl/src/main/java/com/duckduckgo/savedsites/impl/bookmarks/promo/SetupSyncBookmarkAddedPromo.kt

@@ -0,0 +1,112 @@
+/*
+ * Copyright (c) 2025 DuckDuckGo
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.duckduckgo.savedsites.impl.bookmarks.promo
+
+import android.content.Context
+import android.util.AttributeSet
+import android.view.LayoutInflater
+import android.view.View
+import android.view.ViewGroup.LayoutParams.WRAP_CONTENT
+import android.widget.FrameLayout
+import com.duckduckgo.anvil.annotations.InjectWith
+import com.duckduckgo.anvil.annotations.PriorityKey
+import com.duckduckgo.app.bookmarks.BookmarkAddedPromotionPlugin
+import com.duckduckgo.app.bookmarks.BookmarkAddedPromotionPlugin.Companion.PRIORITY_KEY_BOOKMARK_ADDED_PROMOTION
+import com.duckduckgo.common.ui.menu.PopupMenu
+import com.duckduckgo.common.ui.view.gone
+import com.duckduckgo.common.ui.viewbinding.viewBinding
+import com.duckduckgo.common.utils.DispatcherProvider
+import com.duckduckgo.di.scopes.AppScope
+import com.duckduckgo.di.scopes.ViewScope
+import com.duckduckgo.navigation.api.GlobalActivityStarter
+import com.duckduckgo.saved.sites.impl.R
+import com.duckduckgo.saved.sites.impl.databinding.ViewSyncSetupBookmarkAddedPromoBinding
+import com.duckduckgo.sync.api.SyncActivityWithEmptyParams
+import com.squareup.anvil.annotations.ContributesMultibinding
+import dagger.android.support.AndroidSupportInjection
+import logcat.logcat
+import javax.inject.Inject
+
+@ContributesMultibinding(scope = AppScope::class)
+@PriorityKey(PRIORITY_KEY_BOOKMARK_ADDED_PROMOTION)
+class SetupSyncBookmarkAddedPromo @Inject constructor() : BookmarkAddedPromotionPlugin {
+    override suspend fun getView(context: Context): View? {
+        return SetupSyncBookmarkAddedPromotionView(context)
+        // return if(Random.nextBoolean()) {
+        //     null
+        // } else {
+        //     SetupSyncBookmarkAddedPromotionView(context)
+    }
+}
+
+@InjectWith(ViewScope::class)
+class SetupSyncBookmarkAddedPromotionView @JvmOverloads constructor(
+    context: Context,
+    attrs: AttributeSet? = null,
+    defStyle: Int = 0,
+) : FrameLayout(context, attrs, defStyle) {
+
+    @Inject
+    lateinit var globalActivityStarter: GlobalActivityStarter
+
+    @Inject
+    lateinit var dispatchers: DispatcherProvider
+
+    private val binding: ViewSyncSetupBookmarkAddedPromoBinding by viewBinding()
+
+    override fun onAttachedToWindow() {
+        AndroidSupportInjection.inject(this)
+        configureUiEventHandlers()
+        super.onAttachedToWindow()
+    }
+
+    private fun configureUiEventHandlers() {
+        with(binding.syncSetupPromoListItem) {
+            setClickListener {
+                launchSyncSettings()
+            }
+            setTrailingIconClickListener { anchor ->
+                showPopupMenu(anchor)
+            }
+        }
+    }
+
+    private fun showPopupMenu(anchor: View) {
+        val popupMenu = PopupMenu(
+            layoutInflater = LayoutInflater.from(context),
+            resourceId = R.layout.popup_window_hide_sync_suggestion_menu,
+            width = WRAP_CONTENT,
+        )
+        val view = popupMenu.contentView
+        popupMenu.onMenuItemClicked(view.findViewById(R.id.hide)) {
+            onHideSyncSuggestion()
+        }
+        popupMenu.show(binding.root, anchor)
+    }
+
+    private fun onHideSyncSuggestion() {
+        logcat { "Hide Sync Suggestion clicked" }
+        binding.syncSetupPromoListItem.gone()
+    }
+
+    private fun launchSyncSettings() {
+        context?.let {
+            val intent = globalActivityStarter.startIntent(it, SyncActivityWithEmptyParams)
+            context.startActivity(intent)
+        }
+    }
+}