obfuscate workspace module source and version

hugodutka · hugodutka · commit 175c10e5d7a3 · 2024-11-13T13:50:38.000+01:00
diff --git a/coderd/telemetry/telemetry.go b/coderd/telemetry/telemetry.go
@@ -677,12 +677,20 @@ func ConvertWorkspaceResourceMetadata(metadata database.WorkspaceResourceMetadat
 }
 
 func ConvertWorkspaceModule(module database.WorkspaceModule) WorkspaceModule {
+	isCoderModule := strings.Contains(module.Source, "registry.coder.com")
+	source := module.Source
+	version := module.Version
+	if !isCoderModule {
+		source = fmt.Sprintf("%x", sha256.Sum256([]byte(source)))
+		version = fmt.Sprintf("%x", sha256.Sum256([]byte(version)))
+	}
+
 	return WorkspaceModule{
 		ID:         module.ID,
 		JobID:      module.JobID,
 		Transition: module.Transition,
-		Source:     module.Source,
-		Version:    module.Version,
+		Source:     source,
+		Version:    version,
 		Key:        module.Key,
 		CreatedAt:  module.CreatedAt,
 	}
diff --git a/coderd/telemetry/telemetry_test.go b/coderd/telemetry/telemetry_test.go
@@ -5,6 +5,7 @@ import (
 	"net/http"
 	"net/http/httptest"
 	"net/url"
+	"sort"
 	"testing"
 	"time"
 
@@ -122,6 +123,28 @@ func TestTelemetry(t *testing.T) {
 		require.Len(t, snapshot.Users, 1)
 		require.Equal(t, snapshot.Users[0].EmailHashed, "bb44bf07cf9a2db0554bba63a03d822c927deae77df101874496df5a6a3e896d@coder.com")
 	})
+	t.Run("HashedModule", func(t *testing.T) {
+		t.Parallel()
+		db := dbmem.New()
+		_ = dbgen.WorkspaceModule(t, db, database.WorkspaceModule{
+			Source:  "registry.coder.com/terraform/aws",
+			Version: "1.0.0",
+		})
+		_ = dbgen.WorkspaceModule(t, db, database.WorkspaceModule{
+			Source:  "internal-url.com/some-module",
+			Version: "1.0.0",
+		})
+		_, snapshot := collectSnapshot(t, db, nil)
+		require.Len(t, snapshot.WorkspaceModules, 2)
+		modules := snapshot.WorkspaceModules
+		sort.Slice(modules, func(i, j int) bool {
+			return modules[i].Source < modules[j].Source
+		})
+		require.Equal(t, modules[0].Source, "921c61d6f3eef5118f3cae658d1518b378c5b02a4955a766c791440894d989c5")
+		require.Equal(t, modules[0].Version, "92521fc3cbd964bdc9f584a991b89fddaa5754ed1cc96d6d42445338669c1305")
+		require.Equal(t, modules[1].Source, "registry.coder.com/terraform/aws")
+		require.Equal(t, modules[1].Version, "1.0.0")
+	})
 }
 
 // nolint:paralleltest
