code-server/src/node/cli.ts at asher/enable-webkit · coder/code-server · GitHub

Repository navigation

History

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

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

727

728

729

730

731

732

733

734

735

736

737

738

739

740

741

742

743

744

745

746

747

748

749

750

751

752

753

754

755

756

757

758

759

760

761

762

763

764

765

766

767

768

769

770

771

772

773

774

775

776

777

778

779

780

781

782

783

784

785

786

787

788

789

790

791

792

793

794

795

796

797

798

799

800

801

802

803

804

805

806

807

808

809

810

811

812

813

814

815

816

817

818

819

820

821

822

823

824

825

826

827

828

829

830

831

832

833

834

835

836

837

838

839

840

841

842

843

844

845

846

847

848

849

850

851

852

853

854

855

856

857

858

859

860

861

862

863

864

865

866

867

868

869

870

871

872

873

874

875

876

877

878

879

880

881

882

883

884

885

886

887

888

889

890

891

892

893

894

895

896

897

898

899

900

901

902

903

904

905

906

907

908

909

910

911

912

913

914

915

916

917

918

919

920

921

922

923

924

925

926

927

928

929

930

931

932

933

934

935

936

937

938

939

940

941

942

943

944

945

946

947

948

949

950

951

952

953

954

955

956

957

958

959

960

961

962

963

964

965

966

967

968

969

970

971

972

973

974

975

976

977

978

979

980

981

982

983

984

985

986

987

988

989

990

991

992

993

994

995

996

997

998

999

1000

import { field, Level, logger } from "@coder/logger"

import * as crypto from "crypto"

import { promises as fs } from "fs"

import { load } from "js-yaml"

import * as path from "path"

import { generateCertificate, generatePassword, paths, splitOnFirstEquals } from "./util"

import { EditorSessionManagerClient } from "./vscodeSocket"

export enum Feature {

// No current experimental features!

Placeholder = "placeholder",

}

export enum AuthType {

Password = "password",

None = "none",

}

export class Optional<T> {

public constructor(public readonly value?: T) {}

}

export enum LogLevel {

Trace = "trace",

Debug = "debug",

Info = "info",

Warn = "warn",

Error = "error",

}

export class OptionalString extends Optional<string> {}

/**

* (VS) Code flags provided by the user.

export interface UserProvidedCodeArgs {

"disable-telemetry"?: boolean

force?: boolean

"user-data-dir"?: string

"enable-proposed-api"?: string[]

"extensions-dir"?: string

"builtin-extensions-dir"?: string

"install-extension"?: string[]

"uninstall-extension"?: string[]

"list-extensions"?: boolean

"locate-extension"?: string[]

"show-versions"?: boolean

category?: string

"github-auth"?: string

"disable-update-check"?: boolean

"disable-file-downloads"?: boolean

"disable-file-uploads"?: boolean

"disable-workspace-trust"?: boolean

"disable-getting-started-override"?: boolean

"disable-proxy"?: boolean

"reconnection-grace-time"?: string

"session-socket"?: string

"cookie-suffix"?: string

"link-protection-trusted-domains"?: string[]

// locale is used by both VS Code and code-server.

locale?: string

}

/**

* Arguments that the user explicitly provided on the command line. All

* arguments must be optional.

* For arguments with defaults see DefaultedArgs.

export interface UserProvidedArgs extends UserProvidedCodeArgs {

config?: string

auth?: AuthType

password?: string

"hashed-password"?: string

cert?: OptionalString

"cert-host"?: string

"cert-key"?: string

enable?: string[]

help?: boolean

host?: string

port?: number

json?: boolean

log?: LogLevel

open?: boolean

"bind-addr"?: string

socket?: string

"socket-fd"?: number

"socket-mode"?: string

"trusted-origins"?: string[]

version?: boolean

"proxy-domain"?: string[]

"skip-auth-preflight"?: boolean

"reuse-window"?: boolean

"new-window"?: boolean

"ignore-last-opened"?: boolean

verbose?: boolean

"app-name"?: string

"welcome-text"?: string

"abs-proxy-base-path"?: string

i18n?: string

"idle-timeout-seconds"?: number

"vscode-option"?: string[]

/* Positional arguments. */

