refactor: move endpoint host resolution to Swift

mParticle-Apple-SDK-Swift/Sources/Network/MPEndpointHostResolver.swift

@@ -0,0 +1,29 @@
+import Foundation
+
+@objc public final class MPEndpointHostResolver: NSObject {
+    @objc(defaultHostWithSubdomain:apiKey:)
+    public static func defaultHost(subdomain: String, apiKey: String?) -> String {
+        let podPrefix = apiKey?.components(separatedBy: "-") ?? []
+        guard podPrefix.count > 1 else {
+            return "\(subdomain).us1.mparticle.com"
+        }
+        return "\(subdomain).\(podPrefix[0]).mparticle.com"
+    }
+
+    @objc(resolvedHostWithCustomBaseURLHost:trackingHost:host:defaultHost:attAuthorized:)
+    public static func resolvedHost(
+        customBaseURLHost: String?,
+        trackingHost: String?,
+        host: String?,
+        defaultHost: String,
+        attAuthorized: Bool
+    ) -> String {
+        if let customBaseURLHost {
+            return customBaseURLHost
+        }
+        if let trackingHost, attAuthorized {
+            return trackingHost
+        }
+        return host ?? defaultHost
+    }
+}

mParticle-Apple-SDK-Swift/Test/Network/MPEndpointHostResolverTests.swift

@@ -0,0 +1,107 @@
+import XCTest
+@testable import mParticle_Apple_SDK_Swift
+
+final class MPEndpointHostResolverTests: XCTestCase {
+    // MARK: - Pod routing
+
+    func testDefaultHostUsesThePodPrefixFromTheAPIKey() {
+        XCTAssertEqual(
+            MPEndpointHostResolver.defaultHost(subdomain: "nativesdks", apiKey: "eu1-0123456789abcdef"),
+            "nativesdks.eu1.mparticle.com"
+        )
+    }
+
+    func testDefaultHostFallsBackToUS1ForAKeyWithoutAPrefix() {
+        XCTAssertEqual(
+            MPEndpointHostResolver.defaultHost(subdomain: "identity", apiKey: "0123456789abcdef"),
+            "identity.us1.mparticle.com"
+        )
+    }
+
+    func testDefaultHostFallsBackToUS1ForNilAndEmptyKeys() {
+        XCTAssertEqual(
+            MPEndpointHostResolver.defaultHost(subdomain: "nativesdks", apiKey: nil),
+            "nativesdks.us1.mparticle.com"
+        )
+        XCTAssertEqual(
+            MPEndpointHostResolver.defaultHost(subdomain: "nativesdks", apiKey: ""),
+            "nativesdks.us1.mparticle.com"
+        )
+    }
+
+    func testDefaultHostTakesOnlyTheFirstSegmentOfAMultiHyphenKey() {
+        XCTAssertEqual(
+            MPEndpointHostResolver.defaultHost(subdomain: "tracking-identity", apiKey: "us2-abc-def"),
+            "tracking-identity.us2.mparticle.com"
+        )
+    }
+
+    func testDefaultHostKeepsAnEmptyLeadingSegment() {
+        XCTAssertEqual(
+            MPEndpointHostResolver.defaultHost(subdomain: "nativesdks", apiKey: "-abc"),
+            "nativesdks..mparticle.com"
+        )
+    }
+
+    func testDefaultHostAppliesTheTrackingSubdomainVerbatim() {
+        XCTAssertEqual(
+            MPEndpointHostResolver.defaultHost(subdomain: "tracking-nativesdks", apiKey: "us1-key"),
+            "tracking-nativesdks.us1.mparticle.com"
+        )
+    }
+
+    // MARK: - Precedence ladder
+
+    func testCustomBaseURLHostWinsOverEveryOtherOption() {
+        XCTAssertEqual(
+            MPEndpointHostResolver.resolvedHost(
+                customBaseURLHost: "cdn.example.com",
+                trackingHost: "tracking.example.com",
+                host: "host.example.com",
+                defaultHost: "default.mparticle.com",
+                attAuthorized: true
+            ),
+            "cdn.example.com"
+        )
+    }
+
+    func testTrackingHostIsUsedOnlyWhenATTIsAuthorized() {
+        XCTAssertEqual(resolved(trackingHost: "tracking.example.com", attAuthorized: true), "tracking.example.com")
+        XCTAssertEqual(resolved(trackingHost: "tracking.example.com", attAuthorized: false), "default.mparticle.com")
+    }
+
+    func testHostIsUsedWhenThereIsNoApplicableTrackingHost() {
+        XCTAssertEqual(resolved(host: "host.example.com", attAuthorized: false), "host.example.com")
+        XCTAssertEqual(
+            resolved(trackingHost: "tracking.example.com", host: "host.example.com", attAuthorized: false),
+            "host.example.com"
+        )
+    }
+
+    func testDefaultHostIsTheLastResort() {
+        XCTAssertEqual(resolved(), "default.mparticle.com")
+    }
+
+    func testAnEmptyHostOverridesTheDefaultRatherThanFallingThrough() {
+        XCTAssertEqual(resolved(host: ""), "")
+        XCTAssertEqual(resolved(trackingHost: "", attAuthorized: true), "")
+        XCTAssertEqual(resolved(customBaseURLHost: ""), "")
+    }
+
+    // MARK: - Helpers
+
+    private func resolved(
+        customBaseURLHost: String? = nil,
+        trackingHost: String? = nil,
+        host: String? = nil,
+        attAuthorized: Bool = false
+    ) -> String {
+        MPEndpointHostResolver.resolvedHost(
+            customBaseURLHost: customBaseURLHost,
+            trackingHost: trackingHost,
+            host: host,
+            defaultHost: "default.mparticle.com",
+            attAuthorized: attAuthorized
+        )
+    }
+}

