Better observe flow

Author: kalverra

cmd/gather.go

@@ -2,49 +2,35 @@
 package cmd
 
 import (
-	"errors"
 	"fmt"
 	"os"
 	"time"
 
 	"github.com/spf13/cobra"
 
 	"github.com/kalverra/octometrics/gather"
+	"github.com/kalverra/octometrics/observe"
 )
 
 var (
-	githubToken string
-	forceUpdate bool
+	githubToken  string
+	githubClient *gather.GitHubClient
+	forceUpdate  bool
+	noObserve    bool
 )
 
 var gatherCmd = &cobra.Command{
 	Use:   "gather",
 	Short: "Gather metrics from GitHub",
 	PreRunE: func(_ *cobra.Command, _ []string) error {
-		if owner == "" {
-			return errors.New("owner must be provided")
-		}
-		if repo == "" {
-			return errors.New("repo must be provided")
-		}
-
-		setCount := 0
-		if commitSHA != "" {
-			setCount++
-		}
-		if workflowRunID != 0 {
-			setCount++
-		}
-		if pullRequestNumber != 0 {
-			setCount++
-		}
-		if setCount > 1 {
-			return errors.New("only one of commit SHA, workflow run ID or pull request number can be provided")
+		if err := cfg.ValidateGather(); err != nil {
+			return err
 		}
-		if setCount == 0 {
-			return errors.New("one of commit SHA, workflow run ID or pull request number must be provided")
+		var err error
+		githubClient, err = gather.NewGitHubClient(logger, githubToken, nil)
+		if err != nil {
+			return fmt.Errorf("failed to create GitHub client: %w", err)
 		}
-
 		return nil
 	},
 	RunE: func(_ *cobra.Command, _ []string) error {
@@ -54,15 +40,16 @@ var gatherCmd = &cobra.Command{
 
 		startTime := time.Now()
 
-		logger = logger.With().Str("owner", owner).Str("repo", repo).Logger()
+		logger = logger.With().Str("owner", cfg.Owner).Str("repo", cfg.Repo).Logger()
 
-		if workflowRunID != 0 {
-			logger = logger.With().Int64("workflow_run_id", workflowRunID).Logger()
-		} else if pullRequestNumber != 0 {
-			logger = logger.With().Int("pull_request_number", pullRequestNumber).Logger()
+		if cfg.WorkflowRunID != 0 {
+			logger = logger.With().Int64("workflow_run_id", cfg.WorkflowRunID).Logger()
+		} else if cfg.PullRequestNumber != 0 {
+			logger = logger.With().Int("pull_request_number", cfg.PullRequestNumber).Logger()
 		}
 
 		logger.Info().Msg("Gathering data")
+		fmt.Println("Gathering data...")
 
 		opts := []gather.Option{}
 
@@ -71,40 +58,50 @@ var gatherCmd = &cobra.Command{
 		}
 
 		var err error
-		if workflowRunID != 0 {
-			_, _, err = gather.WorkflowRun(logger, githubClient, owner, repo, workflowRunID, opts...)
-		} else if pullRequestNumber != 0 {
-			_, err = gather.PullRequest(logger, githubClient, owner, repo, pullRequestNumber, opts...)
-		} else if commitSHA != "" {
-			_, err = gather.Commit(logger, githubClient, owner, repo, commitSHA, opts...)
+		if cfg.WorkflowRunID != 0 {
+			_, _, err = gather.WorkflowRun(logger, githubClient, cfg.Owner, cfg.Repo, cfg.WorkflowRunID, opts...)
+		} else if cfg.PullRequestNumber != 0 {
+			_, err = gather.PullRequest(logger, githubClient, cfg.Owner, cfg.Repo, cfg.PullRequestNumber, opts...)
+		} else if cfg.CommitSHA != "" {
+			_, err = gather.Commit(logger, githubClient, cfg.Owner, cfg.Repo, cfg.CommitSHA, opts...)
 		}
 		if err != nil {
 			return err
 		}
 
 		logger.Info().Str("duration", time.Since(startTime).String()).Msg("Gathered data")
-		return nil
+		fmt.Println("Gathered data")
+
+		if noObserve {
+			return nil
+		}
+
+		var pagePath string
+		if cfg.WorkflowRunID != 0 {
+			pagePath = fmt.Sprintf("/%s/%s/workflow_runs/%d.html", cfg.Owner, cfg.Repo, cfg.WorkflowRunID)
+		} else if cfg.PullRequestNumber != 0 {
+			pagePath = fmt.Sprintf("/%s/%s/pull_requests/%d.html", cfg.Owner, cfg.Repo, cfg.PullRequestNumber)
+		} else if cfg.CommitSHA != "" {
+			pagePath = fmt.Sprintf("/%s/%s/commits/%s.html", cfg.Owner, cfg.Repo, cfg.CommitSHA)
+		}
+
+		if err := os.RemoveAll(observe.OutputDir); err != nil {
+			return fmt.Errorf("failed to clean observe output: %w", err)
+		}
+		return observe.Interactive(logger, githubClient, pagePath)
 	},
 }
 
 func init() {
-	gatherCmd.Flags().BoolVarP(&forceUpdate, "force-update", "u", false, "Force update of existing data")
-	gatherCmd.Flags().StringVarP(&owner, "owner", "o", "", "Repository owner")
-	gatherCmd.Flags().StringVarP(&repo, "repo", "r", "", "Repository name")
-	gatherCmd.Flags().StringVarP(&commitSHA, "commit-sha", "c", "", "Commit SHA")
-	gatherCmd.Flags().Int64VarP(&workflowRunID, "workflow-run-id", "w", 0, "Workflow run ID")
-	gatherCmd.Flags().IntVarP(&pullRequestNumber, "pull-request-number", "p", 0, "Pull request number")
 	gatherCmd.Flags().
-		StringVarP(&githubToken, "github-token", "t", "", fmt.Sprintf("GitHub API token (can also be set via %s)", gather.GitHubTokenEnvVar))
-
-	if err := gatherCmd.MarkFlagRequired("owner"); err != nil {
-		fmt.Printf("ERROR: Failed to mark owner flag as required: %s\n", err.Error())
-		os.Exit(1)
-	}
-	if err := gatherCmd.MarkFlagRequired("repo"); err != nil {
-		fmt.Printf("ERROR: Failed to mark repo flag as required: %s\n", err.Error())
-		os.Exit(1)
-	}
+		BoolVar(&noObserve, "no-observe", false, "Skip launching the interactive observer after gathering")
+	gatherCmd.Flags().BoolVarP(&forceUpdate, "force-update", "u", false, "Force update of existing data")
+	gatherCmd.Flags().StringP("owner", "o", "", "Repository owner")
+	gatherCmd.Flags().StringP("repo", "r", "", "Repository name")
+	gatherCmd.Flags().StringP("commit-sha", "c", "", "Commit SHA")
+	gatherCmd.Flags().Int64P("workflow_run_id", "w", 0, "Workflow run ID")
+	gatherCmd.Flags().IntP("pull_request_number", "p", 0, "Pull request number")
+	gatherCmd.Flags().StringP("github_token", "t", "", "GitHub API token (env: GITHUB_TOKEN)")
 
 	rootCmd.AddCommand(gatherCmd)
 }

cmd/observe.go

@@ -1,28 +1,27 @@
 package cmd
 
 import (
+	"fmt"
 	"os"
 
 	"github.com/spf13/cobra"
 
+	"github.com/kalverra/octometrics/gather"
 	"github.com/kalverra/octometrics/observe"
 )
 
-var (
-	outputTypes []string
-)
-
 var observeCmd = &cobra.Command{
 	Use:   "observe",
 	Short: "Observe metrics from GitHub",
 	PreRunE: func(_ *cobra.Command, _ []string) error {
+		var err error
+		githubClient, err = gather.NewGitHubClient(logger, githubToken, nil)
+		if err != nil {
+			return fmt.Errorf("failed to create GitHub client: %w", err)
+		}
 		return os.RemoveAll(observe.OutputDir)
 	},
 	RunE: func(_ *cobra.Command, _ []string) error {
-		logger.Debug().
-			Strs("output-types", outputTypes).
-			Msg("observe flags")
-
 		// if workflowRunID != 0 {
 		// 	err := observe.WorkflowRun(githubClient, owner, repo, workflowRunID, outputTypes)
 		// 	if err != nil {
@@ -37,12 +36,10 @@ var observeCmd = &cobra.Command{
 		// 	}
 		// }
 
-		return observe.Interactive(logger, githubClient)
+		return observe.Interactive(logger, githubClient, "")
 	},
 }
 
 func init() {
 	rootCmd.AddCommand(observeCmd)
-
-	observeCmd.Flags().StringArrayVar(&outputTypes, "output-types", []string{"html", "md"}, "Output types to generate")
 }

cmd/octometrics.go

@@ -11,7 +11,6 @@ import (
 	"github.com/rs/zerolog"
 	"github.com/spf13/cobra"
 
-	"github.com/kalverra/octometrics/gather"
 	"github.com/kalverra/octometrics/internal/config"
 	"github.com/kalverra/octometrics/logging"
 )
@@ -20,10 +19,9 @@ const (
 	logFileName = "octometrics.log.json"
 )
 
-// Persistent base command flags
 var (
-	githubClient *gather.GitHubClient
-	logger       zerolog.Logger
+	cfg    *config.Config
+	logger zerolog.Logger
 )
 
 // These variables are set at build time and describe the version and build of the application
@@ -46,15 +44,6 @@ func versionInfo() string {
 	)
 }
 
-// Flag values shared between other commands
-var (
-	owner             string
-	repo              string
-	commitSHA         string
-	workflowRunID     int64
-	pullRequestNumber int
-)
-
 var rootCmd = &cobra.Command{
 	Use:   "octometrics",
 	Short: "See metrics and profiling of your GitHub Actions",
@@ -65,31 +54,20 @@ Octometrics aims to help you easily visualize what your workflows look like, hel
 	PersistentPreRunE: func(cmd *cobra.Command, _ []string) error {
 		var err error
 
-		cfg, err := config.Load(config.WithFlags(cmd.Flags()))
+		cfg, err = config.Load(config.WithFlags(cmd.Flags()))
 		if err != nil {
 			return fmt.Errorf("failed to load config: %w", err)
 		}
 		logger, err = logging.New(logging.WithFileName(logFileName), logging.WithLevel(cfg.LogLevel))
 		if err != nil {
 			return fmt.Errorf("failed to setup logging: %w", err)
 		}
-
-		githubClient, err = gather.NewGitHubClient(logger, githubToken, nil)
-		if err != nil {
-			return fmt.Errorf("failed to create GitHub client: %w", err)
-		}
 		return nil
 	},
-	Run: func(cmd *cobra.Command, _ []string) {
-		err := cmd.Help()
-		if err != nil {
-			logger.Fatal().Err(err).Msg("Failed to print help message")
-		}
-	},
 }
 
 func init() {
-	rootCmd.PersistentFlags().String("log-level", config.DefaultLogLevel, "Log level")
+	rootCmd.PersistentFlags().String("log-level", config.DefaultLogLevel, "Level for detailed logging")
 }
 
 // Execute runs the root command for octometrics.

gather/gather.go

@@ -5,7 +5,6 @@ import (
 	"errors"
 	"fmt"
 	"net/http"
-	"os"
 	"strconv"
 	"strings"
 	"time"
@@ -19,8 +18,6 @@ import (
 
 // GitHub API constants for authentication, timeouts, and data storage.
 const (
-	//nolint:gosec // Env var for getting token
-	GitHubTokenEnvVar = "GITHUB_TOKEN"
 	//nolint:gosec // This is a mock token for testing purposes
 	MockGitHubToken = "mock_github_token"
 	timeoutDur      = 10 * time.Second
@@ -100,16 +97,6 @@ func NewGitHubClient(
 	githubToken string,
 	optionalNext http.RoundTripper,
 ) (*GitHubClient, error) {
-	switch {
-	case githubToken != "":
-		logger.Debug().Msg("Using GitHub token from flag")
-	case os.Getenv(GitHubTokenEnvVar) != "":
-		githubToken = os.Getenv(GitHubTokenEnvVar)
-		logger.Debug().Msg("Using GitHub token from environment variable")
-	default:
-		logger.Warn().Msg("GitHub token not provided, will likely hit rate limits quickly")
-	}
-
 	var (
 		err    error
 		next   http.RoundTripper

internal/config/config.go

@@ -2,13 +2,22 @@
 package config
 
 import (
+	"errors"
+	"fmt"
+
 	"github.com/spf13/pflag"
 	"github.com/spf13/viper"
 )
 
 // Config is the configuration for the application.
 type Config struct {
-	LogLevel string `mapstructure:"log_level"`
+	LogLevel          string `mapstructure:"log_level"`
+	GitHubToken       string `mapstructure:"github_token"`
+	Owner             string `mapstructure:"owner"`
+	Repo              string `mapstructure:"repo"`
+	CommitSHA         string `mapstructure:"commit_sha"`
+	WorkflowRunID     int64  `mapstructure:"workflow_run_id"`
+	PullRequestNumber int    `mapstructure:"pull_request_number"`
 }
 
 const (
@@ -43,6 +52,7 @@ func Load(opts ...LoadOption) (*Config, error) {
 	v.AddConfigPath(".")
 
 	v.SetDefault("log_level", DefaultLogLevel)
+	v.AutomaticEnv()
 
 	for _, opt := range opts {
 		if err := opt(v); err != nil {
@@ -51,7 +61,9 @@ func Load(opts ...LoadOption) (*Config, error) {
 	}
 
 	if err := v.ReadInConfig(); err != nil {
-		return nil, err
+		if _, ok := err.(viper.ConfigFileNotFoundError); !ok { // If the config file is not found, we don't need to return an error
+			return nil, fmt.Errorf("failed to read config file: %w", err)
+		}
 	}
 
 	cfg := &Config{}
@@ -61,3 +73,36 @@ func Load(opts ...LoadOption) (*Config, error) {
 
 	return cfg, nil
 }
+
+// ValidateGather validates the configuration for the gather command.
+func (c *Config) ValidateGather() error {
+	if c.Owner == "" {
+		return errors.New("owner is required")
+	}
+	if c.Repo == "" {
+		return errors.New("repo is required")
+	}
+
+	setCount := 0
+	if c.CommitSHA != "" {
+		setCount++
+	}
+	if c.WorkflowRunID != 0 {
+		setCount++
+	}
+	if c.PullRequestNumber != 0 {
+		setCount++
+	}
+	if setCount > 1 {
+		return errors.New("only one of commit SHA, workflow run ID or pull request number can be provided")
+	}
+	if setCount == 0 {
+		return errors.New("one of commit SHA, workflow run ID or pull request number must be provided")
+	}
+
+	if c.GitHubToken == "" {
+		fmt.Println("WARNING:GitHub token not provided, will likely hit rate limits quickly")
+	}
+
+	return nil
+}