improve [MavenCentral], [MavenMetadata], and [GradlePluginPortal] #6628

anatawa12 · 2021-06-12T13:14:42Z

shields-ci · 2021-06-12T13:15:21Z

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

Generated by 🚫 dangerJS against 1426170

anatawa12 · 2021-06-12T14:26:09Z

Question: Is there any way to test expectBadge with following redirections.

PyvesB · 2021-06-13T08:50:36Z

Question: Is there any way to test expectBadge with following redirections.

I'm not sure. Generally we use expectRedirect to check that the redirect is setup correctly, and only test the main path via expectBadge.

anatawa12 · 2021-06-13T11:22:57Z

@PyvesB Thank you. So, I removed old tests for maven central.

PyvesB · 2021-06-19T19:05:12Z

Thanks, will take a look in the coming days! :)

PyvesB · 2021-06-22T18:52:22Z

I've done a first review pass and test in the Heroku app. For anyone reading through this PR, there's been a bit of scope creep: it's not only the refactor of the redirectors mentioned in #6449 (comment), support for version suffix filters was added as well.

Looking at things in the review app, searching for "maven" displays the badges with a huge bit of vertical spacing, due to the long titles. Is anyone else observing the same problem? See screenshot below.

The only badge that currently supports versionPrefix is Maven Central. However, we've ended up in a inconsistent state with regard to the URL structures in this pull request:

for Maven Metadata, versionPrefix is a query parameter, whereas it's a path element in Gradle and Maven Central.
for Gradle and Maven Central versionPrefix is a path element whereas versionSuffix is a query parameter.

Now that we're using redirectors, it should be easy enough to resolve these inconsistencies. Switching everything to query parameters across all three badge types would make most sense to me.

anatawa12 · 2021-06-23T14:05:36Z

The only badge that currently supports versionPrefix is Maven Central. However, we've ended up in a inconsistent state with regard to the URL structures in this pull request:

for Maven Metadata, versionPrefix is a query parameter, whereas it's a path element in Gradle and Maven Central.

for Gradle and Maven Central versionPrefix is a path element whereas versionSuffix is a query parameter.

Now that we're using redirectors, it should be easy enough to resolve these inconsistencies. Switching everything to query parameters across all three badge types would make most sense to me.

I agree with that so I changed all example to use versionPrefix of queryParams. versionPrefix for gradle-plugin-portal is added by this PR so I removed support with path.

I've done a first review pass and test in the Heroku app. For anyone reading through this PR, there's been a bit of scope creep: it's not only the refactor of the redirectors mentioned in #6449 (comment), support for version suffix filters was added as well.

Looking at things in the review app, searching for "maven" displays the badges with a huge bit of vertical spacing, due to the long titles. Is anyone else observing the same problem? See screenshot below.

I found that we can generate badges without some query parameters in web UI so, To resolve this problem, I removed examples without versionPrefix or versionSuffix.

PyvesB

Thanks, this is almost ready to go as far as I can tell!

I found that we can generate badges without some query parameters in web UI so, To resolve this problem, I removed examples without versionPrefix or versionSuffix.

Given that you've removed the examples without the filters, would it be worth being extra clear about them being optional in the remaining examples? You can add a bit of documentation in the UI, you can take a look at our Discord implemention to see how that's done:

shields/services/discord/discord.service.js

Line 11 in 5ca4089

