package commands import ( "fmt" "net/url" "os" "github.com/hasura/graphql-engine/cli/v2/internal/errors" "github.com/hasura/graphql-engine/cli/v2/internal/scripts" "github.com/hasura/graphql-engine/cli/v2/util" "github.com/gin-gonic/gin" "github.com/hasura/graphql-engine/cli/v2" "github.com/hasura/graphql-engine/cli/v2/pkg/console" "github.com/spf13/cobra" "github.com/spf13/viper" ) // NewConsoleCmd returns the console command func NewConsoleCmd(ec *cli.ExecutionContext) *cobra.Command { var apiHost string v := viper.New() opts := &ConsoleOptions{ EC: ec, } consoleCmd := &cobra.Command{ Use: "console", Short: "Open the console to manage the database and try out APIs", Long: "Run a web server to serve the Hasura console for the GraphQL engine to manage the database and build queries", Example: ` # Start console: hasura console # Start console on a different address and ports: hasura console --address 0.0.0.0 --console-port 8080 --api-port 8081 # Start console without opening the browser automatically hasura console --no-browser # Use with admin secret: hasura console --admin-secret "" # Connect to an instance specified by the flag, overrides the one mentioned in config.yaml: hasura console --endpoint ""`, SilenceUsage: true, PreRunE: func(cmd *cobra.Command, args []string) error { op := genOpName(cmd, "PreRunE") ec.Viper = v err := ec.Prepare() if err != nil { return errors.E(op, err) } if err := ec.Validate(); err != nil { return errors.E(op, err) } if err := scripts.CheckIfUpdateToConfigV3IsRequired(ec); err != nil { return errors.E(op, err) } return nil }, RunE: func(cmd *cobra.Command, args []string) error { op := genOpName(cmd, "RunE") if cmd.Flags().Changed("api-host") { var err error opts.APIHost, err = url.ParseRequestURI(apiHost) if err != nil { return errors.E(op, fmt.Errorf("expected a valid url for --api-host, parsing error: %w", err)) } } else { opts.APIHost = &url.URL{ Scheme: "http", Host: opts.Address, } } if err := opts.Run(); err != nil { return errors.E(op, err) } return nil }, } f := consoleCmd.Flags() f.StringVar(&opts.APIPort, "api-port", "9693", "port for serving migrate api") f.StringVar(&apiHost, "api-host", "http://localhost", "(PREVIEW: usage may change in future) host serving migrate api") f.StringVar(&opts.ConsolePort, "console-port", "9695", "port for serving console") f.StringVar(&opts.Address, "address", "localhost", "address to serve console and migration API from") f.BoolVar(&opts.DontOpenBrowser, "no-browser", false, "do not automatically open console in browser") f.StringVar(&opts.StaticDir, "static-dir", "", "directory where static assets mentioned in the console html template can be served from") f.StringVar(&opts.Browser, "browser", "", "open console in a specific browser") f.BoolVar(&opts.UseServerAssets, "use-server-assets", false, "when rendering console, use assets provided by HGE server") f.String("endpoint", "", "http(s) endpoint for Hasura GraphQL engine") f.String("admin-secret", "", "admin secret for Hasura GraphQL engine") f.String("access-key", "", "access key for Hasura GraphQL engine") if err := f.MarkDeprecated("access-key", "use --admin-secret instead"); err != nil { ec.Logger.WithError(err).Errorf("error while using a dependency library") } f.Bool("insecure-skip-tls-verify", false, "skip TLS verification and disable cert checking (default: false)") f.String("certificate-authority", "", "path to a cert file for the certificate authority") // need to create a new viper because https://github.com/spf13/viper/issues/233 util.BindPFlag(v, "endpoint", f.Lookup("endpoint")) util.BindPFlag(v, "admin_secret", f.Lookup("admin-secret")) util.BindPFlag(v, "access_key", f.Lookup("access-key")) util.BindPFlag(v, "insecure_skip_tls_verify", f.Lookup("insecure-skip-tls-verify")) util.BindPFlag(v, "certificate_authority", f.Lookup("certificate-authority")) return consoleCmd } type ConsoleOptions struct { EC *cli.ExecutionContext APIPort string APIHost *url.URL ConsolePort string Address string DontOpenBrowser bool StaticDir string Browser string UseServerAssets bool APIServerInterruptSignal chan os.Signal ConsoleServerInterruptSignal chan os.Signal } func (o *ConsoleOptions) Run() error { var op errors.Op = "commands.ConsoleOptions.Run" if o.EC.Version == nil { return errors.E(op, "cannot validate version, object is nil") } apiServer, err := console.NewAPIServer(o.APIHost.Host, o.APIPort, o.EC) if err != nil { return errors.E(op, err) } // Setup console server const basePath = "templates/gohtml/" const templateFilename = "console.gohtml" templateProvider := console.NewDefaultTemplateProvider(basePath, templateFilename, console.ConsoleFS) consoleTemplateVersion := templateProvider.GetTemplateVersion(o.EC.Version) consoleAssetsVersion := templateProvider.GetAssetsVersion(o.EC.Version) o.EC.Logger.Debugf("rendering console template [%s] with assets [%s]", consoleTemplateVersion, consoleAssetsVersion) adminSecretHeader := cli.GetAdminSecretHeaderName(o.EC.Version) if o.EC.Config.ServerConfig.HasuraServerInternalConfig.ConsoleAssetsDir != "" { o.UseServerAssets = true } consoleRouter, err := console.BuildConsoleRouter(templateProvider, consoleTemplateVersion, o.StaticDir, gin.H{ "apiHost": o.APIHost.String(), "apiPort": o.APIPort, "cliVersion": o.EC.Version.GetCLIVersion(), "serverVersion": o.EC.Version.GetServerVersion(), "dataApiUrl": o.EC.Config.ServerConfig.ParsedEndpoint.String(), "dataApiVersion": "", "hasAccessKey": adminSecretHeader == cli.XHasuraAccessKey, "adminSecret": o.EC.Config.ServerConfig.AdminSecret, "assetsPath": templateProvider.GetAssetsCDN(), "assetsVersion": consoleAssetsVersion, "enableTelemetry": o.EC.GlobalConfig.EnableTelemetry, "cliUUID": o.EC.GlobalConfig.UUID, "migrateSkipExecution": true, "cdnAssets": !o.UseServerAssets, "consolePath": "/console", "urlPrefix": "/console", }) if err != nil { return errors.E(op, fmt.Errorf("error serving console: %w", err)) } consoleServer := console.NewConsoleServer(&console.NewConsoleServerOpts{ Logger: o.EC.Logger, APIPort: o.APIPort, Address: o.Address, Browser: o.Browser, DontOpenBrowser: o.DontOpenBrowser, EC: o.EC, Port: o.ConsolePort, Router: consoleRouter, StaticDir: o.StaticDir, TemplateProvider: templateProvider, }) // start console and API HTTP Servers serveOpts := &console.ServeOpts{ APIServer: apiServer, ConsoleServer: consoleServer, EC: o.EC, DontOpenBrowser: o.DontOpenBrowser, Browser: o.Browser, ConsolePort: o.ConsolePort, APIPort: o.APIPort, Address: o.Address, SignalChanConsoleServer: o.ConsoleServerInterruptSignal, SignalChanAPIServer: o.APIServerInterruptSignal, } if err := console.Serve(serveOpts); err != nil { return errors.E(op, err) } return nil }