feature: Give helpful advice when profile missing on host #461

rtyley · 2023-12-27T11:08:00Z

This updates the error message given when a profile is not found on a host (note Sonatype currently has 2 OSS hosts - oss.sonatype.org & s01.oss.sonatype.org - and any profile will only exist on one of the hosts).

(example here)

There can be two possible causes when a profile is not found on a host:

The profile name is misspelt/incorrect (eg 'com.gnu' or 'john.smith' instead of 'com.gu')
The profile is actually on the other Sonatype OSS host

The original error message really only indicated the possibility of the 1st problem, but the 2nd issue is increasingly likely - since February 2021 new profiles have only been registered on the new host s01.oss.sonatype.org, and sbt-sonatype defaults to using the older host, oss.sonatype.org.

The new error message aims to make the user aware of the 2 possible causes of the 'missing profile' problem, and offer advice on how the 2nd problem could be corrected.

Before:

Profile com.gu is not found. Check your sonatypeProfileName setting in build.sbt

After:

Profile com.gu is not found on oss.sonatype.org. In your sbt settings, check your sonatypeProfileName and sonatypeCredentialHost (try s01.oss.sonatype.org?)"

Sonatype host is determined by-profile (not by-user)

Note that in the past, there's been a bit of confusion (ok, I've been a bit confused!) about whether hosts are assigned on a by-user or by-profile basis (many users can be granted access by Sonatype to upload to one profile, eg we at the Guardian have that for our com.gu profile). It's definitely per-profile though - so sonatypeProfileName dictates which sonatypeCredentialHost you want to be using.

As a user (eg, for me, with my Sonatype user account 'roberto') working on a variety of projects with different profiles (eg, for me, working on projects under com.gu, com.madgag & org.scanamo) when I'm performing a release I'll be uploading to either oss.sonatype.org, or s01.oss.sonatype.org, depending on which profile/groupId that particular project lives under.

