feat(update): oclif hook to notify of updated versions of CLI by mttdnt · Pull Request #374 · sanity-io/cli

mttdnt · 2026-02-02T21:33:59Z

Description

Update notifier runs as a init hook. As per the original implementation, waits 12 hours between pulling latest version and notifying user if there is a more up to date version.

What to review

New implementation matches intent of original update notifier

Testing

Wrote more integration style test, tried to mock as little as possible

linear · 2026-02-02T21:34:02Z

SDK-636 Implement update check for CLI

Migrate existing functionality of checking if there is a new version available and showing prompt.

Reference implementation: https://github.com/oclif/plugin-warn-if-update-available

mttdnt · 2026-02-02T21:35:47Z

+    set: mockGetUserConfigSet,
+  })),
+  isCi: vi.fn(),
+  subdebug: vi.fn(() => mockDebug),


Not sure if this is really needed, but there wasnt much else to assert on

claude · 2026-02-03T02:19:46Z

Claude finished @mttdnt's task in 1m 34s —— View job

PR Review Complete

Read repository guidelines
Review changed files
Check for issues
Post findings

Issues Found

1. Package Name Mismatch (Critical)

File: updateChecker.ts:40 and showNotificationUpdate.ts:23-24

The code uses config.name which is @sanity/cli, but notification suggests updating sanity package. When fetching from npm, it checks for updates to @sanity/cli, but tells users to run npm update sanity or yarn upgrade sanity. This will confuse users.

Fix: Either:

Use @sanity/cli consistently (fetch it, suggest updating it)
Or if the published package is actually sanity, use that everywhere

2. Missing Test for Global NPM Install

File: checkForUpdates.test.ts:278

Test line 278 comment says "Couldn't find a way to reliably setup a fixture with a global install" but only tests yarn global. Missing test for npm install -g sanity scenario.

Fix: Add test case for global npm install scenario to ensure npm install -g sanity command is suggested correctly.

3. Timeout Cleanup Edge Case

File: promiseRaceWithTimeout.ts:23

The condition if (timeoutId && result !== null) means timeout is only cleared when promise wins. But the finally block already clears it. The inner clearTimeout (line 24) is redundant and adds confusion.

Fix: Remove lines 22-25. The finally block handles all cleanup.

4. Blocking Hook Behavior

File: checkForUpdates.ts:12

Hook awaits updateChecker(), which can block CLI startup for up to 300ms on timeout. Per review comment from mttdnt (line 12), this was a concern but not resolved.

Fix: Either make it non-blocking with void updateChecker(config).catch(...) or document why blocking is acceptable.

github-actions · 2026-02-03T02:25:00Z

Coverage Report

Status	Category	Percentage	Covered / Total
🔵	Lines	77.03%	7005 / 9093
🔵	Statements	76.56%	7220 / 9430
🔵	Functions	73.76%	1198 / 1624
🔵	Branches	63.45%	3225 / 5082

File Coverage

File	Stmts	Branches	Functions	Lines	Uncovered Lines
Changed Files
packages/@sanity/cli-core/src/util/createExpiringConfig.ts	94.11%	100%	75%	94.11%	50, 52
packages/@sanity/cli/src/hooks/init/checkForUpdates.ts	100%	100%	100%	100%
packages/@sanity/cli/src/util/promiseRaceWithTimeout.ts	100%	83.33%	100%	100%
packages/@sanity/cli/src/util/update/fetchLatestVersion.ts	100%	75%	100%	100%
packages/@sanity/cli/src/util/update/getUpdateCommand.ts	100%	100%	100%	100%
packages/@sanity/cli/src/util/update/isInstalledUsingYarn.ts	0%	0%	0%	0%	4-10
packages/@sanity/cli/src/util/update/showNotificationUpdate.ts	100%	75%	100%	100%
packages/@sanity/cli/src/util/update/updateChecker.ts	100%	100%	100%	100%
packages/@sanity/cli/src/util/update/updateCheckerDebug.ts	100%	100%	100%	100%

