summaryrefslogtreecommitdiff
path: root/doProto.go
blob: 5335ab9c64afcaac6e2d3d41334e1b50a7043505 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
// Copyright 2017-2025 WIT.COM Inc. All rights reserved.
// Use of this source code is governed by the GPL 3.0

// protobuf the way I am using them, require GO 1.20. I think. I could be wrong.
// The Go Protocol Buffers library embeds a sync.Mutex within the MessageState struct to prevent unintended shallow copies of message structs
// this optionally (but it is the default) inserts a mutex into the struct generated by protoc

// probably don't need these build lines anymore
//go:build go1.20
// +build go1.20

// go:generate autogenpb --proto file.proto

package main

import (
	"errors"
	"fmt"
	"os"
	"path/filepath"
	"strings"

	"github.com/go-cmd/cmd"
	"go.wit.com/lib/fhelp"
	"go.wit.com/lib/gui/shell"
	"go.wit.com/log"
)

func doProto(argvProto string) (string, error) {
	pf := new(File)
	me.pb.Files = append(me.pb.Files, pf)
	pf.Filename = argvProto
	pf.IterMap = make(map[string]string)

	pf.Filebase = strings.TrimSuffix(argvProto, ".proto")

	if argv.Clean {
		doClean(pf.Filebase)
		me.argv.GoodExit("doClean() ran")
	}

	if argv.Mtime {
		doMtime(pf.Filebase)
		me.argv.GoodExit("doClean() ran")
	}

	if argv.ReFormat {
		protoReformatComments(argvProto)
		// time.Sleep(5 * time.Second)
		protoReformat(argvProto)
		log.Info("format done")
		okExit("")
	}

	if argv.Comments {
		protoReformatComments(argvProto)
		okExit("")
	}

	if argv.Regret {
		// this will override the manditory Uuid checks
		os.Setenv("PROTOBUF_REGRET", "true")
	}

	if doMtime(pf.Filebase) {
		me.argv.GoodExit(pf.Filename + " did not change")
	} else {
		log.Info("ctime check: need to re-run autogenpb")
	}

	// parse sort & marshal options from the .proto file
	// this goes through the .proto files and looks
	// for `autogenpb: ` lines
	if err := pf.protoParse(); err != nil {
		log.Info("autogenpb parse error:", err)
		badExit(err)
	}

	if !argv.NoFormat {
		protoReformat(argvProto)
	}

	if pf.Bases == nil {
		badExit(fmt.Errorf("Base was nil. 'message %s {` did not exist", pf.Filebase))
	}
	if pf.Base == nil {
		badExit(fmt.Errorf("Base was nil. 'message %s {` did not exist", pf.Filebase))
	}

	// if you have gotten here, at least the .proto buf file is OK
	if argv.DryRun {
		// show the protobuf of the protobuf. It's like Inception
		pf.printMsgTable()
		okExit("")
	}

	// todo, look for go.work files
	if argv.GoSrc == "" {
		homeDir, _ := os.UserHomeDir()
		argv.GoSrc = filepath.Join(homeDir, "go/src")
	}

	var startpwd string
	startpwd, _ = os.Getwd()
	log.Info("start pwd = ", startpwd)
	if argv.GoPath == "" {
		argv.GoPath = strings.TrimPrefix(startpwd, argv.GoSrc)
		argv.GoPath = strings.Trim(argv.GoPath, "/")
	}
	log.Info(argv.GoSrc, argv.GoPath)

	if !shell.Exists("go.sum") {
		shell.RunQuiet([]string{"go-mod-clean"})
		if !shell.Exists("go.sum") {
			shell.RunQuiet([]string{"go", "mod", "init"})
			shell.RunQuiet([]string{"go", "mod", "tidy"})
			shell.RunQuiet([]string{"go", "mod", "edit", "-go=1.18"}) // TODO: pass this as ENV. verify protobuf version needed
		}
	}

	var packageName string
	var result cmd.Status
	var cmd []string
	if argv.Package == "" {
		// TODO: switch to using forgepb (expose the functions/logic from forgepb directly
		// it could be a bad idea to use forge.Init() here as forge needs this to build
		// switch to forgepb
		os.Setenv("GO111MODULE", "off") // keeps go list working if go version is back versioned for compatability
		cmd = []string{"go", "list", "-f", "'{{.Name}}'"}
		result = shell.RunQuiet(cmd)
		os.Unsetenv("GO111MODULE")

		packageName = strings.Join(result.Stdout, "\n")
		packageName = strings.TrimSpace(packageName)
		packageName = strings.Trim(packageName, "'")
		// log.Info("packageName == ", packageName)
	} else {
		packageName = argv.Package
	}
	pf.Package = packageName

	// try to make foo.pb.go with protoc if it's not here
	// this is helpful because the protoc-gen-go lines
	// are also annoying to code by hand
	// checkCmd("protoc")
	// checkCmd("protoc-gen-go")

	if !fhelp.CheckProtoc() {
		badExit(fmt.Errorf("you do not have 'protoc' installed"))
	}

	pf.Pbfilename = pf.Filebase + ".pb.go"
	// try to create the foo.pb.go file using protoc if it is not there
	if !shell.Exists(pf.Pbfilename) {
		if !fhelp.CheckProtoc() {
			badExit(fmt.Errorf("you do not have 'protoc' installed"))
		}

		// checkCmd("protoc")
		// checkCmd("protoc-gen-go")

		if err := me.pb.protocBuild(pf); err != nil {
			badExit(err)
		}

	}
	os.Chdir(startpwd)

	// try to add the Mutex to the pb.go file
	if err := me.pb.addMutex(pf); err != nil {
		badExit(err)
	}

	// if foo.pb.go still doesn't exist, protoc failed
	if !shell.Exists(pf.Pbfilename) {
		log.Info("protoc build error.", pf.Pbfilename)
		badExit(errors.New("failed to be created with protoc and proto-gen-go"))
	}

	// make the marshal.pb.go file
	me.pb.marshal(pf)

	// make the sort.pb.go file
	if err := me.pb.makeNewSortfile(pf); err != nil {
		badExit(err)
	}

	if pf.DoGui {
		if err := me.pb.makeGuiFile(pf); err != nil {
			badExit(err)
		}
	}

	if pf.DoHTTP {
		if err := me.pb.makeHTTPFile(pf); err != nil {
			badExit(err)
		}
	}
	var err error
	if err == nil {
		// run goimports to clean the autogenpb files up
		globPattern := pf.Filebase + "*.pb.go"
		var files []string
		files, err = filepath.Glob(globPattern)
		if err != nil {
			log.Info("glob error", err, files)
		}
		if len(files) == 0 {
			// something went wrong
			err = errors.New("autogenpb failed to create *.pb.go files")
		} else {
			cmd := []string{"goimports", "-w"}
			cmd = append(cmd, files...)
			log.Info("Running:", cmd)
			shell.RunVerbose(cmd)
		}
	}
	if err == nil {
		return "autogenpb worked", nil
	}
	return "autogenpb failed", err
}