This updates the error message given when a profile is not found on a host (note Sonatype currently has 2 OSS hosts - `oss.sonatype.org` & `s01.oss.sonatype.org` and any profile will only exist on _one_ of the hosts). There can be two possible causes when a profile is not found on a host: 1. The profile name is misspelt/incorrect (eg 'com.gnu' or 'john.smith' instead of 'com.gu') 2. The profile is actually on the _other_ Sonatype OSS host The original error message really only indicated the possibility of the _1st_ problem, but the 2nd issue is increasingly likely - since February 2021 new profiles have _only_ been registered on the new host `s01.oss.sonatype.org` (https://central.sonatype.org/news/20210223_new-users-on-s01/), and `sbt-sonatype` defaults to using the other host, `oss.sonatype.org`. The new error message aims to make the user aware of the 2 possible causes of the 'missing profile' problem, and offer advice on how the 2nd problem could be corrected. Before: > Profile com.gu is not found. Check your sonatypeProfileName setting in build.sbt After: > Profile com.gu is not found on oss.sonatype.org. In your sbt settings, check your sonatypeProfileName and sonatypeCredentialHost (try s01.oss.sonatype.org?)"

rtyley · 2023-12-27T11:31:50Z

src/main/scala/xerial/sbt/sonatype/SonatypeClient.scala

-  lazy val repoUri = {
-    def repoBase(url: String) = if (url.endsWith("/")) url.dropRight(1) else url
-    val url                   = repoBase(repositoryUrl)
-    url
-  }
-  private val pathPrefix = {
-    new java.net.URL(repoUri).getPath
-  }
+  lazy val repoUri: URI = URI.create(repositoryUrl.stripSuffix("/"))
+
+  private val pathPrefix = repoUri.getPath


This is just a simplification of repoUri - it gets much shorter!

rtyley · 2023-12-27T11:34:24Z

src/main/scala/xerial/sbt/sonatype/SonatypeException.scala

+  case class MISSING_PROFILE(profileName: String, host: String) extends ErrorCode {
+    val problem = s"Profile $profileName is not found on $host"
+
+    val possibleAlternativeHosts: Seq[String] = Sonatype.KnownOssHosts.filterNot(_ == host)
+
+    val hostAdvice = s"try ${possibleAlternativeHosts.mkString(", or ")}?"
+
+    val advice: String =
+      s"In your sbt settings, check your sonatypeProfileName and sonatypeCredentialHost ($hostAdvice)"
+
+    val message: String = s"$problem. $advice"
+  }


Changing MISSING_PROFILE into a case class lets us break down the construction of the error message into separate fields, and makes it easier to construct good assertions on the error messages in SonatypeExceptionTest!

xerial · 2024-01-10T05:31:34Z

i just noticed this PR. Will take a look

rtyley · 2024-01-17T12:12:39Z

i just noticed this PR. Will take a look

Thanks @xerial! How does it look to you? I'm happy to make changes if required?

xerial · 2024-01-18T17:36:45Z

src/main/scala/xerial/sbt/Sonatype.scala

@@ -59,6 +59,7 @@ object Sonatype extends AutoPlugin with LogSupport {

  val sonatypeLegacy = "oss.sonatype.org"
  val sonatype01     = "s01.oss.sonatype.org"
+  val KnownOssHosts  = Seq(sonatypeLegacy, sonatype01)


Suggested change

val KnownOssHosts = Seq(sonatypeLegacy, sonatype01)

val knownOssHosts = Seq(sonatypeLegacy, sonatype01)

For consistency of variable naming.

src/main/scala/xerial/sbt/sonatype/SonatypeException.scala

xerial · 2024-01-18T17:47:36Z

Merged with some fixes for code cosmetics

rtyley · 2024-01-18T17:54:12Z

Thank you!

rtyley force-pushed the give-helpful-message-when-profile-not-found-on-host branch from 373ae8b to a0a1759 Compare December 27, 2023 11:28

rtyley commented Dec 27, 2023

View reviewed changes

rtyley marked this pull request as ready for review December 27, 2023 11:34

xerial self-assigned this Jan 10, 2024

xerial reviewed Jan 18, 2024

View reviewed changes

src/main/scala/xerial/sbt/sonatype/SonatypeException.scala Outdated Show resolved Hide resolved

xerial reviewed Jan 18, 2024

View reviewed changes

src/main/scala/xerial/sbt/sonatype/SonatypeException.scala Outdated Show resolved Hide resolved

Apply suggested fixes

2e19991

xerial changed the title ~~Give helpful advice when profile missing on host~~ feture: Give helpful advice when profile missing on host Jan 18, 2024

xerial changed the title ~~feture: Give helpful advice when profile missing on host~~ feature: Give helpful advice when profile missing on host Jan 18, 2024

xerial merged commit 17e3464 into xerial:master Jan 18, 2024
5 checks passed

rtyley mentioned this pull request Apr 16, 2024

Ab/add mavencentral publishing 2 guardian/source-apps#10

Merged

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feature: Give helpful advice when profile missing on host #461

feature: Give helpful advice when profile missing on host #461

rtyley commented Dec 27, 2023 •

edited

Loading

rtyley Dec 27, 2023

rtyley Dec 27, 2023 •

edited

Loading

xerial commented Jan 10, 2024

rtyley commented Jan 17, 2024

xerial Jan 18, 2024

xerial commented Jan 18, 2024

rtyley commented Jan 18, 2024

	val KnownOssHosts = Seq(sonatypeLegacy, sonatype01)
	val knownOssHosts = Seq(sonatypeLegacy, sonatype01)

feature: Give helpful advice when profile missing on host #461

feature: Give helpful advice when profile missing on host #461

Conversation

rtyley commented Dec 27, 2023 • edited Loading

Sonatype host is determined by-profile (not by-user)

rtyley Dec 27, 2023

Choose a reason for hiding this comment

rtyley Dec 27, 2023 • edited Loading

Choose a reason for hiding this comment

xerial commented Jan 10, 2024

rtyley commented Jan 17, 2024

xerial Jan 18, 2024

Choose a reason for hiding this comment

xerial commented Jan 18, 2024

rtyley commented Jan 18, 2024

rtyley commented Dec 27, 2023 •

edited

Loading

rtyley Dec 27, 2023 •

edited

Loading