Merge pull request #53 from adobe/staging

Promote to main for release v3.0.1

Author: PravinPK

.swiftlint.yml

@@ -14,6 +14,8 @@ disabled_rules: # rule identifiers to exclude from running
 - large_tuple
 - trailing_comma
 - type_body_length
+- weak_delegate
+- class_delegate_protocol
 opt_in_rules: # some rules are opt-in only
 - closure_end_indentation
 - convenience_type
@@ -33,6 +35,7 @@ opt_in_rules: # some rules are opt-in only
 - vertical_parameter_alignment_on_call
 excluded: # paths to ignore during linting
 - Carthage
+- AEPAssurance/UnitTests/
 - SampleApps/*/Pods
 - SampleApps/*/xdmlib
 - SampleApps/*/libs
@@ -48,4 +51,4 @@ identifier_name:
         - id
         - no
         - ok
-line_length: 1000
+line_length: 1000

AEPAssurance.podspec

@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name             = "AEPAssurance"
-  s.version          = "3.0.0"
+  s.version          = "3.0.1"
   s.summary          = "AEPAssurance SDK for Adobe Experience Platform Mobile SDK. Written and maintained by Adobe."
 
   s.description      = <<-DESC

AEPAssurance.xcodeproj/project.pbxproj

@@ -28,7 +28,6 @@ public class Assurance: NSObject, Extension {
 
     let datastore = NamedCollectionDataStore(name: AssuranceConstants.EXTENSION_NAME)
     var assuranceSession: AssuranceSession?
-    var shouldProcessEvents: Bool = true
     var timer: DispatchSourceTimer?
 
     var sessionId: String? {
@@ -88,6 +87,7 @@ public class Assurance: NSObject, Extension {
         /// and do not turn on the unregister timer
         if connectedWebSocketURL != nil {
             shareState()
+            Log.trace(label: AssuranceConstants.LOG_TAG, "Assurance Session was already connected during previous app launch. Attempting to reconnect. URL : \(String(describing: connectedWebSocketURL))")
             assuranceSession?.startSession()
             return
         }
@@ -127,6 +127,9 @@ public class Assurance: NSObject, Extension {
             return stateEvents
         }
 
+        // add the eventHub shared state data to the list of shared state events
+        stateEvents.append(prepareSharedStateEvent(owner: AssuranceConstants.SharedStateName.EVENT_HUB, eventName: "EventHub State", stateContent: registeredExtension, stateType: AssuranceConstants.PayloadKey.SHARED_STATE_DATA))
+
         for (extensionName, _) in extensionsMap {
             let friendlyName = getFriendlyExtensionName(extensionMap: extensionsMap, extensionName: extensionName)
             stateEvents.append(contentsOf: getStateForExtension(stateOwner: extensionName, friendlyName: friendlyName))
@@ -146,7 +149,7 @@ public class Assurance: NSObject, Extension {
             handleAssuranceRequestContent(event: event)
         }
 
-        if !shouldProcessEvents {
+        guard let session = assuranceSession, session.canProcessSDKEvents else {
             return
         }
 
@@ -157,7 +160,7 @@ public class Assurance: NSObject, Extension {
 
         // forward all events to Assurance session
         let assuranceEvent = AssuranceEvent.from(event: event)
-        assuranceSession?.sendEvent(assuranceEvent)
+        session.sendEvent(assuranceEvent)
 
         if event.isPlacesRequestEvent {
             handlePlacesRequest(event: event)
@@ -192,14 +195,15 @@ public class Assurance: NSObject, Extension {
         // Read the environment query parameter from the deeplink url
         let environmentString = deeplinkURL?.params[AssuranceConstants.Deeplink.ENVIRONMENT_KEY] ?? ""
 
-        // invalidate the timer        
+        // invalidate the timer
         invalidateTimer()
 
         // save the environment and sessionID
         environment = AssuranceEnvironment.init(envString: environmentString)
         self.sessionId = sessionId
         shareState()
-        shouldProcessEvents = true
+
+        Log.trace(label: AssuranceConstants.LOG_TAG, "Received sessionID, Initializing Assurance session. \(sessionId)")
         assuranceSession?.startSession()
     }
 
@@ -232,7 +236,7 @@ public class Assurance: NSObject, Extension {
                 }
                 assuranceSession?.addClientLog("\t  \(poiDictionary["regionname"] as? String ?? "Unknown")", visibility: .high)
             }
-            assuranceSession?.addClientLog("Places - Found \(nearByPOIs.count) nearby POIs\(nearByPOIs.count > 0 ? " :" : ".")", visibility: .high)
+            assuranceSession?.addClientLog("Places - Found \(nearByPOIs.count) nearby POIs\(!nearByPOIs.isEmpty ? " :" : ".")", visibility: .high)
         }
     }
 
@@ -283,7 +287,7 @@ public class Assurance: NSObject, Extension {
     /// Start the shutdown timer in the background queue without blocking the current thread.
     /// If the timer get fired, then it shuts down the assurance extension.
     private func startShutDownTimer() {
-        Log.debug(label: AssuranceConstants.LOG_TAG, "Assurance shutdown timer started. Waiting for 5 seconds to receive assurance session url.");
+        Log.debug(label: AssuranceConstants.LOG_TAG, "Assurance shutdown timer started. Waiting for 5 seconds to receive assurance session url.")
         let queue = DispatchQueue.init(label: "com.adobe.assurance.shutdowntimer", qos: .background)
         timer = createDispatchTimer(queue: queue, block: {
             self.shutDownAssurance()
@@ -294,11 +298,10 @@ public class Assurance: NSObject, Extension {
     /// are listened by assurance extension
     /// @see readyForEvent
     private func shutDownAssurance() {
-        shouldProcessEvents = false
         Log.debug(label: AssuranceConstants.LOG_TAG, "Timeout - Assurance extension did not receive session url. Shutting down from processing any further events.")
         invalidateTimer()
         Log.debug(label: AssuranceConstants.LOG_TAG, "Clearing the queued events and purging Assurance shared state.")
-        self.assuranceSession?.clearQueueEvents()
+        self.assuranceSession?.shutDownSession()
         clearState()
     }
 

AEPAssurance/Source/Assurance.swift

@@ -13,7 +13,7 @@
 import AEPServices
 import Foundation
 
-struct AssuranceBlob {
+enum AssuranceBlob {
 
     static let HTTPS_SCHEME = "https"
     static let HOST_FORMAT = "blob%@.griffon.adobe.com"
@@ -57,15 +57,18 @@ struct AssuranceBlob {
         let headers = [HttpConstants.HTTP_HEADER_KEY_ACCEPT: HttpConstants.HTTP_HEADER_CONTENT_TYPE_JSON_APPLICATION,
                        HttpConstants.HTTP_HEADER_KEY_CONTENT_TYPE: HTTP_HEADER_VALUE_OCTET_STREAM,
                        HTTP_HEADER_KEY_FILE_CONTENT_TYPE: contentType]
-
-        let networkRequest = NetworkRequest(url: components.url!,
+        guard let url = components.url else {
+            Log.warning(label: AssuranceConstants.LOG_TAG, "Invalid blob url. Unable to send blob data.")
+            return
+        }
+        let networkRequest = NetworkRequest(url: url,
                                             httpMethod: HttpMethod.post,
                                             connectPayloadData: blob,
                                             httpHeaders: headers,
                                             connectTimeout: CONNECTION_TIMEOUT,
                                             readTimeout: CONNECTION_TIMEOUT)
 
-        Log.debug(label: AssuranceConstants.LOG_TAG, "Uploading blob data to URL : \(components.url!.absoluteString)")
+        Log.debug(label: AssuranceConstants.LOG_TAG, "Uploading blob data to URL : \(url.absoluteString)")
         ServiceProvider.shared.networkService.connectAsync(networkRequest: networkRequest, completionHandler: { connection in
             handleNetworkResponse(connection: connection, callback: callback)
         })

AEPAssurance/Source/AssuranceBlob.swift

@@ -15,7 +15,7 @@ import CoreLocation
 import Foundation
 import UIKit
 
-struct AssuranceClientInfo {
+enum AssuranceClientInfo {
 
     static let PLATFORM_NAME = "Canonical platform name"
     static let DEVICE_NAME = "Device name"
@@ -54,7 +54,7 @@ struct AssuranceClientInfo {
         return appSettingsInDictionary
     }
 
-    ///- Returns: A `Dictionary` with the required device information
+    /// - Returns: A `Dictionary` with the required device information
     private static func readDeviceInfo() -> [String: Any] {
         let systemInfoService = ServiceProvider.shared.systemInfoService
 
@@ -77,7 +77,7 @@ struct AssuranceClientInfo {
     /// Battery level ranges from 0 (fully discharged) to 100 (fully charged).
     /// For simulator where the battery levels are not available -1 is returned.
     ///
-    ///- Returns: An `Int` representing the battery level of the device
+    /// - Returns: An `Int` representing the battery level of the device
     private static func getBatteryLevel() -> Int {
         let batteryPercentage = Int(UIDevice.current.batteryLevel * 100)
         return (batteryPercentage) > 0 ? batteryPercentage : -1

AEPAssurance/Source/AssuranceClientInfo.swift

@@ -22,6 +22,7 @@ enum AssuranceConnectionError {
     case orgIDMismatch
     case connectionLimit
     case eventLimit
+    case deletedSession
     case clientError
     case userCancelled
 
@@ -40,11 +41,11 @@ enum AssuranceConnectionError {
             return ("Socket Connection Error",
                     "Unable to form a valid socket URL for connection.", false)
         case .noOrgId:
-            return ("Invalid Launch & SDK Configuration",
-                    "The Experience Cloud Org identifier is unavailable from SDK configuration. Please ensure the Launch mobile property is properly configured.", false)
+            return (" Invalid Mobile SDK Configuration",
+                    "The Experience Cloud organization identifier is unavailable. Ensure SDK configuration is setup correctly. See documentation for more detail.", false)
         case .orgIDMismatch:
             return ("Unauthorized Access",
-                    "The Experience Cloud organization for this Launch Property does not match that of the AEP Assurance session", false)
+                    "The Experience Cloud organization identifier does not match with that of the Assurance session. Ensure the right Experience Cloud organization is being used. See documentation for more detail.", false)
         case .connectionLimit:
             return ("Connection Limit Reached",
                     "You have reached the maximum number of connected device (50) allowed to a session.", false)
@@ -53,6 +54,9 @@ enum AssuranceConnectionError {
                     "You have reached the maximum number of events (10k) that can be sent per minute.", false)
         // todo immediate:  check with the team on better description.
         // todo later:  have griffon server return error description and how to solve... Same for connection & event limit errors
+        case .deletedSession:
+            return ("Session Deleted",
+                    "You attempted to connect to a deleted session.", false)
         case .clientError:
             return ("Client Disconnected",
                     "This client has been disconnected due to an unexpected error. Error Code 4400.", false)

AEPAssurance/Source/AssuranceConnectionError.swift

@@ -15,7 +15,7 @@ import Foundation
 enum AssuranceConstants {
     static let EXTENSION_NAME = "com.adobe.assurance"
     static let FRIENDLY_NAME = "Assurance"
-    static let EXTENSION_VERSION = "3.0.0"
+    static let EXTENSION_VERSION = "3.0.1"
     static let LOG_TAG = FRIENDLY_NAME
     static let DEFAULT_ENVIRONMENT = AssuranceEnvironment.prod
 
@@ -38,19 +38,19 @@ enum AssuranceConstants {
     }
 
     enum SDKEventName {
-        static let SHARED_STATE_CHANGE    = "Shared state change"
-        static let XDM_SHARED_STATE_CHANGE    = "Shared state change (XDM)"
+        static let SHARED_STATE_CHANGE = "Shared state change"
+        static let XDM_SHARED_STATE_CHANGE = "Shared state change (XDM)"
     }
 
     enum SDKEventType {
         static let ASSURANCE = "com.adobe.eventType.assurance"
     }
 
     enum PluginFakeEvent {
-        static let NAME    = "eventName"
-        static let TYPE    = "eventType"
-        static let SOURCE  = "eventSource"
-        static let DATA    = "eventData"
+        static let NAME = "eventName"
+        static let TYPE = "eventType"
+        static let SOURCE = "eventSource"
+        static let DATA = "eventData"
     }
 
     // todo verify the impact of making these keys AEPExtensionEvent*
@@ -59,8 +59,8 @@ enum AssuranceConstants {
         static let TYPE    = "ACPExtensionEventType"
         static let SOURCE  = "ACPExtensionEventSource"
         static let DATA    = "ACPExtensionEventData"
-        static let TIMESTAMP    = "ACPExtensionEventTimestamp"
-        static let NUMBER    = "ACPExtensionEventNumber"
+        static let TIMESTAMP = "ACPExtensionEventTimestamp"
+        static let NUMBER = "ACPExtensionEventNumber"
         static let UNIQUE_IDENTIFIER = "ACPExtensionEventUniqueIdentifier"
         static let RESPONSE_IDENTIFIER = "ACPExtensionEventResponseIdentifier" // todo new key introduced : convey to UI team
     }
@@ -106,21 +106,21 @@ enum AssuranceConstants {
     enum HTMLURLPath {
         static let CANCEL   = "cancel"
         static let CONFIRM  = "confirm"
-        static let DISCONNECT  = "disconnect"
+        static let DISCONNECT = "disconnect"
     }
 
     enum ClientInfoKeys {
-        static let TYPE  = "type"
-        static let VERSION   = "version"
-        static let DEVICE_INFO  = "deviceInfo"
-        static let APP_SETTINGS  = "appSettings"
+        static let TYPE = "type"
+        static let VERSION = "version"
+        static let DEVICE_INFO = "deviceInfo"
+        static let APP_SETTINGS = "appSettings"
     }
 
     enum CommandType {
-        static let START_EVENT_FORWARDING  = "startEventForwarding"
-        static let CONFIG_UPDATE  = "configUpdate"
-        static let FAKE_EVENT  = "fakeEvent"
-        static let SCREENSHOT  = "screenshot"
+        static let START_EVENT_FORWARDING = "startEventForwarding"
+        static let CONFIG_UPDATE = "configUpdate"
+        static let FAKE_EVENT = "fakeEvent"
+        static let SCREENSHOT = "screenshot"
         static let LOG_FORWARDING = "logForwarding"
         static let WILDCARD = "wildcard"
     }
@@ -131,6 +131,7 @@ enum AssuranceConstants {
         static let ORG_MISMATCH = 4900
         static let CONNECTION_LIMIT = 4901
         static let EVENTS_LIMIT = 4902
+        static let DELETED_SESSION = 4903
         static let CLIENT_ERROR = 4400
     }
 
@@ -158,4 +159,21 @@ enum AssuranceConstants {
             static let NEARBY_POI = "nearbypois"
         }
     }
+
+    enum AssuranceEvent {
+        /// The maximum size of an event that can get through the socket is 32KB.
+        /// The factor 0.75 is introduced to accommodate blowing up of size due to the mandatory base64 encoding of AssuranceEvent before sending through the socket.
+        static let SIZE_LIMIT = (Int) ((32 * 1024) * 0.75)
+
+        enum PayloadKey {
+            static let CHUNK_DATA = "chunkData"
+        }
+
+        enum MetadataKey {
+            static let CHUNK_ID = "chunkId"
+            static let CHUNK_SEQUENCE = "chunkSequenceNumber"
+            static let CHUNK_TOTAL = "chunkTotal"
+        }
+    }
+
 }

AEPAssurance/Source/AssuranceConstants.swift

@@ -14,13 +14,19 @@ import AEPCore
 import AEPServices
 import Foundation
 
+/// Event object used to transport data to/from Assurance server.
+///
+/// This object is intentionally opaque (internal). If this needs to be public,
+/// refactor this class to reflect a builder pattern enforcing size limits on
+/// constituents of the AssuranceEvent like metadata.
 struct AssuranceEvent: Codable {
     var eventID: String = UUID().uuidString
     var vendor: String
     var type: String
     var payload: [String: AnyCodable]?
     var eventNumber: Int32?
     var timestamp: Date?
+    var metadata: [String: AnyCodable]?
 
     /// Decodes a JSON data into a `AssuranceEvent`
     ///
@@ -91,12 +97,13 @@ struct AssuranceEvent: Codable {
     ///   - payload: A dictionary representing the payload to be sent wrapped in the event. This will be serialized into JSON in the transportation process
     ///   - timestamp: optional argument representing the time original event was created. If not provided current time is taken
     ///   - vendor: vendor for the created `AssuranceEvent` defaults to "com.adobe.griffon.mobile".
-    init(type: String, payload: [String: AnyCodable]?, timestamp: Date = Date(), vendor: String = AssuranceConstants.Vendor.MOBILE) {
+    init(type: String, payload: [String: AnyCodable]?, timestamp: Date = Date(), vendor: String = AssuranceConstants.Vendor.MOBILE, metadata: [String: AnyCodable]? = nil) {
         self.type = type
         self.payload = payload
         self.timestamp = timestamp
         self.vendor = vendor
         self.eventNumber = AssuranceEvent.generateEventNumber()
+        self.metadata = metadata
     }
 
     /// Returns the type of the command. Applies only for command events. This method returns nil for all other `AssuranceEvent`s.
@@ -157,8 +164,15 @@ struct AssuranceEvent: Codable {
             "  payload: \(PrettyDictionary.prettify(payload))\n" +
             "  eventNumber: \(String(describing: eventNumber))\n" +
             "  timestamp: \(String(describing: timestamp?.description))\n" +
+            "  metadata: \(PrettyDictionary.prettify(metadata))\n" +
             "]"
         // swiftformat:enable indent
     }
 
+    var jsonData: Data {
+        let encoder = JSONEncoder()
+        encoder.dateEncodingStrategy = .millisecondsSince1970
+        return (try? encoder.encode(self)) ?? Data()
+    }
+
 }