- Notifications
You must be signed in to change notification settings - Fork923
feat: adds device_id, device_os, and coder_desktop_version to telemetry#17086
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes fromall commits
Commits
Show all changes
2 commits Select commitHold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
30 changes: 30 additions & 0 deletionscoderd/workspaceagents.go
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
170 changes: 137 additions & 33 deletionscoderd/workspaceagents_test.go
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -51,6 +51,7 @@ import ( | ||
| "github.com/coder/coder/v2/coderd/jwtutils" | ||
| "github.com/coder/coder/v2/coderd/rbac" | ||
| "github.com/coder/coder/v2/coderd/telemetry" | ||
| "github.com/coder/coder/v2/coderd/util/ptr" | ||
| "github.com/coder/coder/v2/codersdk" | ||
| "github.com/coder/coder/v2/codersdk/agentsdk" | ||
| "github.com/coder/coder/v2/codersdk/workspacesdk" | ||
| @@ -2135,30 +2136,21 @@ func TestOwnedWorkspacesCoordinate(t *testing.T) { | ||
| ctx := testutil.Context(t, testutil.WaitLong) | ||
| logger := testutil.Logger(t) | ||
| firstClient, _, api := coderdtest.NewWithAPI(t, &coderdtest.Options{ | ||
| Coordinator: tailnet.NewCoordinator(logger), | ||
| }) | ||
| firstUser := coderdtest.CreateFirstUser(t, firstClient) | ||
| member, memberUser := coderdtest.CreateAnotherUser(t, firstClient, firstUser.OrganizationID, rbac.RoleTemplateAdmin()) | ||
| // Create a workspace with an agent | ||
| firstWorkspace := buildWorkspaceWithAgent(t, member, firstUser.OrganizationID, memberUser.ID, api.Database, api.Pubsub) | ||
| u, err := member.URL.Parse("/api/v2/tailnet") | ||
| require.NoError(t, err) | ||
| q := u.Query() | ||
| q.Set("version", "2.0") | ||
| u.RawQuery = q.Encode() | ||
| //nolint:bodyclose // websocket package closes this for you | ||
| wsConn, resp, err := websocket.Dial(ctx, u.String(), &websocket.DialOptions{ | ||
| HTTPHeader: http.Header{ | ||
| @@ -2173,15 +2165,6 @@ func TestOwnedWorkspacesCoordinate(t *testing.T) { | ||
| } | ||
| defer wsConn.Close(websocket.StatusNormalClosure, "done") | ||
| rpcClient, err := tailnet.NewDRPCClient( | ||
| websocket.NetConn(ctx, wsConn, websocket.MessageBinary), | ||
| logger, | ||
| @@ -2229,23 +2212,135 @@ func TestOwnedWorkspacesCoordinate(t *testing.T) { | ||
| NumAgents: 0, | ||
| }, | ||
| }) | ||
| } | ||
| func TestUserTailnetTelemetry(t *testing.T) { | ||
| t.Parallel() | ||
| telemetryData := &codersdk.CoderDesktopTelemetry{ | ||
| DeviceOS: "Windows", | ||
| DeviceID: "device001", | ||
| CoderDesktopVersion: "0.22.1", | ||
| } | ||
| fullHeader, err := json.Marshal(telemetryData) | ||
| require.NoError(t, err) | ||
| testCases := []struct { | ||
| name string | ||
| headers map[string]string | ||
| // only used for DeviceID, DeviceOS, CoderDesktopVersion | ||
| expected telemetry.UserTailnetConnection | ||
| }{ | ||
| { | ||
| name: "no header", | ||
| headers: map[string]string{}, | ||
| expected: telemetry.UserTailnetConnection{}, | ||
| }, | ||
| { | ||
| name: "full header", | ||
| headers: map[string]string{ | ||
| codersdk.CoderDesktopTelemetryHeader: string(fullHeader), | ||
| }, | ||
| expected: telemetry.UserTailnetConnection{ | ||
| DeviceOS: ptr.Ref("Windows"), | ||
| DeviceID: ptr.Ref("device001"), | ||
| CoderDesktopVersion: ptr.Ref("0.22.1"), | ||
| }, | ||
| }, | ||
| { | ||
| name: "empty header", | ||
| headers: map[string]string{ | ||
| codersdk.CoderDesktopTelemetryHeader: "", | ||
| }, | ||
| expected: telemetry.UserTailnetConnection{}, | ||
| }, | ||
| { | ||
| name: "invalid header", | ||
| headers: map[string]string{ | ||
| codersdk.CoderDesktopTelemetryHeader: "{\"device_os", | ||
| }, | ||
| expected: telemetry.UserTailnetConnection{}, | ||
| }, | ||
| } | ||
| // nolint: paralleltest // no longer need to reinitialize loop vars in go 1.22 | ||
| for _, tc := range testCases { | ||
| t.Run(tc.name, func(t *testing.T) { | ||
| t.Parallel() | ||
| ctx := testutil.Context(t, testutil.WaitLong) | ||
| logger := testutil.Logger(t) | ||
| fTelemetry := newFakeTelemetryReporter(ctx, t, 200) | ||
| fTelemetry.enabled = false | ||
| firstClient := coderdtest.New(t, &coderdtest.Options{ | ||
| Logger: &logger, | ||
| TelemetryReporter: fTelemetry, | ||
| }) | ||
| firstUser := coderdtest.CreateFirstUser(t, firstClient) | ||
| member, memberUser := coderdtest.CreateAnotherUser(t, firstClient, firstUser.OrganizationID, rbac.RoleTemplateAdmin()) | ||
| headers := http.Header{ | ||
| "Coder-Session-Token": []string{member.SessionToken()}, | ||
| } | ||
| for k, v := range tc.headers { | ||
| headers.Add(k, v) | ||
| } | ||
| // enable telemetry now that user is created. | ||
| fTelemetry.enabled = true | ||
| u, err := member.URL.Parse("/api/v2/tailnet") | ||
| require.NoError(t, err) | ||
| q := u.Query() | ||
| q.Set("version", "2.0") | ||
| u.RawQuery = q.Encode() | ||
| predialTime := time.Now() | ||
| //nolint:bodyclose // websocket package closes this for you | ||
| wsConn, resp, err := websocket.Dial(ctx, u.String(), &websocket.DialOptions{ | ||
| HTTPHeader: headers, | ||
| }) | ||
| if err != nil { | ||
| if resp != nil && resp.StatusCode != http.StatusSwitchingProtocols { | ||
| err = codersdk.ReadBodyAsError(resp) | ||
| } | ||
| require.NoError(t, err) | ||
| } | ||
| defer wsConn.Close(websocket.StatusNormalClosure, "done") | ||
| // Check telemetry | ||
| snapshot := testutil.RequireRecvCtx(ctx, t, fTelemetry.snapshots) | ||
| require.Len(t, snapshot.UserTailnetConnections, 1) | ||
| telemetryConnection := snapshot.UserTailnetConnections[0] | ||
| require.Equal(t, memberUser.ID.String(), telemetryConnection.UserID) | ||
| require.GreaterOrEqual(t, telemetryConnection.ConnectedAt, predialTime) | ||
| require.LessOrEqual(t, telemetryConnection.ConnectedAt, time.Now()) | ||
| require.NotEmpty(t, telemetryConnection.PeerID) | ||
| requireEqualOrBothNil(t, telemetryConnection.DeviceID, tc.expected.DeviceID) | ||
| requireEqualOrBothNil(t, telemetryConnection.DeviceOS, tc.expected.DeviceOS) | ||
| requireEqualOrBothNil(t, telemetryConnection.CoderDesktopVersion, tc.expected.CoderDesktopVersion) | ||
| beforeDisconnectTime := time.Now() | ||
| err = wsConn.Close(websocket.StatusNormalClosure, "done") | ||
| require.NoError(t, err) | ||
| snapshot = testutil.RequireRecvCtx(ctx, t, fTelemetry.snapshots) | ||
| require.Len(t, snapshot.UserTailnetConnections, 1) | ||
| telemetryDisconnection := snapshot.UserTailnetConnections[0] | ||
| require.Equal(t, memberUser.ID.String(), telemetryDisconnection.UserID) | ||
| require.Equal(t, telemetryConnection.ConnectedAt, telemetryDisconnection.ConnectedAt) | ||
| require.Equal(t, telemetryConnection.UserID, telemetryDisconnection.UserID) | ||
| require.Equal(t, telemetryConnection.PeerID, telemetryDisconnection.PeerID) | ||
| require.NotNil(t, telemetryDisconnection.DisconnectedAt) | ||
| require.GreaterOrEqual(t, *telemetryDisconnection.DisconnectedAt, beforeDisconnectTime) | ||
| require.LessOrEqual(t, *telemetryDisconnection.DisconnectedAt, time.Now()) | ||
| requireEqualOrBothNil(t, telemetryConnection.DeviceID, tc.expected.DeviceID) | ||
| requireEqualOrBothNil(t, telemetryConnection.DeviceOS, tc.expected.DeviceOS) | ||
| requireEqualOrBothNil(t, telemetryConnection.CoderDesktopVersion, tc.expected.CoderDesktopVersion) | ||
| }) | ||
| } | ||
| } | ||
| func buildWorkspaceWithAgent( | ||
| @@ -2414,3 +2509,12 @@ func (f *fakeTelemetryReporter) Enabled() bool { | ||
| // Close implements the telemetry.Reporter interface. | ||
| func (*fakeTelemetryReporter) Close() {} | ||
| func requireEqualOrBothNil[T any](t testing.TB, a, b *T) { | ||
| t.Helper() | ||
| if a != nil && b != nil { | ||
| require.Equal(t, *a, *b) | ||
| return | ||
| } | ||
| require.Equal(t, a, b) | ||
| } | ||
Comment on lines +2513 to +2520 There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. suggestion: potentially useful | ||
26 changes: 26 additions & 0 deletionscodersdk/client.go
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
1 change: 1 addition & 0 deletionscodersdk/client_internal_test.go
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -27,6 +27,7 @@ import ( | ||
| "cdr.dev/slog" | ||
| "cdr.dev/slog/sloggers/sloghuman" | ||
| "github.com/coder/coder/v2/testutil" | ||
| ) | ||
3 changes: 3 additions & 0 deletionssite/src/api/typesGenerated.ts
Some generated files are not rendered by default. Learn more abouthow customized files appear on GitHub.
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
15 changes: 8 additions & 7 deletionsvpn/speaker_internal_test.go
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.