all: temporarily replace use of time.DateOnly with telemetry.DateOnly

To unbreak the gopls build at 1.19, replace uses of time.DateOnly with a
temporary constant telemetry.DateOnly.

Confirmed (via a replace directive) that this fixes the gopls build.

Change-Id: Ib1c6dc8d27cb9d5200dc00e2e4745edb732896d2
Reviewed-on: https://go-review.googlesource.com/c/telemetry/+/609597
Reviewed-by: Hyang-Ah Hana Kim <[email protected]>
LUCI-TryBot-Result: Go LUCI <[email protected]>

Author: findleyr

cmd/gotelemetry/internal/view/view.go

@@ -437,7 +437,7 @@ func formatDateTime(date time.Time) string {
 // parseReportDate parses the date string in the format
 // used byt the telemetry report.
 func parseReportDate(s string) (time.Time, error) {
-	return time.Parse(time.DateOnly, s)
+	return time.Parse(telemetry.DateOnly, s)
 }
 
 // charts returns chartdata for a set of telemetry reports. It uses the config
@@ -580,7 +580,7 @@ func pending(files []*counterFile, cfg *config.Config) []*telemetryReport {
 			log.Printf("skipping malformed %v: unexpected TimeEnd value %q", f.ID, f.Meta["TimeEnd"])
 			continue
 		}
-		week := tb.Format(time.DateOnly)
+		week := tb.Format(telemetry.DateOnly)
 		if _, ok := reports[week]; !ok {
 			reports[week] = &telemetry.Report{Week: week}
 		}

cmd/gotelemetry/internal/view/view_test.go

@@ -100,7 +100,7 @@ func Test_summary(t *testing.T) {
 
 func Test_reportsDomain(t *testing.T) {
 	mustParseDate := func(date string) time.Time {
-		ts, err := time.Parse(time.DateOnly, date)
+		ts, err := time.Parse(telemetry.DateOnly, date)
 		if err != nil {
 			t.Fatalf("failed to parse date %q: %v", date, err)
 		}

godev/cmd/telemetrygodev/main.go

@@ -314,7 +314,7 @@ func handleUpload(ucfg *tconfig.Config, uploadBucket storage.BucketHandle) conte
 // validate validates the telemetry report data against the latest config.
 func validate(r *telemetry.Report, cfg *tconfig.Config) error {
 	// TODO: reject/drop data arrived too early or too late.
-	if _, err := time.Parse(time.DateOnly, r.Week); err != nil {
+	if _, err := time.Parse(telemetry.DateOnly, r.Week); err != nil {
 		return fmt.Errorf("invalid week %s", r.Week)
 	}
 	if !semver.IsValid(r.Config) {

godev/cmd/worker/main.go

@@ -102,7 +102,7 @@ func handleCopy(cfg *config.Config, dest *storage.API) content.HandlerFunc {
 		g.SetLimit(concurrency)
 
 		for date := start; !date.After(end); date = date.AddDate(0, 0, 1) {
-			it := sourceBucket.Objects(ctx, date.Format(time.DateOnly))
+			it := sourceBucket.Objects(ctx, date.Format(telemetry.DateOnly))
 			for {
 				fileName, err := it.Next()
 				if errors.Is(err, storage.ErrObjectIteratorDone) {
@@ -138,13 +138,13 @@ func handleTasks(cfg *config.Config) content.HandlerFunc {
 
 		// Copy the past 20 days uploaded reports from prod to dev gcs bucket.
 		if cfg.Env != "prod" {
-			url := cfg.WorkerURL + "/copy/?start=" + now.AddDate(0, 0, -1*20).Format(time.DateOnly) + "&end=" + now.Format(time.DateOnly)
+			url := cfg.WorkerURL + "/copy/?start=" + now.AddDate(0, 0, -1*20).Format(telemetry.DateOnly) + "&end=" + now.Format(telemetry.DateOnly)
 			if _, err := createHTTPTask(cfg, url); err != nil {
 				return err
 			}
 		}
 		for i := 7; i > 0; i-- {
-			date := now.AddDate(0, 0, -1*i).Format(time.DateOnly)
+			date := now.AddDate(0, 0, -1*i).Format(telemetry.DateOnly)
 			url := cfg.WorkerURL + "/merge/?date=" + date
 			if _, err := createHTTPTask(cfg, url); err != nil {
 				return err
@@ -154,7 +154,7 @@ func handleTasks(cfg *config.Config) content.HandlerFunc {
 		// coded one day delay.
 		for i := 8; i > 1; i-- {
 			// Daily chart: generate chart using one day's data.
-			date := now.AddDate(0, 0, -1*i).Format(time.DateOnly)
+			date := now.AddDate(0, 0, -1*i).Format(telemetry.DateOnly)
 			url := cfg.WorkerURL + "/chart/?date=" + date
 			if _, err := createHTTPTask(cfg, url); err != nil {
 				return err
@@ -163,7 +163,7 @@ func handleTasks(cfg *config.Config) content.HandlerFunc {
 			// Weekly chart: generate chart using past 7 days' data.
 			end := now.AddDate(0, 0, -1*i)
 			start := end.AddDate(0, 0, -6)
-			url = cfg.WorkerURL + "/chart/?start=" + start.Format(time.DateOnly) + "&end=" + end.Format(time.DateOnly)
+			url = cfg.WorkerURL + "/chart/?start=" + start.Format(telemetry.DateOnly) + "&end=" + end.Format(telemetry.DateOnly)
 			if _, err := createHTTPTask(cfg, url); err != nil {
 				return err
 			}
@@ -213,7 +213,7 @@ func handleMerge(s *storage.API) content.HandlerFunc {
 	return func(w http.ResponseWriter, r *http.Request) error {
 		ctx := r.Context()
 		date := r.URL.Query().Get("date")
-		if _, err := time.Parse(time.DateOnly, date); err != nil {
+		if _, err := time.Parse(telemetry.DateOnly, date); err != nil {
 			return content.Error(err, http.StatusBadRequest)
 		}
 		it := s.Upload.Objects(ctx, date)
@@ -259,10 +259,10 @@ func handleMerge(s *storage.API) content.HandlerFunc {
 
 func fileName(start, end time.Time) string {
 	if start.Equal(end) {
-		return end.Format(time.DateOnly) + ".json"
+		return end.Format(telemetry.DateOnly) + ".json"
 	}
 
-	return start.Format(time.DateOnly) + "_" + end.Format(time.DateOnly) + ".json"
+	return start.Format(telemetry.DateOnly) + "_" + end.Format(telemetry.DateOnly) + ".json"
 }
 
 // parseDateRange returns the start and end date from the given url.
@@ -271,7 +271,7 @@ func parseDateRange(url *url.URL) (start, end time.Time, _ error) {
 		if url.Query().Get("start") != "" || url.Query().Get("end") != "" {
 			return time.Time{}, time.Time{}, content.Error(fmt.Errorf("start or end key should be empty when date key is being used"), http.StatusBadRequest)
 		}
-		date, err := time.Parse(time.DateOnly, dateString)
+		date, err := time.Parse(telemetry.DateOnly, dateString)
 		if err != nil {
 			return time.Time{}, time.Time{}, content.Error(err, http.StatusBadRequest)
 		}
@@ -280,12 +280,12 @@ func parseDateRange(url *url.URL) (start, end time.Time, _ error) {
 
 	var err error
 	startString := url.Query().Get("start")
-	start, err = time.Parse(time.DateOnly, startString)
+	start, err = time.Parse(telemetry.DateOnly, startString)
 	if err != nil {
 		return time.Time{}, time.Time{}, content.Error(err, http.StatusBadRequest)
 	}
 	endString := url.Query().Get("end")
-	end, err = time.Parse(time.DateOnly, endString)
+	end, err = time.Parse(telemetry.DateOnly, endString)
 	if err != nil {
 		return time.Time{}, time.Time{}, content.Error(err, http.StatusBadRequest)
 	}
@@ -330,7 +330,7 @@ func handleChart(cfg *tconfig.Config, s *storage.API) content.HandlerFunc {
 		var reports []telemetry.Report
 		var xs []float64
 		for date := start; !date.After(end); date = date.AddDate(0, 0, 1) {
-			dailyReports, err := readMergedReports(ctx, date.Format(time.DateOnly)+".json", s)
+			dailyReports, err := readMergedReports(ctx, date.Format(telemetry.DateOnly)+".json", s)
 			if err != nil {
 				return err
 			}
@@ -341,7 +341,7 @@ func handleChart(cfg *tconfig.Config, s *storage.API) content.HandlerFunc {
 		}
 
 		data := nest(reports)
-		charts := charts(cfg, start.Format(time.DateOnly), end.Format(time.DateOnly), data, xs)
+		charts := charts(cfg, start.Format(telemetry.DateOnly), end.Format(telemetry.DateOnly), data, xs)
 
 		obj := fileName(start, end)
 		out, err := s.Chart.Object(obj).NewWriter(ctx)
@@ -357,7 +357,7 @@ func handleChart(cfg *tconfig.Config, s *storage.API) content.HandlerFunc {
 			return err
 		}
 
-		msg := fmt.Sprintf("processed %d reports from date %s to %s into %s", len(reports), start.Format(time.DateOnly), end.Format(time.DateOnly), s.Chart.URI()+"/"+obj)
+		msg := fmt.Sprintf("processed %d reports from date %s to %s into %s", len(reports), start.Format(telemetry.DateOnly), end.Format(telemetry.DateOnly), s.Chart.URI()+"/"+obj)
 		return content.Text(w, msg, http.StatusOK)
 	}
 }

godev/cmd/worker/main_test.go

@@ -834,7 +834,7 @@ func TestParseDateRange(t *testing.T) {
 
 			if !tc.wantErr {
 				if !gotStart.Equal(tc.wantStart) || !gotEnd.Equal(tc.wantEnd) {
-					t.Errorf("parseDateRange(%s) = (%s, %s), want (%s, %s)", tc.url, gotStart.Format(time.DateOnly), gotEnd.Format(time.DateOnly), tc.wantStart.Format(time.DateOnly), tc.wantEnd.Format(time.DateOnly))
+					t.Errorf("parseDateRange(%s) = (%s, %s), want (%s, %s)", tc.url, gotStart.Format(telemetry.DateOnly), gotEnd.Format(telemetry.DateOnly), tc.wantStart.Format(telemetry.DateOnly), tc.wantEnd.Format(telemetry.DateOnly))
 				}
 			}
 		})

internal/counter/file.go

@@ -297,7 +297,7 @@ func (f *file) rotate1() time.Time {
 		goVers,
 		runtime.GOOS,
 		runtime.GOARCH,
-		f.timeBegin.Format(time.DateOnly),
+		f.timeBegin.Format(telemetry.DateOnly),
 		FileVersion,
 	)
 	dir := telemetry.Default.LocalDir()

internal/counter/rotate_test.go

@@ -75,7 +75,7 @@ func TestRotateCounters(t *testing.T) {
 	// move into the future and rotate the file, remapping it
 	now = now.Add(7 * 24 * time.Hour)
 	f.rotate()
-	if got, want := f.timeBegin.Format(time.DateOnly), now.Format(time.DateOnly); got != want {
+	if got, want := f.timeBegin.Format(telemetry.DateOnly), now.Format(telemetry.DateOnly); got != want {
 		t.Errorf("f.timeBegin = %q, want %q", got, want)
 	}
 
@@ -167,8 +167,8 @@ func TestRotate(t *testing.T) {
 			t.Fatalf("err=%v, len(fi) = %d, want 2", err, len(fi))
 		}
 		x := fi[0].Name()
-		y := x[len(x)-len(time.DateOnly)-len(".v1.count") : len(x)-len(".v1.count")]
-		us, err := time.ParseInLocation(time.DateOnly, y, time.UTC)
+		y := x[len(x)-len(telemetry.DateOnly)-len(".v1.count") : len(x)-len(".v1.count")]
+		us, err := time.ParseInLocation(telemetry.DateOnly, y, time.UTC)
 		if err != nil {
 			t.Fatal(err)
 		}

internal/regtest/regtest.go

@@ -52,7 +52,7 @@ func NewProgram(t *testing.T, name string, fn func() int) Program {
 		// We are running the separate process that was spawned by RunProg.
 		fmt.Fprintf(os.Stderr, "running program %q\n", name)
 		if asofEnvVarValue != "" {
-			asof, err := time.Parse(time.DateOnly, asofEnvVarValue)
+			asof, err := time.Parse(telemetry.DateOnly, asofEnvVarValue)
 			if err != nil {
 				log.Fatalf("error parsing asof time %q: %v", asof, err)
 			}
@@ -116,7 +116,7 @@ func RunProgAsOf(t *testing.T, telemetryDir string, asof time.Time, prog Program
 	cmd := exec.Command(testBin, "-test.run", fmt.Sprintf("^%s$", testName))
 	cmd.Env = append(os.Environ(), telemetryDirEnvVar+"="+telemetryDir, entryPointEnvVar+"="+string(prog))
 	if !asof.IsZero() {
-		cmd.Env = append(cmd.Env, asofEnvVar+"="+asof.Format(time.DateOnly))
+		cmd.Env = append(cmd.Env, asofEnvVar+"="+asof.Format(telemetry.DateOnly))
 	}
 	return cmd.CombinedOutput()
 }

internal/telemetry/dateonly.go

@@ -0,0 +1,9 @@
+// Copyright 2024 The Go Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+package telemetry
+
+// TODO(rfindley): replace uses of DateOnly with time.DateOnly once we no
+// longer support building gopls with go 1.19.
+const DateOnly = "2006-01-02"

internal/telemetry/dir.go

@@ -102,9 +102,9 @@ func (d Dir) SetModeAsOf(mode string, asofTime time.Time) error {
 		return fmt.Errorf("cannot create a telemetry mode file: %w", err)
 	}
 
-	asof := asofTime.UTC().Format(time.DateOnly)
+	asof := asofTime.UTC().Format(DateOnly)
 	// Defensively guarantee that we can parse the asof time.
-	if _, err := time.Parse(time.DateOnly, asof); err != nil {
+	if _, err := time.Parse(DateOnly, asof); err != nil {
 		return fmt.Errorf("internal error: invalid mode date %q: %v", asof, err)
 	}
 
@@ -136,7 +136,7 @@ func (d Dir) Mode() (string, time.Time) {
 	//
 	// If the modefile contains a date, return it.
 	if idx := strings.Index(mode, " "); idx >= 0 {
-		d, err := time.Parse(time.DateOnly, mode[idx+1:])
+		d, err := time.Parse(DateOnly, mode[idx+1:])
 		if err != nil {
 			d = time.Time{}
 		}

internal/upload/date.go

@@ -11,6 +11,7 @@ import (
 	"time"
 
 	"golang.org/x/telemetry/internal/counter"
+	"golang.org/x/telemetry/internal/telemetry"
 )
 
 // time and date handling
@@ -19,7 +20,7 @@ var distantPast = 21 * 24 * time.Hour
 
 // reports that are too old (21 days) are not uploaded
 func (u *uploader) tooOld(date string, uploadStartTime time.Time) bool {
-	t, err := time.Parse(time.DateOnly, date)
+	t, err := time.Parse(telemetry.DateOnly, date)
 	if err != nil {
 		u.logger.Printf("tooOld: %v", err)
 		return false

internal/upload/dates_test.go

@@ -227,7 +227,7 @@ func TestDates(t *testing.T) {
 }
 
 func mustParseDate(d string) time.Time {
-	x, err := time.Parse(time.DateOnly, d)
+	x, err := time.Parse(telemetry.DateOnly, d)
 	if err != nil {
 		log.Fatalf("couldn't parse time %s", d)
 	}
@@ -236,13 +236,13 @@ func mustParseDate(d string) time.Time {
 
 // return a day more than 'old' before 'today'
 func olderThan(t *testing.T, today string, old time.Duration, nm string) string {
-	x, err := time.Parse(time.DateOnly, today)
+	x, err := time.Parse(telemetry.DateOnly, today)
 	if err != nil {
 		t.Errorf("%q not a day in test %s (%v)", today, nm, err)
 		return today // so test should fail
 	}
 	ans := x.Add(-old - 24*time.Hour)
-	msg := ans.Format(time.DateOnly)
+	msg := ans.Format(telemetry.DateOnly)
 	return msg
 }
 

internal/upload/reports.go

@@ -26,7 +26,7 @@ func (u *uploader) reports(todo *work) ([]string, error) {
 		return nil, nil // no reports
 	}
 	thisInstant := u.startTime
-	today := thisInstant.Format(time.DateOnly)
+	today := thisInstant.Format(telemetry.DateOnly)
 	lastWeek := latestReport(todo.uploaded)
 	if lastWeek >= today { //should never happen
 		lastWeek = ""

internal/upload/upload.go

@@ -12,11 +12,13 @@ import (
 	"regexp"
 	"strings"
 	"time"
+
+	"golang.org/x/telemetry/internal/telemetry"
 )
 
 var (
 	dateRE     = regexp.MustCompile(`(\d\d\d\d-\d\d-\d\d)[.]json$`)
-	dateFormat = time.DateOnly
+	dateFormat = telemetry.DateOnly
 	// TODO(rfindley): use dateFormat throughout.
 )
 
@@ -41,7 +43,7 @@ func (u *uploader) uploadReport(fname string) {
 	// TODO(rfindley): use uploadReportDate here, once we've done a gopls release.
 
 	// first make sure it is not in the future
-	today := thisInstant.Format(time.DateOnly)
+	today := thisInstant.Format(telemetry.DateOnly)
 	match := dateRE.FindStringSubmatch(fname)
 	if match == nil || len(match) < 2 {
 		u.logger.Printf("Report name %q missing date", filepath.Base(fname))
@@ -62,7 +64,7 @@ func (u *uploader) uploadReport(fname string) {
 // try to upload the report, 'true' if successful
 func (u *uploader) uploadReportContents(fname string, buf []byte) bool {
 	fdate := strings.TrimSuffix(filepath.Base(fname), ".json")
-	fdate = fdate[len(fdate)-len(time.DateOnly):]
+	fdate = fdate[len(fdate)-len(telemetry.DateOnly):]
 
 	newname := filepath.Join(u.dir.UploadDir(), fdate+".json")
 

start_test.go

@@ -58,7 +58,7 @@ func runProg(prog string) int {
 	}
 
 	// Get the fake time used by all programs.
-	asof, err := time.Parse(time.DateOnly, mustGetEnv(asofEnv))
+	asof, err := time.Parse(it.DateOnly, mustGetEnv(asofEnv))
 	if err != nil {
 		log.Fatalf("parsing %s: %v", asofEnv, err)
 	}
@@ -101,7 +101,7 @@ func execProg(t *testing.T, telemetryDir, prog string, asof time.Time, env ...st
 	cmd := exec.Command(exe, "** TestStart **") // this unused arg is just for ps(1)
 	cmd.Stderr = os.Stderr
 	cmd.Env = os.Environ()
-	cmd.Env = append(cmd.Env, asofEnv+"="+asof.Format(time.DateOnly))
+	cmd.Env = append(cmd.Env, asofEnv+"="+asof.Format(it.DateOnly))
 	cmd.Env = append(cmd.Env, telemetryDirEnv+"="+telemetryDir)
 	cmd.Env = append(cmd.Env, runStartEnv+"="+prog) // see TestMain
 	cmd.Env = append(cmd.Env, env...)