Share
Embed
Transcript
124 slides
-
๐ Pol Piella Abadia ๐ฎ๐น Swift Heroes 2023 Making developer
tools with Swift -
Who am I? ๐จ๐ป Senior Software Engineer at BBC โ
Weekly blogs at polpiella.dev ๐ฌ Curator of the iOS CI Newsle tt er ๐ Based in Manchester ๐ช๐ธ From Barcelona -
What weโll build today ๐ป Complex metrics system ๐ Metrics
from Xcode Cloud and GHA ๐ Dashboard plots and displays metrics ๐ก Inspired by a real-world system ๐ฆ Swift Package monorepo ๐ Everything is Open Source! โค -
Why Swift though? ๐ป Often not fi rst choice for
writing tooling ๐ Powerful language with a mature ecosystem. โ Beyond Apple app development ๐ Tools are often maintained and built by mobile developers. โค Focus on the system, not the language! -
# ! /bin/sh # Create an empty directory mkdir metrics
Creating a Swift Package Creating a Swift Package -
# ! /bin/sh # Create an empty directory mkdir metrics
# Move into the new directory cd metrics Creating a Swift Package Creating a Swift Package -
# ! /bin/sh # Create an empty directory mkdir metrics
# Move into the new directory cd metrics # Create a new executable package swift package init -- name Metrics Creating a Swift Package Creating a Swift Package -
. โโโ Package.swift โโโ README.md โโโ Sources โ โโโ Metrics
โ โโโ Metrics.swift โโโ Tests โโโ MetricsTests โโโ MetricsTests.swift Creating a Swift Package Creating a Swift Package # ! /bin/sh # Create an empty directory mkdir metrics # Move into the new directory cd metrics # Create a new executable package swift package init -- name Metrics -
using Swiftโฆ The metrics backend ๐ฟ PostgresSQL database โ POST
endpoint ๐ GET endpoint โ DELETE endpoint ๐ Built entirely with Swift ๐ง Using Vapor -
// swift-tools-version:5.6 import PackageDescription let package = Package( name: "Metrics",
platforms: [ .macOS(.v12) ], dependencies: [ ], targets: [ .target(name: "Metrics"), .testTarget(name: "MetricsTests", dependencies: ["Metrics"]) ] ) -
// swift-tools-version:5.6 import PackageDescription let package = Package( name: "Metrics",
platforms: [ .macOS(.v12) ], dependencies: [ ], targets: [ .target(name: "Metrics"), .testTarget(name: "MetricsTests", dependencies: ["Metrics"]) ] ) -
// swift-tools-version:5.6 import PackageDescription let package = Package( name: "Metrics",
platforms: [ .macOS(.v12) ], dependencies: [ ], targets: [ ] ) -
// swift-tools-version:5.6 import PackageDescription let package = Package( name: "Metrics",
platforms: [ .macOS(.v12) ], dependencies: [ .package(url: "https: // github.com/vapor/vapor.git", from: "4.0.0"), ], targets: [ ] ) -
// swift-tools-version:5.6 import PackageDescription let package = Package( name: "Metrics",
platforms: [ .macOS(.v12) ], dependencies: [ .package(url: "https: // github.com/vapor/vapor.git", from: "4.0.0"), .package(url: "https: // github.com/vapor/fluent.git", from: "4.0.0"), .package(url: "https: // github.com/vapor/fluent-postgres-driver.git", from: "2.0.0") ], targets: [ ] ) -
// swift-tools-version:5.6 import PackageDescription let package = Package( name: "Metrics",
platforms: [ .macOS(.v12) ], dependencies: [ .package(url: "https: // github.com/vapor/vapor.git", from: "4.0.0"), .package(url: "https: // github.com/vapor/fluent.git", from: "4.0.0"), .package(url: "https: // github.com/vapor/fluent-postgres-driver.git", from: "2.0.0") ], targets: [ .target( name: "App", dependencies: [ ], swiftSettings: [ ] ), ] ) -
// swift-tools-version:5.6 import PackageDescription let package = Package( name: "Metrics",
platforms: [ .macOS(.v12) ], dependencies: [ .package(url: "https: // github.com/vapor/vapor.git", from: "4.0.0"), .package(url: "https: // github.com/vapor/fluent.git", from: "4.0.0"), .package(url: "https: // github.com/vapor/fluent-postgres-driver.git", from: "2.0.0") ], targets: [ .target( name: "App", dependencies: [ .product(name: "Fluent", package: "fluent"), .product(name: "FluentPostgresDriver", package: "fluent-postgres-driver"), .product(name: "Vapor", package: "vapor") ], swiftSettings: [ ] ), ] ) -
// swift-tools-version:5.6 import PackageDescription let package = Package( name: "Metrics",
platforms: [ .macOS(.v12) ], dependencies: [ .package(url: "https: // github.com/vapor/vapor.git", from: "4.0.0"), .package(url: "https: // github.com/vapor/fluent.git", from: "4.0.0"), .package(url: "https: // github.com/vapor/fluent-postgres-driver.git", from: "2.0.0") ], targets: [ .target( name: "App", dependencies: [ .product(name: "Fluent", package: "fluent"), .product(name: "FluentPostgresDriver", package: "fluent-postgres-driver"), .product(name: "Vapor", package: "vapor") ], swiftSettings: [ .unsafeFlags(["-cross-module-optimization"], .when(configuration: .release)) ] ), ] ) -
// swift-tools-version:5.6 import PackageDescription let package = Package( name: "Metrics",
platforms: [ .macOS(.v12) ], dependencies: [ .package(url: "https: // github.com/vapor/vapor.git", from: "4.0.0"), .package(url: "https: // github.com/vapor/fluent.git", from: "4.0.0"), .package(url: "https: // github.com/vapor/fluent-postgres-driver.git", from: "2.0.0") ], targets: [ .target( name: "App", dependencies: [ .product(name: "Fluent", package: "fluent"), .product(name: "FluentPostgresDriver", package: "fluent-postgres-driver"), .product(name: "Vapor", package: "vapor") ], swiftSettings: [ .unsafeFlags(["-cross-module-optimization"], .when(configuration: .release)) ] ), .executableTarget(name: "Run", dependencies: [.target(name: "App")]) ] ) -
. โโโ Package.swift โโโ README.md โโโ Sources โ โโโ App
โ โโโ Model.swift Modelling data -
import Vapor import Fluent . โโโ Package.swift โโโ README.md โโโ
Sources โ โโโ App โ โโโ Model.swift Modelling data -
import Vapor import Fluent final class Metric: Model, Content {
static let schema = "metrics" } Modelling data . โโโ Package.swift โโโ README.md โโโ Sources โ โโโ App โ โโโ Model.swift -
import Vapor import Fluent final class Metric: Model, Content {
static let schema = "metrics" @ID(key: .id) var id: UUID? @Field(key: "workflow") var workflow: String @Field(key: "duration") var duration: Int @Field(key: "date") var date: Date @Field(key: "repository") var repository: String @Field(key: "author") var author: String @Enum(key: "provider") var provider: Provider @Enum(key: "outcome") var outcome: Outcome init() {} } Modelling data . โโโ Package.swift โโโ README.md โโโ Sources โ โโโ App โ โโโ Model.swift -
import Vapor import Fluent enum Provider: String, Codable { case
xcodeCloud = "xcode-cloud" case githubActions = "github-actions" } enum Outcome: String, Codable { case success case failure case cancelled } final class Metric: Model, Content { static let schema = "metrics" @ID(key: .id) var id: UUID? @Field(key: "workflow") var workflow: String @Field(key: "duration") var duration: Int @Field(key: "date") var date: Date @Field(key: "repository") var repository: String @Field(key: "author") var author: String @Enum(key: "provider") var provider: Provider @Enum(key: "outcome") var outcome: Outcome init() {} } Modelling data . โโโ Package.swift โโโ README.md โโโ Sources โ โโโ App โ โโโ Model.swift -
import Fluent struct CreateMetric: Migration { } . โโโ Package.swift
โโโ README.md โโโ Sources โ โโโ App โ โโโ Model.swift โ โโโ Migrations.swift Modelling data -
import Fluent struct CreateMetric: Migration { func prepare(on database: Database)
-> EventLoopFuture<Void> { } } Modelling data . โโโ Package.swift โโโ README.md โโโ Sources โ โโโ App โ โโโ Model.swift โ โโโ Migrations.swift -
import Fluent struct CreateMetric: Migration { func prepare(on database: Database)
-> EventLoopFuture<Void> { database.schema("metrics") } } Modelling data . โโโ Package.swift โโโ README.md โโโ Sources โ โโโ App โ โโโ Model.swift โ โโโ Migrations.swift -
import Fluent struct CreateMetric: Migration { func prepare(on database: Database)
-> EventLoopFuture<Void> { database.schema("metrics") .id() .field("workflow", .string, .required) .field("duration", .int, .required) .field("date", .datetime, .required) .field("provider", .string, .required) .field("outcome", .string, .required) .field("repository", .string, .required) .field("author", .string, .required) } } Modelling data . โโโ Package.swift โโโ README.md โโโ Sources โ โโโ App โ โโโ Model.swift โ โโโ Migrations.swift -
import Fluent struct CreateMetric: Migration { func prepare(on database: Database)
-> EventLoopFuture<Void> { database.schema("metrics") .id() .field("workflow", .string, .required) .field("duration", .int, .required) .field("date", .datetime, .required) .field("provider", .string, .required) .field("outcome", .string, .required) .field("repository", .string, .required) .field("author", .string, .required) .create() } } Modelling data . โโโ Package.swift โโโ README.md โโโ Sources โ โโโ App โ โโโ Model.swift โ โโโ Migrations.swift -
import Fluent struct CreateMetric: Migration { func prepare(on database: Database)
-> EventLoopFuture<Void> { database.schema("metrics") .id() .field("workflow", .string, .required) .field("duration", .int, .required) .field("date", .datetime, .required) .field("provider", .string, .required) .field("outcome", .string, .required) .field("repository", .string, .required) .field("author", .string, .required) .create() } func revert(on database: Database) -> EventLoopFuture<Void> { database.schema("metrics").delete() } } Modelling data . โโโ Package.swift โโโ README.md โโโ Sources โ โโโ App โ โโโ Model.swift โ โโโ Migrations.swift -
import Fluent import Vapor struct MetricsController: RouteCollection { } .
โโโ Package.swift โโโ README.md โโโ Sources โ โโโ App โ โโโ Model.swift โ โโโ Migrations.swift โ โโโ MetricsController.swift Defining the routes -
import Fluent import Vapor struct MetricsController: RouteCollection { func boot(routes:
RoutesBuilder) throws { } } Defining the endpoints . โโโ Package.swift โโโ README.md โโโ Sources โ โโโ App โ โโโ Model.swift โ โโโ Migrations.swift โ โโโ MetricsController.swift -
import Fluent import Vapor struct MetricsController: RouteCollection { func boot(routes:
RoutesBuilder) throws { let api = routes.grouped("api", "metrics") api.get(use: get) } } Defining the endpoints . โโโ Package.swift โโโ README.md โโโ Sources โ โโโ App โ โโโ Model.swift โ โโโ Migrations.swift โ โโโ MetricsController.swift -
import Fluent import Vapor struct MetricsController: RouteCollection { func boot(routes:
RoutesBuilder) throws { let api = routes.grouped("api", "metrics") api.get(use: get) } func get(req: Request) async throws -> [Metric] { try await Metric.query(on: req.db) .sort(\.$date, .descending) .all() } } Defining the endpoints . โโโ Package.swift โโโ README.md โโโ Sources โ โโโ App โ โโโ Model.swift โ โโโ Migrations.swift โ โโโ MetricsController.swift -
import Fluent import Vapor struct MetricsController: RouteCollection { func boot(routes:
RoutesBuilder) throws { let api = routes.grouped("api", "metrics") api.get(use: get) api.get(":id", use: find) } func find(req: Request) async throws -> Metric { if let metric = try await Metric .find(req.parameters.get("id"), on: req.db) { return metric } else { throw Abort(.notFound) } } } Defining the endpoints . โโโ Package.swift โโโ README.md โโโ Sources โ โโโ App โ โโโ Model.swift โ โโโ Migrations.swift โ โโโ MetricsController.swift -
import Fluent import Vapor struct MetricsController: RouteCollection { func boot(routes:
RoutesBuilder) throws { let api = routes.grouped("api", "metrics") api.get(use: get) api.get(":id", use: find) api.post(use: create) } func create(req: Request) async throws -> Metric { let metric = try req.content.decode(Metric.self) try await metric.save(on: req.db) return metric } } Defining the endpoints . โโโ Package.swift โโโ README.md โโโ Sources โ โโโ App โ โโโ Model.swift โ โโโ Migrations.swift โ โโโ MetricsController.swift -
import Fluent import Vapor struct MetricsController: RouteCollection { func boot(routes:
RoutesBuilder) throws { let api = routes.grouped("api", "metrics") api.get(use: get) api.get(":id", use: find) api.post(use: create) api.delete(":id", use: delete) } func delete(req: Request) async throws -> HTTPStatus { guard let metric = try await Metric .find( req.parameters.get("id"), on: req.db ) else { throw Abort(.notFound) } try await metric.delete(on: req.db) return .noContent } } Defining the endpoints . โโโ Package.swift โโโ README.md โโโ Sources โ โโโ App โ โโโ Model.swift โ โโโ Migrations.swift โ โโโ MetricsController.swift -
import Fluent import Vapor func routes(_ app: Application) throws {
try app.register(collection: MetricsController()) } . โโโ Package.swift โโโ README.md โโโ Sources โ โโโ App โ โโโ Model.swift โ โโโ Migrations.swift โ โโโ MetricsController.swift โ โโโ routes.swift Registering the routes -
import Fluent import FluentPostgresDriver import Vapor public func configure(_ app:
Application) throws { } . โโโ Package.swift โโโ README.md โโโ Sources โ โโโ App โ โโโ Model.swift โ โโโ Migrations.swift โ โโโ MetricsController.swift โ โโโ routes.swift โ โโโ configure.swift Finallyโฆ -
import Fluent import FluentPostgresDriver import Vapor public func configure(_ app:
Application) throws { app.databases.use(.postgres( hostname: Environment .get("DATABASE_HOST") ?? "localhost", port: Environment .get("DATABASE_PORT") .flatMap(Int.init(_:)) ?? 5432, username: Environment .get("DATABASE_USERNAME") ?? "vapor_username", password: Environment .get("DATABASE_PASSWORD") ?? "vapor_password", database: Environment .get("DATABASE_NAME") ?? "vapor_database" ), as: .psql) } Finallyโฆ . โโโ Package.swift โโโ README.md โโโ Sources โ โโโ App โ โโโ Model.swift โ โโโ Migrations.swift โ โโโ MetricsController.swift โ โโโ routes.swift โ โโโ configure.swift -
import Fluent import FluentPostgresDriver import Vapor public func configure(_ app:
Application) throws { app.databases.use(.postgres( hostname: Environment .get("DATABASE_HOST") ?? "localhost", port: Environment .get("DATABASE_PORT") .flatMap(Int.init(_:)) ?? 5432, username: Environment .get("DATABASE_USERNAME") ?? "vapor_username", password: Environment .get("DATABASE_PASSWORD") ?? "vapor_password", database: Environment .get("DATABASE_NAME") ?? "vapor_database" ), as: .psql) app.migrations.add(CreateMetric()) try app.autoMigrate().wait() } Finallyโฆ . โโโ Package.swift โโโ README.md โโโ Sources โ โโโ App โ โโโ Model.swift โ โโโ Migrations.swift โ โโโ MetricsController.swift โ โโโ routes.swift โ โโโ configure.swift -
import Fluent import FluentPostgresDriver import Vapor public func configure(_ app:
Application) throws { app.databases.use(.postgres( hostname: Environment .get("DATABASE_HOST") ?? "localhost", port: Environment .get(โDATABASE_PORT") .flatMap(Int.init(_:)) ?? 5432, username: Environment .get("DATABASE_USERNAME") ?? "vapor_username", password: Environment .get("DATABASE_PASSWORD") ?? "vapor_password", database: Environment .get("DATABASE_NAME") ?? "vapor_database" ), as: .psql) app.migrations.add(CreateMetric()) try app.autoMigrate().wait() app.logger.logLevel = .debug } Finallyโฆ . โโโ Package.swift โโโ README.md โโโ Sources โ โโโ App โ โโโ Model.swift โ โโโ Migrations.swift โ โโโ MetricsController.swift โ โโโ routes.swift โ โโโ configure.swift -
import Fluent import FluentPostgresDriver import Vapor public func configure(_ app:
Application) throws { app.databases.use(.postgres( hostname: Environment .get("DATABASE_HOST") ?? "localhost", port: Environment .get(โDATABASE_PORT") .flatMap(Int.init(_:)) ?? 5432, username: Environment .get("DATABASE_USERNAME") ?? "vapor_username", password: Environment .get("DATABASE_PASSWORD") ?? "vapor_password", database: Environment .get("DATABASE_NAME") ?? "vapor_database" ), as: .psql) app.migrations.add(CreateMetric()) try app.autoMigrate().wait() app.logger.logLevel = .debug try routes(app) } Finallyโฆ . โโโ Package.swift โโโ README.md โโโ Sources โ โโโ App โ โโโ Model.swift โ โโโ Migrations.swift โ โโโ MetricsController.swift โ โโโ routes.swift โ โโโ configure.swift -
The run target . โโโ Package.swift โโโ README.md โโโ Sources
โ โโโ App โ โ โโโ Model.swift โ โ โโโ Migrations.swift โ โ โโโ MetricsController.swift โ โ โโโ routes.swift โ โ โโโ configure.swift โ โโโ Run โ โโโ main.swift -
The run target . โโโ Package.swift โโโ README.md โโโ Sources
โ โโโ App โ โ โโโ Model.swift โ โ โโโ Migrations.swift โ โ โโโ MetricsController.swift โ โ โโโ routes.swift โ โ โโโ configure.swift โ โโโ Run โ โโโ main.swift -
import App import Vapor var env = try Environment.detect() try
LoggingSystem.bootstrap(from: &env) let app = Application(env) defer { app.shutdown() } try configure(app) try app.run() The run target . โโโ Package.swift โโโ README.md โโโ Sources โ โโโ App โ โ โโโ Model.swift โ โ โโโ Migrations.swift โ โ โโโ MetricsController.swift โ โ โโโ routes.swift โ โ โโโ configure.swift โ โโโ Run โ โโโ main.swift -
. โโโ Package.swift โโโ README.md โโโ Resources โ โโโ Views
โ โโโ Home.leaf โโโ Sources โ โโโ App โ โ โโโ Model.swift โ โ โโโ Migrations.swift โ โ โโโ MetricsController.swift โ โ โโโ routes.swift โ โ โโโ configure.swift โ โ โโโ FrontendController.swift โ โโโ Run โ โโโ main.swift ๐ Creating a template -
๐ Creating a template . โโโ Package.swift โโโ README.md โโโ
Resources โ โโโ Views โ โโโ Home.leaf โโโ Sources โ โโโ App โ โ โโโ Model.swift โ โ โโโ Migrations.swift โ โ โโโ MetricsController.swift โ โ โโโ routes.swift โ โ โโโ configure.swift โ โ โโโ FrontendController.swift โ โโโ Run โ โโโ main.swift -
<html> <head> <script type="text/javascript" src="https: // www.gstatic.com/charts/loader.js" > </ script>
<script src="https: // cdn.tailwindcss.com"> </ script> </ head> <body class="h-screen w-screen bg-gray-900"> <main> <div class="mx-auto my-8 text-3xl font-semibold max-w-5xl > <section class="flex flex-col gap-2"> <h1 class="text-5xl">QReate Metrics </ h1> <p class="text-sm font-normal"> A dashboard to aggregate all workflows data for y </ p> </ section> <section> <p class="text-2xl font-semibold mb-4">All workflow </ <div id="chart"> </ div> </ section> <section> <p class="text-2xl font-semibold mb-4">Recent build </ <div class="flex flex-col gap-6"> #for(metric in metrics): <div class="flex flex-col gap-1 text-lg round ๐ Creating a template . โโโ Package.swift โโโ README.md โโโ Resources โ โโโ Views โ โโโ Home.leaf โโโ Sources โ โโโ App โ โ โโโ Model.swift โ โ โโโ Migrations.swift โ โ โโโ MetricsController.swift โ โ โโโ routes.swift โ โ โโโ configure.swift โ โ โโโ FrontendController.swift โ โโโ Run โ โโโ main.swift -
<html> <head> <script type="text/javascript" src="https: // www.gstatic.com/charts/loader.js" > </ script>
<script src="https: // cdn.tailwindcss.com"> </ script> </ head> <body class="h-screen w-screen bg-gray-900"> <main> <div class="mx-auto my-8 text-3xl font-semibold max-w-5xl > <section class="flex flex-col gap-2"> <h1 class="text-5xl">QReate Metrics </ h1> <p class="text-sm font-normal"> A dashboard to aggregate all workflows data for y </ p> </ section> <section> <p class="text-2xl font-semibold mb-4">All workflow </ <div id="chart"> </ div> </ section> <section> <p class="text-2xl font-semibold mb-4">Recent build </ <div class="flex flex-col gap-6"> #for(metric in metrics): <div class="flex flex-col gap-1 text-lg round ๐ Creating a template . โโโ Package.swift โโโ README.md โโโ Resources โ โโโ Views โ โโโ Home.leaf โโโ Sources โ โโโ App โ โ โโโ Model.swift โ โ โโโ Migrations.swift โ โ โโโ MetricsController.swift โ โ โโโ routes.swift โ โ โโโ configure.swift โ โ โโโ FrontendController.swift โ โโโ Run โ โโโ main.swift -
import Vapor struct FrontendController: RouteCollection { } . โโโ Package.swift
โโโ README.md โโโ Resources โ โโโ Views โ โโโ Home.leaf โโโ Sources โ โโโ App โ โโโ Model.swift โ โโโ Migrations.swift โ โโโ MetricsController.swift โ โโโ routes.swift โ โโโ configure.swift โ โโโ FrontendController.swift โ โโโ Run โ โโโ main.swift -
import Vapor struct FrontendController: RouteCollection { func boot(routes: RoutesBuilder) throws
{ routes.get(use: get) } func get(req: Request) async throws -> View { } } . โโโ Package.swift โโโ README.md โโโ Resources โ โโโ Views โ โโโ Home.leaf โโโ Sources โ โโโ App โ โโโ Model.swift โ โโโ Migrations.swift โ โโโ MetricsController.swift โ โโโ routes.swift โ โโโ configure.swift โ โโโ FrontendController.swift โ โโโ Run โ โโโ main.swift -
import Vapor struct FrontendController: RouteCollection { func boot(routes: RoutesBuilder) throws
{ routes.get(use: get) } func get(req: Request) async throws -> View { let allMetrics = try await Metric.query(on: req.db) .sort(\.$date, .descending) .all() } } . โโโ Package.swift โโโ README.md โโโ Resources โ โโโ Views โ โโโ Home.leaf โโโ Sources โ โโโ App โ โโโ Model.swift โ โโโ Migrations.swift โ โโโ MetricsController.swift โ โโโ routes.swift โ โโโ configure.swift โ โโโ FrontendController.swift โ โโโ Run โ โโโ main.swift -
import Vapor struct FrontendController: RouteCollection { func boot(routes: RoutesBuilder) throws
{ routes.get(use: get) } func get(req: Request) async throws -> View { let allMetrics = try await Metric.query(on: req.db) .sort(\.$date, .descending) .all() return try await req.view.render( "Home", HomeContext(metrics: allMetrics) ) } } . โโโ Package.swift โโโ README.md โโโ Resources โ โโโ Views โ โโโ Home.leaf โโโ Sources โ โโโ App โ โโโ Model.swift โ โโโ Migrations.swift โ โโโ MetricsController.swift โ โโโ routes.swift โ โโโ configure.swift โ โโโ FrontendController.swift โ โโโ Run โ โโโ main.swift -
import Vapor struct FrontendController: RouteCollection { func boot(routes: RoutesBuilder) throws
{ routes.get(use: get) } func get(req: Request) async throws -> View { let allMetrics = try await Metric.query(on: req.db) .sort(\.$date, .descending) .all() return try await req.view.render( "Home", HomeContext(metrics: allMetrics) ) } } . โโโ Package.swift โโโ README.md โโโ Resources โ โโโ Views โ โโโ Home.leaf โโโ Sources โ โโโ App โ โโโ Model.swift โ โโโ Migrations.swift โ โโโ MetricsController.swift โ โโโ routes.swift โ โโโ configure.swift โ โโโ FrontendController.swift โ โโโ Run โ โโโ main.swift -
import Vapor struct HomeContext: Encodable { let metrics: [Metric] }
struct FrontendController: RouteCollection { func boot(routes: RoutesBuilder) throws { routes.get(use: get) } func get(req: Request) async throws -> View { let allMetrics = try await Metric.query(on: req.db) .sort(\.$date, .descending) .all() return try await req.view.render( "Home", HomeContext(metrics: allMetrics) ) } } . โโโ Package.swift โโโ README.md โโโ Resources โ โโโ Views โ โโโ Home.leaf โโโ Sources โ โโโ App โ โโโ Model.swift โ โโโ Migrations.swift โ โโโ MetricsController.swift โ โโโ routes.swift โ โโโ configure.swift โ โโโ FrontendController.swift โ โโโ Run โ โโโ main.swift -
โข App has a single GHA work fl ow โข
Send metric points to the metrics service. โข Straight after the work fl owโs execution is done. โข No back-end service โข A work fl ow using the work fl ow_run event โข Run a Swift CLI ๐ GitHub Actions Metrics -
// swift-tools-version:5.6 import PackageDescription let package = Package( name: "Metrics",
platforms: [ .macOS(.v12) ], products: [ ], dependencies: [ ], targets: [ ] ) -
// swift-tools-version:5.6 import PackageDescription let package = Package( name: "Metrics",
platforms: [ .macOS(.v12) ], products: [ ], dependencies: [ ], targets: [ .executableTarget( name: "GithubActionsMetricsCLI", dependencies: [ ] ) ] ) -
// swift-tools-version:5.6 import PackageDescription let package = Package( name: "Metrics",
platforms: [ .macOS(.v12) ], products: [ .executable(name: "GithubActionsMetricsCLI", targets: ["GithubActionsMetricsCLI"]) ], dependencies: [ ], targets: [ .executableTarget( name: "GithubActionsMetricsCLI", dependencies: [ ] ) ] ) -
// swift-tools-version:5.6 import PackageDescription let package = Package( name: "Metrics",
platforms: [ .macOS(.v12) ], products: [ .executable(name: "GithubActionsMetricsCLI", targets: ["GithubActionsMetricsCLI"]) ], dependencies: [ .package(url: "https: // github.com/apple/swift-argument-parser.git", exact: "1.2.2") ], targets: [ .executableTarget( name: "GithubActionsMetricsCLI", dependencies: [ ] ) ] ) -
// swift-tools-version:5.6 import PackageDescription let package = Package( name: "Metrics",
platforms: [ .macOS(.v12) ], products: [ .executable(name: "GithubActionsMetricsCLI", targets: ["GithubActionsMetricsCLI"]) ], dependencies: [ .package(url: "https: // github.com/apple/swift-argument-parser.git", exact: "1.2.2") ], targets: [ .executableTarget( name: "GithubActionsMetricsCLI", dependencies: [ .product(name: "ArgumentParser", package: "swift-argument-parser") ] ) ] ) -
. โโโ Package.swift โโโ README.md โโโ Resources โ โโโ Views
โ โโโ Home.leaf โโโ Sources โ โโโ App โ โ โโโ Model.swift โ โ โโโ Migrations.swift โ โ โโโ MetricsController.swift โ โ โโโ routes.swift โ โ โโโ configure.swift โ โ โโโ FrontendController.swift โ โโโ Run โ โโโ main.swift -
. โโโ Package.swift โโโ README.md โโโ Resources โ โโโ Views
โ โโโ Home.leaf โโโ Sources โ โโโ GithubActionsMetricsCLI โ โ โโโ GithubActionsMetricsCLI.swift โ โโโ App โ โ โโโ Model.swift โ โ โโโ Migrations.swift โ โ โโโ MetricsController.swift โ โ โโโ routes.swift โ โ โโโ configure.swift โ โ โโโ FrontendController.swift โ โโโ Run โ โโโ main.swift -
import Foundation import ArgumentParser @main struct GithubActionsMetricsCLI: AsyncParsableCommand { @Argument
private var workflow: String @Argument private var updatedAt: String @Argument private var date: String @Argument private var repository: String @Argument private var outcome: String @Argument private var author: String func run() async throws { } } -
func run() async throws { guard let updateAtDate = Date(from:
updatedAt), let startedAtDate = Date(from: date) else { return } } extension Date { init?(from isoString: String) { let dateFormatter = DateFormatter() dateFormatter.locale = Locale(identifier: "en_US_POSIX") dateFormatter.dateFormat = "yyyy-MM-dd'T'HH:mm:ssZ" if let date = dateFormatter.date(from: isoString) { self = date } else { return nil } } } -
func run() async throws { guard let updateAtDate = Date(from:
updatedAt), let startedAtDate = Date(from: date) else { return } } -
func run() async throws { guard let updateAtDate = Date(from:
updatedAt), let startedAtDate = Date(from: date) else { return } let duration = updateAtDate.timeIntervalSince(startedAtDate) } -
func run() async throws { guard let updateAtDate = Date(from:
updatedAt), let startedAtDate = Date(from: date) else { return } let duration = updateAtDate.timeIntervalSince(startedAtDate) guard let outcome = adapt(githubActionsOutcome: outcome) else { print("Not handling the GHA outcome \(outcome.rawValue)") return } } private func adapt(githubActionsOutcome: GithubActionOutcome) -> Outcome? { switch githubActionsOutcome { case .success: return .success case .failure: return .failure case .cancelled: return .cancelled default: return nil } } -
func run() async throws { guard let updateAtDate = Date(from:
updatedAt), let startedAtDate = Date(from: date) else { return } let duration = updateAtDate.timeIntervalSince(startedAtDate) guard let outcome = adapt(githubActionsOutcome: outcome) else { print("Not handling the GHA outcome \(outcome.rawValue)") return } } -
func run() async throws { guard let updateAtDate = Date(from:
updatedAt), let startedAtDate = Date(from: date) else { return } let duration = updateAtDate.timeIntervalSince(startedAtDate) guard let outcome = adapt(githubActionsOutcome: outcome) else { print("Not handling the GHA outcome \(outcome.rawValue)") return } guard let analyticsEndpoint = ProcessInfo.processInfo.environment["ANALYTICS_ENDPOINT"] else { print("ANALYTICS_ENDPOINT is not set. Skipping sending analytics.") return } } -
func run() async throws { guard let updateAtDate = Date(from:
updatedAt), let startedAtDate = Date(from: date) else { return } let duration = updateAtDate.timeIntervalSince(startedAtDate) guard let outcome = adapt(githubActionsOutcome: outcome) else { print("Not handling the GHA outcome \(outcome.rawValue)") return } guard let analyticsEndpoint = ProcessInfo.processInfo.environment["ANALYTICS_ENDPOINT"] else { print("ANALYTICS_ENDPOINT is not set. Skipping sending analytics.") return } let payload = Payload( workflow: workflow, duration: Int(duration), date: startedAtDate, provider: .githubActions, author: author, outcome: outcome, repository: repository ) } -
func run() async throws { guard let updateAtDate = Date(from:
updatedAt), let startedAtDate = Date(from: date) else { return } let duration = updateAtDate.timeIntervalSince(startedAtDate) guard let outcome = adapt(githubActionsOutcome: outcome) else { print("Not handling the GHA outcome \(outcome.rawValue)") return } guard let analyticsEndpoint = ProcessInfo.processInfo.environment["ANALYTICS_ENDPOINT"] else { print("ANALYTICS_ENDPOINT is not set. Skipping sending analytics.") return } let payload = Payload( workflow: workflow, duration: Int(duration), date: startedAtDate, provider: .githubActions, author: author, outcome: outcome, repository: repository ) let analyticsService = Factory.make(with: analyticsEndpoint) _ = try await analyticsService.send(payload: payload) } -
Creating a workflow . โโโ .github โ โโโ workflows โ
โโโ lint.yml โ โโโ workflow_run.yml -
. โโโ .github โ โโโ workflows โ โโโ lint.yml โ
โโโ workflow_run.yml name: Log workflow run metrics Creating a workflow -
name: Log workflow run metrics on: workflow_run: workflows: [Lint] types:
- completed Creating a workflow . โโโ .github โ โโโ workflows โ โโโ lint.yml โ โโโ workflow_run.yml -
name: Log workflow run metrics on: workflow_run: workflows: [Lint] types:
- completed jobs: log: runs-on: macos-latest Creating a workflow . โโโ .github โ โโโ workflows โ โโโ lint.yml โ โโโ workflow_run.yml -
name: Log workflow run metrics on: workflow_run: workflows: [Lint] types:
- completed jobs: log: runs-on: macos-latest env: ANALYTICS_ENDPOINT: ${{ secrets.ANALYTICS_ENDPOINT }} Creating a workflow . โโโ .github โ โโโ workflows โ โโโ lint.yml โ โโโ workflow_run.yml -
name: Log workflow run metrics on: workflow_run: workflows: [Lint] types:
- completed jobs: log: runs-on: macos-latest env: ANALYTICS_ENDPOINT: ${{ secrets.ANALYTICS_ENDPOINT }} steps: - uses: actions/checkout@v3 with: repository: polpielladev/metrics Creating a workflow . โโโ .github โ โโโ workflows โ โโโ lint.yml โ โโโ workflow_run.yml -
name: Log workflow run metrics on: workflow_run: workflows: [Lint] types:
- completed jobs: log: runs-on: macos-latest env: ANALYTICS_ENDPOINT: ${{ secrets.ANALYTICS_ENDPOINT }} steps: - uses: actions/checkout@v3 with: repository: polpielladev/metrics - run: | swift run GithubActionsMetricsCLI \ "${{ github.event.workflow_run.name }}" \ "${{ github.event.workflow_run.updated_at }}" \ "${{ github.event.workflow_run.run_started_at }}" \ "${{ github.event.workflow_run.head_repository.name }}" \ "${{ github.event.workflow_run.conclusion }}" \ "${{ github.event.workflow_run.head_commit.author.name }}" Creating a workflow . โโโ .github โ โโโ workflows โ โโโ lint.yml โ โโโ workflow_run.yml -
Another example Used by the Swift Package Index project to
generate Pull Requests from issues using webhook logic directly in GHA work fl ows. -
Learn more I have an article on the topic where
you can fi nd a more in- depth explanation of this section of the slides. -
โข Send metrics from all Xcode Cloud work fl ows.
โข Straight after the work fl ow is done executing. โข Using an Xcode Cloud webhook. โข Serverless Swift lambda. Xcode Cloud metrics -
// swift-tools-version:5.6 import PackageDescription let package = Package( name: "Metrics",
platforms: [ .macOS(.v12) ], products: [ ], dependencies: [ ], targets: [ ] ) -
// swift-tools-version:5.6 import PackageDescription let package = Package( name: "Metrics",
platforms: [ .macOS(.v12) ], products: [ ], dependencies: [ .package(url: "https: // github.com/swift-server/swift-aws-lambda-runtime.git", exact: "1.0.0-alpha.1"), .package(url: "https: // github.com/swift-server/swift-aws-lambda-events.git", exact: "0.1.0") ], targets: [ ] ) -
// swift-tools-version:5.6 import PackageDescription let package = Package( name: "Metrics",
platforms: [ .macOS(.v12) ], products: [ ], dependencies: [ .package(url: "https: // github.com/swift-server/swift-aws-lambda-runtime.git", exact: "1.0.0-alpha.1"), .package(url: "https: // github.com/swift-server/swift-aws-lambda-events.git", exact: "0.1.0") ], targets: [ .executableTarget( name: "XcodeCloudWebhook", dependencies: [ .product(name: "AWSLambdaRuntime", package: "swift-aws-lambda-runtime"), .product(name: "AWSLambdaEvents", package: "swift-aws-lambda-events") ] ) ] ) -
// swift-tools-version:5.6 import PackageDescription let package = Package( name: "Metrics",
platforms: [ .macOS(.v12) ], products: [ .executable(name: "XcodeCloudWebhook", targets: ["XcodeCloudWebhook"]) ], dependencies: [ .package(url: "https: // github.com/swift-server/swift-aws-lambda-runtime.git", exact: "1.0.0-alpha.1"), .package(url: "https: // github.com/swift-server/swift-aws-lambda-events.git", exact: "0.1.0") ], targets: [ .executableTarget( name: "XcodeCloudWebhook", dependencies: [ .product(name: "AWSLambdaRuntime", package: "swift-aws-lambda-runtime"), .product(name: "AWSLambdaEvents", package: "swift-aws-lambda-events") ] ) ] ) -
. โโโ Package.swift โโโ README.md โโโ Resources โ โโโ Views
โ โโโ Home.leaf โโโ Sources โ โโโ XcodeCloudWebhook โ โ โโโ XcodeCloudWebhook.swift โ โโโ GithubActionsMetricsCLI โ โ โโโ GithubActionsMetricsCLI.swift โ โโโ App โ โ โโโ Model.swift โ โ โโโ Migrations.swift โ โ โโโ MetricsController.swift โ โ โโโ routes.swift โ โ โโโ configure.swift โ โ โโโ FrontendController.swift โ โโโ Run โ โโโ main.swift -
import AWSLambdaRuntime import AWSLambdaEvents import Foundation @main struct XcodeCloudWebhook: SimpleLambdaHandler
{ let decoder: JSONDecoder init() { let dateFormatter = DateFormatter() dateFormatter.dateFormat = "yyyy-MM-dd'T'HH:mm:ss.SSSZ" let decoder = JSONDecoder() decoder.dateDecodingStrategy = .formatted(dateFormatter) self.decoder = decoder } } -
import AWSLambdaRuntime import AWSLambdaEvents import Foundation @main struct XcodeCloudWebhook: SimpleLambdaHandler
{ let decoder: JSONDecoder init() { let dateFormatter = DateFormatter() dateFormatter.dateFormat = "yyyy-MM-dd'T'HH:mm:ss.SSSZ" let decoder = JSONDecoder() decoder.dateDecodingStrategy = .formatted(dateFormatter) self.decoder = decoder } func handle(_ request: APIGatewayV2Request, context: LambdaContext) async throws -> APIGatewayV2Response { } } -
func handle(_ request: APIGatewayV2Request, context: LambdaContext) async throws -> APIGatewayV2Response
{ guard let body = request.body, let bodyData = body.data(using: .utf8), let payload = try? decoder.decode(WebhookPayload.self, from: bodyData) else { return .init(statusCode: .ok, body: "Not handling the request ... ") } } -
func handle(_ request: APIGatewayV2Request, context: LambdaContext) async throws -> APIGatewayV2Response
{ guard let body = request.body, let bodyData = body.data(using: .utf8), let payload = try? decoder.decode(WebhookPayload.self, from: bodyData), payload.ciBuildRun.attributes.executionProgress == "COMPLETE" else { return .init(statusCode: .ok, body: "Not handling the request ... ") } } -
func handle(_ request: APIGatewayV2Request, context: LambdaContext) async throws -> APIGatewayV2Response
{ guard let body = request.body, let bodyData = body.data(using: .utf8), let payload = try? decoder.decode(WebhookPayload.self, from: bodyData), payload.ciBuildRun.attributes.executionProgress == "COMPLETE" else { return .init(statusCode: .ok, body: "Not handling the request ... ") } guard let analyticsEndpoint = ProcessInfo.processInfo.environment["ANALYTICS_ENDPOINT"] else { print("ANALYTICS_ENDPOINT is not set. Skipping sending analytics.") return .init(statusCode: .internalServerError) } } -
func handle(_ request: APIGatewayV2Request, context: LambdaContext) async throws -> APIGatewayV2Response
{ guard let body = request.body, let bodyData = body.data(using: .utf8), let payload = try? decoder.decode(WebhookPayload.self, from: bodyData), payload.ciBuildRun.attributes.executionProgress == "COMPLETE" else { return .init(statusCode: .ok, body: "Not handling the request ... ") } guard let analyticsEndpoint = ProcessInfo.processInfo.environment["ANALYTICS_ENDPOINT"] else { print("ANALYTICS_ENDPOINT is not set. Skipping sending analytics.") return .init(statusCode: .internalServerError) } let analyticsService = Factory.make(with: analyticsEndpoint) } -
func handle(_ request: APIGatewayV2Request, context: LambdaContext) async throws -> APIGatewayV2Response
{ guard let body = request.body, let bodyData = body.data(using: .utf8), let payload = try? decoder.decode(WebhookPayload.self, from: bodyData), payload.ciBuildRun.attributes.executionProgress == "COMPLETE" else { return .init(statusCode: .ok, body: "Not handling the request ... ") } guard let analyticsEndpoint = ProcessInfo.processInfo.environment["ANALYTICS_ENDPOINT"] else { print("ANALYTICS_ENDPOINT is not set. Skipping sending analytics.") return .init(statusCode: .internalServerError) } let analyticsService = Factory.make(with: analyticsEndpoint) guard let startDate = payload.ciBuildRun.attributes.startedDate, let duration = payload .ciBuildRun .attributes .finishedDate? .timeIntervalSince(startDate), let outcome = Self.adapt(xcodeCloudOutcome: payload.ciBuildRun.attributes.completionStatus) else { return .init(statusCode: .ok, body: "Not handling this request ... ") } } -
guard let analyticsEndpoint = ProcessInfo.processInfo.environment["ANALYTICS_ENDPOINT"] else { print("ANALYTICS_ENDPOINT is not
set. Skipping sending analytics.") return .init(statusCode: .internalServerError) } let analyticsService = Factory.make(with: analyticsEndpoint) guard let startDate = payload.ciBuildRun.attributes.startedDate, let duration = payload .ciBuildRun .attributes .finishedDate? .timeIntervalSince(startDate), let outcome = Self.adapt(xcodeCloudOutcome: payload.ciBuildRun.attributes.completionStatus) else { return .init(statusCode: .ok, body: "Not handling this request ... ") } let analyticsPayload = Payload( workflow: payload.ciWorkflow.attributes.name, duration: Int(duration), date: startDate, provider: .xcodeCloud, author: payload.ciBuildRun.attributes.sourceCommit.author.displayName, outcome: outcome, repository: payload.scmRepository.attributes.repositoryName ) _ = try await analyticsService.send(payload: analyticsPayload) return .init(statusCode: .ok) } -
Letโs deploy the lambda! swift package \ --disable-sandbox archive \
--swift-version 5.7 \ --output-path . \ --products XcodeCloudWebhook -
Letโs deploy the lambda! swift package \ --disable-sandbox archive \
--swift-version 5.7 \ --output-path . \ --products XcodeCloudWebhook -
Letโs deploy the lambda! swift package \ --disable-sandbox archive \
--swift-version 5.7 \ --output-path . \ --products XcodeCloudWebhook -
Learn more I have an article on the topic where
you can fi nd a more in- depth explanation of this section of this section. -
๐ Letโs wrap up! โ A full-stack website using Vapor
๐ An API using Vapor ๐ป A command line tool for macOS, extensible to other platforms too! ๐ A serverless Swift lambda using AWS ๐ฆ Everything in the same Swift Package! โค Swift is great for developer tooling! ๐ค Great way to upskill!