feat(autocapture): auto capture element interactions

.github/workflows/test.yml

@@ -1,18 +1,18 @@
-name: Tests
-on:
-  push:
-    branches:
-      - main
-  pull_request:
-    paths-ignore:
-      - "**/*.md"
-jobs:
-  test:
-    runs-on: macos-13
-    steps:
-      - uses: actions/checkout@v4
-      - uses: maxim-lobanov/setup-xcode@v1
-        with:
-          xcode-version: latest-stable
-      - name: Test SDK
-        run: make test
+  name: Tests
+  on:
+    push:
+      branches:
+        - main
+    pull_request:
+      paths-ignore:
+        - "**/*.md"
+  jobs:
+    test:
+      runs-on: macos-13
+      steps:
+        - uses: actions/checkout@v4
+        - uses: maxim-lobanov/setup-xcode@v1
+          with:
+            xcode-version: latest-stable
+        - name: Test SDK
+          run: make test

.swiftformat

@@ -0,0 +1,96 @@
+--acronyms ID,URL,UUID
+--allman false
+--anonymousforeach convert
+--assetliterals visual-width
+--asynccapturing 
+--beforemarks 
+--binarygrouping none
+--callsiteparen default
+--categorymark "MARK: %c"
+--classthreshold 0
+--closingparen balanced
+--closurevoid remove
+--commas inline
+--complexattrs preserve
+--computedvarattrs preserve
+--condassignment after-property
+--conflictmarkers reject
+--dateformat system
+--decimalgrouping none
+--doccomments before-declarations
+--elseposition same-line
+--emptybraces no-space
+--enumnamespaces always
+--enumthreshold 0
+--exponentcase lowercase
+--exponentgrouping disabled
+--extensionacl on-extension
+--extensionlength 0
+--extensionmark "MARK: - %t + %c"
+--fractiongrouping disabled
+--fragment false
+--funcattributes preserve
+--generictypes 
+--groupedextension "MARK: %c"
+--guardelse auto
+--header ignore
+--hexgrouping 4,8
+--hexliteralcase uppercase
+--ifdef indent
+--importgrouping alpha
+--indent 4
+--indentcase false
+--indentstrings false
+--initcodernil false
+--lifecycle 
+--lineaftermarks true
+--linebreaks lf
+--markcategories true
+--markextensions always
+--marktypes always
+--maxwidth none
+--modifierorder 
+--nevertrailing 
+--nilinit remove
+--noncomplexattrs 
+--nospaceoperators 
+--nowrapoperators 
+--octalgrouping none
+--onelineforeach ignore
+--operatorfunc spaced
+--organizationmode visibility
+--organizetypes actor,class,enum,struct
+--patternlet hoist
+--ranges spaced
+--redundanttype infer-locals-only
+--self remove
+--selfrequired 
+--semicolons never
+--shortoptionals except-properties
+--smarttabs enabled
+--someany true
+--storedvarattrs preserve
+--stripunusedargs always
+--structthreshold 0
+--tabwidth unspecified
+--throwcapturing 
+--timezone system
+--trailingclosures 
+--trimwhitespace always
+--typeattributes preserve
+--typeblanklines remove
+--typedelimiter space-after
+--typemark "MARK: - %t"
+--voidtype void
+--wraparguments preserve
+--wrapcollections preserve
+--wrapconditions preserve
+--wrapeffects preserve
+--wrapenumcases always
+--wrapparameters default
+--wrapreturntype preserve
+--wrapternary default
+--wraptypealiases preserve
+--xcodeindentation disabled
+--yodaswap always
+--exclude PostHogExampleAutocapture,PostHogExample,PostHogExampleWithSPM,PostHogExampleAutocapture,PostHogTests,Pods,.build

.swiftlint.yml

@@ -1,6 +1,7 @@
 excluded: # case-sensitive paths to ignore during linting. Takes precedence over `included`
   - PostHogExample
   - PostHogExampleWithSPM
+  - PostHogExampleAutocapture
   - PostHogTests
   - PostHog/Utils/ReadWriteLock.swift
   - PostHog/Utils/Reachability.swift
@@ -19,6 +20,11 @@ file_length:
   warning: 1000
   error: 1200
 
+identifier_name:
+  excluded:
+    - id
+    - ^ph_.*$
+
 function_body_length:
   - 1000 # warning
   - 1200 # error

CHANGELOG.md

@@ -1,5 +1,7 @@
 ## Next
 
