[0.1.5] Limit concurrency: discard stale annotation results per file; add SDK env tests - #33
Merged
Conversation
… add SDK env tests
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
Two changes in this PR:
1. Concurrency: discard stale annotation results per file
When the IDE triggers multiple rapid annotations for the same file (e.g. during a series of quick saves), only the last check result is now applied. Each file has a generation counter (
ConcurrentHashMapinDocscribeAnnotator.fileGeneration) — if a newer check starts while an older one is still running, the older result is discarded on completion.Before: rapid saves triggered N concurrent
bundle exec docscribecalls for the same file. All N results were applied in sequence, with the last one overwriting — wasted work and potential race conditions.After: each file has a generation counter incremented at the start of
doAnnotate(). On completion, the saved generation is compared to the current value. If they differ, the result is discarded. Only the latest check's annotations reach the editor.2. Tests + KDoc for Ruby SDK environment
PR #32 added
buildSdkEnvironment()andDefaultCommandExecutor(environment)but lacked tests and docs:DefaultCommandExecutor— KDoc forenvironmentparameter (how SDK PATH injection works)DefaultCommandExecutor with environment does not throw— integration test verifying the env constructor works withrunDocscribe()Files
DocscribeAnnotator.ktDocscribeAnnotatorTest.ktDocscribeRunner.ktDefaultCommandExecutor.environmentDocscribeRunnerTest.ktDefaultCommandExecutor(environment)CHANGELOG.mdChecklist
./gradlew test)./gradlew spotlessCheck)./gradlew detekt)./gradlew verifyPlugin)