Skip to content

feat(cli): emit one-line update notice in non-interactive mode #377

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
bj456736 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat(cli): emit one-line update notice in non-interactive mode #377

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
101 changes: 69 additions & 32 deletions apps/kimi-code/src/cli/update/preflight.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,16 @@ import { spawn } from 'node:child_process';
import { log, type Logger } from '@moonshot-ai/kimi-code-sdk';
import type { TelemetryProperties } from '@moonshot-ai/kimi-telemetry';

import {
NATIVE_INSTALL_COMMAND_UNIX,
NATIVE_INSTALL_COMMAND_WIN,
} from '#/constant/app';
import { NATIVE_INSTALL_COMMAND_UNIX, NATIVE_INSTALL_COMMAND_WIN } from '#/constant/app';
import { loadTuiConfig } from '#/tui/config';

import { readUpdateCache } from './cache';
import { tryAcquireUpdateInstallLock } from './install-lock';
import { emptyUpdateInstallState, readUpdateInstallState, writeUpdateInstallState } from './install-state';
import {
emptyUpdateInstallState,
readUpdateInstallState,
writeUpdateInstallState,
} from './install-state';
import {
CHANGELOG_URL,
promptForInstallChoice,
Expand Down Expand Up @@ -100,11 +101,20 @@ export function spawnForSource(
): SpawnCommand {
switch (source) {
case 'npm-global':
return { cmd: withCmdSuffix('npm', platform), args: ['install', '-g', `${NPM_PACKAGE_NAME}@${version}`] };
return {
cmd: withCmdSuffix('npm', platform),
args: ['install', '-g', `${NPM_PACKAGE_NAME}@${version}`],
};
case 'pnpm-global':
return { cmd: withCmdSuffix('pnpm', platform), args: ['add', '-g', `${NPM_PACKAGE_NAME}@${version}`] };
return {
cmd: withCmdSuffix('pnpm', platform),
args: ['add', '-g', `${NPM_PACKAGE_NAME}@${version}`],
};
case 'yarn-global':
return { cmd: withCmdSuffix('yarn', platform), args: ['global', 'add', `${NPM_PACKAGE_NAME}@${version}`] };
return {
cmd: withCmdSuffix('yarn', platform),
args: ['global', 'add', `${NPM_PACKAGE_NAME}@${version}`],
};
case 'bun-global':
return { cmd: bunCommand(platform), args: ['add', '-g', `${NPM_PACKAGE_NAME}@${version}`] };
case 'native':
Expand Down Expand Up @@ -280,15 +290,23 @@ function trackUpdateEvent(
}
}

function logUpdateInfo(logger: UpdateLogger, message: string, payload: Record<string, unknown>): void {
function logUpdateInfo(
logger: UpdateLogger,
message: string,
payload: Record<string, unknown>,
): void {
try {
logger.info(message, payload);
} catch {
// Diagnostic logging must never affect update prompting.
}
}

function logUpdateWarn(logger: UpdateLogger, message: string, payload: Record<string, unknown>): void {
function logUpdateWarn(
logger: UpdateLogger,
message: string,
payload: Record<string, unknown>,
): void {
try {
logger.warn(message, payload);
} catch {
Expand Down Expand Up @@ -382,24 +400,24 @@ async function startBackgroundInstall(

const nextState: UpdateInstallState = succeeded
? {
...startedState,
active: null,
lastFailure: null,
lastSuccess: {
version: target.version,
installedAt: nowIso(),
notifiedAt: null,
},
}
...startedState,
active: null,
lastFailure: null,
lastSuccess: {
version: target.version,
installedAt: nowIso(),
notifiedAt: null,
},
}
: {
...startedState,
active: null,
lastFailure: {
version: target.version,
failedAt: nowIso(),
attempts,
},
};
...startedState,
active: null,
lastFailure: {
version: target.version,
failedAt: nowIso(),
attempts,
},
};
void writeUpdateInstallState(nextState).catch(() => {});
if (succeeded) {
trackUpdateEvent(track, 'update_background_install_succeeded', {
Expand All @@ -425,8 +443,12 @@ async function startBackgroundInstall(
};

const child = spawn(cmd, [...args], { detached: true, stdio: 'ignore' });
child.once('error', () => { finish(false); });
child.once('exit', (code) => { finish(code === 0); });
child.once('error', () => {
finish(false);
});
child.once('exit', (code) => {
finish(code === 0);
});
child.unref();
} finally {
await lock.release().catch(() => {});
Expand All @@ -453,8 +475,7 @@ export async function runUpdatePreflight(
const platform = process.platform;

try {
const isInteractive =
options.isTTY ?? (process.stdin.isTTY && process.stdout.isTTY);
const isInteractive = options.isTTY ?? (process.stdin.isTTY && process.stdout.isTTY);
let installState = await readUpdateInstallState().catch(() => emptyUpdateInstallState());
if (isInteractive) {
installState = await showPendingBackgroundInstallNotice(
Expand All @@ -476,7 +497,23 @@ export async function runUpdatePreflight(
: await detectInstallSource().catch(() => 'unsupported' as const);

const decision = decideUpdateAction(target, isInteractive, source, platform);
if (decision === 'none' || target === null) return 'continue';
if (decision === 'none' || target === null) {
// In non-interactive mode, still emit a one-line stderr notice so
// CI/print-mode users know they're behind. Keep it terse and
// rate-limited by the same cache that drives interactive mode.
if (!isInteractive && target !== null) {
stderr.write(
`notice: ${NPM_PACKAGE_NAME} ${currentVersion} -> ${target.version} available. ` +
`Run \`kimi upgrade\` to update.\n`,
);
trackUpdateEvent(options.track, 'update_notified_non_interactive', {
current_version: currentVersion,
target_version: target.version,
source,
});
}
return 'continue';
}

const installCommand = installCommandFor(source, target.version, platform);
const sourceCanAutoInstall = canAutoInstall(source, platform);
Expand Down
19 changes: 19 additions & 0 deletions apps/kimi-code/test/cli/update/preflight.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -206,6 +206,25 @@ describe('runUpdatePreflight', () => {
expect(detectInstallSource).not.toHaveBeenCalled();
});

it('emits a one-line stderr notice in non-interactive mode when an update is available', async () => {
mocks.readUpdateCache.mockResolvedValue(cacheWith('0.5.0'));
mocks.refreshUpdateCache.mockResolvedValue(cacheWith('0.5.0'));
const { stderr, options } = captureOutput();
const track = vi.fn();
await expect(
runUpdatePreflight('0.4.0', { ...options, isTTY: false, track }),
).resolves.toBe('continue');
expect(stderr.join('')).toBe(
'notice: @moonshot-ai/kimi-code 0.4.0 -> 0.5.0 available. Run `kimi upgrade` to update.\n',
);
expect(track).toHaveBeenCalledWith('update_notified_non_interactive', expect.objectContaining({
current_version: '0.4.0',
target_version: '0.5.0',
source: 'unsupported',
}));
expect(detectInstallSource).not.toHaveBeenCalled();
});

it('npm-global: prompts and spawns npm install -g when automatic updates are disabled', async () => {
disableAutoInstall();
mocks.readUpdateCache.mockResolvedValue(cacheWith('0.5.0'));
Expand Down
Loading