Merge pull request #182 from TelemetryDeck/add-cluster-structure

Add cluster structure

.swiftlint.yml

@@ -55,4 +55,5 @@ identifier_name:
     - env
     - telemetry_api_server_version
 
-reporter: "github-actions-logging" # reporter type (xcode, json, csv, checkstyle, codeclimate, junit, html, emoji, sonarqube, markdown, github-actions-logging)
+#reporter: "github-actions-logging" # reporter type (xcode, json, csv, checkstyle, codeclimate, junit, html, emoji, sonarqube, markdown, github-actions-logging)
+reporter: "xcode"

APIClient/APIClient.swift

@@ -414,6 +414,17 @@ extension APIClient {
         runTask(with: request, completion: completion)
     }
 
+    @available(macOS 12.0, *)
+    func post<Input: Encodable, Output: Decodable>(data: Input, url: URL) async throws -> Output {
+        #if DEBUG
+            print("🌍 POST", url)
+        #endif
+
+        var request = authenticatedURLRequest(for: url, httpMethod: "POST")
+        request.httpBody = try? JSONEncoder.telemetryEncoder.encode(data)
+        return try await runAsyncTask(with: request)
+    }
+
     func post<Input: Encodable, Output: Decodable>(_ data: Input, to url: URL, defaultValue _: Output? = nil, completion: @escaping (Result<Output, TransferError>) -> Void) {
         #if DEBUG
             print("🌍 POST", url)

APIClient/DTOs/InsightInfo.swift

@@ -27,12 +27,6 @@ public struct InsightInfo: Codable, Hashable, Identifiable {
     /// What kind of insight is this?
     public var type: InsightType
 
-    /// If set, display the chart with this accent color, otherwise fall back to default color
-    public var accentColor: String?
-
-    /// If set, use the custom query in this property instead of constructing a query out of the options below
-    public var customQuery: CustomQuery?
-
     /// Which signal types are we interested in? If nil, do not filter by signal type
     public var signalType: String?
 
@@ -57,31 +51,32 @@ public struct InsightInfo: Codable, Hashable, Identifiable {
     /// The date this query was last run
     public var lastRunAt: Date?
 
+    /// The query to calculate this insight
+    public var query: CustomQuery?
+
     public init(
         id: UUID,
         groupID: UUID,
         order: Double?,
         title: String,
         type: InsightType,
-        accentColor: String? = nil,
+        accentColor _: String? = nil,
         widgetable _: Bool? = false,
-        customQuery: CustomQuery? = nil,
         signalType: String?,
         uniqueUser: Bool,
         breakdownKey: String?,
         groupBy: QueryGranularity?,
         displayMode: InsightDisplayMode,
         isExpanded: Bool,
         lastRunTime: TimeInterval?,
-        lastRunAt: Date?
+        lastRunAt: Date?,
+        query: CustomQuery?
     ) {
         self.id = id
         self.groupID = groupID
         self.order = order
         self.title = title
         self.type = type
-        self.accentColor = accentColor
-        self.customQuery = customQuery
         self.signalType = signalType
         self.uniqueUser = uniqueUser
         self.breakdownKey = breakdownKey
@@ -90,5 +85,6 @@ public struct InsightInfo: Codable, Hashable, Identifiable {
         self.isExpanded = isExpanded
         self.lastRunTime = lastRunTime
         self.lastRunAt = lastRunAt
+        self.query = query
     }
 }

Cluster/Chart/BarChart/BarCharTopN.swift

@@ -0,0 +1,25 @@
+//
+//  BarCharTopN.swift
+//  Telemetry Viewer (iOS)
+//
+//  Created by Lukas on 23.05.24.
+//
+
+import SwiftUI
+import Charts
+import DataTransferObjects
+
+struct BarChartTopN: View {
+    let result: TopNQueryResult
+
+    var body: some View {
+        Chart {
+            //ForEach(result.rows) { row in
+            //    BarMark(
+            //        x: .value("Date", 4),
+            //        y: .value("Total Count", 5)
+            //    )
+            //}
+        }
+    }
+}

Cluster/Chart/BarChart/BarChartGroupBy.swift

@@ -0,0 +1,25 @@
+//
+//  BarChartGroupBy.swift
+//  Telemetry Viewer (iOS)
+//
+//  Created by Lukas on 23.05.24.
+//
+
+import SwiftUI
+import Charts
+import DataTransferObjects
+
+struct BarChartGroupBy: View {
+    let result: GroupByQueryResult
+
+    var body: some View {
+        Chart {
+            /*ForEach(result.rows) { row in
+                BarMark(
+                    x: .value("Date", 5),
+                    y: .value("Total Count", 5)
+                )
+            }*/
+        }
+    }
+}

Cluster/Chart/BarChart/BarChartTimeSeries.swift

@@ -0,0 +1,25 @@
+//
+//  BarChartTimeSeries.swift
+//  Telemetry Viewer (iOS)
+//
+//  Created by Lukas on 23.05.24.
+//
+
+import SwiftUI
+import Charts
+import DataTransferObjects
+
+struct BarChartTimeSeries: View {
+    let result: TimeSeriesQueryResult
+
+    var body: some View {
+        Chart {
+            ForEach(result.rows, id: \.timestamp) { row in
+                BarMark(
+                    x: .value("Date", row.timestamp),
+                    y: .value("Total Count", row.result["count"]?.value ?? 0)
+                )
+            }
+        }
+    }
+}

Cluster/Chart/BarChart/ClusterBarChart.swift

@@ -0,0 +1,38 @@
+//
+//  ClusterBarChart.swift
+//  Telemetry Viewer (iOS)
+//
+//  Created by Lukas on 23.05.24.
+//
+import SwiftUI
+import DataTransferObjects
+
+struct ClusterBarChart: View {
+    let query: CustomQuery
+    let result: QueryResult
+
+    var body: some View {
+        switch query.queryType {
+        case .timeseries:
+            if case let .timeSeries(result) = result {
+                BarChartTimeSeries(result: result)
+            } else {
+                Text("Mismatch in query type and result type 1")
+            }
+        /*case .groupBy:
+            if case let .groupBy(result) = result {
+                BarChartGroupBy(result: result)
+            } else {
+                Text("Mismatch in query type and result type 2")
+            }*/
+        case .topN:
+            if case let .topN(result) = result {
+                BarChartTopN(result: result)
+            } else {
+                Text("Mismatch in query type and result type 2")
+            }
+        default:
+            Text("\(query.queryType.rawValue) bar charts are not supported.")
+        }
+    }
+}

Cluster/Chart/ClusterChart.swift

@@ -0,0 +1,28 @@
+//
+//  ClusterChart.swift
+//  Telemetry Viewer (iOS)
+//
+//  Created by Lukas on 23.05.24.
+//
+
+import SwiftUI
+import DataTransferObjects
+
+/// Cluster/Chart – given a query and a result, displays the result
+struct ClusterChart: View {
+
+    let query: CustomQuery
+    let result: QueryResult
+    let type: InsightDisplayMode
+
+    var body: some View {
+        switch type {
+        case .barChart:
+            ClusterBarChart(query: query, result: result)
+        case .lineChart:
+            ClusterLineChart(query: query, result: result)
+        default:
+            Text("Not supported")
+        }
+    }
+}

Cluster/Chart/LineChart/ClusterLineChart.swift

@@ -0,0 +1,27 @@
+//
+//  ClusterLineChart.swift
+//  Telemetry Viewer (iOS)
+//
+//  Created by Lukas on 23.05.24.
+//
+
+import SwiftUI
+import DataTransferObjects
+
+struct ClusterLineChart: View {
+    let query: CustomQuery
+    let result: QueryResult
+
+    var body: some View {
+        switch query.queryType {
+        case .timeseries:
+            if case let .timeSeries(result) = result {
+                LineChartTimeSeries(result: result)
+            } else {
+                Text("Mismatch in query type and result type")
+            }
+        default:
+            Text("\(query.queryType.rawValue) bar charts are not supported.")
+        }
+    }
+}

Cluster/Chart/LineChart/LineChartTimeSeries.swift

@@ -0,0 +1,33 @@
+//
+//  LineChartTimeSeries.swift
+//  Telemetry Viewer (iOS)
+//
+//  Created by Lukas on 23.05.24.
+//
+
+import SwiftUI
+import Charts
+import DataTransferObjects
+
+struct LineChartTimeSeries: View {
+    let result: TimeSeriesQueryResult
+
+    var body: some View {
+        Chart {
+            ForEach(result.rows, id: \.timestamp) { row in
+                LineMark(
+                    x: .value("Date", row.timestamp),
+                    y: .value("Total Count", row.result["count"]?.value ?? 0)
+                )
+            }
+            .interpolationMethod(.cardinal)
+
+            ForEach(result.rows, id: \.timestamp) { row in
+                AreaMark(x: .value("Date", row.timestamp),
+                         y: .value("Total Count", row.result["count"]?.value ?? 0))
+            }
+            .interpolationMethod(.cardinal)
+            .foregroundStyle(LinearGradient(colors: [Color.telemetryOrange.opacity(0.25), Color.telemetryOrange.opacity(0.0)], startPoint: .top, endPoint: .bottom))
+        }
+    }
+}

Cluster/ClusterInstrument.swift

@@ -0,0 +1,34 @@
+//
+//  ClusterInstrument.swift
+//  Telemetry Viewer (iOS)
+//
+//  Created by Lukas on 23.05.24.
+//
+
+import SwiftUI
+import DataTransferObjects
+
+struct ClusterInstrument: View {
+    @EnvironmentObject var api: APIClient
+
+    let query: CustomQuery
+    let title: String
+    let type: InsightDisplayMode
+
+    var body: some View {
+        VStack(alignment: .leading, spacing: 8) {
+            Text(title)
+                .font(.headline)
+                .fontWeight(.medium)
+                .foregroundStyle(Color.Zinc600)
+                .padding(.top)
+                .padding(.horizontal)
+            QueryRunner(query: query, type: type)
+        }
+        .compositingGroup()
+        .background(.background)
+        .shadow(color: .gray.opacity(0.15), radius: 5, x: 0, y: 2)
+        .border(Color.Zinc200, width: 1.0)
+        .padding(.vertical, 5)
+    }
+}