⌘ kean.blog

Pulse: Network Inspector

  

On iOS, there is this friction when it comes to debugging apps. You can’t inspect anything that happens behind the scenes unless you use special tools. You can’t even see network requests.

There are tools that can help: Wireshark, Proxyman, Charles, etc. These are all phenomenal tools, but they are all kind of complicated. For example, to start using Proxyman you need to install a root certificate on your iPhone. It basically performs a MITM attack to see your encrypted traffic. Charles is closer to what I want. My understanding is that it does it by using Packet Tunnel Provider with a custom HTTP proxy.

Update: Proxyman released a Proxyman iOS Beta right after this post, a great Charles alternative.

What I wished iOS had is a simple analog of Safari Web Inspector. So I built just that. It also turned out to be a macOS app thanks to SwiftUI.

Pulse, a structured logging system built using SwiftUI Pulse, a structured logging system built using SwiftUI Pulse, a structured logging system built using SwiftUI Pulse, a structured logging system built using SwiftUI Pulse, a structured logging system built using SwiftUI

Pulse #

Pulse is not an app. It’s a framework with programmatic interfaces for everything. It consists of the following parts:

  • Pulse, a logging system with structured persistent storage that implements SwiftLog protocol
  • PulseUI, a SwiftUI-based framework with components that you can embed directly into your app, e.g. ConsoleView. This framework is private and is available for GitHub sponsors. It will be open sourced when there are enough sponsors behind it.
  • A macOS app based on PulseUI.

Integrating PulseUI is easy. You add a package to your app and configure it to record the events and metrics provided by URLSession. There are no certificates or VPN tunnels involved and it only sees your app’s URLSession traffic. You can show a PulseUI.ConsoleView to see the requests and other logs in real-time.

You can bind the presentation of the ConsoleView to a shake gesture. This also allows you to use Cmd+Ctrl+Z shortcut in a simulator to display it, convenient.

The main advantage of Pulse is that it is always there and recording: logs, network events, metrics. And you don’t have to be in front of a computer to use it. If a team member encounters an issue in one of your builds, all the information is recorded and can be shared using any native mechanism, such as AirDrop. It’s super easy.

I think the best way to think about Pulse is not as a network debugging tool but as a comprehensive logging system.

SwiftUI #

The key to this project is SwiftUI. The speed with which I was able to develop it should not even be possible. With SwiftUI, you can program at a speed of thought (and as fast as you can type). Instant feedback is enlivening.

I also used MVVM. And I’m glad I did. When the time came to implement the “Share” feature, I was simply able to use the same ViewModels that I created for SwiftUI views, but instead of binding them to Views, I was able to simply print all the outputs as text. No changes to the ViewModels themselves. This is MVVM at its best.

Conclusion #

I have a massive backlog for this project, but I’m already extremely happy with the results. If you want to try it and support the project, please join to GitHub sponsors. The plan is to open source it once there is enough sponsors.