Release 2021.5.0

.github/workflows/check.yaml

@@ -1,20 +0,0 @@
-on: [push, pull_request]
-name: Check
-jobs:
-  check:
-    strategy:
-      matrix:
-        go-version: [1.15.x]
-        os: [ubuntu-latest, macos-latest, windows-latest]
-    runs-on: ${{ matrix.os }}
-    steps:
-    - name: Install Go
-      uses: actions/setup-go@v2
-      with:
-        go-version: ${{ matrix.go-version }}
-    - name: Install go-sumtype
-      run: go get github.com/BurntSushi/go-sumtype
-    - name: Checkout code
-      uses: actions/checkout@v2
-    - name: Test
-      run: make test

RELEASE_NOTES

@@ -1,10 +1,3 @@
-2021.5.2
-- 2021-05-04 Setup a Github action for checking the cloudflared build
-
-2021.5.1
-- 2021-05-10 TUN-4342: Fix false positive warning about unused hostname property
-- 2021-05-10 Release 2021.5.0
-
 2021.5.0
 - 2021-05-10 TUN-4384: Silence log from automaxprocs
 - 2021-05-10 AUTH-3537: AUDs in JWTs are now always arrays

cmd/cloudflared/tunnel/cmd.go

@@ -181,7 +181,7 @@ func runAdhocNamedTunnel(sc *subcommandContext, name, credentialsOutputPath stri
 
 	if r, ok := routeFromFlag(sc.c); ok {
 		if res, err := sc.route(tunnel.ID, r); err != nil {
-			sc.log.Err(err).Str("route", r.String()).Msg("failed to provision routing, please create it manually via Cloudflare dashboard or UI; most likely you already have a conflicting record there")
+			sc.log.Err(err).Msg("failed to create route, please create it manually")
 		} else {
 			sc.log.Info().Msg(res.SuccessSummary())
 		}

cmd/cloudflared/tunnel/configuration.go

@@ -160,6 +160,10 @@ func prepareTunnelConfig(
 	if err != nil {
 		log.Err(err).Str(LogFieldHostname, configHostname).Msg("Invalid hostname")
 		return nil, ingress.Ingress{}, errors.Wrap(err, "Invalid hostname")
+	} else if hostname != "" && isNamedTunnel {
+		log.Warn().Msg("The property `hostname` in your configuration is ignored because you configured a Named Tunnel " +
+			"in the property `tunnel`. Make sure to provision the routing (e.g. via `cloudflared tunnel route`) or else " +
+			"your origin will not be reachable. You should remove the `hostname` property to avoid this warning.")
 	}
 	isFreeTunnel := hostname == ""
 	clientID := c.String("id")

cmd/cloudflared/tunnel/signal_test.go

@@ -1,5 +1,3 @@
-// +build !windows
-
 package tunnel
 
 import (

cmd/cloudflared/tunnel/subcommands.go

@@ -595,12 +595,6 @@ func runCommand(c *cli.Context) error {
 		}
 	}
 
-	if c.String("hostname") != "" {
-		sc.log.Warn().Msg("The property `hostname` in your configuration is ignored because you configured a Named Tunnel " +
-			"in the property `tunnel` to run. Make sure to provision the routing (e.g. via `cloudflared tunnel route dns/lb`) or else " +
-			"your origin will not be reachable. You should remove the `hostname` property to avoid this warning.")
-	}
-
 	return runNamedTunnel(sc, tunnelRef)
 }
 

cmd/cloudflared/tunnel/subcommands_test.go

@@ -1,6 +1,7 @@
 package tunnel
 
 import (
+	"fmt"
 	"path/filepath"
 	"testing"
 
@@ -94,7 +95,7 @@ func TestTunnelfilePath(t *testing.T) {
 	assert.NoError(t, err)
 	homeDir, err := homedir.Dir()
 	assert.NoError(t, err)
-	expected := filepath.Join(homeDir, ".cloudflared", tunnelID.String()+".json")
+	expected := fmt.Sprintf("%s/.cloudflared/%v.json", homeDir, tunnelID)
 	assert.Equal(t, expected, actual)
 }
 

cmd/cloudflared/updater/workers_service_test.go

@@ -1,5 +1,3 @@
-// +build !windows
-
 package updater
 
 import (
@@ -15,7 +13,6 @@ import (
 	"net/http"
 	"net/http/httptest"
 	"os"
-	"path/filepath"
 	"runtime"
 	"strconv"
 	"strings"
@@ -24,8 +21,6 @@ import (
 	"github.com/stretchr/testify/require"
 )
 
-var testFilePath = filepath.Join(os.TempDir(), "test")
-
 func respondWithJSON(w http.ResponseWriter, v interface{}, status int) {
 	data, _ := json.Marshal(v)
 
@@ -213,6 +208,7 @@ func TestUpdateService(t *testing.T) {
 	ts := createServer()
 	defer ts.Close()
 
+	testFilePath := "tmpfile"
 	createTestFile(t, testFilePath)
 	defer os.Remove(testFilePath)
 	log.Println("server url: ", ts.URL)
@@ -233,6 +229,7 @@ func TestBetaUpdateService(t *testing.T) {
 	ts := createServer()
 	defer ts.Close()
 
+	testFilePath := "tmpfile"
 	createTestFile(t, testFilePath)
 	defer os.Remove(testFilePath)
 
@@ -252,6 +249,7 @@ func TestFailUpdateService(t *testing.T) {
 	ts := createServer()
 	defer ts.Close()
 
+	testFilePath := "tmpfile"
 	createTestFile(t, testFilePath)
 	defer os.Remove(testFilePath)
 
@@ -265,6 +263,7 @@ func TestNoUpdateService(t *testing.T) {
 	ts := createServer()
 	defer ts.Close()
 
+	testFilePath := "tmpfile"
 	createTestFile(t, testFilePath)
 	defer os.Remove(testFilePath)
 
@@ -279,6 +278,7 @@ func TestForcedUpdateService(t *testing.T) {
 	ts := createServer()
 	defer ts.Close()
 
+	testFilePath := "tmpfile"
 	createTestFile(t, testFilePath)
 	defer os.Remove(testFilePath)
 
@@ -298,6 +298,7 @@ func TestUpdateSpecificVersionService(t *testing.T) {
 	ts := createServer()
 	defer ts.Close()
 
+	testFilePath := "tmpfile"
 	createTestFile(t, testFilePath)
 	defer os.Remove(testFilePath)
 	reqVersion := "2020.9.1"
@@ -318,6 +319,7 @@ func TestCompressedUpdateService(t *testing.T) {
 	ts := createServer()
 	defer ts.Close()
 
+	testFilePath := "tmpfile"
 	createTestFile(t, testFilePath)
 	defer os.Remove(testFilePath)
 
@@ -337,6 +339,7 @@ func TestUpdateWhenRunningKnownBuggyVersion(t *testing.T) {
 	ts := createServer()
 	defer ts.Close()
 
+	testFilePath := "tmpfile"
 	createTestFile(t, testFilePath)
 	defer os.Remove(testFilePath)
 

metrics/timer.go

@@ -0,0 +1,48 @@
+package metrics
+
+import (
+	"time"
+
+	"github.com/prometheus/client_golang/prometheus"
+)
+
+// Timer assumes the metrics is partitioned by one label
+type Timer struct {
+	startTime   map[string]time.Time
+	metrics     *prometheus.HistogramVec
+	measureUnit time.Duration
+	labelKey    string
+}
+
+func NewTimer(metrics *prometheus.HistogramVec, unit time.Duration, labelKey string) *Timer {
+	return &Timer{
+		startTime:   make(map[string]time.Time),
+		measureUnit: unit,
+		metrics:     metrics,
+		labelKey:    labelKey,
+	}
+}
+
+func (i *Timer) Start(labelVal string) {
+	i.startTime[labelVal] = time.Now()
+}
+
+func (i *Timer) End(labelVal string) time.Duration {
+	if start, ok := i.startTime[labelVal]; ok {
+		return Latency(start, time.Now())
+	}
+	return 0
+}
+
+func (i *Timer) Observe(measurement time.Duration, labelVal string) {
+	metricsLabels := prometheus.Labels{i.labelKey: labelVal}
+	i.metrics.With(metricsLabels).Observe(float64(measurement / i.measureUnit))
+}
+
+func (i *Timer) EndAndObserve(labelVal string) {
+	i.Observe(i.End(labelVal), labelVal)
+}
+
+func Latency(startTime, endTime time.Time) time.Duration {
+	return endTime.Sub(startTime)
+}

metrics/timer_test.go

@@ -0,0 +1,24 @@
+package metrics
+
+import (
+	"testing"
+	"time"
+
+	"github.com/prometheus/client_golang/prometheus"
+	"github.com/stretchr/testify/assert"
+)
+
+func TestEnd(t *testing.T) {
+	m := prometheus.NewHistogramVec(
+		prometheus.HistogramOpts{
+			Namespace: "TestCallLatencyWithoutMeasurement",
+			Name:      "Latency",
+			Buckets:   prometheus.LinearBuckets(0, 50, 100),
+		},
+		[]string{"key"},
+	)
+	timer := NewTimer(m, time.Millisecond, "key")
+	assert.Equal(t, time.Duration(0), timer.End("dne"))
+	timer.Start("test")
+	assert.NotEqual(t, time.Duration(0), timer.End("test"))
+}

sshgen/sshgen_test.go

@@ -1,5 +1,3 @@
-// +build !windows
-
 package sshgen
 
 import (

tunnelstore/client.go

@@ -72,7 +72,6 @@ type Route interface {
 	json.Marshaler
 	RecordType() string
 	UnmarshalResult(body io.Reader) (RouteResult, error)
-	String() string
 }
 
 type RouteResult interface {
@@ -117,10 +116,6 @@ func (dr *DNSRoute) RecordType() string {
 	return "dns"
 }
 
-func (dr *DNSRoute) String() string {
-	return fmt.Sprintf("%s %s", dr.RecordType(), dr.userHostname)
-}
-
 func (res *DNSRouteResult) SuccessSummary() string {
 	var msgFmt string
 	switch res.CName {
@@ -169,10 +164,6 @@ func (lr *LBRoute) RecordType() string {
 	return "lb"
 }
 
-func (lb *LBRoute) String() string {
-	return fmt.Sprintf("%s %s %s", lb.RecordType(), lb.lbName, lb.lbPool)
-}
-
 func (lr *LBRoute) UnmarshalResult(body io.Reader) (RouteResult, error) {
 	var result LBRouteResult
 	err := parseResponse(body, &result)

watcher/file_test.go

@@ -1,5 +1,3 @@
-// +build !windows
-
 package watcher
 
 import (