const documentation = `

Maybe something along the following lines:

versionPrefix and versionSuffix allow narrowing down the range of versions the badge will take into account, but they are completely optional.

PyvesB · 2021-06-26T08:09:25Z

services/gradle-plugin-portal/gradle-plugin-portal.service.js

      namedParams: {
        pluginId: 'com.gradle.plugin-publish',
      },
      staticPreview: {
-        label: 'plugin portal',
-        message: 'v0.14.0',
+        label: 'maven-central',


Shouldn't this have remained plugin portal?

PyvesB · 2021-06-26T08:11:52Z

services/maven-metadata/maven-metadata.service.js

+      version === undefined
+    )
+      throw new NotFound({
+        prettyMessage: 'version prefix or suffix not found',


Could you please add a test for this case?

anatawa12 · 2021-06-28T10:53:17Z

@PyvesB I've fixed gradle-plugin-portal and added documentation and tests.

…rsionSuffix was specified

PyvesB

I noticed a minor bug in our frontend, only the first query parameter has an e.g. in front of it, which looks a bit weird:

However, that's unrelated to your work, just happened to notice it whilst testing your pull request. :)

Anyway, thanks for working on this, it's good to go! 👍🏻

PyvesB · 2021-06-30T07:36:50Z

I was a little slow on the review, so I've tried to be fast on the deployment side: this is already live on our production servers! 🍾

anatawa12 added 9 commits June 12, 2021 20:49

implement version prefix and suffix

6b4f111

add tests for maven-metadata

33cf8bd

use maven-metadata in maven-central

dd47a0c

add tests of maven-central for redirecting

d8c71c3

add tests of maven-central for redirecting

3729734

fix: maven-central: don't force color as blue

1ec3ebe

add versionPrefix for gradle-plugin-portal

059fcdb

add example for gradle-plugin-portal

b888cf9

fix: gradle-plugin-portal: don't force color as blue

cfff903

anatawa12 added 3 commits June 12, 2021 23:10

fix test

3754db5

fix test

2c35b3e

fix test

c9f7b7f

PyvesB added the service-badge Accepted and actionable changes, features, and bugs label Jun 13, 2021

anatawa12 added 2 commits June 13, 2021 19:18

remove expectBadge tests for maven central

166a0df

fix test for maven-metadata

559eb5f

shields-cd temporarily deployed to shields-staging-pr-6628 June 15, 2021 03:29 Inactive

shields-cd temporarily deployed to shields-staging-pr-6628 June 22, 2021 07:04 Inactive

anatawa12 added 2 commits June 23, 2021 22:14

remove :versionPrefix from gradle-plugin-portal

ba51afa

use query parameter versionPrefix in maven-central example

f2adc83

shields-cd had a problem deploying to shields-staging-pr-6628 June 23, 2021 13:48 Failure

fix redundant pattern

32368dc

shields-cd temporarily deployed to shields-staging-pr-6628 June 23, 2021 13:56 Inactive

remove some examples

c3927d4

shields-cd temporarily deployed to shields-staging-pr-6628 June 23, 2021 14:00 Inactive

PyvesB reviewed Jun 26, 2021

View reviewed changes

anatawa12 added 3 commits June 26, 2021 20:51

fix static preview of gradle-plugin-portal

37d3476

fix tests

845f645

add documentation

ee9a94d

shields-cd temporarily deployed to shields-staging-pr-6628 June 28, 2021 10:50 Inactive

fix static preview of gradle-plugin-portal

22284b8

shields-cd temporarily deployed to shields-staging-pr-6628 June 28, 2021 10:53 Inactive

fix: version prefix or suffix not found if either versionPrefix or ve…

5cb4f36

…rsionSuffix was specified

shields-cd temporarily deployed to shields-staging-pr-6628 June 28, 2021 10:59 Inactive

PyvesB approved these changes Jun 30, 2021

View reviewed changes

Merge branch 'master' into maven-central-and-metadata

1426170

PyvesB deployed to shields-staging-pr-6628 June 30, 2021 07:13 View deployment

PyvesB merged commit 08b8153 into badges:master Jun 30, 2021

anatawa12 deleted the maven-central-and-metadata branch June 30, 2021 07:38

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

improve [MavenCentral], [MavenMetadata], and [GradlePluginPortal] #6628

improve [MavenCentral], [MavenMetadata], and [GradlePluginPortal] #6628

anatawa12 commented Jun 12, 2021

shields-ci commented Jun 12, 2021 •

edited

anatawa12 commented Jun 12, 2021

PyvesB commented Jun 13, 2021 •

edited

anatawa12 commented Jun 13, 2021

PyvesB commented Jun 19, 2021

PyvesB commented Jun 22, 2021

anatawa12 commented Jun 23, 2021

PyvesB left a comment

PyvesB Jun 26, 2021

PyvesB Jun 26, 2021

anatawa12 commented Jun 28, 2021

PyvesB left a comment

PyvesB commented Jun 30, 2021

improve [MavenCentral], [MavenMetadata], and [GradlePluginPortal] #6628

improve [MavenCentral], [MavenMetadata], and [GradlePluginPortal] #6628

Conversation

anatawa12 commented Jun 12, 2021

shields-ci commented Jun 12, 2021 • edited

anatawa12 commented Jun 12, 2021

PyvesB commented Jun 13, 2021 • edited

anatawa12 commented Jun 13, 2021

PyvesB commented Jun 19, 2021

PyvesB commented Jun 22, 2021

anatawa12 commented Jun 23, 2021

PyvesB left a comment

Choose a reason for hiding this comment

PyvesB Jun 26, 2021

Choose a reason for hiding this comment

PyvesB Jun 26, 2021

Choose a reason for hiding this comment

anatawa12 commented Jun 28, 2021

PyvesB left a comment

Choose a reason for hiding this comment

PyvesB commented Jun 30, 2021

shields-ci commented Jun 12, 2021 •

edited

PyvesB commented Jun 13, 2021 •

edited