~james/core

core/spindle/mill/restore.go -rw-r--r-- 7.6 KiB
452f17b7 — james chore(import): snapshot james.dad.town/core at f70c71c7696a 17 hours ago
                                                                                
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
package mill

import (
	"fmt"
	"maps"
	"slices"
	"time"

	"tangled.org/core/spindle/db"
	"tangled.org/core/spindle/engine"
	"tangled.org/core/spindle/models"

	millv1 "tangled.org/core/spindle/mill/proto/gen"
)

const (
	leaseRowReserved = "reserved"
	leaseRowRunning  = "running"
)

func (m *Mill) persistLease(lease *RemoteLease, state string) error {
	if m.db == nil {
		return nil
	}
	lease.mu.Lock()
	quotaID := lease.quotaID
	lease.mu.Unlock()
	return m.db.SaveMillLease(db.MillLease{
		LeaseID:                    lease.id,
		NodeID:                     lease.nodeID,
		Epoch:                      lease.epoch,
		Engine:                     lease.engine,
		PipelineID:                 string(lease.wid.PipelineId),
		Workflow:                   lease.wid.Name,
		State:                      state,
		QuotaReservationID:         quotaID,
		OwnerDID:                   lease.ownerDID,
		RepoDID:                    lease.repoDID,
		MillRecordsTerminalMetrics: lease.millRecordsTerminalMetrics,
	})
}

// reservation ids the fleet still has live leases for. startup recovery
// keeps these and reclaims every other row
func (m *Mill) LiveQuotaReservationIDs() []string {
	m.mu.Lock()
	leases := slices.Collect(maps.Values(m.leases))
	m.mu.Unlock()

	var ids []string
	for _, lease := range leases {
		lease.mu.Lock()
		if lease.quotaID != "" {
			ids = append(ids, lease.quotaID)
		}
		ids = append(ids, slices.Collect(maps.Keys(lease.remoteQuotas))...)
		lease.mu.Unlock()
	}
	return ids
}

func (m *Mill) RestoreState() error {
	if m.db == nil {
		return nil
	}
	cursors, err := m.db.ListExecutorCursors()
	if err != nil {
		return err
	}
	rows, err := m.db.ListMillLeases()
	if err != nil {
		return err
	}

	m.mu.Lock()
	for _, c := range cursors {
		m.nodeSeqno[c.NodeID+"/"+c.Epoch] = c.AckedSeqno
	}
	for _, r := range rows {
		lease := newLease(r.LeaseID, r.NodeID, r.Epoch, r.Engine)
		lease.wid = models.WorkflowId{
			PipelineId: models.PipelineId(r.PipelineID),
			Name:       r.Workflow,
		}
		// the charge outlives the mill process. only the id survives, so
		// release goes through the manager by id rather than a held lease
		lease.quotaID = r.QuotaReservationID
		lease.ownerDID = r.OwnerDID
		lease.repoDID = r.RepoDID
		lease.millRecordsTerminalMetrics = r.MillRecordsTerminalMetrics
		// restored leases start as orphans, an executor must reclaim it via
		// its first snapshot, or the sweep will fail it
		lease.orphaned = true
		lease.claimed = false
		if r.State == leaseRowRunning {
			lease.state = leaseRunning
		}
		m.leases[r.LeaseID] = lease
	}
	restored := len(rows)
	m.mu.Unlock()

	if restored > 0 {
		m.l.Info("restored mill leases from previous run", "leases", restored, "cursors", len(cursors))
		// executors get a grace window to reconnect and claim their leases
		time.AfterFunc(m.cfg.ReconnectGrace, m.sweepUnclaimedOrphans)
	}
	return nil
}
func (m *Mill) sweepUnclaimedOrphans() {
	m.mu.Lock()
	var unclaimed []*RemoteLease
	for _, lease := range m.leases {
		if !lease.orphaned {
			continue
		}
		if lease.claimed {
			continue
		}
		if lease.getState() == leaseDone {
			continue
		}
		if sess := m.sessions[lease.nodeID]; sess == nil || sess.disconnected {
			unclaimed = append(unclaimed, lease)
		}
	}
	m.mu.Unlock()

	retry := false
	reason := "executor did not reconnect after mill restart"
	for _, lease := range unclaimed {
		m.l.Warn("failing unclaimed restored lease", "lease", lease.id, "node", lease.nodeID)
		if err := m.finishOrphan(lease, string(models.StatusKindFailed), &reason, nil); err != nil {
			m.l.Error("finish unclaimed restored lease", "lease", lease.id, "err", err)
			retry = true
		}
	}
	if retry {
		time.AfterFunc(5*time.Second, m.sweepUnclaimedOrphans)
	}
}

