fix(gradle): Refactored init-script-gradle.ftl to add support for configuration cache in gradle projects. (IDETECT-4812) #1531
There are no files selected for viewing
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
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 |
|---|---|---|
|
|
@@ -13,174 +13,236 @@ Set<String> projectNameIncludeFilter = convertStringToSet('${includedProjectName | |
| Set<String> projectPathExcludeFilter = convertStringToSet('${excludedProjectPaths}') | ||
| Set<String> projectPathIncludeFilter = convertStringToSet('${includedProjectPaths}') | ||
| Boolean rootOnly = Boolean.parseBoolean("${rootOnlyOption}") | ||
|
|
||
| gradle.allprojects { | ||
| // add a new task to each project to start the process of getting the dependencies | ||
| task gatherDependencies(type: DefaultTask) { | ||
| // Store project name during configuration phase | ||
| def projectName = project.name | ||
| doLast { | ||
| println "Gathering dependencies for " + projectName | ||
| } | ||
| } | ||
|
|
||
| afterEvaluate { currentProject -> | ||
| // Capture all needed project properties during configuration | ||
| def projectPath = currentProject.path | ||
| def projectName = currentProject.name | ||
| def isRootProject = isRoot(currentProject) | ||
| def extractionDir = System.getProperty('GRADLEEXTRACTIONDIR') | ||
| def projectDir = currentProject.projectDir | ||
| def projectDirPath = projectDir.canonicalPath | ||
|
|
||
| // Root project properties | ||
| def rootProject = currentProject.gradle.rootProject | ||
| def rootProjectName = rootProject.name | ||
| def rootProjectPath = rootProject.path | ||
| def rootProjectGroup = rootProject.group.toString() | ||
| def rootProjectVersion = rootProject.version.toString() | ||
| def rootProjectDir = rootProject.projectDir | ||
| def rootProjectDirPath = rootProjectDir.canonicalPath | ||
|
|
||
| // Project metadata | ||
| def projectGroup = currentProject.group.toString() | ||
| def projectVersion = currentProject.version.toString() | ||
| def projectParent = currentProject.parent ? currentProject.parent.toString() : "none" | ||
|
|
||
| // Prepare configuration names | ||
| def configurationNames = getFilteredConfigurationNames(currentProject, | ||
| '${excludedConfigurationNames}', '${includedConfigurationNames}') | ||
|
|
||
| def selectedConfigs = [] | ||
| configurationNames.each { name -> | ||
| try { | ||
| def config = currentProject.configurations.findByName(name) | ||
| if (config) { | ||
| selectedConfigs.add(config) | ||
| } | ||
| } catch (Exception e) { | ||
| println "Could not process configuration: " + name | ||
| throw e | ||
| } | ||
| } | ||
|
|
||
| // Check if the project should be included in results | ||
| def shouldIncludeProject = (rootOnly && isRootProject) || | ||
| (!rootOnly && shouldInclude(projectNameExcludeFilter, projectNameIncludeFilter, projectName) && | ||
| shouldInclude(projectPathExcludeFilter, projectPathIncludeFilter, projectPath)) | ||
|
|
||
| // Capture output file path during configuration | ||
| def projectFilePathConfig = computeProjectFilePath(projectPath, extractionDir) | ||
|
|
||
| // Configure the dependencies task during configuration time | ||
| def dependenciesTask = currentProject.tasks.getByName('dependencies') | ||
|
|
||
| // Set the configurations at configuration time if possible | ||
| if (!selectedConfigs.isEmpty()) { | ||
| dependenciesTask.configurations = selectedConfigs | ||
| } | ||
|
|
||
| // Set the output file at configuration time if possible | ||
| if (shouldIncludeProject) { | ||
| // Create output file directly during configuration | ||
| File projectFile = new File(projectFilePathConfig) | ||
| if (projectFile.exists()) { | ||
| projectFile.delete() | ||
| } | ||
| projectFile.createNewFile() | ||
|
Comment on lines
+86
to
+90
There was a problem hiding this comment. Creating and deleting files during the configuration phase can cause issues with configuration cache and parallel builds. File operations should be moved to task execution phase (doFirst/doLast) to avoid configuration cache violations and ensure proper build isolation. Copilot uses AI. Check for mistakes. There was a problem hiding this comment. This is a known issue. Even though creating file should be part of execution phase but then setting configuration objects like outputFile to that created file, when done should be part of configuration phase. I would like to keep this as it is. |
||
|
|
||
| // Set the output file during configuration phase | ||
| try { | ||
| dependenciesTask.outputFile = projectFile | ||
| println "Set output file during configuration to " + projectFile.getAbsolutePath() | ||
| } catch (Exception e) { | ||
| println "Could not set outputFile property during configuration: " + e.message | ||
| e.printStackTrace() | ||
| throw e | ||
| } | ||
| } | ||
|
|
||
| dependenciesTask.doFirst { | ||
| try { | ||
| if (extractionDir == null) { | ||
| throw new IllegalStateException("GRADLEEXTRACTIONDIR system property is not set") | ||
| } | ||
|
|
||
| // Create metadata file for root project | ||
| if (isRootProject) { | ||
| try { | ||
| File outputDirectory = new File(extractionDir) | ||
| outputDirectory.mkdirs() | ||
| File rootOutputFile = new File(outputDirectory, 'rootProjectMetadata.txt') | ||
|
|
||
| def rootProjectMetadataPieces = [] | ||
| rootProjectMetadataPieces.add('DETECT META DATA START') | ||
| rootProjectMetadataPieces.add("rootProjectDirectory:" + rootProjectDirPath) | ||
| rootProjectMetadataPieces.add("rootProjectPath:" + rootProjectPath) | ||
| rootProjectMetadataPieces.add("rootProjectGroup:" + rootProjectGroup) | ||
| rootProjectMetadataPieces.add("rootProjectName:" + rootProjectName) | ||
| rootProjectMetadataPieces.add("rootProjectVersion:" + rootProjectVersion) | ||
| rootProjectMetadataPieces.add('DETECT META DATA END') | ||
|
|
||
| rootOutputFile.text = rootProjectMetadataPieces.join('\n') | ||
| } catch (Exception e) { | ||
| println "ERROR while generating root project metadata: " + e.message | ||
| e.printStackTrace() | ||
| throw e | ||
| } | ||
| } | ||
| } catch (Exception e) { | ||
| println "ERROR in dependencies doFirst: " + e.message | ||
| e.printStackTrace() | ||
| throw e | ||
| } | ||
| } | ||
|
|
||
| dependenciesTask.doLast { | ||
| try { | ||
| if(shouldIncludeProject) { | ||
| File projectFile = new File(projectFilePathConfig) | ||
|
|
||
| // Add metadata at the end of the file | ||
| def metaDataPieces = [] | ||
| metaDataPieces.add('') | ||
| metaDataPieces.add('DETECT META DATA START') | ||
| metaDataPieces.add("rootProjectDirectory:" + rootProjectDirPath) | ||
| metaDataPieces.add("rootProjectGroup:" + rootProjectGroup) | ||
| metaDataPieces.add("rootProjectPath:" + rootProjectPath) | ||
| metaDataPieces.add("rootProjectName:" + rootProjectName) | ||
| metaDataPieces.add("rootProjectVersion:" + rootProjectVersion) | ||
| metaDataPieces.add("projectDirectory:" + projectDirPath) | ||
| metaDataPieces.add("projectGroup:" + projectGroup) | ||
| metaDataPieces.add("projectName:" + projectName) | ||
| metaDataPieces.add("projectVersion:" + projectVersion) | ||
| metaDataPieces.add("projectPath:" + projectPath) | ||
| metaDataPieces.add("projectParent:" + projectParent) | ||
| metaDataPieces.add('DETECT META DATA END') | ||
| metaDataPieces.add('') | ||
|
|
||
| // Append to file | ||
| projectFile << metaDataPieces.join('\n') | ||
| } | ||
| } catch (Exception e) { | ||
| println "ERROR in dependencies doLast: " + e.message | ||
| e.printStackTrace() | ||
| throw e | ||
| } | ||
| } | ||
|
|
||
| // This forces the dependencies task to be run | ||
| currentProject.gatherDependencies.finalizedBy(currentProject.tasks.getByName('dependencies')) | ||
| currentProject.gatherDependencies | ||
| } | ||
| } | ||
|
|
||
| // ## START methods invoked by tasks above | ||
| <#-- Do not parse with Freemarker because Groovy variable replacement in template strings is the same as Freemarker template syntax. --> | ||
| <#noparse> | ||
| def isRoot(Project project) { | ||
| try { | ||
| Project rootProject = project.gradle.rootProject; | ||
| return project.name.equals(rootProject.name) | ||
| } catch (Exception e) { | ||
| println "ERROR in isRoot: " + e.message | ||
| e.printStackTrace() | ||
| throw e | ||
| } | ||
| } | ||
|
|
||
|
|
||
| // Get path for project file | ||
| def computeProjectFilePath(String projectPath, String outputDirectoryPath) { | ||
| try { | ||
| File outputDirectory = createTaskOutputDirectory(outputDirectoryPath) | ||
| String name = projectPath ?: "" | ||
|
|
||
| int depthCount = 0 | ||
| for(char c: name.toCharArray()) { | ||
| if (c == ':') { | ||
| depthCount++ | ||
| } | ||
| } | ||
| String depth = String.valueOf(depthCount) | ||
| // Special case for root project | ||
| if (projectPath == ":") { | ||
| return new File(outputDirectory, "root_project_depth${depth}_dependencyGraph.txt").getAbsolutePath() | ||
| } | ||
| // Replace all non-alphanumeric characters with underscores | ||
|
|
||
| String nameForFile = name?.replaceAll(/[^\p{IsAlphabetic}\p{Digit}]/, "_") | ||
| nameForFile = "project_" + nameForFile | ||
| return new File(outputDirectory, "${nameForFile}_depth${depth}_dependencyGraph.txt").getAbsolutePath() | ||
| } catch (Exception e) { | ||
| println "ERROR in computeProjectFilePath: " + e.message | ||
| e.printStackTrace() | ||
| throw e | ||
| } | ||
| } | ||
|
|
||
| // Get only configuration names to avoid serialization issues | ||
| def getFilteredConfigurationNames(Project project, String excludedConfigurationNames, String includedConfigurationNames) { | ||
| try { | ||
| Set<String> configurationExcludeFilter = convertStringToSet(excludedConfigurationNames) | ||
| Set<String> configurationIncludeFilter = convertStringToSet(includedConfigurationNames) | ||
| Set<String> filteredNames = new TreeSet<String>() | ||
|
|
||
| for (def configuration : project.configurations) { | ||
| try { | ||
| if (shouldInclude(configurationExcludeFilter, configurationIncludeFilter, configuration.name)) { | ||
| filteredNames.add(configuration.name) | ||
| } | ||
| } catch (Exception e) { | ||
| println "ERROR processing configuration " + configuration.name + ": " + e.message | ||
| throw e | ||
| } | ||
| } | ||
|
|
||
| return filteredNames | ||
| } catch (Exception e) { | ||
| println "ERROR in getFilteredConfigurationNames: " + e.message | ||
| e.printStackTrace() | ||
| throw e | ||
| } | ||
| } | ||
|
|
||
| def createTaskOutputDirectory(String outputDirectoryPath) { | ||
|
|
@@ -219,7 +281,7 @@ def wildCardTokenToRegexToken(String token) { | |
| if(matcher.group(1) != null) { | ||
| matcher.appendReplacement(buffer, '.*') | ||
| } else if (matcher.group(2) != null) { | ||
| matcher.appendReplacement(buffer, "."); | ||
| } else { | ||
| matcher.appendReplacement(buffer, '\\\\Q' + matcher.group(0) + '\\\\E') | ||
| } | ||
|
|
||
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.
Setting task properties directly with Configuration objects can cause serialization issues with configuration cache. Consider using configuration names and resolving configurations during task execution instead.
Copilot uses AI. Check for mistakes.
Uh oh!
There was an error while loading. Please reload this page.
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.
Setting configuration object properties during configuration phase is not causing serialization issues as tested with multiple projects. I assume this is what Gradle wants for now.