|
| 1 | +/** |
| 2 | + * Checks for updates to a given npm package and notifies the user if an update is available. |
| 3 | + */ |
| 4 | + |
| 5 | +import * as os from 'os'; |
| 6 | +import * as path from 'path'; |
| 7 | +import * as semver from 'semver'; |
| 8 | +import { OutputHelper } from '@quenty/cli-output-helpers'; |
| 9 | +import { readFile, writeFile } from 'fs/promises'; |
| 10 | +import { Memoize } from 'typescript-memoize'; |
| 11 | + |
| 12 | +const CHECK_INTERVAL_MS = 24 * 60 * 60 * 1000; // 24 hours |
| 13 | + |
| 14 | +interface VersionCache { |
| 15 | + lastCheck: number; |
| 16 | + latestVersion: string; |
| 17 | + currentVersion: string; |
| 18 | +} |
| 19 | + |
| 20 | +interface UpdateCheckResult { |
| 21 | + updateAvailable: boolean; |
| 22 | + currentVersion: string; |
| 23 | + latestVersion: string; |
| 24 | +} |
| 25 | + |
| 26 | +interface VersionCheckerOptions { |
| 27 | + packageName: string; |
| 28 | + humanReadableName?: string; |
| 29 | + registryUrl: string; |
| 30 | + currentVersion?: string; |
| 31 | + packageJsonPath?: string; |
| 32 | + updateCommand?: string; |
| 33 | + verbose?: boolean; |
| 34 | +} |
| 35 | + |
| 36 | +export class VersionChecker { |
| 37 | + public static async checkForUpdatesAsync( |
| 38 | + options: VersionCheckerOptions |
| 39 | + ): Promise<UpdateCheckResult | undefined> { |
| 40 | + try { |
| 41 | + return await VersionChecker._checkForUpdatesInternalAsync(options); |
| 42 | + } catch (error) { |
| 43 | + const name = options.humanReadableName || options.packageName; |
| 44 | + OutputHelper.box( |
| 45 | + `Failed to check for updates for ${name} due to ${error}` |
| 46 | + ); |
| 47 | + } |
| 48 | + |
| 49 | + return undefined; |
| 50 | + } |
| 51 | + |
| 52 | + private static async _checkForUpdatesInternalAsync( |
| 53 | + options: VersionCheckerOptions |
| 54 | + ): Promise<UpdateCheckResult | undefined> { |
| 55 | + const { |
| 56 | + packageName, |
| 57 | + registryUrl, |
| 58 | + currentVersion, |
| 59 | + packageJsonPath, |
| 60 | + updateCommand = `npm install -g ${packageName}@latest`, |
| 61 | + } = options; |
| 62 | + |
| 63 | + const version = await VersionChecker._queryOurVersionAsync( |
| 64 | + currentVersion, |
| 65 | + packageJsonPath |
| 66 | + ); |
| 67 | + if (!version) { |
| 68 | + if (options.verbose) { |
| 69 | + OutputHelper.error( |
| 70 | + `Could not determine current version for ${packageName}, skipping update check.` |
| 71 | + ); |
| 72 | + } |
| 73 | + return undefined; |
| 74 | + } |
| 75 | + |
| 76 | + const result = await VersionChecker._queryUpdateStateAsync( |
| 77 | + packageName, |
| 78 | + version, |
| 79 | + registryUrl |
| 80 | + ); |
| 81 | + |
| 82 | + if (options.verbose) { |
| 83 | + OutputHelper.info( |
| 84 | + `Checked for updates for ${packageName}. Current version: ${result.currentVersion}, Latest version: ${result.latestVersion}, and update available: ${result.updateAvailable}` |
| 85 | + ); |
| 86 | + } |
| 87 | + |
| 88 | + if (result.updateAvailable) { |
| 89 | + const name = options.humanReadableName || packageName; |
| 90 | + const text = [ |
| 91 | + `${name} update available: ${result.currentVersion} → ${result.latestVersion}`, |
| 92 | + '', |
| 93 | + OutputHelper.formatHint(`Run '${updateCommand}' to update`), |
| 94 | + ].join('\n'); |
| 95 | + |
| 96 | + OutputHelper.box(text, { centered: true }); |
| 97 | + } |
| 98 | + |
| 99 | + return result; |
| 100 | + } |
| 101 | + |
| 102 | + @Memoize() |
| 103 | + private static async _queryOurVersionAsync( |
| 104 | + currentVersion: string | undefined, |
| 105 | + packageJsonPath: string | undefined |
| 106 | + ): Promise<string | null> { |
| 107 | + if (currentVersion) { |
| 108 | + return currentVersion; |
| 109 | + } |
| 110 | + |
| 111 | + if (!packageJsonPath) { |
| 112 | + throw new Error( |
| 113 | + 'Either currentVersion or packageJsonPath must be provided to determine the current version.' |
| 114 | + ); |
| 115 | + } |
| 116 | + |
| 117 | + const pkg = JSON.parse(await readFile(packageJsonPath, 'utf8')); |
| 118 | + return pkg.version || null; |
| 119 | + } |
| 120 | + |
| 121 | + private static async _queryUpdateStateAsync( |
| 122 | + packageName: string, |
| 123 | + currentVersion: string, |
| 124 | + registryUrl: string |
| 125 | + ): Promise<UpdateCheckResult> { |
| 126 | + // Use a simple cache file in the user's home directory |
| 127 | + const cacheKey = `${packageName |
| 128 | + .replace('/', '-') |
| 129 | + .replace('@', '')}-version`; |
| 130 | + const cacheFile = path.join(os.homedir(), '.nevermore-version-cache'); |
| 131 | + |
| 132 | + // Try to read cached data |
| 133 | + let cachedData: VersionCache | undefined; |
| 134 | + let loadedCacheData; |
| 135 | + try { |
| 136 | + const cacheContent = await readFile(cacheFile, 'utf-8'); |
| 137 | + loadedCacheData = JSON.parse(cacheContent); |
| 138 | + cachedData = loadedCacheData[cacheKey] as VersionCache | undefined; |
| 139 | + } catch (error) { |
| 140 | + // Cache file doesn't exist or is invalid, will check for updates |
| 141 | + } |
| 142 | + |
| 143 | + // If we checked recently, skip |
| 144 | + const now = Date.now(); |
| 145 | + if ( |
| 146 | + cachedData && |
| 147 | + (now - cachedData.lastCheck < CHECK_INTERVAL_MS || |
| 148 | + cachedData.currentVersion !== currentVersion) |
| 149 | + ) { |
| 150 | + return { |
| 151 | + updateAvailable: semver.gt(cachedData.latestVersion, currentVersion), |
| 152 | + currentVersion: currentVersion, |
| 153 | + latestVersion: cachedData.latestVersion, |
| 154 | + }; |
| 155 | + } |
| 156 | + |
| 157 | + const { default: latestVersion } = await import('latest-version'); |
| 158 | + |
| 159 | + // Check for new version |
| 160 | + const latestVersionString = await latestVersion(packageName, { |
| 161 | + registryUrl: registryUrl, |
| 162 | + }); |
| 163 | + |
| 164 | + // Save to cache |
| 165 | + const newCache: VersionCache = { |
| 166 | + lastCheck: now, |
| 167 | + latestVersion: latestVersionString, |
| 168 | + currentVersion: currentVersion, |
| 169 | + }; |
| 170 | + const newResults = loadedCacheData || {}; |
| 171 | + newResults[cacheKey] = newCache; |
| 172 | + |
| 173 | + try { |
| 174 | + await writeFile(cacheFile, JSON.stringify(newResults, null, 2), 'utf-8'); |
| 175 | + } catch (error) { |
| 176 | + // Ignore cache write errors, update check still worked |
| 177 | + OutputHelper.warn(`Failed to write cache file: ${error}`); |
| 178 | + } |
| 179 | + |
| 180 | + // Return whether update is available |
| 181 | + return { |
| 182 | + updateAvailable: semver.gt(latestVersionString, currentVersion), |
| 183 | + currentVersion: currentVersion, |
| 184 | + latestVersion: latestVersionString, |
| 185 | + }; |
| 186 | + } |
| 187 | +} |
0 commit comments