Commitd311dda

authored

feat: add enrichment of StartRequest with OS, device ID, version (#123)

Enriches `StartRequest` protocol message with device ID, OS, and version, for Coder Desktop telemetry.

1 parentf53a99f commitd311ddaCopy full SHA for d311dda

File tree

+608

-4

lines changed

+608

-4

lines changed

Lines changed: 3 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,7 @@ import VPNLib`
`6`	`6`	`actorManager{`
`7`	`7`	`letptp:PacketTunnelProvider`
`8`	`8`	`letcfg:ManagerConfig`
	`9`	`+lettelemetryEnricher:TelemetryEnricher`
`9`	`10`
`10`	`11`	`lettunnelHandle:TunnelHandle`
`11`	`12`	`letspeaker:Speaker<Vpn_ManagerMessage,Vpn_TunnelMessage>`
`@@ -19,6 +20,7 @@ actor Manager {`
`19`	`20`	`init(with:PacketTunnelProvider, cfg:ManagerConfig)asyncthrows(ManagerError){`
`20`	`21`	`ptp= with`
`21`	`22`	`self.cfg= cfg`
	`23`	`+ telemetryEnricher=TelemetryEnricher()`
`22`	`24`	`#if arch(arm64)`
`23`	`25`	`letdylibPath= cfg.serverUrl.appending(path:"bin/coder-vpn-darwin-arm64.dylib")`
`24`	`26`	`#elseif arch(x86_64)`
`@@ -176,6 +178,7 @@ actor Manager {`
`176`	`178`	`req.value= header.value`
`177`	`179`	`}`
`178`	`180`	`}`
	`181`	`+ req= telemetryEnricher.enrich(req)`
`179`	`182`	`}`
`180`	`183`	`})`
`181`	`184`	`}catch{`

Lines changed: 5 additions & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -88,8 +88,11 @@ public actor Speaker<SendMsg: RPCMessage & Message, RecvMsg: RPCMessage & Messag`
`88`	`88`
`89`	`89`	`/// Does the VPN Protocol handshake and validates the result`
`90`	`90`	`publicfunc handshake()asyncthrows(HandshakeError){`
`91`		`-lethndsh=Handshaker(writeFD: writeFD, dispatch: dispatch, queue: queue, role: role)`
`92`		`- // ignore the version for now because we know it can only be 1.0`
	`91`	`+lethndsh=Handshaker(writeFD: writeFD, dispatch: dispatch, queue: queue, role: role,`
	`92`	`+ versions:[ProtoVersion(1,1)])`
	`93`	`+ // ignore the version for now because we know it can only be 1.0 or 1.1.`
	`94`	`+ // 1.1 adds support for telemetry to StartRequest, but since setting these`
	`95`	`+ // fields won't adversely affect a 1.0 speaker, we set them regardless.`
`93`	`96`	`try _=await hndsh.handshake()`
`94`	`97`	`}`
`95`	`98`

Lines changed: 31 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,31 @@`
	`1`	`+import Foundation`
	`2`	`+`
	`3`	`+publicstructTelemetryEnricher{`
	`4`	`+privateletdeviceID:String`
	`5`	`+privateletversion:String?`
	`6`	`+`
	`7`	`+publicinit(){`
	`8`	`+ version=Bundle.main.infoDictionary?["CFBundleShortVersionString"]as?String`
	`9`	`+`
	`10`	`+letuserDefaults=UserDefaults.standard`
	`11`	`+letkey="deviceID"`
	`12`	`+`
	`13`	`+iflet existingID= userDefaults.string(forKey: key){`
	`14`	`+ deviceID= existingID`
	`15`	`+}else{`
	`16`	`+letnewID=UUID().uuidString`
	`17`	`+ userDefaults.set(newID, forKey: key)`
	`18`	`+ deviceID= newID`
	`19`	`+}`
	`20`	`+}`
	`21`	`+`
	`22`	`+publicfunc enrich(_ original:Vpn_StartRequest)->Vpn_StartRequest{`
	`23`	`+varreq= original`
	`24`	`+ req.deviceOs="macOS"`
	`25`	`+ req.deviceID= deviceID`
	`26`	`+iflet version{`
	`27`	`+ req.coderDesktopVersion= version`
	`28`	`+}`
	`29`	`+return req`
	`30`	`+}`
	`31`	`+}`

Comments

(0)