Add AtomicSiteServiceRemote/getWebServerLogs

Author: kean

WordPressKit/AtomicLogs.swift

@@ -1,6 +1,6 @@
 import Foundation
 
-public final class AtomicLogMessage: Decodable {
+public final class AtomicErrorLogEntry: Decodable {
     public let message: String?
     public let severity: String?
     public let kind: String?
@@ -19,6 +19,30 @@ public final class AtomicLogMessage: Decodable {
 
 public final class AtomicErrorLogsResponse: Decodable {
     public let totalResults: Int
-    public let logs: [AtomicLogMessage]
+    public let logs: [AtomicErrorLogEntry]
+    public let scrollId: String?
+}
+
+public class AtomicWebServerLogEntry: Decodable {
+    public let bodyBytesSent: Int?
+    /// The possible values are `"true"` or `"false"`.
+    public let cached: String?
+    public let date: Date?
+    public let httpHost: String?
+    public let httpReferer: String?
+    public let httpUserAgent: String?
+    public let requestTime: Double?
+    public let requestType: String?
+    public let requestURL: String?
+    public let scheme: String?
+    public let status: Int?
+    public let timestamp: Int?
+    public let type: String?
+    public let userIP: String?
+}
+
+public final class AtomicWebServerLogsResponse: Decodable {
+    public let totalResults: Int
+    public let logs: [AtomicWebServerLogEntry]
     public let scrollId: String?
 }

WordPressKit/AtomicSiteServiceRemote.swift

@@ -3,27 +3,71 @@ import Foundation
 public final class AtomicSiteServiceRemote: ServiceRemoteWordPressComREST {
     /// - parameter scrollID: Pass the scroll ID from the previous response to
     /// fetch the next page.
-    public func getSiteErrorLogs(siteID: Int,
+    public func getErrorLogs(siteID: Int,
+                             range: Range<Date>,
+                             severity: AtomicErrorLogEntry.Severity? = nil,
+                             scrollID: String? = nil,
+                             pageSize: Int = 50,
+                             success: @escaping (AtomicErrorLogsResponse) -> Void,
+                             failure: @escaping (Error) -> Void) {
+        let path = self.path(forEndpoint: "sites/\(siteID)/hosting/error-logs/", withVersion: ._2_0)
+        var parameters = [
+            "start": "\(Int(range.lowerBound.timeIntervalSince1970))",
+            "end": "\(Int(range.upperBound.timeIntervalSince1970))",
+            "sort_order": "desc",
+            "page_size": "\(pageSize)"
+        ] as [String: String]
+        if let severity {
+            parameters["filter[severity][]"] = severity.rawValue
+        }
+        if let scrollID {
+            parameters["scroll_id"] = scrollID
+        }
+        wordPressComRestApi.GET(path, parameters: parameters as [String: AnyObject]) { responseObject, httpResponse in
+            guard (200..<300).contains(httpResponse?.statusCode ?? 0),
+                  let data = (responseObject as? [String: AnyObject])?["data"],
+                  JSONSerialization.isValidJSONObject(data) else {
+                failure(URLError(.unknown))
+                return
+            }
+            do {
+                let data = try JSONSerialization.data(withJSONObject: data)
+                let response = try JSONDecoder.apiDecoder.decode(AtomicErrorLogsResponse.self, from: data)
+                success(response)
+            } catch {
+                WPKitLogError("Error parsing campaigns response: \(error), \(responseObject)")
+                failure(error)
+            }
+        } failure: { error, _ in
+            failure(error)
+        }
+    }
+
+    public func getWebServerLogs(siteID: Int,
                                  range: Range<Date>,
-                                 severity: AtomicLogMessage.Severity? = nil,
+                                 httpMethod: String? = nil,
+                                 statusCode: Int? = nil,
                                  scrollID: String? = nil,
                                  pageSize: Int = 50,
-                                 success: @escaping (AtomicErrorLogsResponse) -> Void,
+                                 success: @escaping (AtomicWebServerLogsResponse) -> Void,
                                  failure: @escaping (Error) -> Void) {
-        let path = self.path(forEndpoint: "sites/\(siteID)/hosting/error-logs/", withVersion: ._2_0)
+        let path = self.path(forEndpoint: "sites/\(siteID)/hosting/logs/", withVersion: ._2_0)
         var parameters = [
             "start": "\(Int(range.lowerBound.timeIntervalSince1970))",
             "end": "\(Int(range.upperBound.timeIntervalSince1970))",
             "sort_order": "desc",
             "page_size": "\(pageSize)"
-        ] as [String: AnyObject]
-        if let severity {
-            parameters["filter[severity][]"] = severity.rawValue as AnyObject
+        ] as [String: String]
+        if let httpMethod {
+            parameters["filter[request_type][]"] = httpMethod.uppercased()
+        }
+        if let statusCode {
+            parameters["filter[status][]"] = "\(statusCode)"
         }
         if let scrollID {
-            parameters["scroll_id"] = scrollID as AnyObject
+            parameters["scroll_id"] = scrollID
         }
-        wordPressComRestApi.GET(path, parameters: parameters) { responseObject, httpResponse in
+        wordPressComRestApi.GET(path, parameters: parameters as [String: AnyObject]) { responseObject, httpResponse in
             guard (200..<300).contains(httpResponse?.statusCode ?? 0),
                   let data = (responseObject as? [String: AnyObject])?["data"],
                   JSONSerialization.isValidJSONObject(data) else {
@@ -32,7 +76,7 @@ public final class AtomicSiteServiceRemote: ServiceRemoteWordPressComREST {
             }
             do {
                 let data = try JSONSerialization.data(withJSONObject: data)
-                let response = try JSONDecoder.apiDecoder.decode(AtomicErrorLogsResponse.self, from: data)
+                let response = try JSONDecoder.apiDecoder.decode(AtomicWebServerLogsResponse.self, from: data)
                 success(response)
             } catch {
                 WPKitLogError("Error parsing campaigns response: \(error), \(responseObject)")