Update `BugPattern#{link,linkType.CUSTOM}` to link to our website #251

rickie · 2022-09-20T14:25:12Z

No description provided.

japborst · 2022-09-20T16:20:17Z

README.md

@@ -121,7 +121,8 @@ $ mvn clean install
 [INFO] -------------------------------------------------------------
 [WARNING] Example.java:[9,34] [tech.picnic.errorprone.refastertemplates.BigDecimalTemplates.BigDecimalZero]
  Did you mean 'return BigDecimal.ZERO;'?
-[WARNING] Example.java:[14,35] [IdentityConversion] This method invocation appears redundant; remove it or suppress this warning and add a comment explaining its purpose
+[WARNING] Example.java:[13,35] [IdentityConversion] This method invocation appears redundant; remove it or suppress this warning and add a comment explaining its purpose
+    (see https://error-prone.picnic.tech/bug_patterns/IdentityConversion)


japborst · 2022-09-20T16:21:57Z

error-prone-contrib/src/main/java/tech/picnic/errorprone/bugpatterns/AmbiguousJsonCreator.java

@@ -26,7 +26,8 @@
 @AutoService(BugChecker.class)
 @BugPattern(
    summary = "`JsonCreator.Mode` should be set for single-argument creators",
-    linkType = NONE,
+    link = "https://error-prone.picnic.tech/bug_patterns/AmbiguousJsonCreator",


Note: here and below, we're mixing camel and snake case here.

However, this is consistent with errorprone.info, e.g. http://errorprone.info/bugpattern/AndroidInjectionBeforeSuper
(Bug Pattern -> bugpattern is actually lowercase 🙄)

@rickie is it possible to define the base url in a single place?

However, this is consistent with errorprone.info

😂

@rickie is it possible to define the base url in a single place?

Not without making a change directly in Error Prone to be honest.

This is the relevant method in EP:

@Nullable private static String createLinkUrl(String canonicalName, BugPattern pattern) { switch (pattern.linkType()) { case AUTOGENERATED: return String.format("https://errorprone.info/bugpattern/%s", canonicalName); case CUSTOM: // annotation.link() must be provided. if (pattern.link().isEmpty()) { throw new IllegalStateException( "If linkType element of @BugPattern is CUSTOM, " + "a link element must also be provided."); } return pattern.link(); case NONE: return null; } throw new AssertionError( "Unexpected value for linkType element of @BugPattern: " + pattern.linkType()); }

Introducing a new LinkType.PICNIC would be cool though 😂. (Not an option though haha)

We could perhaps introduce a static constant for the https://error-prone.picnic.tech/bug_patterns/ prefix in the tech.picnic.errorprone.bugpatterns.util package. 🤔

W.r.t. the path: I think I prefer bugpattern (for consistency with Error Prone) or bug-pattern/bug-patterns over bug_patterns :)

Forgot to push, did that here: 07a0034

Stephan202

Nice!

Stephan202 · 2022-09-20T20:58:08Z

error-prone-contrib/src/main/java/tech/picnic/errorprone/bugpatterns/AmbiguousJsonCreator.java

@@ -26,7 +26,8 @@
 @AutoService(BugChecker.class)
 @BugPattern(
    summary = "`JsonCreator.Mode` should be set for single-argument creators",
-    linkType = NONE,
+    link = "https://error-prone.picnic.tech/bug_patterns/AmbiguousJsonCreator",


We could perhaps introduce a static constant for the https://error-prone.picnic.tech/bug_patterns/ prefix in the tech.picnic.errorprone.bugpatterns.util package. 🤔

W.r.t. the path: I think I prefer bugpattern (for consistency with Error Prone) or bug-pattern/bug-patterns over bug_patterns :)

Stephan202

Just dropping a thought I just had while talking with @loehnertz :)

Stephan202 · 2022-09-21T16:08:14Z

README.md

 [WARNING] Example.java:[9,34] [tech.picnic.errorprone.refastertemplates.BigDecimalTemplates.BigDecimalZero]
  Did you mean 'return BigDecimal.ZERO;'?
-[WARNING] Example.java:[14,35] [IdentityConversion] This method invocation appears redundant; remove it or suppress this warning and add a comment explaining its purpose
+[WARNING] Example.java:[13,35] [IdentityConversion] This method invocation appears redundant; remove it or suppress this warning and add a comment explaining its purpose
+    (see https://error-prone.picnic.tech/bugpatterns/IdentityConversion)


For a separate PR: we should also emit these links for Refaster-based checks :)

Means extending refaster, right? AFAIK not supported by error-prone, right?

Indeed; out of the box Refaster only patches. I filed #255 to track this.

@Stephan202 super! 💪

rickie · 2022-09-28T07:49:56Z

Suggested commit message:

Emit website link along with `BugChecker` rewrite suggestions (#251)

japborst · 2022-09-28T08:18:20Z

README.md

@@ -121,7 +121,8 @@ $ mvn clean install
 [INFO] -------------------------------------------------------------
 [WARNING] Example.java:[9,34] [tech.picnic.errorprone.refastertemplates.BigDecimalTemplates.BigDecimalZero]
  Did you mean 'return BigDecimal.ZERO;'?
-[WARNING] Example.java:[14,35] [IdentityConversion] This method invocation appears redundant; remove it or suppress this warning and add a comment explaining its purpose
+[WARNING] Example.java:[13,35] [IdentityConversion] This method invocation appears redundant; remove it or suppress this warning and add a comment explaining its purpose
+    (see https://error-prone.picnic.tech/bugpatterns/IdentityConversion)


Here and below: we have URLs without trailing slashes, which is consistent with the rest of this and other of our codebases.

There are many opinions what's the right approach. Generally there seems some consensus where /name/ refers to a directory and /name refers to file (albeit weirdly without an extensions). Jekyll, however, currently uses trailing slashes and it does not seem we can configure it as such to omit them (even when doing so, it redirects the page to include a trailing slash).

Given that both work, I'd suggest leaving the URLs like this. If we manage for Jekyll to omit the trailing slash, these URLs will continue to work.

SGTM. Also I think for a URL it looks nicer to not have a trailing slash.

That's super subjective 😉 (although I agree)

japborst · 2022-09-28T08:18:51Z

error-prone-contrib/src/main/java/tech/picnic/errorprone/bugpatterns/AmbiguousJsonCreator.java

@@ -26,7 +27,8 @@
 @AutoService(BugChecker.class)
 @BugPattern(
    summary = "`JsonCreator.Mode` should be set for single-argument creators",
-    linkType = NONE,
+    link = BASE_URL_BUGPATTERNS + "AmbiguousJsonCreator",


I assume we can't auto-generate this based on the class name?

Should we use URI.resolve here instead?

Suggested change

link = BASE_URL_BUGPATTERNS + "AmbiguousJsonCreator",

link = BASE_URL_BUGPATTERNS.resolve("AmbiguousJsonCreator"),

We can indeed not auto-generate.

link should be a String constant. The proposed solution is an URI and not a constant. .toString() would solve the former issue but not the latter 😬.

error-prone-contrib/src/main/java/tech/picnic/errorprone/bugpatterns/util/Documentation.java

japborst

I verified that all the URLs work 💪

https://error-prone.picnic.tech/bugpatterns/ +

grep -r -l '@BugPattern' error-prone-contrib/src/main/java/tech/picnic/errorprone/bugpatterns | xargs -I {} basename {} .java

Stephan202

Rebased and added a commit. Not yet approving because I want to asses the effort required to automate/enforce this (started playing with something).

Stephan202

Rebased and added a commit to update a recently introduced bug checker.

Rebased and added a commit. Not yet approving because I want to asses the effort required to automate/enforce this (started playing with something).

I'll defer completion of the enforcement check to a separate PR. (It is pretty clear that this will be necessary, though. For example, right now the Refaster check doesn't define a URL, and its module (refaster-runner) does not have access to Documentation.BUG_PATTERNS_BASE_URL.)

rickie added the new feature label Sep 20, 2022

rickie requested review from Stephan202 and japborst September 20, 2022 14:25

rickie changed the title ~~Introduce BugPattern#{link,linkType.CUSTOM} to link to our website~~ Update BugPattern#{link,linkType.CUSTOM} to link to our website Sep 20, 2022

japborst reviewed Sep 20, 2022

View reviewed changes

Stephan202 reviewed Sep 20, 2022

View reviewed changes

japborst mentioned this pull request Sep 21, 2022

Set up documentation website generation and deployment #253

Merged

10 tasks

Stephan202 reviewed Sep 21, 2022

View reviewed changes

Stephan202 mentioned this pull request Sep 21, 2022

Emit website link along with Refaster refactor suggestions #255

Merged

rickie marked this pull request as ready for review September 28, 2022 07:47

rickie added this to the 0.4.0 milestone Sep 28, 2022

rickie requested review from Stephan202 and japborst September 28, 2022 07:50

japborst reviewed Sep 28, 2022

View reviewed changes

japborst approved these changes Sep 28, 2022

View reviewed changes

Stephan202 force-pushed the rossendrijver/introduce_custom_links branch from b68ba62 to b5dc7e3 Compare September 28, 2022 17:16

Stephan202 reviewed Sep 28, 2022

View reviewed changes

rickie and others added 6 commits October 2, 2022 14:02

Introduce linkType#CUSTOM to link to our website

6389c42

Update readme

9665303

Update urls

2034d11

Add util with base URL

ff4ea83

Suggestions

8417cc3

Add URL for new check

49c86f4

Stephan202 approved these changes Oct 2, 2022

View reviewed changes

Stephan202 force-pushed the rossendrijver/introduce_custom_links branch from b5dc7e3 to 49c86f4 Compare October 2, 2022 12:08

Stephan202 merged commit 0561c37 into master Oct 2, 2022

Stephan202 deleted the rossendrijver/introduce_custom_links branch October 2, 2022 12:12

rickie removed the new feature label Oct 13, 2022

rickie added the improvement label Oct 13, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update `BugPattern#{link,linkType.CUSTOM}` to link to our website #251

Update `BugPattern#{link,linkType.CUSTOM}` to link to our website #251

rickie commented Sep 20, 2022

japborst Sep 20, 2022

japborst Sep 20, 2022

japborst Sep 20, 2022

rickie Sep 20, 2022

rickie Sep 20, 2022

Stephan202 Sep 20, 2022

japborst Sep 20, 2022

Stephan202 left a comment

Stephan202 Sep 20, 2022

Stephan202 left a comment

Stephan202 Sep 21, 2022

japborst Sep 21, 2022

Stephan202 Sep 21, 2022

japborst Sep 21, 2022

rickie commented Sep 28, 2022 •

edited by Stephan202

Loading

japborst Sep 28, 2022

rickie Sep 28, 2022

japborst Sep 28, 2022

japborst Sep 28, 2022

japborst Sep 28, 2022

rickie Sep 28, 2022

japborst Sep 28, 2022

japborst left a comment

Stephan202 left a comment

Stephan202 left a comment

	link = BASE_URL_BUGPATTERNS + "AmbiguousJsonCreator",
	link = BASE_URL_BUGPATTERNS.resolve("AmbiguousJsonCreator"),

Update BugPattern#{link,linkType.CUSTOM} to link to our website #251

Update BugPattern#{link,linkType.CUSTOM} to link to our website #251

Conversation

rickie commented Sep 20, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Stephan202 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Stephan202 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rickie commented Sep 28, 2022 • edited by Stephan202 Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

japborst left a comment

Choose a reason for hiding this comment

Stephan202 left a comment

Choose a reason for hiding this comment

Stephan202 left a comment

Choose a reason for hiding this comment

Update `BugPattern#{link,linkType.CUSTOM}` to link to our website #251

Update `BugPattern#{link,linkType.CUSTOM}` to link to our website #251

rickie commented Sep 28, 2022 •

edited by Stephan202

Loading