xum/src/node/runtime/multiProjectRuntime.ts at main · coder/xum · GitHub

History

478 lines (411 loc) · 14.4 KB

Raw

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

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

import assert from "node:assert";

import type { RuntimeConfig } from "@/common/types/runtime";

import type { Result } from "@/common/types/result";

import { getErrorMessage } from "@/common/utils/errors";

import type { ContainerManager, ProjectWorkspaceEntry } from "@/node/multiProject/containerManager";

import type {

EnsureReadyOptions,

EnsureReadyResult,

ExecOptions,

ExecStream,

FileStat,

Runtime,

RuntimeCreateFlags,

WorkspaceCreationParams,

WorkspaceCreationResult,

WorkspaceForkParams,

WorkspaceForkResult,

WorkspaceInitParams,

WorkspaceInitResult,

} from "./Runtime";

export interface MultiProjectRuntimeEntry {

projectPath: string;

projectName: string;

runtime: Runtime;

}

export class MultiProjectRuntime implements Runtime {

readonly createFlags?: RuntimeCreateFlags;

readonly finalizeConfig?: (

finalBranchName: string,

config: RuntimeConfig

) => Promise<Result<RuntimeConfig, string>>;

readonly validateBeforePersist?: (

finalBranchName: string,

config: RuntimeConfig

) => Promise<Result<void, string>>;

readonly postCreateSetup?: (params: WorkspaceInitParams) => Promise<void>;

public envResolver?: (projectPath: string) => Promise<Record<string, string> | undefined>;

private readonly primaryRuntime: Runtime;

private readonly containerPath: string;

constructor(

private readonly containerManager: ContainerManager,

private readonly projectRuntimes: MultiProjectRuntimeEntry[],

workspaceName: string

) {

assert(projectRuntimes.length > 0, "MultiProjectRuntime requires at least one project runtime");

this.primaryRuntime = projectRuntimes[0].runtime;

this.containerPath = containerManager.getContainerPath(workspaceName);

this.createFlags = this.primaryRuntime.createFlags;

this.finalizeConfig = this.primaryRuntime.finalizeConfig?.bind(this.primaryRuntime);

this.validateBeforePersist = this.primaryRuntime.validateBeforePersist?.bind(

this.primaryRuntime

);

this.postCreateSetup = this.primaryRuntime.postCreateSetup?.bind(this.primaryRuntime);

}

async ensureReady(options?: EnsureReadyOptions): Promise<EnsureReadyResult> {

for (const projectRuntime of this.projectRuntimes) {

const readyResult = await projectRuntime.runtime.ensureReady(options);

if (!readyResult.ready) {

return readyResult;

}

return { ready: true };

}

async createWorkspace(params: WorkspaceCreationParams): Promise<WorkspaceCreationResult> {

const workspaceName = params.directoryName;

const createdRuntimes: MultiProjectRuntimeEntry[] = [];

const projectWorkspaces: ProjectWorkspaceEntry[] = [];

for (const projectRuntime of this.projectRuntimes) {

const createResult = await projectRuntime.runtime.createWorkspace({

...params,

projectPath: projectRuntime.projectPath,

});

if (!createResult.success) {

const rollbackErrors = await this.rollbackCreatedWorkspaces(

createdRuntimes,

workspaceName,

params.abortSignal,

params.trusted

);

return {

success: false,

error: this.withRollbackErrors(

`Failed to create workspace for project ${projectRuntime.projectName}: ${

createResult.error ?? "Unknown error"

}`,

rollbackErrors

};

}

const createdWorkspacePath = createResult.workspacePath;

if (!createdWorkspacePath) {

const rollbackErrors = await this.rollbackCreatedWorkspaces(

[...createdRuntimes, projectRuntime],

workspaceName,

params.abortSignal,

params.trusted

);

return {

success: false,

error: this.withRollbackErrors(

`Failed to create workspace for project ${projectRuntime.projectName}: runtime returned success without workspacePath`,

rollbackErrors

};

}

createdRuntimes.push(projectRuntime);

projectWorkspaces.push({

projectName: projectRuntime.projectName,

workspacePath: createdWorkspacePath,

});

}

try {

await this.containerManager.createContainer(workspaceName, projectWorkspaces);

} catch (error) {

const rollbackErrors = await this.rollbackCreatedWorkspaces(

createdRuntimes,

workspaceName,

params.abortSignal,

params.trusted

);

return {

success: false,

error: this.withRollbackErrors(

`Failed to create multi-project container: ${getErrorMessage(error)}`,

rollbackErrors

};

}

return {

success: true,

workspacePath: this.containerManager.getContainerPath(workspaceName),

};

}

async initWorkspace(params: WorkspaceInitParams): Promise<WorkspaceInitResult> {

const projectInitLogger = {

...params.initLogger,

// Individual runtimes report completion; suppress per-project completion so the

// multi-project workspace transitions out of initializing only after all runtimes finish.

logComplete: (_exitCode: number) => undefined,

};

const initResults: WorkspaceInitResult[] = [];

for (const projectRuntime of this.projectRuntimes) {

const projectWorkspacePath = projectRuntime.runtime.getWorkspacePath(

projectRuntime.projectPath,

params.branchName

);

const projectEnv = (await this.envResolver?.(projectRuntime.projectPath)) ?? params.env;

const initResult = await projectRuntime.runtime.initWorkspace({

...params,

projectPath: projectRuntime.projectPath,

workspacePath: projectWorkspacePath,

initLogger: projectInitLogger,

env: projectEnv,

});

initResults.push(initResult);

}

const firstFailure = initResults.find((result) => !result.success);

if (firstFailure) {

params.initLogger.logComplete(-1);

return firstFailure;

}

params.initLogger.logComplete(0);

return { success: true };

}

async deleteWorkspace(

_projectPath: string,

workspaceName: string,

force: boolean,

abortSignal?: AbortSignal,

trusted?: boolean

): Promise<{ success: true; deletedPath: string } | { success: false; error: string }> {

const errors: string[] = [];

for (const projectRuntime of this.projectRuntimes) {

try {

const deleteResult = await projectRuntime.runtime.deleteWorkspace(

projectRuntime.projectPath,

workspaceName,

force,

abortSignal,

trusted

);

if (!deleteResult.success) {

errors.push(

`[${projectRuntime.projectName}] ${deleteResult.error ?? "Unknown delete error"}`

);

}

} catch (error) {

errors.push(`[${projectRuntime.projectName}] ${getErrorMessage(error)}`);

}

try {

await this.containerManager.removeContainer(workspaceName);

} catch (error) {

errors.push(`[container] ${getErrorMessage(error)}`);

}

if (errors.length > 0) {

return {

success: false,

error: `Failed to delete multi-project workspace: ${errors.join("; ")}`,

};

}

return {

success: true,

deletedPath: this.containerManager.getContainerPath(workspaceName),

};

}

async forkWorkspace(params: WorkspaceForkParams): Promise<WorkspaceForkResult> {

const forkedRuntimes: MultiProjectRuntimeEntry[] = [];

const projectWorkspaces: ProjectWorkspaceEntry[] = [];

let primaryForkResult: WorkspaceForkResult | undefined;

for (const [runtimeIndex, projectRuntime] of this.projectRuntimes.entries()) {

const forkResult = await projectRuntime.runtime.forkWorkspace({

...params,

projectPath: projectRuntime.projectPath,

});

if (runtimeIndex === 0) {

primaryForkResult = forkResult;

}

if (!forkResult.success) {

const rollbackErrors = await this.rollbackCreatedWorkspaces(

forkedRuntimes,

params.newWorkspaceName,

params.abortSignal,

params.trusted

);

return {

success: false,

error: this.withRollbackErrors(

`Failed to fork project ${projectRuntime.projectName}: ${forkResult.error ?? "Unknown error"}`,

rollbackErrors

...(forkResult.failureIsFatal !== undefined

? { failureIsFatal: forkResult.failureIsFatal }

: {}),

...(forkResult.forkedRuntimeConfig

? { forkedRuntimeConfig: forkResult.forkedRuntimeConfig }

: {}),

...(forkResult.sourceRuntimeConfig

? { sourceRuntimeConfig: forkResult.sourceRuntimeConfig }

: {}),

};

}

const forkedWorkspacePath = forkResult.workspacePath;

if (!forkedWorkspacePath) {

const rollbackErrors = await this.rollbackCreatedWorkspaces(

[...forkedRuntimes, projectRuntime],

params.newWorkspaceName,

params.abortSignal,

params.trusted

);

return {

success: false,

error: this.withRollbackErrors(

`Failed to fork project ${projectRuntime.projectName}: runtime returned success without workspacePath`,

rollbackErrors

};

}

forkedRuntimes.push(projectRuntime);

projectWorkspaces.push({

projectName: projectRuntime.projectName,

workspacePath: forkedWorkspacePath,

});

}

assert(primaryForkResult, "Primary runtime fork result is required");

assert(primaryForkResult.success, "Primary runtime fork should succeed when all forks succeed");

try {

await this.containerManager.createContainer(params.newWorkspaceName, projectWorkspaces);

} catch (error) {

const rollbackErrors = await this.rollbackCreatedWorkspaces(

forkedRuntimes,

params.newWorkspaceName,

params.abortSignal,

params.trusted

);

return {

success: false,

error: this.withRollbackErrors(

`Failed to create child workspace container: ${getErrorMessage(error)}`,

rollbackErrors

};

}

return {

success: true,

workspacePath: this.containerManager.getContainerPath(params.newWorkspaceName),

sourceBranch: primaryForkResult.sourceBranch,

...(primaryForkResult.forkedRuntimeConfig

? { forkedRuntimeConfig: primaryForkResult.forkedRuntimeConfig }

: {}),

...(primaryForkResult.sourceRuntimeConfig

? { sourceRuntimeConfig: primaryForkResult.sourceRuntimeConfig }

: {}),

};

}

async renameWorkspace(

_projectPath: string,

oldName: string,

newName: string,

abortSignal?: AbortSignal,

trusted?: boolean

): Promise<

{ success: true; oldPath: string; newPath: string } | { success: false; error: string }

> {

const renamedProjectWorkspaces: ProjectWorkspaceEntry[] = [];

for (const projectRuntime of this.projectRuntimes) {

const renameResult = await projectRuntime.runtime.renameWorkspace(

projectRuntime.projectPath,

oldName,

newName,

abortSignal,

trusted

);

if (!renameResult.success) {

return {

success: false,

error: `Failed to rename workspace for project ${projectRuntime.projectName}: ${renameResult.error}`,

};

}

renamedProjectWorkspaces.push({

projectName: projectRuntime.projectName,

workspacePath: renameResult.newPath,

});

}

try {

await this.containerManager.removeContainer(oldName);

await this.containerManager.createContainer(newName, renamedProjectWorkspaces);

} catch (error) {

return {

success: false,

error: `Failed to update multi-project container for rename: ${getErrorMessage(error)}`,

};

}

return {

success: true,

oldPath: this.containerManager.getContainerPath(oldName),

newPath: this.containerManager.getContainerPath(newName),

};

}

getWorkspacePath(_projectPath: string, _workspaceName: string): string {

return this.containerPath;

}

resolvePath(targetPath: string): Promise<string> {

return this.primaryRuntime.resolvePath(targetPath);

}

normalizePath(targetPath: string, basePath: string): string {

return this.primaryRuntime.normalizePath(targetPath, basePath);

}

exec(command: string, options: ExecOptions): Promise<ExecStream> {

return this.primaryRuntime.exec(command, {

...options,

cwd: options.cwd || this.containerPath,

});

}

readFile(filePath: string, abortSignal?: AbortSignal): ReadableStream<Uint8Array> {

return this.primaryRuntime.readFile(filePath, abortSignal);

}

writeFile(filePath: string, abortSignal?: AbortSignal): WritableStream<Uint8Array> {

return this.primaryRuntime.writeFile(filePath, abortSignal);

}

stat(filePath: string, abortSignal?: AbortSignal): Promise<FileStat> {

return this.primaryRuntime.stat(filePath, abortSignal);

}

ensureDir(dirPath: string, abortSignal?: AbortSignal): Promise<void> {

return this.primaryRuntime.ensureDir(dirPath, abortSignal);

}

tempDir(): Promise<string> {

return this.primaryRuntime.tempDir();

}

getXumHome(): string {

return this.primaryRuntime.getXumHome();

}

private async rollbackCreatedWorkspaces(

createdRuntimes: MultiProjectRuntimeEntry[],

workspaceName: string,

abortSignal?: AbortSignal,

trusted?: boolean

): Promise<string[]> {

const rollbackErrors: string[] = [];

for (const projectRuntime of [...createdRuntimes].reverse()) {

try {

const deleteResult = await projectRuntime.runtime.deleteWorkspace(

projectRuntime.projectPath,

workspaceName,

true,

abortSignal,

trusted

);

if (!deleteResult.success) {

rollbackErrors.push(

`[${projectRuntime.projectName}] ${deleteResult.error ?? "Unknown rollback error"}`

);

}

} catch (error) {

rollbackErrors.push(`[${projectRuntime.projectName}] ${getErrorMessage(error)}`);

}

try {

await this.containerManager.removeContainer(workspaceName);

} catch (error) {

rollbackErrors.push(`[container] ${getErrorMessage(error)}`);

}

return rollbackErrors;

}

private withRollbackErrors(errorMessage: string, rollbackErrors: string[]): string {

if (rollbackErrors.length === 0) {

return errorMessage;

}

return `${errorMessage} Rollback errors: ${rollbackErrors.join("; ")}`;

}

xum/src/node/runtime/multiProjectRuntime.ts at main · coder/xum · GitHub

Uh oh!

Expand file tree

Breadcrumbs

multiProjectRuntime.ts

Latest commit

History

Breadcrumbs

multiProjectRuntime.ts

File metadata and controls