-
Notifications
You must be signed in to change notification settings - Fork 2.3k
feat: add update notification to both binaries #1783
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.
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
Merged
Merged
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
bb8f44e
chore: add update notification to both binaries
mathiasbynens c7a8ae4
chore: use file modification time instead of explicit `timestamp` prop
mathiasbynens f394814
chore: support `CHROME_DEVTOOLS_MCP_NO_UPDATE_CHECKS` env var
mathiasbynens f53ab36
chore: prevent spawning concurrent subprocesses
mathiasbynens File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| package-lock=true |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| /** | ||
| * @license | ||
| * Copyright 2026 Google LLC | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| import fs from 'node:fs/promises'; | ||
| import path from 'node:path'; | ||
| import process from 'node:process'; | ||
|
|
||
| const cachePath = process.argv[2]; | ||
|
|
||
| if (cachePath) { | ||
| try { | ||
| const response = await fetch( | ||
| 'https://registry.npmjs.org/chrome-devtools-mcp/latest', | ||
| ); | ||
| const data = response.ok ? await response.json() : null; | ||
|
|
||
| if ( | ||
| data && | ||
| typeof data === 'object' && | ||
| 'version' in data && | ||
| typeof data.version === 'string' | ||
| ) { | ||
| await fs.mkdir(path.dirname(cachePath), {recursive: true}); | ||
| await fs.writeFile( | ||
| cachePath, | ||
| JSON.stringify({version: data.version, timestamp: Date.now()}), | ||
| ); | ||
| } | ||
| } catch { | ||
| // Ignore errors. | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| /** | ||
| * @license | ||
| * Copyright 2026 Google LLC | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| import child_process from 'node:child_process'; | ||
| import fs from 'node:fs/promises'; | ||
| import os from 'node:os'; | ||
| import path from 'node:path'; | ||
| import process from 'node:process'; | ||
|
|
||
| import {VERSION} from '../version.js'; | ||
|
|
||
| /** | ||
| * Notifies the user if an update is available. | ||
| * @param message The message to display in the update notification. | ||
| */ | ||
| export async function checkForUpdates(message: string) { | ||
| const cachePath = path.join( | ||
| os.homedir(), | ||
| '.cache', | ||
| 'chrome-devtools-mcp', | ||
| 'latest.json', | ||
| ); | ||
|
|
||
| let cache: {version: string; timestamp: number} | undefined; | ||
|
mathiasbynens marked this conversation as resolved.
Outdated
|
||
| try { | ||
| const data = await fs.readFile(cachePath, 'utf8'); | ||
| cache = JSON.parse(data); | ||
| } catch { | ||
| // Ignore errors reading cache. | ||
| } | ||
|
|
||
| if (cache && typeof cache.version === 'string' && cache.version !== VERSION) { | ||
| console.warn( | ||
| `\nUpdate available: ${VERSION} -> ${cache.version}\n${message}\n`, | ||
| ); | ||
| } | ||
|
|
||
| const now = Date.now(); | ||
| if (cache && now - cache.timestamp < 24 * 60 * 60 * 1000) { | ||
| return; | ||
| } | ||
|
|
||
| // In a separate process, check the latest available version number | ||
| // and update the local snapshot accordingly. | ||
| const scriptPath = path.join(import.meta.dirname, '..', 'bin', 'check-latest-version.js'); | ||
|
|
||
| try { | ||
| const child = child_process.spawn( | ||
| process.execPath, | ||
| [scriptPath, cachePath], | ||
| { | ||
| detached: true, | ||
| stdio: 'ignore', | ||
| }, | ||
| ); | ||
| child.unref(); | ||
| } catch { | ||
| // Fail silently in case of any errors. | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,112 @@ | ||
| /** | ||
| * @license | ||
| * Copyright 2026 Google LLC | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| import assert from 'node:assert'; | ||
| import child_process from 'node:child_process'; | ||
| import fs from 'node:fs/promises'; | ||
| import os from 'node:os'; | ||
| import {afterEach, describe, it} from 'node:test'; | ||
|
|
||
| import sinon from 'sinon'; | ||
|
|
||
| import {checkForUpdates} from '../src/utils/check-for-updates.js'; | ||
| import {VERSION} from '../src/version.js'; | ||
|
|
||
| describe('checkForUpdates', () => { | ||
| afterEach(() => { | ||
| sinon.restore(); | ||
| }); | ||
|
|
||
| it('notifies if cache exists and version is different', async () => { | ||
| sinon.stub(os, 'homedir').returns('/home/user'); | ||
| sinon.stub(fs, 'readFile').callsFake(async filePath => { | ||
| if (filePath.toString().includes('latest.json')) { | ||
| return JSON.stringify({ | ||
| version: '99.9.9', | ||
| timestamp: Date.now(), | ||
| }); | ||
| } | ||
| throw new Error(`File not found: ${filePath}`); | ||
| }); | ||
| const warnStub = sinon.stub(console, 'warn'); | ||
| const spawnStub = sinon.stub(child_process, 'spawn'); | ||
|
|
||
| await checkForUpdates('Run `npm update` to update.'); | ||
|
|
||
| assert.ok( | ||
| warnStub.calledWith( | ||
| sinon.match('Update available: ' + VERSION + ' -> 99.9.9'), | ||
| ), | ||
| ); | ||
| assert.ok(spawnStub.notCalled); | ||
| }); | ||
|
|
||
| it('does not spawn fetch process if cache is fresh', async () => { | ||
| sinon.stub(os, 'homedir').returns('/home/user'); | ||
| sinon.stub(fs, 'readFile').callsFake(async filePath => { | ||
| if (filePath.toString().includes('latest.json')) { | ||
| return JSON.stringify({ | ||
| version: VERSION, | ||
| timestamp: Date.now(), | ||
| }); | ||
| } | ||
| throw new Error(`File not found: ${filePath}`); | ||
| }); | ||
| const spawnStub = sinon.stub(child_process, 'spawn'); | ||
|
|
||
| await checkForUpdates('Run `npm update` to update.'); | ||
|
|
||
| assert.ok(spawnStub.notCalled); | ||
| }); | ||
|
|
||
| it('spawns detached process if cache is stale', async () => { | ||
| sinon.stub(os, 'homedir').returns('/home/user'); | ||
| sinon.stub(fs, 'readFile').callsFake(async filePath => { | ||
| if (filePath.toString().includes('latest.json')) { | ||
| return JSON.stringify({ | ||
| version: VERSION, | ||
| timestamp: Date.now() - 25 * 60 * 60 * 1000, // 25 hours ago | ||
| }); | ||
| } | ||
| throw new Error(`File not found: ${filePath}`); | ||
| }); | ||
|
|
||
| const unrefSpy = sinon.spy(); | ||
| const spawnStub = sinon.stub(child_process, 'spawn').returns({ | ||
| unref: unrefSpy, | ||
| } as unknown as child_process.ChildProcess); | ||
|
|
||
| await checkForUpdates('Run `npm update` to update.'); | ||
|
|
||
| assert.ok(spawnStub.calledOnce); | ||
| assert.strictEqual(spawnStub.firstCall.args[0], process.execPath); | ||
| assert.ok(spawnStub.firstCall.args[1][0]?.includes('check-latest-version.js')); | ||
| assert.ok(spawnStub.firstCall.args[1][1]?.includes('latest.json')); | ||
| assert.strictEqual(spawnStub.firstCall.args[2]?.detached, true); | ||
| assert.ok(unrefSpy.calledOnce); | ||
| }); | ||
|
|
||
| it('spawns detached process if cache is missing', async () => { | ||
| sinon.stub(os, 'homedir').returns('/home/user'); | ||
| sinon.stub(fs, 'readFile').callsFake(async filePath => { | ||
| throw new Error(`File not found: ${filePath}`); | ||
| }); | ||
|
|
||
| const unrefSpy = sinon.spy(); | ||
| const spawnStub = sinon.stub(child_process, 'spawn').returns({ | ||
| unref: unrefSpy, | ||
| } as unknown as child_process.ChildProcess); | ||
|
|
||
| await checkForUpdates('Run `npm update` to update.'); | ||
|
|
||
| assert.ok(spawnStub.calledOnce); | ||
| assert.strictEqual(spawnStub.firstCall.args[0], process.execPath); | ||
| assert.ok(spawnStub.firstCall.args[1][0]?.includes('check-latest-version.js')); | ||
| assert.ok(spawnStub.firstCall.args[1][1]?.includes('latest.json')); | ||
| assert.strictEqual(spawnStub.firstCall.args[2]?.detached, true); | ||
| assert.ok(unrefSpy.calledOnce); | ||
| }); | ||
| }); |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.