[Maven] Support for maven central snapshots

[Doc94]

This PR close #10894 making a replicate of the current services for maven-central but for the snapshots feature added recently.

[github-actions]

	Messages
📖	✨ Thanks for your contribution to Shields, @Doc94!

Generated by 🚫 dangerJS against 732efea

[portlek]

looking forward to this!

[chris48s]

Can we replace this with an example that works

[StefMa]

The "problem" with an example here is, that thery remove snapshots after a 90 days.
See https://central.sonatype.org/publish/publish-portal-snapshots/

Specifically, -SNAPSHOT releases are cleaned up after a period of time (currently 90 days). We believe that this should be sufficient, as projects under active development will be pushing new versions of the same -SNAPSHOT component with some frequency.

So even if we go with an SNAPSHOT release today, it might break in 90 days 🫠
So we might need an really active project to have some kind of a stable example...

[chris48s]

OK, sure. But if you look at the example used in the service tests, it does actually exist
https://central.sonatype.com/repository/maven-snapshots/me/mrdoc/minecraft/dlibcustomextensions/maven-metadata.xml
the versions might expire over time, but the repo is there
https://central.sonatype.com/repository/maven-snapshots/com/google/guava/guava/maven-metadata.xml
is never going to return anything.

[chris48s]

OK, so we've got 2 things going on here.

First lets take the last updated badge. This one should be fairly simple to land.
Fundamanetally, MavenCentralLastUpdate and MavenCentralSnapshotsLastUpdate are quite similar and there's a lot of copy/paste going on here. I'd like us to restructure both services and DRY this up so the common parts are not duplicated. Here's a suggested implementation:

import Joi from 'joi'
import { pathParams, BaseXmlService } from '../index.js'
import { parseDate, renderDateBadge } from '../date.js'
import { nonNegativeInteger } from '../validators.js'

const updateResponseSchema = Joi.object({
  metadata: Joi.object({
    versioning: Joi.object({
      lastUpdated: nonNegativeInteger,
    }).required(),
  }).required(),
}).required()

class MavenCentralLastUpdateBase extends BaseXmlService {
  static category = 'activity'

  static defaultBadgeData = { label: 'last updated' }

  async handle({ groupId, artifactId }) {
    const { metadata } = await this.fetch({
      groupId,
      artifactId,
      schema: updateResponseSchema,
    })

    const date = parseDate(
      String(metadata.versioning.lastUpdated),
      'YYYYMMDDHHmmss',
    )

    return renderDateBadge(date)
  }

  static encodeParams({ groupId, artifactId }) {
    return {
      group: encodeURIComponent(groupId).replace(/\./g, '/'),
      artifact: encodeURIComponent(artifactId),
    }
  }
}

class MavenCentralLastUpdate extends MavenCentralLastUpdateBase {
  static route = {
    base: 'maven-central/last-update',
    pattern: ':groupId/:artifactId',
  }

  static openApi = {
    '/maven-central/last-update/{groupId}/{artifactId}': {
      get: {
        summary: 'Maven Central Last Update',
        parameters: pathParams(
          { name: 'groupId', example: 'com.google.guava' },
          { name: 'artifactId', example: 'guava' },
        ),
      },
    },
  }

  async fetch({ groupId, artifactId, schema }) {
    const { group, artifact } = this.constructor.encodeParams({
      groupId,
      artifactId,
    })
    return this._requestXml({
      schema,
      url: `https://repo1.maven.org/maven2/${group}/${artifact}/maven-metadata.xml`,
      httpErrors: { 404: 'artifact not found' },
    })
  }
}

class MavenCentralSnapshotsLastUpdate extends MavenCentralLastUpdateBase {
  static route = {
    base: 'maven-central-snapshots/last-update',
    pattern: ':groupId/:artifactId',
  }

  static openApi = {
    '/maven-central-snapshots/last-update/{groupId}/{artifactId}': {
      get: {
        summary: 'Maven Central Snapshots Last Update',
        parameters: pathParams(
          { name: 'groupId', example: 'me.mrdoc.minecraft' },
          { name: 'artifactId', example: 'dlibcustomextensions' },
        ),
      },
    },
  }

  async fetch({ groupId, artifactId, schema }) {
    const { group, artifact } = this.constructor.encodeParams({
      groupId,
      artifactId,
    })
    return this._requestXml({
      schema,
      url: `https://central.sonatype.com/repository/maven-snapshots/${group}/${artifact}/maven-metadata.xml`,
      httpErrors: { 404: 'artifact not found' },
    })
  }
}

export default [MavenCentralLastUpdate, MavenCentralSnapshotsLastUpdate]

(that can all go in one file)

[chris48s]

Secondly, lets look at the version badge.

This isn't really your fault, but the maven central version badge has a long-standing issue. #6188
I think it is likely we will remove the versionPrefix and versionSuffix params (see #6188 (comment) )
If we are going to add a specific route for this (although you can already make badges for this service anyway e.g: https://img.shields.io/maven-metadata/v.svg?label=maven-central-snapshots&metadataUrl=https%3A//central.sonatype.com/repository/maven-snapshots/me/mrdoc/minecraft/dlibcustomextensions/maven-metadata.xml as the routes are just redirectors for the more general maven-metadata route), then I think we should not expose the versionPrefix and versionSuffix params on the documentation page. Lets not encourage users to start using a feature that is likely to disappear.

[StefMa]

I'm a bit confused with the URL you posted here.
Right know, version 1.0.0-SNAPSHOT is released.
See https://central.sonatype.com/repository/maven-snapshots/me/mrdoc/minecraft/dlibcustomextensions/maven-metadata.xml

However, if I open the URL, it gives me 0.0.3-SNAPSHOT back.

[chris48s]

Yeah, see #6188 At the moment we're making an assumption about the ordering of versions which doesn't hold across every registry.

Tbh, I think we probably need to get #6188 resolved (see #11077 - I've not had a chance to follow up on that yet) and then circle back to this one having done that.

[chris48s]

Can we also replace this with an example that works

[StefMa]

Hey guys,

what is the progress on that? 😇
@Doc94 still interested in fixing the stuff?
I would love to use shields for snapshot releases.

[Doc94]

Hey guys,

what is the progress on that? 😇 @Doc94 still interested in fixing the stuff? I would love to use shields for snapshot releases.

not sure if wait to the PR for the order of versions based in how this can change how need handle all here for refactor

[ethauvin]

For the time-being, you could use something like:

![Maven metadata URL](https://img.shields.io/maven-metadata/v?metadataUrl=https%3A%2F%2Fcentral.sonatype.com%2Frepository%2Fmaven-snapshots%2Fcom%2Fexample%2FartifactId%2Fmaven-metadata.xml)

[chris48s]

If someone wants to come back and rebase + finish this, we've now merged #11077

This badge (snapshot version) can still be a forwarder to the maven metadata badge but..

• We should ignore the old prefix/sufffix params and just expose filter, which is more versatile
• We should either expose the strategy param, or possibly hard-code it to release or latest if the default strategy doesn't make sense for snapshots (I'm not really clued up enough to make that judgement)