enable cli request logging (#85)

* enable cli request logging * fix test
amalshaji · Aug 15, 2024 · 2e1c18f · 2e1c18f
1 parent 9749947
commit 2e1c18f
Show file tree

Hide file tree

Showing 5 changed files with 38 additions and 23 deletions.
diff --git a/admin/apis/v1/config.py b/admin/apis/v1/config.py
@@ -17,6 +17,7 @@ class GetConfigInput(BaseModel):
 server_url: {server_url}
 ssh_url: {ssh_url}
 secret_key: {secret_key}
+enable_request_logging: false
 tunnels:
   - name: portr
     subdomain: portr

diff --git a/admin/tests/api_tests/test_config.py b/admin/tests/api_tests/test_config.py
@@ -30,7 +30,7 @@ def test_download_config_should_pass(self):
             "/api/v1/config/download", json={"secret_key": self.team_user.secret_key}
         )
         assert resp.json() == {
-            "message": f"server_url: {settings.server_url}\nssh_url: {settings.ssh_url}\nsecret_key: {self.team_user.secret_key}\ntunnels:\n  - name: portr\n    subdomain: portr\n    port: 4321"
+            "message": f"server_url: {settings.server_url}\nssh_url: {settings.ssh_url}\nsecret_key: {self.team_user.secret_key}\nenable_request_logging: false\ntunnels:\n  - name: portr\n    subdomain: portr\n    port: 4321"
         }
 
     def test_download_config_with_wrong_secret_key_should_fail(self):

diff --git a/tunnel/internal/client/client/client.go b/tunnel/internal/client/client/client.go
@@ -43,13 +43,14 @@ func (c *Client) Start(ctx context.Context, services ...string) error {
 			continue
 		}
 		clientConfigs = append(clientConfigs, config.ClientConfig{
-			ServerUrl:    c.config.ServerUrl,
-			SshUrl:       c.config.SshUrl,
-			TunnelUrl:    c.config.TunnelUrl,
-			SecretKey:    c.config.SecretKey,
-			Tunnel:       tunnel,
-			UseLocalHost: c.config.UseLocalHost,
-			Debug:        c.config.Debug,
+			ServerUrl:            c.config.ServerUrl,
+			SshUrl:               c.config.SshUrl,
+			TunnelUrl:            c.config.TunnelUrl,
+			SecretKey:            c.config.SecretKey,
+			Tunnel:               tunnel,
+			UseLocalHost:         c.config.UseLocalHost,
+			Debug:                c.config.Debug,
+			EnableRequestLogging: c.config.EnableRequestLogging,
 		})
 	}
 

diff --git a/tunnel/internal/client/config/config.go b/tunnel/internal/client/config/config.go
@@ -45,14 +45,15 @@ func (t *Tunnel) GetLocalAddr() string {
 }
 
 type Config struct {
-	ServerUrl    string   `yaml:"server_url"`
-	SshUrl       string   `yaml:"ssh_url"`
-	TunnelUrl    string   `yaml:"tunnel_url"`
-	SecretKey    string   `yaml:"secret_key"`
-	Tunnels      []Tunnel `yaml:"tunnels"`
-	UseLocalHost bool     `yaml:"use_localhost"`
-	Debug        bool     `yaml:"debug"`
-	UseVite      bool     `yaml:"use_vite"`
+	ServerUrl            string   `yaml:"server_url"`
+	SshUrl               string   `yaml:"ssh_url"`
+	TunnelUrl            string   `yaml:"tunnel_url"`
+	SecretKey            string   `yaml:"secret_key"`
+	Tunnels              []Tunnel `yaml:"tunnels"`
+	UseLocalHost         bool     `yaml:"use_localhost"`
+	Debug                bool     `yaml:"debug"`
+	UseVite              bool     `yaml:"use_vite"`
+	EnableRequestLogging bool     `yaml:"enable_request_logging"`
 }
 
 func (c *Config) SetDefaults() {
@@ -83,13 +84,14 @@ func (c Config) GetAdminAddress() string {
 }
 
 type ClientConfig struct {
-	ServerUrl    string
-	SshUrl       string
-	TunnelUrl    string
-	SecretKey    string
-	Tunnel       Tunnel
-	UseLocalHost bool
-	Debug        bool
+	ServerUrl            string
+	SshUrl               string
+	TunnelUrl            string
+	SecretKey            string
+	Tunnel               Tunnel
+	UseLocalHost         bool
+	Debug                bool
+	EnableRequestLogging bool
 }
 
 func (c *ClientConfig) GetHttpTunnelAddr() string {

diff --git a/tunnel/internal/client/ssh/ssh.go b/tunnel/internal/client/ssh/ssh.go
@@ -327,6 +327,17 @@ func (s *SshClient) logHttpRequest(
 		}
 		return
 	}
+
+	if s.config.EnableRequestLogging {
+		fmt.Printf(
+			"%s [%d] %-6s %d %s\n",
+			req.LoggedAt.Local().Format("2006-01-02 15:04:05"),
+			req.Localport,
+			req.Method,
+			req.ResponseStatusCode,
+			req.Url,
+		)
+	}
 }
 
 func (s *SshClient) tcpTunnel(src, dst net.Conn) {