feat: Add support for Hookdeck Console (#42)

alexbouchardd · web-flow · commit 49bb54f8419b · 2023-03-05T10:02:42.000-07:00
* feat: Add support for Hookdeck Console

* fix: Fix comment

* fix: Remove innacurate comment
diff --git a/pkg/cmd/root.go b/pkg/cmd/root.go
@@ -100,6 +100,7 @@ func init() {
 	// Hidden configuration flags, useful for dev/debugging
 	rootCmd.PersistentFlags().StringVar(&Config.APIBaseURL, "api-base", hookdeck.DefaultAPIBaseURL, "Sets the API base URL")
 	rootCmd.PersistentFlags().StringVar(&Config.DashboardBaseURL, "dashboard-base", hookdeck.DefaultDashboardBaseURL, "Sets the web dashboard base URL")
+	rootCmd.PersistentFlags().StringVar(&Config.ConsoleBaseURL, "console-base", hookdeck.DefaultConsoleBaseURL, "Sets the web console base URL")
 
 	rootCmd.Flags().BoolP("version", "v", false, "Get the version of the Hookdeck CLI")
 
diff --git a/pkg/cmd/whoami.go b/pkg/cmd/whoami.go
@@ -4,10 +4,10 @@ import (
 	"fmt"
 	"os"
 
-	"github.com/spf13/cobra"
-
 	"github.com/hookdeck/hookdeck-cli/pkg/ansi"
+	"github.com/hookdeck/hookdeck-cli/pkg/login"
 	"github.com/hookdeck/hookdeck-cli/pkg/validators"
+	"github.com/spf13/cobra"
 )
 
 type whoamiCmd struct {
@@ -22,22 +22,28 @@ func newWhoamiCmd() *whoamiCmd {
 		Use:   "whoami",
 		Args:  validators.NoArgs,
 		Short: "Show the logged-in user",
-		RunE: lc.runWhoamiCmd,
+		RunE:  lc.runWhoamiCmd,
 	}
 
 	return lc
 }
 
 func (lc *whoamiCmd) runWhoamiCmd(cmd *cobra.Command, args []string) error {
-	displayName := Config.Profile.GetDisplayName()
-	teamName := Config.Profile.GetTeamName()
+	key, err := Config.Profile.GetAPIKey()
+	if err != nil {
+		return err
+	}
+	response, err := login.ValidateKey(Config.APIBaseURL, key)
+	if err != nil {
+		return err
+	}
 
 	color := ansi.Color(os.Stdout)
 
 	fmt.Printf(
 		"Logged in as %s in workspace %s\n",
-		color.Bold(displayName),
-		color.Bold(teamName),
+		color.Bold(response.UserName),
+		color.Bold(response.TeamName),
 	)
 
 	return nil
diff --git a/pkg/config/config.go b/pkg/config/config.go
@@ -37,6 +37,7 @@ type Config struct {
 	ProfilesFile     string
 	APIBaseURL       string
 	DashboardBaseURL string
+	ConsoleBaseURL   string
 	Insecure         bool
 }
 
diff --git a/pkg/config/profile.go b/pkg/config/profile.go
@@ -22,6 +22,8 @@ type Profile struct {
 	DeviceName  string
 	ProfileName string
 	TeamName    string
+	TeamID      string
+	TeamMode    string
 	APIKey      string
 	ClientID    string
 	DisplayName string
@@ -124,6 +126,28 @@ func (p *Profile) GetDisplayName() string {
 	return ""
 }
 
+func (p *Profile) GetTeamMode() string {
+	if p.TeamMode != "" {
+		return p.TeamMode
+	}
+	if err := viper.ReadInConfig(); err == nil {
+		return viper.GetString(p.GetConfigField("team_mode"))
+	}
+
+	return ""
+}
+
+func (p *Profile) GetTeamId() string {
+	if p.TeamID != "" {
+		return p.TeamID
+	}
+	if err := viper.ReadInConfig(); err == nil {
+		return viper.GetString(p.GetConfigField("team_id"))
+	}
+
+	return ""
+}
+
 func (p *Profile) refreshTeamName() string {
 	apiKey, err := p.GetAPIKey()
 	if err != nil {
@@ -248,6 +272,14 @@ func (p *Profile) writeProfile(runtimeViper *viper.Viper) error {
 		runtimeViper.Set(p.GetConfigField("team_name"), strings.TrimSpace(p.TeamName))
 	}
 
+	if p.TeamID != "" {
+		runtimeViper.Set(p.GetConfigField("team_id"), strings.TrimSpace(p.TeamID))
+	}
+
+	if p.TeamMode != "" {
+		runtimeViper.Set(p.GetConfigField("team_mode"), strings.TrimSpace(p.TeamMode))
+	}
+
 	runtimeViper.MergeInConfig()
 
 	runtimeViper.SetConfigFile(profilesFile)
diff --git a/pkg/hookdeck/client.go b/pkg/hookdeck/client.go
@@ -24,6 +24,8 @@ const DefaultDashboardURL = "https://dashboard.hookdeck.com"
 // DefaultDashboardBaseURL is the default base URL for dashboard requests
 const DefaultDashboardBaseURL = "http://dashboard.hookdeck.com"
 
+const DefaultConsoleBaseURL = "http://console.hookdeck.com"
+
 const DefaultWebsocektURL = "wss://ws.hookdeck.com"
 
 // Client is the API client used to sent requests to Hookdeck.
diff --git a/pkg/listen/listen.go b/pkg/listen/listen.go
@@ -82,14 +82,21 @@ func Listen(URL *url.URL, source_alias string, connection_query string, flags Fl
 	fmt.Println()
 	fmt.Println(ansi.Bold("Dashboard"))
 	if guest_url != "" {
-		fmt.Println("👤 Login URL: " + guest_url)
-		fmt.Println("Sign up in the dashboard to make your webhook URL permanent.")
+		fmt.Println("👤 Console URL: " + guest_url)
+		fmt.Println("Sign up in the Console to make your webhook URL permanent.")
+		fmt.Println()
+	} else {
+		var url = config.DashboardBaseURL
+		if config.Profile.GetTeamId() != "" {
+			url += "?team_id=" + config.Profile.GetTeamId()
+		}
+		if config.Profile.GetTeamMode() == "console" {
+			url = config.ConsoleBaseURL + "?source_id=" + source.Id
+		}
+		fmt.Println("👉 Inspect and replay webhooks: " + url)
 		fmt.Println()
 	}
 
-	fmt.Printf("👉 Inspect and replay webhooks: %s/cli/events\n", config.DashboardBaseURL)
-	fmt.Println()
-
 	fmt.Println(ansi.Bold(source.Label + " Source"))
 	fmt.Println("🔌 Webhook URL: " + source.Url)
 	fmt.Println()
@@ -110,6 +117,8 @@ func Listen(URL *url.URL, source_alias string, connection_query string, flags Fl
 		Key:              key,
 		APIBaseURL:       config.APIBaseURL,
 		DashboardBaseURL: config.DashboardBaseURL,
+		ConsoleBaseURL:   config.ConsoleBaseURL,
+		Profile:          config.Profile,
 		WSBaseURL:        flags.WSBaseURL,
 		NoWSS:            flags.NoWSS,
 		URL:              URL,
diff --git a/pkg/login/client_login.go b/pkg/login/client_login.go
@@ -32,13 +32,37 @@ type Links struct {
 
 // Login function is used to obtain credentials via hookdeck dashboard.
 func Login(config *config.Config, input io.Reader) error {
+	var s *spinner.Spinner
+
+	if config.Profile.APIKey != "" {
+		s = ansi.StartNewSpinner("Verifying CLI Key...", os.Stdout)
+		response, err := ValidateKey(config.APIBaseURL, config.Profile.APIKey)
+		if err != nil {
+			return err
+		}
+
+		config.Profile.ClientID = response.ClientID
+		config.Profile.DisplayName = response.UserName
+		config.Profile.TeamName = response.TeamName
+		config.Profile.TeamMode = response.TeamMode
+		config.Profile.TeamID = response.TeamID
+
+		profileErr := config.Profile.CreateProfile()
+		if profileErr != nil {
+			return profileErr
+		}
+
+		message := SuccessMessage(response.UserName, response.TeamName, config.Profile.TeamMode == "console")
+		ansi.StopSpinner(s, message, os.Stdout)
+
+		return nil
+	}
+
 	links, err := getLinks(config.APIBaseURL, config.Profile.DeviceName)
 	if err != nil {
 		return err
 	}
 
-	var s *spinner.Spinner
-
 	if isSSH() || !canOpenBrowser() {
 		fmt.Printf("To authenticate with Hookdeck, please go to: %s\n", links.BrowserURL)
 
@@ -72,13 +96,15 @@ func Login(config *config.Config, input io.Reader) error {
 	config.Profile.ClientID = response.ClientID
 	config.Profile.DisplayName = response.UserName
 	config.Profile.TeamName = response.TeamName
+	config.Profile.TeamMode = response.TeamMode
+	config.Profile.TeamID = response.TeamID
 
 	profileErr := config.Profile.CreateProfile()
 	if profileErr != nil {
 		return profileErr
 	}
 
-	message := SuccessMessage(response.UserName, response.TeamName)
+	message := SuccessMessage(response.UserName, response.TeamName, response.TeamMode == "console")
 	ansi.StopSpinner(s, message, os.Stdout)
 
 	return nil
@@ -118,6 +144,8 @@ func GuestLogin(config *config.Config) (string, error) {
 	config.Profile.ClientID = response.ClientID
 	config.Profile.DisplayName = response.UserName
 	config.Profile.TeamName = response.TeamName
+	config.Profile.TeamMode = response.TeamMode
+	config.Profile.TeamID = response.TeamID
 
 	profileErr := config.Profile.CreateProfile()
 	if profileErr != nil {
diff --git a/pkg/login/interactive_login.go b/pkg/login/interactive_login.go
@@ -66,14 +66,16 @@ func InteractiveLogin(config *config.Config) error {
 	config.Profile.ClientID = response.ClientID
 	config.Profile.DisplayName = response.UserName
 	config.Profile.TeamName = response.TeamName
+	config.Profile.TeamMode = response.TeamMode
+	config.Profile.TeamID = response.TeamID
 
 	profileErr := config.Profile.CreateProfile()
 	if profileErr != nil {
 		ansi.StopSpinner(s, "", os.Stdout)
 		return profileErr
 	}
 
-	message := SuccessMessage(response.UserName, response.TeamName)
+	message := SuccessMessage(response.UserName, response.TeamName, response.TeamMode == "console")
 
 	ansi.StopSpinner(s, message, os.Stdout)
 
diff --git a/pkg/login/login_message.go b/pkg/login/login_message.go
@@ -8,8 +8,14 @@ import (
 )
 
 // SuccessMessage returns the display message for a successfully authenticated user
-func SuccessMessage(displayName string, teamName string) string {
+func SuccessMessage(displayName string, teamName string, isConsole bool) string {
 	color := ansi.Color(os.Stdout)
+
+	if isConsole == true {
+		return fmt.Sprintf(
+			"Done! The Hookdeck CLI is configured with your console Sandbox",
+		)
+	}
 	return fmt.Sprintf(
 		"Done! The Hookdeck CLI is configured for %s in workspace %s\n",
 		color.Bold(displayName),
diff --git a/pkg/login/poll.go b/pkg/login/poll.go
@@ -21,6 +21,7 @@ type PollAPIKeyResponse struct {
 	UserName string `json:"user_name"`
 	TeamID   string `json:"team_id"`
 	TeamName string `json:"team_name"`
+	TeamMode string `json:"team_mode"`
 	APIKey   string `json:"key"`
 	ClientID string `json:"client_id"`
 }
diff --git a/pkg/login/validate.go b/pkg/login/validate.go
@@ -0,0 +1,52 @@
+package login
+
+import (
+	"context"
+	"encoding/json"
+	"io/ioutil"
+	"net/url"
+
+	"github.com/hookdeck/hookdeck-cli/pkg/hookdeck"
+)
+
+// ValidateAPIKeyResponse returns the user and team associated with a key
+type ValidateAPIKeyResponse struct {
+	UserID   string `json:"user_id"`
+	UserName string `json:"user_name"`
+	TeamID   string `json:"team_id"`
+	TeamName string `json:"team_name"`
+	TeamMode string `json:"team_mode"`
+	ClientID string `json:"client_id"`
+}
+
+func ValidateKey(baseURL string, key string) (*ValidateAPIKeyResponse, error) {
+
+	parsedBaseURL, err := url.Parse(baseURL)
+	if err != nil {
+		return nil, err
+	}
+
+	client := &hookdeck.Client{
+		BaseURL: parsedBaseURL,
+		APIKey:  key,
+	}
+
+	res, err := client.Get(context.Background(), "/cli-auth/validate", "", nil)
+	if err != nil {
+		return nil, err
+	}
+
+	var response ValidateAPIKeyResponse
+
+	defer res.Body.Close()
+	body, err := ioutil.ReadAll(res.Body)
+	if err != nil {
+		return nil, err
+	}
+	err = json.Unmarshal(body, &response)
+	if err != nil {
+		return nil, err
+	}
+
+	return &response, nil
+}
diff --git a/pkg/proxy/proxy.go b/pkg/proxy/proxy.go
@@ -20,6 +20,7 @@ import (
 	log "github.com/sirupsen/logrus"
 
 	"github.com/hookdeck/hookdeck-cli/pkg/ansi"
+	"github.com/hookdeck/hookdeck-cli/pkg/config"
 	"github.com/hookdeck/hookdeck-cli/pkg/hookdeck"
 	"github.com/hookdeck/hookdeck-cli/pkg/websocket"
 )
@@ -34,12 +35,13 @@ const timeLayout = "2006-01-02 15:04:05"
 type Config struct {
 	// DeviceName is the name of the device sent to Hookdeck to help identify the device
 	DeviceName string
+	Profile    config.Profile
 	// Key is the API key used to authenticate with Hookdeck
-	Key string
-	// EndpointsMap is a mapping of local webhook endpoint urls to the events they consume
+	Key              string
 	URL              *url.URL
 	APIBaseURL       string
 	DashboardBaseURL string
+	ConsoleBaseURL   string
 	WSBaseURL        string
 	// Indicates whether to print full JSON objects to stdout
 	PrintJSON bool
@@ -313,13 +315,16 @@ func (p *Proxy) processAttempt(msg websocket.IncomingMessage) {
 func (p *Proxy) processEndpointResponse(webhookEvent *websocket.Attempt, resp *http.Response) {
 	localTime := time.Now().Format(timeLayout)
 	color := ansi.Color(os.Stdout)
-	outputStr := fmt.Sprintf("%s [%d] %s %s | %s/cli/events/%s",
+	var url = p.cfg.DashboardBaseURL + "/cli/events/" + webhookEvent.Body.EventID
+	if p.cfg.Profile.GetTeamMode() == "console" {
+		url = p.cfg.ConsoleBaseURL + "/?event_id=" + webhookEvent.Body.EventID
+	}
+	outputStr := fmt.Sprintf("%s [%d] %s %s | %s",
 		color.Faint(localTime),
 		ansi.ColorizeStatus(resp.StatusCode),
 		resp.Request.Method,
 		resp.Request.URL,
-		p.cfg.DashboardBaseURL,
-		webhookEvent.Body.EventID,
+		url,
 	)
 	fmt.Println(outputStr)
 

Original file line number	Diff line number	Diff line change
`@@ -37,6 +37,7 @@ type Config struct {`
`37`	`37`	`ProfilesFile string`
`38`	`38`	`APIBaseURL string`
`39`	`39`	`DashboardBaseURL string`
	`40`	`+ ConsoleBaseURL string`
`40`	`41`	`Insecure bool`
`41`	`42`	`}`
`42`	`43`
Original file line number	Diff line number	Diff line change
`@@ -21,6 +21,7 @@ type PollAPIKeyResponse struct {`
`21`	`21`	UserName string `json:"user_name"`
`22`	`22`	TeamID string `json:"team_id"`
`23`	`23`	TeamName string `json:"team_name"`
	`24`	+ TeamMode string `json:"team_mode"`
`24`	`25`	APIKey string `json:"key"`
`25`	`26`	ClientID string `json:"client_id"`
`26`	`27`	`}`