ADFA-4419: Remote peer editor decoration API - #1459
Conversation
Add IdeEditorService.addRemotePeerMarker/removeRemotePeerMarker/clearRemotePeerMarkers as default-implemented (backward-compatible) methods so a plugin can draw a remote collaborator's caret/badge inside the editor. Backed by a new EditorDecorationManager + RemotePeerMarkerWindow (an EditorPopupWindow overlay that tracks scroll via FEATURE_SCROLL_AS_CONTENT) in the app module; EditorProviderImpl resolves the live editor via EditorHandlerActivity.getEditorForFile and marshals onto the main thread, clearing markers on dispose. IdeEditorServiceImpl exposes read-gated overrides and the parallel EditorProvider contract methods. The new interface methods are default-implemented so this is an additive, non-breaking change for the generated plugin-api lib and existing implementers. Consumed by the Pair pair-programming plugin.
…e-peer-editor-decoration
…e-peer-editor-decoration
…orations Rename EditorDecorationManager -> PeerPresenceOverlayManager and extract a focused PeerPresenceProvider interface out of the broad EditorProvider, so the pair-programming peer-cursor overlay (floating named badges) reads as a distinct concern from the generic EditorDecorationProvider (additive color spans) added in #1448 (ADFA-4436). Host-internal only: no plugin-api contract changed and the merged rainbow- brackets plugin is unaffected. Verified with :app:compileV8DebugKotlin.
There was a problem hiding this comment.
Claude Code Review
This repository is configured for manual code reviews. Comment @claude review to trigger a review and subscribe this PR to future pushes, or @claude review once for a one-time review.
Tip: disable this comment in your organization's Code Review settings.
|
@claude review |
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 Walkthrough
Risks and best-practice concerns
WalkthroughThe PR adds peer-cursor overlays, exposes an asynchronous ChangesPeer Cursor Overlay Feature
openProject Plugin API Implementation
Plugin Load Error Tracking
Estimated code review effort: 4 (Complex) | ~45 minutes Sequence Diagram(s)sequenceDiagram
participant Plugin as IdeEditorServiceImpl
participant Provider as EditorProviderImpl
participant Overlay as PeerCursorOverlayManager
participant Window as PeerCursorWindow
Plugin->>Provider: showPeerCursor(file, line, column, peerId, peerName, peerColor)
Provider->>Overlay: addMarker(...)
Overlay->>Window: update(...)
Window->>Window: show cursor badge
sequenceDiagram
participant Caller as Plugin
participant Service as IdeProjectServiceImpl
participant Activity as ActivityProvider
participant State as ProjectPreferences
Caller->>Service: openProject(projectDir)
Service->>Service: validate permission and canonical path
Service->>Activity: obtain foreground activity
Service->>State: persist project state
Service->>Activity: recreate activity
Possibly related PRs
Suggested reviewers: Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches 💡 1📝 Generate docstrings 💡
🧪 Generate unit tests (beta)
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 |
There was a problem hiding this comment.
Actionable comments posted: 5
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In
`@app/src/main/java/com/itsaky/androidide/activities/editor/PeerPresenceOverlayManager.kt`:
- Around line 122-125: The clamping logic in PeerPresenceOverlayManager’s
position calculation does not handle the exact-fit case because when maxX is 0
it falls back to rawX, allowing the overlay to render off-screen; update the x
computation so the clamp applies whenever the editor width is known, including
when label.measuredWidth equals boundEditor.width, and keep the existing
rawX.coerceIn(0, maxX) behavior for all non-negative maxX values.
In
`@app/src/main/java/com/itsaky/androidide/repositories/PluginRepositoryImpl.kt`:
- Around line 147-154: The failure path in installPluginFromFile() leaves a
broken upgraded plugin on disk after the old version has already been removed,
so adjust the replace flow to avoid half-installed upgrades. Use the existing
load check around manager.loadPlugins()/manager.getPlugin(pluginId) to either
delay uninstalling the current plugin until the new package is proven loadable,
or restore the previous package on failure. In the failure branch that throws
IllegalStateException, also delete the copied finalFile so future
PluginRepositoryImpl loads do not keep retrying the bad artifact.
In
`@plugin-manager/src/main/kotlin/com/itsaky/androidide/plugins/manager/core/PluginManager.kt`:
- Around line 279-284: The load path in PluginManager.loadPlugins is swallowing
coroutine cancellation by catching all Exception around loadPlugin, so a
cancelled job is treated like a plugin failure instead of stopping execution.
Narrow the catch in the loadPlugin/result block to let CancellationException
pass through unchanged, and only wrap genuine plugin load errors in
Result.failure before calling recordLoadFailure.
In
`@plugin-manager/src/main/kotlin/com/itsaky/androidide/plugins/manager/services/IdeEditorServiceImpl.kt`:
- Around line 283-292: `hidePeerCursor` and `clearPeerCursors` in
`IdeEditorServiceImpl` are unnecessarily gated by `ensureFileAccessible(file)`,
which blocks overlay cleanup when the file/tab is no longer open. Remove the
accessibility check from these cleanup-only paths while keeping `requireRead()`
and the downstream `editorProvider.hidePeerCursor(...)` /
`editorProvider.clearPeerCursors(...)` calls so peer overlays can still be
dismissed by file key.
In
`@plugin-manager/src/main/kotlin/com/itsaky/androidide/plugins/manager/services/IdeProjectServiceImpl.kt`:
- Around line 97-105: Use the validated canonical project path in
IdeProjectServiceImpl.openProject and apply the existing PathValidator before
switching projects. The current flow checks containment with
isUnderProjectsDir(projectDir) but later persists the original path, so update
the openProject logic to reuse the validated canonical target and run it through
PathValidator like getProjectByPath does before calling the project
switch/selection code.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: e0348b09-b91a-4370-9cb1-9c72e245fff6
📒 Files selected for processing (7)
app/src/main/java/com/itsaky/androidide/activities/editor/PeerPresenceOverlayManager.ktapp/src/main/java/com/itsaky/androidide/app/EditorProviderImpl.ktapp/src/main/java/com/itsaky/androidide/repositories/PluginRepositoryImpl.ktplugin-api/src/main/kotlin/com/itsaky/androidide/plugins/services/IdeServices.ktplugin-manager/src/main/kotlin/com/itsaky/androidide/plugins/manager/core/PluginManager.ktplugin-manager/src/main/kotlin/com/itsaky/androidide/plugins/manager/services/IdeEditorServiceImpl.ktplugin-manager/src/main/kotlin/com/itsaky/androidide/plugins/manager/services/IdeProjectServiceImpl.kt
- PeerPresenceOverlayManager: clamp peer badge on exact-fit width (maxX >= 0) - PluginManager.loadPlugins: rethrow CancellationException instead of recording cancellation as a plugin load failure - IdeEditorServiceImpl: don't gate hidePeerCursor/clearPeerCursors on file accessibility, so overlay cleanup still works after a tab closes - IdeProjectServiceImpl.openProject: use the validated canonical path and run it through PathValidator before switching projects - PluginRepositoryImpl: delete the broken artifact when an upgraded plugin fails to load, so loadPlugins() doesn't keep retrying it - Drop PairTrace / [HOST] dev-trace Log.d (kept warn/error diagnostics)
…e-peer-editor-decoration # Conflicts: # plugin-api/src/main/kotlin/com/itsaky/androidide/plugins/services/IdeServices.kt # plugin-manager/src/main/kotlin/com/itsaky/androidide/plugins/manager/core/PluginManager.kt
|
Note GitHub couldn't provide a complete incremental comparison for this pull request, so CodeRabbit is performing a full review instead. This review may take a little longer. |
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
plugin-manager/src/main/kotlin/com/itsaky/androidide/plugins/manager/services/IdeProjectServiceImpl.kt (1)
5-5: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low valueReplace
android.util.Logwith SLF4J logging.
IdeProjectServiceImplstill importsandroid.util.Log, andopenProject()emits unstructured string logs withLog.w()/Log.e(). Use the module’s standardLoggerFactorylogger with structured placeholders for these messages.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@plugin-manager/src/main/kotlin/com/itsaky/androidide/plugins/manager/services/IdeProjectServiceImpl.kt` at line 5, Replace the android.util.Log usage in IdeProjectServiceImpl, including the Log.w()/Log.e() calls in openProject(), with the module-standard LoggerFactory SLF4J logger. Preserve the existing log levels and messages while converting interpolated values to structured placeholders and passing arguments separately.Source: Coding guidelines
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In
`@plugin-api/src/main/kotlin/com/itsaky/androidide/plugins/services/IdeServices.kt`:
- Around line 35-51: The changed files
plugin-api/src/main/kotlin/com/itsaky/androidide/plugins/services/IdeServices.kt
lines 35-51 and
plugin-manager/src/main/kotlin/com/itsaky/androidide/plugins/manager/services/IdeProjectServiceImpl.kt
lines 95-125 require formatting updates: run Spotless or otherwise reformat both
complete files using tabs and LF line endings, and replace any newly introduced
em dashes or en dashes in IdeProjectServiceImpl with ASCII punctuation.
In
`@plugin-manager/src/main/kotlin/com/itsaky/androidide/plugins/manager/services/IdeProjectServiceImpl.kt`:
- Around line 119-130: Update MainActivity.openProject so it no longer writes
ProjectManagerImpl.projectPath or GeneralPreferences.lastOpenedProject before
activity.recreate(). Move those assignments into the editor activity’s
onNewIntent/setup path that performs the actual reload, ensuring project state
changes only when recreation is successfully handled.
---
Nitpick comments:
In
`@plugin-manager/src/main/kotlin/com/itsaky/androidide/plugins/manager/services/IdeProjectServiceImpl.kt`:
- Line 5: Replace the android.util.Log usage in IdeProjectServiceImpl, including
the Log.w()/Log.e() calls in openProject(), with the module-standard
LoggerFactory SLF4J logger. Preserve the existing log levels and messages while
converting interpolated values to structured placeholders and passing arguments
separately.
🪄 Autofix
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro Plus
Run ID: e4e5cb3d-f162-4373-9267-4f582a290457
📒 Files selected for processing (8)
app/src/main/java/com/itsaky/androidide/activities/editor/PeerPresenceOverlayManager.ktapp/src/main/java/com/itsaky/androidide/app/EditorProviderImpl.ktapp/src/main/java/com/itsaky/androidide/repositories/PluginRepositoryImpl.ktplugin-api/api/plugin-api.apiplugin-api/src/main/kotlin/com/itsaky/androidide/plugins/services/IdeServices.ktplugin-manager/src/main/kotlin/com/itsaky/androidide/plugins/manager/core/PluginManager.ktplugin-manager/src/main/kotlin/com/itsaky/androidide/plugins/manager/services/IdeEditorServiceImpl.ktplugin-manager/src/main/kotlin/com/itsaky/androidide/plugins/manager/services/IdeProjectServiceImpl.kt
🚧 Files skipped from review as they are similar to previous changes (5)
- app/src/main/java/com/itsaky/androidide/repositories/PluginRepositoryImpl.kt
- plugin-manager/src/main/kotlin/com/itsaky/androidide/plugins/manager/services/IdeEditorServiceImpl.kt
- app/src/main/java/com/itsaky/androidide/app/EditorProviderImpl.kt
- app/src/main/java/com/itsaky/androidide/activities/editor/PeerPresenceOverlayManager.kt
- plugin-manager/src/main/kotlin/com/itsaky/androidide/plugins/manager/core/PluginManager.kt
spotlessApply reformatting across the seven files this branch touched, plus the three lints ktlint cannot auto-fix: expand the wildcard import in PluginManager, move the orphaned KDoc onto delegatingEditorProvider, and rename INSTANCE/Loader to instance/loader per property-naming.
There was a problem hiding this comment.
Actionable comments posted: 4
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In
`@plugin-manager/src/main/kotlin/com/itsaky/androidide/plugins/manager/core/PluginManager.kt`:
- Around line 1255-1269: In PluginManager.kt, wrap activityProvider in a
delegating provider analogous to delegatingEditorProvider so
IdeProjectServiceImpl receives a provider that reflects later
setActivityProvider() updates. Apply this wrapper at both project-service
construction sites: lines 1255-1269 and 1505-1519; update each
IdeProjectServiceImpl call without changing unrelated providers or validation
logic.
In
`@plugin-manager/src/main/kotlin/com/itsaky/androidide/plugins/manager/services/IdeProjectServiceImpl.kt`:
- Around line 101-102: Update the warning in IdeProjectServiceImpl’s
project-opening validation to use only a stable failure code or exception class,
removing both requested and configured project paths; also update the
catch/logging block around lines 133-135 to omit e.message and log only
non-sensitive exception metadata.
- Around line 176-178: Update the allowed-path check in the project
authorization method to compare canonical Path values, or require either an
exact root match or a separator-delimited descendant match. Ensure sibling paths
such as similarly prefixed directories are rejected while valid descendants
remain authorized, preserving the behavior used by getProjectByPath.
- Around line 52-57: Update IdeProjectServiceImpl query methods at
plugin-manager/src/main/kotlin/com/itsaky/androidide/plugins/manager/services/IdeProjectServiceImpl.kt:52-57,
65-70, and 83-88 to catch only the expected recoverable provider exception, log
the failure with the fallback, and retain the existing fallback values. At
plugin-manager/src/main/kotlin/com/itsaky/androidide/plugins/manager/services/IdeProjectServiceImpl.kt:133-135,
replace android.util.Log usage in openProject with the established SLF4J logger.
🪄 Autofix
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro Plus
Run ID: 2de320a2-51cf-4d59-955f-11b66c5f62b5
📒 Files selected for processing (7)
app/src/main/java/com/itsaky/androidide/activities/editor/PeerPresenceOverlayManager.ktapp/src/main/java/com/itsaky/androidide/app/EditorProviderImpl.ktapp/src/main/java/com/itsaky/androidide/repositories/PluginRepositoryImpl.ktplugin-api/src/main/kotlin/com/itsaky/androidide/plugins/services/IdeServices.ktplugin-manager/src/main/kotlin/com/itsaky/androidide/plugins/manager/core/PluginManager.ktplugin-manager/src/main/kotlin/com/itsaky/androidide/plugins/manager/services/IdeEditorServiceImpl.ktplugin-manager/src/main/kotlin/com/itsaky/androidide/plugins/manager/services/IdeProjectServiceImpl.kt
🚧 Files skipped from review as they are similar to previous changes (5)
- app/src/main/java/com/itsaky/androidide/app/EditorProviderImpl.kt
- app/src/main/java/com/itsaky/androidide/repositories/PluginRepositoryImpl.kt
- plugin-api/src/main/kotlin/com/itsaky/androidide/plugins/services/IdeServices.kt
- plugin-manager/src/main/kotlin/com/itsaky/androidide/plugins/manager/services/IdeEditorServiceImpl.kt
- app/src/main/java/com/itsaky/androidide/activities/editor/PeerPresenceOverlayManager.kt
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
app/src/main/java/com/itsaky/androidide/activities/editor/PeerCursorOverlayManager.kt (2)
50-56: 🩺 Stability & Availability | 🟡 Minor | ⚡ Quick winRemove the empty per-file map after the last peer is removed.
Line [54] removes only the peer entry. When it is the last entry,
markersretains an empty map and the file path untilclearorclearAllruns. Remove the outer entry whenbyPeer.isEmpty().Proposed fix
fun removeMarker( file: File, peerId: String, ): Boolean { - val removed = markers[file.absolutePath]?.remove(peerId) ?: return false + val path = file.absolutePath + val byPeer = markers[path] ?: return false + val removed = byPeer.remove(peerId) ?: return false removed.dismiss() + if (byPeer.isEmpty()) { + markers.remove(path) + } return true }🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@app/src/main/java/com/itsaky/androidide/activities/editor/PeerCursorOverlayManager.kt` around lines 50 - 56, Update removeMarker in PeerCursorOverlayManager to remove the file’s outer markers entry after removing a peer when the per-file map is empty. Preserve the current false return for missing files or peer IDs and the dismiss/true behavior for successful removals.
69-130: 🩺 Stability & Availability | 🟡 Minor | ⚡ Quick winUnregister each window before dismissing it.
EditorPopupWindow.dismiss()does not unregister its scroll receiver. Callunregister()on every cleanup path beforedismiss(); otherwise replaced windows can remain registered with the old editor and retain stale callbacks.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@app/src/main/java/com/itsaky/androidide/activities/editor/PeerCursorOverlayManager.kt` around lines 69 - 130, Update every cleanup path that removes a PeerCursorWindow to call its unregister() method before dismiss(). Ensure replaced and otherwise discarded windows are unregistered before dismissal so no stale scroll receiver or callbacks remain attached to the old editor.Source: Coding guidelines
🧹 Nitpick comments (2)
app/src/main/java/com/itsaky/androidide/activities/editor/PeerCursorOverlayManager.kt (2)
20-32: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winAdd KDoc for the public overlay API.
PeerCursorOverlayManager,addMarker,removeMarker,clear, andclearAlldo not document their threading requirements, return values, or dismissal side effects. Add concise KDoc before merge.As per coding guidelines: public classes, functions, and non-obvious logic must have KDoc or Javadoc documenting contracts, threading, nullability, and side effects.
Also applies to: 50-64
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@app/src/main/java/com/itsaky/androidide/activities/editor/PeerCursorOverlayManager.kt` around lines 20 - 32, Add concise KDoc for the public class PeerCursorOverlayManager and its methods addMarker, removeMarker, clear, and clearAll, documenting their threading requirements, return values, nullability, and marker dismissal side effects. Preserve the existing behavior and cover the related API methods shown in the diff.Source: Coding guidelines
132-139: 🎯 Functional Correctness | 🔵 Trivial | ⚡ Quick winAdd contrast tests and correct the threshold
contrastingTextColoruses non-linear RGB values and ignores alpha. For example,#999999selects white at only 2.85:1 contrast, and translucent red over white drops to 1.56:1. Add light, dark, boundary, and alpha tests. Select the foreground from the composited background so it meets the intended contrast target.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@app/src/main/java/com/itsaky/androidide/activities/editor/PeerCursorOverlayManager.kt` around lines 132 - 139, Update contrastingTextColor to linearize RGB channels, composite translucent backgrounds over the actual base background, and choose the foreground using a contrast calculation that meets the intended target rather than the fixed 0.6 luminance threshold. Add tests covering light, dark, threshold-boundary, and alpha-composited backgrounds, including the cited gray and translucent-red cases.Source: Coding guidelines
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Outside diff comments:
In
`@app/src/main/java/com/itsaky/androidide/activities/editor/PeerCursorOverlayManager.kt`:
- Around line 50-56: Update removeMarker in PeerCursorOverlayManager to remove
the file’s outer markers entry after removing a peer when the per-file map is
empty. Preserve the current false return for missing files or peer IDs and the
dismiss/true behavior for successful removals.
- Around line 69-130: Update every cleanup path that removes a PeerCursorWindow
to call its unregister() method before dismiss(). Ensure replaced and otherwise
discarded windows are unregistered before dismissal so no stale scroll receiver
or callbacks remain attached to the old editor.
---
Nitpick comments:
In
`@app/src/main/java/com/itsaky/androidide/activities/editor/PeerCursorOverlayManager.kt`:
- Around line 20-32: Add concise KDoc for the public class
PeerCursorOverlayManager and its methods addMarker, removeMarker, clear, and
clearAll, documenting their threading requirements, return values, nullability,
and marker dismissal side effects. Preserve the existing behavior and cover the
related API methods shown in the diff.
- Around line 132-139: Update contrastingTextColor to linearize RGB channels,
composite translucent backgrounds over the actual base background, and choose
the foreground using a contrast calculation that meets the intended target
rather than the fixed 0.6 luminance threshold. Add tests covering light, dark,
threshold-boundary, and alpha-composited backgrounds, including the cited gray
and translucent-red cases.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro Plus
Run ID: 5058d050-67b1-4fca-b564-4c7101fafde3
📒 Files selected for processing (7)
app/src/main/java/com/itsaky/androidide/activities/editor/PeerCursorOverlayManager.ktapp/src/main/java/com/itsaky/androidide/app/EditorProviderImpl.ktplugin-api/api/plugin-api.apiplugin-api/src/main/kotlin/com/itsaky/androidide/plugins/services/IdeServices.ktplugin-manager/src/main/kotlin/com/itsaky/androidide/plugins/manager/core/PluginManager.ktplugin-manager/src/main/kotlin/com/itsaky/androidide/plugins/manager/services/IdeEditorServiceImpl.ktplugin-manager/src/main/kotlin/com/itsaky/androidide/plugins/manager/services/IdeProjectServiceImpl.kt
🚧 Files skipped from review as they are similar to previous changes (6)
- plugin-api/api/plugin-api.api
- plugin-manager/src/main/kotlin/com/itsaky/androidide/plugins/manager/core/PluginManager.kt
- app/src/main/java/com/itsaky/androidide/app/EditorProviderImpl.kt
- plugin-manager/src/main/kotlin/com/itsaky/androidide/plugins/manager/services/IdeEditorServiceImpl.kt
- plugin-api/src/main/kotlin/com/itsaky/androidide/plugins/services/IdeServices.kt
- plugin-manager/src/main/kotlin/com/itsaky/androidide/plugins/manager/services/IdeProjectServiceImpl.kt
Summary
Host-side support for the pair-programming plugin (ADFA-4419): lets the external
.cgppair plugin render remote collaborators in the editor and drive shared editing entirely throughplugin-api. The pair plugin itself ships separately; this PR adds only the host contract + bridge it talks to.