func (m *Mill) reconcileLeases(sess *millSession, activeLeaseIDs []string) error {
	active := make(map[string]struct{}, len(activeLeaseIDs))
	for _, id := range activeLeaseIDs {
		active[id] = struct{}{}
	}

	known := make(map[string]struct{})
	m.mu.Lock()
	var gone []*RemoteLease
	for _, lease := range m.leases {
		if lease.nodeID == sess.nodeID {
			known[lease.id] = struct{}{}
			if lease.epoch != sess.epoch {
				gone = append(gone, lease)
			} else if _, ok := active[lease.id]; !ok {
				gone = append(gone, lease)
			}
		}
	}
	for _, lease := range m.reservations {
		if lease.nodeID == sess.nodeID && lease.epoch == sess.epoch {
			known[lease.id] = struct{}{}
		}
	}
	m.mu.Unlock()
	var unknown []string
	for id := range active {
		if _, ok := known[id]; !ok {
			unknown = append(unknown, id)
		}
	}

	for _, lease := range gone {
		status := string(models.StatusKindFailed)
		reason := "executor no longer holds lease"
		if cancelled, cancelReason := lease.cancelRequested(); cancelled {
			status = string(models.StatusKindCancelled)
			reason = cancelReason
		}
		m.l.Warn("finishing reconciled lease", "lease", lease.id, "node", sess.nodeID, "leaseInc", lease.epoch, "sessInc", sess.epoch)
		if lease.orphaned {
			if err := m.finishOrphan(lease, status, &reason, nil); err != nil {
				return err
			}
		} else if err := m.finishLiveLease(lease, status, reason); err != nil {
			return err
		}
	}
	for _, id := range unknown {
		if err := m.sendUntrackedCancel(sess, id, "lease is not owned by this mill"); err != nil {
			return fmt.Errorf("cancel unknown executor lease %q: %w", id, err)
		}
	}
	return nil
}

func (m *Mill) completeLeaseRow(lease *RemoteLease, status string, errMsg *string, exitCode *int64) (string, error) {
	if m.db == nil {
		return status, nil
	}
	return m.db.CompleteMillLease(
		lease.id,
		lease.wid,
		status,
		errMsg,
		exitCode,
		m.n,
	)
}

func (m *Mill) finishLiveLease(lease *RemoteLease, status, reason string) error {
	lease.finishMu.Lock()
	defer lease.finishMu.Unlock()
	if lease.getState() == leaseDone {
		return nil
	}
	status, err := m.completeLeaseRow(lease, status, &reason, nil)
	if err != nil {
		return err
	}
	lease.deliverTerminal(&millv1.AttemptResult{
		Status: mapTerminalStatusString(status),
		Error:  reason,
	})
	m.recordSyntheticTerminal(lease, status)
	if err := m.cleanupLeaseLocked(lease); err != nil {
		return err
	}
	return nil
}

func (m *Mill) finishOrphan(lease *RemoteLease, status string, errMsg *string, exitCode *int64) error {
	lease.finishMu.Lock()
	defer lease.finishMu.Unlock()
	if lease.getState() == leaseDone {
		return nil
	}
	status, err := m.completeLeaseRow(lease, status, errMsg, exitCode)
	if err != nil {
		return err
	}
	lease.markDone()
	m.recordSyntheticTerminal(lease, status)
	if err := m.cleanupLeaseLocked(lease); err != nil {
		return err
	}
	return nil
}

func (m *Mill) recordSyntheticTerminal(lease *RemoteLease, status string) {
	if !lease.millRecordsTerminalMetrics {
		return
	}
	result := "failure"
	class := engine.FailureClassInfrastructure
	reason := engine.FailureReasonExecutorLost
	switch status {
	case string(models.StatusKindSuccess):
		result = "success"
		class = engine.FailureClassNone
		reason = engine.FailureReasonSuccess
	case string(models.StatusKindTimeout):
		result = "timeout"
		class = engine.FailureClassUser
		reason = engine.FailureReasonTimeout
	case string(models.StatusKindCancelled):
		result = "cancelled"
		class = engine.FailureClassUser
		reason = engine.FailureReasonCancelled
	}
	m.metrics.RecordWorkflowTerminal(lease.engine, result, string(class), string(reason))
}

func mapTerminalStatusString(s string) millv1.TerminalStatus {
	switch s {
	case "success":
		return millv1.TerminalStatus_TERMINAL_STATUS_SUCCESS
	case "failed":
		return millv1.TerminalStatus_TERMINAL_STATUS_FAILED
	case "timeout":
		return millv1.TerminalStatus_TERMINAL_STATUS_TIMEOUT
	case "cancelled":
		return millv1.TerminalStatus_TERMINAL_STATUS_CANCELLED
	default:
		return millv1.TerminalStatus_TERMINAL_STATUS_UNSPECIFIED
	}
}