mParticle-Apple-SDK.xcodeproj/project.pbxproj

@@ -584,6 +584,7 @@
 			membershipExceptions = (
 				Test/Identity/MPIdentityDTOTests.swift,
 				Test/Identity/MPUserIdentityChangeTests.m,
+				Test/Network/MPEndpointHostResolverTests.swift,
 				Test/Network/MPRequestSignerTests.swift,
 				Test/Network/MPURLRequestPlanTests.swift,
 				Test/Notifications/MPDeviceTokenStoreTests.swift,
@@ -634,6 +635,7 @@
 			membershipExceptions = (
 				Test/Identity/MPIdentityDTOTests.swift,
 				Test/Identity/MPUserIdentityChangeTests.m,
+				Test/Network/MPEndpointHostResolverTests.swift,
 				Test/Network/MPRequestSignerTests.swift,
 				Test/Network/MPURLRequestPlanTests.swift,
 				Test/Notifications/MPDeviceTokenStoreTests.swift,

mParticle-Apple-SDK/Network/MPNetworkCommunication.m

@@ -116,30 +116,22 @@ - (instancetype)init {
 #pragma mark Private accessors
 
 - (NSString *)defaultHostWithSubdomain:(NSString *)subdomain apiKey:(NSString *)apiKey {
-    NSArray *splitKey = [apiKey componentsSeparatedByString:@"-"];
-    if (splitKey.count <= 1) {
-        // Handle case with no prefix, default to US1 (old keys)
-        return [NSString stringWithFormat:@"%@.us1.mparticle.com", subdomain];
-    }
-    return [NSString stringWithFormat:@"%@.%@.mparticle.com", subdomain, splitKey[0]];
+    return [MPEndpointHostResolver defaultHostWithSubdomain:subdomain apiKey:apiKey];
 }
 
-- (NSString *)defaultEventHost {
+- (BOOL)attAuthorized {
     MPStateMachine_PRIVATE *stateMachine = [MParticle sharedInstance].stateMachine;
-    if (stateMachine.attAuthorizationStatus.integerValue == MPATTAuthorizationStatusAuthorized) {
-        return [self defaultHostWithSubdomain:kMPURLHostEventTrackingSubdomain apiKey:stateMachine.apiKey];
-    } else {
-        return [self defaultHostWithSubdomain:kMPURLHostEventSubdomain apiKey:stateMachine.apiKey];
-    }
+    return stateMachine.attAuthorizationStatus.integerValue == MPATTAuthorizationStatusAuthorized;
+}
+
+- (NSString *)defaultEventHost {
+    NSString *subdomain = [self attAuthorized] ? kMPURLHostEventTrackingSubdomain : kMPURLHostEventSubdomain;
+    return [self defaultHostWithSubdomain:subdomain apiKey:[MParticle sharedInstance].stateMachine.apiKey];
 }
 
 - (NSString *)defaultIdentityHost {
-    MPStateMachine_PRIVATE *stateMachine = [MParticle sharedInstance].stateMachine;
-    if (stateMachine.attAuthorizationStatus.integerValue == MPATTAuthorizationStatusAuthorized) {
-        return [self defaultHostWithSubdomain:kMPURLHostIdentityTrackingSubdomain apiKey:stateMachine.apiKey];
-    } else {
-        return [self defaultHostWithSubdomain:kMPURLHostIdentitySubdomain apiKey:stateMachine.apiKey];
-    }
+    NSString *subdomain = [self attAuthorized] ? kMPURLHostIdentityTrackingSubdomain : kMPURLHostIdentitySubdomain;
+    return [self defaultHostWithSubdomain:subdomain apiKey:[MParticle sharedInstance].stateMachine.apiKey];
 }
 
 - (MPURL *)configURL {
@@ -159,7 +151,11 @@ - (MPURL *)configURL {
     if (customHost && networkOptions.configHost) {
         MPILogWarning(@"MPNetworkOptions: customBaseURL is set; configHost is ignored.");
     }
-    NSString *configHost = customHost ?: (networkOptions.configHost ?: kMPURLHostConfig);
+    NSString *configHost = [MPEndpointHostResolver resolvedHostWithCustomBaseURLHost:customHost
+                                                                       trackingHost:nil
+                                                                               host:networkOptions.configHost
+                                                                        defaultHost:kMPURLHostConfig
+                                                                      attAuthorized:NO];
 
     NSString *dataPlanConfigString;
     NSString *dataPlanId = MParticle.sharedInstance.dataPlanId;
@@ -203,12 +199,11 @@ - (MPURL *)configURL {
 
 - (MPURL *)eventURLForUpload:(MPUpload *)mpUpload {
     MPUploadSettings *uploadSettings = (MPUploadSettings *)mpUpload.uploadSettings;
-    NSString *eventHost;
-    if (uploadSettings.eventsTrackingHost && [MParticle sharedInstance].stateMachine.attAuthorizationStatus.integerValue == MPATTAuthorizationStatusAuthorized) {
-        eventHost = uploadSettings.eventsTrackingHost;
-    } else {
-        eventHost = uploadSettings.eventsHost ?: self.defaultEventHost;
-    }
+    NSString *eventHost = [MPEndpointHostResolver resolvedHostWithCustomBaseURLHost:nil
+                                                                      trackingHost:uploadSettings.eventsTrackingHost
+                                                                              host:uploadSettings.eventsHost
+                                                                       defaultHost:self.defaultEventHost
+                                                                     attAuthorized:[self attAuthorized]];
     NSString *urlString = [NSString stringWithFormat:urlFormat, kMPURLScheme, self.defaultEventHost, kMPEventsVersion, uploadSettings.apiKey, kMPEventsURL];
     NSURL *defaultURL = [NSURL URLWithString:urlString];
 
@@ -239,7 +234,11 @@ - (MPURL *)audienceURL {
     if (customHost && networkOptions.eventsHost) {
         MPILogWarning(@"MPNetworkOptions: customBaseURL is set; eventsHost is ignored.");
     }
-    NSString *eventHost = customHost ?: (networkOptions.eventsHost ?: self.defaultEventHost);
+    NSString *eventHost = [MPEndpointHostResolver resolvedHostWithCustomBaseURLHost:customHost
+                                                                      trackingHost:nil
+                                                                              host:networkOptions.eventsHost
+                                                                       defaultHost:self.defaultEventHost
+                                                                     attAuthorized:NO];
     NSString *audienceURLFormat = [audienceFormat stringByAppendingString:@"?mpid=%@"];
     NSString *urlString = [NSString stringWithFormat:audienceURLFormat, kMPURLScheme, self.defaultEventHost, kMPAudienceVersion, stateMachine.apiKey, kMPAudienceURL, [MPPersistenceController_PRIVATE mpId]];
     NSURL *defaultURL = [NSURL URLWithString:urlString];
@@ -299,21 +298,16 @@ - (MPURL *)logoutURL {
 }
 
 - (MPURL *)identityURL:(NSString *)pathComponent {
-    MParticle *mParticle = [MParticle sharedInstance];
-    MPStateMachine_PRIVATE *stateMachine = mParticle.stateMachine;
-    MPNetworkOptions *identityNetworkOptions = mParticle.networkOptions;
+    MPNetworkOptions *identityNetworkOptions = [MParticle sharedInstance].networkOptions;
     NSString *identityCustomHost = identityNetworkOptions.customBaseURL.host;
-    NSString *identityHost;
-    if (identityCustomHost) {
-        if (identityNetworkOptions.identityHost || identityNetworkOptions.identityTrackingHost) {
-            MPILogWarning(@"MPNetworkOptions: customBaseURL is set; identityHost/identityTrackingHost are ignored.");
-        }
-        identityHost = identityCustomHost;
-    } else if (identityNetworkOptions.identityTrackingHost && stateMachine.attAuthorizationStatus.integerValue == MPATTAuthorizationStatusAuthorized) {
-        identityHost = identityNetworkOptions.identityTrackingHost;
-    } else {
-        identityHost = identityNetworkOptions.identityHost ?: self.defaultIdentityHost;
-    }
+    if (identityCustomHost && (identityNetworkOptions.identityHost || identityNetworkOptions.identityTrackingHost)) {
+        MPILogWarning(@"MPNetworkOptions: customBaseURL is set; identityHost/identityTrackingHost are ignored.");
+    }
+    NSString *identityHost = [MPEndpointHostResolver resolvedHostWithCustomBaseURLHost:identityCustomHost
+                                                                         trackingHost:identityNetworkOptions.identityTrackingHost
+                                                                                 host:identityNetworkOptions.identityHost
+                                                                          defaultHost:self.defaultIdentityHost
+                                                                        attAuthorized:[self attAuthorized]];
     NSString *urlString = [NSString stringWithFormat:identityURLFormat, kMPURLScheme, self.defaultIdentityHost, kMPIdentityVersion, pathComponent];
     NSURL *defaultURL = [NSURL URLWithString:urlString];
 
@@ -341,21 +335,16 @@ - (MPURL *)identityURL:(NSString *)pathComponent {
 
 - (MPURL *)modifyURL {
     NSString *pathComponent = @"modify";
-    MParticle *mParticle = [MParticle sharedInstance];
-    MPStateMachine_PRIVATE *stateMachine = mParticle.stateMachine;
-    MPNetworkOptions *modifyNetworkOptions = mParticle.networkOptions;
+    MPNetworkOptions *modifyNetworkOptions = [MParticle sharedInstance].networkOptions;
     NSString *modifyCustomHost = modifyNetworkOptions.customBaseURL.host;
-    NSString *identityHost;
-    if (modifyCustomHost) {
-        if (modifyNetworkOptions.identityHost || modifyNetworkOptions.identityTrackingHost) {
-            MPILogWarning(@"MPNetworkOptions: customBaseURL is set; identityHost/identityTrackingHost are ignored.");
-        }
-        identityHost = modifyCustomHost;
-    } else if (modifyNetworkOptions.identityTrackingHost && stateMachine.attAuthorizationStatus.integerValue == MPATTAuthorizationStatusAuthorized) {
-        identityHost = modifyNetworkOptions.identityTrackingHost;
-    } else {
-        identityHost = modifyNetworkOptions.identityHost ?: self.defaultIdentityHost;
-    }
+    if (modifyCustomHost && (modifyNetworkOptions.identityHost || modifyNetworkOptions.identityTrackingHost)) {
+        MPILogWarning(@"MPNetworkOptions: customBaseURL is set; identityHost/identityTrackingHost are ignored.");
+    }
+    NSString *identityHost = [MPEndpointHostResolver resolvedHostWithCustomBaseURLHost:modifyCustomHost
+                                                                         trackingHost:modifyNetworkOptions.identityTrackingHost
+                                                                                 host:modifyNetworkOptions.identityHost
+                                                                          defaultHost:self.defaultIdentityHost
+                                                                        attAuthorized:[self attAuthorized]];
     NSString *urlString = [NSString stringWithFormat:modifyURLFormat, kMPURLScheme, self.defaultIdentityHost, kMPIdentityVersion, [MPPersistenceController_PRIVATE mpId],  pathComponent];
     NSURL *defaultURL = [NSURL URLWithString:urlString];
 
@@ -385,12 +374,11 @@ - (MPURL *)aliasURLForUpload:(MPUpload *)mpUpload {
     MPUploadSettings *uploadSettings = (MPUploadSettings *)mpUpload.uploadSettings;
     NSString *pathComponent = @"alias";
 
-    NSString *eventHost;
-    if (uploadSettings.aliasTrackingHost && [MParticle sharedInstance].stateMachine.attAuthorizationStatus.integerValue == MPATTAuthorizationStatusAuthorized) {
-        eventHost = uploadSettings.aliasTrackingHost;
-    } else {
-        eventHost = uploadSettings.aliasHost ?: self.defaultEventHost;
-    }
+    NSString *eventHost = [MPEndpointHostResolver resolvedHostWithCustomBaseURLHost:nil
+                                                                      trackingHost:uploadSettings.aliasTrackingHost
+                                                                              host:uploadSettings.aliasHost
+                                                                       defaultHost:self.defaultEventHost
+                                                                     attAuthorized:[self attAuthorized]];
     NSString *urlString = [NSString stringWithFormat:aliasURLFormat, kMPURLScheme, self.defaultEventHost, kMPIdentityVersion, kMPIdentityKey, uploadSettings.apiKey, pathComponent];
     NSURL *defaultURL = [NSURL URLWithString:urlString];