metrics-platform
Closed, ResolvedPublic
Actions

Assigned To

Authored By

	• Mholloway
	May 3 2021, 8:55 PM

Details

	Subject	Repo	Branch	Lines +/-
	[Swift] Support adding context values based on stream config	mediawiki/libs/metrics-platform	master	+558 -0
	[Swift] Add Swift client library	mediawiki/libs/metrics-platform	master	+1 K -1

Customize query in gerrit

Related Objects
Search...

Status	Subtype	Assigned	Task
Open		None	T228175 Event Platform Client Libraries
Open		None	T282003 Metrics Platform: Streamline the process to create new instrumentations
Resolved		• Mholloway	T239996 Send batches of events from EPC app libraries (Java, Swift)
Open		None	T276378 EPIC: Release Metrics Platform v1
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		• DAbad	T281997 Metrics Platform: Centralize code location and organization
Resolved		• jlinehan	T280182 Consolidate Metrics Platform client libraries into mediawiki/libs/metrics-platform
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		mpopov	T259714 Test schema and stream for analytics events
Resolved	BUG REPORT	• Mholloway	T259917 Streams with empty configs should be rendered as {} in the JSON returned by StreamConfig API
Resolved		SNowick_WMF	T264193 Investigate differences in counts between legacy & modern-v1 Edit History Compare events
Resolved		• Mholloway	T259269 Implement StorageManager in MEP
Resolved	Spike	• Mholloway	T281002 [SPIKE] Investigate metrics platform test inconsistencies in iOS
Resolved		• Mholloway	T284195 Add a Swift image to Wikimedia's docker registry for testing

Event Timeline

• Mholloway triaged this task as Medium priority.May 3 2021, 8:55 PM

• Mholloway created this task.

• Mholloway renamed this task from Conslidate Metrics Platform Swfit client into mediawiki/libs/metrics-platform to Conslidate Metrics Platform Swift client into mediawiki/libs/metrics-platform.May 3 2021, 9:07 PM

• Mholloway added a parent task: T281770: Ensure that the Swift client library can be included via SwiftPM.

• Mholloway added a subtask: T261987: MEP Client iOS (Revision).May 13 2021, 8:40 PM

• Mholloway claimed this task.May 26 2021, 10:36 PM

• Mholloway moved this task from Backlog to Discussed on the Metrics Platform Backlog board.

• Mholloway moved this task from Inbox to Doing on the Product-Data-Infrastructure board.

• Mholloway added a subtask: T284195: Add a Swift image to Wikimedia's docker registry for testing.Jun 2 2021, 10:20 PM

https://github.com/wikimedia/wikipedia-ios/pull/3991

Aklapper renamed this task from Conslidate Metrics Platform Swift client into mediawiki/libs/metrics-platform to Consolidate Metrics Platform Swift client into mediawiki/libs/metrics-platform.Jun 30 2021, 9:32 PM

• Mholloway moved this task from Doing to Reviewing on the Product-Data-Infrastructure board.Jul 13 2021, 1:47 PM

• Mholloway moved this task from Discussed to QA/Review on the Metrics Platform Backlog board.

Change 703012 had a related patch set uploaded (by Mholloway; author: Michael Holloway):

[mediawiki/libs/metrics-platform@master] Add Swift client library

https://gerrit.wikimedia.org/r/703012

gerritbot added a project: Patch-For-Review.Jul 15 2021, 1:50 PM

• Mholloway closed subtask T284195: Add a Swift image to Wikimedia's docker registry for testing as Resolved.Jul 15 2021, 1:56 PM

• Mholloway moved this task from Reviewing to Doing on the Product-Data-Infrastructure board.Aug 2 2021, 4:15 PM

• Mholloway moved this task from QA/Review to Discussed on the Metrics Platform Backlog board.Aug 2 2021, 4:40 PM

Work continues apace: https://gerrit.wikimedia.org/r/q/project:mediawiki%252Flibs%252Fmetrics-platform+status:open

Change 713927 had a related patch set uploaded (by Mholloway; author: Michael Holloway):

[mediawiki/libs/metrics-platform@master] [WIP] [Swift] Support adding context values based on stream config

https://gerrit.wikimedia.org/r/713927

Current status on the WIP patch: the SerializedSwift library for serializing objects to/from JSON had seemed to be working well, but I've found a bug in it that needs to be resolved if we want to more forward with it. The bug is that null values are explicitly serialized as { "property": null } rather than being omitted, which is the default in GSON, which inspired SerializedSwift, and which is what we want. I believe it's a bug because the intention in the code is pretty clearly that these values be omitted.

After some debugging, I've identified what I think is the issue, which is that the value wrapped by the @Serialized property wrapper is always being interpreted as non-optional (and therefore nonnull), even when the value it is in fact a nil-valued Optional. This can be seen by debugging any unit test that involves serializing a null field, such as testInheritance; the wrappedValue getter for optionals is never used, even for the nil-valued boo field.

What I don't understand is how this even makes sense or compiles, or how to fix it. We'll likely have to pull in someone with deeper knowledge of Swift.

After discussing this with Toni I decided to drop the library and just implement this using the standard Codable/CodingKeys approach, which is a bit more boilerplate code but is working great. That change is reflected in the lastest patch set.