feat(gradle): allow specifying Gradle daemon heap size (renovatebot#40090)

This change introduces a heap size limitation for the Gradle daemon used
when updating the Gradle wrapper, defaults to 512m.

The heap size is limited to the globally configured limit, which
defaults to 512m. It can be configured on the repository level, but not
exceed the globally configured limit. A hard coded mimiumum heap size of
512m is enforced.

The configuration option is named `toolSettings`, which has two
properties for the maximum and initial heap size. See
`docs/usage/configuration-options#toolSettings` for more details.

Author: snazy

docs/usage/configuration-options.md

@@ -4690,6 +4690,36 @@ We recommend that you only configure the `timezone` option if _both_ of these ar
 
 Please see the above link for valid timezone names.
 
+## toolSettings
+
+When Renovate updates a dependency and needs to invoke processes leveraging Java, for example Gradle for [the `gradle-wrapper` manager](./modules/manager/gradle-wrapper/index.md), the repository's Gradle Wrapper will be invoked, if present.
+
+The JVM heap size for the Java invocations is 512m by default.
+This can be overridden using the following options.
+
+This option can be used on the repository level and in the [Renovate configuration](./self-hosted-configuration.md) using the following options.
+
+<!-- prettier-ignore -->
+!!! note
+    The JVM memory settings specified in the global self-hosted configuration set by the administrator in [`toolSettings.jvmMaxMemory`](./self-hosted-configuration.md) limits the memory settings for all repositories.
+    The default limit for all repositories is 512m.
+
+<!-- prettier-ignore -->
+!!! note
+    The JVM memory settings are considered for the `gradle-wrapper` manager.
+
+### jvmMaxMemory
+
+Maximum heap size in MB for Java VMs.
+Defaults to `512` for both the repository level and self-hosted configuration.
+
+To allow repositories to use _more_ than 512m of heap during the Gradle Wrapper update, configure the `jvmMaxMemory` option in the [`toolSettings.jvmMaxMemory`](./self-hosted-configuration.md).
+
+### jvmMemory
+
+Initial heap size in MB for Java VMs. Must be less than or equal to `jvmMaxMemory`.
+Defaults to `jvmMaxMemory`.
+
 ## updateInternalDeps
 
 Renovate defaults to skipping any internal package dependencies within monorepos.

lib/config/global.ts

@@ -43,6 +43,7 @@ export class GlobalConfig {
     'presetCachePersistence',
     's3Endpoint',
     's3PathStyle',
+    'toolSettings',
     'userAgent',
   ];
 

lib/config/options/index.ts

@@ -3352,6 +3352,35 @@ const options: Readonly<RenovateOptions>[] = [
     default: false,
     globalOnly: true,
   },
+  {
+    name: 'toolSettings',
+    description:
+      'Tool specific configuration. Global self-hosted configuration takes precedence.',
+    type: 'object',
+    default: {
+      jvmMaxMemory: 512,
+      jvmMemory: 512,
+    },
+    cli: false,
+  },
+  {
+    name: 'jvmMaxMemory',
+    description:
+      'Maximum JVM memory in MB to use for updates that use a Java VM, like the Gradle Wrapper, defaults to 512. Repo configuration for this value will be ignored if it exceeds the global configuration for `manager.jvmMaxMemory`',
+    type: 'integer',
+    parents: ['toolSettings'],
+    cli: false,
+    env: false,
+  },
+  {
+    name: 'jvmMemory',
+    description:
+      'Initial JVM memory in MB to use for updates that use a Java VM, like the Gradle Wrapper, defaults to `jvmMaxMemory`. Repo configuration for this value will be ignored if it exceeds the global configuration for `manager.jvmMaxMemory`',
+    type: 'integer',
+    parents: ['toolSettings'],
+    cli: false,
+    env: false,
+  },
 ];
 
 export function getOptions(): Readonly<RenovateOptions>[] {

lib/config/types.ts

@@ -254,6 +254,7 @@ export interface RepoGlobalConfig extends GlobalInheritableConfig {
   ignorePrAuthor?: boolean;
   allowedUnsafeExecutions?: AllowedUnsafeExecution[];
   onboardingAutoCloseAge?: number;
+  toolSettings?: ToolSettingsOptions;
 }
 
 /**
@@ -462,6 +463,7 @@ export interface RenovateConfig
   minimumGroupSize?: number;
   configFileNames?: string[];
   minimumReleaseAgeBehaviour?: MinimumReleaseAgeBehaviour;
+  toolSettings?: ToolSettingsOptions;
 }
 
 const CustomDatasourceFormats = [
@@ -599,6 +601,7 @@ export type AllowedParents =
   | 'packageRules'
   | 'postUpgradeTasks'
   | 'vulnerabilityAlerts'
+  | 'toolSettings'
   | ManagerName
   | UpdateTypeOptions;
 export interface RenovateOptionBase {
@@ -803,3 +806,8 @@ export interface BumpVersionConfig {
   matchStrings: string[];
   name?: string;
 }
+
+export interface ToolSettingsOptions {
+  jvmMaxMemory?: number;
+  jvmMemory?: number;
+}

lib/modules/manager/gradle-wrapper/artifacts.spec.ts

@@ -9,7 +9,7 @@ import type { StatusResult } from '../../../util/git/types.ts';
 import { getPkgReleases } from '../../datasource/index.ts';
 import { updateArtifacts as gradleUpdateArtifacts } from '../gradle/index.ts';
 import type { UpdateArtifactsConfig, UpdateArtifactsResult } from '../types.ts';
-import { updateBuildFile, updateLockFiles } from './artifacts.ts';
+import { gradleJvmArg, updateBuildFile, updateLockFiles } from './artifacts.ts';
 import { updateArtifacts } from './index.ts';
 import { envMock, mockExecAll } from '~test/exec-util.ts';
 import { Fixtures } from '~test/fixtures.ts';
@@ -51,6 +51,9 @@ describe('modules/manager/gradle-wrapper/artifacts', () => {
     GlobalConfig.set(adminConfig);
     resetPrefetchedImages();
 
+    // remove any test-specific overrides
+    delete config.toolSettings;
+
     fs.readLocalFile.mockResolvedValue('test');
     fs.statLocalFile.mockResolvedValue(
       partial<Stats>({
@@ -70,7 +73,56 @@ describe('modules/manager/gradle-wrapper/artifacts', () => {
     });
   });
 
+  describe('gradleJvmArg()', () => {
+    it('takes the values given to it, and returns the JVM arguments', () => {
+      const result = gradleJvmArg({ jvmMemory: 256, jvmMaxMemory: 768 });
+      expect(result).toBe(' -Dorg.gradle.jvmargs="-Xms256m -Xmx768m"');
+    });
+  });
+
   describe('updateArtifacts()', () => {
+    it('Custom Gradle Wrapper heap settings are populated', async () => {
+      const execSnapshots = mockExecAll();
+      httpMock
+        .scope('https://services.gradle.org')
+        .get('/distributions/gradle-6.3-bin.zip.sha256')
+        .reply(
+          200,
+          '038794feef1f4745c6347107b6726279d1c824f3fc634b60f86ace1e9fbd1768',
+        );
+      git.getRepoStatus.mockResolvedValueOnce(
+        partial<StatusResult>({
+          modified: ['gradle/wrapper/gradle-wrapper.properties'],
+        }),
+      );
+      GlobalConfig.set({
+        ...adminConfig,
+        toolSettings: { jvmMaxMemory: 600 },
+      });
+
+      const result = await updateArtifacts({
+        packageFileName: 'gradle/wrapper/gradle-wrapper.properties',
+        updatedDeps: [],
+        newPackageFileContent: `distributionSha256Sum=336b6898b491f6334502d8074a6b8c2d73ed83b92123106bd4bf837f04111043\ndistributionUrl=https\\://services.gradle.org/distributions/gradle-6.3-bin.zip`,
+        config,
+      });
+
+      expect(result).toEqual([
+        {
+          file: {
+            contents: 'test',
+            path: 'gradle/wrapper/gradle-wrapper.properties',
+            type: 'addition',
+          },
+        },
+      ]);
+      expect(execSnapshots).toMatchObject([
+        {
+          cmd: './gradlew -Dorg.gradle.jvmargs="-Xms600m -Xmx600m" :wrapper --gradle-distribution-url https://services.gradle.org/distributions/gradle-6.3-bin.zip --gradle-distribution-sha256-sum 038794feef1f4745c6347107b6726279d1c824f3fc634b60f86ace1e9fbd1768',
+        },
+      ]);
+    });
+
     it('replaces existing value', async () => {
       const execSnapshots = mockExecAll();
       git.getRepoStatus.mockResolvedValue(
@@ -107,7 +159,7 @@ describe('modules/manager/gradle-wrapper/artifacts', () => {
       );
       expect(execSnapshots).toMatchObject([
         {
-          cmd: './gradlew :wrapper --gradle-distribution-url https://services.gradle.org/distributions/gradle-6.3-bin.zip',
+          cmd: './gradlew -Dorg.gradle.jvmargs="-Xms512m -Xmx512m" :wrapper --gradle-distribution-url https://services.gradle.org/distributions/gradle-6.3-bin.zip',
           options: {
             cwd: '/tmp/github/some/repo',
             env: {
@@ -119,7 +171,7 @@ describe('modules/manager/gradle-wrapper/artifacts', () => {
       ]);
     });
 
-    it('aborts if allowedUnsafeExecutions does not include `gradleWrapper`', async () => {
+    it('aborts if allowedUnsafeExecutions does not include `toolSettings`', async () => {
       GlobalConfig.set({
         ...adminConfig,
         allowedUnsafeExecutions: [],
@@ -189,7 +241,7 @@ describe('modules/manager/gradle-wrapper/artifacts', () => {
       expect(result).toBeEmptyArray();
       expect(execSnapshots).toMatchObject([
         {
-          cmd: './gradlew :wrapper --gradle-version 5.6.4',
+          cmd: './gradlew -Dorg.gradle.jvmargs="-Xms512m -Xmx512m" :wrapper --gradle-version 5.6.4',
           options: { cwd: '/tmp/github/some/repo' },
         },
       ]);
@@ -246,7 +298,7 @@ describe('modules/manager/gradle-wrapper/artifacts', () => {
             ' bash -l -c "' +
             'install-tool java 11.0.1' +
             ' && ' +
-            './gradlew :wrapper --gradle-distribution-url https://services.gradle.org/distributions/gradle-6.3-bin.zip --gradle-distribution-sha256-sum 038794feef1f4745c6347107b6726279d1c824f3fc634b60f86ace1e9fbd1768' +
+            './gradlew -Dorg.gradle.jvmargs=\\"-Xms512m -Xmx512m\\" :wrapper --gradle-distribution-url https://services.gradle.org/distributions/gradle-6.3-bin.zip --gradle-distribution-sha256-sum 038794feef1f4745c6347107b6726279d1c824f3fc634b60f86ace1e9fbd1768' +
             '"',
           options: { cwd: '/tmp/github/some/repo' },
         },
@@ -288,7 +340,7 @@ describe('modules/manager/gradle-wrapper/artifacts', () => {
       expect(execSnapshots).toMatchObject([
         { cmd: 'install-tool java 11.0.1' },
         {
-          cmd: './gradlew :wrapper --gradle-distribution-url https://services.gradle.org/distributions/gradle-6.3-bin.zip --gradle-distribution-sha256-sum 038794feef1f4745c6347107b6726279d1c824f3fc634b60f86ace1e9fbd1768',
+          cmd: './gradlew -Dorg.gradle.jvmargs="-Xms512m -Xmx512m" :wrapper --gradle-distribution-url https://services.gradle.org/distributions/gradle-6.3-bin.zip --gradle-distribution-sha256-sum 038794feef1f4745c6347107b6726279d1c824f3fc634b60f86ace1e9fbd1768',
           options: { cwd: '/tmp/github/some/repo' },
         },
       ]);
@@ -355,7 +407,7 @@ describe('modules/manager/gradle-wrapper/artifacts', () => {
       );
       expect(execSnapshots).toMatchObject([
         {
-          cmd: './gradlew :wrapper --gradle-distribution-url https://services.gradle.org/distributions/gradle-6.3-bin.zip',
+          cmd: './gradlew -Dorg.gradle.jvmargs="-Xms512m -Xmx512m" :wrapper --gradle-distribution-url https://services.gradle.org/distributions/gradle-6.3-bin.zip',
           options: {
             cwd: '/tmp/github/some/repo/sub',
             env: {
@@ -486,7 +538,7 @@ describe('modules/manager/gradle-wrapper/artifacts', () => {
       expect(res).toStrictEqual(updatedArtifacts);
       expect(execSnapshots).toMatchObject([
         {
-          cmd: './gradlew :wrapper --gradle-version 8.2',
+          cmd: './gradlew -Dorg.gradle.jvmargs="-Xms512m -Xmx512m" :wrapper --gradle-version 8.2',
         },
       ]);
     });

lib/modules/manager/gradle-wrapper/artifacts.ts

@@ -2,9 +2,10 @@ import { lang, query as q } from '@renovatebot/good-enough-parser';
 import { isTruthy } from '@sindresorhus/is';
 import { quote } from 'shlex';
 import upath from 'upath';
+import type { ToolSettingsOptions } from '../../../config/types.ts';
 import { TEMPORARY_ERROR } from '../../../constants/error-messages.ts';
 import { logger } from '../../../logger/index.ts';
-import { exec } from '../../../util/exec/index.ts';
+import { exec, getToolSettingsOptions } from '../../../util/exec/index.ts';
 import type { ExecOptions } from '../../../util/exec/types.ts';
 import {
   localPathExists,
@@ -131,6 +132,10 @@ export async function updateLockFiles(
   });
 }
 
+export function gradleJvmArg(config: ToolSettingsOptions): string {
+  return ` -Dorg.gradle.jvmargs="-Xms${config.jvmMemory}m -Xmx${config.jvmMaxMemory}m"`;
+}
+
 export async function updateArtifacts({
   packageFileName,
   newPackageFileContent,
@@ -156,6 +161,9 @@ export async function updateArtifacts({
       return null;
     }
 
+    // Limit the Gradle daemon Java heap memory size to prevent OOM errors
+    // leading to Renovate kernel-OOMs and timeouts. See #39558
+    cmd += gradleJvmArg(getToolSettingsOptions(config.toolSettings));
     cmd += ' :wrapper';
 
     let checksum: string | null = null;

lib/modules/manager/types.ts

@@ -1,6 +1,7 @@
 import type { ReleaseType } from 'semver';
 import type {
   MatchStringsStrategy,
+  ToolSettingsOptions,
   UpdateType,
   ValidationMessage,
 } from '../../config/types.ts';
@@ -48,6 +49,7 @@ export interface UpdateArtifactsConfig {
   registryAliases?: Record<string, string>;
   skipArtifactsUpdate?: boolean;
   lockFiles?: string[];
+  toolSettings?: ToolSettingsOptions;
 }
 
 export interface RangeConfig<T = Record<string, any>> extends ManagerData<T> {