-
Notifications
You must be signed in to change notification settings - Fork 55
chore: refactor trimNavigationFiles task to use Gradle Worker API to improve performance #1715
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
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
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
92 changes: 92 additions & 0 deletions
92
buildSrc/src/main/kotlin/aws/sdk/kotlin/dokka/TrimNavigation.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,92 @@ | ||
| /* | ||
| * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| package aws.sdk.kotlin.dokka | ||
|
|
||
| import org.gradle.api.DefaultTask | ||
| import org.gradle.api.file.DirectoryProperty | ||
| import org.gradle.api.logging.Logging | ||
| import org.gradle.api.tasks.InputDirectory | ||
| import org.gradle.api.tasks.TaskAction | ||
| import org.gradle.workers.WorkAction | ||
| import org.gradle.workers.WorkParameters | ||
| import org.gradle.workers.WorkerExecutor | ||
| import org.jsoup.Jsoup | ||
| import java.io.File | ||
| import javax.inject.Inject | ||
| import kotlin.io.walk | ||
|
|
||
| abstract class TrimNavigation @Inject constructor(private val workerExecutor: WorkerExecutor) : DefaultTask() { | ||
| @get:InputDirectory | ||
| abstract val sourceDirectory: DirectoryProperty | ||
|
|
||
| init { | ||
| description = "Trims navigation.html files to remove unrelated projects' side menus" | ||
| group = "documentation" | ||
| } | ||
|
|
||
| @TaskAction | ||
| fun trimNavigation() { | ||
| val queue = workerExecutor.noIsolation() | ||
| val sourceDirectory = this.sourceDirectory.getAsFile().get() | ||
|
|
||
| logger.info("Searching for navigation.html files in $sourceDirectory") | ||
| sourceDirectory | ||
| .walk() | ||
| .filter { it.name == "navigation.html" && it.parentFile != sourceDirectory } | ||
| .forEach { file -> | ||
| queue.submit(TrimModule::class.java) { | ||
| navigationFile = file | ||
| projectRoot = project.layout.projectDirectory.asFile | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| interface TrimModuleParameters : WorkParameters { | ||
| var navigationFile: File | ||
| var projectRoot: File | ||
| } | ||
|
|
||
| abstract class TrimModule : WorkAction<TrimModuleParameters> { | ||
| override fun execute() { | ||
| val navigation = parameters.navigationFile | ||
| val moduleName = navigation.parentFile.name | ||
|
|
||
| val relativePath = navigation.toRelativeString(parameters.projectRoot) | ||
| val logger = Logging.getLogger(TrimNavigation::class.java) | ||
| logger.info("Trimming $relativePath...") | ||
|
|
||
| val doc = Jsoup.parse(navigation) | ||
|
|
||
| // Remove all parent directory elements from all navigation links | ||
| doc.select("a[href^=../]").forEach { anchor -> | ||
| var href = anchor.attr("href") | ||
|
|
||
| while (href.startsWith("../")) { | ||
| href = href.removePrefix("../") | ||
| } | ||
|
|
||
| anchor.attr("href", href) | ||
| } | ||
|
|
||
| // Trim side menus | ||
| doc.select("div.sideMenu > div.toc--part") | ||
| .filterNot { it.id().startsWith("$moduleName-nav-submenu") } | ||
| .forEach { moduleMenu -> | ||
| val moduleRow = moduleMenu.select("div.toc--row").first()!! | ||
| val toggleButton = moduleRow.select("button.toc--button").single() | ||
| toggleButton.remove() | ||
|
|
||
| moduleMenu.children() | ||
| .filterNot { it == moduleRow } | ||
| .forEach { it.remove() } | ||
| } | ||
|
|
||
| // Update navigation.html | ||
| val trimmedSideMenuParts = doc.select("div.sideMenu > div.toc--part") | ||
| navigation.writeText("<div class=\"sideMenu\">\n$trimmedSideMenuParts\n</div>") | ||
| } | ||
| } | ||
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
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.
Note for reviewers: This section is copied directly from the old task impl. No non-refactoring changes made.