fix(update): suppress update nudge when installed version equals latest (#697) - #30
fix(update): suppress update nudge when installed version equals latest (#697)#30chethanuk wants to merge 1 commit into
Conversation
- In update.js, strip leading 'v' from the registry-returned version before SEMVER_RE validation so 'v1.8.6' and '1.8.6' are treated as equal. Previously a v-prefixed registry response failed SEMVER_RE and returned early without removing the stale hint file. - In ocr.js, guard the hint display: normalize both the hint version and the installed package version (stripping 'v') and skip the nudge when they are equal, preventing stale hint files from showing a false alert after the user has already updated. - Add scripts/update.test.js covering semverGt, normalizeVersion, SEMVER_RE validation, and the ocr.js shouldShowNudge guard logic (19 assertions). Fixes alibaba#697
🤖 CodeAnt AI — Review Status
|
Thanks for using CodeAnt! 🎉We're free for open-source projects. if you're enjoying it, help us grow by sharing. Share on X · |
|
Warning Review limit reached
Next review available in: 56 minutes You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (3)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
codeant-ai
Bot
added
the
size:M
User descriptionWhatFixes the false "A new version is available" nudge shown by Root causeTwo code paths each had a v-prefix mismatch that could leave a stale hint file displayed indefinitely:
Fix
TestsAdded
Run: How to test# Unit tests
node scripts/update.test.js
# Manual smoke-test: write a hint file matching the installed version
mkdir -p ~/.opencodereview
echo '{"version":"1.8.6","pkg":"@alibaba-group/open-code-review"}' > ~/.opencodereview/update-available
ocr version # should NOT print the update nudgeAcceptance criteria
CodeAnt-AI DescriptionSuppress false update alerts when the installed version is already current What Changed
Impact
💡 Usage GuideChecking Your Pull RequestEvery time you make a pull request, our system automatically looks through it. We check for security issues, mistakes in how you're setting up your infrastructure, and common code problems. We do this to make sure your changes are solid and won't cause any trouble later. Talking to CodeAnt AIGot a question or need a hand with something in your pull request? You can easily get in touch with CodeAnt AI right here. Just type the following in a comment on your pull request, and replace "Your question here" with whatever you want to ask: This lets you have a chat with CodeAnt AI about your pull request, making it easier to understand and improve your code. ExamplePreserve Org Learnings with CodeAntYou can record team preferences so CodeAnt AI applies them in future reviews. Reply directly to the specific CodeAnt AI suggestion (in the same thread) and replace "Your feedback here" with your input: This helps CodeAnt AI learn and adapt to your team's coding style and standards. ExampleRetrigger reviewAsk CodeAnt AI to review the PR again, by typing: Check Your Repository HealthTo analyze the health of your code repository, visit our dashboard at https://app.codeant.ai. This tool helps you identify potential issues and areas for improvement in your codebase, ensuring your repository maintains high standards of code health. |
![codeant-ai[bot]](https://avatars.githubusercontent.com/in/646884?s=60&v=4){kind=small}
| const pkgVersion = (() => { | ||
| try { | ||
| return require(path.join(__dirname, "..", "package.json")).version || ""; | ||
| } catch (_) { return ""; } | ||
| })(); | ||
| const hintNorm = hint.version.startsWith("v") ? hint.version.slice(1) : hint.version; | ||
| const pkgNorm = pkgVersion.startsWith("v") ? pkgVersion.slice(1) : pkgVersion; | ||
| if (!pkgNorm || hintNorm !== pkgNorm) { |
There was a problem hiding this comment.
Suggestion: The wrapper package version is not necessarily the installed native binary version: OCR_VERSION can pin the binary to an older release while package.json retains the newer wrapper version. In that case this comparison suppresses the hint even though the binary is outdated. Compare against the resolved binary's actual version, or persist and use the version selected during installation. [api mismatch]
Severity Level: Major ⚠️
- ⚠️ Pinned native binaries can be mistaken for current versions.
Prompt for AI Agent 🤖
This is a comment left during a code review.
**Path:** bin/ocr.js
**Line:** 25:32
**Comment:**
*Api Mismatch: The wrapper package version is not necessarily the installed native binary version: `OCR_VERSION` can pin the binary to an older release while `package.json` retains the newer wrapper version. In that case this comparison suppresses the hint even though the binary is outdated. Compare against the resolved binary's actual version, or persist and use the version selected during installation.
Validate the correctness of the flagged issue. If correct, How can I resolve this? If you propose a fix, implement it and please make it concise.
Once fix is implemented, also check other comments on the same PR, and ask user if the user wants to fix the rest of the comments as well. if said yes, then fetch all the comments validate the correctness and implement a minimal fix
1 participant
What
Fixes the false "A new version is available" nudge shown by
ocreven when the installed version already matches the latest published version (issue alibaba#697).Root cause
Two code paths each had a v-prefix mismatch that could leave a stale hint file displayed indefinitely:
scripts/update.js— the background update checker fetches the latest version from the npm registry. If the registry returns a version with a leadingv(e.g.v1.8.6), theSEMVER_REguard (/^\d+.../) rejects it and returns early without callingremoveHint(), so the stale hint file stays on disk.bin/ocr.js— the hint file is read and printed on everyocrinvocation, with no comparison against the currently installed version. Even after the user has already updated, the hint shows until the background script next runs successfully.Fix
scripts/update.js: normalize the registry-returned version by stripping any leadingvbefore the SEMVER_RE check, sov1.8.6is treated the same as1.8.6.bin/ocr.js: before printing the hint, compare the hint version against the npmpackage.jsonversion (both normalized). Skip the nudge when they are equal.Tests
Added
scripts/update.test.js(19 self-contained assertions, no framework dependency) covering:semverGtcorrectness (equal, patch, major, pre-release)normalizeVersionstrippingshouldShowNudgeguard logic (theocr.jsdisplay condition)Run:
node scripts/update.test.js→ 19 passed, 0 failed.How to test
Acceptance criteria
ocr versionon installed v1.8.6 with latest v1.8.6 prints no update nudgev1.8.6vs1.8.6as equal