Merge pull request #17 from instana/feature/update_max_length_for_values

Do not drop values longer than max allowed length.

Author: tapwork

.swiftpm/xcode/xcshareddata/xcschemes/InstanaAgentIntegrationTests.xcscheme

@@ -32,6 +32,9 @@
                <Test
                   Identifier = "BasicIntegrationServerTest">
                </Test>
+               <Test
+                  Identifier = "BeaconTests">
+               </Test>
                <Test
                   Identifier = "CoreBeaconExtensionsTests">
                </Test>
@@ -44,6 +47,9 @@
                <Test
                   Identifier = "CustomBeaconTests">
                </Test>
+               <Test
+                  Identifier = "DefaultIgnoredURLsTests">
+               </Test>
                <Test
                   Identifier = "FramerateDropMonitorTests">
                </Test>

Sources/InstanaAgent/Beacons/Beacons Types/Beacon.swift

@@ -2,14 +2,15 @@ import Foundation
 
 /// Base class for Beacon.
 class Beacon {
+
     let id = UUID()
     var timestamp: Instana.Types.Milliseconds = Date().millisecondsSince1970
     let viewName: String?
 
     init(timestamp: Instana.Types.Milliseconds = Date().millisecondsSince1970,
          viewName: String? = nil) {
         self.timestamp = timestamp
-        self.viewName = viewName
+        self.viewName = InstanaProperties.validate(view: viewName)
     }
 }
 

Sources/InstanaAgent/Beacons/Beacons Types/CustomBeacon.swift

