kimi-code/packages/node-sdk/test/export-session.test.ts
liruifengv b51e13538d
ci: run unit tests on windows (#1037)
* ci: run unit tests on windows

* fix(migration-legacy): align workdir bucket key with agent-core

computeWorkdirBucket used a local node:path-based resolve that yields backslash-separated paths on Windows, while agent-core's encodeWorkDirKey uses pathe (forward slashes on every platform). The SHA-256 inputs diverged, so migrated sessions were written to a bucket that the session picker never reads, making them invisible on Windows.

Alias computeWorkdirBucket to encodeWorkDirKey so both sides stay byte-identical, drop the local slugify copy, and update the workdir-bucket test reference accordingly.

* test(acp-adapter): expect platform-native separators in e2e-fs path

The e2e-fs test asserted the fs/readTextFile wire path as the raw POSIX targetPath, but AcpKaos.toClientPath converts '/' to '\' when the inner LocalKaos reports pathClass 'win32' (Windows). On Windows the wire path became '\Users\test\x.ts' and the assertion failed.

Mirror toClientPath in the test: expect backslash separators on win32 and the raw path otherwise. Implementation is unchanged.

* test(sdk): normalize workDir and skillDir paths in session tests

SessionStore.create/list and the skill loader normalize paths through pathe (forward slashes). The SDK tests compared the resulting workDir and skill loaded-dir against raw mkdtemp / node:path strings, which use backslashes on Windows (and node:fs realpath also returns backslashes for the skill dir), failing three toMatchObject assertions.

Build the expected paths with agent-core's normalizeWorkDir so they match the internal pathe representation on every platform. The skill dir keeps its realpath() (the loader realpaths the root) and only normalizes separators.

* test(skill): normalize realpath to forward slashes in scanner tests

resolveSkillRoots normalizes every root.path through fs.realpath followed by replacing backslashes with forward slashes (scanner.ts). The scanner tests compared root.path against node:fs realpath directly, which returns backslashes on Windows, so twenty assertions failed (toEqual / toContain / toHaveLength) even though the resolved paths were identical.

Wrap realpath at the top of the test file to mirror the implementation's normalization, so every comparison uses the same forward-slash form on every platform.

* test: skip Unix-only permission tests on Windows

The Unix file-permission assertions (mode bits like 0o600 / 0o700 and chmod 000 making a path unreadable) have no equivalent on Windows, which uses ACLs; fs.chmod there can only toggle the read-only bit. These six tests failed on Windows with mismatched mode values or a missing 40411.

Skip them on win32 via it.skipIf(process.platform === 'win32'): oauth FileTokenStorage (0600 file, 0700 dir), agent-core BackgroundTaskPersistence (0700 tasks dir), agent-core createPerIdJsonStore (0700 subdir), migration-legacy atomicWrite (0600 file), and server fs:browse (chmod 000 -> 40411).

* test(tui): make platform-sensitive assertions cross-platform

The TUI implementations are already platform-aware (pathe-style paths, pathToFileURL, quoteShellArg cmd/POSIX quoting, Alt+V on Windows for paste expansion), but the tests hard-coded POSIX expectations and failed on Windows.

Align the assertions with the implementation's platform behavior: footer-goal-badge matches the '[goal' badge prefix instead of /goal/ (toolbar tips contain '/goal'); tool-call expects backslash relative paths on win32; plan-box builds the file:// URL via pathToFileURL; custom-editor sends Alt+V on win32 for paste expansion; file-mention-provider normalizes the expected description to forward slashes; kimi-tui-startup builds the resume command with quoteShellArg; kimi-tui-message-flow builds the expected install path with resolve().

* test: align path assertions with pathe on Windows

Several test suites asserted paths produced by node:path/node:os/node:fs against values that agent-core, node-sdk and kaos normalize through pathe (forward slashes). On Windows the two forms diverge (backslashes vs forward slashes), failing about 19 assertions.

Mirror the implementation's normalization in the assertions via a local toPosix helper (or agent-core's normalizeWorkDir), so expected paths use forward slashes on every platform: kaos LocalKaos, node-sdk export/list/resume/config/transport sessions, cli FileMentionProvider, and agent-core skill-session.

* test(native): build path expectations with node:path.resolve

paths.mjs builds every path with node:path.resolve, which yields backslash-separated absolute paths on Windows. The path-helpers tests asserted against template strings that mixed the backslash appRoot with forward-slash segments, so Object.is failed on Windows even though the strings looked identical.

Build the expectations with the same resolve(appRoot, ...) helper so the separators match on every platform.

* fix: make Windows CI tests pass across all packages

Fix the remaining Windows CI failures so the Windows test job can go green. The changes fall into a few categories:

- Path separators: agent-core/node-sdk/kaos normalize paths via pathe (forward slashes); align test expectations and a couple of implementations (native cache base, workspace registry) with that.

- Platform-only services: skip launchd/systemd manager suites on win32 (Windows uses schtasks).

- Process/signal lifecycle: skip or relax tests that rely on POSIX signals / SIGTERM semantics that Windows does not support.

- Hook shell syntax: rewrite hook test commands from POSIX shell (single quotes, semicolons, stderr redirects, if/then/fi) to node -e / .cjs files that run under cmd.exe.

- CRLF: make Bash tool description stripping tolerate CRLF line endings.

- Misc: realpath short-name divergence, port-retry timing, telemetry spawn, fs-watch timing, snapshot path normalization, etc.

* fix: remove unused basename import in workspaceRegistryService

Fix lint error (no-unused-vars): basename from node:path is no longer used after switching to posixBasename from pathe.

* fix: align resume harness pathClass and wait for banner state on Windows

Two more Windows CI fixes:

- createResumeNoSideEffectKaos now reports pathClass 'win32' on Windows so tool descriptions (e.g. Glob's Windows note) match the live agent in expectResumeMatches, fixing usage/description deep-equal drift.

- kimi-tui-startup once-banner test now waits for writeBannerDisplayState to land before asserting, since the atomic write can lag behind the render on Windows.

* fix: resolve remaining Windows unit test failures

Make the new Windows CI job green across agent-core, kaos, node-sdk and server:

- Align the resume harness kaos pathClass with the live agent so platform-conditional tool descriptions (Glob's Windows note) match in expectResumeMatches instead of drifting on win32.
- Rewrite hook commands in agent-core tests as cross-platform node one-liners; single-quote echo, >&2 and ';' do not work under cmd.exe.
- Add .gitattributes enforcing LF so raw-imported templates (e.g. the compaction instruction) produce byte-identical token counts on Windows and POSIX.
- Terminate the full process tree on Windows in both the hook runner and kaos (taskkill /T /F) so grandchildren cannot outlive their parent and keep the cwd locked.
- Normalize workDir path separators in two kimi-sdk session tests to match the stored canonical form.
- Avoid cmd.exe arg-quoting pitfalls in the kaos cmd.exe test, and run the Windows process-tree kill test from a script file with the pid path passed via argv.
- Give the first fs-git e2e test more time on Windows and retry the temp-dir cleanup; skip the fs-watch overflow-burst assertion on Windows where fs-event coalescing prevents the single-window spike.

* ci: retrigger checks

* fix: resolve remaining Windows failures after merging main

- Terminate the spawned git/gh process tree on Windows in FsGitService (taskkill /T /F on timeout) so a timed-out 'gh pr view' cannot leave a grandchild holding the workspace cwd, which made the fs-git e2e cleanup fail with EPERM.

- Give the fs:git_status e2e suite a longer timeout on Windows and retry the temp-dir cleanup longer to ride out the slower child-process teardown.

- Make the third-party plugin install trust test assert the resolved install path via node:path so it matches the Windows-resolved path (D:\tmp\...) as well as the POSIX one.

* fix: align workspace registry roots and harden fs-git cleanup on Windows

- workspace-registry test: compare normalized (forward-slash) roots, since the registry and session index both store workDir via pathe.resolve (forward slashes on every platform). realpath() yields backslashes on Windows and diverged from the stored root.

- fs-git e2e: bump the temp-dir cleanup retries and the afterEach timeout, since Windows child-process teardown after server.close() is asynchronous and can keep the workspace cwd locked for several seconds.

* test: stub openUrl in kimi-tui-message-flow feedback tests

The /feedback command falls back to openUrl(FEEDBACK_ISSUE_URL) when submission fails, which spawned a real browser window on every test run. Mock #/utils/open-url (matching the existing login/message-replay/server test convention) so the suite never opens a browser.

* test: harden fs-git e2e cleanup against Windows cwd locks

On Windows, git/gh child processes and the session core process can outlive server.close() and keep the temp workspace as their cwd, so rmSync fails with EPERM even after a long retry. Add rmSyncRobust that retries and, if the cwd is still locked, swallows EPERM/EBUSY on Windows — the OS reclaims the temp dir and a cleanup hiccup must not fail an otherwise-passing test.

* test: harden server e2e cleanup against async teardown races

server.close() does not fully await the server's asynchronous teardown, so on a loaded CI runner the temp home/workspace dirs can still be held or written to when the afterEach rmSync runs, failing with EPERM (Windows) or ENOTEMPTY (Linux). Use a rmSyncRobust helper (retry + swallow EPERM/EBUSY/ENOTEMPTY) in the fs-git and question e2e cleanup. Also fix a leftover `throw err` (renamed to `throw error`) that broke the typecheck.
2026-06-26 11:56:41 +08:00

318 lines
11 KiB
TypeScript

import { existsSync } from 'node:fs';
import { mkdir, mkdtemp, readFile, rm, writeFile } from 'node:fs/promises';
import { tmpdir } from 'node:os';
import { join, resolve } from 'node:path';
import * as zlib from 'node:zlib';
import { afterEach, describe, expect, it } from 'vitest';
import {
createKimiHarness,
KimiError,
type SessionSummary,
} from '#/index';
import { resolveGlobalLogPath } from '../../agent-core/src/logging/logger';
import {
WIRE_PROTOCOL_VERSION,
exportSessionDirectory,
} from '../../agent-core/src/session/export';
import { recordingTelemetry, type TelemetryRecord } from './telemetry';
import { TEST_IDENTITY } from './test-identity';
// agent-core/node-sdk normalize paths to forward slashes (pathe). Mirror that
// in path assertions so they hold on Windows, where node:path produces
// backslashes.
const toPosix = (p: string): string => p.replaceAll('\\', '/');
const tempDirs: string[] = [];
afterEach(async () => {
for (const dir of tempDirs.splice(0)) {
await rm(dir, { recursive: true, force: true });
}
});
async function makeTempDir(): Promise<string> {
const dir = await mkdtemp(join(tmpdir(), 'kimi-sdk-export-'));
tempDirs.push(dir);
return dir;
}
function readZipEntries(buf: Buffer): Map<string, Buffer> {
let eocd = -1;
for (let i = buf.length - 22; i >= Math.max(0, buf.length - 65557); i--) {
if (buf.readUInt32LE(i) === 0x06054b50) {
eocd = i;
break;
}
}
if (eocd === -1) throw new Error('zip eocd not found');
const entryCount = buf.readUInt16LE(eocd + 10);
const cdOffset = buf.readUInt32LE(eocd + 16);
const entries = new Map<string, Buffer>();
let pos = cdOffset;
for (let i = 0; i < entryCount; i++) {
if (buf.readUInt32LE(pos) !== 0x02014b50) {
throw new Error(`bad central-directory entry at ${String(pos)}`);
}
const method = buf.readUInt16LE(pos + 10);
const compressedSize = buf.readUInt32LE(pos + 20);
const fnameLen = buf.readUInt16LE(pos + 28);
const extraLen = buf.readUInt16LE(pos + 30);
const commentLen = buf.readUInt16LE(pos + 32);
const lfhOffset = buf.readUInt32LE(pos + 42);
const filename = buf.toString('utf8', pos + 46, pos + 46 + fnameLen);
if (buf.readUInt32LE(lfhOffset) !== 0x04034b50) {
throw new Error(`bad local-file-header at ${String(lfhOffset)}`);
}
const lfhFnameLen = buf.readUInt16LE(lfhOffset + 26);
const lfhExtraLen = buf.readUInt16LE(lfhOffset + 28);
const dataStart = lfhOffset + 30 + lfhFnameLen + lfhExtraLen;
const compressed = buf.subarray(dataStart, dataStart + compressedSize);
const data = method === 0 ? compressed : method === 8 ? zlib.inflateRawSync(compressed) : null;
if (data === null) throw new Error(`unsupported compression method: ${String(method)}`);
entries.set(filename, data);
pos += 46 + fnameLen + extraLen + commentLen;
}
return entries;
}
function makeSummary(input: {
readonly id: string;
readonly sessionDir: string;
readonly workDir: string;
readonly title?: string | undefined;
}): SessionSummary {
return {
id: input.id,
sessionDir: input.sessionDir,
workDir: input.workDir,
createdAt: 1,
updatedAt: 2,
title: input.title,
};
}
describe('exportSessionDirectory', () => {
it('writes a zip with manifest and every session file', async () => {
const tmp = await makeTempDir();
const sid = 'ses_export_test';
const workDir = join(tmp, 'work');
const sessionDir = join(tmp, 'sessions', sid);
await mkdir(join(sessionDir, 'subagents'), { recursive: true });
await writeFile(
join(sessionDir, 'wire.jsonl'),
[
JSON.stringify({
type: 'turn_begin',
time: Date.parse('2026-04-18T10:00:00Z'),
user_input: 'hello',
}),
JSON.stringify({
type: 'turn_end',
time: Date.parse('2026-04-18T10:00:03Z'),
}),
'',
].join('\n'),
'utf-8',
);
await writeFile(join(sessionDir, 'state.json'), JSON.stringify({ session_id: sid }), 'utf-8');
await writeFile(join(sessionDir, 'subagents', 'a.txt'), 'child', 'utf-8');
const outputPath = join(tmp, 'out.zip');
const result = await exportSessionDirectory({
request: { sessionId: sid, outputPath, version: '1.0.0-test' },
summary: makeSummary({
id: sid,
sessionDir,
workDir,
title: 'Export Test',
}),
});
expect(result.zipPath).toBe(toPosix(outputPath));
expect(result.sessionDir).toBe(sessionDir);
expect(result.entries).toEqual([
'manifest.json',
'state.json',
'subagents/a.txt',
'wire.jsonl',
]);
expect(result.manifest).toMatchObject({
sessionId: sid,
wireProtocolVersion: WIRE_PROTOCOL_VERSION,
sessionFirstActivity: '2026-04-18T10:00:00.000Z',
sessionLastActivity: '2026-04-18T10:00:03.000Z',
title: 'Export Test',
workspaceDir: workDir,
kimiCodeVersion: '1.0.0-test',
});
expect(result.manifest.exportedAt).toMatch(/^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$/);
const entries = readZipEntries(await readFile(outputPath));
expect(entries.has('manifest.json')).toBe(true);
expect(entries.get('state.json')?.toString('utf-8')).toContain(sid);
expect(entries.get('subagents/a.txt')?.toString('utf-8')).toBe('child');
expect([...entries.keys()].some((name) => name.includes(tmp))).toBe(false);
const manifest = JSON.parse(entries.get('manifest.json')!.toString('utf-8')) as {
sessionId: string;
title: string;
workspaceDir: string;
};
expect(manifest.sessionId).toBe(sid);
expect(manifest.title).toBe('Export Test');
expect(manifest.workspaceDir).toBe(workDir);
});
it('uses the default output path when outputPath is omitted', async () => {
const tmp = await makeTempDir();
const sid = 'session_default_output';
const sessionDir = join(tmp, 'sessions', sid);
await mkdir(sessionDir, { recursive: true });
await writeFile(join(sessionDir, 'state.json'), '{}', 'utf-8');
const result = await exportSessionDirectory({
request: { sessionId: sid, version: '1.0.0-test' },
summary: makeSummary({ id: sid, sessionDir, workDir: tmp }),
});
const expectedPath = resolve(`${sid}.zip`);
expect(result.zipPath).toBe(toPosix(expectedPath));
expect(existsSync(result.zipPath)).toBe(true);
await rm(expectedPath, { force: true });
});
it('omits global log manifest path when the global log cannot be bundled', async () => {
const tmp = await makeTempDir();
const homeDir = join(tmp, 'home');
const sid = 'ses_unreadable_global_log';
const sessionDir = join(tmp, 'sessions', sid);
await mkdir(sessionDir, { recursive: true });
await writeFile(join(sessionDir, 'state.json'), '{}', 'utf-8');
await mkdir(resolveGlobalLogPath(homeDir), { recursive: true });
const outputPath = join(tmp, 'unreadable-global.zip');
const result = await exportSessionDirectory({
request: { sessionId: sid, outputPath, includeGlobalLog: true, version: '1.0.0-test' },
summary: makeSummary({ id: sid, sessionDir, workDir: tmp }),
homeDir,
});
expect(result.manifest.globalLogPath).toBeUndefined();
expect(result.entries).not.toContain('logs/global/kimi-code.log');
const entries = readZipEntries(await readFile(outputPath));
expect(entries.has('logs/global/kimi-code.log')).toBe(false);
const manifest = JSON.parse(entries.get('manifest.json')!.toString('utf-8')) as Record<
string,
unknown
>;
expect(manifest['globalLogPath']).toBeUndefined();
});
it('supports relative outputPath and creates parent directories', async () => {
const tmp = await makeTempDir();
const sid = 'ses_relative_output';
const sessionDir = join(tmp, 'sessions', sid);
await mkdir(sessionDir, { recursive: true });
await writeFile(join(sessionDir, 'state.json'), '{}', 'utf-8');
const outputPath = join(tmp, 'exports/out.zip');
const result = await exportSessionDirectory({
request: { sessionId: sid, outputPath, version: '1.0.0-test' },
summary: makeSummary({ id: sid, sessionDir, workDir: tmp }),
});
expect(result.zipPath).toBe(toPosix(outputPath));
expect(existsSync(result.zipPath)).toBe(true);
});
it('exports sessions without wire.jsonl and omits activity fields', async () => {
const tmp = await makeTempDir();
const sid = 'ses_no_wire';
const sessionDir = join(tmp, 'sessions', sid);
await mkdir(sessionDir, { recursive: true });
await writeFile(join(sessionDir, 'state.json'), '{}', 'utf-8');
const result = await exportSessionDirectory({
request: { sessionId: sid, version: '1.0.0-test' },
summary: makeSummary({ id: sid, sessionDir, workDir: tmp }),
});
expect(result.manifest.sessionFirstActivity).toBeUndefined();
expect(result.manifest.sessionLastActivity).toBeUndefined();
await rm(resolve(`${sid}.zip`), { force: true });
});
it('rejects empty or missing session directories', async () => {
const tmp = await makeTempDir();
const sid = 'ses_empty';
const sessionDir = join(tmp, 'sessions', sid);
await mkdir(sessionDir, { recursive: true });
await expect(
exportSessionDirectory({
request: { sessionId: sid, version: '1.0.0-test' },
summary: makeSummary({ id: sid, sessionDir, workDir: tmp }),
}),
).rejects.toMatchObject({
name: 'KimiError',
code: 'session.export_not_found',
} satisfies Partial<KimiError>);
});
});
describe('KimiHarness.exportSession', () => {
it('exports a created session through the public Harness API', async () => {
const homeDir = await makeTempDir();
const workDir = await makeTempDir();
const records: TelemetryRecord[] = [];
const harness = createKimiHarness({
identity: TEST_IDENTITY,
homeDir,
telemetry: recordingTelemetry(records),
});
const session = await harness.createSession({
id: 'ses_harness_export',
workDir,
});
const sessionDir = (await harness.listSessions({ workDir })).find(
(item) => item.id === session.id,
)!.sessionDir;
await writeFile(join(sessionDir, 'wire.jsonl'), '{}\n', 'utf-8');
await mkdir(join(sessionDir, 'subagents'), { recursive: true });
await writeFile(join(sessionDir, 'subagents', 'demo.txt'), 'demo', 'utf-8');
const outputPath = join(workDir, 'export.zip');
const result = await harness.exportSession({ id: session.id, outputPath, version: '1.0.0-test' });
expect(result.zipPath).toBe(toPosix(outputPath));
expect(result.entries).toContain('manifest.json');
expect(result.entries).toContain('state.json');
expect(result.entries).toContain('wire.jsonl');
expect(result.entries).toContain('subagents/demo.txt');
expect(result.manifest.sessionId).toBe(session.id);
expect(records).toContainEqual({
event: 'export',
sessionId: session.id,
properties: undefined,
});
});
it('rejects missing session ids', async () => {
const homeDir = await makeTempDir();
const harness = createKimiHarness({ homeDir, identity: TEST_IDENTITY });
const missingExport = harness.exportSession({ id: 'ses_missing', version: '1.0.0-test' });
await expect(missingExport).rejects.toBeInstanceOf(KimiError);
await expect(missingExport).rejects.toMatchObject({
code: 'session.not_found',
details: { sessionId: 'ses_missing' },
} satisfies Partial<KimiError>);
});
});