Allow setting of favourite serp easter egg logo by mikescamell · Pull Request #7467 · duckduckgo/Android

mikescamell · 2026-01-12T15:29:13Z

Task/Issue URL: https://app.asana.com/1/137249556945/project/1207908166761516/task/1212553599261552?focus=true

Description

This PR adds the ability for users to set a SERP Easter Egg logo as their favourite, which will then display on all DuckDuckGo search result pages.

Features implemented:

Feature toggle - Added remote feature toggle (serpEasterEggLogos.setFavourite) to control the favourite logo functionality
Favourite logo data store - Added FavouriteSerpLogoDataStore to persist the user's favourite logo URL preference
Discovery screen enhancements - Updated the Easter Egg logo screen to:
- Display a title telling the user they've discovered an Easter Egg logo
- Added a button to set/unset the logo as favourite
Wiggle animation - Easter Egg logos now play a subtle wiggle animation when displayed in the omnibar:
- Only plays once per unique logo URL
- Skips animation for favourite logos
- Waits for image crossfade to complete before animating
State management fixes - Fixed race conditions that could cause Easter Egg logos to be lost:
- Preserve existing Easter Egg when onViewModeChanged is called
- Distinguish between SerpLogo.Normal (explicitly no Easter Egg) and null (pending state)
- Reset to Dax logo when favourite preference changes

Steps to test this PR

Easter Egg Discovery

Setting a Favourite Logo

Resetting to Default

With a favourite logo set, tap on the logo
Verify the button now shows "Reset to Default"
Tap "Reset Search Logo"
Dismiss the easter egg logo screen
Verify the DDG logo is visible
Search for something that does not have an easter egg logo e.g. "fpl"
Verify the DDG logo is still visible
Search for a term that triggers an Easter Egg logo (e.g., "Southampton FC", "f1", "predator")
Verify the Easter Egg logo appears in the omnibar with a wiggle animation

Flag off

Index: serp-logos/serp-logos-api/src/main/kotlin/com/duckduckgo/serp/logos/api/SerpEasterEggLogosToggles.kt
IDEA additional info:
Subsystem: com.intellij.openapi.diff.impl.patch.CharsetEP
<+>UTF-8
===================================================================
diff --git a/serp-logos/serp-logos-api/src/main/kotlin/com/duckduckgo/serp/logos/api/SerpEasterEggLogosToggles.kt b/serp-logos/serp-logos-api/src/main/kotlin/com/duckduckgo/serp/logos/api/SerpEasterEggLogosToggles.kt
--- a/serp-logos/serp-logos-api/src/main/kotlin/com/duckduckgo/serp/logos/api/SerpEasterEggLogosToggles.kt	(revision 2a9b098666ba9cd103cbe20e24fa7ff018cf7168)
+++ b/serp-logos/serp-logos-api/src/main/kotlin/com/duckduckgo/serp/logos/api/SerpEasterEggLogosToggles.kt	(date 1769694204288)
@@ -24,6 +24,6 @@
   @Toggle.DefaultValue(DefaultFeatureValue.FALSE)
   fun self(): Toggle

-    @Toggle.DefaultValue(DefaultFeatureValue.TRUE)
+    @Toggle.DefaultValue(DefaultFeatureValue.FALSE)
   fun setFavourite(): Toggle
}

UI changes

Before	After

Note

Medium Risk
Touches omnibar state/animation handling and adds new persistence + feature-flagged behaviour, so regressions could affect address bar logo rendering across navigation and page loads. Scope is contained to SERP-logo UI/state and is well covered by new/updated tests.

Overview
Adds a feature-flagged “favourite” SERP Easter Egg logo that, when set, overrides normal SERP logo extraction and is shown on all DuckDuckGo search result pages.

Introduces persistence via a new FavouriteSerpLogoDataStore (DataStore-backed) and wires it through SerpLogos/BrowserTabViewModel so favourite changes immediately update the omnibar and avoid issuing ExtractSerpLogo when a favourite is active.

Updates the discovery UI to let users set/unset a favourite (new SerpEasterEggLogoViewModel, layout + strings) and refines omnibar rendering/animations: adds a one-time wiggle animation for non-favourite Easter Egg logos, plus explicit cancellation of that animation during logo transitions to prevent glitches. Tests are expanded across app + serp-logos modules, and SerpLogo.EasterEgg now carries an isFavourite flag to distinguish behaviour.

^{Written by Cursor Bugbot for commit e3e334d. This will update automatically on new commits. Configure here.}

app/src/main/java/com/duckduckgo/app/browser/omnibar/OmnibarLayout.kt

app/src/main/java/com/duckduckgo/app/browser/omnibar/OmnibarLayoutViewModel.kt

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

app/src/main/java/com/duckduckgo/app/browser/omnibar/OmnibarLayoutViewModel.kt

...rp-logos-impl/src/main/kotlin/com/duckduckgo/serp/logos/impl/ui/SerpEasterEggLogoActivity.kt

