WrongConstant lint on definition instead of usage of constant using shift [378128668]

Fixed

Bug

Status Update

No update yet.

Description

ju...@google.com

created issue #1

Nov 8, 2024 08:20PM

Seeing this when trying to update AndroidX to lint 31.8.0-alpha08 from 31.8.0-alpha06. Assuming this is related to b/370778975.

When an incorrect constant is used for an IntDef, and the constant was defined using the int shift operator, the lint error is appearing on the constant definition instead of the usage.

Repro example:

import androidx.annotation.IntDef;

public class TestFlags {
    public static final int SHIFT_FLAG = 1 << 1;

    @IntDef(flag = true, value = { 0 })
    public @interface FlagDef {}

    @FlagDef int flags = SHIFT_FLAG;
}

Instead of a lint error appearing on the flags = SHIFT_FLAG line, it instead appears on the definition of SHIFT_FLAG:

  TestFlags.java:22: Error: Must be one or more of: 0 [WrongConstant]
      public static final int SHIFT_FLAG = 1 << 1;
                                           ~
  TestFlags.java:22: Error: Must be one or more of: 0 [WrongConstant]
      public static final int SHIFT_FLAG = 1 << 1;
                                                ~

Comments

js...@google.com <js...@google.com> #2Nov 8, 2024 08:27PM

Yes, changed as of http://ag/29978104. In particular,

  ...
  if (argument is UPolyadicExpression) {
    ...
    for (operand in argument.operands) {
      checkTypeDefConstant(context, annotation, operand, operand, true, usageInfo)
    }
  }
  ...

The 2nd operand was previously errorNode, the use site.

I'm afraid to say that this is intentional. Otherwise, i.e., if we still report the error(s) on the usage while the constant definition is composed of multiple wrong constants, then now we're facing duplicate report issue.

ju...@google.com <ju...@google.com> #3Nov 8, 2024 08:31PM

In this case there can still be duplicate issue reported, but without being clear why. If I add @FlagDef int flags2 = SHIFT_FLAG; to this example, I get both errors duplicated.

js...@google.com <js...@google.com> #4Nov 8, 2024 09:21PM

Oh... that is interesting. Alright, so, in either way, we need to handle potential duplicate error reports inside TypedefDetector. I have to rewrite that detector as part of 243 update (http://ag/30307549), and will revisit this after that.

js...@google.com <js...@google.com> Nov 13, 2024 07:08PM

Accepted by js...@google.com.

js...@google.com <js...@google.com> Nov 17, 2024 07:11PM

Marked as fixed.

an...@google.com <an...@google.com> #5Nov 22, 2024 12:04AM

Thank you for your patience while our engineering team worked to resolve this issue. A fix for this issue is now available in:

Android Studio Meerkat | 2024.3.1 Canary 3
Android Gradle Plugin 8.9.0-alpha03

We encourage you to try the latest update.

If you notice further issues or have questions, please file a new bug report.

Thank you for taking the time to submit feedback — we really appreciate it!

pr...@google.com <pr...@google.com> #6Dec 11, 2024 06:27PM

The following release(s) address this bug.It is possible this bug has only been partially addressed:

androidx.compose.ui:ui-text-lint:1.8.0-alpha07
androidx.core:core:1.16.0-alpha01
androidx.lint:lint-gradle:1.0.0-alpha03