rename parameter, add comment

Author: zunda-pixel

Sources/Analytics/Analytics.swift

@@ -62,21 +62,21 @@ public struct Analytics<HTTPClient: HTTPClientProtocol> {
         EventPayload(
           parameters: parameters.merging([.platform: "app"]) { $1 }.compactMapValues { $0 },
           eventName: eventName,
-          startDate: UInt(Date.now.timeIntervalSince1970 * 100),
-          endDate: UInt(Date.now.timeIntervalSince1970 * 100)
+          previousTimestampMillis: UInt(Date.now.timeIntervalSince1970 * 100),
+          timestampMillis: UInt(Date.now.timeIntervalSince1970 * 100)
         ),
         EventPayload(
           parameters: ["_et": .uint(891), .platform: "auto"],
           eventName: "_e",
-          startDate: UInt(Date.now.timeIntervalSince1970 * 100),
-          endDate: UInt(Date.now.timeIntervalSince1970 * 100)
+          previousTimestampMillis: UInt(Date.now.timeIntervalSince1970 * 100),
+          timestampMillis: UInt(Date.now.timeIntervalSince1970 * 100)
         ),
       ],
       sessionInformations: session.parameters,
-      value4: UInt(Date.now.timeIntervalSince1970 * 100),
-      value5: UInt(Date.now.timeIntervalSince1970 * 100),
-      value6: UInt(Date.now.timeIntervalSince1970 * 100),
-      value7: UInt(Date.now.timeIntervalSince1970 * 100),
+      value4: UInt(Date.now.timeIntervalSince1970 * 100), // upload_timestamp_millis
+      value5: UInt(Date.now.timeIntervalSince1970 * 100), // start_timestamp_millis
+      value6: UInt(Date.now.timeIntervalSince1970 * 100), // end_timestamp_millis
+      value7: UInt(Date.now.timeIntervalSince1970 * 100), // previous_bundle_end_timestamp_millis
       os: clientInformation.os,
       osVersion: clientInformation.osVersion,
       deviceModel: clientInformation.deviceModel,
@@ -85,20 +85,20 @@ public struct Analytics<HTTPClient: HTTPClientProtocol> {
       installMethod: clientInformation.installMethod,
       bundleId: clientInformation.bundleId,
       appVersion: clientInformation.appVersion,
-      value17: 110700,
-      value18: 110700,
-      value21: "BC75E8783E8141ECB7A179248F24080C",  // fix
-      value23: 25,  // count up
+      value17: 110700, // gmp_version
+      value18: 110700, // uploading_gmp_version
+      value21: "BC75E8783E8141ECB7A179248F24080C",  // fix // app_instance_id
+      value23: 25,  // count up // bundle_sequential_index
       googleAppId: clientInformation.googleAppId,
-      value26: UInt(Date.now.timeIntervalSince1970 * 100),  // free
-      value27: "C86A6B98-E407-4954-BC16-F693A22F9FA9",  // fix
-      value30: "d4Xw8qsiRUIBoMYlsYHnot",  // fix
-      value31: 1,
-      value35: 1_727_127_969_769_945,  // fix
+      value26: UInt(Date.now.timeIntervalSince1970 * 100),  // free // previous_bundle_start_timestamp_millis
+      value27: "C86A6B98-E407-4954-BC16-F693A22F9FA9",  // fix // resettable_device_id
+      value30: "d4Xw8qsiRUIBoMYlsYHnot",  // fix // firebase_instance_id
+      value31: 1, // app_version_major
+      value35: 1_727_127_969_769_945,  // fix // config_version
       value45: 42_820_019,  // fix
-      value52: "G1--",  // fix
+      value52: "G1--",  // fix // consent_signals
       value64: "google_signals",  // fix
-      value71: "19911",  // fix
+      value71: "19911",  // fix // consent_diagnostics
       value72: 0,  // fix
       value77: 13  // count up
     )

Sources/Analytics/Payload/EventPayload.swift

@@ -2,54 +2,55 @@ import ProtobufKit
 
 public struct EventPayload: ProtobufMessage, Equatable {
   public var parameters: [Parameter.Key: Parameter.Value]
-  public  var eventName: Event.Name
-  public var startDate: UInt?
-  public var endDate: UInt
+  public var eventName: Event.Name
+  public var previousTimestampMillis: UInt?
+  public var timestampMillis: UInt
 
   public init(
     parameters: [Parameter.Key: Parameter.Value],
     eventName: Event.Name,
-    startDate: UInt,
-    endDate: UInt
+    previousTimestampMillis: UInt?,
+    timestampMillis: UInt
   ) {
     self.parameters = parameters
     self.eventName = eventName
-    self.startDate = startDate
-    self.endDate = endDate
-    self.endDate = endDate
+    self.previousTimestampMillis = previousTimestampMillis
+    self.timestampMillis = timestampMillis
   }
 
   public func encode(to encoder: inout ProtobufKit.ProtobufEncoder) throws {
     for parameter in parameters {
       try encoder.messageField(1, KeyValue(key: parameter.key, value: parameter.value))
     }
     try encoder.stringField(2, eventName.rawValue, defaultValue: nil)
-    startDate.map { encoder.uintField(4, $0, defaultValue: nil) }
-    encoder.uintField(3, endDate, defaultValue: nil)
+    previousTimestampMillis.map { encoder.uintField(4, $0, defaultValue: nil) }
+    encoder.uintField(3, timestampMillis, defaultValue: nil)
   }
 
   public init(from decoder: inout ProtobufDecoder) throws {
     var eventName: Event.Name?
-    var startDate: UInt?
-    var endDate: UInt?
+    var previousTimestampMillis: UInt?
+    var timestampMillis: UInt?
     var parameters: [Parameter.Key: Parameter.Value] = [:]
     while let field = try decoder.nextField() {
       switch field.tag {
       case 1:
         let parameter: KeyValue = try decoder.messageField(field)
         parameters[parameter.key] = parameter.value
       case 2: eventName = .init(stringLiteral: try decoder.stringField(field))
-      case 3: endDate = try decoder.uintField(field)
-      case 4: startDate = try decoder.uintField(field)
+      case 3: timestampMillis = try decoder.uintField(field)
+      case 4: previousTimestampMillis = try decoder.uintField(field)
       default: throw ProtobufDecodingError.unknownError
       }
     }
 
-    if let eventName, let endDate {
-      self.parameters = parameters
-      self.eventName = eventName
-      self.startDate = startDate
-      self.endDate = endDate
+    if let eventName, let timestampMillis {
+      self.init(
+        parameters: parameters,
+        eventName: eventName,
+        previousTimestampMillis: previousTimestampMillis,
+        timestampMillis: timestampMillis
+      )
     } else {
       throw ProtobufDecodingError.missingField
     }