-
-
Notifications
You must be signed in to change notification settings - Fork 907
Expand file tree
/
Copy pathdurableshellcontroller.go
More file actions
277 lines (251 loc) · 8.71 KB
/
durableshellcontroller.go
File metadata and controls
277 lines (251 loc) · 8.71 KB
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
// Copyright 2025, Command Line Inc.
// SPDX-License-Identifier: Apache-2.0
package blockcontroller
import (
"context"
"encoding/base64"
"fmt"
"io/fs"
"log"
"sync"
"time"
"github.com/google/uuid"
"github.com/wavetermdev/waveterm/pkg/filestore"
"github.com/wavetermdev/waveterm/pkg/jobcontroller"
"github.com/wavetermdev/waveterm/pkg/remote"
"github.com/wavetermdev/waveterm/pkg/remote/conncontroller"
"github.com/wavetermdev/waveterm/pkg/shellexec"
"github.com/wavetermdev/waveterm/pkg/util/shellutil"
"github.com/wavetermdev/waveterm/pkg/utilds"
"github.com/wavetermdev/waveterm/pkg/wavebase"
"github.com/wavetermdev/waveterm/pkg/waveobj"
"github.com/wavetermdev/waveterm/pkg/wps"
"github.com/wavetermdev/waveterm/pkg/wshrpc"
"github.com/wavetermdev/waveterm/pkg/wshrpc/wshclient"
"github.com/wavetermdev/waveterm/pkg/wshutil"
"github.com/wavetermdev/waveterm/pkg/wstore"
)
type DurableShellController struct {
Lock *sync.Mutex
ControllerType string
TabId string
BlockId string
ConnName string
BlockDef *waveobj.BlockDef
VersionTs utilds.VersionTs
InputSessionId string // random uuid
inputSeqNum int // monotonic sequence number for inputs, starts at 1
JobId string
LastKnownStatus string
}
func MakeDurableShellController(tabId string, blockId string, controllerType string, connName string) Controller {
return &DurableShellController{
Lock: &sync.Mutex{},
ControllerType: controllerType,
TabId: tabId,
BlockId: blockId,
ConnName: connName,
LastKnownStatus: Status_Init,
InputSessionId: uuid.New().String(),
}
}
func (dsc *DurableShellController) WithLock(f func()) {
dsc.Lock.Lock()
defer dsc.Lock.Unlock()
f()
}
func (dsc *DurableShellController) getJobId() string {
dsc.Lock.Lock()
defer dsc.Lock.Unlock()
return dsc.JobId
}
func (dsc *DurableShellController) getNextInputSeq() (string, int) {
dsc.Lock.Lock()
defer dsc.Lock.Unlock()
dsc.inputSeqNum++
return dsc.InputSessionId, dsc.inputSeqNum
}
func (dsc *DurableShellController) getJobStatus_withlock() string {
if dsc.JobId == "" {
dsc.LastKnownStatus = Status_Init
return Status_Init
}
status, err := jobcontroller.GetJobManagerStatus(context.Background(), dsc.JobId)
if err != nil {
log.Printf("error getting job status for %s: %v, using last known status: %s", dsc.JobId, err, dsc.LastKnownStatus)
return dsc.LastKnownStatus
}
dsc.LastKnownStatus = status
return status
}
func (dsc *DurableShellController) getRuntimeStatus_withlock() BlockControllerRuntimeStatus {
var rtn BlockControllerRuntimeStatus
rtn.Version = dsc.VersionTs.GetVersionTs()
rtn.BlockId = dsc.BlockId
rtn.ShellProcStatus = dsc.getJobStatus_withlock()
rtn.ShellProcConnName = dsc.ConnName
return rtn
}
func (dsc *DurableShellController) GetRuntimeStatus() *BlockControllerRuntimeStatus {
var rtn BlockControllerRuntimeStatus
dsc.WithLock(func() {
rtn = dsc.getRuntimeStatus_withlock()
})
return &rtn
}
func (dsc *DurableShellController) GetConnName() string {
dsc.Lock.Lock()
defer dsc.Lock.Unlock()
return dsc.ConnName
}
func (dsc *DurableShellController) sendUpdate_withlock() {
rtStatus := dsc.getRuntimeStatus_withlock()
log.Printf("sending blockcontroller update %#v\n", rtStatus)
wps.Broker.Publish(wps.WaveEvent{
Event: wps.Event_ControllerStatus,
Scopes: []string{
waveobj.MakeORef(waveobj.OType_Tab, dsc.TabId).String(),
waveobj.MakeORef(waveobj.OType_Block, dsc.BlockId).String(),
},
Data: rtStatus,
})
}
// Start initializes or reconnects to a durable shell for the block.
// Logic:
// - If block has no existing jobId: starts a new job and attaches it
// - If block has existing jobId with running job manager: reconnects to existing job
// - If block has existing jobId with non-running job manager:
// - force=true: detaches old job and starts new one
// - force=false: returns without starting (leaves block unstarted)
//
// After establishing jobId, ensures job connection is active (reconnects if needed)
func (dsc *DurableShellController) Start(ctx context.Context, blockMeta waveobj.MetaMapType, rtOpts *waveobj.RuntimeOpts, force bool) error {
blockData, err := wstore.DBMustGet[*waveobj.Block](ctx, dsc.BlockId)
if err != nil {
return fmt.Errorf("error getting block: %w", err)
}
if conncontroller.IsLocalConnName(dsc.ConnName) {
return fmt.Errorf("durable shell controller requires a remote connection")
}
var jobId string
if blockData.JobId != "" {
status, err := jobcontroller.GetJobManagerStatus(ctx, blockData.JobId)
if err != nil {
return fmt.Errorf("error getting job manager status: %w", err)
}
if status == jobcontroller.JobManagerStatus_Running {
jobId = blockData.JobId
} else if !force {
log.Printf("block %q has jobId %s but manager is not running (status: %s), not starting (force=false)\n", dsc.BlockId, blockData.JobId, status)
return nil
} else {
log.Printf("block %q has jobId %s but manager is not running (status: %s), starting new job (force=true)\n", dsc.BlockId, blockData.JobId, status)
// intentionally leave jobId empty to trigger starting a new job below
}
}
if jobId == "" {
log.Printf("block %q starting new durable shell\n", dsc.BlockId)
fsErr := filestore.WFS.MakeFile(ctx, dsc.BlockId, wavebase.BlockFile_Term, nil, wshrpc.FileOpts{MaxSize: DefaultTermMaxFileSize, Circular: true})
if fsErr != nil && fsErr != fs.ErrExist {
return fmt.Errorf("error creating block term file: %w", fsErr)
}
newJobId, err := dsc.startNewJob(ctx, blockMeta, dsc.ConnName, rtOpts)
if err != nil {
return fmt.Errorf("failed to start new job: %w", err)
}
jobId = newJobId
}
dsc.WithLock(func() {
dsc.JobId = jobId
dsc.sendUpdate_withlock()
})
err = jobcontroller.ReconnectJob(ctx, jobId, rtOpts)
if err != nil {
return fmt.Errorf("failed to reconnect to job: %w", err)
}
return nil
}
func (dsc *DurableShellController) Stop(graceful bool, newStatus string, destroy bool) {
if !destroy {
return
}
jobId := dsc.getJobId()
if jobId == "" {
return
}
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
defer cancel()
jobcontroller.TerminateAndDetachJob(ctx, jobId)
}
func (dsc *DurableShellController) SendInput(inputUnion *BlockInputUnion) error {
if inputUnion == nil {
return nil
}
jobId := dsc.getJobId()
if jobId == "" {
return fmt.Errorf("no job attached to controller")
}
inputSessionId, seqNum := dsc.getNextInputSeq()
data := wshrpc.CommandJobInputData{
JobId: jobId,
InputSessionId: inputSessionId,
SeqNum: seqNum,
TermSize: inputUnion.TermSize,
SigName: inputUnion.SigName,
}
if len(inputUnion.InputData) > 0 {
data.InputData64 = base64.StdEncoding.EncodeToString(inputUnion.InputData)
}
return jobcontroller.SendInput(context.Background(), data)
}
func (dsc *DurableShellController) startNewJob(ctx context.Context, blockMeta waveobj.MetaMapType, connName string, rtOpts *waveobj.RuntimeOpts) (string, error) {
termSize := waveobj.TermSize{
Rows: shellutil.DefaultTermRows,
Cols: shellutil.DefaultTermCols,
}
if rtOpts != nil && rtOpts.TermSize.Rows > 0 && rtOpts.TermSize.Cols > 0 {
termSize = rtOpts.TermSize
}
cmdStr := blockMeta.GetString(waveobj.MetaKey_Cmd, "")
cwd := blockMeta.GetString(waveobj.MetaKey_CmdCwd, "")
opts, err := remote.ParseOpts(connName)
if err != nil {
return "", fmt.Errorf("invalid ssh remote name (%s): %w", connName, err)
}
conn := conncontroller.MaybeGetConn(opts)
if conn == nil {
return "", fmt.Errorf("connection %q not found", connName)
}
connRoute := wshutil.MakeConnectionRouteId(connName)
remoteInfo, err := wshclient.RemoteGetInfoCommand(wshclient.GetBareRpcClient(), &wshrpc.RpcOpts{Route: connRoute, Timeout: 2000})
if err != nil {
return "", fmt.Errorf("unable to obtain remote info from connserver: %w", err)
}
shellType := shellutil.GetShellTypeFromShellPath(remoteInfo.Shell)
swapToken := makeSwapToken(ctx, ctx, dsc.BlockId, blockMeta, connName, shellType)
sockName := wavebase.GetPersistentRemoteSockName(wstore.GetClientId())
rpcContext := wshrpc.RpcContext{
ProcRoute: true,
SockName: sockName,
BlockId: dsc.BlockId,
Conn: connName,
}
jwtStr, err := wshutil.MakeClientJWTToken(rpcContext)
if err != nil {
return "", fmt.Errorf("error making jwt token: %w", err)
}
swapToken.RpcContext = &rpcContext
swapToken.Env[wshutil.WaveJwtTokenVarName] = jwtStr
cmdOpts := shellexec.CommandOptsType{
Interactive: true,
Login: true,
Cwd: cwd,
SwapToken: swapToken,
ForceJwt: blockMeta.GetBool(waveobj.MetaKey_CmdJwt, false),
}
jobId, err := shellexec.StartRemoteShellJob(ctx, ctx, termSize, cmdStr, cmdOpts, conn, dsc.BlockId)
if err != nil {
return "", fmt.Errorf("failed to start durable shell: %w", err)
}
return jobId, nil
}