-
-
Notifications
You must be signed in to change notification settings - Fork 80.7k
Expand file tree
/
Copy pathupdate-global.ts
More file actions
1009 lines (942 loc) · 32.1 KB
/
Copy pathupdate-global.ts
File metadata and controls
1009 lines (942 loc) · 32.1 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
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
// Runs package-manager based global update and install flows.
import fsSync from "node:fs";
import fs from "node:fs/promises";
import os from "node:os";
import path from "node:path";
import { normalizeLowercaseStringOrEmpty } from "@openclaw/normalization-core/string-coerce";
import { BUNDLED_RUNTIME_SIDECAR_PATHS } from "../plugins/runtime-sidecar-paths.js";
import { pathExists } from "../utils.js";
import {
applyNpmFreshnessBypassEnv,
applyPosixNpmScriptShellEnv,
createNpmFreshnessBypassArgs,
} from "./npm-install-env.js";
import {
collectPackageDistInventory,
PACKAGE_DIST_INVENTORY_RELATIVE_PATH,
readPackageDistInventoryIfPresent,
} from "./package-dist-inventory.js";
import { readPackageVersion } from "./package-json.js";
import { applyPathPrepend } from "./path-prepend.js";
import { parseSemver } from "./runtime-guard.js";
/** Supported package managers for OpenClaw global install and update flows. */
export type GlobalInstallManager = "npm" | "pnpm" | "bun";
/** Runs package-manager commands with timeout and environment control. */
export type CommandRunner = (
argv: string[],
options: { timeoutMs: number; cwd?: string; env?: NodeJS.ProcessEnv },
) => Promise<{
stdout: string;
stderr: string;
code: number | null;
signal?: NodeJS.Signals | null;
killed?: boolean;
termination?: "exit" | "timeout" | "no-output-timeout" | "signal";
}>;
type ResolvedGlobalInstallCommand = {
manager: GlobalInstallManager;
command: string;
};
/**
* Resolved package-manager command plus the root paths used for install,
* verification, and staged package swaps.
*/
export type ResolvedGlobalInstallTarget = ResolvedGlobalInstallCommand & {
globalRoot: string | null;
packageRoot: string | null;
directNodeModulesRoot?: boolean;
};
const PRIMARY_PACKAGE_NAME = "openclaw";
const ALL_PACKAGE_NAMES = [PRIMARY_PACKAGE_NAME] as const;
const GLOBAL_RENAME_PREFIX = ".";
/** npm-compatible spec used when the user asks to install the moving main branch. */
export const OPENCLAW_MAIN_PACKAGE_SPEC = "github:openclaw/openclaw#main";
const COREPACK_ENABLE_DOWNLOAD_PROMPT_DEFAULT = "0";
const NPM_GLOBAL_INSTALL_QUIET_FLAGS = ["--no-fund", "--no-audit", "--loglevel=error"] as const;
const PNPM_OPENCLAW_BUILD_ALLOWLIST_FLAG = `--allow-build=${PRIMARY_PACKAGE_NAME}`;
const FIRST_PACKAGED_DIST_INVENTORY_VERSION = { major: 2026, minor: 4, patch: 15 };
const OMITTED_PRIVATE_QA_BUNDLED_PLUGIN_ROOTS = new Set([
"dist/extensions/qa-channel",
"dist/extensions/qa-lab",
"dist/extensions/qa-matrix",
]);
/** npm prefix layout paths needed to install, stage, and expose global bins. */
export type NpmGlobalPrefixLayout = {
prefix: string;
globalRoot: string;
binDir: string;
};
function normalizePackageTarget(value: string): string {
return value.trim();
}
function normalizePackageVersionForComparison(value: string | null | undefined): string | null {
const trimmed = value?.trim();
if (!trimmed) {
return null;
}
return trimmed.replace(/^[vV](?=\d)/, "");
}
/** Returns true when a user target requests the moving main-branch package spec. */
export function isMainPackageTarget(value: string): boolean {
return normalizeLowercaseStringOrEmpty(normalizePackageTarget(value)) === "main";
}
/**
* Returns true for targets that should pass through as package-manager specs
* rather than being treated as registry dist-tags.
*/
export function isExplicitPackageInstallSpec(value: string): boolean {
const trimmed = normalizePackageTarget(value);
if (!trimmed) {
return false;
}
return (
/\.(?:tgz|tar\.gz)$/iu.test(trimmed) ||
trimmed.includes("://") ||
trimmed.includes("#") ||
/^(?:file|github|git\+ssh|git\+https|git\+http|git\+file|npm):/i.test(trimmed)
);
}
function stripPrimaryPackageAlias(spec: string): string {
const normalized = normalizePackageTarget(spec);
const prefix = `${PRIMARY_PACKAGE_NAME}@`;
return normalized.toLowerCase().startsWith(prefix)
? normalized.slice(prefix.length).trim()
: normalized;
}
function isPnpmOpenClawSourceInstallSpec(spec: string): boolean {
const target = stripPrimaryPackageAlias(spec);
return (
/^github:/i.test(target) ||
/^git\+(?:ssh|https|http|file):/i.test(target) ||
/^git:/i.test(target)
);
}
/**
* Extracts a pinned installed version from package specs like `openclaw@1.2.3`.
* Moving tags, URLs, git refs, and aliases return null because they cannot be
* compared reliably after install.
*/
export function resolveExpectedInstalledVersionFromSpec(
packageName: string,
spec: string,
): string | null {
const normalizedPackageName = packageName.trim();
const normalizedSpec = normalizePackageTarget(spec);
if (!normalizedPackageName || !normalizedSpec.startsWith(`${normalizedPackageName}@`)) {
return null;
}
const rawVersion = normalizedSpec.slice(normalizedPackageName.length + 1).trim();
if (
!rawVersion ||
rawVersion.includes("/") ||
rawVersion.includes(":") ||
rawVersion.includes("#") ||
/^(latest|beta|next|main)$/i.test(rawVersion)
) {
return null;
}
return normalizePackageVersionForComparison(rawVersion);
}
/**
* Verifies that a global package root looks like a packaged OpenClaw install
* and, when supplied, matches the expected concrete version.
*/
export async function collectInstalledGlobalPackageErrors(params: {
packageRoot: string;
expectedVersion?: string | null;
}): Promise<string[]> {
const errors: string[] = [];
errors.push(...(await collectSourceCheckoutInstallErrors(params.packageRoot)));
const installedVersion = await readPackageVersion(params.packageRoot);
const expectedComparable = normalizePackageVersionForComparison(params.expectedVersion);
const installedComparable = normalizePackageVersionForComparison(installedVersion);
if (expectedComparable && installedComparable !== expectedComparable) {
errors.push(
`expected installed version ${expectedComparable}, found ${installedComparable ?? "<missing>"}`,
);
}
errors.push(
...(await collectInstalledPackageDistErrors({
packageRoot: params.packageRoot,
installedVersion,
expectedVersion: params.expectedVersion,
})),
);
return errors;
}
async function collectSourceCheckoutInstallErrors(packageRoot: string): Promise<string[]> {
const realPackageRoot = await tryRealpath(packageRoot);
const hasSourceCheckoutShape =
((await pathExists(path.join(realPackageRoot, ".git"))) ||
(await pathExists(path.join(realPackageRoot, "pnpm-workspace.yaml")))) &&
(await pathExists(path.join(realPackageRoot, "src"))) &&
(await pathExists(path.join(realPackageRoot, "extensions")));
return hasSourceCheckoutShape
? [`global package root resolves to source checkout: ${realPackageRoot}`]
: [];
}
function shouldRequirePackagedDistInventory(version: string | null | undefined): boolean {
const parsed = parseSemver(version ?? null);
if (!parsed) {
return false;
}
if (parsed.major !== FIRST_PACKAGED_DIST_INVENTORY_VERSION.major) {
return parsed.major > FIRST_PACKAGED_DIST_INVENTORY_VERSION.major;
}
if (parsed.minor !== FIRST_PACKAGED_DIST_INVENTORY_VERSION.minor) {
return parsed.minor > FIRST_PACKAGED_DIST_INVENTORY_VERSION.minor;
}
return parsed.patch >= FIRST_PACKAGED_DIST_INVENTORY_VERSION.patch;
}
async function collectInstalledPackageDistErrors(params: {
packageRoot: string;
installedVersion: string | null;
expectedVersion?: string | null;
}): Promise<string[]> {
const criticalPaths = await collectCriticalInstalledPackageDistPaths(params.packageRoot);
let inventoryFiles: string[] | null = null;
let inventoryError: string | null = null;
try {
inventoryFiles = await readPackageDistInventoryIfPresent(params.packageRoot);
} catch {
inventoryError = `invalid package dist inventory ${PACKAGE_DIST_INVENTORY_RELATIVE_PATH}`;
}
if (inventoryFiles !== null) {
const actualFiles = await collectPackageDistInventory(params.packageRoot);
const inventoryErrors = await collectInstalledPathErrors({
packageRoot: params.packageRoot,
expectedFiles: inventoryFiles,
actualFiles,
missingMessage: (relativePath) => `missing packaged dist file ${relativePath}`,
unexpectedMessage: (relativePath) => `unexpected packaged dist file ${relativePath}`,
});
const inventorySet = new Set(inventoryFiles);
const supplementalCriticalPaths = criticalPaths.filter(
(relativePath) => !inventorySet.has(relativePath),
);
if (supplementalCriticalPaths.length === 0) {
return inventoryErrors;
}
return [
...inventoryErrors,
...(await collectInstalledPathErrors({
packageRoot: params.packageRoot,
expectedFiles: supplementalCriticalPaths,
actualFiles,
missingMessage: (relativePath) => `missing bundled runtime sidecar ${relativePath}`,
})),
];
}
const criticalErrors = await collectInstalledPathErrors({
packageRoot: params.packageRoot,
expectedFiles: await collectLegacyInstalledPackageDistPaths(params.packageRoot),
actualFiles: null,
missingMessage: (relativePath) => `missing bundled runtime sidecar ${relativePath}`,
});
if (inventoryError) {
return [inventoryError, ...criticalErrors];
}
if (
shouldRequirePackagedDistInventory(params.installedVersion) ||
shouldRequirePackagedDistInventory(params.expectedVersion)
) {
return [
`missing package dist inventory ${PACKAGE_DIST_INVENTORY_RELATIVE_PATH}`,
...criticalErrors,
];
}
return criticalErrors;
}
async function collectLegacyInstalledPackageDistPaths(packageRoot: string): Promise<string[]> {
return await collectCriticalInstalledPackageDistPaths(packageRoot);
}
async function collectCriticalInstalledPackageDistPaths(packageRoot: string): Promise<string[]> {
const expectedFiles = new Set<string>();
await Promise.all(
BUNDLED_RUNTIME_SIDECAR_PATHS.map(async (relativePath) => {
const pluginRoot = resolveBundledPluginRoot(relativePath);
if (pluginRoot === null) {
return;
}
if (OMITTED_PRIVATE_QA_BUNDLED_PLUGIN_ROOTS.has(pluginRoot)) {
return;
}
if (
(await pathExists(path.join(packageRoot, pluginRoot, "package.json"))) ||
(await pathExists(path.join(packageRoot, pluginRoot, "openclaw.plugin.json")))
) {
expectedFiles.add(relativePath);
}
}),
);
return [...expectedFiles].toSorted((left, right) => left.localeCompare(right));
}
function resolveBundledPluginRoot(relativePath: string): string | null {
const match = /^dist\/extensions\/[^/]+/u.exec(relativePath);
return match ? match[0] : null;
}
async function collectInstalledPathErrors(params: {
packageRoot: string;
expectedFiles: string[];
actualFiles: string[] | null;
missingMessage: (relativePath: string) => string;
unexpectedMessage?: ((relativePath: string) => string) | undefined;
}): Promise<string[]> {
const errors: string[] = [];
const actualSet = params.actualFiles ? new Set(params.actualFiles) : null;
for (const relativePath of params.expectedFiles) {
const exists =
actualSet !== null
? actualSet.has(relativePath)
: await pathExists(path.join(params.packageRoot, relativePath));
if (!exists) {
errors.push(params.missingMessage(relativePath));
}
}
if (actualSet !== null && params.unexpectedMessage) {
const expectedSet = new Set(params.expectedFiles);
for (const relativePath of params.actualFiles ?? []) {
if (!expectedSet.has(relativePath)) {
errors.push(params.unexpectedMessage(relativePath));
}
}
}
return errors;
}
/**
* Returns true when a target can be resolved through npm registry metadata.
* Explicit tarball, URL, git, and main-branch specs bypass registry lookup.
*/
export function canResolveRegistryVersionForPackageTarget(value: string): boolean {
const trimmed = normalizePackageTarget(value);
if (!trimmed) {
return true;
}
return !isMainPackageTarget(trimmed) && !isExplicitPackageInstallSpec(trimmed);
}
async function resolvePortableGitPathPrepend(): Promise<string[]> {
if (process.platform !== "win32") {
return [];
}
const localAppData = process.env.LOCALAPPDATA?.trim();
if (!localAppData) {
return [];
}
const portableGitRoot = path.join(localAppData, "OpenClaw", "deps", "portable-git");
const candidates = [
path.join(portableGitRoot, "mingw64", "bin"),
path.join(portableGitRoot, "usr", "bin"),
path.join(portableGitRoot, "cmd"),
path.join(portableGitRoot, "bin"),
];
const existing: string[] = [];
for (const candidate of candidates) {
if (await pathExists(candidate)) {
existing.push(candidate);
}
}
return existing;
}
function applyWindowsPackageInstallEnv(env: Record<string, string>) {
if (process.platform !== "win32") {
return;
}
env.NPM_CONFIG_UPDATE_NOTIFIER = "false";
env.NPM_CONFIG_FUND = "false";
env.NPM_CONFIG_AUDIT = "false";
env.NODE_LLAMA_CPP_SKIP_DOWNLOAD = "1";
}
function applyCorepackDownloadPromptEnv(env: Record<string, string>) {
const current = env.COREPACK_ENABLE_DOWNLOAD_PROMPT?.trim();
if (!current) {
env.COREPACK_ENABLE_DOWNLOAD_PROMPT = COREPACK_ENABLE_DOWNLOAD_PROMPT_DEFAULT;
}
}
/**
* Converts a user tag or explicit package target into the package-manager spec
* used by global install commands.
*/
export function resolveGlobalInstallSpec(params: {
packageName: string;
tag: string;
env?: NodeJS.ProcessEnv;
}): string {
const override =
params.env?.OPENCLAW_UPDATE_PACKAGE_SPEC?.trim() ||
process.env.OPENCLAW_UPDATE_PACKAGE_SPEC?.trim();
if (override) {
return override;
}
const target = normalizePackageTarget(params.tag);
if (isMainPackageTarget(target)) {
return OPENCLAW_MAIN_PACKAGE_SPEC;
}
if (isExplicitPackageInstallSpec(target)) {
return target;
}
return `${params.packageName}@${target}`;
}
/**
* Builds the package-manager environment used for global installs.
* It keeps caller env values, adds platform-specific install defaults, and
* disables npm/corepack prompts that would otherwise hang unattended updates.
*/
export async function createGlobalInstallEnv(
env?: NodeJS.ProcessEnv,
): Promise<NodeJS.ProcessEnv | undefined> {
const pathPrepend = await resolvePortableGitPathPrepend();
const sourceEnv = env ?? process.env;
const merged = Object.fromEntries(
Object.entries(sourceEnv)
.filter(([, value]) => value != null)
.map(([key, value]) => [key, String(value)]),
) as Record<string, string>;
applyPathPrepend(merged, pathPrepend);
applyWindowsPackageInstallEnv(merged);
applyCorepackDownloadPromptEnv(merged);
applyNpmFreshnessBypassEnv(merged);
applyPosixNpmScriptShellEnv(merged);
return merged;
}
async function tryRealpath(targetPath: string): Promise<string> {
try {
return await fs.realpath(targetPath);
} catch {
return path.resolve(targetPath);
}
}
function resolveBunGlobalRoot(): string {
const bunInstall = process.env.BUN_INSTALL?.trim() || path.join(os.homedir(), ".bun");
return path.join(bunInstall, "install", "global", "node_modules");
}
function inferNpmPrefixFromPackageRoot(pkgRoot?: string | null): string | null {
const trimmed = pkgRoot?.trim();
if (!trimmed) {
return null;
}
const normalized = path.resolve(trimmed);
const nodeModulesDir = path.dirname(normalized);
if (path.basename(nodeModulesDir) !== "node_modules") {
return null;
}
const parentDir = path.dirname(nodeModulesDir);
if (path.basename(parentDir) === "lib") {
return path.dirname(parentDir);
}
if (
process.platform === "win32" &&
normalizeLowercaseStringOrEmpty(path.basename(parentDir)) === "npm"
) {
return parentDir;
}
return null;
}
/**
* Infers npm prefix, package root, and bin paths from an npm global root.
* Direct `node_modules` roots are accepted only when the caller opts into them.
*/
export function resolveNpmGlobalPrefixLayoutFromGlobalRoot(
globalRoot?: string | null,
options: { allowDirectNodeModulesRoot?: boolean } = {},
): NpmGlobalPrefixLayout | null {
const trimmed = globalRoot?.trim();
if (!trimmed) {
return null;
}
const normalized = path.resolve(trimmed);
if (path.basename(normalized) !== "node_modules") {
return null;
}
const parentDir = path.dirname(normalized);
if (path.basename(parentDir) === "lib") {
const prefix = path.dirname(parentDir);
return {
prefix,
globalRoot: normalized,
binDir: path.join(prefix, "bin"),
};
}
if (process.platform === "win32") {
return {
prefix: parentDir,
globalRoot: normalized,
binDir: parentDir,
};
}
if (options.allowDirectNodeModulesRoot) {
return {
prefix: parentDir,
globalRoot: normalized,
binDir: path.join(normalized, ".bin"),
};
}
return null;
}
/**
* Derives npm's global package and bin directories from a prefix root.
* Used for staged installs where OpenClaw creates the prefix itself.
*/
export function resolveNpmGlobalPrefixLayoutFromPrefix(prefix: string): NpmGlobalPrefixLayout {
const resolvedPrefix = path.resolve(prefix);
if (process.platform === "win32") {
return {
prefix: resolvedPrefix,
globalRoot: path.join(resolvedPrefix, "node_modules"),
binDir: resolvedPrefix,
};
}
return {
prefix: resolvedPrefix,
globalRoot: path.join(resolvedPrefix, "lib", "node_modules"),
binDir: path.join(resolvedPrefix, "bin"),
};
}
function splitNormalizedPathParts(value: string): string[] {
return path
.resolve(value)
.split(path.sep)
.filter(Boolean)
.map((part) => normalizeLowercaseStringOrEmpty(part));
}
function isNodeVersionPathPart(value: string | undefined): boolean {
return value !== undefined && /^v?\d+(?:\.\d+){0,3}(?:[-+][0-9a-z.-]+)?$/u.test(value);
}
function hasPathSequence(parts: readonly string[], sequence: readonly string[]): boolean {
const lastStart = parts.length - sequence.length;
for (let index = 0; index <= lastStart; index += 1) {
if (sequence.every((part, offset) => parts[index + offset] === part)) {
return true;
}
}
return false;
}
function isEphemeralNodeManagedNpmPrefix(prefix: string): boolean {
const parts = splitNormalizedPathParts(prefix);
const basename = parts.at(-1);
const parent = parts.at(-2);
const grandparent = parts.at(-3);
if (isNodeVersionPathPart(basename) && grandparent === "cellar") {
return true;
}
if (
isNodeVersionPathPart(basename) &&
(hasPathSequence(parts, [".nvm", "versions", "node"]) ||
hasPathSequence(parts, ["n", "versions", "node"]) ||
hasPathSequence(parts, [".asdf", "installs", "nodejs"]) ||
hasPathSequence(parts, [".volta", "tools", "image", "node"]))
) {
return true;
}
return (
basename === "installation" && isNodeVersionPathPart(parent) && grandparent === "node-versions"
);
}
function resolveNpmCommandBesidePackageRoot(pkgRoot?: string | null): string | null {
const prefix = inferNpmPrefixFromPackageRoot(pkgRoot);
if (!prefix) {
return null;
}
const candidate =
process.platform === "win32" ? path.join(prefix, "npm.cmd") : path.join(prefix, "bin", "npm");
return fsSync.existsSync(candidate) ? candidate : null;
}
function resolvePreferredNpmCommand(pkgRoot?: string | null): string | null {
const prefix = inferNpmPrefixFromPackageRoot(pkgRoot);
if (prefix && isEphemeralNodeManagedNpmPrefix(prefix)) {
return null;
}
return resolveNpmCommandBesidePackageRoot(pkgRoot);
}
function inferGlobalRootFromPackageRoot(pkgRoot?: string | null): string | null {
const trimmed = pkgRoot?.trim();
if (!trimmed) {
return null;
}
const normalized = path.resolve(trimmed);
const globalRoot = path.dirname(normalized);
return path.basename(globalRoot) === "node_modules" ? globalRoot : null;
}
function resolvePackageRootFromGlobalRoot(params: {
globalRoot: string;
packageName?: string;
}): string {
const packageName = params.packageName?.trim() || PRIMARY_PACKAGE_NAME;
const parts = packageName.split("/");
const hasSafeSegments =
parts.length > 0 &&
parts.length <= 2 &&
parts.every(
(part) => part.length > 0 && part !== "." && part !== ".." && !part.includes("\\"),
) &&
(parts.length === 1 || parts[0]?.startsWith("@"));
return path.join(params.globalRoot, ...(hasSafeSegments ? parts : [PRIMARY_PACKAGE_NAME]));
}
function isDirectNpmNodeModulesRoot(globalRoot: string | null): boolean {
return (
globalRoot !== null &&
resolveNpmGlobalPrefixLayoutFromGlobalRoot(globalRoot) === null &&
resolveNpmGlobalPrefixLayoutFromGlobalRoot(globalRoot, {
allowDirectNodeModulesRoot: true,
}) !== null
);
}
function inferBunGlobalRootFromPackageRoot(pkgRoot?: string | null): string | null {
const directGlobalRoot = inferGlobalRootFromPackageRoot(pkgRoot);
if (!directGlobalRoot) {
return null;
}
return path.resolve(directGlobalRoot) === path.resolve(resolveBunGlobalRoot())
? directGlobalRoot
: null;
}
function inferPnpmGlobalRootFromPackageRoot(pkgRoot?: string | null): string | null {
const directGlobalRoot = inferGlobalRootFromPackageRoot(pkgRoot);
if (resolvePnpmGlobalDirFromGlobalRoot(directGlobalRoot)) {
return directGlobalRoot;
}
const trimmed = pkgRoot?.trim();
if (!trimmed) {
return null;
}
const normalized = path.resolve(trimmed);
const parts = normalized.split(path.sep);
const pnpmIndex = parts.lastIndexOf(".pnpm");
if (pnpmIndex <= 0) {
return null;
}
if (parts[pnpmIndex + 2] !== "node_modules") {
return null;
}
const layoutDir = parts.slice(0, pnpmIndex).join(path.sep) || path.sep;
const globalRoot =
path.basename(layoutDir) === "node_modules" ? layoutDir : path.join(layoutDir, "node_modules");
return resolvePnpmGlobalDirFromGlobalRoot(globalRoot) ? globalRoot : null;
}
/**
* Resolves pnpm's global-dir from its active `node_modules` root.
* Versioned pnpm layouts put packages under `<globalDir>/<version>/node_modules`.
*/
export function resolvePnpmGlobalDirFromGlobalRoot(globalRoot?: string | null): string | null {
const trimmed = globalRoot?.trim();
if (!trimmed) {
return null;
}
const normalized = path.resolve(trimmed);
if (path.basename(normalized) !== "node_modules") {
return null;
}
const layoutDir = path.dirname(normalized);
return /^\d+$/u.test(path.basename(layoutDir)) ? path.dirname(layoutDir) : null;
}
async function isPnpmGlobalPackageRoot(pkgRoot?: string | null): Promise<boolean> {
const globalRoot = inferPnpmGlobalRootFromPackageRoot(pkgRoot);
if (!globalRoot) {
return false;
}
const layoutDir = path.dirname(globalRoot);
if (!(await pathExists(path.join(globalRoot, ".modules.yaml")))) {
return false;
}
return (
(await pathExists(path.join(layoutDir, "pnpm-lock.yaml"))) ||
(await pathExists(path.join(layoutDir, "package.json")))
);
}
function resolvePreferredGlobalManagerCommand(
manager: GlobalInstallManager,
pkgRoot?: string | null,
): string {
if (manager !== "npm") {
return manager;
}
return resolvePreferredNpmCommand(pkgRoot) ?? manager;
}
/**
* Resolves the package-manager command to execute for a global install.
* npm may use the npm binary beside an existing package root when available.
*/
export function resolveGlobalInstallCommand(
manager: GlobalInstallManager,
pkgRoot?: string | null,
): ResolvedGlobalInstallCommand {
return {
manager,
command: resolvePreferredGlobalManagerCommand(manager, pkgRoot),
};
}
function normalizeGlobalInstallCommand(
managerOrCommand: GlobalInstallManager | ResolvedGlobalInstallCommand,
pkgRoot?: string | null,
): ResolvedGlobalInstallCommand {
return typeof managerOrCommand === "string"
? resolveGlobalInstallCommand(managerOrCommand, pkgRoot)
: managerOrCommand;
}
function resolveInstallCommandForManager(
managerOrCommand: GlobalInstallManager | ResolvedGlobalInstallCommand,
manager: GlobalInstallManager,
pkgRoot?: string | null,
): ResolvedGlobalInstallCommand {
const normalized = normalizeGlobalInstallCommand(managerOrCommand, pkgRoot);
return normalized.manager === manager
? normalized
: resolveGlobalInstallCommand(manager, pkgRoot);
}
/**
* Reads the global `node_modules` root for a package manager command.
* Bun uses its deterministic install root because it has no `root -g` command.
*/
export async function resolveGlobalRoot(
managerOrCommand: GlobalInstallManager | ResolvedGlobalInstallCommand,
runCommand: CommandRunner,
timeoutMs: number,
pkgRoot?: string | null,
): Promise<string | null> {
const resolved = normalizeGlobalInstallCommand(managerOrCommand, pkgRoot);
if (resolved.manager === "bun") {
return resolveBunGlobalRoot();
}
const argv = [resolved.command, "root", "-g"];
const res = await runCommand(argv, { timeoutMs }).catch(() => null);
if (!res || res.code !== 0) {
return null;
}
const root = res.stdout.trim();
return root || null;
}
/**
* Resolves the effective global install target, honoring an existing package
* root when requested and detecting pnpm or bun layouts before command probes.
*/
export async function resolveGlobalInstallTarget(params: {
manager: GlobalInstallManager | ResolvedGlobalInstallCommand;
runCommand: CommandRunner;
timeoutMs: number;
pkgRoot?: string | null;
honorPackageRoot?: boolean;
packageName?: string;
}): Promise<ResolvedGlobalInstallTarget> {
const honoredPackageRootGlobalRoot = params.honorPackageRoot
? inferGlobalRootFromPackageRoot(params.pkgRoot)
: null;
const pnpmPackageRootGlobalRoot = (await isPnpmGlobalPackageRoot(params.pkgRoot))
? inferPnpmGlobalRootFromPackageRoot(params.pkgRoot)
: null;
const bunPackageRootGlobalRoot = inferBunGlobalRootFromPackageRoot(params.pkgRoot);
const honoredDirectNpmRoot =
pnpmPackageRootGlobalRoot === null &&
bunPackageRootGlobalRoot === null &&
isDirectNpmNodeModulesRoot(honoredPackageRootGlobalRoot);
const command = bunPackageRootGlobalRoot
? resolveInstallCommandForManager(params.manager, "bun", params.pkgRoot)
: pnpmPackageRootGlobalRoot
? resolveInstallCommandForManager(params.manager, "pnpm", params.pkgRoot)
: honoredDirectNpmRoot
? resolveInstallCommandForManager(params.manager, "npm", params.pkgRoot)
: normalizeGlobalInstallCommand(params.manager, params.pkgRoot);
const globalRoot = await resolveGlobalRoot(
command,
params.runCommand,
params.timeoutMs,
params.pkgRoot,
);
const pkgRootGlobalRoot = command.manager === "pnpm" ? pnpmPackageRootGlobalRoot : null;
const targetGlobalRoot =
(command.manager === "bun" ? bunPackageRootGlobalRoot : null) ??
pkgRootGlobalRoot ??
(command.manager === "npm" ? honoredPackageRootGlobalRoot : null) ??
globalRoot;
return {
...command,
globalRoot: targetGlobalRoot,
packageRoot: targetGlobalRoot
? resolvePackageRootFromGlobalRoot({
globalRoot: targetGlobalRoot,
packageName: params.packageName,
})
: null,
...(honoredPackageRootGlobalRoot &&
targetGlobalRoot === honoredPackageRootGlobalRoot &&
honoredDirectNpmRoot
? { directNodeModulesRoot: true }
: {}),
};
}
/**
* Identifies which global package manager owns an existing package root.
* Command probes are checked first, then pnpm/bun layout fingerprints.
*/
export async function detectGlobalInstallManagerForRoot(
runCommand: CommandRunner,
pkgRoot: string,
timeoutMs: number,
): Promise<GlobalInstallManager | null> {
const pkgReal = await tryRealpath(pkgRoot);
const candidates: Array<{
manager: "npm" | "pnpm";
argv: string[];
}> = [
{ manager: "npm", argv: ["npm", "root", "-g"] },
{ manager: "pnpm", argv: ["pnpm", "root", "-g"] },
];
for (const { manager, argv } of candidates) {
const res = await runCommand(argv, { timeoutMs }).catch(() => null);
if (!res || res.code !== 0) {
continue;
}
const globalRoot = res.stdout.trim();
if (!globalRoot) {
continue;
}
const globalReal = await tryRealpath(globalRoot);
for (const name of ALL_PACKAGE_NAMES) {
const expected = path.join(globalReal, name);
const expectedReal = await tryRealpath(expected);
if (path.resolve(expectedReal) === path.resolve(pkgReal)) {
return manager;
}
}
}
if (await isPnpmGlobalPackageRoot(pkgRoot)) {
return "pnpm";
}
const bunGlobalRoot = resolveBunGlobalRoot();
const bunGlobalReal = await tryRealpath(bunGlobalRoot);
for (const name of ALL_PACKAGE_NAMES) {
const bunExpected = path.join(bunGlobalReal, name);
const bunExpectedReal = await tryRealpath(bunExpected);
if (path.resolve(bunExpectedReal) === path.resolve(pkgReal)) {
return "bun";
}
}
if (resolveNpmCommandBesidePackageRoot(pkgRoot)) {
return "npm";
}
return null;
}
/**
* Detects an installed global OpenClaw package by probing package-manager roots
* when no trusted package root is already available.
*/
export async function detectGlobalInstallManagerByPresence(
runCommand: CommandRunner,
timeoutMs: number,
): Promise<GlobalInstallManager | null> {
for (const manager of ["npm", "pnpm"] as const) {
const root = await resolveGlobalRoot(manager, runCommand, timeoutMs);
if (!root) {
continue;
}
for (const name of ALL_PACKAGE_NAMES) {
if (await pathExists(path.join(root, name))) {
return manager;
}
}
}
const bunRoot = resolveBunGlobalRoot();
for (const name of ALL_PACKAGE_NAMES) {
if (await pathExists(path.join(bunRoot, name))) {
return "bun";
}
}
return null;
}
/**
* Builds the primary package-manager argv for a global OpenClaw install.
* npm receives quiet/freshness-bypass flags; pnpm source installs allow builds.
*/
export function globalInstallArgs(
managerOrCommand: GlobalInstallManager | ResolvedGlobalInstallCommand,
spec: string,
pkgRoot?: string | null,
installPrefix?: string | null,
): string[] {
const resolved = normalizeGlobalInstallCommand(managerOrCommand, pkgRoot);
if (resolved.manager === "pnpm") {
return [
resolved.command,
"add",
"-g",
...(installPrefix ? ["--global-dir", installPrefix] : []),
...(isPnpmOpenClawSourceInstallSpec(spec) ? [PNPM_OPENCLAW_BUILD_ALLOWLIST_FLAG] : []),
spec,
];
}
if (resolved.manager === "bun") {
return [resolved.command, "add", "-g", spec];
}
return [
resolved.command,
"i",
"-g",
...(installPrefix ? ["--prefix", installPrefix] : []),
spec,
...NPM_GLOBAL_INSTALL_QUIET_FLAGS,
...createNpmFreshnessBypassArgs(process.env, new Date(), {
npmConfigPrefix: installPrefix,
}),
];
}
/**
* Builds npm's retry argv without optional dependencies.
* Non-npm managers have no equivalent fallback and return null.
*/
export function globalInstallFallbackArgs(
managerOrCommand: GlobalInstallManager | ResolvedGlobalInstallCommand,
spec: string,
pkgRoot?: string | null,
installPrefix?: string | null,
): string[] | null {
const resolved = normalizeGlobalInstallCommand(managerOrCommand, pkgRoot);
if (resolved.manager !== "npm") {
return null;
}
return [
resolved.command,
"i",
"-g",
...(installPrefix ? ["--prefix", installPrefix] : []),
spec,
"--omit=optional",
...NPM_GLOBAL_INSTALL_QUIET_FLAGS,
...createNpmFreshnessBypassArgs(process.env, new Date(), {
npmConfigPrefix: installPrefix,
}),
];
}
/** Removes leftover hidden global package directories from interrupted renames. */
export async function cleanupGlobalRenameDirs(params: {
globalRoot: string;
packageName: string;
}): Promise<{ removed: string[] }> {
const removed: string[] = [];
const root = params.globalRoot.trim();
const name = params.packageName.trim();
if (!root || !name) {
return { removed };
}
const prefix = `${GLOBAL_RENAME_PREFIX}${name}-`;
let entries: string[];
try {
entries = await fs.readdir(root);
} catch {
return { removed };
}
for (const entry of entries) {
if (!entry.startsWith(prefix)) {
continue;
}
const target = path.join(root, entry);
try {
const stat = await fs.lstat(target);
if (!stat.isDirectory()) {
continue;