Nov 16, 2024 · Nov 6, 2024 · Nov 6, 2024 · Nov 6, 2024 · Nov 7, 2024 · Nov 7, 2024
diff --git a/coderd/database/dbauthz/dbauthz.go b/coderd/database/dbauthz/dbauthz.go
 return q.db.GetWorkspaceModulesByJobID(ctx, jobID)
 }

 func (q *querier) GetWorkspaceModulesCreatedAfter(ctx context.Context, createdAt time.Time) ([]database.WorkspaceModule, error) {
 if err := q.authorizeContext(ctx, policy.ActionRead, rbac.ResourceSystem); err != nil {
 return nil, err
 }
 return q.db.GetWorkspaceModulesCreatedAfter(ctx, createdAt)
 }

 func (q *querier) GetWorkspaceProxies(ctx context.Context) ([]database.WorkspaceProxy, error) {
 return fetchWithPostFilter(q.auth, policy.ActionRead, func(ctx context.Context, _ interface{}) ([]database.WorkspaceProxy, error) {
 return q.db.GetWorkspaceProxies(ctx)
diff --git a/coderd/database/dbauthz/dbauthz_test.go b/coderd/database/dbauthz/dbauthz_test.go
 s.Run("GetWorkspaceModulesByJobID", s.Subtest(func(db database.Store, check *expects) {
 check.Args(uuid.New()).Asserts(rbac.ResourceSystem, policy.ActionRead)
 }))
 s.Run("GetWorkspaceModulesCreatedAfter", s.Subtest(func(db database.Store, check *expects) {
 check.Args(dbtime.Now()).Asserts(rbac.ResourceSystem, policy.ActionRead)
 }))
 }

 func (s *MethodTestSuite) TestNotifications() {
diff --git a/coderd/database/dbgen/dbgen.go b/coderd/database/dbgen/dbgen.go
 return resource
 }

 func WorkspaceModule(t testing.TB, db database.Store, orig database.WorkspaceModule) database.WorkspaceModule {
 module, err := db.InsertWorkspaceModule(genCtx, database.InsertWorkspaceModuleParams{
 ID:         takeFirst(orig.ID, uuid.New()),
 JobID:      takeFirst(orig.JobID, uuid.New()),
 Transition: takeFirst(orig.Transition, database.WorkspaceTransitionStart),
 Source:     takeFirst(orig.Source, "test-source"),
 Version:    takeFirst(orig.Version, "v1.0.0"),
 Key:        takeFirst(orig.Key, "test-key"),
 CreatedAt:  takeFirst(orig.CreatedAt, dbtime.Now()),
 })
 require.NoError(t, err, "insert workspace module")
 return module
 }

 func WorkspaceResourceMetadatums(t testing.TB, db database.Store, seed database.WorkspaceResourceMetadatum) []database.WorkspaceResourceMetadatum {
 meta, err := db.InsertWorkspaceResourceMetadata(genCtx, database.InsertWorkspaceResourceMetadataParams{
 WorkspaceResourceID: takeFirst(seed.WorkspaceResourceID, uuid.New()),
diff --git a/coderd/database/dbmem/dbmem.go b/coderd/database/dbmem/dbmem.go
 return modules, nil
 }

 func (q *FakeQuerier) GetWorkspaceModulesCreatedAfter(_ context.Context, createdAt time.Time) ([]database.WorkspaceModule, error) {
 q.mutex.RLock()
 defer q.mutex.RUnlock()

 modules := make([]database.WorkspaceModule, 0)
 for _, module := range q.workspaceModules {
 if module.CreatedAt.After(createdAt) {
 modules = append(modules, module)
 }
 }
 return modules, nil
 }

 func (q *FakeQuerier) GetWorkspaceProxies(_ context.Context) ([]database.WorkspaceProxy, error) {
 q.mutex.RLock()
 defer q.mutex.RUnlock()
diff --git a/coderd/database/dbmetrics/querymetrics.go b/coderd/database/dbmetrics/querymetrics.go
diff --git a/coderd/database/dbmock/dbmock.go b/coderd/database/dbmock/dbmock.go
diff --git a/coderd/database/querier.go b/coderd/database/querier.go
diff --git a/coderd/database/queries.sql.go b/coderd/database/queries.sql.go
diff --git a/coderd/database/queries/workspacemodules.sql b/coderd/database/queries/workspacemodules.sql
 workspace_modules
 WHERE
 job_id = $1;

 -- name: GetWorkspaceModulesCreatedAfter :many
 SELECT * FROM workspace_modules WHERE created_at > $1;
diff --git a/coderd/provisionerdserver/provisionerdserver.go b/coderd/provisionerdserver/provisionerdserver.go
 slog.F("module_key", module.Key),
 slog.F("transition", transition))

 err = InsertWorkspaceModule(ctx, s.Database, jobID, transition, module)
 err = InsertWorkspaceModule(ctx, s.Database, jobID, transition, module, telemetrySnapshot)
 if err != nil {
 return nil, xerrors.Errorf("insert module: %w", err)
 }
 }
 }
 for _, module := range jobType.WorkspaceBuild.Modules {
 err = InsertWorkspaceModule(ctx, db, job.ID, workspaceBuild.Transition, module)
 err = InsertWorkspaceModule(ctx, db, job.ID, workspaceBuild.Transition, module, telemetrySnapshot)
 if err != nil {
 return xerrors.Errorf("insert provisioner job module: %w", err)
 }
 slog.F("module_source", module.Source),
 )

 err = InsertWorkspaceModule(ctx, s.Database, jobID, database.WorkspaceTransitionStart, module)
 err = InsertWorkspaceModule(ctx, s.Database, jobID, database.WorkspaceTransitionStart, module, telemetrySnapshot)
 if err != nil {
 return nil, xerrors.Errorf("insert module: %w", err)
 }
 ))...)
 }

 func InsertWorkspaceModule(ctx context.Context, db database.Store, jobID uuid.UUID, transition database.WorkspaceTransition, protoModule *sdkproto.Module) error {
 _, err := db.InsertWorkspaceModule(ctx, database.InsertWorkspaceModuleParams{
 func InsertWorkspaceModule(ctx context.Context, db database.Store, jobID uuid.UUID, transition database.WorkspaceTransition, protoModule *sdkproto.Module, snapshot *telemetry.Snapshot) error {
 module, err := db.InsertWorkspaceModule(ctx, database.InsertWorkspaceModuleParams{
 ID:         uuid.New(),
 CreatedAt:  dbtime.Now(),
 JobID:      jobID,
 if err != nil {
 return xerrors.Errorf("insert provisioner job module %q: %w", protoModule.Source, err)
 }
 snapshot.WorkspaceModules = append(snapshot.WorkspaceModules, telemetry.ConvertWorkspaceModule(module))
 return nil
 }

diff --git a/coderd/telemetry/telemetry.go b/coderd/telemetry/telemetry.go
 }
 return nil
 })
 eg.Go(func() error {
 workspaceModules, err := r.options.Database.GetWorkspaceModulesCreatedAfter(ctx, createdAfter)
 if err != nil {
 return xerrors.Errorf("get workspace modules: %w", err)
 }
 snapshot.WorkspaceModules = make([]WorkspaceModule, 0, len(workspaceModules))
 for _, module := range workspaceModules {
 snapshot.WorkspaceModules = append(snapshot.WorkspaceModules, ConvertWorkspaceModule(module))
 }
 return nil
 })
 eg.Go(func() error {
 licenses, err := r.options.Database.GetUnexpiredLicenses(ctx)
 if err != nil {

 // ConvertWorkspaceResource anonymizes a workspace resource.
 func ConvertWorkspaceResource(resource database.WorkspaceResource) WorkspaceResource {
 return WorkspaceResource{
 r := WorkspaceResource{
 ID:           resource.ID,
 JobID:        resource.JobID,
 CreatedAt:    resource.CreatedAt,
 Transition:   resource.Transition,
 Type:         resource.Type,
 InstanceType: resource.InstanceType.String,
 }
 if resource.ModulePath.Valid {
 r.ModulePath = &resource.ModulePath.String
 }
 return r
 }

 // ConvertWorkspaceResourceMetadata anonymizes workspace metadata.
 }
 }

 func ConvertWorkspaceModule(module database.WorkspaceModule) WorkspaceModule {
 return WorkspaceModule{
 ID:         module.ID,
 JobID:      module.JobID,
 Transition: module.Transition,
 Source:     module.Source,
 Version:    module.Version,
 Key:        module.Key,
 CreatedAt:  module.CreatedAt,
 }
 }

 // ConvertUser anonymizes a user.
 func ConvertUser(dbUser database.User) User {
 emailHashed := ""
 WorkspaceProxies          []WorkspaceProxy            `json:"workspace_proxies"`
 WorkspaceResourceMetadata []WorkspaceResourceMetadata `json:"workspace_resource_metadata"`
 WorkspaceResources        []WorkspaceResource         `json:"workspace_resources"`
 WorkspaceModules          []WorkspaceModule           `json:"workspace_modules"`
 Workspaces                []Workspace                 `json:"workspaces"`
 NetworkEvents             []NetworkEvent              `json:"network_events"`
 }
 Transition   database.WorkspaceTransition `json:"transition"`
 Type         string                       `json:"type"`
 InstanceType string                       `json:"instance_type"`
 // ModulePath is nullable because it was added a long time after the
 // original workspace resource telemetry was added. All new resources
 // will have a module path, but deployments with older resources still
 // in the database will not.
 ModulePath *string `json:"module_path"`
 }

 type WorkspaceResourceMetadata struct {
 Sensitive  bool      `json:"sensitive"`
 }

 type WorkspaceModule struct {
 ID         uuid.UUID                    `json:"id"`
 CreatedAt  time.Time                    `json:"created_at"`
 JobID      uuid.UUID                    `json:"job_id"`
 Transition database.WorkspaceTransition `json:"transition"`
 Key        string                       `json:"key"`
 Version    string                       `json:"version"`
 Source     string                       `json:"source"`
 }

 type WorkspaceAgent struct {
 ID                       uuid.UUID  `json:"id"`
 CreatedAt                time.Time  `json:"created_at"`
diff --git a/coderd/telemetry/telemetry_test.go b/coderd/telemetry/telemetry_test.go
 assert.NoError(t, err)
 _, _ = dbgen.WorkspaceProxy(t, db, database.WorkspaceProxy{})

 _ = dbgen.WorkspaceModule(t, db, database.WorkspaceModule{})

 _, snapshot := collectSnapshot(t, db, nil)
 require.Len(t, snapshot.ProvisionerJobs, 1)
 require.Len(t, snapshot.Licenses, 1)
 require.Len(t, snapshot.WorkspaceResources, 1)
 require.Len(t, snapshot.WorkspaceAgentStats, 1)
 require.Len(t, snapshot.WorkspaceProxies, 1)
 require.Len(t, snapshot.WorkspaceModules, 1)

 wsa := snapshot.WorkspaceAgents[0]
 require.Len(t, wsa.Subsystems, 2)
Original file line number	Diff line number	Diff line change
Expand Up		@@ -2673,6 +2673,13 @@ func (q *querier) GetWorkspaceModulesByJobID(ctx context.Context, jobID uuid.UUI
		return q.db.GetWorkspaceModulesByJobID(ctx, jobID)
		}

		func (q *querier) GetWorkspaceModulesCreatedAfter(ctx context.Context, createdAt time.Time) ([]database.WorkspaceModule, error) {
		if err := q.authorizeContext(ctx, policy.ActionRead, rbac.ResourceSystem); err != nil {
		return nil, err
		}
		return q.db.GetWorkspaceModulesCreatedAfter(ctx, createdAt)
		}

		func (q *querier) GetWorkspaceProxies(ctx context.Context) ([]database.WorkspaceProxy, error) {
		return fetchWithPostFilter(q.auth, policy.ActionRead, func(ctx context.Context, _ interface{}) ([]database.WorkspaceProxy, error) {
		return q.db.GetWorkspaceProxies(ctx)
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -2919,6 +2919,9 @@ func (s *MethodTestSuite) TestSystemFunctions() {
		s.Run("GetWorkspaceModulesByJobID", s.Subtest(func(db database.Store, check *expects) {
		check.Args(uuid.New()).Asserts(rbac.ResourceSystem, policy.ActionRead)
		}))
		s.Run("GetWorkspaceModulesCreatedAfter", s.Subtest(func(db database.Store, check *expects) {
		check.Args(dbtime.Now()).Asserts(rbac.ResourceSystem, policy.ActionRead)
		}))
		}

		func (s *MethodTestSuite) TestNotifications() {
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -666,6 +666,20 @@ func WorkspaceResource(t testing.TB, db database.Store, orig database.WorkspaceR
		return resource
		}

		func WorkspaceModule(t testing.TB, db database.Store, orig database.WorkspaceModule) database.WorkspaceModule {
		module, err := db.InsertWorkspaceModule(genCtx, database.InsertWorkspaceModuleParams{
		ID: takeFirst(orig.ID, uuid.New()),
		JobID: takeFirst(orig.JobID, uuid.New()),
		Transition: takeFirst(orig.Transition, database.WorkspaceTransitionStart),
		Source: takeFirst(orig.Source, "test-source"),
		Version: takeFirst(orig.Version, "v1.0.0"),
		Key: takeFirst(orig.Key, "test-key"),
		CreatedAt: takeFirst(orig.CreatedAt, dbtime.Now()),
		})
		require.NoError(t, err, "insert workspace module")
		return module
		}

		func WorkspaceResourceMetadatums(t testing.TB, db database.Store, seed database.WorkspaceResourceMetadatum) []database.WorkspaceResourceMetadatum {
		meta, err := db.InsertWorkspaceResourceMetadata(genCtx, database.InsertWorkspaceResourceMetadataParams{
		WorkspaceResourceID: takeFirst(seed.WorkspaceResourceID, uuid.New()),
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -6686,6 +6686,19 @@ func (q *FakeQuerier) GetWorkspaceModulesByJobID(_ context.Context, jobID uuid.U
		return modules, nil
		}

		func (q *FakeQuerier) GetWorkspaceModulesCreatedAfter(_ context.Context, createdAt time.Time) ([]database.WorkspaceModule, error) {
		q.mutex.RLock()
		defer q.mutex.RUnlock()

		modules := make([]database.WorkspaceModule, 0)
		for _, module := range q.workspaceModules {
		if module.CreatedAt.After(createdAt) {
		modules = append(modules, module)
		}
		}
		return modules, nil
		}

		func (q *FakeQuerier) GetWorkspaceProxies(_ context.Context) ([]database.WorkspaceProxy, error) {
		q.mutex.RLock()
		defer q.mutex.RUnlock()
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -11,3 +11,6 @@ FROM
		workspace_modules
		WHERE
		job_id = $1;

		-- name: GetWorkspaceModulesCreatedAfter :many
		SELECT * FROM workspace_modules WHERE created_at > $1;
Copy link Member johnstcnNov 15, 2024 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others.Learn more. non-blocking: If we're going to be querying on`created_at`, do we need an index? Copy link ContributorAuthor hugodutkaNov 15, 2024 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others.Learn more. Won't hurt, I'll add it. 😄
Original file line number	Diff line number	Diff line change
Expand Up		@@ -1279,7 +1279,7 @@ func (s server) CompleteJob(ctx context.Context, completed proto.CompletedJob)
		slog.F("module_key", module.Key),
		slog.F("transition", transition))

		err = InsertWorkspaceModule(ctx, s.Database, jobID, transition, module)
		err = InsertWorkspaceModule(ctx, s.Database, jobID, transition, module, telemetrySnapshot)
		if err != nil {
		return nil, xerrors.Errorf("insert module: %w", err)
		}
Expand DownExpand Up		@@ -1491,7 +1491,7 @@ func (s server) CompleteJob(ctx context.Context, completed proto.CompletedJob)
		}
		}
		for _, module := range jobType.WorkspaceBuild.Modules {
		err = InsertWorkspaceModule(ctx, db, job.ID, workspaceBuild.Transition, module)
		err = InsertWorkspaceModule(ctx, db, job.ID, workspaceBuild.Transition, module, telemetrySnapshot)
		if err != nil {
		return xerrors.Errorf("insert provisioner job module: %w", err)
		}
Expand DownExpand Up		@@ -1683,7 +1683,7 @@ func (s server) CompleteJob(ctx context.Context, completed proto.CompletedJob)
		slog.F("module_source", module.Source),
		)

		err = InsertWorkspaceModule(ctx, s.Database, jobID, database.WorkspaceTransitionStart, module)
		err = InsertWorkspaceModule(ctx, s.Database, jobID, database.WorkspaceTransitionStart, module, telemetrySnapshot)
		if err != nil {
		return nil, xerrors.Errorf("insert module: %w", err)
		}
Expand DownExpand Up		@@ -1769,8 +1769,8 @@ func (s *server) startTrace(ctx context.Context, name string, opts ...trace.Span
		))...)
		}

		func InsertWorkspaceModule(ctx context.Context, db database.Store, jobID uuid.UUID, transition database.WorkspaceTransition, protoModule *sdkproto.Module) error {
		_, err := db.InsertWorkspaceModule(ctx, database.InsertWorkspaceModuleParams{
		func InsertWorkspaceModule(ctx context.Context, db database.Store, jobID uuid.UUID, transition database.WorkspaceTransition, protoModule sdkproto.Module, snapshot telemetry.Snapshot) error {
		module, err := db.InsertWorkspaceModule(ctx, database.InsertWorkspaceModuleParams{
		ID: uuid.New(),
		CreatedAt: dbtime.Now(),
		JobID: jobID,
Expand All		@@ -1782,6 +1782,7 @@ func InsertWorkspaceModule(ctx context.Context, db database.Store, jobID uuid.UU
		if err != nil {
		return xerrors.Errorf("insert provisioner job module %q: %w", protoModule.Source, err)
		}
		snapshot.WorkspaceModules = append(snapshot.WorkspaceModules, telemetry.ConvertWorkspaceModule(module))
		return nil
		}

Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -456,6 +456,17 @@ func (r remoteReporter) createSnapshot() (Snapshot, error) {
		}
		return nil
		})
		eg.Go(func() error {
		workspaceModules, err := r.options.Database.GetWorkspaceModulesCreatedAfter(ctx, createdAfter)
		if err != nil {
		return xerrors.Errorf("get workspace modules: %w", err)
		}
		snapshot.WorkspaceModules = make([]WorkspaceModule, 0, len(workspaceModules))
		for _, module := range workspaceModules {
		snapshot.WorkspaceModules = append(snapshot.WorkspaceModules, ConvertWorkspaceModule(module))
		}
		return nil
		})
		eg.Go(func() error {
		licenses, err := r.options.Database.GetUnexpiredLicenses(ctx)
		if err != nil {
Expand DownExpand Up		@@ -642,14 +653,18 @@ func ConvertWorkspaceApp(app database.WorkspaceApp) WorkspaceApp {

		// ConvertWorkspaceResource anonymizes a workspace resource.
		func ConvertWorkspaceResource(resource database.WorkspaceResource) WorkspaceResource {
		return WorkspaceResource{
		r := WorkspaceResource{
		ID: resource.ID,
		JobID: resource.JobID,
		CreatedAt: resource.CreatedAt,
		Transition: resource.Transition,
		Type: resource.Type,
		InstanceType: resource.InstanceType.String,
		}
		if resource.ModulePath.Valid {
		r.ModulePath = &resource.ModulePath.String
		}
		return r
		}

		// ConvertWorkspaceResourceMetadata anonymizes workspace metadata.
Expand All		@@ -661,6 +676,18 @@ func ConvertWorkspaceResourceMetadata(metadata database.WorkspaceResourceMetadat
		}
		}

		func ConvertWorkspaceModule(module database.WorkspaceModule) WorkspaceModule {
		return WorkspaceModule{
		ID: module.ID,
		JobID: module.JobID,
		Transition: module.Transition,
		Source: module.Source,
		Version: module.Version,
		Key: module.Key,
		CreatedAt: module.CreatedAt,
		}
		}

		// ConvertUser anonymizes a user.
		func ConvertUser(dbUser database.User) User {
		emailHashed := ""
Expand DownExpand Up		@@ -810,6 +837,7 @@ type Snapshot struct {
		WorkspaceProxies []WorkspaceProxy `json:"workspace_proxies"`
		WorkspaceResourceMetadata []WorkspaceResourceMetadata `json:"workspace_resource_metadata"`
		WorkspaceResources []WorkspaceResource `json:"workspace_resources"`
		WorkspaceModules []WorkspaceModule `json:"workspace_modules"`
		Workspaces []Workspace `json:"workspaces"`
		NetworkEvents []NetworkEvent `json:"network_events"`
		}
Expand DownExpand Up		@@ -878,6 +906,11 @@ type WorkspaceResource struct {
		Transition database.WorkspaceTransition `json:"transition"`
		Type string `json:"type"`
		InstanceType string `json:"instance_type"`
		// ModulePath is nullable because it was added a long time after the
		// original workspace resource telemetry was added. All new resources
		// will have a module path, but deployments with older resources still
		// in the database will not.
		ModulePath *string `json:"module_path"`
		}

		type WorkspaceResourceMetadata struct {
Expand All		@@ -886,6 +919,16 @@ type WorkspaceResourceMetadata struct {
		Sensitive bool `json:"sensitive"`
		}

		type WorkspaceModule struct {
		ID uuid.UUID `json:"id"`
		CreatedAt time.Time `json:"created_at"`
		JobID uuid.UUID `json:"job_id"`
		Transition database.WorkspaceTransition `json:"transition"`
		Key string `json:"key"`
		Version string `json:"version"`
		Source string `json:"source"`
		}

		type WorkspaceAgent struct {
		ID uuid.UUID `json:"id"`
		CreatedAt time.Time `json:"created_at"`
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -87,6 +87,8 @@ func TestTelemetry(t *testing.T) {
		assert.NoError(t, err)
		_, _ = dbgen.WorkspaceProxy(t, db, database.WorkspaceProxy{})

		_ = dbgen.WorkspaceModule(t, db, database.WorkspaceModule{})

		_, snapshot := collectSnapshot(t, db, nil)
		require.Len(t, snapshot.ProvisionerJobs, 1)
		require.Len(t, snapshot.Licenses, 1)
Expand All		@@ -103,6 +105,7 @@ func TestTelemetry(t *testing.T) {
		require.Len(t, snapshot.WorkspaceResources, 1)
		require.Len(t, snapshot.WorkspaceAgentStats, 1)
		require.Len(t, snapshot.WorkspaceProxies, 1)
		require.Len(t, snapshot.WorkspaceModules, 1)

		wsa := snapshot.WorkspaceAgents[0]
		require.Len(t, wsa.Subsystems, 2)
Expand Down