feat(maven): Package cache provider

docs/usage/self-hosted-configuration.md

@@ -409,10 +409,8 @@ Valid codes for namespaces are as follows:
 - `datasource-hexpm-bob`
 - `datasource-java-version`
 - `datasource-jenkins-plugins`
-- `datasource-maven`
-- `datasource-maven:head-requests-timeout`
-- `datasource-maven:head-requests`
-- `datasource-maven:metadata-xml`
+- `datasource-maven:cache-provider`
+- `datasource-maven:postprocess-reject`
 - `datasource-node-version`
 - `datasource-npm:data`
 - `datasource-nuget-v3`

lib/modules/datasource/maven/index.ts

@@ -1,5 +1,3 @@
-import type { XmlDocument } from 'xmldoc';
-import { GlobalConfig } from '../../../config/global';
 import { logger } from '../../../logger';
 import * as packageCache from '../../../util/cache/package';
 import { asTimestamp } from '../../../util/timestamp';
@@ -42,15 +40,6 @@ function getLatestSuitableVersion(releases: Release[]): string | null {
   );
 }
 
-function extractVersions(metadata: XmlDocument): string[] {
-  const versions = metadata.descendantWithPath('versioning.versions');
-  const elements = versions?.childrenNamed('version');
-  if (!elements) {
-    return [];
-  }
-  return elements.map((el) => el.val);
-}
-
 export const defaultRegistryUrls = [MAVEN_REPO];
 
 export class MavenDatasource extends Datasource {
@@ -80,35 +69,16 @@ export class MavenDatasource extends Datasource {
     repoUrl: string,
   ): Promise<string[]> {
     const metadataUrl = getMavenUrl(dependency, repoUrl, 'maven-metadata.xml');
-
-    const cacheNamespace = 'datasource-maven:metadata-xml';
-    const cacheKey = `v2:${metadataUrl}`;
-    const cachedVersions = await packageCache.get<string[]>(
-      cacheNamespace,
-      cacheKey,
-    );
-    /* v8 ignore next 3 -- TODO: add test */
-    if (cachedVersions) {
-      return cachedVersions;
-    }
-
     const metadataXmlResult = await downloadMavenXml(this.http, metadataUrl);
     return metadataXmlResult
-      .transform(
-        async ({ isCacheable, data: mavenMetadata }): Promise<string[]> => {
-          const versions = extractVersions(mavenMetadata);
-          const cachePrivatePackages = GlobalConfig.get(
-            'cachePrivatePackages',
-            false,
-          );
-
-          if (cachePrivatePackages || isCacheable) {
-            await packageCache.set(cacheNamespace, cacheKey, versions, 30);
-          }
-
-          return versions;
-        },
-      )
+      .transform(({ data: metadata }) => {
+        const versions = metadata.descendantWithPath('versioning.versions');
+        const elements = versions?.childrenNamed('version');
+        if (!elements) {
+          return [];
+        }
+        return elements.map((el) => el.val);
+      })
       .onError((err) => {
         logger.debug(
           `Maven: error fetching versions for "${dependency.display}": ${err.type}`,
@@ -176,7 +146,7 @@ export class MavenDatasource extends Datasource {
       ? `postprocessRelease:${registryUrl}:${packageName}:${versionOrig}:${version}`
       : `postprocessRelease:${registryUrl}:${packageName}:${version}`;
     const cachedResult = await packageCache.get<PostprocessReleaseResult>(
-      'datasource-maven',
+      'datasource-maven:postprocess-reject',
       cacheKey,
     );
 
@@ -205,15 +175,21 @@ export class MavenDatasource extends Datasource {
     if (err) {
       const result: PostprocessReleaseResult =
         err.type === 'not-found' ? 'reject' : release;
-      await packageCache.set('datasource-maven', cacheKey, result, 24 * 60);
+      if (result === 'reject') {
+        await packageCache.set(
+          'datasource-maven:postprocess-reject',
+          cacheKey,
+          result,
+          24 * 60,
+        );
+      }
       return result;
     }
 
     if (val.lastModified) {
       release.releaseTimestamp = asTimestamp(val.lastModified);
     }
 
-    await packageCache.set('datasource-maven', cacheKey, release, 7 * 24 * 60);
     return release;
   }
 }

lib/modules/datasource/maven/util.ts

@@ -5,6 +5,7 @@ import { HOST_DISABLED } from '../../../constants/error-messages';
 import { logger } from '../../../logger';
 import { ExternalHostError } from '../../../types/errors/external-host-error';
 import { type Http, HttpError } from '../../../util/http';
+import { PackageHttpCacheProvider } from '../../../util/http/cache/package-http-cache-provider';
 import type { HttpOptions, HttpResponse } from '../../../util/http/types';
 import { regEx } from '../../../util/regex';
 import { Result } from '../../../util/result';
@@ -63,14 +64,20 @@ function isUnsupportedHostError(err: HttpError): boolean {
   return err.name === 'UnsupportedProtocolError';
 }
 
+const cacheProvider = new PackageHttpCacheProvider({
+  namespace: 'datasource-maven:cache-provider',
+  ttlMinutes: 7 * 24 * 60,
+  checkCacheControlHeader: false, // Maven doesn't respond with `cache-control` headers
+});
+
 export async function downloadHttpProtocol(
   http: Http,
   pkgUrl: URL | string,
   opts: HttpOptions = {},
 ): Promise<MavenFetchResult> {
   const url = pkgUrl.toString();
   const fetchResult = await Result.wrap<HttpResponse, Error>(
-    http.getText(url, opts),
+    http.getText(url, { ...opts, cacheProvider }),
   )
     .transform((res): MavenFetchSuccess => {
       const result: MavenFetchSuccess = { data: res.body };

lib/util/cache/package/types.ts

@@ -80,10 +80,8 @@ export type PackageCacheNamespace =
   | 'datasource-hexpm-bob'
   | 'datasource-java-version'
   | 'datasource-jenkins-plugins'
-  | 'datasource-maven'
-  | 'datasource-maven:head-requests-timeout'
-  | 'datasource-maven:head-requests'
-  | 'datasource-maven:metadata-xml'
+  | 'datasource-maven:cache-provider'
+  | 'datasource-maven:postprocess-reject'
   | 'datasource-node-version'
   | 'datasource-npm:data'
   | 'datasource-nuget-v3'