Fix flake and requested changes

coder · kylecarbs · Jun 17, 2022 · Jun 12, 2022 · Jun 12, 2022 · Jun 13, 2022
commit 9ed5ecd88ac11fa6a28c9d401e3320eae44aee6d
diff --git a/cli/server.go b/cli/server.go
@@ -82,7 +82,7 @@ func server() *cobra.Command {
 		oauth2GithubClientSecret         string
 		oauth2GithubAllowedOrganizations []string
 		oauth2GithubAllowSignups         bool
-		telemetryEnabled                 bool
+		telemetryEnable                  bool
 		telemetryURL                     string
 		tlsCertFile                      string
 		tlsClientCAFile                  string
@@ -327,16 +327,16 @@ func server() *cobra.Command {
 			}
 			// Disable telemetry if in dev-mode. If the telemetry flag
 			// is manually specified, override this behavior!
-			if buildModeDev && !cmd.Flags().Changed("telemetry") {
-				telemetryEnabled = false
+			if buildModeDev && !cmd.Flags().Changed("telemetry-enable") {
+				telemetryEnable = false
 			}
 			reporter, err := telemetry.New(telemetry.Options{
 				DeploymentID: deploymentID,
 				Database:     options.Database,
 				Logger:       logger.Named("telemetry"),
 				URL:          telemetryURL,
 				DevMode:      dev,
-				Disabled:     !telemetryEnabled,
+				Disabled:     !telemetryEnable,
 			})
 			if err != nil {
 				return xerrors.Errorf("create telemetry reporter: %w", err)
@@ -580,7 +580,7 @@ func server() *cobra.Command {
 		"Specifies organizations the user must be a member of to authenticate with GitHub.")
 	cliflag.BoolVarP(root.Flags(), &oauth2GithubAllowSignups, "oauth2-github-allow-signups", "", "CODER_OAUTH2_GITHUB_ALLOW_SIGNUPS", false,
 		"Specifies whether new users can sign up with GitHub.")
-	cliflag.BoolVarP(root.Flags(), &telemetryEnabled, "telemetry", "", "CODER_TELEMETRY", true, "Specifies whether telemetry is enabled or not. Coder collects anonymized usage data to help improve our product!")
+	cliflag.BoolVarP(root.Flags(), &telemetryEnable, "telemetry-enable", "", "CODER_TELEMETRY_ENABLE", true, "Specifies whether telemetry is enabled or not. Coder collects anonymized usage data to help improve our product!")
 	cliflag.StringVarP(root.Flags(), &telemetryURL, "telemetry-url", "", "CODER_TELEMETRY_URL", "https://telemetry.coder.com", "Specifies a URL to send telemetry to.")
 	_ = root.Flags().MarkHidden("telemetry-url")
 	cliflag.BoolVarP(root.Flags(), &tlsEnable, "tls-enable", "", "CODER_TLS_ENABLE", false, "Specifies if TLS will be enabled")

diff --git a/cli/server_test.go b/cli/server_test.go
@@ -348,7 +348,7 @@ func TestServer(t *testing.T) {
 		server := httptest.NewServer(r)
 		t.Cleanup(server.Close)
 
-		root, _ := clitest.New(t, "server", "--dev", "--tunnel=false", "--address", ":0", "--telemetry", "true", "--telemetry-url", server.URL)
+		root, _ := clitest.New(t, "server", "--dev", "--tunnel=false", "--address", ":0", "--telemetry-enable", "true", "--telemetry-url", server.URL)
 		var buf strings.Builder
 		errC := make(chan error)
 		root.SetOutput(&buf)

diff --git a/coderd/database/databasefake/databasefake.go b/coderd/database/databasefake/databasefake.go
@@ -981,7 +981,7 @@ func (q *fakeQuerier) GetTemplates(_ context.Context) ([]database.Template, erro
 	q.mutex.RLock()
 	defer q.mutex.RUnlock()
 
-	return q.templates, nil
+	return q.templates[:], nil
 }
 
 func (q *fakeQuerier) GetTemplatesByOrganization(_ context.Context, arg database.GetTemplatesByOrganizationParams) ([]database.Template, error) {

diff --git a/coderd/database/dump.sql b/coderd/database/dump.sql
diff --git a/coderd/database/migrations/000023_site_config.up.sql b/coderd/database/migrations/000023_site_config.up.sql
@@ -1,4 +1,4 @@
-CREATE TABLE IF NOT EXISTS site_config (
+CREATE TABLE IF NOT EXISTS site_configs (
     key varchar(256) NOT NULL UNIQUE,
     value varchar(8192) NOT NULL
 );
diff --git a/coderd/database/queries.sql.go b/coderd/database/queries.sql.go
diff --git a/coderd/database/queries/siteconfig.sql b/coderd/database/queries/siteconfig.sql
@@ -1,5 +1,5 @@
 -- name: InsertDeploymentID :exec
-INSERT INTO site_config (key, value) VALUES ('deployment_id', $1);
+INSERT INTO site_configs (key, value) VALUES ('deployment_id', $1);
 
 -- name: GetDeploymentID :one
-SELECT value FROM site_config WHERE key = 'deployment_id';
+SELECT value FROM site_configs WHERE key = 'deployment_id';
diff --git a/coderd/telemetry/telemetry.go b/coderd/telemetry/telemetry.go
@@ -28,7 +28,8 @@ import (
 type Options struct {
 	Database database.Store
 	Logger   slog.Logger
-	URL      *url.URL
+	// URL is an endpoint to direct telemetry towards!
+	URL *url.URL
 
 	DeploymentID string
 	DevMode      bool
@@ -155,9 +156,13 @@ func (r *Reporter) runSnapshotter() {
 			case <-ticker.C:
 			}
 			// Skip the ticker on the first run to report instantly!
-			first = false
 		}
+		first = false
 		r.closeMutex.Lock()
+		if r.isClosed() {
+			r.closeMutex.Unlock()
+			return
+		}
 		r.report()
 		r.closeMutex.Unlock()
 	}
@@ -345,6 +350,8 @@ func (r *Reporter) createSnapshot() (*Snapshot, error) {
 			emailHashed := ""
 			atSymbol := strings.LastIndex(dbUser.Email, "@")
 			if atSymbol >= 0 {
+				// We hash the beginning of the user to allow for indexing users
+				// by email between deployments.
 				hash := sha256.Sum256([]byte(dbUser.Email[:atSymbol]))
 				emailHashed = fmt.Sprintf("%x%s", hash[:], dbUser.Email[atSymbol:])
 			}
@@ -366,6 +373,7 @@ func (r *Reporter) createSnapshot() (*Snapshot, error) {
 		snapshot.Workspaces = make([]Workspace, 0, len(workspaces))
 		for _, dbWorkspace := range workspaces {
 			snapshot.Workspaces = append(snapshot.Workspaces, Workspace{
+				ID:             dbWorkspace.ID,
 				OrganizationID: dbWorkspace.OrganizationID,
 				OwnerID:        dbWorkspace.OwnerID,
 				TemplateID:     dbWorkspace.TemplateID,
@@ -475,10 +483,10 @@ type Snapshot struct {
 
 // Deployment contains information about the host running Coder.
 type Deployment struct {
-	ID            string     `json:"id" validate:"required"`
+	ID            string     `json:"id"`
 	Architecture  string     `json:"architecture"`
 	Containerized bool       `json:"containerized"`
-	DevMode       bool       `json:"dev_mode" validate:"required"`
+	DevMode       bool       `json:"dev_mode"`
 	OSType        string     `json:"os_type"`
 	OSFamily      string     `json:"os_family"`
 	OSPlatform    string     `json:"os_platform"`
@@ -487,7 +495,7 @@ type Deployment struct {
 	CPUCores      int        `json:"cpu_cores"`
 	MemoryTotal   uint64     `json:"memory_total"`
 	MachineID     string     `json:"machine_id"`
-	Version       string     `json:"version" validate:"required"`
+	Version       string     `json:"version"`
 	StartedAt     time.Time  `json:"started_at"`
 	ShutdownAt    *time.Time `json:"shutdown_at"`
 }
@@ -537,6 +545,7 @@ type WorkspaceBuild struct {
 }
 
 type Workspace struct {
+	ID             uuid.UUID `json:"id"`
 	OrganizationID uuid.UUID `json:"organization_id"`
 	OwnerID        uuid.UUID `json:"owner_id"`
 	TemplateID     uuid.UUID `json:"template_id"`
@@ -578,7 +587,7 @@ type ProvisionerJob struct {
 }
 
 type ParameterSchema struct {
-	ID                  uuid.UUID `json:"parameter_schema"`
+	ID                  uuid.UUID `json:"id"`
 	JobID               uuid.UUID `json:"job_id"`
 	Name                string    `json:"name"`
 	ValidationCondition string    `json:"validation_condition"`