-
-
Notifications
You must be signed in to change notification settings - Fork 47
fix: Bound live build output memory #1642
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
Open
mvanhorn
wants to merge
1
commit into
appdevforall:stage
Choose a base branch
from
mvanhorn:fix/1367-bound-build-output-memory
base: stage
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
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
146 changes: 146 additions & 0 deletions
146
app/src/main/java/com/itsaky/androidide/fragments/output/BuildOutputBuffer.kt
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,146 @@ | ||
| /* | ||
| * This file is part of AndroidIDE. | ||
| * | ||
| * AndroidIDE is free software: you can redistribute it and/or modify | ||
| * it under the terms of the GNU General Public License as published by | ||
| * the Free Software Foundation, either version 3 of the License, or | ||
| * (at your option) any later version. | ||
| * | ||
| * AndroidIDE is distributed in the hope that it will be useful, | ||
| * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| * GNU General Public License for more details. | ||
| * | ||
| * You should have received a copy of the GNU General Public License | ||
| * along with AndroidIDE. If not, see <https://www.gnu.org/licenses/>. | ||
| */ | ||
|
|
||
| package com.itsaky.androidide.fragments.output | ||
|
|
||
| import kotlinx.coroutines.channels.Channel | ||
|
|
||
| /** | ||
| * Thread-safe pending build output with fixed memory and batch budgets. | ||
| * | ||
| * Inputs are indivisible: one input larger than [maxBatchChars] is emitted alone, while one larger | ||
| * than [maxPendingChars] is omitted. Other inputs are never split or reordered. | ||
| */ | ||
| internal class BuildOutputBuffer( | ||
| private val maxPendingChars: Int = DEFAULT_MAX_PENDING_CHARS, | ||
| private val maxBatchChars: Int = DEFAULT_MAX_BATCH_CHARS, | ||
| ) { | ||
| data class Batch( | ||
| val text: String, | ||
| val sessionGeneration: Int, | ||
| ) | ||
|
|
||
| private sealed interface Entry { | ||
| val sessionGeneration: Int | ||
|
|
||
| data class Text( | ||
| val value: String, | ||
| override val sessionGeneration: Int, | ||
| ) : Entry | ||
|
|
||
| data class Omission( | ||
| var lineCount: Long, | ||
| override val sessionGeneration: Int, | ||
| ) : Entry | ||
| } | ||
|
|
||
| private val entries = ArrayDeque<Entry>() | ||
| private val available = Channel<Unit>(Channel.CONFLATED) | ||
| private val lock = Any() | ||
| private var retainedChars = 0 | ||
| private var omission: Entry.Omission? = null | ||
|
|
||
| internal val pendingChars: Int | ||
| get() = synchronized(lock) { retainedChars } | ||
|
|
||
| init { | ||
| require(maxPendingChars > 0) { "maxPendingChars must be positive" } | ||
| require(maxBatchChars > 0) { "maxBatchChars must be positive" } | ||
| } | ||
|
|
||
| fun offer( | ||
| text: String, | ||
| sessionGeneration: Int, | ||
| ) { | ||
| if (text.isEmpty()) return | ||
| val needsNewline = !text.endsWith('\n') | ||
| val normalizedLength = text.length.toLong() + if (needsNewline) 1 else 0 | ||
| val lineCount = text.count { it == '\n' }.toLong() + if (needsNewline) 1 else 0 | ||
| synchronized(lock) { | ||
| if ( | ||
| normalizedLength > maxPendingChars.toLong() || | ||
| normalizedLength > (maxPendingChars - retainedChars).toLong() | ||
| ) { | ||
| val existingOmission = omission | ||
| if ( | ||
| existingOmission?.sessionGeneration == sessionGeneration && | ||
| entries.lastOrNull() === existingOmission | ||
| ) { | ||
| existingOmission.lineCount += lineCount | ||
| } else { | ||
| val marker = Entry.Omission(lineCount, sessionGeneration) | ||
| omission = marker | ||
| entries.addLast(marker) | ||
| } | ||
| } else { | ||
| val normalized = if (needsNewline) "$text\n" else text | ||
| entries.addLast(Entry.Text(normalized, sessionGeneration)) | ||
| retainedChars += normalizedLength.toInt() | ||
| } | ||
| available.trySend(Unit) | ||
| } | ||
| } | ||
|
|
||
| suspend fun takeBatch(): Batch { | ||
| while (true) { | ||
| available.receive() | ||
| val batch = synchronized(lock) { takeAvailableBatch() } | ||
| if (batch != null) return batch | ||
| } | ||
| } | ||
|
|
||
| fun clear() { | ||
| synchronized(lock) { | ||
| entries.clear() | ||
| retainedChars = 0 | ||
| omission = null | ||
| while (available.tryReceive().isSuccess) { | ||
| // Discard stale wakeups from the cleared build session. | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private fun takeAvailableBatch(): Batch? { | ||
| if (entries.isEmpty()) return null | ||
| val sessionGeneration = entries.first().sessionGeneration | ||
| val batch = StringBuilder(minOf(retainedChars, maxBatchChars)) | ||
| while (entries.isNotEmpty()) { | ||
| val entry = entries.first() | ||
| if (entry.sessionGeneration != sessionGeneration) break | ||
| val value = | ||
| when (entry) { | ||
| is Entry.Text -> entry.value | ||
| is Entry.Omission -> omissionMarker(entry.lineCount) | ||
| } | ||
| if (batch.isNotEmpty() && batch.length + value.length > maxBatchChars) break | ||
|
|
||
| entries.removeFirst() | ||
| batch.append(value) | ||
| if (entry is Entry.Text) retainedChars -= entry.value.length | ||
| if (entry is Entry.Omission && omission === entry) omission = null | ||
| } | ||
| if (entries.isNotEmpty()) available.trySend(Unit) | ||
| return Batch(batch.toString(), sessionGeneration) | ||
| } | ||
|
|
||
| private fun omissionMarker(lineCount: Long): String = "[$lineCount build output lines omitted]\n" | ||
|
|
||
| companion object { | ||
| private const val DEFAULT_MAX_PENDING_CHARS = 256 * 1024 | ||
| private const val DEFAULT_MAX_BATCH_CHARS = 32 * 1024 | ||
| } | ||
| } | ||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Fix the singular form of the omission marker.
The marker always uses "lines". For
lineCount == 1the output reads "[1 build output lines omitted]". Users see this text in the build output pane. The test atBuildOutputBufferTest.ktline 100 currently asserts the incorrect form, so update that expectation too.The string is also hardcoded here instead of a string resource. If the build output pane is localized elsewhere, move this marker to
strings.xmlwith a plurals entry.🔤 Proposed fix for the singular case
📝 Committable suggestion
🤖 Prompt for AI Agents