Refactor Summaries

cmd/skywire-cli/commands/visor/pk.go

@@ -16,11 +16,11 @@ var pkCmd = &cobra.Command{
 	Run: func(_ *cobra.Command, _ []string) {
 
 		client := rpcClient()
-		summary, err := client.Summary()
+		overview, err := client.Overview()
 		if err != nil {
 			logger.Fatal("Failed to connect:", err)
 		}
 
-		fmt.Println(summary.PubKey)
+		fmt.Println(overview.PubKey)
 	},
 }

cmd/skywire-cli/commands/visor/version.go

@@ -16,12 +16,12 @@ var buildInfoCmd = &cobra.Command{
 	Short: "Obtains version and build info of the node",
 	Run: func(_ *cobra.Command, _ []string) {
 		client := rpcClient()
-		summary, err := client.Summary()
+		overview, err := client.Overview()
 		if err != nil {
 			log.Fatal("Failed to connect:", err)
 		}
 
-		if _, err := summary.BuildInfo.WriteTo(os.Stdout); err != nil {
+		if _, err := overview.BuildInfo.WriteTo(os.Stdout); err != nil {
 			log.Fatal("Failed to output build info:", err)
 		}
 	},

pkg/visor/api.go

@@ -27,8 +27,8 @@ import (
 
 // API represents visor API.
 type API interface {
+	Overview() (*Overview, error)
 	Summary() (*Summary, error)
-	ExtraSummary() (*ExtraSummary, error)
 
 	Health() (*HealthInfo, error)
 	Uptime() (float64, error)
@@ -78,8 +78,8 @@ type HealthCheckable interface {
 	Health(ctx context.Context) (int, error)
 }
 
-// Summary provides a summary of a Skywire Visor.
-type Summary struct {
+// Overview provides a overview of a Skywire Visor.
+type Overview struct {
 	PubKey          cipher.PubKey        `json:"local_pk"`
 	BuildInfo       *buildinfo.Info      `json:"build_info"`
 	AppProtoVersion string               `json:"app_protocol_version"`
@@ -89,17 +89,17 @@ type Summary struct {
 	LocalIP         string               `json:"local_ip"`
 }
 
-// Summary implements API.
-func (v *Visor) Summary() (*Summary, error) {
-	var summaries []*TransportSummary
+// Overview implements API.
+func (v *Visor) Overview() (*Overview, error) {
+	var tSummaries []*TransportSummary
 	if v == nil {
 		panic("v is nil")
 	}
 	if v.tpM == nil {
 		panic("tpM is nil")
 	}
 	v.tpM.WalkTransports(func(tp *transport.ManagedTransport) bool {
-		summaries = append(summaries,
+		tSummaries = append(tSummaries,
 			newTransportSummary(v.tpM, tp, true, v.router.SetupIsTrusted(tp.Remote())))
 		return true
 	})
@@ -114,38 +114,40 @@ func (v *Visor) Summary() (*Summary, error) {
 		return nil, fmt.Errorf("failed to get IPs of interface %s: %w", defaultNetworkIfc, err)
 	}
 
-	summary := &Summary{
+	overview := &Overview{
 		PubKey:          v.conf.PK,
 		BuildInfo:       buildinfo.Get(),
 		AppProtoVersion: supportedProtocolVersion,
 		Apps:            v.appL.AppStates(),
-		Transports:      summaries,
+		Transports:      tSummaries,
 		RoutesCount:     v.router.RoutesCount(),
 	}
 
 	if len(localIPs) > 0 {
 		// should be okay to have the first one, in the case of
 		// active network interface, there's usually just a single IP
-		summary.LocalIP = localIPs[0].String()
+		overview.LocalIP = localIPs[0].String()
 	}
 
-	return summary, nil
+	return overview, nil
 }
 
-// ExtraSummary provides an extra summary of a Skywire Visor.
-type ExtraSummary struct {
-	Summary *Summary                        `json:"summary"`
-	Dmsg    []dmsgtracker.DmsgClientSummary `json:"dmsg"`
-	Health  *HealthInfo                     `json:"health"`
-	Uptime  float64                         `json:"uptime"`
-	Routes  []routingRuleResp               `json:"routes"`
+// Summary provides an summary of a Skywire Visor.
+type Summary struct {
+	*NetworkStats
+	Overview     *Overview                      `json:"overview"`
+	Health       *HealthInfo                    `json:"health"`
+	Uptime       float64                        `json:"uptime"`
+	Routes       []routingRuleResp              `json:"routes"`
+	IsHypervisor bool                           `json:"is_hypervisor,omitempty"`
+	DmsgStats    *dmsgtracker.DmsgClientSummary `json:"dmsg_stats"`
 }
 
-// ExtraSummary implements API.
-func (v *Visor) ExtraSummary() (*ExtraSummary, error) {
-	summary, err := v.Summary()
+// Summary implements API.
+func (v *Visor) Summary() (*Summary, error) {
+	overview, err := v.Overview()
 	if err != nil {
-		return nil, fmt.Errorf("summary")
+		return nil, fmt.Errorf("overview")
 	}
 
 	health, err := v.Health()
@@ -172,14 +174,14 @@ func (v *Visor) ExtraSummary() (*ExtraSummary, error) {
 		})
 	}
 
-	extraSummary := &ExtraSummary{
-		Summary: summary,
-		Health:  health,
-		Uptime:  uptime,
-		Routes:  extraRoutes,
+	summary := &Summary{
+		Overview: overview,
+		Health:   health,
+		Uptime:   uptime,
+		Routes:   extraRoutes,
 	}
 
-	return extraSummary, nil
+	return summary, nil
 }
 
 // collectHealthStats for given services and return health statuses
@@ -456,12 +458,12 @@ func (v *Visor) GetAppStats(appName string) (appserver.AppStats, error) {
 
 // GetAppConnectionsSummary implements API.
 func (v *Visor) GetAppConnectionsSummary(appName string) ([]appserver.ConnectionSummary, error) {
-	summary, err := v.procM.ConnectionsSummary(appName)
+	cSummary, err := v.procM.ConnectionsSummary(appName)
 	if err != nil {
 		return nil, err
 	}
 
-	return summary, nil
+	return cSummary, nil
 }
 
 // TransportTypes implements API.