+- add autocapture support for UIKit ([#224](https://github.com/PostHog/posthog-ios/pull/224))
+
 ## 3.14.0 - 2024-11-05
 
 - add option to pass a custom timestamp when calling capture() ([#228](https://github.com/PostHog/posthog-ios/pull/228))

Makefile

@@ -1,3 +1,7 @@
+SIMULATOR_IOS_VERSION = $(shell xcrun simctl list | grep ^iOS | ruby -e 'puts /\(([0-9.]+).*\)/.match(STDIN.read.chomp.split("\n").last).to_a[1]')
+SIMULATOR_ID = $(call udid_for,$(SIMULATOR_IOS_VERSION),iPhone [0-9]+ [^M])
+TEST_ITERATIONS = 1
+
 .PHONY: build buildSdk buildExamples format swiftLint swiftFormat test testOniOSSimulator testOnMacSimulator lint bootstrap releaseCocoaPods
 
 build: buildSdk buildExamples
@@ -25,22 +29,26 @@ buildExamples:
 
 format: swiftLint swiftFormat
 
+print-env: 
+	@echo "Simulator iOS version: '$(SIMULATOR_IOS_VERSION)'"
+	@echo "Simulator UUID: '$(SIMULATOR_ID)'"
+
 swiftLint:
 	swiftlint --fix
 
 swiftFormat:
 	swiftformat . --swiftversion 5.3
 
-testOniOSSimulator:
-	set -o pipefail && xcrun xcodebuild test -scheme PostHog -destination 'platform=iOS Simulator,name=iPhone 15,OS=18.0' | xcpretty
+test-ios: print-env
+	set -o pipefail && xcrun xcodebuild test -scheme PostHog -destination platform="iOS Simulator,id=$(SIMULATOR_ID)" $(if $(filter-out 1,$(TEST_ITERATIONS)), -run-tests-until-failure -test-iterations $(TEST_ITERATIONS)) | xcpretty
 
-testOnMacSimulator:
+test-macos: 
 	set -o pipefail && xcrun xcodebuild test -scheme PostHog -destination 'platform=macOS' | xcpretty
 
-test:
+test: 
 	swift test | xcpretty
 
-lint:
+lint: 
 	swiftformat . --lint --swiftversion 5.3 && swiftlint
 
 # requires gem and brew
@@ -51,3 +59,15 @@ bootstrap:
 
 releaseCocoaPods:
 	pod trunk push PostHog.podspec --allow-warnings
+
+
+define udid_for
+$(shell xcrun simctl list --json devices available "$(1)" | jq -r --arg regex "$(2)" '
+  .devices 
+  | to_entries 
+  | map(select(.value | length > 0)) 
+  | map({key: .key, value: (.value | map(select(.name | test($$regex))))}) 
+  | map(select(.value | length > 0)) 
+  | .[0].value[0].udid
+')
+endef

Package.swift

@@ -4,20 +4,20 @@ import PackageDescription
 let package = Package(
     name: "PostHog",
     platforms: [
-        .macOS(.v10_15), .iOS(.v13), .tvOS(.v13), .watchOS(.v6),
+        .macOS(.v10_15), .iOS(.v13), .tvOS(.v13), .watchOS(.v6)
     ],
     products: [
         // Products define the executables and libraries a package produces, and make them visible to other packages.
         .library(
             name: "PostHog",
             targets: ["PostHog"]
-        ),
+        )
     ],
     dependencies: [
         // Dependencies declare other packages that this package depends on.
         .package(url: "https://github.com/Quick/Quick.git", from: "6.0.0"),
         .package(url: "https://github.com/Quick/Nimble.git", from: "12.0.0"),
-        .package(url: "https://github.com/AliSoftware/OHHTTPStubs.git", from: "9.0.0"),
+        .package(url: "https://github.com/AliSoftware/OHHTTPStubs.git", from: "9.0.0")
     ],
     targets: [
         // Targets are the basic building blocks of a package. A target can define a module or a test suite.
@@ -26,7 +26,7 @@ let package = Package(
             name: "PostHog",
             path: "PostHog",
             resources: [
-                .copy("Resources/PrivacyInfo.xcprivacy"),
+                .copy("Resources/PrivacyInfo.xcprivacy")
             ]
         ),
         .testTarget(
@@ -36,9 +36,9 @@ let package = Package(
                 "Quick",
                 "Nimble",
                 "OHHTTPStubs",
-                .product(name: "OHHTTPStubsSwift", package: "OHHTTPStubs"),
+                .product(name: "OHHTTPStubsSwift", package: "OHHTTPStubs")
             ],
             path: "PostHogTests"
-        ),
+        )
     ]
 )