internal/telemetry: move core types to internal/telemetry

This change moves core types defined by the telemetry package into
internal telemetry and just reexports them from the root telemetry
package so that the telemetry package doesn't have to be a
bottom-level dependency.

Also remove all import renamings of
golang.org/x/telemetry/internal/telemetry.

Change-Id: Iec4e0b9e04e85708763155f9ea7b55bd2c7edff4
Reviewed-on: https://go-review.googlesource.com/c/telemetry/+/564135
Reviewed-by: Robert Findley <[email protected]>
LUCI-TryBot-Result: Go LUCI <[email protected]>

Author: matloob

cmd/gotelemetry/internal/csv/csv.go

@@ -20,9 +20,8 @@ import (
 	"sort"
 	"strings"
 
-	"golang.org/x/telemetry"
 	"golang.org/x/telemetry/internal/counter"
-	it "golang.org/x/telemetry/internal/telemetry"
+	"golang.org/x/telemetry/internal/telemetry"
 )
 
 type file struct {
@@ -33,7 +32,7 @@ type file struct {
 }
 
 func Csv() {
-	files, err := readdir(it.LocalDir, nil)
+	files, err := readdir(telemetry.LocalDir, nil)
 	if err != nil {
 		log.Fatal(err)
 	}

cmd/gotelemetry/internal/view/view.go

@@ -23,13 +23,12 @@ import (
 	"strings"
 	"time"
 
-	"golang.org/x/telemetry"
 	"golang.org/x/telemetry/cmd/gotelemetry/internal/browser"
 	"golang.org/x/telemetry/internal/config"
 	"golang.org/x/telemetry/internal/configstore"
 	contentfs "golang.org/x/telemetry/internal/content"
 	tcounter "golang.org/x/telemetry/internal/counter"
-	it "golang.org/x/telemetry/internal/telemetry"
+	"golang.org/x/telemetry/internal/telemetry"
 	"golang.org/x/telemetry/internal/unionfs"
 )
 
@@ -115,16 +114,16 @@ func (s *Server) handleIndex(fsys fs.FS) handlerFunc {
 		if err != nil {
 			return err
 		}
-		if _, err := os.Stat(it.LocalDir); err != nil {
+		if _, err := os.Stat(telemetry.LocalDir); err != nil {
 			return fmt.Errorf(
 				`The telemetry dir %s does not exist.
-There is nothing to report.`, it.LocalDir)
+There is nothing to report.`, telemetry.LocalDir)
 		}
-		reports, err := reports(it.LocalDir, cfg)
+		reports, err := reports(telemetry.LocalDir, cfg)
 		if err != nil {
 			return err
 		}
-		files, err := files(it.LocalDir, cfg)
+		files, err := files(telemetry.LocalDir, cfg)
 		if err != nil {
 			return err
 		}

cmd/gotelemetry/internal/view/view_test.go

@@ -11,8 +11,8 @@ import (
 	"reflect"
 	"testing"
 
-	"golang.org/x/telemetry"
 	"golang.org/x/telemetry/internal/config"
+	"golang.org/x/telemetry/internal/telemetry"
 )
 
 func Test_summary(t *testing.T) {

cmd/gotelemetry/main.go

@@ -18,7 +18,7 @@ import (
 	"golang.org/x/telemetry/cmd/gotelemetry/internal/csv"
 	"golang.org/x/telemetry/cmd/gotelemetry/internal/view"
 	"golang.org/x/telemetry/internal/counter"
-	it "golang.org/x/telemetry/internal/telemetry"
+	"golang.org/x/telemetry/internal/telemetry"
 	"golang.org/x/telemetry/upload"
 )
 
@@ -213,10 +213,10 @@ func help(name string) {
 }
 
 func runOn(_ []string) {
-	if old, _ := it.Mode(); old == "on" {
+	if old, _ := telemetry.Mode(); old == "on" {
 		return
 	}
-	if err := it.SetMode("on"); err != nil {
+	if err := telemetry.SetMode("on"); err != nil {
 		failf("Failed to enable telemetry: %v", err)
 	}
 	// We could perhaps only show the telemetry on message when the mode goes
@@ -236,19 +236,19 @@ To disable both collection and uploading, run “gotelemetry off“.`
 }
 
 func runLocal(_ []string) {
-	if old, _ := it.Mode(); old == "local" {
+	if old, _ := telemetry.Mode(); old == "local" {
 		return
 	}
-	if err := it.SetMode("local"); err != nil {
+	if err := telemetry.SetMode("local"); err != nil {
 		failf("Failed to set the telemetry mode to local: %v", err)
 	}
 }
 
 func runOff(_ []string) {
-	if old, _ := it.Mode(); old == "off" {
+	if old, _ := telemetry.Mode(); old == "off" {
 		return
 	}
-	if err := it.SetMode("off"); err != nil {
+	if err := telemetry.SetMode("off"); err != nil {
 		failf("Failed to disable telemetry: %v", err)
 	}
 }
@@ -258,21 +258,21 @@ func runView(_ []string) {
 }
 
 func runEnv(_ []string) {
-	m, t := it.Mode()
+	m, t := telemetry.Mode()
 	fmt.Printf("mode: %s %s\n", m, t)
 	fmt.Println()
-	fmt.Println("modefile:", it.ModeFile)
-	fmt.Println("localdir:", it.LocalDir)
-	fmt.Println("uploaddir:", it.UploadDir)
+	fmt.Println("modefile:", telemetry.ModeFile)
+	fmt.Println("localdir:", telemetry.LocalDir)
+	fmt.Println("uploaddir:", telemetry.UploadDir)
 }
 
 func runClean(_ []string) {
 	// For now, be careful to only remove counter files and reports.
 	// It would probably be OK to just remove everything, but it may
 	// be useful to preserve the weekends file.
 	for dir, suffixes := range map[string][]string{
-		it.LocalDir:  {"." + counter.FileVersion + ".count", ".json"},
-		it.UploadDir: {".json"},
+		telemetry.LocalDir:  {"." + counter.FileVersion + ".count", ".json"},
+		telemetry.UploadDir: {".json"},
 	} {
 		entries, err := os.ReadDir(dir)
 		if err != nil {
@@ -307,7 +307,7 @@ func runCSV(_ []string) {
 
 func runDump(args []string) {
 	if len(args) == 0 {
-		localdir := it.LocalDir
+		localdir := telemetry.LocalDir
 		fi, err := os.ReadDir(localdir)
 		if err != nil && len(args) == 0 {
 			log.Fatal(err)

godev/cmd/telemetrygodev/main.go

@@ -23,14 +23,14 @@ import (
 
 	"golang.org/x/exp/slog"
 	"golang.org/x/mod/semver"
-	"golang.org/x/telemetry"
 	"golang.org/x/telemetry/godev/internal/config"
 	"golang.org/x/telemetry/godev/internal/content"
 	ilog "golang.org/x/telemetry/godev/internal/log"
 	"golang.org/x/telemetry/godev/internal/middleware"
 	"golang.org/x/telemetry/godev/internal/storage"
 	tconfig "golang.org/x/telemetry/internal/config"
 	contentfs "golang.org/x/telemetry/internal/content"
+	"golang.org/x/telemetry/internal/telemetry"
 	"golang.org/x/telemetry/internal/unionfs"
 )
 

godev/cmd/telemetrygodev/main_test.go

@@ -19,9 +19,9 @@ import (
 	"strings"
 	"testing"
 
-	"golang.org/x/telemetry"
 	"golang.org/x/telemetry/godev/internal/config"
 	tconfig "golang.org/x/telemetry/internal/config"
+	"golang.org/x/telemetry/internal/telemetry"
 	"golang.org/x/telemetry/internal/testenv"
 )
 

godev/cmd/worker/main.go

@@ -22,14 +22,14 @@ import (
 	taskspb "cloud.google.com/go/cloudtasks/apiv2/cloudtaskspb"
 	"golang.org/x/exp/slog"
 	"golang.org/x/mod/semver"
-	"golang.org/x/telemetry"
 	"golang.org/x/telemetry/godev/internal/config"
 	"golang.org/x/telemetry/godev/internal/content"
 	ilog "golang.org/x/telemetry/godev/internal/log"
 	"golang.org/x/telemetry/godev/internal/middleware"
 	"golang.org/x/telemetry/godev/internal/storage"
 	tconfig "golang.org/x/telemetry/internal/config"
 	contentfs "golang.org/x/telemetry/internal/content"
+	"golang.org/x/telemetry/internal/telemetry"
 	"golang.org/x/telemetry/internal/unionfs"
 )
 

godev/cmd/worker/main_test.go

@@ -8,7 +8,7 @@ import (
 	"reflect"
 	"testing"
 
-	"golang.org/x/telemetry"
+	"golang.org/x/telemetry/internal/telemetry"
 )
 
 func Test_nest(t *testing.T) {

internal/config/config.go

@@ -11,7 +11,7 @@ import (
 	"os"
 	"strings"
 
-	"golang.org/x/telemetry"
+	"golang.org/x/telemetry/internal/telemetry"
 )
 
 // Config is a wrapper around telemetry.UploadConfig that provides some

internal/config/config_test.go

@@ -11,7 +11,7 @@ import (
 	"path/filepath"
 	"testing"
 
-	"golang.org/x/telemetry"
+	"golang.org/x/telemetry/internal/telemetry"
 )
 
 func TestConfig(t *testing.T) {

internal/configgen/main.go

@@ -28,8 +28,8 @@ import (
 	_ "embed"
 
 	"golang.org/x/mod/semver"
-	"golang.org/x/telemetry"
 	"golang.org/x/telemetry/internal/graphconfig"
+	"golang.org/x/telemetry/internal/telemetry"
 )
 
 var (

internal/configgen/main_test.go

@@ -12,7 +12,7 @@ import (
 	"sort"
 	"testing"
 
-	"golang.org/x/telemetry"
+	"golang.org/x/telemetry/internal/telemetry"
 )
 
 func TestGenerate(t *testing.T) {

internal/configstore/download.go

@@ -17,7 +17,7 @@ import (
 	"os/exec"
 	"path/filepath"
 
-	"golang.org/x/telemetry"
+	"golang.org/x/telemetry/internal/telemetry"
 )
 
 const (

internal/configstore/download_test.go

@@ -13,8 +13,8 @@ import (
 	"strings"
 	"testing"
 
-	"golang.org/x/telemetry"
 	"golang.org/x/telemetry/internal/proxy"
+	"golang.org/x/telemetry/internal/telemetry"
 	"golang.org/x/telemetry/internal/testenv"
 )
 

internal/regtest/e2e_test.go

@@ -15,11 +15,10 @@ import (
 	"strings"
 	"testing"
 
-	"golang.org/x/telemetry"
 	"golang.org/x/telemetry/counter"
 	"golang.org/x/telemetry/internal/config"
 	icounter "golang.org/x/telemetry/internal/counter"
-	it "golang.org/x/telemetry/internal/telemetry"
+	"golang.org/x/telemetry/internal/telemetry"
 	"golang.org/x/telemetry/internal/testenv"
 )
 
@@ -75,7 +74,7 @@ func TestE2E_off(t *testing.T) {
 		t.Run(fmt.Sprintf("mode=%s", test.mode), func(t *testing.T) {
 			telemetryDir := t.TempDir()
 			if test.mode != "" {
-				if err := it.ModeFilePath(filepath.Join(telemetryDir, "mode")).SetMode(test.mode); err != nil {
+				if err := telemetry.ModeFilePath(filepath.Join(telemetryDir, "mode")).SetMode(test.mode); err != nil {
 					t.Fatalf("SetMode failed: %v", err)
 				}
 			}

types.go renamed to internal/telemetry/types.go

@@ -21,10 +21,9 @@ import (
 	"testing"
 	"time"
 
-	"golang.org/x/telemetry"
 	"golang.org/x/telemetry/counter"
 	"golang.org/x/telemetry/internal/regtest"
-	it "golang.org/x/telemetry/internal/telemetry"
+	"golang.org/x/telemetry/internal/telemetry"
 	"golang.org/x/telemetry/internal/testenv"
 )
 
@@ -79,7 +78,7 @@ func newTestUploader(uc *telemetry.UploadConfig, telemetryDir string, srv *httpt
 	uploader := NewUploader(uc)
 	uploader.LocalDir = filepath.Join(telemetryDir, "local")
 	uploader.UploadDir = filepath.Join(telemetryDir, "upload")
-	uploader.ModeFilePath = it.ModeFilePath(filepath.Join(telemetryDir, "mode"))
+	uploader.ModeFilePath = telemetry.ModeFilePath(filepath.Join(telemetryDir, "mode"))
 	uploader.UploadServerURL = srv.URL
 	return uploader
 }

internal/upload/dates_test.go

@@ -15,9 +15,9 @@ import (
 	"strings"
 	"time"
 
-	"golang.org/x/telemetry"
 	"golang.org/x/telemetry/internal/config"
 	"golang.org/x/telemetry/internal/configstore"
+	"golang.org/x/telemetry/internal/telemetry"
 )
 
 // reports generates reports from inactive count files

internal/upload/reports.go

@@ -15,8 +15,7 @@ import (
 	"strings"
 	"time"
 
-	"golang.org/x/telemetry"
-	it "golang.org/x/telemetry/internal/telemetry"
+	"golang.org/x/telemetry/internal/telemetry"
 )
 
 var logger *log.Logger
@@ -45,7 +44,7 @@ func SetLogOutput(logging io.Writer) {
 // dirname, if it exists. If dirname is the empty string,
 // the function tries the directory it.Localdir/debug.
 func LogIfDebug(dirname string) error {
-	dname := filepath.Join(it.LocalDir, "debug")
+	dname := filepath.Join(telemetry.LocalDir, "debug")
 	if dirname != "" {
 		dname = dirname
 	}
@@ -99,7 +98,7 @@ type Uploader struct {
 	// UploadDir is where uploader leaves the copy of uploaded data.
 	UploadDir string
 	// ModeFilePath is the file.
-	ModeFilePath it.ModeFilePath
+	ModeFilePath telemetry.ModeFilePath
 
 	UploadServerURL string
 	StartTime       time.Time
@@ -112,17 +111,17 @@ func NewUploader(config *telemetry.UploadConfig) *Uploader {
 	return &Uploader{
 		Config:          config,
 		ConfigVersion:   "custom",
-		LocalDir:        it.LocalDir,
-		UploadDir:       it.UploadDir,
-		ModeFilePath:    it.ModeFile,
+		LocalDir:        telemetry.LocalDir,
+		UploadDir:       telemetry.UploadDir,
+		ModeFilePath:    telemetry.ModeFile,
 		UploadServerURL: "https://telemetry.go.dev/upload",
 		StartTime:       time.Now().UTC(),
 	}
 }
 
 // Run generates and uploads reports
 func (u *Uploader) Run() {
-	if it.DisabledOnPlatform {
+	if telemetry.DisabledOnPlatform {
 		return
 	}
 	todo := u.findWork()

internal/upload/run.go

@@ -5,7 +5,7 @@
 package telemetry
 
 import (
-	it "golang.org/x/telemetry/internal/telemetry"
+	"golang.org/x/telemetry/internal/telemetry"
 )
 
 // Mode returns the current telemetry mode.
@@ -24,7 +24,7 @@ import (
 //
 // [gotelemetry]: https://pkg.go.dev/golang.org/x/telemetry/cmd/gotelemetry
 func Mode() string {
-	mode, _ := it.Mode()
+	mode, _ := telemetry.Mode()
 	return mode
 }
 
@@ -36,5 +36,5 @@ func Mode() string {
 // An error is returned if the provided mode value is invalid, or if an error
 // occurs while persisting the mode value to the file system.
 func SetMode(mode string) error {
-	return it.SetMode(mode)
+	return telemetry.SetMode(mode)
 }