feat: view query plan as a json

router/cmd/plan_generator.go

@@ -7,6 +7,7 @@ import (
 	"log"
 	"os"
 	"os/signal"
+	"strings"
 	"syscall"
 
 	"github.com/KimMachineGun/automemlimit/memlimit"
@@ -22,7 +23,9 @@ import (
 func PlanGenerator(args []string) {
 	var planHelp bool
 
-	cfg := plan_generator.QueryPlanConfig{}
+	cfg := plan_generator.QueryPlanConfig{
+		OutputFormat: core.PlanOutputFormatText,
+	}
 	f := flag.NewFlagSet("router "+args[0], flag.ExitOnError)
 	f.BoolVar(&planHelp, "help", false, "Prints the help message")
 	f.StringVar(&cfg.ExecutionConfig, "execution-config", "", "required, execution config file location")
@@ -36,6 +39,17 @@ func PlanGenerator(args []string) {
 	f.BoolVar(&cfg.FailOnPlanError, "fail-on-error", false, "if at least one plan fails, the command exit code will be 1")
 	f.BoolVar(&cfg.FailFast, "fail-fast", false, "stop as soon as possible if a plan fails")
 	f.StringVar(&cfg.LogLevel, "log-level", "warn", "log level to use (debug, info, warn, error, panic, fatal)")
+	f.Func("print-format", "output format (text|json)", func(s string) error {
+		switch value := core.PlanOutputFormat(strings.ToLower(s)); value {
+		case core.PlanOutputFormatInvalid:
+			cfg.OutputFormat = core.PlanOutputFormatText
+			return nil
+		case core.PlanOutputFormatText, core.PlanOutputFormatJSON:
+			cfg.OutputFormat = value
+			return nil
+		}
+		return fmt.Errorf("must be one of: text, json (got %q)", s)
+	})
 	f.UintVar(&cfg.MaxDataSourceCollectorsConcurrency, "max-collectors", 0, "max number of concurrent data source collectors, if unset or 0, no limit will be enforced")
 
 	if err := f.Parse(args[1:]); err != nil {

router/core/plan_generator.go

@@ -2,6 +2,7 @@ package core
 
 import (
 	"context"
+	"encoding/json"
 	"errors"
 	"fmt"
 	"net/http"
@@ -52,6 +53,14 @@ type Planner struct {
 	operationValidator *astvalidation.OperationValidator
 }
 
+type PlanOutputFormat string
+
+const (
+	PlanOutputFormatInvalid PlanOutputFormat = ""
+	PlanOutputFormatText    PlanOutputFormat = "text"
+	PlanOutputFormatJSON    PlanOutputFormat = "json"
+)
+
 func NewPlanner(planConfiguration *plan.Configuration, definition *ast.Document, clientDefinition *ast.Document) (*Planner, error) {
 	planner, err := plan.NewPlanner(*planConfiguration)
 	if err != nil {
@@ -65,7 +74,7 @@ func NewPlanner(planConfiguration *plan.Configuration, definition *ast.Document,
 	}, nil
 }
 
-func (pl *Planner) PlanOperation(operationFilePath string) (string, error) {
+func (pl *Planner) PlanOperation(operationFilePath string, outputFormat PlanOutputFormat) (string, error) {
 	operation, err := pl.parseOperation(operationFilePath)
 	if err != nil {
 		return "", &PlannerOperationValidationError{err: err}
@@ -91,7 +100,18 @@ func (pl *Planner) PlanOperation(operationFilePath string) (string, error) {
 		return "", fmt.Errorf("failed to plan operation: %w", err)
 	}
 
-	return rawPlan.PrettyPrint(), nil
+	switch outputFormat {
+	case PlanOutputFormatText:
+		return rawPlan.PrettyPrint(), nil
+	case PlanOutputFormatJSON:
+		marshal, err := json.Marshal(rawPlan)
+		if err != nil {
+			return "", fmt.Errorf("failed to marshal raw plan: %w", err)
+		}
+		return string(marshal), nil
+	}
+
+	return "", fmt.Errorf("invalid type specified: %q", outputFormat)
 }
 
 func (pl *Planner) PlanParsedOperation(operation *ast.Document) (*resolve.FetchTreeQueryPlanNode, error) {

router/pkg/plan_generator/plan_generator.go

@@ -30,6 +30,7 @@ type QueryPlanConfig struct {
 	OutputReport                       bool
 	FailOnPlanError                    bool
 	FailFast                           bool
+	OutputFormat                       core.PlanOutputFormat
 	LogLevel                           string
 	Logger                             *zap.Logger
 	MaxDataSourceCollectorsConcurrency uint
@@ -52,6 +53,10 @@ func PlanGenerator(ctx context.Context, cfg QueryPlanConfig) error {
 		cfg.Concurrency = runtime.GOMAXPROCS(0)
 	}
 
+	if cfg.OutputFormat == "" {
+		cfg.OutputFormat = core.PlanOutputFormatText
+	}
+
 	queriesPath, err := filepath.Abs(cfg.SourceDir)
 	if err != nil {
 		return fmt.Errorf("failed to get absolute path for queries: %v", err)
@@ -140,7 +145,7 @@ func PlanGenerator(ctx context.Context, cfg QueryPlanConfig) error {
 
 					queryFilePath := filepath.Join(queriesPath, queryFile.Name())
 
-					outContent, err := planner.PlanOperation(queryFilePath)
+					outContent, err := planner.PlanOperation(queryFilePath, cfg.OutputFormat)
 					res := QueryPlanResult{
 						FileName: queryFile.Name(),
 						Plan:     outContent,