app/src/main/java/com/duckduckgo/app/browser/omnibar/OmnibarLayout.kt

anikiki

Looks good and works as expected! 🎉

There's a failing test (missing param).

app/src/main/java/com/duckduckgo/app/browser/omnibar/OmnibarLayoutViewModel.kt

We now include a title to tell the user they have discovered an easter egg logo and allow them to set the logo as their favourite via the newly added button on screen.

When an Easter Egg logo is displayed in the omnibar (from a special search like "f1"), it now plays a subtle wiggle animation once the image loads. The animation: - Only plays once per unique logo URL (prevents re-triggering on ViewState updates) - Skips animation for favourite logos (set by user preference) We also need to make sure we cancel the wobble animation before the shared element transition otherwise it becomes glitchy.

When a SERP page loads with an Easter Egg logo, two events occur in non-deterministic order: onViewModeChanged and onExternalOmnibarStateChanged. If onViewModeChanged was called after the Easter Egg was already set, it would overwrite the leadingIconState with Dax because it always passed logoUrl = null. This fix preserves the existing Easter Egg URL in onViewModeChanged by extracting it from the current state before updating, following the same pattern already used in onExternalLoadingStateChanged.

When navigating between searches, onExternalOmnibarStateChanged may be called with serpLogo = null before the new logo extraction completes. Previously this would clear the existing Easter Egg logo, causing Dax to briefly flash or persist if timing was unfavorable. Now we distinguish between: - SerpLogo.Normal: Explicitly no Easter Egg, clear and show Dax - null: Unknown/pending state, preserve existing Easter Egg if present This prevents the logo from being lost during navigation between Easter Egg searches.

No need to extract an existing logo if we have a favourite set. Also prevents getting into any weird state.

…te button clicked Matches iOS and request from Ship Review

… on SERP page in BrowserTabViewModel Moves the logic to ensure we set a Favourite EasterEgg logo to the BrowserTabViewModel. This makes the OmnibarViewModel dumber like before adding the favourite feature, leaving responsibility to the caller (BrowserTab) to decide what should be shown. Add flow observer that combines favourite toggle state and favourite URL to reactively update the serpLogo when: - Favourite logo is set: Show the favourite Easter egg logo - Favourite logo is cleared: Show Dax (Normal logo) - Feature is disabled: Let normal extraction handle it Only reacts when on a SERP page to avoid unnecessary updates on other pages.

When a favourite SERP logo is cleared while on a SERP page, the omnibarViewState.serpLogo should update from EasterEgg to Normal, but currently it stays stale. This test verifies the expected behavior and will pass once a flow observer is added to BrowserTabViewModel to react to favourite logo changes

The icon will now shrink depending on how much room we have between the text and the button. On all but the tiniest of phones this will be fine. I reduced margins to give the logo the best chance of being as big as possible without overlapping.

No longer needed as we moved the logic to the BrowserViewModel

cursor

Cursor Bugbot has reviewed your changes and found 1 potential issue.

...p-logos-impl/src/main/kotlin/com/duckduckgo/serp/logos/impl/ui/SerpEasterEggLogoViewModel.kt

Task/Issue URL: https://app.asana.com/1/137249556945/project/1207908166761516/task/1212768545044373?focus=true ### Description Translations for setting a favourite easter egg logo ### Steps to test this PR Enable setFavourite toggle _Translations_ - [x] Switch languages - [x] Search for an easter egg logo e.g. "predator" - [x] Check strings on the SERP easter egg logo screen have changed ### UI changes N/A  --- > [!NOTE] > **Low Risk** > Resource-only localization changes with no functional logic modifications; risk is limited to missing/incorrect string resources causing UI text regressions. > > **Overview** > Adds new localized strings used by the SERP easter egg logo screen for **setting a favourite logo**, **resetting to default**, and the discovery message (`serpLogoSetAsFavourite`, `serpLogoResetToDefault`, `serpLogoDiscoveryText`) across multiple `values-xx/strings-serp-logos.xml` files, plus the base `values/strings-serp-logos.xml`. > > Removes the `values/donottranslate.xml` resource that previously held the English versions of these strings, and updates several locale resource headers (copyright year). > > <sup>Written by [Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit d6264dd. This will update automatically on new commits. Configure [here](https://cursor.com/dashboard?tab=bugbot).</sup>

mikescamell changed the title ~~Feature/mike/allow setting of favourite serp easter egg logo~~ Allow setting of favourite serp easter egg logo Jan 12, 2026

mikescamell force-pushed the feature/mike/allow-setting-of-favourite-serp-easter-egg-logo branch 2 times, most recently from 19e36d2 to 3b8dd59 Compare January 13, 2026 17:48

mikescamell force-pushed the feature/mike/allow-setting-of-favourite-serp-easter-egg-logo branch 6 times, most recently from 7362335 to b763bc4 Compare February 2, 2026 09:02

mikescamell marked this pull request as ready for review February 2, 2026 09:46

cursor bot reviewed Feb 2, 2026

View reviewed changes

