generated from brevdev/seed
-
Notifications
You must be signed in to change notification settings - Fork 9
/
open.go
350 lines (314 loc) · 11 KB
/
open.go
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
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
package open
import (
"bufio"
"errors"
"fmt"
"os"
"os/exec"
"strings"
"time"
"github.com/alessio/shellescape"
"github.com/brevdev/brev-cli/pkg/cmd/cmderrors"
"github.com/brevdev/brev-cli/pkg/cmd/completions"
"github.com/brevdev/brev-cli/pkg/cmd/hello"
"github.com/brevdev/brev-cli/pkg/cmd/refresh"
"github.com/brevdev/brev-cli/pkg/cmd/util"
"github.com/brevdev/brev-cli/pkg/entity"
breverrors "github.com/brevdev/brev-cli/pkg/errors"
"github.com/brevdev/brev-cli/pkg/store"
"github.com/brevdev/brev-cli/pkg/terminal"
"github.com/briandowns/spinner"
"github.com/spf13/cobra"
)
var (
openLong = "[command in beta] This will open VS Code SSH-ed in to your workspace. You must have 'code' installed in your path."
openExample = "brev open workspace_id_or_name\nbrev open my-app\nbrev open h9fp5vxwe"
)
type OpenStore interface {
util.GetWorkspaceByNameOrIDErrStore
refresh.RefreshStore
UpdateUser(string, *entity.UpdateUser) (*entity.User, error)
GetOrganizations(options *store.GetOrganizationsOptions) ([]entity.Organization, error)
GetWorkspaces(organizationID string, options *store.GetWorkspacesOptions) ([]entity.Workspace, error)
StartWorkspace(workspaceID string) (*entity.Workspace, error)
GetActiveOrganizationOrDefault() (*entity.Organization, error)
GetWorkspace(workspaceID string) (*entity.Workspace, error)
}
func NewCmdOpen(t *terminal.Terminal, store OpenStore, noLoginStartStore OpenStore) *cobra.Command {
var runRemotCMD bool
var waitForSetupToFinish bool
cmd := &cobra.Command{
Annotations: map[string]string{"ssh": ""},
Use: "open",
DisableFlagsInUseLine: true,
Short: "[beta] open VSCode to ",
Long: openLong,
Example: openExample,
Args: cmderrors.TransformToValidationError(cobra.ExactArgs(1)),
ValidArgsFunction: completions.GetAllWorkspaceNameCompletionHandler(noLoginStartStore, t),
RunE: func(cmd *cobra.Command, args []string) error {
err := runOpenCommand(t, store, args[0], runRemotCMD, waitForSetupToFinish)
if err != nil {
return breverrors.WrapAndTrace(err)
}
return nil
},
}
cmd.Flags().BoolVarP(&runRemotCMD, "remote", "r", true, "run remote command")
cmd.Flags().BoolVarP(&waitForSetupToFinish, "wait", "w", false, "wait for setup to finish")
return cmd
}
// Fetch workspace info, then open code editor
func runOpenCommand(t *terminal.Terminal, tstore OpenStore, wsIDOrName string, runRemoteCMD bool, waitForSetupToFinish bool) error {
// todo check if workspace is stopped and start if it if it is stopped
fmt.Println("finding your dev environment...")
res := refresh.RunRefreshAsync(tstore, runRemoteCMD)
workspace, err := util.GetUserWorkspaceByNameOrIDErr(tstore, wsIDOrName)
if err != nil {
return breverrors.WrapAndTrace(err)
}
if workspace.Status == "STOPPED" { // we start the env for the user
err = startWorkspaceIfStopped(t, tstore, wsIDOrName, workspace)
if err != nil {
return breverrors.WrapAndTrace(err)
}
}
workspace, err = util.GetUserWorkspaceByNameOrIDErr(tstore, wsIDOrName)
if err != nil {
return breverrors.WrapAndTrace(err)
}
if workspace.Status != "RUNNING" {
return breverrors.WorkspaceNotRunning{Status: workspace.Status}
}
projPath := workspace.GetProjectFolderPath()
localIdentifier := workspace.GetLocalIdentifier()
err = res.Await()
if err != nil {
return breverrors.WrapAndTrace(err)
}
err = hello.SetHasRunOpen(true)
if err != nil {
return breverrors.WrapAndTrace(err)
}
err = openVsCodeWithSSH(t, string(localIdentifier), projPath, tstore, runRemoteCMD, waitForSetupToFinish)
if err != nil {
if strings.Contains(err.Error(), `"code": executable file not found in $PATH`) {
errMsg := "code\": executable file not found in $PATH\n\nadd 'code' to your $PATH to open VS Code from the terminal\n\texport PATH=\"/Applications/Visual Studio Code.app/Contents/Resources/app/bin:$PATH\""
_, errStore := tstore.UpdateUser(
workspace.CreatedByUserID,
&entity.UpdateUser{
OnboardingData: map[string]interface{}{
"pathErrorTS": time.Now().UTC().Unix(),
},
})
if errStore != nil {
return errors.New(errMsg + "\n" + errStore.Error())
}
return errors.New(errMsg)
}
return breverrors.WrapAndTrace(err)
}
return nil
}
func pollUntil(t *terminal.Terminal, wsid string, state string, openStore OpenStore) error {
s := t.NewSpinner()
isReady := false
s.Suffix = " hang tight 🤙"
s.Start()
for !isReady {
time.Sleep(5 * time.Second)
ws, err := openStore.GetWorkspace(wsid)
if err != nil {
return breverrors.WrapAndTrace(err)
}
s.Suffix = " workspace is currently " + strings.ToLower(ws.Status)
if ws.Status == state {
s.Suffix = "Workspace is ready!"
s.Stop()
isReady = true
}
}
return nil
}
func startWorkspaceIfStopped(t *terminal.Terminal, tstore OpenStore, wsIDOrName string, workspace *entity.Workspace) error {
activeOrg, err := tstore.GetActiveOrganizationOrDefault()
if err != nil {
return breverrors.WrapAndTrace(err)
}
workspaces, err := tstore.GetWorkspaceByNameOrID(activeOrg.ID, wsIDOrName)
if err != nil {
return breverrors.WrapAndTrace(err)
}
startedWorkspace, err := tstore.StartWorkspace(workspaces[0].ID)
if err != nil {
return breverrors.WrapAndTrace(err)
}
t.Vprintf(t.Yellow("Dev environment %s is starting. \n\n", startedWorkspace.Name))
err = pollUntil(t, workspace.ID, entity.Running, tstore)
if err != nil {
return breverrors.WrapAndTrace(err)
}
workspace, err = util.GetUserWorkspaceByNameOrIDErr(tstore, wsIDOrName)
if err != nil {
return breverrors.WrapAndTrace(err)
}
return nil
}
// Opens code editor. Attempts to install code in path if not installed already
func openVsCodeWithSSH(t *terminal.Terminal, sshAlias string, path string, tstore OpenStore, runRemoteCMD bool, waitForSetupToFinish bool) error {
// infinite for loop:
res := refresh.RunRefreshAsync(tstore, runRemoteCMD)
err := res.Await()
if err != nil {
return breverrors.WrapAndTrace(err)
}
s := t.NewSpinner()
s.Start()
s.Suffix = " checking if your environment is ready..."
waitForSSHToBeAvailable(t, s, sshAlias)
waitForLoggerFileToBeAvailable(t, s, sshAlias)
if err != nil {
return breverrors.WrapAndTrace(err)
}
setupFinished, err := checkSetupFinished(sshAlias, waitForSetupToFinish)
if err != nil {
return breverrors.WrapAndTrace(err)
}
if !setupFinished {
err = streamOutput(t, s, sshAlias, path, waitForSetupToFinish)
if err != nil {
return breverrors.WrapAndTrace(err)
}
} else {
s.Suffix = " Environment is ready. Opening VS Code 🤙"
time.Sleep(1 * time.Second)
err = openVsCode(sshAlias, path)
if err != nil {
return breverrors.WrapAndTrace(err)
}
}
t.Vprint("\n")
return nil
}
func waitForSSHToBeAvailable(t *terminal.Terminal, s *spinner.Spinner, sshAlias string) {
counter := 0
for {
cmd := exec.Command("ssh", "-o", "RemoteCommand=none", "-o", "ConnectTimeout=1", sshAlias, "echo", "hello")
_, err := cmd.CombinedOutput()
if err == nil {
return
}
if counter == 10 {
s.Suffix = t.Green(" waiting for connection to be ready 🤙")
}
counter++
time.Sleep(1 * time.Second)
}
}
func waitForLoggerFileToBeAvailable(t *terminal.Terminal, s *spinner.Spinner, sshAlias string) {
counter := 0
for {
cmd := exec.Command("ssh", "-o", "RemoteCommand=none", "-o", "ConnectTimeout=1", sshAlias, "tail", "-n", "1", "/var/log/brev-workspace.log")
_, err := cmd.CombinedOutput()
if err == nil {
return
}
if counter == 5 {
s.Suffix = t.Green(" setting up Ubuntu...")
}
if counter == 20 {
s.Suffix = t.Green(" installing a few more bits and bobs... ")
}
if counter == 27 {
s.Suffix = t.Green(" this is only slow the first time... ")
}
counter++
time.Sleep(1 * time.Second)
}
}
func checkSetupFinished(sshAlias string, waitForSetupToFinish bool) (bool, error) {
out, err := exec.Command("ssh", "-o", "RemoteCommand=none", sshAlias, "cat", "/var/log/brev-workspace.log").CombinedOutput() // RemoteCommand=none
if err != nil {
return false, breverrors.WrapAndTrace(err)
}
return (strings.Contains(string(out), "------ Setup End ------") || (!waitForSetupToFinish && strings.Contains(string(out), "------ Git repo cloned ------"))), nil
}
func streamOutput(t *terminal.Terminal, s *spinner.Spinner, sshAlias string, path string, waitForSetupToFinish bool) error {
s.Suffix = t.Green(" should be no more than a minute now...hit ENTER to see logs")
cmd := exec.Command("ssh", "-o", "RemoteCommand=none", sshAlias, "tail", "-f", "/var/log/brev-workspace.log")
cmdReader, err := cmd.StdoutPipe()
if err != nil {
return breverrors.WrapAndTrace(err)
}
vscodeAlreadyOpened := false
showLogsToUser := false
scanner := bufio.NewScanner(cmdReader)
errChannel := make(chan error)
go scanLoggerFile(scanner, sshAlias, path, s, &vscodeAlreadyOpened, &showLogsToUser, errChannel, waitForSetupToFinish)
err = cmd.Start()
if err != nil {
os.Exit(0)
return breverrors.WrapAndTrace(err)
}
go showLogsToUserIfTheyPressEnter(sshAlias, &showLogsToUser, s)
out := <-errChannel
if out != nil {
return out
}
err = cmd.Wait()
if err != nil {
return breverrors.WrapAndTrace(err)
}
return nil
}
func scanLoggerFile(scanner *bufio.Scanner, sshAlias string, path string, s *spinner.Spinner, vscodeAlreadyOpened *bool, showLogsToUser *bool, err chan error, waitForSetupToFinish bool) {
for scanner.Scan() {
if *showLogsToUser {
fmt.Println("\n", scanner.Text())
}
if strings.Contains(scanner.Text(), "------ Setup End ------") || (!waitForSetupToFinish && strings.Contains(scanner.Text(), "------ Git repo cloned ------")) {
if !*vscodeAlreadyOpened {
s.Stop()
err <- openVsCode(sshAlias, path)
*vscodeAlreadyOpened = true
}
}
if strings.Contains(scanner.Text(), "------ Setup End ------") {
s.Stop()
os.Exit(0)
}
}
}
func openVsCode(sshAlias string, path string) error {
vscodeString := fmt.Sprintf("vscode-remote://ssh-remote+%s%s", sshAlias, path)
vscodeString = shellescape.QuoteCommand([]string{vscodeString})
cmd := exec.Command("code", "--folder-uri", vscodeString) // #nosec G204
err := cmd.Run()
if err != nil {
err = openVsCodeViaExecutable(sshAlias, path)
return breverrors.WrapAndTrace(err)
}
return nil
}
func openVsCodeViaExecutable(sshAlias string, path string) error {
vscodeString := fmt.Sprintf("vscode-remote://ssh-remote+%s%s", sshAlias, path)
vscodeString = shellescape.QuoteCommand([]string{vscodeString})
cmd := exec.Command("/Applications/Visual Studio Code.app/Contents/Resources/app/bin/code", "--folder-uri", vscodeString) // #nosec G204
err := cmd.Run()
if err != nil {
return breverrors.WrapAndTrace(err)
}
return nil
}
func showLogsToUserIfTheyPressEnter(sshAlias string, showLogsToUser *bool, s *spinner.Spinner) {
scanner := bufio.NewScanner(os.Stdin)
for scanner.Scan() {
*showLogsToUser = true
out, err := exec.Command("ssh", "-o", "RemoteCommand=none", sshAlias, "cat", "/var/log/brev-workspace.log").CombinedOutput()
fmt.Print(string(out))
if err != nil {
fmt.Println(err)
}
s.Suffix = ""
}
}