_?: string[]

}

interface Option<T> {

type: T

/**

* Short flag for the option.

short?: string

/**

* Whether the option is a path and should be resolved.

path?: boolean

/**

* Description of the option. Leave blank to hide the option.

description?: string

/**

* If marked as deprecated, the option is marked as deprecated in help.

deprecated?: boolean

}

type OptionType<T> = T extends boolean

? "boolean"

: T extends OptionalString

? typeof OptionalString

: T extends LogLevel

? typeof LogLevel

: T extends AuthType

? typeof AuthType

: T extends number

? "number"

: T extends string

? "string"

: T extends string[]

? "string[]"

: "unknown"

export type Options<T> = {

[P in keyof T]: Option<OptionType<T[P]>>

}

export const options: Options<Required<UserProvidedArgs>> = {

auth: { type: AuthType, description: "The type of authentication to use." },

password: {

type: "string",

description: "The password for password authentication (can only be passed in via $PASSWORD or the config file).",

"hashed-password": {

type: "string",

description:

"The password hashed with argon2 for password authentication (can only be passed in via $HASHED_PASSWORD or the config file). \n" +

"Takes precedence over 'password'.",

cert: {

type: OptionalString,

path: true,

description: "Path to certificate. A self signed certificate is generated if none is provided.",

"cert-host": {

type: "string",

description: "Hostname to use when generating a self signed certificate.",

"cert-key": { type: "string", path: true, description: "Path to certificate key when using non-generated cert." },

"disable-telemetry": { type: "boolean", description: "Disable telemetry." },

"disable-update-check": {

type: "boolean",

description:

"Disable update check. Without this flag, code-server checks every 6 hours against the latest github release and \n" +

"then notifies you once every week that a new release is available.",

"session-socket": {

type: "string",

"cookie-suffix": {

type: "string",

description:

"Adds a suffix to the cookie. This can prevent a collision of cookies for subdomains, making them explixit. \n" +

"Without this flag, no suffix is used. This can also be set with CODE_SERVER_COOKIE_SUFFIX set to any string.",

"disable-file-downloads": {

type: "boolean",

description:

"Disable file downloads from Code. This can also be set with CS_DISABLE_FILE_DOWNLOADS set to 'true' or '1'.",

"disable-file-uploads": {

type: "boolean",

description: "Disable file uploads.",

"disable-workspace-trust": {

type: "boolean",

description: "Disable Workspace Trust feature. This switch only affects the current session.",

"disable-getting-started-override": {

type: "boolean",

description: "Disable the coder/coder override in the Help: Getting Started page.",

"disable-proxy": {

type: "boolean",

description: "Disable domain and path proxy routes.",

// --enable can be used to enable experimental features. These features

// provide no guarantees.

enable: { type: "string[]" },

help: { type: "boolean", short: "h", description: "Show this output." },

json: { type: "boolean" },

"link-protection-trusted-domains": {

type: "string[]",

description: "Links matching a trusted domain can be opened without link protection.",

locale: {

// The preferred way to set the locale is via the UI.

type: "string",

description: `

Set vscode display language and language to show on the login page, more info see

https://en.wikipedia.org/wiki/IETF_language_tag

open: { type: "boolean", description: "Open in browser on startup. Does not work remotely." },

"bind-addr": {

type: "string",

description: "Address to bind to in host:port. You can also use $PORT to override the port.",

config: {

type: "string",

description: "Path to yaml config file. Every flag maps directly to a key in the config file.",

// These two have been deprecated by bindAddr.

host: { type: "string", description: "" },

port: { type: "number", description: "" },

socket: { type: "string", path: true, description: "Path to a socket (bind-addr will be ignored)." },

"socket-fd": {

type: "number",

description: "File descriptor of a pre-bound, listening socket to use (for systemd socket activation).",

"socket-mode": { type: "string", description: "File mode of the socket." },

"trusted-origins": {

type: "string[]",

description:

"Disables authenticate origin check for trusted origin. Useful if not able to access reverse proxy configuration.",

version: { type: "boolean", short: "v", description: "Display version information." },

_: { type: "string[]" },

"user-data-dir": { type: "string", path: true, description: "Path to the user data directory." },

"extensions-dir": { type: "string", path: true, description: "Path to the extensions directory." },

"builtin-extensions-dir": { type: "string", path: true },

"list-extensions": { type: "boolean", description: "List installed VS Code extensions." },

force: { type: "boolean", description: "Avoid prompts when installing VS Code extensions." },

"locate-extension": { type: "string[]" },

category: { type: "string" },

"install-extension": {

type: "string[]",

description:

"Install or update a VS Code extension by id or vsix. The identifier of an extension is `${publisher}.${name}`.\n" +

"To install a specific version provide `@${version}`. For example: 'vscode.csharp@1.2.3'.",

"enable-proposed-api": {

type: "string[]",

description:

"Enable proposed API features for extensions. Can receive one or more extension IDs to enable individually.",

"uninstall-extension": { type: "string[]", description: "Uninstall a VS Code extension by id." },

"show-versions": { type: "boolean", description: "Show VS Code extension versions." },

"github-auth": {

type: "string",

description: "GitHub authentication token (can only be passed in via $GITHUB_TOKEN or the config file).",

"proxy-domain": { type: "string[]", description: "Domain used for proxying ports." },

"skip-auth-preflight": {

type: "boolean",

description: "Allows preflight requests through proxy without authentication.",

"ignore-last-opened": {

type: "boolean",

short: "e",

description: "Ignore the last opened directory or workspace in favor of an empty window.",

"new-window": {

type: "boolean",

short: "n",

description: "Force to open a new window.",

"reuse-window": {

type: "boolean",

short: "r",

description: "Force to open a file or folder in an already opened window.",

log: { type: LogLevel },

verbose: { type: "boolean", short: "vvv", description: "Enable verbose logging." },

"app-name": {

type: "string",

short: "an",

description:

"Will replace the {{app}} placeholder in any strings, which by default includes the title bar and welcome message",

"welcome-text": {

type: "string",

short: "w",

description: "Text to show on login page",

deprecated: true,

"abs-proxy-base-path": {

type: "string",

description: "The base path to prefix to all absproxy requests",

i18n: {

type: "string",

path: true,

description: "Path to JSON file with custom translations. Merges with default strings and supports all i18n keys.",

"idle-timeout-seconds": {

type: "number",

description: "Timeout in seconds to wait before shutting down when idle.",

"reconnection-grace-time": {

type: "string",

description:

"Override the reconnection grace time in seconds. Clients who disconnect for longer than this duration will need to \n" +

"reload the window. Defaults to 10800 (3 hours).",

"vscode-option": {

type: "string[]",

description:

"Pass an option straight through to the VS Code server as flag=value, or as a bare flag for a \n" +

"boolean. Repeatable; repeating the same flag builds an array. Use this to reach VS Code options \n" +

"code-server does not model itself, e.g. --vscode-option enable-sandbox --vscode-option agents=true.",

}

export const optionDescriptions = (opts: Partial<Options<Required<UserProvidedArgs>>> = options): string[] => {

const entries = Object.entries(opts).filter(([, v]) => !!v.description)

const widths = entries.reduce(

(prev, [k, v]) => ({

long: k.length > prev.long ? k.length : prev.long,

short: v.short && v.short.length > prev.short ? v.short.length : prev.short,

}),

{ short: 0, long: 0 },

)

return entries.map(([k, v]) => {

const help = `${" ".repeat(widths.short - (v.short ? v.short.length : 0))}${v.short ? `-${v.short}` : " "} --${k} `

return (

help +

v.description

?.trim()

.split(/\n/)

.map((line, i) => {

line = line.trim()

if (i === 0) {

return " ".repeat(widths.long - k.length) + (v.deprecated ? "(deprecated) " : "") + line

}

return " ".repeat(widths.long + widths.short + 6) + line

})

.join("\n") +

(typeof v.type === "object" ? ` [${Object.values(v.type).join(", ")}]` : "")

)

})

}

/**

* Parse arguments into UserProvidedArgs. This should not go beyond checking

* that arguments are valid types and have values when required.

export const parse = (

argv: string[],

opts?: {

configFile?: string

): UserProvidedArgs => {

const error = (msg: string): Error => {

if (opts?.configFile) {

msg = `error reading ${opts.configFile}: ${msg}`

}

return new Error(msg)

}

const args: UserProvidedArgs = {}

let ended = false

for (let i = 0; i < argv.length; ++i) {

const arg = argv[i]

// -- signals the end of option parsing.

if (!ended && arg === "--") {

ended = true

continue

}

// Options start with a dash and require a value if non-boolean.

if (!ended && arg.startsWith("-")) {

let key: keyof UserProvidedArgs | undefined

let value: string | undefined

if (arg.startsWith("--")) {

const split = splitOnFirstEquals(arg.replace(/^--/, ""))

key = split[0] as keyof UserProvidedArgs

value = split[1]

} else {

const short = arg.replace(/^-/, "")

const pair = Object.entries(options).find(([, v]) => v.short === short)

if (pair) {

key = pair[0] as keyof UserProvidedArgs

}

if (!key || !options[key]) {

throw error(`Unknown option ${arg}`)

}

if (key === "password" && !opts?.configFile) {

throw new Error("--password can only be set in the config file or passed in via $PASSWORD")

}

if (key === "hashed-password" && !opts?.configFile) {

throw new Error("--hashed-password can only be set in the config file or passed in via $HASHED_PASSWORD")

}

if (key === "github-auth" && !opts?.configFile) {

throw new Error("--github-auth can only be set in the config file or passed in via $GITHUB_TOKEN")

}

if (key === "idle-timeout-seconds" && Number(value) <= 60) {

throw new Error("--idle-timeout-seconds must be greater than 60 seconds.")

}

const option = options[key]

if (option.type === "boolean") {

;(args[key] as boolean) = true

continue

}

// Might already have a value if it was the --long=value format.

if (typeof value === "undefined") {

// A value is only valid if it doesn't look like an option.

value = argv[i + 1] && !argv[i + 1].startsWith("-") ? argv[++i] : undefined

}

if (!value && option.type === OptionalString) {

;(args[key] as OptionalString) = new OptionalString(value)

continue

} else if (!value) {

throw error(`--${key} requires a value`)

}

if (option.type === OptionalString && value === "false") {

continue

}

if (option.path) {

value = path.resolve(value)

}

switch (option.type) {

case "string":

;(args[key] as string) = value

break

case "string[]":

if (!args[key]) {

;(args[key] as string[]) = []

}

;(args[key] as string[]).push(value)

break

case "number":

;(args[key] as number) = parseInt(value, 10)

if (isNaN(args[key] as number)) {

throw error(`--${key} must be a number`)

}

break

case OptionalString:

;(args[key] as OptionalString) = new OptionalString(value)

break

default: {

if (!Object.values(option.type).includes(value)) {

throw error(`--${key} valid values: [${Object.values(option.type).join(", ")}]`)

}

;(args[key] as string) = value

break

}

continue

}

// Everything else goes into _.

if (typeof args._ === "undefined") {

args._ = []

}

args._.push(arg)

}

// If a cert was provided a key must also be provided.

if (args.cert && args.cert.value && !args["cert-key"]) {

throw new Error("--cert-key is missing")

}

logger.debug(() => [`parsed ${opts?.configFile ? "config" : "command line"}`, field("args", redactArgs(args))])

return args

}

/**

* Redact sensitive information from arguments for logging.

export const redactArgs = (args: UserProvidedArgs): UserProvidedArgs => {

return {

...args,

password: args.password ? "<redacted>" : undefined,

"hashed-password": args["hashed-password"] ? "<redacted>" : undefined,

"github-auth": args["github-auth"] ? "<redacted>" : undefined,

}

/**

* User-provided arguments with defaults. The distinction between user-provided

* args and defaulted args exists so we can tell the difference between end

* values and what the user actually provided on the command line.

export interface DefaultedArgs extends ConfigArgs {

auth: AuthType

cert?: {

value: string

}

host: string

port: number

"proxy-domain": string[]

verbose: boolean

usingEnvPassword: boolean

usingEnvHashedPassword: boolean

"extensions-dir": string

"user-data-dir": string

"session-socket": string

"app-name": string

/* Positional arguments. */

_: string[]

}

