feat!: build: separate miner and node version strings

Ref: #12010

Author: rvagg

api/docgen-openrpc/openrpc.go

@@ -106,7 +106,7 @@ func NewLotusOpenRPCDocument(Comments, GroupDocs map[string]string) *go_openrpc_
 			title := "Lotus RPC API"
 			info.Title = (*meta_schema.InfoObjectProperties)(&title)
 
-			version := build.BuildVersion
+			version := build.NodeBuildVersion
 			info.Version = (*meta_schema.InfoObjectVersion)(&version)
 			return info
 		},

build/panic_reporter.go

@@ -28,13 +28,31 @@ var PanicReportingPath = "panic-reports"
 // the lotus journal to be included in the panic report.
 var PanicReportJournalTail = defaultJournalTail
 
-// GeneratePanicReport produces a timestamped dump of the application state
+// GenerateNodePanicReport produces a timestamped dump of the application state
 // for inspection and debugging purposes. Call this function from any place
 // where a panic or severe error needs to be examined. `persistPath` is the
 // path where the reports should be saved. `repoPath` is the path where the
 // journal should be read from. `label` is an optional string to include
 // next to the report timestamp.
-func GeneratePanicReport(persistPath, repoPath, label string) {
+//
+// This function should be called for panics originating from the Lotus daemon.
+func GenerateNodePanicReport(persistPath, repoPath, label string) {
+	generatePanicReport(NodeUserVersion(), persistPath, repoPath, label)
+}
+
+// GenerateMinerPanicReport produces a timestamped dump of the application state
+// for inspection and debugging purposes. Call this function from any place
+// where a panic or severe error needs to be examined. `persistPath` is the
+// path where the reports should be saved. `repoPath` is the path where the
+// journal should be read from. `label` is an optional string to include
+// next to the report timestamp.
+//
+// This function should be called for panics originating from the Lotus miner.
+func GenerateMinerPanicReport(persistPath, repoPath, label string) {
+	generatePanicReport(MinerUserVersion(), persistPath, repoPath, label)
+}
+
+func generatePanicReport(buildVersion BuildVersion, persistPath, repoPath, label string) {
 	// make sure we always dump the latest logs on the way out
 	// especially since we're probably panicking
 	defer panicLog.Sync() //nolint:errcheck
@@ -64,21 +82,21 @@ func GeneratePanicReport(persistPath, repoPath, label string) {
 		return
 	}
 
-	writeAppVersion(filepath.Join(reportPath, "version"))
+	writeAppVersion(buildVersion, filepath.Join(reportPath, "version"))
 	writeStackTrace(filepath.Join(reportPath, "stacktrace.dump"))
 	writeProfile("goroutines", filepath.Join(reportPath, "goroutines.pprof.gz"))
 	writeProfile("heap", filepath.Join(reportPath, "heap.pprof.gz"))
 	writeJournalTail(PanicReportJournalTail, repoPath, filepath.Join(reportPath, "journal.ndjson"))
 }
 
-func writeAppVersion(file string) {
+func writeAppVersion(buildVersion BuildVersion, file string) {
 	f, err := os.Create(file)
 	if err != nil {
 		panicLog.Error(err.Error())
 	}
 	defer f.Close() //nolint:errcheck
 
-	versionString := []byte(BuildVersion + BuildTypeString() + CurrentCommit + "\n")
+	versionString := []byte(string(buildVersion) + BuildTypeString() + CurrentCommit + "\n")
 	if _, err := f.Write(versionString); err != nil {
 		panicLog.Error(err.Error())
 	}

build/version.go

@@ -2,6 +2,8 @@ package build
 
 import "os"
 
+type BuildVersion string
+
 var CurrentCommit string
 var BuildType int
 
@@ -36,13 +38,24 @@ func BuildTypeString() string {
 	}
 }
 
-// BuildVersion is the local build version
-const BuildVersion = "1.27.1-dev"
+// NodeBuildVersion is the local build version of the Lotus daemon
+const NodeBuildVersion string = "1.27.1-dev"
+
+func NodeUserVersion() BuildVersion {
+	if os.Getenv("LOTUS_VERSION_IGNORE_COMMIT") == "1" {
+		return BuildVersion(NodeBuildVersion)
+	}
+
+	return BuildVersion(NodeBuildVersion + BuildTypeString() + CurrentCommit)
+}
+
+// MinerBuildVersion is the local build version of the Lotus miner
+const MinerBuildVersion = "1.27.1-dev"
 
-func UserVersion() string {
+func MinerUserVersion() BuildVersion {
 	if os.Getenv("LOTUS_VERSION_IGNORE_COMMIT") == "1" {
-		return BuildVersion
+		return BuildVersion(MinerBuildVersion)
 	}
 
-	return BuildVersion + BuildTypeString() + CurrentCommit
+	return BuildVersion(MinerBuildVersion + BuildTypeString() + CurrentCommit)
 }

chain/beacon/drand/drand.go

@@ -97,7 +97,7 @@ func NewDrandBeacon(genesisTs, interval uint64, ps *pubsub.PubSub, config dtypes
 		if err != nil {
 			return nil, xerrors.Errorf("could not create http drand client: %w", err)
 		}
-		hc.(DrandHTTPClient).SetUserAgent("drand-client-lotus/" + build.BuildVersion)
+		hc.(DrandHTTPClient).SetUserAgent("drand-client-lotus/" + build.NodeBuildVersion)
 		clients = append(clients, hc)
 
 	}

cmd/lotus-bench/main.go

@@ -100,7 +100,7 @@ func main() {
 	app := &cli.App{
 		Name:                      "lotus-bench",
 		Usage:                     "Benchmark performance of lotus on your hardware",
-		Version:                   build.UserVersion(),
+		Version:                   string(build.NodeUserVersion()),
 		DisableSliceFlagSeparator: true,
 		Commands: []*cli.Command{
 			proveCmd,

cmd/lotus-fountain/main.go

@@ -41,7 +41,7 @@ func main() {
 	app := &cli.App{
 		Name:    "lotus-fountain",
 		Usage:   "Devnet token distribution utility",
-		Version: build.UserVersion(),
+		Version: string(build.NodeUserVersion()),
 		Flags: []cli.Flag{
 			&cli.StringFlag{
 				Name:    "repo",

cmd/lotus-gateway/main.go

@@ -40,7 +40,7 @@ func main() {
 	app := &cli.App{
 		Name:    "lotus-gateway",
 		Usage:   "Public API server for lotus",
-		Version: build.UserVersion(),
+		Version: string(build.NodeUserVersion()),
 		Flags: []cli.Flag{
 			&cli.StringFlag{
 				Name:    "repo",

cmd/lotus-health/main.go

@@ -36,7 +36,7 @@ func main() {
 	app := &cli.App{
 		Name:     "lotus-health",
 		Usage:    "Tools for monitoring lotus daemon health",
-		Version:  build.UserVersion(),
+		Version:  string(build.NodeUserVersion()),
 		Commands: local,
 		Flags: []cli.Flag{
 			&cli.StringFlag{

cmd/lotus-miner/main.go

@@ -101,7 +101,7 @@ func main() {
 	app := &cli.App{
 		Name:                 "lotus-miner",
 		Usage:                "Filecoin decentralized storage network miner",
-		Version:              build.UserVersion(),
+		Version:              string(build.MinerUserVersion()),
 		EnableBashCompletion: true,
 		Flags: []cli.Flag{
 			&cli.StringFlag{
@@ -159,7 +159,7 @@ func main() {
 		After: func(c *cli.Context) error {
 			if r := recover(); r != nil {
 				// Generate report in LOTUS_PATH and re-raise panic
-				build.GeneratePanicReport(c.String("panic-reports"), c.String(FlagMinerRepo), c.App.Name)
+				build.GenerateMinerPanicReport(c.String("panic-reports"), c.String(FlagMinerRepo), c.App.Name)
 				panic(r)
 			}
 			return nil

cmd/lotus-miner/run.go

@@ -57,7 +57,7 @@ var runCmd = &cli.Command{
 		}
 
 		ctx, _ := tag.New(lcli.DaemonContext(cctx),
-			tag.Insert(metrics.Version, build.BuildVersion),
+			tag.Insert(metrics.Version, build.MinerBuildVersion),
 			tag.Insert(metrics.Commit, build.CurrentCommit),
 			tag.Insert(metrics.NodeType, "miner"),
 		)