nx/packages/gradle/src/plugin/utils/get-project-graph-lines.ts
Emily Xiong 5537df6411
feat(gradle): exclude dependsOn tasks (#30913)
<!-- Please make sure you have read the submission guidelines before
posting an PR -->
<!--
https://github.com/nrwl/nx/blob/master/CONTRIBUTING.md#-submitting-a-pr
-->

<!-- Please make sure that your commit message follows our format -->
<!-- Example: `fix(nx): must begin with lowercase` -->

<!-- If this is a particularly complex change or feature addition, you
can request a dedicated Nx release for this pull request branch. Mention
someone from the Nx team or the `@nrwl/nx-pipelines-reviewers` and they
will confirm if the PR warrants its own release for testing purposes,
and generate it for you if appropriate. -->

## Current Behavior
<!-- This is the behavior we have today -->
current gradle task executor will run gradle task as it is. by default,
gradle command will run the tasks itself and its all depends on tasks.

## Expected Behavior
<!-- This is the behavior we should expect with the changes in this PR
-->
- add excludeDependsOn in gradle executor schema with default value to
true: this allows gradle command to run tasks without its dependsOn
tasks. this improves performance time
- change project graph plugin (dev.nx.gradle.project-graph) to accept
option atomizer:
```
nxProjectReport {
	atomized = false
}
```
this will disabled atomized targets to be created. check-ci will not
have dependsOn task ci, it will be test instead.
it will not created any ci and ci--* targets, but check-ci will be
created, but dependsOn test:
<img width="605" alt="Screenshot 2025-05-20 at 3 00 39 PM"
src="https://github.com/user-attachments/assets/a2e0ae20-78a1-4848-a063-5825b169c219"
/>

this is what check-ci target looks like with atomized as true:
<img width="917" alt="Screenshot 2025-05-20 at 2 59 34 PM"
src="https://github.com/user-attachments/assets/33c6af0b-3e45-498d-96d0-4f46c54a8159"
/>

- change dependsOn targets to include both project name and task name.
e.g. `spring-boot:checkFormat
`, so when excludeDependsOn is true, it will exclude exact task
- in batch runner, run test runner and build runner as same time

## Related Issue(s)
<!-- Please link the issue being fixed so it gets closed when this is
merged. -->

Fixes #
2025-05-26 13:59:04 -04:00

90 lines
2.7 KiB
TypeScript

import { AggregateCreateNodesError, output, workspaceRoot } from '@nx/devkit';
import { execGradleAsync, newLineSeparator } from '../../utils/exec-gradle';
import { GradlePluginOptions } from './gradle-plugin-options';
import { dirname } from 'node:path';
export async function getNxProjectGraphLines(
gradlewFile: string,
gradleConfigHash: string,
gradlePluginOptions: GradlePluginOptions
): Promise<string[]> {
if (process.env.VERCEL) {
// skip on Vercel
return [];
}
let nxProjectGraphBuffer: Buffer;
const gradlePluginOptionsArgs =
Object.entries(gradlePluginOptions ?? {})?.map(
([key, value]) => `-P${key}=${value}`
) ?? [];
try {
nxProjectGraphBuffer = await execGradleAsync(gradlewFile, [
'nxProjectGraph',
`-Phash=${gradleConfigHash}`,
'--no-configuration-cache', // disable configuration cache
'--parallel', // add parallel to improve performance
'--build-cache', // enable build cache
'--warning-mode',
'none',
...gradlePluginOptionsArgs,
`-PworkspaceRoot=${workspaceRoot}`,
process.env.NX_VERBOSE_LOGGING ? '--info' : '',
]);
} catch (e: Buffer | Error | any) {
if (e.toString()?.includes('ERROR: JAVA_HOME')) {
throw new AggregateCreateNodesError(
[
[
gradlewFile,
new Error(
`Could not find Java. Please install Java and try again: https://www.java.com/en/download/help/index_installing.html.\n\r${e.toString()}`
),
],
],
[]
);
} else if (e.toString()?.includes(`Task 'nxProjectGraph' not found`)) {
throw new AggregateCreateNodesError(
[
[
gradlewFile,
new Error(
`Could not run 'nxProjectGraph' task. Please run 'nx generate @nx/gradle:init' to add the necessary plugin dev.nx.gradle.project-graph.\n\r${e.toString()}`
),
],
],
[]
);
} else {
throw new AggregateCreateNodesError(
[
[
gradlewFile,
new Error(
`Could not run 'nxProjectGraph' Gradle task. Please install Gradle and try again: https://gradle.org/install/.\r\n${e.toString()}`
),
],
],
[]
);
}
}
const projectGraphLines = nxProjectGraphBuffer
.toString()
.split(newLineSeparator)
.filter((line) => line.trim() !== '');
if (process.env.NX_VERBOSE_LOGGING === 'true') {
output.log({
title: `Successfully ran 'nxProjectGraph' task using ${gradlewFile} with hash ${gradleConfigHash}`,
bodyLines: projectGraphLines,
});
}
return projectGraphLines;
}