lotus/provider/lpweb/api/debug/debug.go

// Package debug provides the API for various debug endpoints in lotus-provider.
package debug

import (
	"context"
	"encoding/json"
	"fmt"
	"net/http"
	"sort"
	"sync"
	"time"

	"github.com/BurntSushi/toml"
	"github.com/gorilla/mux"
	logging "github.com/ipfs/go-log/v2"
	"golang.org/x/xerrors"

	"github.com/filecoin-project/lotus/api/client"
	"github.com/filecoin-project/lotus/build"
	cliutil "github.com/filecoin-project/lotus/cli/util"
	"github.com/filecoin-project/lotus/cmd/lotus-provider/deps"
)

var log = logging.Logger("lp/web/debug")

type debug struct {
	*deps.Deps
}

func Routes(r *mux.Router, deps *deps.Deps) {
	d := debug{deps}
	r.HandleFunc("/chain-state-sse", d.chainStateSSE)
}

type rpcInfo struct {
	Address   string
	CLayers   []string
	Reachable bool
	SyncState string
	Version   string
}

func (d *debug) chainStateSSE(w http.ResponseWriter, r *http.Request) {
	w.Header().Set("Access-Control-Allow-Origin", "*")
	w.Header().Set("Access-Control-Allow-Headers", "Content-Type")
	w.Header().Set("Content-Type", "text/event-stream")
	w.Header().Set("Cache-Control", "no-cache")
	w.Header().Set("Connection", "keep-alive")

	ctx := r.Context()

	for {

		type minimalApiInfo struct {
			Apis struct {
				ChainApiInfo []string
			}
		}

		rpcInfos := map[string]minimalApiInfo{} // config name -> api info
		confNameToAddr := map[string]string{}   // config name -> api address

		err := forEachConfig[minimalApiInfo](d, func(name string, info minimalApiInfo) error {
			if len(info.Apis.ChainApiInfo) == 0 {
				return nil
			}

			rpcInfos[name] = info

			for _, addr := range info.Apis.ChainApiInfo {
				ai := cliutil.ParseApiInfo(addr)
				confNameToAddr[name] = ai.Addr
			}

			return nil
		})
		if err != nil {
			log.Errorw("getting api info", "error", err)
			return
		}

		dedup := map[string]bool{} // for dedup by address

		infos := map[string]rpcInfo{} // api address -> rpc info
		var infosLk sync.Mutex

		var wg sync.WaitGroup
		for _, info := range rpcInfos {
			ai := cliutil.ParseApiInfo(info.Apis.ChainApiInfo[0])
			if dedup[ai.Addr] {
				continue
			}
			dedup[ai.Addr] = true
			wg.Add(1)
			go func() {
				defer wg.Done()
				var clayers []string
				for layer, a := range confNameToAddr {
					if a == ai.Addr {
						clayers = append(clayers, layer)
					}
				}

				myinfo := rpcInfo{
					Address:   ai.Addr,
					Reachable: false,
					CLayers:   clayers,
				}
				defer func() {
					infosLk.Lock()
					defer infosLk.Unlock()
					infos[ai.Addr] = myinfo
				}()
				da, err := ai.DialArgs("v1")
				if err != nil {
					log.Warnw("DialArgs", "error", err)
					return
				}

				ah := ai.AuthHeader()

				v1api, closer, err := client.NewFullNodeRPCV1(ctx, da, ah)
				if err != nil {
					log.Warnf("Not able to establish connection to node with addr: %s", ai.Addr)
					return
				}
				defer closer()

				ver, err := v1api.Version(ctx)
				if err != nil {
					log.Warnw("Version", "error", err)
					return
				}

				head, err := v1api.ChainHead(ctx)
				if err != nil {
					log.Warnw("ChainHead", "error", err)
					return
				}

				var syncState string
				switch {
				case time.Now().Unix()-int64(head.MinTimestamp()) < int64(build.BlockDelaySecs*3/2): // within 1.5 epochs
					syncState = "ok"
				case time.Now().Unix()-int64(head.MinTimestamp()) < int64(build.BlockDelaySecs*5): // within 5 epochs
					syncState = fmt.Sprintf("slow (%s behind)", time.Since(time.Unix(int64(head.MinTimestamp()), 0)).Truncate(time.Second))
				default:
					syncState = fmt.Sprintf("behind (%s behind)", time.Since(time.Unix(int64(head.MinTimestamp()), 0)).Truncate(time.Second))
				}

				myinfo = rpcInfo{
					Address:   ai.Addr,
					CLayers:   clayers,
					Reachable: true,
					Version:   ver.Version,
					SyncState: syncState,
				}
			}()
		}
		wg.Wait()

		var infoList []rpcInfo
		for _, i := range infos {
			infoList = append(infoList, i)
		}
		sort.Slice(infoList, func(i, j int) bool {
			return infoList[i].Address < infoList[j].Address
		})

		fmt.Fprintf(w, "data: ")
		err = json.NewEncoder(w).Encode(&infoList)
		if err != nil {
			log.Warnw("json encode", "error", err)
			return
		}
		fmt.Fprintf(w, "\n\n")
		if f, ok := w.(http.Flusher); ok {
			f.Flush()
		}

		time.Sleep(time.Duration(build.BlockDelaySecs) * time.Second)

		select { // stop running if there is reader.
		case <-ctx.Done():
			return
		default:
		}
	}
}

func forEachConfig[T any](a *debug, cb func(name string, v T) error) error {
	confs, err := a.loadConfigs(context.Background())
	if err != nil {
		return err
	}

	for name, tomlStr := range confs { // todo for-each-config
		var info T
		if err := toml.Unmarshal([]byte(tomlStr), &info); err != nil {
			return xerrors.Errorf("unmarshaling %s config: %w", name, err)
		}

		if err := cb(name, info); err != nil {
			return xerrors.Errorf("cb: %w", err)
		}
	}

	return nil
}

func (d *debug) loadConfigs(ctx context.Context) (map[string]string, error) {
	//err := db.QueryRow(cctx.Context, `SELECT config FROM harmony_config WHERE title=$1`, layer).Scan(&text)

	rows, err := d.DB.Query(ctx, `SELECT title, config FROM harmony_config`)
	if err != nil {
		return nil, xerrors.Errorf("getting db configs: %w", err)
	}

	configs := make(map[string]string)
	for rows.Next() {
		var title, config string
		if err := rows.Scan(&title, &config); err != nil {
			return nil, xerrors.Errorf("scanning db configs: %w", err)
		}
		configs[title] = config
	}

	return configs, nil
}