Merge pull request #181 from ngrok/kc/add-url-flag-to-agent-all-types…

…-tcp-http-tls

Kc/add url flag to agent all types tcp http tls

config/common.go

@@ -10,6 +10,13 @@ type commonOpts struct {
 	Metadata string
 	// Tunnel backend metadata. Viewable via the dashboard and API, but has no
 	// bearing on tunnel behavior.
+
+	// The URL to request for this endpoint
+	URL string
+
+	// user supplied description of the endpoint
+	Description string
+
 	// If not set, defaults to a URI in the format `app://hostname/path/to/executable?pid=12345`
 	ForwardsTo string
 

config/description.go

@@ -0,0 +1,28 @@
+package config
+
+type descriptionOption string
+
+func WithDescription(name string) interface {
+	HTTPEndpointOption
+	TCPEndpointOption
+	TLSEndpointOption
+	LabeledTunnelOption
+} {
+	return descriptionOption(name)
+}
+
+func (opt descriptionOption) ApplyHTTP(opts *httpOptions) {
+	opts.Description = string(opt)
+}
+
+func (opt descriptionOption) ApplyTLS(opts *tlsOptions) {
+	opts.Description = string(opt)
+}
+
+func (opt descriptionOption) ApplyTCP(opts *tcpOptions) {
+	opts.Description = string(opt)
+}
+
+func (opt descriptionOption) ApplyLabeled(opts *labeledOptions) {
+	opts.Description = string(opt)
+}

config/http.go

@@ -88,6 +88,7 @@ type httpOptions struct {
 
 func (cfg *httpOptions) toProtoConfig() *proto.HTTPEndpoint {
 	opts := &proto.HTTPEndpoint{
+		URL:       cfg.URL,
 		Domain:    cfg.Domain,
 		Hostname:  cfg.Hostname,
 		Subdomain: cfg.Subdomain,
@@ -146,8 +147,9 @@ func (cfg *httpOptions) WithForwardsTo(url *url.URL) {
 
 func (cfg httpOptions) Extra() proto.BindExtra {
 	return proto.BindExtra{
-		Metadata: cfg.Metadata,
-		Bindings: cfg.Bindings,
+		Metadata:    cfg.Metadata,
+		Description: cfg.Description,
+		Bindings:    cfg.Bindings,
 	}
 }
 

config/labeled.go

@@ -66,7 +66,8 @@ func (cfg *labeledOptions) WithForwardsTo(url *url.URL) {
 
 func (cfg labeledOptions) Extra() proto.BindExtra {
 	return proto.BindExtra{
-		Metadata: cfg.Metadata,
+		Metadata:    cfg.Metadata,
+		Description: cfg.Description,
 	}
 }
 

config/policy.go

@@ -77,8 +77,6 @@ func (p *policy) ApplyTCP(opts *tcpOptions) {
 
 // policyToString converts the policy into a JSON string representation. This is to help remap Policy to TrafficPolicy.
 func policyToString(p *policy) string {
-	fmt.Println("WithPolicy has been deprecated. Please use WithPolicyString instead, as WithPolicy will stop working soon.")
-
 	val, err := json.Marshal(p)
 	if err != nil {
 		panic(errors.New(fmt.Sprintf("failed to parse action configuration due to error: %s", err.Error())))

config/tcp.go

@@ -32,6 +32,7 @@ func TCPEndpoint(opts ...TCPEndpointOption) Tunnel {
 type tcpOptions struct {
 	// Common tunnel configuration options.
 	commonOpts
+
 	// The TCP address to request for this edge.
 	RemoteAddr string
 	// An HTTP Server to run traffic on
@@ -48,6 +49,7 @@ func WithRemoteAddr(addr string) TCPEndpointOption {
 
 func (cfg *tcpOptions) toProtoConfig() *proto.TCPEndpoint {
 	return &proto.TCPEndpoint{
+		URL:           cfg.URL,
 		Addr:          cfg.RemoteAddr,
 		IPRestriction: cfg.commonOpts.CIDRRestrictions.toProtoConfig(),
 		ProxyProto:    proto.ProxyProto(cfg.commonOpts.ProxyProto),
@@ -69,8 +71,9 @@ func (cfg *tcpOptions) WithForwardsTo(url *url.URL) {
 
 func (cfg tcpOptions) Extra() proto.BindExtra {
 	return proto.BindExtra{
-		Metadata: cfg.Metadata,
-		Bindings: cfg.Bindings,
+		Metadata:    cfg.Metadata,
+		Description: cfg.Description,
+		Bindings:    cfg.Bindings,
 	}
 }
 

config/tls.go

@@ -61,11 +61,11 @@ type tlsOptions struct {
 
 func (cfg *tlsOptions) toProtoConfig() *proto.TLSEndpoint {
 	opts := &proto.TLSEndpoint{
+		URL:        cfg.URL,
 		Domain:     cfg.Domain,
 		ProxyProto: proto.ProxyProto(cfg.ProxyProto),
-
-		Subdomain: cfg.Subdomain,
-		Hostname:  cfg.Hostname,
+		Subdomain:  cfg.Subdomain,
+		Hostname:   cfg.Hostname,
 	}
 
 	opts.IPRestriction = cfg.commonOpts.CIDRRestrictions.toProtoConfig()
@@ -99,8 +99,9 @@ func (cfg *tlsOptions) WithForwardsTo(url *url.URL) {
 
 func (cfg tlsOptions) Extra() proto.BindExtra {
 	return proto.BindExtra{
-		Metadata: cfg.Metadata,
-		Bindings: cfg.Bindings,
+		Metadata:    cfg.Metadata,
+		Description: cfg.Description,
+		Bindings:    cfg.Bindings,
 	}
 }
 

config/url.go

@@ -0,0 +1,23 @@
+package config
+
+type urlOption string
+
+func WithURL(name string) interface {
+	HTTPEndpointOption
+	TLSEndpointOption
+	TCPEndpointOption
+} {
+	return urlOption(name)
+}
+
+func (opt urlOption) ApplyHTTP(opts *httpOptions) {
+	opts.URL = string(opt)
+}
+
+func (opt urlOption) ApplyTLS(opts *tlsOptions) {
+	opts.URL = string(opt)
+}
+
+func (opt urlOption) ApplyTCP(opts *tcpOptions) {
+	opts.URL = string(opt)
+}

internal/tunnel/proto/msg.go

@@ -224,6 +224,7 @@ type BindExtra struct {
 	Token       string
 	IPPolicyRef string
 	Metadata    string
+	Description string
 	Bindings    []string
 }
 
@@ -282,6 +283,7 @@ func ParseProxyProto(proxyProto string) (ProxyProto, bool) {
 }
 
 type HTTPEndpoint struct {
+	URL               string
 	Domain            string
 	Hostname          string // public hostname of the bind
 	Subdomain         string
@@ -308,6 +310,7 @@ type HTTPEndpoint struct {
 }
 
 type TCPEndpoint struct {
+	URL  string
 	Addr string
 	ProxyProto
 
@@ -318,6 +321,7 @@ type TCPEndpoint struct {
 }
 
 type TLSEndpoint struct {
+	URL       string
 	Domain    string
 	Hostname  string // public hostname of the bind
 	Subdomain string

session.go

@@ -920,7 +920,7 @@ func (s *sessionImpl) ListenAndServeHTTP(ctx context.Context, cfg config.Tunnel,
 			impl.server = server
 		} else {
 			// Inform end user that they're using a deprecated option.
-			fmt.Println("Tunnel is serving an HTTP server via HTTP options. This has been deprecated. Please use Session.ListenAndServeHTTP instead.")
+			s.inner().Logger.Warn("Tunnel is serving an HTTP server via HTTP options. This has been deprecated. Please use Session.ListenAndServeHTTP instead.")
 		}
 	}