/**

* Take CLI and config arguments (optional) and return a single set of arguments

* with the defaults set. Arguments from the CLI are prioritized over config

* arguments.

export async function setDefaults(cliArgs: UserProvidedArgs, configArgs?: ConfigArgs): Promise<DefaultedArgs> {

const args = Object.assign({}, configArgs || {}, cliArgs)

if (!args["user-data-dir"]) {

args["user-data-dir"] = paths.data

}

if (!args["extensions-dir"]) {

args["extensions-dir"] = path.join(args["user-data-dir"], "extensions")

}

if (!args["session-socket"]) {

args["session-socket"] = defaultSessionSocket(args["user-data-dir"])

}

process.env.CODE_SERVER_SESSION_SOCKET = args["session-socket"]

// --verbose takes priority over --log and --log takes priority over the

// environment variable.

if (args.verbose) {

args.log = LogLevel.Trace

} else if (

!args.log &&

process.env.LOG_LEVEL &&

Object.values(LogLevel).includes(process.env.LOG_LEVEL as LogLevel)

) {

args.log = process.env.LOG_LEVEL as LogLevel

}

// Sync --log, --verbose, the environment variable, and logger level.

if (args.log) {

process.env.LOG_LEVEL = args.log

}

switch (args.log) {

case LogLevel.Trace:

logger.level = Level.Trace

args.verbose = true

break

case LogLevel.Debug:

logger.level = Level.Debug

args.verbose = false

break

case LogLevel.Info:

logger.level = Level.Info

args.verbose = false

break

case LogLevel.Warn:

logger.level = Level.Warn

args.verbose = false

break

case LogLevel.Error:

logger.level = Level.Error

args.verbose = false

break

}

// Default to using a password.

if (!args.auth) {

args.auth = AuthType.Password

}

const addr = bindAddrFromAllSources(configArgs || {}, cliArgs)

args.host = addr.host

args.port = addr.port

if (args.cert && !args.cert.value) {

const { cert, certKey } = await generateCertificate(args["cert-host"] || "localhost")

args.cert = {

value: cert,

}

args["cert-key"] = certKey

}

let usingEnvPassword = !!process.env.PASSWORD

if (process.env.PASSWORD) {

args.password = process.env.PASSWORD

}

if (process.env.CS_DISABLE_FILE_DOWNLOADS?.match(/^(1|true)$/)) {

args["disable-file-downloads"] = true

}

if (process.env.CS_DISABLE_GETTING_STARTED_OVERRIDE?.match(/^(1|true)$/)) {

args["disable-getting-started-override"] = true

}

if (process.env.CS_DISABLE_PROXY?.match(/^(1|true)$/)) {

args["disable-proxy"] = true

}

const usingEnvHashedPassword = !!process.env.HASHED_PASSWORD

if (process.env.HASHED_PASSWORD) {

args["hashed-password"] = process.env.HASHED_PASSWORD

usingEnvPassword = false

}

if (process.env.CODE_SERVER_COOKIE_SUFFIX) {

args["cookie-suffix"] = process.env.CODE_SERVER_COOKIE_SUFFIX

}

if (process.env.GITHUB_TOKEN) {

args["github-auth"] = process.env.GITHUB_TOKEN

}

if (process.env.CODE_SERVER_RECONNECTION_GRACE_TIME) {

args["reconnection-grace-time"] = process.env.CODE_SERVER_RECONNECTION_GRACE_TIME

}

// Space-separated, like NODE_OPTIONS. Appended to any flags rather than

// replacing them so the two can be combined.

if (process.env.VSCODE_OPTIONS) {

args["vscode-option"] = [

...(args["vscode-option"] ?? []),

...process.env.VSCODE_OPTIONS.split(/\s+/).filter((option) => option),

]

}

if (process.env.CODE_SERVER_IDLE_TIMEOUT_SECONDS) {

if (isNaN(Number(process.env.CODE_SERVER_IDLE_TIMEOUT_SECONDS))) {

logger.info("CODE_SERVER_IDLE_TIMEOUT_SECONDS must be a number")

}

if (Number(process.env.CODE_SERVER_IDLE_TIMEOUT_SECONDS) <= 60) {

throw new Error("--idle-timeout-seconds must be greater than 60 seconds.")

}

args["idle-timeout-seconds"] = Number(process.env.CODE_SERVER_IDLE_TIMEOUT_SECONDS)

}

// Ensure they're not readable by child processes.

delete process.env.PASSWORD

delete process.env.HASHED_PASSWORD

delete process.env.GITHUB_TOKEN

// Filter duplicate proxy domains and remove any leading `*.`.

const proxyDomains = new Set((args["proxy-domain"] || []).map((d) => d.replace(/^\*\./, "")))

const finalProxies = []

for (const proxyDomain of proxyDomains) {

if (!proxyDomain.includes("{{port}}")) {

finalProxies.push("{{port}}." + proxyDomain)

} else {

finalProxies.push(proxyDomain)

}

// all proxies are of format anyprefix-{{port}}-anysuffix.{{host}}, where {{host}} is optional

// e.g. code-8080.domain.tld would match for code-{{port}}.domain.tld and code-{{port}}.{{host}}

if (finalProxies.length > 0 && !process.env.VSCODE_PROXY_URI) {

process.env.VSCODE_PROXY_URI = `//${finalProxies[0]}`

}

args["proxy-domain"] = finalProxies

args["app-name"] ??= process.env.CODE_SERVER_APP_NAME || "code-server"

args._ = getResolvedPathsFromArgs(args)

return {

...args,

usingEnvPassword,

usingEnvHashedPassword,

} as DefaultedArgs // TODO: Technically no guarantee this is fulfilled.

}

/**

* The session socket to use when one was not given.

* Windows has no Unix sockets, so there it is a named pipe, which lives in its

* own namespace rather than on disk and so cannot be placed inside the user

* data directory. The name is derived from that directory anyway, so that two

* instances with separate data directories do not collide and a later

* invocation with the same one finds the first. Windows paths are compared

* without regard to case, so the name is folded before it is hashed; otherwise

* the same directory typed two ways would produce two pipes.

export function defaultSessionSocket(userDataDir: string, platform: NodeJS.Platform = process.platform): string {

if (platform !== "win32") {

return path.join(userDataDir, "code-server-ipc.sock")

}

const name = crypto.createHash("sha256").update(path.resolve(userDataDir).toLowerCase()).digest("hex").slice(0, 16)

return String.raw`\\.\pipe\code-server-ipc-${name}`

}

export function getResolvedPathsFromArgs(args: UserProvidedArgs): string[] {

return (args._ ?? []).map((p) => path.resolve(p))

}

/**

* Helper function to return the default config file.

* @param {string} password - Password passed in (usually from generatePassword())

* @returns The default config file:

* - bind-addr: 127.0.0.1:8080

* - auth: password

* - password: <password>

* - cert: false

export function defaultConfigFile(password: string): string {

return `bind-addr: 127.0.0.1:8080

auth: password

password: ${password}

cert: false

}

interface ConfigArgs extends UserProvidedArgs {

config: string

}

/**

* Reads the code-server yaml config file and returns it as Args.

* @param configPath Read the config from configPath instead of $CODE_SERVER_CONFIG or the default.

export async function readConfigFile(configPath?: string): Promise<ConfigArgs> {

if (!configPath) {

configPath = process.env.CODE_SERVER_CONFIG

if (!configPath) {

configPath = path.join(paths.config, "config.yaml")

}

await fs.mkdir(path.dirname(configPath), { recursive: true })

try {

const generatedPassword = await generatePassword()

await fs.writeFile(configPath, defaultConfigFile(generatedPassword), {

flag: "wx", // wx means to fail if the path exists.

})

logger.info(`Wrote default config file to ${configPath}`)

} catch (error: any) {

// EEXIST is fine; we don't want to overwrite existing configurations.

if (error.code !== "EEXIST") {

throw error

}

const configFile = await fs.readFile(configPath, "utf8")

return parseConfigFile(configFile, configPath)

}

/**

* parseConfigFile parses configFile into ConfigArgs.

* configPath is used as the filename in error messages

export function parseConfigFile(configFile: string, configPath: string): ConfigArgs {

if (!configFile) {

return { config: configPath }

}

const config = load(configFile, {

filename: configPath,

})

if (!config || typeof config === "string") {

throw new Error(`invalid config: ${config}`)

}

// We convert the config file into a set of flags.

// This is a temporary measure until we add a proper CLI library.

const configFileArgv = Object.entries(config)

.map(([optName, opt]) => {

if (opt === true) {

return `--${optName}`

} else if (Array.isArray(opt)) {

return opt.map((o) => `--${optName}=${o}`)

}

return `--${optName}=${opt}`

})

.flat()

const args = parse(configFileArgv, {

configFile: configPath,

})

return {

...args,

config: configPath,

}

function parseBindAddr(bindAddr: string): Addr {

const u = new URL(`http://${bindAddr}`)

return {

host: u.hostname,

// With the http scheme 80 will be dropped so assume it's 80 if missing.

// This means --bind-addr <addr> without a port will default to 80 as well

// and not the code-server default.

port: u.port ? parseInt(u.port, 10) : 80,

}

interface Addr {

host: string

port: number

}

/**

* This function creates the bind address

* using the CLI args.

export function bindAddrFromArgs(addr: Addr, args: UserProvidedArgs): Addr {

addr = { ...addr }

if (args["bind-addr"]) {

addr = parseBindAddr(args["bind-addr"])

}

if (process.env.CODE_SERVER_HOST) {

addr.host = process.env.CODE_SERVER_HOST

}

if (args.host) {

addr.host = args.host

}

if (process.env.PORT) {

addr.port = parseInt(process.env.PORT, 10)

}

if (args.port !== undefined) {

addr.port = args.port

}

return addr

}

function bindAddrFromAllSources(...argsConfig: UserProvidedArgs[]): Addr {

let addr: Addr = {

host: "localhost",

port: 8080,

}

for (const args of argsConfig) {

addr = bindAddrFromArgs(addr, args)

}

return addr

}

/**

* Determine if it looks like the user is trying to open a file or folder in an

* existing instance. The arguments here should be the arguments the user

* explicitly passed on the command line, *NOT DEFAULTS* or the configuration.

export const shouldOpenInExistingInstance = async (

args: UserProvidedArgs,

sessionSocket: string,

): Promise<string | undefined> => {

// Always use the existing instance if we're running from VS Code's terminal.

if (process.env.VSCODE_IPC_HOOK_CLI) {

logger.debug("Found VSCODE_IPC_HOOK_CLI")

return process.env.VSCODE_IPC_HOOK_CLI

}

const paths = getResolvedPathsFromArgs(args)

const client = new EditorSessionManagerClient(sessionSocket)

// If these flags are set then assume the user is trying to open in an

// existing instance since these flags have no effect otherwise. That means

// if there is no existing instance we should error rather than falling back

// to spawning code-server normally.

const openInFlagCount = ["reuse-window", "new-window"].reduce((prev, cur) => {

return args[cur as keyof UserProvidedArgs] ? prev + 1 : prev

}, 0)

if (openInFlagCount > 0) {

logger.debug("Found --reuse-window or --new-window")

const socketPath = await client.getConnectedSocketPath(paths[0])

if (!socketPath) {

throw new Error(`No opened code-server instances found to handle ${paths[0]}`)

}

return socketPath

}

// It's possible the user is trying to spawn another instance of code-server.

// 1. Check if any unrelated flags are set (this should only run when

// code-server is invoked exactly like this: `code-server my-file`).

// 2. That a file or directory was passed.

// 3. That the socket is active.

// 4. That an instance exists to handle the path (implied by #3).

if (Object.keys(args).length === 1 && typeof args._ !== "undefined" && args._.length > 0) {

if (!(await client.canConnect())) {

return undefined

}

const socketPath = await client.getConnectedSocketPath(paths[0])

if (socketPath) {

logger.debug("Found existing code-server socket")

return socketPath

}

return undefined

}

/**

* Arguments for running Code's server.

* A subset of ../../lib/vscode/src/vs/server/node/serverEnvironmentService.ts:90

export interface CodeArgs extends UserProvidedCodeArgs {

"accept-server-license-terms"?: boolean

"connection-token"?: string

help: boolean

port?: string

version: boolean

"without-connection-token"?: boolean

"without-browser-env-var"?: boolean

compatibility?: string

log?: string[]

}

/**

* Expand --vscode-option entries into VS Code server arguments.

* An entry is `flag=value`, or a bare `flag` meaning true. A leading `--` on

* the flag is optional, so both spellings people reach for work. Repeating a

* flag collects the values into an array, since several VS Code options take

* one.

* `true` and `false` become booleans rather than strings. VS Code tests these

* flags for truthiness and the string "false" is truthy, so passing it along

* verbatim would quietly do the opposite of what was asked.

export const parseVscodeOptions = (entries: string[]): Record<string, string | boolean | string[]> => {

const parsed: Record<string, string | boolean | string[]> = {}

for (const entry of entries) {

const [flag, rawValue] = splitOnFirstEquals(entry.replace(/^--/, ""))

if (!flag) {

throw new Error(`--vscode-option requires a flag name (got "${entry}")`)

}

const value: string | boolean =

typeof rawValue === "undefined" || rawValue === "true" ? true : rawValue === "false" ? false : rawValue

const existing = parsed[flag]

if (typeof existing === "undefined") {

parsed[flag] = value

} else if (Array.isArray(existing)) {

existing.push(String(value))

} else {

parsed[flag] = [String(existing), String(value)]

}

return parsed

}

/**

* Convert our arguments to equivalent VS Code server arguments.

* Does not add any extra arguments.

export const toCodeArgs = async (args: DefaultedArgs): Promise<CodeArgs> => {

// The passthrough option is ours; VS Code has no idea what it is.

const { "vscode-option": vscodeOptions, ...rest } = args

return {

...rest,

/** Type casting. */

View remainder of file in raw view

code-server/src/node/cli.ts at asher/enable-webkit · coder/code-server · GitHub

Repository navigation

Expand file tree

Breadcrumbs

cli.ts

Latest commit

History

Breadcrumbs

cli.ts

File metadata and controls