1571308 - Apilint error message should not include `detail`

Status: RESOLVED FIXED

(GeckoView :: General, defect, P3)

Description

[[ex-Mozilla] Agi Sferro | :agi]

The integration of apilint with mach lint adds the detail section to the error message. This is unnecessary as the detail just contains the name of the method or class that is causing the error, this piece of information is already present in the file/line/column fields.

e.g. this:

/Users/asferro/workspace/mozilla-central/mobile/android/geckoview/src/main/java/org/mozilla/geckoview/RuntimeTelemetry.java
   71:25  error  Field-only classes should not be final for mocking.: None                                                                                                                                       failures (android-api-lint)
   71:25  error  Field-only classes need at least one constructor for mocking.: None                                                                                                                             failures (android-api-lint)
   75:29  error  Missing field type nullability annotation. Needs one of @Nullable, @NonNull.: field public final String name                                                                                    failures (android-api-lint)
   80:29  error  Missing field type nullability annotation. Needs one of @Nullable, @NonNull.: field public final long[] values                                                                                  failures (android-api-lint)
  104:21  error  Method missing threading annotation. Needs one of: @MainThread, @UiThread, @WorkerThread, @BinderThread, @AnyThread.: method public void onTelemetryReceived(@NonNull RuntimeTelemetry.Metric)  failures (android-api-lint)

should be:

/Users/asferro/workspace/mozilla-central/mobile/android/geckoview/src/main/java/org/mozilla/geckoview/RuntimeTelemetry.java
   71:25  error  Field-only classes should not be final for mocking.                                                                   failures (android-api-lint)
   71:25  error  Field-only classes need at least one constructor for mocking.                                                         failures (android-api-lint)
   75:29  error  Missing field type nullability annotation. Needs one of @Nullable, @NonNull.                                          failures (android-api-lint)
   80:29  error  Missing field type nullability annotation. Needs one of @Nullable, @NonNull.                                          failures (android-api-lint)
  104:21  error  Method missing threading annotation. Needs one of: @MainThread, @UiThread, @WorkerThread, @BinderThread, @AnyThread.  failures (android-api-lint)

Comment 1

[[ex-Mozilla] Agi Sferro | :agi]

Attachment: Bug 1571308 - Don't include |detail| in apilint output.

Comment 2

[[ex-Mozilla] Agi Sferro | :agi]

Attachment: Bug 1571308 - Use error code from apilint.

Failures in apilint have a rule code so include that in the information from
the lint.

Comment 3

[[ex-Mozilla] Agi Sferro | :agi]

I need to land one patch of the series for another bug.

Comment 4

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/b587b6fc7ee1
Don't include |detail| in apilint output. r=nalexander

Comment 5

[Raul Gurzau (:RaulG)]

https://hg.mozilla.org/mozilla-central/rev/b587b6fc7ee1

Comment 6

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/56152ebae420
Use error code from apilint. r=nalexander

Comment 7

[Andrei Ciure[:aciure]]

https://hg.mozilla.org/mozilla-central/rev/56152ebae420

Comment 8

[Chris Peterson [:cpeterson]]

status-firefox69=wontfix because we don't need to uplift this apilint fix to Beta.