feat(sg): report user os information via analytics (#64280)

Closes DINF-193

![CleanShot 2024-08-05 at 21 28
37@2x](https://github.com/user-attachments/assets/34f121c5-5a85-456c-b12b-2f959573fcae)

OS information is now part of the `sg` analytics metadata.


## Test plan

<!-- REQUIRED; info at
https://docs-legacy.sourcegraph.com/dev/background-information/testing_principles
-->

Any `sg` operation now reports the os information.

## Changelog

<!-- OPTIONAL; info at
https://www.notion.so/sourcegraph/Writing-a-changelog-entry-dd997f411d524caabf0d8d38a24a878c
-->

Author: BolajiOlajide

dev/sg/internal/analytics/analytics.go

@@ -7,6 +7,7 @@ import (
 	"fmt"
 	"os"
 	"path"
+	"runtime"
 	"sync"
 	"time"
 
@@ -151,6 +152,14 @@ func (i invocation) GetArgs() []any {
 	return v.([]any)
 }
 
+func (i invocation) GetOS() string {
+	v, ok := i.metadata["os"]
+	if !ok {
+		return ""
+	}
+	return v.(string)
+}
+
 var store = sync.OnceValue(func() analyticsStore {
 	db, err := newDiskStore()
 	if err != nil {
@@ -191,14 +200,15 @@ type analyticsStore struct {
 	db Execer
 }
 
-func (s analyticsStore) NewInvocation(ctx context.Context, uuid uuid.UUID, version string, meta map[string]any) error {
+func (s analyticsStore) NewInvocation(_ context.Context, uuid uuid.UUID, version string, meta map[string]any) error {
 	if s.db == nil {
 		return ErrDBNotInitialized
 	}
 
 	meta["user_id"] = getEmail()
 	meta["version"] = version
 	meta["start_time"] = time.Now()
+	meta["os"] = getOS()
 
 	b, err := json.Marshal(meta)
 	if err != nil {
@@ -213,7 +223,7 @@ func (s analyticsStore) NewInvocation(ctx context.Context, uuid uuid.UUID, versi
 	return nil
 }
 
-func (s analyticsStore) AddMetadata(ctx context.Context, uuid uuid.UUID, meta map[string]any) error {
+func (s analyticsStore) AddMetadata(_ context.Context, uuid uuid.UUID, meta map[string]any) error {
 	if s.db == nil {
 		return ErrDBNotInitialized
 	}
@@ -231,7 +241,7 @@ func (s analyticsStore) AddMetadata(ctx context.Context, uuid uuid.UUID, meta ma
 	return nil
 }
 
-func (s analyticsStore) DeleteInvocation(ctx context.Context, uuid string) error {
+func (s analyticsStore) DeleteInvocation(_ context.Context, uuid string) error {
 	if s.db == nil {
 		return ErrDBNotInitialized
 	}
@@ -244,7 +254,7 @@ func (s analyticsStore) DeleteInvocation(ctx context.Context, uuid string) error
 	return nil
 }
 
-func (s analyticsStore) ListCompleted(ctx context.Context) ([]invocation, error) {
+func (s analyticsStore) ListCompleted(_ context.Context) ([]invocation, error) {
 	if s.db == nil {
 		return nil, nil
 	}
@@ -304,6 +314,24 @@ func emailfunc() string {
 
 var getEmail = sync.OnceValue[string](emailfunc)
 
+func osFunc() string {
+	userOS := runtime.GOOS
+	switch userOS {
+	case "windows":
+		return "Windows"
+	case "darwin":
+		return "macOS"
+	case "linux":
+		return "Linux"
+	default:
+		// weird case, but catching it instead of throwing an error
+		return userOS
+	}
+}
+
+// Dont invoke this function directly. Use the `getOS` function instead.
+var getOS = sync.OnceValue[string](osFunc)
+
 func NewInvocation(ctx context.Context, version string, meta map[string]any) (context.Context, error) {
 	// v7 for sortable property (not vital as we also store timestamps, but no harm to have)
 	u, _ := uuid.NewV7()

dev/sg/internal/analytics/bigquery.go

@@ -77,6 +77,7 @@ func NewEvent(i invocation) *event {
 		"failed":    i.IsFailed(),
 		"cancelled": i.IsCancelled(),
 		"panicked":  i.IsPanicked(),
+		"os":        i.GetOS(),
 	}
 
 	e.Metadata, _ = json.Marshal(metadata)