Update API with device id

.gitignore

@@ -2,3 +2,4 @@
 Package.resolved
 .swiftpm
 .build
+Resources/config.json

Package.swift

@@ -4,16 +4,19 @@ import PackageDescription
 let package = Package(
     name: "SesameServer",
     platforms: [
-       .macOS(.v10_15)
+       .macOS(.v12)
     ],
     dependencies: [
         .package(url: "https://github.com/vapor/vapor.git", from: "4.0.0"),
+        .package(url: "https://github.com/christophhagen/clairvoyant.git", from: "0.5.0"),
     ],
     targets: [
         .target(
             name: "App",
             dependencies: [
-                .product(name: "Vapor", package: "vapor")
+                .product(name: "Vapor", package: "vapor"),
+                .product(name: "Clairvoyant", package: "Clairvoyant"),
+
             ],
             swiftSettings: [
                 // Enable better optimizations when building in Release configuration. Despite the use of

Resources/config_example.json

@@ -0,0 +1,6 @@
+{
+    "port": 6003,
+    "keyFileName": "keys",
+    "deviceTimeout": 20,
+    "authenticationTokens" : [],
+}

Resources/keys

@@ -1,2 +0,0 @@
-0000000000000000000000000000000000000000000000000000000000000000
-0000000000000000000000000000000000000000000000000000000000000000

Sources/App/API/DeviceResponse.swift

@@ -54,13 +54,13 @@ struct DeviceResponse {
      the remaining bytes contain the message.
      - Parameter buffer: The buffer where the message bytes are stored
      */
-    init?(_ buffer: ByteBuffer) {
+    init?(_ buffer: ByteBuffer, request: String) {
         guard let byte = buffer.getBytes(at: 0, length: 1) else {
-            print("No bytes received from device")
+            log("\(request): No bytes received from device")
             return nil
         }
         guard let event = MessageResult(rawValue: byte[0]) else {
-            print("Unknown response \(byte[0]) received from device")
+            log("\(request): Unknown response \(byte[0]) received from device")
             return nil
         }
         self.event = event

Sources/App/API/Message.swift

@@ -29,6 +29,14 @@ struct Message: Equatable, Hashable {
     }
 }
 
+extension Message: Codable {
+
+    enum CodingKeys: Int, CodingKey {
+        case mac = 1
+        case content = 2
+    }
+}
+
 extension Message {
 
     /**
@@ -42,14 +50,17 @@ extension Message {
         /// The counter of the message (for freshness)
         let id: UInt32
 
+        let deviceId: UInt8?
+
         /**
          Create new message content.
          - Parameter time: The time of message creation,
          - Parameter id: The counter of the message
          */
-        init(time: UInt32, id: UInt32) {
+        init(time: UInt32, id: UInt32, device: UInt8) {
             self.time = time
             self.id = id
+            self.deviceId = device
         }
 
         /**
@@ -61,20 +72,29 @@ extension Message {
          */
         init<T: Sequence>(decodeFrom data: T) where T.Element == UInt8 {
             self.time = UInt32(data: Data(data.prefix(MemoryLayout<UInt32>.size)))
-            self.id = UInt32(data: Data(data.dropFirst(MemoryLayout<UInt32>.size)))
+            self.id = UInt32(data: Data(data.dropLast().suffix(MemoryLayout<UInt32>.size)))
+            self.deviceId = data.suffix(1).last!
         }
 
         /// The byte length of an encoded message content
         static var length: Int {
-            MemoryLayout<UInt32>.size * 2
+            MemoryLayout<UInt32>.size * 2 + 1
         }
 
         /// The message content encoded to data
         var encoded: Data {
-            time.encoded + id.encoded
+            time.encoded + id.encoded + Data([deviceId ?? 0])
         }
     }
+}
 
+extension Message.Content: Codable {
+
+    enum CodingKeys: Int, CodingKey {
+        case time = 1
+        case id = 2
+        case deviceId = 3
+    }
 }
 
 extension Message {
@@ -96,6 +116,14 @@ extension Message {
         self.init(decodeFrom: data)
     }
 
+    init?(decodeFrom data: Data, index: inout Int) {
+        guard index + Message.length <= data.count else {
+            return nil
+        }
+        self.init(decodeFrom: data.advanced(by: index))
+        index += Message.length
+    }
+
     /// The message encoded to data
     var encoded: Data {
         mac + content.encoded

Sources/App/API/MessageResult.swift

@@ -26,6 +26,9 @@ enum MessageResult: UInt8 {
     /// The key was accepted by the device, and the door will be opened
     case messageAccepted = 7
 
+    /// The device id is invalid
+    case messageDeviceInvalid = 8
+
 
     /// The request did not contain body data with the key
     case noBodyData = 10
@@ -61,6 +64,8 @@ extension MessageResult: CustomStringConvertible {
             return "Message counter invalid"
         case .messageAccepted:
             return "Message accepted"
+        case .messageDeviceInvalid:
+            return "Invalid device ID"
         case .noBodyData:
             return "No body data included in the request"
         case .deviceNotConnected:

Sources/App/Config.swift

@@ -3,11 +3,41 @@ import Foundation
 struct Config {
 
     /// The port where the server runs
-    static let port = 6003
+    let port: Int
 
     /// The name of the file in the `Resources` folder containing the device authentication token
-    static let keyFileName = "keys"
+    let keyFileName: String
 
     /// The seconds to wait for a response from the device
-    static let deviceTimeout: Int64 = 20
+    let deviceTimeout: Int64
+
+    /// The authentication tokens to use for monitoring of the service
+    let authenticationTokens: Set<String>
+}
+
+extension Config: Codable {
+
+}
+
+extension Config {
+
+    init(loadFrom url: URL) throws {
+        guard FileManager.default.fileExists(atPath: url.path) else {
+            log("No configuration file found at \(url.path)")
+            fatalError("No configuration file found")
+        }
+        let data: Data
+        do {
+            data = try Data(contentsOf: url)
+        } catch {
+            log("Failed to read config data: \(error)")
+            throw error
+        }
+        do {
+            self = try JSONDecoder().decode(Config.self, from: data)
+        } catch {
+               log("Failed to decode config data: \(error)")
+               throw error
+           }
+    }
 }

Sources/App/DeviceManager.swift

@@ -1,6 +1,7 @@
 import Foundation
 import WebSocketKit
 import Vapor
+import Clairvoyant
 
 final class DeviceManager {
 
@@ -17,6 +18,12 @@ final class DeviceManager {
     var deviceIsAuthenticated = false
 
     private var isOpeningNewConnection = false
+
+    private let deviceTimeout: Int64
+
+    private let deviceConnectedMetric: Metric<Bool>
+
+    private let messagesToDeviceMetric: Metric<Int>
     
     /// Indicator for device availability
     var deviceIsConnected: Bool {
@@ -26,9 +33,31 @@ final class DeviceManager {
     /// A promise to finish the request once the device responds or times out
     private var requestInProgress: EventLoopPromise<DeviceResponse>?
     
-    init(deviceKey: Data, remoteKey: Data) {
+    init(deviceKey: Data, remoteKey: Data, deviceTimeout: Int64) async {
         self.deviceKey = deviceKey
         self.remoteKey = remoteKey
+        self.deviceTimeout = deviceTimeout
+        self.deviceConnectedMetric = try! await .init(
+            "sesame.connected",
+            name: "Device connected",
+            description: "Shows if the device is connected via WebSocket")
+        self.messagesToDeviceMetric = try! await .init(
+            "sesame.messages",
+            name: "Forwarded Messages",
+            description: "The number of messages transmitted to the device")
+    }
+
+    private func updateDeviceConnectionMetric() {
+        Task {
+            try? await deviceConnectedMetric.update(deviceIsConnected)
+        }
+    }
+
+    private func updateMessageCountMetric() {
+        Task {
+            let lastValue = await messagesToDeviceMetric.lastValue()?.value ?? 0
+            try? await messagesToDeviceMetric.update(lastValue + 1)
+        }
     }
     
     // MARK: API
@@ -45,27 +74,30 @@ final class DeviceManager {
         guard requestInProgress == nil else {
             return eventLoop.makeSucceededFuture(.operationInProgress)
         }
-        requestInProgress = eventLoop.makePromise(of: DeviceResponse.self)
+        let result = eventLoop.makePromise(of: DeviceResponse.self)
+        self.requestInProgress = result
         socket.send(message.bytes, promise: nil)
-        eventLoop.scheduleTask(in: .seconds(Config.deviceTimeout)) { [weak self] in
+        updateMessageCountMetric()
+        eventLoop.scheduleTask(in: .seconds(deviceTimeout)) { [weak self] in
             guard let promise = self?.requestInProgress else {
                 return
             }
             self?.requestInProgress = nil
             promise.succeed(.deviceTimedOut)
         }
-        return requestInProgress!.futureResult
+        return result.futureResult
     }
     
     func authenticateDevice(hash: String) {
+        defer { updateDeviceConnectionMetric() }
         guard let key = Data(fromHexEncodedString: hash),
               SHA256.hash(data: key) == self.deviceKey else {
-            print("Invalid device key")
+            log("Invalid device key")
             _ = connection?.close()
             deviceIsAuthenticated = false
             return
         }
-        print("Device authenticated")
+        log("Device authenticated")
         deviceIsAuthenticated = true
     }
 
@@ -79,37 +111,40 @@ final class DeviceManager {
             return
         }
         defer { requestInProgress = nil }
-        promise.succeed(DeviceResponse(data) ?? .unexpectedSocketEvent)
+        promise.succeed(DeviceResponse(data, request: RouteAPI.socket.rawValue) ?? .unexpectedSocketEvent)
     }
     
     func didCloseDeviceSocket() {
+        defer { updateDeviceConnectionMetric() }
         guard !isOpeningNewConnection else {
             return
         }
         deviceIsAuthenticated = false
         guard connection != nil else {
-            print("Socket closed, but no connection anyway")
+            log("Socket closed, but no connection anyway")
             return
         }
         connection = nil
-        print("Socket closed")
+        log("Socket closed")
     }
     
     func removeDeviceConnection() {
+        defer { updateDeviceConnectionMetric() }
         deviceIsAuthenticated = false
         guard let socket = connection else {
             return
         }
         try? socket.close().wait()
         connection = nil
-        print("Removed device connection")
+        log("Removed device connection")
     }
     
     func createNewDeviceConnection(_ socket: WebSocket) {
+        defer { updateDeviceConnectionMetric() }
         isOpeningNewConnection = true
         removeDeviceConnection()
         connection = socket
-        print("Socket connected")
+        log("Socket connected")
         isOpeningNewConnection = false
     }
 }

Sources/App/configure.swift

@@ -1,4 +1,5 @@
 import Vapor
+import Clairvoyant
 
 var deviceManager: DeviceManager!
 
@@ -8,12 +9,51 @@ enum ServerError: Error {
 }
 
 // configures your application
-public func configure(_ app: Application) throws {
-    app.http.server.configuration.port = Config.port
-    
+public func configure(_ app: Application) async throws {
     let storageFolder = URL(fileURLWithPath: app.directory.resourcesDirectory)
-    let keyFile = storageFolder.appendingPathComponent(Config.keyFileName)
-    let authContent: [Data] = try String(contentsOf: keyFile)
+    let logFolder = storageFolder.appendingPathComponent("logs")
+
+    let accessManager = AccessTokenManager([])
+    let monitor = await MetricObserver(
+        logFolder: logFolder,
+        accessManager: accessManager,
+        logMetricId: "sesame.log")
+    MetricObserver.standard = monitor
+
+    let status = try await Metric<ServerStatus>("sesame.status")
+    try await status.update(.initializing)
+
+    await monitor.registerRoutes(app)
+
+    let configUrl = storageFolder.appendingPathComponent("config.json")
+    let config = try Config(loadFrom: configUrl)
+
+    config.authenticationTokens.map { $0.data(using: .utf8)! }.forEach(accessManager.add)
+
+    app.http.server.configuration.port = config.port
+
+    let keyFile = storageFolder.appendingPathComponent(config.keyFileName)
+
+    let (deviceKey, remoteKey) = try loadKeys(at: keyFile)
+    deviceManager = await DeviceManager(
+        deviceKey: deviceKey,
+        remoteKey: remoteKey,
+        deviceTimeout: config.deviceTimeout)
+    
+    try routes(app)
+    
+    // Gracefully shut down by closing potentially open socket
+    DispatchQueue.global(qos: .utility).asyncAfter(deadline: .now() + .seconds(5)) {
+        _ = app.server.onShutdown.always { _ in
+            deviceManager.removeDeviceConnection()
+        }
+    }
+
+    try await status.update(.nominal)
+}
+
+private func loadKeys(at url: URL) throws -> (deviceKey: Data, remoteKey: Data) {
+    let authContent: [Data] = try String(contentsOf: url)
         .trimmingCharacters(in: .whitespacesAndNewlines)
         .components(separatedBy: "\n")
         .map { $0.trimmingCharacters(in: .whitespacesAndNewlines) }
@@ -29,15 +69,15 @@ public func configure(_ app: Application) throws {
     guard authContent.count == 2 else {
         throw ServerError.invalidAuthenticationFileContent
     }
-    let deviceKey = authContent[0]
-    let remoteKey = authContent[1]
-    deviceManager = DeviceManager(deviceKey: deviceKey, remoteKey: remoteKey)
-    try routes(app)
-    
-    // Gracefully shut down by closing potentially open socket
-    DispatchQueue.global(qos: .utility).asyncAfter(deadline: .now() + .seconds(5)) {
-        _ = app.server.onShutdown.always { _ in
-            deviceManager.removeDeviceConnection()
-        }
+    return (deviceKey: authContent[0], remoteKey: authContent[1])
+}
+
+func log(_ message: String) {
+    guard let observer = MetricObserver.standard else {
+        print(message)
+        return
+    }
+    Task {
+        await observer.log(message)
     }
 }

Sources/Run/main.swift

@@ -1,9 +1,15 @@
 import App
 import Vapor
 
-var env = try Environment.detect()
+var env = Environment.production //.detect()
 try LoggingSystem.bootstrap(from: &env)
 let app = Application(env)
 defer { app.shutdown() }
-try configure(app)
+
+private let semaphore = DispatchSemaphore(value: 0)
+Task {
+    try await configure(app)
+    semaphore.signal()
+}
+semaphore.wait()
 try app.run()

Tests/AppTests/AppTests.swift

@@ -11,7 +11,7 @@ final class AppTests: XCTestCase {
     }
 
     func testEncodingContent() {
-        let input = Message.Content(time: 1234567890, id: 23456789)
+        let input = Message.Content(time: 1234567890, id: 23456789, device: 0)
         let data = Array(input.encoded)
         let output = Message.Content(decodeFrom: data)
         XCTAssertEqual(input, output)
@@ -22,7 +22,7 @@ final class AppTests: XCTestCase {
 
     func testEncodingMessage() {
         let input = Message(mac: Data(repeating: 42, count: 32),
-                            content: Message.Content(time: 1234567890, id: 23456789))
+                            content: Message.Content(time: 1234567890, id: 23456789, device: 0))
         let data = input.encoded
         let buffer = ByteBuffer(data: data)
         let output = Message(decodeFrom: buffer)
@@ -31,7 +31,7 @@ final class AppTests: XCTestCase {
 
     func testSigning() throws {
         let key = SymmetricKey(size: .bits256)
-        let content = Message.Content(time: 1234567890, id: 23456789)
+        let content = Message.Content(time: 1234567890, id: 23456789, device: 0)
         let input = content.authenticate(using: key)
         XCTAssertTrue(input.isValid(using: key))
 
@@ -43,10 +43,10 @@ final class AppTests: XCTestCase {
         XCTAssertEqual(content, input.content)
     }
 
-    func testMessageTransmission() throws {
+    func testMessageTransmission() async throws {
         let app = Application(.testing)
         defer { app.shutdown() }
-        try configure(app)
+        try await configure(app)
 
         // How to open a socket via request?
     }