Add dmsghttp logserver route

pkg/visor/cmd.go

@@ -54,7 +54,6 @@ var (
 	// visorBuildInfo holds information about the build
 	visorBuildInfo *buildinfo.Info
 	dmsgServer     string
-	rawSurvey      bool
 	isStoreLog     bool
 	isForceColor   bool
 )
@@ -117,7 +116,6 @@ func init() {
 	hiddenflags = append(hiddenflags, "hv")
 	RootCmd.Flags().BoolVarP(&disableHypervisorPKs, "xhv", "k", false, "disable remote hypervisors \u001b[0m*")
 	hiddenflags = append(hiddenflags, "xhv")
-	//	initAutoPeerFlags()
 	RootCmd.Flags().StringVarP(&logLvl, "loglvl", "s", "", "[ debug | warn | error | fatal | panic | trace ] \u001b[0m*")
 	hiddenflags = append(hiddenflags, "loglvl")
 	RootCmd.Flags().StringVarP(&pprofMode, "pprofmode", "q", "", "[ cpu | mem | mutex | block | trace | http ]")
@@ -130,12 +128,10 @@ func init() {
 	hiddenflags = append(hiddenflags, "syslog")
 	RootCmd.Flags().StringVarP(&completion, "completion", "z", "", "[ bash | zsh | fish | powershell ]")
 	hiddenflags = append(hiddenflags, "completion")
-	RootCmd.Flags().BoolVar(&rawSurvey, "raw-survey", false, "survey will generate and store decrypted if pass this flag")
-	hiddenflags = append(hiddenflags, "raw-survey")
-	RootCmd.Flags().BoolVarP(&isStoreLog, "store-log", "l", false, "store all logs to file")
-	hiddenflags = append(hiddenflags, "store-log")
-	RootCmd.Flags().BoolVar(&isForceColor, "force-color", false, "set force coler true in loggers")
-	hiddenflags = append(hiddenflags, "force-color")
+	RootCmd.Flags().BoolVarP(&isStoreLog, "storelog", "l", false, "store all logs to file")
+	hiddenflags = append(hiddenflags, "storelog")
+	RootCmd.Flags().BoolVar(&isForceColor, "forcecolor", false, "force color logging when out is not STDOUT")
+	hiddenflags = append(hiddenflags, "forcecolor")
 	RootCmd.Flags().BoolVar(&all, "all", false, "show all flags")
 	for _, j := range hiddenflags {
 		RootCmd.Flags().MarkHidden(j) //nolint
@@ -144,33 +140,6 @@ func init() {
 
 }
 
-//omit due to possible panic
-/*
-func initAutoPeerFlags() {
-	localIPs, err := netutil.DefaultNetworkInterfaceIPs()
-	if err != nil {
-		logger.WithError(err).Warn("Could not determine network interface IP address")
-		if len(localIPs) == 0 {
-			localIPs = append(localIPs, net.ParseIP("192.168.0.1"))
-		}
-	}
-	RootCmd.Flags().StringVarP(&autoPeerIP, "hvip", "l", trimStringFromDot(localIPs[0].String())+".2:7998", "set hypervisor by ip")
-	hiddenflags = append(hiddenflags, "hvip")
-	isDefaultAutopeer := false
-	if os.Getenv("AUTOPEER") == "1" {
-		isDefaultAutopeer = true
-	}
-	RootCmd.Flags().BoolVarP(&isAutoPeer, "autopeer", "m", isDefaultAutopeer, "enable autopeering to remote hypervisor")
-	hiddenflags = append(hiddenflags, "autopeer")
-}
-func trimStringFromDot(s string) string {
-	if idx := strings.LastIndex(s, "."); idx != -1 {
-		return s[:idx]
-	}
-	return s
-}
-*/
-
 // RootCmd contains the help command & invocation flags
 var RootCmd = &cobra.Command{
 	Use:   "visor",

pkg/visor/init.go

@@ -403,7 +403,7 @@ func initDmsgHTTPLogServer(ctx context.Context, v *Visor, log *logging.Logger) e
 		}
 	}
 
-	lsAPI := logserver.New(logger, v.conf.Transport.LogStore.Location, v.conf.LocalPath, v.conf.DmsgHTTPServerPath, whitelistedPKs, printLog)
+	lsAPI := logserver.New(logger, v.conf.Transport.LogStore.Location, v.conf.LocalPath, v.conf.DmsgHTTPServerPath, whitelistedPKs, v.conf.PK, printLog)
 
 	lis, err := dmsgC.Listen(visorconfig.DmsgHTTPPort)
 	if err != nil {

pkg/visor/logserver/api.go

@@ -8,14 +8,17 @@ import (
 	"net/http"
 	"os"
 	"path/filepath"
+	"strings"
 	"time"
 
 	"github.com/gin-gonic/gin"
+	coincipher "github.com/skycoin/skycoin/src/cipher"
 
 	"github.com/skycoin/skywire-utilities/pkg/buildinfo"
 	"github.com/skycoin/skywire-utilities/pkg/cipher"
 	"github.com/skycoin/skywire-utilities/pkg/httputil"
 	"github.com/skycoin/skywire-utilities/pkg/logging"
+	"github.com/skycoin/skywire/pkg/visor/visorconfig"
 )
 
 // API register all the API endpoints.
@@ -28,7 +31,7 @@ type API struct {
 }
 
 // New creates a new API.
-func New(log *logging.Logger, tpLogPath, localPath, customPath string, whitelistedPKs []cipher.PubKey, printLog bool) *API {
+func New(log *logging.Logger, tpLogPath, localPath, customPath string, whitelistedPKs []cipher.PubKey, visorPK cipher.PubKey, printLog bool) *API {
 	api := &API{
 		logger:    log,
 		startedAt: time.Now(),
@@ -50,16 +53,57 @@ func New(log *logging.Logger, tpLogPath, localPath, customPath string, whitelist
 	if len(whitelistedPKs) > 0 {
 		authRoute.Use(whitelistAuth(whitelistedPKs))
 	}
-	// note that the survey only exists / is generated if the reward address is set
-	authRoute.StaticFile("/node-info.json", filepath.Join(localPath, "node-info.json"))
+	// note that the survey FILE only exists / is generated if the reward address is set
+	authRoute.StaticFile("/"+visorconfig.NodeInfo, filepath.Join(localPath, visorconfig.NodeInfo))
+	// serve the file with the reward address - only exists if the reward address is set
+	authRoute.StaticFile("/"+visorconfig.RewardFile, filepath.Join(localPath, visorconfig.RewardFile))
+
+	//Derive the surveyName from visorconfig.NodeInfo by dropping the ".json" suffix
+	surveyName := strings.TrimSuffix(string(visorconfig.NodeInfo), ".json")
+	// This survey endpoint generates the survey as a response
+	authRoute.GET("/"+surveyName, func(c *gin.Context) {
+		var rewardAddress string
+		var cAddr coincipher.Address
+		//check for reward address
+		rewardAddressBytes, err := os.ReadFile(localPath + "/" + visorconfig.RewardFile) //nolint
+		if err == nil {
+			//remove any newlines & whitespace from rewardAddress string
+			rewardAddress = strings.TrimSpace(string(rewardAddressBytes))
+			//validate the skycoin address
+			cAddr, err = coincipher.DecodeBase58Address(rewardAddress)
+			if err != nil {
+				log.WithError(err).Error("Invalid skycoin reward address " + rewardAddress)
+			}
+			log.Debug("Skycoin reward address: ", cAddr.String())
+		}
+		survey, err := visorconfig.SystemSurvey()
+		if err != nil {
+			log.WithError(err).Error("Could not read system info.")
+		}
+		survey.PubKey = visorPK
+		survey.SkycoinAddress = cAddr.String()
+		// Print results.
+		s, err := json.MarshalIndent(survey, "", "\t")
+		if err != nil {
+			log.WithError(err).Error("Could not marshal system survey to json.")
+		}
+
+		c.Header("Content-Type", "application/json")
+		c.Writer.WriteHeader(http.StatusOK)
+
+		_, err = c.Writer.Write([]byte(s))
+		if err != nil {
+			httputil.GetLogger(c.Request).WithError(err).Errorf("failed to write json response")
+		}
+	})
 
 	r.GET("/health", func(c *gin.Context) {
 		api.health(c)
 	})
 
 	// serve transport log files ; then any files in the custom path
 	r.GET("/:file", func(c *gin.Context) {
-		// files with .csv extension are likely transport log files
+		// files with .csv extension are **likely** transport log files
 		if filepath.Ext(c.Param("file")) == ".csv" {
 			// check transport logs dir for the file, and serve it if it exists
 			_, err := os.Stat(filepath.Join(tpLogPath, c.Param("file")))

pkg/visor/visorconfig/types.go

@@ -54,84 +54,3 @@ func (d *Duration) UnmarshalJSON(b []byte) error {
 		return errors.New("invalid duration")
 	}
 }
-
-// VisorConfig is every field of the config
-type VisorConfig struct {
-	Version string `json:"version"`
-	Sk      string `json:"sk"`
-	Pk      string `json:"pk"`
-	Dmsg    struct {
-		Discovery     string `json:"discovery"`
-		SessionsCount int    `json:"sessions_count"`
-		Servers       []struct {
-			Version   string `json:"version"`
-			Sequence  int    `json:"sequence"`
-			Timestamp int    `json:"timestamp"`
-			Static    string `json:"static"`
-			Server    struct {
-				Address           string `json:"address"`
-				AvailableSessions int    `json:"availableSessions"`
-			} `json:"server"`
-		} `json:"servers"`
-	} `json:"dmsg"`
-	Dmsgpty struct {
-		DmsgPort   int    `json:"dmsg_port"`
-		CliNetwork string `json:"cli_network"`
-		CliAddress string `json:"cli_address"`
-	} `json:"dmsgpty"`
-	SkywireTCP struct {
-		PkTable          interface{} `json:"pk_table"`
-		ListeningAddress string      `json:"listening_address"`
-	} `json:"skywire-tcp"`
-	Transport struct {
-		Discovery           string      `json:"discovery"`
-		AddressResolver     string      `json:"address_resolver"`
-		PublicAutoconnect   bool        `json:"public_autoconnect"`
-		TransportSetupNodes interface{} `json:"transport_setup_nodes"`
-	} `json:"transport"`
-	Routing struct {
-		SetupNodes         []string `json:"setup_nodes"`
-		RouteFinder        string   `json:"route_finder"`
-		RouteFinderTimeout string   `json:"route_finder_timeout"`
-		MinHops            int      `json:"min_hops"`
-	} `json:"routing"`
-	UptimeTracker struct {
-		Addr string `json:"addr"`
-	} `json:"uptime_tracker"`
-	Launcher struct {
-		ServiceDiscovery string `json:"service_discovery"`
-		Apps             []struct {
-			Name      string   `json:"name"`
-			AutoStart bool     `json:"auto_start"`
-			Port      int      `json:"port"`
-			Args      []string `json:"args,omitempty"`
-		} `json:"apps"`
-		ServerAddr string `json:"server_addr"`
-		BinPath    string `json:"bin_path"`
-	} `json:"launcher"`
-	Hypervisors          []interface{} `json:"hypervisors"`
-	CliAddr              string        `json:"cli_addr"`
-	LogLevel             string        `json:"log_level"`
-	LocalPath            string        `json:"local_path"`
-	StunServers          []string      `json:"stun_servers"`
-	ShutdownTimeout      string        `json:"shutdown_timeout"`
-	RestartCheckDelay    string        `json:"restart_check_delay"`
-	IsPublic             bool          `json:"is_public"`
-	PersistentTransports interface{}   `json:"persistent_transports"`
-	Hypervisor           struct {
-		DbPath     string `json:"db_path"`
-		EnableAuth bool   `json:"enable_auth"`
-		Cookies    struct {
-			HashKey         string `json:"hash_key"`
-			BlockKey        string `json:"block_key"`
-			ExpiresDuration int64  `json:"expires_duration"`
-			Path            string `json:"path"`
-			Domain          string `json:"domain"`
-		} `json:"cookies"`
-		DmsgPort    int    `json:"dmsg_port"`
-		HTTPAddr    string `json:"http_addr"`
-		EnableTLS   bool   `json:"enable_tls"`
-		TLSCertFile string `json:"tls_cert_file"`
-		TLSKeyFile  string `json:"tls_key_file"`
-	} `json:"hypervisor"`
-}

pkg/visor/visorconfig/v1.go

@@ -56,7 +56,7 @@ type Transport struct {
 	Discovery         string          `json:"discovery"`
 	AddressResolver   string          `json:"address_resolver"`
 	PublicAutoconnect bool            `json:"public_autoconnect"`
-	TransportSetupPKs []cipher.PubKey `json:"transport_setup_nodes"`
+	TransportSetupPKs []cipher.PubKey `json:"transport_setup"`
 	LogStore          *LogStore       `json:"log_store"`
 	StcprPort         int             `json:"stcpr_port"`
 	SudphPort         int             `json:"sudph_port"`