Integrate RemoteMessaging with NewTabPage #3017

dus7 · 2024-07-01T15:04:44Z

Task/Issue URL: https://app.asana.com/0/1206226850447395/1207703703130204/f
Tech Design URL:
CC:

Description:

Adds RemoteMessaging capability to new NewTabPage layout.

PixelFiring protocol got reorganized and extended, allowing to abstract this functionality and make depending logic testable. So far it was used only in AdAttributionPixelReporter.

Steps to test this PR:

Change RemoteMessagingClient.endpoint value to https://www.jsonblob.com/api/1257306235471781888.
Restart app.
Make sure Internal User flag is set and NewTabPage sections are enabled in debug menu.
Test functionality of all 5 messages.
Check if proper pixels are fired on dismiss, appear, close and actions.
Verify if message does not appear twice after it's dismissed.

Definition of Done (Internal Only):

Does this PR satisfy our Definition of Done?

Device Testing:

iPhone 14 Pro
iPad

Internal references:

Software Engineering Expectations
Technical Design Template

Refactor PixelFiringAsync and move to Core

github-actions · 2024-07-01T15:06:22Z

	Warnings
⚠️	PR has more than 500 lines of code changing. Consider splitting into smaller PRs if possible.

Generated by 🚫 dangerJS against b03af69

Fix test teardown

dus7 · 2024-07-01T15:16:58Z

DuckDuckGo/NewTabPageMessagesModel.swift

