mirror of
https://github.com/openclaw/openclaw.git
synced 2026-05-08 19:18:26 +00:00
perf(wizard): lazy-load onboarding deps
This commit is contained in:
@@ -1,12 +1,67 @@
|
||||
import fs from "node:fs/promises";
|
||||
import os from "node:os";
|
||||
import path from "node:path";
|
||||
import { describe, expect, it, vi } from "vitest";
|
||||
import { afterAll, beforeAll, describe, expect, it, vi } from "vitest";
|
||||
import type { RuntimeEnv } from "../runtime.js";
|
||||
import type { WizardPrompter } from "./prompts.js";
|
||||
import { DEFAULT_BOOTSTRAP_FILENAME } from "../agents/workspace.js";
|
||||
import { runOnboardingWizard } from "./onboarding.js";
|
||||
|
||||
const ensureAuthProfileStore = vi.hoisted(() => vi.fn(() => ({ profiles: {} })));
|
||||
const promptAuthChoiceGrouped = vi.hoisted(() => vi.fn(async () => "skip"));
|
||||
const applyAuthChoice = vi.hoisted(() => vi.fn(async (args) => ({ config: args.config })));
|
||||
const resolvePreferredProviderForAuthChoice = vi.hoisted(() => vi.fn(() => "openai"));
|
||||
const warnIfModelConfigLooksOff = vi.hoisted(() => vi.fn(async () => {}));
|
||||
const applyPrimaryModel = vi.hoisted(() => vi.fn((cfg) => cfg));
|
||||
const promptDefaultModel = vi.hoisted(() => vi.fn(async () => ({ config: null, model: null })));
|
||||
const promptCustomApiConfig = vi.hoisted(() => vi.fn(async (args) => ({ config: args.config })));
|
||||
const configureGatewayForOnboarding = vi.hoisted(() =>
|
||||
vi.fn(async (args) => ({
|
||||
nextConfig: args.nextConfig,
|
||||
settings: {
|
||||
port: args.localPort ?? 18789,
|
||||
bind: "loopback",
|
||||
authMode: "token",
|
||||
gatewayToken: "test-token",
|
||||
tailscaleMode: "off",
|
||||
tailscaleResetOnExit: false,
|
||||
},
|
||||
})),
|
||||
);
|
||||
const finalizeOnboardingWizard = vi.hoisted(() =>
|
||||
vi.fn(async (options) => {
|
||||
if (!process.env.BRAVE_API_KEY) {
|
||||
await options.prompter.note("hint", "Web search (optional)");
|
||||
}
|
||||
|
||||
if (options.opts.skipUi) {
|
||||
return { launchedTui: false };
|
||||
}
|
||||
|
||||
const hatch = await options.prompter.select({
|
||||
message: "How do you want to hatch your bot?",
|
||||
options: [],
|
||||
});
|
||||
if (hatch !== "tui") {
|
||||
return { launchedTui: false };
|
||||
}
|
||||
|
||||
let message: string | undefined;
|
||||
try {
|
||||
await fs.stat(path.join(options.workspaceDir, DEFAULT_BOOTSTRAP_FILENAME));
|
||||
message = "Wake up, my friend!";
|
||||
} catch {
|
||||
message = undefined;
|
||||
}
|
||||
|
||||
await runTui({ deliver: false, message });
|
||||
return { launchedTui: true };
|
||||
}),
|
||||
);
|
||||
const listChannelPlugins = vi.hoisted(() => vi.fn(() => []));
|
||||
const logConfigUpdated = vi.hoisted(() => vi.fn(() => {}));
|
||||
const setupInternalHooks = vi.hoisted(() => vi.fn(async (cfg) => cfg));
|
||||
|
||||
const setupChannels = vi.hoisted(() => vi.fn(async (cfg) => cfg));
|
||||
const setupSkills = vi.hoisted(() => vi.fn(async (cfg) => cfg));
|
||||
const healthCommand = vi.hoisted(() => vi.fn(async () => {}));
|
||||
@@ -29,34 +84,68 @@ vi.mock("../commands/onboard-skills.js", () => ({
|
||||
setupSkills,
|
||||
}));
|
||||
|
||||
vi.mock("../agents/auth-profiles.js", () => ({
|
||||
ensureAuthProfileStore,
|
||||
}));
|
||||
|
||||
vi.mock("../commands/auth-choice-prompt.js", () => ({
|
||||
promptAuthChoiceGrouped,
|
||||
}));
|
||||
|
||||
vi.mock("../commands/auth-choice.js", () => ({
|
||||
applyAuthChoice,
|
||||
resolvePreferredProviderForAuthChoice,
|
||||
warnIfModelConfigLooksOff,
|
||||
}));
|
||||
|
||||
vi.mock("../commands/model-picker.js", () => ({
|
||||
applyPrimaryModel,
|
||||
promptDefaultModel,
|
||||
}));
|
||||
|
||||
vi.mock("../commands/onboard-custom.js", () => ({
|
||||
promptCustomApiConfig,
|
||||
}));
|
||||
|
||||
vi.mock("../commands/health.js", () => ({
|
||||
healthCommand,
|
||||
}));
|
||||
|
||||
vi.mock("../config/config.js", async (importActual) => {
|
||||
const actual = await importActual<typeof import("../config/config.js")>();
|
||||
return {
|
||||
...actual,
|
||||
readConfigFileSnapshot,
|
||||
writeConfigFile,
|
||||
};
|
||||
});
|
||||
vi.mock("../commands/onboard-hooks.js", () => ({
|
||||
setupInternalHooks,
|
||||
}));
|
||||
|
||||
vi.mock("../commands/onboard-helpers.js", async (importActual) => {
|
||||
const actual = await importActual<typeof import("../commands/onboard-helpers.js")>();
|
||||
return {
|
||||
...actual,
|
||||
ensureWorkspaceAndSessions,
|
||||
detectBrowserOpenSupport: vi.fn(async () => ({ ok: false })),
|
||||
openUrl: vi.fn(async () => true),
|
||||
printWizardHeader: vi.fn(),
|
||||
probeGatewayReachable: vi.fn(async () => ({ ok: true })),
|
||||
resolveControlUiLinks: vi.fn(() => ({
|
||||
httpUrl: "http://127.0.0.1:18789",
|
||||
wsUrl: "ws://127.0.0.1:18789",
|
||||
})),
|
||||
};
|
||||
});
|
||||
vi.mock("../config/config.js", () => ({
|
||||
DEFAULT_GATEWAY_PORT: 18789,
|
||||
resolveGatewayPort: () => 18789,
|
||||
readConfigFileSnapshot,
|
||||
writeConfigFile,
|
||||
}));
|
||||
|
||||
vi.mock("../commands/onboard-helpers.js", () => ({
|
||||
DEFAULT_WORKSPACE: "/tmp/openclaw-workspace",
|
||||
applyWizardMetadata: (cfg: unknown) => cfg,
|
||||
summarizeExistingConfig: () => "summary",
|
||||
handleReset: async () => {},
|
||||
randomToken: () => "test-token",
|
||||
normalizeGatewayTokenInput: (value: unknown) => ({
|
||||
ok: true,
|
||||
token: typeof value === "string" ? value.trim() : "",
|
||||
error: null,
|
||||
}),
|
||||
validateGatewayPasswordInput: () => ({ ok: true, error: null }),
|
||||
ensureWorkspaceAndSessions,
|
||||
detectBrowserOpenSupport: vi.fn(async () => ({ ok: false })),
|
||||
openUrl: vi.fn(async () => true),
|
||||
printWizardHeader: vi.fn(),
|
||||
probeGatewayReachable: vi.fn(async () => ({ ok: true })),
|
||||
waitForGatewayReachable: vi.fn(async () => {}),
|
||||
formatControlUiSshHint: vi.fn(() => "ssh hint"),
|
||||
resolveControlUiLinks: vi.fn(() => ({
|
||||
httpUrl: "http://127.0.0.1:18789",
|
||||
wsUrl: "ws://127.0.0.1:18789",
|
||||
})),
|
||||
}));
|
||||
|
||||
vi.mock("../commands/systemd-linger.js", () => ({
|
||||
ensureSystemdUserLingerInteractive,
|
||||
@@ -70,10 +159,26 @@ vi.mock("../infra/control-ui-assets.js", () => ({
|
||||
ensureControlUiAssetsBuilt,
|
||||
}));
|
||||
|
||||
vi.mock("../channels/plugins/index.js", () => ({
|
||||
listChannelPlugins,
|
||||
}));
|
||||
|
||||
vi.mock("../config/logging.js", () => ({
|
||||
logConfigUpdated,
|
||||
}));
|
||||
|
||||
vi.mock("../tui/tui.js", () => ({
|
||||
runTui,
|
||||
}));
|
||||
|
||||
vi.mock("./onboarding.gateway-config.js", () => ({
|
||||
configureGatewayForOnboarding,
|
||||
}));
|
||||
|
||||
vi.mock("./onboarding.finalize.js", () => ({
|
||||
finalizeOnboardingWizard,
|
||||
}));
|
||||
|
||||
vi.mock("./onboarding.completion.js", () => ({
|
||||
setupOnboardingShellCompletion,
|
||||
}));
|
||||
@@ -111,6 +216,25 @@ function createRuntime(opts?: { throwsOnExit?: boolean }): RuntimeEnv {
|
||||
}
|
||||
|
||||
describe("runOnboardingWizard", () => {
|
||||
let suiteRoot = "";
|
||||
let suiteCase = 0;
|
||||
|
||||
beforeAll(async () => {
|
||||
suiteRoot = await fs.mkdtemp(path.join(os.tmpdir(), "openclaw-onboard-suite-"));
|
||||
});
|
||||
|
||||
afterAll(async () => {
|
||||
await fs.rm(suiteRoot, { recursive: true, force: true });
|
||||
suiteRoot = "";
|
||||
suiteCase = 0;
|
||||
});
|
||||
|
||||
async function makeCaseDir(prefix: string): Promise<string> {
|
||||
const dir = path.join(suiteRoot, `${prefix}${++suiteCase}`);
|
||||
await fs.mkdir(dir, { recursive: true });
|
||||
return dir;
|
||||
}
|
||||
|
||||
it("exits when config is invalid", async () => {
|
||||
readConfigFileSnapshot.mockResolvedValueOnce({
|
||||
path: "/tmp/.openclaw/openclaw.json",
|
||||
@@ -182,47 +306,43 @@ describe("runOnboardingWizard", () => {
|
||||
}) {
|
||||
runTui.mockClear();
|
||||
|
||||
const workspaceDir = await fs.mkdtemp(path.join(os.tmpdir(), "openclaw-onboard-"));
|
||||
try {
|
||||
if (params.writeBootstrapFile) {
|
||||
await fs.writeFile(path.join(workspaceDir, DEFAULT_BOOTSTRAP_FILENAME), "{}");
|
||||
}
|
||||
|
||||
const select: WizardPrompter["select"] = vi.fn(async (opts) => {
|
||||
if (opts.message === "How do you want to hatch your bot?") {
|
||||
return "tui";
|
||||
}
|
||||
return "quickstart";
|
||||
});
|
||||
|
||||
const prompter = createWizardPrompter({ select });
|
||||
const runtime = createRuntime({ throwsOnExit: true });
|
||||
|
||||
await runOnboardingWizard(
|
||||
{
|
||||
acceptRisk: true,
|
||||
flow: "quickstart",
|
||||
mode: "local",
|
||||
workspace: workspaceDir,
|
||||
authChoice: "skip",
|
||||
skipProviders: true,
|
||||
skipSkills: true,
|
||||
skipHealth: true,
|
||||
installDaemon: false,
|
||||
},
|
||||
runtime,
|
||||
prompter,
|
||||
);
|
||||
|
||||
expect(runTui).toHaveBeenCalledWith(
|
||||
expect.objectContaining({
|
||||
deliver: false,
|
||||
message: params.expectedMessage,
|
||||
}),
|
||||
);
|
||||
} finally {
|
||||
await fs.rm(workspaceDir, { recursive: true, force: true });
|
||||
const workspaceDir = await makeCaseDir("workspace-");
|
||||
if (params.writeBootstrapFile) {
|
||||
await fs.writeFile(path.join(workspaceDir, DEFAULT_BOOTSTRAP_FILENAME), "{}");
|
||||
}
|
||||
|
||||
const select: WizardPrompter["select"] = vi.fn(async (opts) => {
|
||||
if (opts.message === "How do you want to hatch your bot?") {
|
||||
return "tui";
|
||||
}
|
||||
return "quickstart";
|
||||
});
|
||||
|
||||
const prompter = createWizardPrompter({ select });
|
||||
const runtime = createRuntime({ throwsOnExit: true });
|
||||
|
||||
await runOnboardingWizard(
|
||||
{
|
||||
acceptRisk: true,
|
||||
flow: "quickstart",
|
||||
mode: "local",
|
||||
workspace: workspaceDir,
|
||||
authChoice: "skip",
|
||||
skipProviders: true,
|
||||
skipSkills: true,
|
||||
skipHealth: true,
|
||||
installDaemon: false,
|
||||
},
|
||||
runtime,
|
||||
prompter,
|
||||
);
|
||||
|
||||
expect(runTui).toHaveBeenCalledWith(
|
||||
expect.objectContaining({
|
||||
deliver: false,
|
||||
message: params.expectedMessage,
|
||||
}),
|
||||
);
|
||||
}
|
||||
|
||||
it("launches TUI without auto-delivery when hatching", async () => {
|
||||
|
||||
Reference in New Issue
Block a user