Generated in workflow #2070 for commit 8a89d1f by the Vitest Coverage Report Action

binoy14

Might be worth looking at createExpiringConfig if it simplifies some things and other comments but overall is good

binoy14 · 2026-02-03T17:19:42Z

+ * Get the appropriate update command for the package manager
+ */
+export default function getUpdateCommand(pm: PackageManager): string {
+  const commands: Record<PackageManager, string> = {


From looking at the original implementation, it checks if it's a global install vs local install. This forces a global install which is not something that is ideal. Also should it be install sanity ? 🤔

cc @rexxars

Ah yeah I see it checks for a global install, that I can update. In the original cli it uses @sanity/cli, but I agree seems like it should install sanity

Added the changes to check for global vs local install. One thing I am unsure of is will oclif be pulling the version of @sanity/cli? If so will it be confusing to the user when suggesting to update the sanity package?

binoy14 · 2026-02-03T17:27:53Z

+    return
+  }
+
+  const cache = store.get('updateCheck') as UpdateCache | undefined


The store name does not seem to match the original CLI. We probably should keep it simple cliLastUpdateCheck is what og cli has but I think maybe if we create an expiring config this might not be needed.

binoy14 · 2026-02-03T17:29:33Z

+    vi.unstubAllEnvs()
+    originalEnv = {...process.env} as Record<string, string>
+    mockIsCi.mockReturnValue(false)
+    process.stdout.isTTY = true


can't this be vi.stubEnv('isTTY', true) that way we can remove the originalEnv thing

binoy14 · 2026-02-03T17:29:57Z

+
+  test('returns early if not TTY', async () => {
+    const {config} = await getCommandAndConfig('help')
+    const originalIsTTY = process.stdout.isTTY


maybe use vi.stubEnv?

socket-security · 2026-02-04T19:38:48Z

Review the following changes in direct dependencies. Learn more about Socket for GitHub.

Diff	Package	Supply Chain Security	Vulnerability	Quality	Maintenance	License
	npm/is-installed-globally@1.0.0

View full report

mttdnt · 2026-02-04T20:42:20Z

+  })
+
+  test('shows yarn global add command when globally installed via yarn', async () => {
+    mockIsInstalledGlobally.default = true


Couldn't find a way to reliably setup a fixture with a global install. Let me know if you have any ideas.

binoy14 · 2026-02-06T19:28:18Z

+  try {
+    await updateChecker(config)
+  } catch (err) {
+    console.error(`Error checking for updates: ${err}`)


This should use debug not console.error

binoy14 · 2026-02-06T19:38:11Z

+    command = getUpdateCommand(chosen)
+  }
+
+  const message = `Update available: ${currentVersion} → ${latestVersion}\n\nRun ${command} to update`


Copying styles from current CLI

Suggested change

const message = `Update available: ${currentVersion} → ${latestVersion}\n\nRun ${command} to update`

const message = `Update available: ${styleText('dim', currentVersion)} → ${styleText('green', latestVersion)}\n\nRun ${styleText('cyan', command)} to update`

binoy14 · 2026-02-06T19:42:38Z

+  try {
+    const result = await Promise.race([
+      getLatestVersion(packageName),
+      new Promise<null>((resolve) => setTimeout(() => resolve(null), timeout)),


This will cause the process to hang until the timeout is resolved. If you change the timeout to something larger like 60_000 and run a command that responds and exits immediately like --help see it getting hung. We basically need to clear this timeout

binoy14 · 2026-02-06T19:43:55Z

+const mockIsInstalledGlobally = vi.hoisted(() => ({default: false}))
+const mockIsInstalledUsingYarn = vi.hoisted(() => vi.fn())
+
+// Mock dependencies


Suggested change

// Mock dependencies

binoy14 · 2026-02-06T19:49:06Z

+
+  // Cache for latest version from npm
+  const latestVersionCache = createExpiringConfig({
+    fetchValue: async () => fetchLatestVersionWithTimeout(config.name, CHECK_TIMEOUT),


Should this error be handled? i.e basically ignore it I don't want an error cause this to throw an uncaught exception

It being handled in fetchLastestVersionTimeout, but I can just remove the throws in that function so it fails silently

hmm I guess it's fine because the main functions catches it

…out cleanup

…test

…or timeout

mttdnt requested review from binoy14 and rexxars February 2, 2026 21:33

mttdnt requested a review from a team as a code owner February 2, 2026 21:34

mttdnt commented Feb 2, 2026

View reviewed changes

Comment thread packages/@sanity/cli/src/hooks/init/checkForUpdates.ts

mttdnt force-pushed the feature/sdk-636/update-check branch from 11ffd9b to 882a993 Compare February 3, 2026 02:19

binoy14 requested changes Feb 3, 2026

View reviewed changes

mttdnt force-pushed the feature/sdk-636/update-check branch from 581717b to 5bc86f7 Compare February 4, 2026 19:51

mttdnt commented Feb 4, 2026

View reviewed changes

mttdnt requested a review from binoy14 February 4, 2026 20:45

mttdnt added 10 commits February 6, 2026 14:43

feat(update-check): claude implementation of update checker

0806434

feat(update): finished update checker migration

3b42718

chore(update): moving folder and breaking out functions

d7e10ab

feat(update): using existing package manager detection utility

67495a0

chore(update): tests for update checker

a5222de

chore(update): pr comments

554617f

chore(update): rebase lockfile regenerate

ecc02fc

chore(update): claude review

0b79017

chore(update): pr comments

a5f097a

chore(update): removing changes to createExpiringConfig

287bb31

binoy14 requested changes Feb 6, 2026

View reviewed changes

mttdnt force-pushed the feature/sdk-636/update-check branch from e33300a to 287bb31 Compare February 6, 2026 19:49

mttdnt added 4 commits February 8, 2026 22:41

chore(update): more comments, adding timeout utility with proper time…

b1fcda3

…out cleanup

chore(update): updated styling to notification, and removing useless …

00e3f96

…test

chore(update): removing claude change

a71e1a5

chore(update): fixing typo for config name and removing error throw f…

8a89d1f

…or timeout

mttdnt requested a review from binoy14 February 9, 2026 15:52

binoy14 approved these changes Feb 9, 2026

View reviewed changes

mttdnt merged commit 4172cbc into main Feb 10, 2026
33 checks passed

mttdnt deleted the feature/sdk-636/update-check branch February 10, 2026 13:17

squiggler-legacy Bot mentioned this pull request Feb 10, 2026

chore: release main #401

Merged

This was referenced Mar 6, 2026

chore: release main #556

Merged

chore: release main #592

Merged

	const message = `Update available: ${currentVersion} → ${latestVersion}\n\nRun ${command} to update`
	const message = `Update available: ${styleText('dim', currentVersion)} → ${styleText('green', latestVersion)}\n\nRun ${styleText('cyan', command)} to update`

Conversation

mttdnt commented Feb 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

What to review

Testing

Uh oh!

linear Bot commented Feb 2, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

claude Bot commented Feb 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Review Complete

Issues Found

1. Package Name Mismatch (Critical)

2. Missing Test for Global NPM Install

3. Timeout Cleanup Edge Case

4. Blocking Hook Behavior

Uh oh!

github-actions Bot commented Feb 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Coverage Report

Uh oh!

binoy14 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

socket-security Bot commented Feb 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

mttdnt commented Feb 2, 2026 •

edited

Loading

claude Bot commented Feb 3, 2026 •

edited

Loading

github-actions Bot commented Feb 3, 2026 •

edited

Loading

socket-security Bot commented Feb 4, 2026 •

edited

Loading