Merge pull request #56 from hotwired/user-agent-prefix

Breaking API change: applications can set a User-Agent prefix

Demo/AppDelegate.swift

@@ -20,6 +20,9 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
             .file(Bundle.main.url(forResource: "path-configuration", withExtension: "json")!)
         ])
 
+        // Set an optional custom user agent application prefix.
+        Hotwire.config.applicationUserAgentPrefix = "Hotwire Demo;"
+
         // Register bridge components
         Hotwire.registerBridgeComponents([
             FormComponent.self,

Source/Bridge/UserAgent.swift

@@ -1,8 +1,15 @@
 import Foundation
 
-public enum UserAgent {
-    public static func userAgentSubstring(for componentTypes: [BridgeComponent.Type]) -> String {
+enum UserAgent {
+    static func build(applicationPrefix: String?, componentTypes: [BridgeComponent.Type]) -> String {
         let components = componentTypes.map { $0.name }.joined(separator: " ")
-        return "bridge-components: [\(components)]"
+        let componentsSubstring = "bridge-components: [\(components)]"
+
+        return [
+            applicationPrefix,
+            "Hotwire Native iOS;",
+            "Turbo Native iOS;",
+            componentsSubstring
+        ].compactMap { $0 }.joined(separator: " ")
     }
 }

Source/Hotwire.swift

@@ -9,7 +9,6 @@ public enum Hotwire {
     /// Use `Hotwire.config.makeCustomWebView` to customize the web view or web view
     /// configuration further, making sure to call `Bridge.initialize()`.
     public static func registerBridgeComponents(_ componentTypes: [BridgeComponent.Type]) {
-        Hotwire.config.userAgent += " \(UserAgent.userAgentSubstring(for: componentTypes))"
         bridgeComponentTypes = componentTypes
 
         Hotwire.config.makeCustomWebView = { configuration in

Source/HotwireConfig.swift

@@ -4,10 +4,16 @@ import WebKit
 public struct HotwireConfig {
     public typealias WebViewBlock = (_ configuration: WKWebViewConfiguration) -> WKWebView
 
-    /// Override to set a custom user agent.
-    /// - Important: Include "Hotwire Native" or "Turbo Native" to use `turbo_native_app?`
-    /// on your Rails server.
-    public var userAgent = "Hotwire Native iOS; Turbo Native iOS"
+    /// Set a custom user agent application prefix for every WKWebView instance.
+    ///
+    /// The library will automatically append a substring to your prefix
+    /// which includes:
+    /// - "Hotwire Native iOS; Turbo Native iOS;"
+    /// - "bridge-components: [your bridge components];"
+    ///
+    /// WKWebView's default user agent string will also appear at the
+    /// beginning of the user agent.
+    public var applicationUserAgentPrefix: String? = nil
 
     /// When enabled, adds a `UIBarButtonItem` of type `.done` to the left
     /// navigation bar button item on screens presented modally.
@@ -73,7 +79,10 @@ public struct HotwireConfig {
     private func makeWebViewConfiguration() -> WKWebViewConfiguration {
         let configuration = WKWebViewConfiguration()
         configuration.defaultWebpagePreferences?.preferredContentMode = .mobile
-        configuration.applicationNameForUserAgent = userAgent
+        configuration.applicationNameForUserAgent = UserAgent.build(
+            applicationPrefix: applicationUserAgentPrefix,
+            componentTypes: Hotwire.bridgeComponentTypes
+        )
         configuration.processPool = sharedProcessPool
         return configuration
     }

Tests/Bridge/UserAgentTests.swift

@@ -1,15 +1,29 @@
 import Foundation
-import HotwireNative
+@testable import HotwireNative
 import XCTest
 
 class UserAgentTests: XCTestCase {
+    func testUserAgentSubstringWithNoComponents() {
+        let userAgentSubstring = UserAgent.build(
+            applicationPrefix: nil,
+            componentTypes: []
+        )
+        XCTAssertEqual(userAgentSubstring, "Hotwire Native iOS; Turbo Native iOS; bridge-components: []")
+    }
+
     func testUserAgentSubstringWithTwoComponents() {
-        let userAgentSubstring = UserAgent.userAgentSubstring(for: [OneBridgeComponent.self, TwoBridgeComponent.self])
-        XCTAssertEqual(userAgentSubstring, "bridge-components: [one two]")
+        let userAgentSubstring = UserAgent.build(
+            applicationPrefix: nil,
+            componentTypes: [OneBridgeComponent.self, TwoBridgeComponent.self]
+        )
+        XCTAssertEqual(userAgentSubstring, "Hotwire Native iOS; Turbo Native iOS; bridge-components: [one two]")
     }
 
-    func testUserAgentSubstringWithNoComponents() {
-        let userAgentSubstring = UserAgent.userAgentSubstring(for: [])
-        XCTAssertEqual(userAgentSubstring, "bridge-components: []")
+    func testUserAgentSubstringCustomPrefix() {
+        let userAgentSubstring = UserAgent.build(
+            applicationPrefix: "Hotwire Demo;",
+            componentTypes: [OneBridgeComponent.self, TwoBridgeComponent.self]
+        )
+        XCTAssertEqual(userAgentSubstring, "Hotwire Demo; Hotwire Native iOS; Turbo Native iOS; bridge-components: [one two]")
     }
 }