@@ -17,19 +17,19 @@ class CustomBeacon: Beacon {
     let duration: Instana.Types.Milliseconds?
     let backendTracingID: String?
     let error: Error?
-    let meta: [String: String]?
+    let metaData: MetaData?
 
     init(timestamp: Instana.Types.Milliseconds? = nil,
          name: String,
          duration: Instana.Types.Milliseconds? = nil,
          backendTracingID: String? = nil,
          error: Error? = nil,
-         meta: [String: String]? = nil,
+         metaData: MetaData? = nil,
          viewName: String? = CustomBeaconDefaultViewNameID) {
         self.duration = duration
         self.name = name
         self.error = error
-        self.meta = meta
+        self.metaData = metaData
         self.backendTracingID = backendTracingID
         var start = Date().millisecondsSince1970
         if let duration = duration {

Sources/InstanaAgent/Beacons/Beacons Types/HTTPBeacon.swift

@@ -1,6 +1,8 @@
 import Foundation
 
 class HTTPBeacon: Beacon {
+    static let maxLengthURL: Int = 4096
+
     let duration: Instana.Types.Milliseconds
     let method: String
     let url: URL
@@ -22,7 +24,8 @@ class HTTPBeacon: Beacon {
         let path = !url.path.isEmpty ? url.path : nil
         self.duration = duration
         self.method = method
-        self.url = url
+        let urlString = url.absoluteString.cleanEscapeAndTruncate(at: Self.maxLengthURL, trailing: "")
+        self.url = URL(string: urlString) ?? url
         self.path = path
         self.responseCode = responseCode
         self.responseSize = responseSize

Sources/InstanaAgent/Beacons/CoreBeacon/CoreBeacon+Extensions.swift

@@ -19,34 +19,25 @@ extension CoreBeacon {
 
     func formattedKVPair(key: String, value: Any) -> String? {
         guard Mirror.isNotNil(value: value) else { return nil }
-        if let dict = value as? [AnyHashable: AnyObject] {
+        if let dict = value as? MetaData {
             return dict.asString(prefix: key)
         }
-        let value = "\(value)".cleanAndEscape()
+        let value = "\(value)".coreBeaconClean()
+        guard !value.isEmpty else { return nil }
         return "\(key)\t\(value)"
     }
 }
 
-extension Dictionary {
-    func asString(prefix: String) -> String {
-        return map {
-            let value = "\($0.value)".cleanAndEscape()
-            return "\(prefix)_\($0.key)\t\(value)"
+extension MetaData {
+    func asString(prefix: String) -> String? {
+        guard count > 0 else { return nil }
+        return compactMap {
+            guard !$0.value.isEmpty else { return nil }
+            return "\(prefix)_\($0.key)\t\($0.value.coreBeaconClean())"
         }.joined(separator: "\n")
     }
 }
 
-extension String {
-    func cleanAndEscape() -> Self {
-        var trimmed = trimmingCharacters(in: CharacterSet.whitespacesAndNewlines)
-        trimmed = trimmed.truncated(at: Int(CoreBeacon.maxBytesPerField))
-        trimmed = trimmed.replacingOccurrences(of: "\\", with: "\\\\")
-        trimmed = trimmed.replacingOccurrences(of: "\n", with: "\\n")
-        trimmed = trimmed.replacingOccurrences(of: "\t", with: "\\t")
-        return trimmed
-    }
-}
-
 extension Collection where Element == CoreBeacon {
     var asString: String { compactMap { $0.asString }.joined(separator: "\n\n") }
 }

Sources/InstanaAgent/Beacons/CoreBeacon/CoreBeacon.swift

@@ -18,12 +18,12 @@ enum BeaconType: String, Equatable, Codable, CustomStringConvertible {
 /// That means we also loose the type information, so we need treat all fields as String
 struct CoreBeacon: Codable {
     /**
-     * The max byte for each field (bytes)
+     * The max length for each field
      *
      *
      * Default: To be discussed if it can be dynamic
      */
-    static let maxBytesPerField: Instana.Types.Bytes = 10000
+    static let maxLengthPerField: Int = 16384
 
     /**
      * The type of the beacon.
@@ -113,7 +113,7 @@ struct CoreBeacon: Codable {
      *
      * optional
      */
-    var m: [String: String]?
+    var m: MetaData?
 
     /**
      * User ID

Sources/InstanaAgent/Beacons/CoreBeacon/CoreBeaconFactory.swift

@@ -43,7 +43,7 @@ extension CoreBeacon {
         ui = properties.user?.id
         un = properties.user?.name
         ue = properties.user?.email
-        m = properties.metaData
+        m = !properties.metaData.isEmpty ? properties.metaData : nil
     }
 
     mutating func append(_ beacon: HTTPBeacon) {
@@ -91,7 +91,7 @@ extension CoreBeacon {
         let useCurrentVisibleViewName = beacon.viewName == CustomBeaconDefaultViewNameID
         v = useCurrentVisibleViewName ? properties.viewNameForCurrentAppState : beacon.viewName
         cen = beacon.name
-        m = beacon.meta
+        m = beacon.metaData
         if let error = beacon.error {
             add(error: error)
         }

Sources/InstanaAgent/Configuration/InstanaProperties.swift

@@ -1,18 +1,63 @@
 import Foundation
 
+typealias MetaData = [String: String]
+
 struct InstanaProperties: Equatable {
     struct User: Equatable {
+        static let userValueMaxLength = 128
+
         /// Unique identifier for the user
-        var id: String
+        var id: String {
+            didSet { id = Self.validate(value: id) ?? id }
+        }
+
         /// User's email address
-        var email: String?
+        var email: String? {
+            didSet { email = Self.validate(value: email) }
+        }
+
         /// User's full name
-        var name: String?
+        var name: String? {
+            didSet { name = Self.validate(value: name) }
+        }
+
+        init(id: String, email: String?, name: String?) {
+            self.id = Self.validate(value: id) ?? id
+            self.email = Self.validate(value: email)
+            self.name = Self.validate(value: name)
+        }
+
+        static func validate(value: String?) -> String? {
+            guard let value = value else { return nil }
+            return value.cleanEscapeAndTruncate(at: userValueMaxLength)
+        }
     }
 
     var user: User?
-    var metaData: [String: String]?
-    var view: String?
+    private(set) var metaData = MetaData()
+
+    static let viewMaxLength = 256
+    var view: String? {
+        didSet { view = Self.validate(view: view) }
+    }
+
+    init(user: User? = nil, view: String? = nil) {
+        self.user = user
+        self.view = Self.validate(view: view)
+    }
+
+    mutating func appendMetaData(_ key: String, _ value: String) {
+        let key = MetaData.validate(key: key)
+        let value = MetaData.validate(value: value)
+        if metaData.count < MetaData.Max.numberOfMetaEntries {
+            metaData[key] = value
+        }
+    }
+
+    static func validate(view: String?) -> String? {
+        guard let value = view else { return nil }
+        return value.cleanEscapeAndTruncate(at: viewMaxLength)
+    }
 }
 
 extension InstanaProperties {
@@ -31,11 +76,6 @@ extension InstanaProperties {
 }
 
 class InstanaPropertyHandler: NSObject {
-    struct Const {
-        static let maximumNumberOfMetaDataFields = 50
-        static let maximumLengthPerMetaDataField = 256
-    }
-
     private var unsafe_properties = InstanaProperties()
     private let lock = NSLock()
     var properties: InstanaProperties {
@@ -52,21 +92,26 @@ class InstanaPropertyHandler: NSObject {
             lock.unlock()
         }
     }
+}
+
+extension MetaData {
+    struct Max {
+        static let numberOfMetaEntries = 64
+        static let lengthMetaValue = 256
+        static let lengthMetaKey = 98
+    }
 
-    func validate(value: String) -> Bool {
-        if value.count > Const.maximumLengthPerMetaDataField {
-            Instana.current?.session.logger.add("Instana: MetaData value reached maximum length (\(Const.maximumLengthPerMetaDataField)).", level: .warning)
-            return false
+    static func validate(value: String) -> String {
+        if value.count > Max.lengthMetaValue {
+            Instana.current?.session.logger.add("Instana: MetaData value reached maximum length (\(Max.lengthMetaValue)) Truncating value.", level: .warning)
         }
-        return value.count <= Const.maximumLengthPerMetaDataField
+        return value.cleanEscapeAndTruncate(at: Max.lengthMetaValue)
     }
 
-    func validate(keys: [String]) -> Bool {
-        if keys.count > Const.maximumNumberOfMetaDataFields {
-            // swiftlint:disable:next line_length
-            Instana.current?.session.logger.add("Instana: MetaData reached maximum number (\(Const.maximumNumberOfMetaDataFields)) of valid fields.", level: .warning)
-            return false
+    static func validate(key: String) -> String {
+        if key.count > Max.lengthMetaKey {
+            Instana.current?.session.logger.add("Instana: MetaData key reached maximum length (\(Max.lengthMetaKey)) Truncating key.", level: .warning)
         }
-        return true
+        return key.cleanEscapeAndTruncate(at: Max.lengthMetaKey)
     }
 }

Sources/InstanaAgent/Instana.swift

@@ -157,12 +157,7 @@ import UIKit
     @objc
     public static func setMeta(value: String, key: String) {
         guard let propertyHandler = Instana.current?.session.propertyHandler else { return }
-        guard propertyHandler.validate(value: value) else { return }
-        var metaData = propertyHandler.properties.metaData ?? [:]
-        metaData[key] = value
-        if propertyHandler.validate(keys: Array(metaData.keys)) {
-            propertyHandler.properties.metaData = metaData
-        }
+        propertyHandler.properties.appendMetaData(key, value)
     }
 
     /// User-specific information
@@ -240,7 +235,7 @@ import UIKit
                                   duration: duration,
                                   backendTracingID: backendTracingID,
                                   error: error,
-                                  meta: meta,
+                                  metaData: meta,
                                   viewName: viewName)
         Instana.current?.monitors.reporter.submit(beacon)
     }

Sources/InstanaAgent/Utils/Extensions/String+Extras.swift

@@ -1,11 +1,26 @@
 import Foundation
 
 extension String {
-    func truncated(at length: Int, trailing: String = "…") -> String {
+    func coreBeaconClean() -> String {
+        cleanEscapeAndTruncate(at: CoreBeacon.maxLengthPerField)
+    }
+
+    func cleanEscapeAndTruncate(at length: Int, trailing: String = "…") -> String {
+        return cleanEscape().maxLength(length, trailing: trailing)
+    }
+
+    func cleanEscape() -> String {
+        var trimmed = trimmingCharacters(in: CharacterSet.whitespacesAndNewlines)
+        trimmed = trimmed.replacingOccurrences(of: "\\", with: "\\\\")
+        trimmed = trimmed.replacingOccurrences(of: "\n", with: "\\n")
+        trimmed = trimmed.replacingOccurrences(of: "\t", with: "\\t")
+        return trimmed
+    }
+
+    func maxLength(_ length: Int, trailing: String = "…") -> String {
         if count <= length {
             return self
         }
-        let truncated = prefix(length)
-        return truncated + trailing
+        return String(prefix(length - trailing.count)) + trailing
     }
 }