Write lint check with auto-fix to handle minSdk bump changes [318550385]

Fixed

Feature Request

Status Update

No update yet.

Description

al...@google.com

created issue #1

Jan 3, 2024 09:04PM

Raising our minSdk version left us with a few categories of mechanical fixes that are currently performed manually but could be automated:

Removing dead code paths gated on SDK_INT checks, e.g.

public Clazz doTheThing(View v) {
  if (SDK_INT >= 16) {
    return v.doTheThing();
  } else {
     // Fallback behavior.
  }
}

// becomes...

public Class doTheThing(View v) {
  return v.doTheThing()
}

This is covered by an existing lint check with auto-fix, but I'm mentioning it because it dovetails into the next catergory

Deprecating methods that are purely pass-through to their platform equivalents, e.g.

public Class doTheThing(View v) {
  return v.doTheThing()
}

// becomes...

/**
 * @deprecated Use {@link View#doTheThing()} directly.
 */
@Deprecated
public Clazz doTheThing(View v) {
  return v.doTheThing()
}

Replacing usages of deprecated methods with their platform equivalents, e.g.

Clazz result = ViewCompat.doTheThing(v);

// becomes...

Clazz result = v.doTheThing();

It would be nice to have an internal lint auto-fix for (1) and (2), and maybe we could do a public lint auto-fix for (3). Or migrate everyone to Kotlin and use ReplaceWith?

Comments

al...@google.com <al...@google.com> Jan 8, 2024 02:52PM

Accepted by al...@google.com.

ap...@google.com <ap...@google.com> #2Jan 17, 2024 08:39PM

Any updates on this? It's been a month already since I reported it, and it seems this crash is occurring quite frequently for my users.

ap...@google.com <ap...@google.com> #3Jan 17, 2024 08:39PM

I am still regularly receiving reports about this issue, and it seems it has not been addressed in the latest 1.4.0-rc01 release.

ap...@google.com <ap...@google.com> #4Jan 17, 2024 08:39PM

Seems like a fairly easy fix on our end. I'll see to that it is fixed in 1.5.

al...@google.com <al...@google.com> #5Jan 17, 2024 08:46PM

Lots of remaining work:

Support for imports parameter with auto-fix
Tests for applying Java ReplaceWith to Kotlin sources
- Probably also changes to the auto-fixes for Kotlin syntax
More testing of different expression values
- Maybe lint enforcement of correct, parseable expression values
Support for applying Kotlin @Deprecated(replaceWith) to Java sources

ap...@google.com <ap...@google.com> #6Jan 25, 2024 10:02PM

Project: platform/frameworks/support
Branch: androidx-main

commit 1633f9fec600b25b596638393ce27bfb3b7e6bd9
Author: Alan Viverette <alanv@google.com>
Date: Thu Jan 18 11:26:25 2024

Create lint check for deprecating obsolete compat methods

Shows as an error in the IDE but not CLI. Unfortunately this makes it
harder to auto-fix via CLI robot, so we'd want to manually re-enable the
check when fixing things locally.

Bug: 318550385
Test: ObsoleteCompatDetectorTest
Change-Id: I2b5e76af4b8f0a10014fef63dfc4b11dd8288ae0

M buildSrc/private/src/main/kotlin/androidx/build/LintConfiguration.kt
M lint-checks/integration-tests/build.gradle
A lint-checks/integration-tests/src/main/java/androidx/ObsoleteCompatMethod.java
A lint-checks/integration-tests/src/main/java/androidx/ObsoleteCompatMethodMissingDeprecated.java
A lint-checks/integration-tests/src/main/java/androidx/ObsoleteCompatMethodMissingDeprecatedAndJavadoc.java
A lint-checks/integration-tests/src/main/java/androidx/ObsoleteCompatMethodMissingJavadoc.java
A lint-checks/integration-tests/src/main/java/androidx/ObsoleteCompatMethodMissingReplaceWith.java
M lint-checks/src/main/java/androidx/build/lint/AndroidXIssueRegistry.kt
A lint-checks/src/main/java/androidx/build/lint/ObsoleteCompatDetector.kt
A lint-checks/src/test/java/androidx/build/lint/ObsoleteCompatDetectorTest.kt

https://android-review.googlesource.com/2925551

al...@google.com <al...@google.com> Feb 1, 2024 06:46PM

Marked as fixed.