Investigate integrating MEP library in iOS
Closed, ResolvedPublic
Actions

Assigned To

Authored By

	LGoto
	Jul 16 2020, 10:23 PM

Description

The initial client PR has two pieces needed for us to connect this end-to-end: implementation of the NetworkManager protocol and implementation of the StorageManager protocol. The expected functionality of these is defined well in the EventPlatformClientProtocols.swift file in the initial PR.

This task is to investigate and subtask out if necessary the implementation of these portions. If possible I think it would be nice to lean on existing functionality in the old event logging system for persistence and networking rather than reinventing the wheel. Analytics has confirmed that the design of NetworkManager and StorageManager can be changed if needed for this. If we can reuse some components from the old system, maybe we should duplicate that code so that the original event logging library remains untouched for better regression testing.

If it's not reusable, we should have a solid understanding of how the old system works and document any deltas to be aware of with how things are stored and the network is used in the old system vs. the new system.

Related Objects
Search...

Status	Assigned	Task
Open	None	T282003 Metrics Platform: Streamline the process to create new instrumentations
Declined	None	T259734 BUOD-KR1-Q4+: Certify that analytics schema and instruments have been upgraded to use the MEP system (clearing the legacy system for sunsetting)
Declined	Ottomata	T259157 BUOD-KR1-Q3: Require that all new schema/instruments are created with the MEP system
Declined	None	T259704 BUOD-KR1-Q2: Upgrade MEP clients to full release status
Resolved	kzimmerman	T259169 BUOD-KR1-Q1: Pilot MEP clients with 2 product teams
Resolved	mpopov	T259709 MEP instrument/schema pilot #1 (EditHistoryCompare)
Open	None	T276378 EPIC: Release Metrics Platform v1
Resolved	• DAbad	T281997 Metrics Platform: Centralize code location and organization
Resolved	• jlinehan	T280182 Consolidate Metrics Platform client libraries into mediawiki/libs/metrics-platform
Open	None	T228175 Event Platform Client Libraries
Resolved	• Mholloway	T239996 Send batches of events from EPC app libraries (Java, Swift)
Open	None	T281768 Incorporate librarized Metrics Platform Swift client into the iOS app
Open	None	T281770 Ensure that the Swift client library can be included via SwiftPM
Resolved	• Mholloway	T281758 Consolidate Metrics Platform Swift client into mediawiki/libs/metrics-platform
Open	None	T261987 MEP Client iOS (Revision)
Resolved	mpopov	T228180 MEP Client iOS (MVP)
Resolved	Tsevener	T258228 Investigate integrating MEP library in iOS
Resolved	Tsevener	T259271 Implement NetworkManager in MEP
Resolved	phuedx	T281772 [EPIC] Incorporate librarized Metrics Platform Java client into the Android app
Resolved	cjming	T281773 Publish librarized Metrics Platform Java client to Maven
Resolved	• Mholloway	T281757 Conslidate Metrics Platform Java client into mediawiki/libs/metrics-platform
Resolved	cjming	T318934 Extend the Java MPC to detect session inactivity
Resolved	cjming	T318935 Refactor Java MPC's event sending code
Resolved	cjming	T318947 Add dispatch method to Java MPC
Resolved	cjming	T318948 Refactor Java MPC's stream config fetching code

Event Timeline

LGoto created this task.Jul 16 2020, 10:23 PM

Tsevener updated the task description. (Show Details)Jul 17 2020, 6:49 PM

LGoto moved this task from Triage to Tracking on the Product-Analytics board.Jul 20 2020, 4:08 PM

LGoto triaged this task as Medium priority.Jul 20 2020, 6:34 PM

LGoto moved this task from Needs Triage to Engineering Backlog on the Wikipedia-iOS-App-Backlog board.

LGoto added a project: iOS-app-v6.7-Bonefish-On-A-Bus.

LGoto moved this task from Tasks from Product Backlog to Needs Engineering Sync on the iOS-app-v6.7-Bonefish-On-A-Bus board.

Tsevener claimed this task.Jul 22 2020, 4:43 PM

Tsevener moved this task from Needs Engineering Sync to Doing on the iOS-app-v6.7-Bonefish-On-A-Bus board.

Tsevener moved this task from Doing to Blocked or Waiting on the iOS-app-v6.7-Bonefish-On-A-Bus board.Jul 30 2020, 4:17 PM

Moving this to waiting - work will be done against subtasks.

Tsevener moved this task from Blocked or Waiting to Epics In Progress on the iOS-app-v6.7-Bonefish-On-A-Bus board.Jul 30 2020, 4:21 PM

Besides being disabled when the app enters background (loggingEnabled = false) should also be disabled if user isn't sharing usage data with us. Right now that's not taken into consideration by the library directly, but perhaps it should (just like how existing EventLogging respects that setting).

@Tsevener: What do you think about StorageManager having a sharingUsageData property that can be accessed in EPC's log() (like how it accesses deviceID)? We could then perform a check either at the top of log() (so the event doesn't even make it into the input buffer if the user is opted out) or at the bottom, right before the event is given to NetworkManager for POSTing.

@mpopov sure sounds good, I'll make that change.

@mpopov PR has been updated - ready for your end-to-end testing & review of my stuff! Then we'll take it back and have one of the other engineers review. We should also pick a feature to convert at that time. Also I noticed some deltas with the old library as I was using some of that logic. I documented them in the task description here in case you have any input on that. At the very least it could explain some discrepancies we see once this goes out.

mpopov closed subtask T259271: Implement NetworkManager in MEP as Resolved.Sep 2 2020, 1:38 PM

mpopov closed subtask T259269: Implement StorageManager in MEP as Resolved.

LGoto moved this task from Epics In Progress to Ready for PM Signoff on the iOS-app-v6.7-Bonefish-On-A-Bus board.Sep 22 2020, 6:25 PM

Congrats on taking step 1 with us y'all!

• Mholloway reopened subtask T259269: Implement StorageManager in MEP as Open.Oct 29 2020, 5:21 PM

• Mholloway removed a subtask: T259269: Implement StorageManager in MEP.