anikiki self-requested a review February 2, 2026 10:19

mikescamell assigned anikiki Feb 2, 2026

mikescamell force-pushed the feature/mike/allow-setting-of-favourite-serp-easter-egg-logo branch from b763bc4 to bff3474 Compare February 2, 2026 15:32

cursor bot reviewed Feb 2, 2026

View reviewed changes

app/src/main/java/com/duckduckgo/app/browser/BrowserTabViewModel.kt Show resolved Hide resolved

app/src/main/java/com/duckduckgo/app/browser/omnibar/OmnibarLayoutViewModel.kt Outdated Show resolved Hide resolved

mikescamell force-pushed the feature/mike/allow-setting-of-favourite-serp-easter-egg-logo branch from bff3474 to cf15f2f Compare February 2, 2026 16:04

cursor bot reviewed Feb 2, 2026

View reviewed changes

...rp-logos-impl/src/main/kotlin/com/duckduckgo/serp/logos/impl/ui/SerpEasterEggLogoActivity.kt Show resolved Hide resolved

mikescamell force-pushed the feature/mike/allow-setting-of-favourite-serp-easter-egg-logo branch from cae2868 to 20a6686 Compare February 2, 2026 16:31

cursor bot reviewed Feb 2, 2026

View reviewed changes

app/src/main/java/com/duckduckgo/app/browser/omnibar/OmnibarLayout.kt Show resolved Hide resolved

mikescamell force-pushed the feature/mike/allow-setting-of-favourite-serp-easter-egg-logo branch from 500da4f to b0e3498 Compare February 4, 2026 12:10

anikiki approved these changes Feb 4, 2026

View reviewed changes

cursor bot reviewed Feb 4, 2026

View reviewed changes

app/src/main/java/com/duckduckgo/app/browser/omnibar/OmnibarLayoutViewModel.kt Outdated Show resolved Hide resolved

mikescamell force-pushed the feature/mike/allow-setting-of-favourite-serp-easter-egg-logo branch 3 times, most recently from 5b93a05 to 64f8fcd Compare February 4, 2026 20:29

mikescamell added 5 commits February 4, 2026 21:50

Add feature toggle

1e9b5cc

Add data store for managing favourite SERP logo preferences

eb5d6e7

Expose favourite logo flow via SerpLogos interface

933db00

Add discovery test and favourite button to SERP Easter Egg logo screen

66fd9d2

We now include a title to tell the user they have discovered an easter egg logo and allow them to set the logo as their favourite via the newly added button on screen.

mikescamell added 19 commits February 4, 2026 21:50

Don't extract SERP logo when favourite is set

739af3a

No need to extract an existing logo if we have a favourite set. Also prevents getting into any weird state.

Add tests

be60a4b

Lint

26ce2b4

Refactor leading icon state handling to use getLeadingIconState method

93a8174

Fix casing

8477d53

Add command handling to close the Easter egg logo screen when favouri…

7ebf0cb

…te button clicked Matches iOS and request from Ship Review

Implement background click handling to close the Easter egg logo screen

aeea849

Add tests

9def7d0

Update background dim amount for better text contrast

5c3c377

Remove unused dependency from test

90ef0e6

Fix layout spacing or landscape mode

7c59b9b

The icon will now shrink depending on how much room we have between the text and the button. On all but the tiniest of phones this will be fine. I reduced margins to give the logo the best chance of being as big as possible without overlapping.

Remove test

8c0b487

No longer needed as we moved the logic to the BrowserViewModel

Fix wiggle playing when opening a new tab and searching

2131824

spotless

ba420b4

Fix tests

918b1f5

mikescamell force-pushed the feature/mike/allow-setting-of-favourite-serp-easter-egg-logo branch from 64f8fcd to 918b1f5 Compare February 4, 2026 20:50

cursor bot reviewed Feb 4, 2026

View reviewed changes

...p-logos-impl/src/main/kotlin/com/duckduckgo/serp/logos/impl/ui/SerpEasterEggLogoViewModel.kt Show resolved Hide resolved

mikescamell and others added 2 commits February 5, 2026 09:22

Fix duplicate flow collection on configuration change

4d932d8

mikescamell merged commit ddd02a3 into develop Feb 6, 2026
12 of 13 checks passed

mikescamell deleted the feature/mike/allow-setting-of-favourite-serp-easter-egg-logo branch February 6, 2026 16:57

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow setting of favourite serp easter egg logo#7467

Allow setting of favourite serp easter egg logo#7467
mikescamell merged 26 commits intodevelopfrom
feature/mike/allow-setting-of-favourite-serp-easter-egg-logo

mikescamell commented Jan 12, 2026 •

edited by cursor bot

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

anikiki left a comment

Uh oh!

Uh oh!

cursor bot left a comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

mikescamell commented Jan 12, 2026 • edited by cursor bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Steps to test this PR

UI changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

anikiki left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

cursor bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

mikescamell commented Jan 12, 2026 •

edited by cursor bot

Loading