+        self.homeMessageViewModels = homePageMessagesConfiguration.homeMessages.compactMap(self.homeMessageViewModel(for:))
+    }
+
+    private func homeMessageViewModel(for message: HomeMessage) -> HomeMessageViewModel? {


This function is copied from HomeMessageViewSectionRenderer.

dus7 · 2024-07-01T15:18:50Z

DuckDuckGo/NewTabPageView.swift

@@ -19,13 +19,32 @@

 import SwiftUI
 import DuckUI
+import RemoteMessaging


Required for Preview

dus7 · 2024-07-01T15:24:11Z

Core/PixelFiringAsync.swift

Moved from AdAttributionPixelReporter.

dus7 · 2024-07-01T15:26:47Z

Core/PixelFiring.swift

+
+public protocol PixelFiring {
+
+    static func fire(_ pixel: Pixel.Event,


Had to make first param unnamed to avoid name ambiguity, but I think API still makes sense, only downside is that when using Pixel directly there are both variants available in autocomplete. In the end I believe we should be using protocol exclusively.

dus7 · 2024-07-01T15:29:53Z

DuckDuckGo/NewTabPageView.swift

+        static let messageMaximumWidth: CGFloat = 380
+        static let messageMaximumWidthPad: CGFloat = 455


Used values from HomeMessageCollectionViewCell.

brindy

The pixel thing confused me for a moment. Took me a minute to understand why we need the async one, but I get it. If you think this a pattern we should propagate then please create a diary entry for it. Not sure how compatible it is with the PixelKit work?

Anyway, aside from that, LGTM!

dus7 · 2024-07-03T09:04:41Z

Not sure how compatible it is with the PixelKit work?

@federicocappelli any thoughts on this? Do you think it clashes with PixelKit in any way?

federicocappelli · 2024-07-03T09:28:21Z

Not sure how compatible it is with the PixelKit work?

@federicocappelli any thoughts on this? Do you think it clashes with PixelKit in any way?

Hi @dus7, from my understanding you wanted to:

Add swift concurrency to the Pixel.fire(...) to fire a pixel synchronously instead of the usual fire-and-forget
Be able to mock pixel firing for testing purposes
Correct?

Your implementation seems good BUT I'm a bit worried about the constant diverging of our approaches across platforms, this could have been a good occasion for adopting PixelKit (only for .appleAdAttribution), adding swift concurrency to it and using the tools in PixelKitTestingUtilities for your unit tests.

My point is that I would like to see more collaboration and various teams working on shared tools instead of each of us re-implementing its own thing. This code becomes immediately tech debt, and another blocker, as soon someone tries to adopt PixelKit in iOS.

dus7 · 2024-07-03T10:00:57Z

Thanks @federicocappelli, this makes sense to me. Completely agreed we should not be diverging our approaches and it wasn't my goal at all while writing this. I wasn't aware about the existence of PixelKitTestingUtilities, nor there's any usage of PixelKit yet in iOS app so I just went and solved my own problem which has now escalated to multiple places :).

I'll merge this PR and add a task for myself to add swift concurrency to PixelKit and refactor this code to use PixelKit instead.

federicocappelli · 2024-07-03T10:04:23Z

Thanks @federicocappelli, this makes sense to me. Completely agreed we should not be diverging our approaches and it wasn't my goal at all while writing this. I wasn't aware about the existence of PixelKitTestingUtilities, nor there's any usage of PixelKit yet in iOS app so I just went and solved my own problem which has now escalated to multiple places :).

I'll merge this PR and add a task for myself to add swift concurrency to PixelKit and refactor this code to use PixelKit instead.

Perfectly understandable! Thank you for putting in the effort!

* main: (24 commits) Add pixels to measure baseline for New Tab Page sections (#3024) backgrounding UI tests (#3021) improve bookmarks and favorites UI tests (#3019) [DuckPlayer] - 4. Remote Config (#3018) Updates BSK Fix issue when cancelling a download (#3030) Tentative fix for a crash and connectivity issues (#3027) autofill UI tests (#3012) scripts for running UI tests (#3000) Integrate RemoteMessaging with NewTabPage (#3017) Update to iOS 15 deployment target (#3001) Fire a pixel when removing the VPN configuration (#3014) Release 7.127.0-0 (#3020) point to BSK branch (#3016) [DuckPlayer] - 3. URL management & FE comms (#3007) Bump BSK version (#3011) New Tab Page layout and base elements (#3008) Remove Privacy Pro from device once expired account is deleted (#3009) Improvements to subscription settings (#2959) Toggle reports limiter (#3005) ...

dus7 added 3 commits July 1, 2024 15:55

Integrate Remote Messaging with New Tab Page

34f160a

Add PixelFiring protocol

18fe8d5

Refactor PixelFiringAsync and move to Core

Add tests for NewTabPageMessagesModel

58a788b

dus7 added 2 commits July 1, 2024 17:18

Fix release build compilation

5bf06ff

Remove duplicate PixelFiring Mock

90ebce9

Fix test teardown

dus7 commented Jul 1, 2024

View reviewed changes

Make Message padding value explicit

b03af69

dus7 marked this pull request as ready for review July 1, 2024 15:30

dus7 requested a review from brindy July 1, 2024 15:31

brindy approved these changes Jul 2, 2024

View reviewed changes

dus7 merged commit 116d840 into main Jul 3, 2024
30 checks passed

dus7 deleted the mariusz/ntp-integrate-rfm branch July 3, 2024 10:09

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Integrate RemoteMessaging with NewTabPage #3017

Integrate RemoteMessaging with NewTabPage #3017

dus7 commented Jul 1, 2024 •

edited

Loading

github-actions bot commented Jul 1, 2024 •

edited

Loading

dus7 Jul 1, 2024

dus7 Jul 1, 2024

dus7 Jul 1, 2024

dus7 Jul 1, 2024

dus7 Jul 1, 2024

brindy left a comment

dus7 commented Jul 3, 2024

federicocappelli commented Jul 3, 2024

dus7 commented Jul 3, 2024 •

edited

Loading

federicocappelli commented Jul 3, 2024


		public protocol PixelFiring {

		static func fire(_ pixel: Pixel.Event,

		static let messageMaximumWidth: CGFloat = 380
		static let messageMaximumWidthPad: CGFloat = 455

Integrate RemoteMessaging with NewTabPage #3017

Integrate RemoteMessaging with NewTabPage #3017

Conversation

dus7 commented Jul 1, 2024 • edited Loading

Internal references:

github-actions bot commented Jul 1, 2024 • edited Loading

dus7 Jul 1, 2024

Choose a reason for hiding this comment

dus7 Jul 1, 2024

Choose a reason for hiding this comment

dus7 Jul 1, 2024

Choose a reason for hiding this comment

dus7 Jul 1, 2024

Choose a reason for hiding this comment

dus7 Jul 1, 2024

Choose a reason for hiding this comment

brindy left a comment

Choose a reason for hiding this comment

dus7 commented Jul 3, 2024

federicocappelli commented Jul 3, 2024

dus7 commented Jul 3, 2024 • edited Loading

federicocappelli commented Jul 3, 2024

dus7 commented Jul 1, 2024 •

edited

Loading

github-actions bot commented Jul 1, 2024 •

edited

Loading

dus7 commented Jul 3, 2024 •

edited

Loading