Track API key usage

coder · kylecarbs · Jun 17, 2022 · Jun 12, 2022 · Jun 12, 2022 · Jun 13, 2022
commit b74d12742a9bf2a89ad73dc647dbb6f38668e25d
diff --git a/coderd/database/databasefake/databasefake.go b/coderd/database/databasefake/databasefake.go
@@ -130,6 +130,19 @@ func (q *fakeQuerier) GetAPIKeyByID(_ context.Context, id string) (database.APIK
 	return database.APIKey{}, sql.ErrNoRows
 }
 
+func (q *fakeQuerier) GetAPIKeysLastUsedAfter(_ context.Context, after time.Time) ([]database.APIKey, error) {
+	q.mutex.RLock()
+	defer q.mutex.RUnlock()
+
+	apiKeys := make([]database.APIKey, 0)
+	for _, key := range q.apiKeys {
+		if key.LastUsed.After(after) {
+			apiKeys = append(apiKeys, key)
+		}
+	}
+	return apiKeys, nil
+}
+
 func (q *fakeQuerier) DeleteAPIKeyByID(_ context.Context, id string) error {
 	q.mutex.Lock()
 	defer q.mutex.Unlock()

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/apikeys.sql b/coderd/database/queries/apikeys.sql
@@ -8,6 +8,9 @@ WHERE
 LIMIT
 	1;
 
+-- name: GetAPIKeysLastUsedAfter :many
+SELECT * FROM api_keys WHERE last_used > $1;
+
 -- name: InsertAPIKey :one
 INSERT INTO
 	api_keys (

diff --git a/coderd/telemetry/telemetry.go b/coderd/telemetry/telemetry.go
@@ -274,6 +274,17 @@ func (r *remoteReporter) createSnapshot() (*Snapshot, error) {
 		}
 	)
 
+	eg.Go(func() error {
+		apiKeys, err := r.options.Database.GetAPIKeysLastUsedAfter(ctx, createdAfter)
+		if err != nil {
+			return xerrors.Errorf("get api keys last used: %w", err)
+		}
+		snapshot.APIKeys = make([]APIKey, 0, len(apiKeys))
+		for _, apiKey := range apiKeys {
+			snapshot.APIKeys = append(snapshot.APIKeys, ConvertAPIKey(apiKey))
+		}
+		return nil
+	})
 	eg.Go(func() error {
 		schemas, err := r.options.Database.GetParameterSchemasCreatedAfter(ctx, createdAfter)
 		if err != nil {
@@ -414,6 +425,17 @@ func (r *remoteReporter) createSnapshot() (*Snapshot, error) {
 	return snapshot, nil
 }
 
 // ConvertAPIKey anonymizes an API key.
+func ConvertAPIKey(apiKey database.APIKey) APIKey {
+	return APIKey{
+		ID:        apiKey.ID,
+		UserID:    apiKey.UserID,
+		CreatedAt: apiKey.CreatedAt,
+		LastUsed:  apiKey.LastUsed,
+		LoginType: apiKey.LoginType,
+	}
+}
+
 // ConvertWorkspace anonymizes a workspace.
 func ConvertWorkspace(workspace database.Workspace) Workspace {
 	return Workspace{
@@ -551,6 +573,7 @@ func ConvertTemplateVersion(version database.TemplateVersion) TemplateVersion {
 type Snapshot struct {
 	DeploymentID string `json:"deployment_id"`
 
+	APIKeys            []APIKey            `json:"api_keys"`
 	ParameterSchemas   []ParameterSchema   `json:"parameter_schemas"`
 	ProvisionerJobs    []ProvisionerJob    `json:"provisioner_jobs"`
 	Templates          []Template          `json:"templates"`
@@ -585,6 +608,14 @@ type Deployment struct {
 	ShutdownAt      *time.Time `json:"shutdown_at"`
 }
 
+type APIKey struct {
+	ID        string             `json:"id"`
+	UserID    uuid.UUID          `json:"user_id"`
+	CreatedAt time.Time          `json:"created_at"`
+	LastUsed  time.Time          `json:"last_used"`
+	LoginType database.LoginType `json:"login_type"`
+}
+
 type User struct {
 	ID        uuid.UUID `json:"uuid"`
 	CreatedAt time.Time `json:"created_at"`

diff --git a/coderd/telemetry/telemetry_test.go b/coderd/telemetry/telemetry_test.go
@@ -31,7 +31,12 @@ func TestTelemetry(t *testing.T) {
 		t.Parallel()
 		db := databasefake.New()
 		ctx := context.Background()
-		_, err := db.InsertParameterSchema(ctx, database.InsertParameterSchemaParams{
+		_, err := db.InsertAPIKey(ctx, database.InsertAPIKeyParams{
+			ID:       uuid.NewString(),
+			LastUsed: database.Now(),
+		})
+		require.NoError(t, err)
+		_, err = db.InsertParameterSchema(ctx, database.InsertParameterSchemaParams{
 			ID:        uuid.New(),
 			CreatedAt: database.Now(),
 		})