slack.lint.DeprecatedSqlUsageDetector.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of slack-lint-checks Show documentation
Slack lint checks.
The newest version!
// Copyright (C) 2021 Slack Technologies, LLC
// SPDX-License-Identifier: Apache-2.0
package slack.lint

import com.android.tools.lint.client.api.UElementHandler
import com.android.tools.lint.detector.api.Category
import com.android.tools.lint.detector.api.Detector
import com.android.tools.lint.detector.api.Implementation
import com.android.tools.lint.detector.api.Issue
import com.android.tools.lint.detector.api.JavaContext
import com.android.tools.lint.detector.api.Severity
import com.android.tools.lint.detector.api.SourceCodeScanner
import org.jetbrains.uast.UCallExpression
import slack.lint.util.sourceImplementation

/**
 * Raises a warning on direct sqlite database usage and encourages
 * [SqlDelight](https://cashapp.github.io/sqldelight/) usage.
 */
@Suppress("UnstableApiUsage")
class DeprecatedSqlUsageDetector : Detector(), SourceCodeScanner {

  override fun getApplicableUastTypes() = listOf(UCallExpression::class.java)

  override fun createUastHandler(context: JavaContext) =
    object : UElementHandler() {
      override fun visitCallExpression(node: UCallExpression) {
        if (
          APPLICABLE_RECEIVER_TYPES.contains(node.receiverType?.canonicalText) &&
            APPLICABLE_CALL_NAMES.contains(node.methodIdentifier?.name)
        ) {
          context.report(
            issue = ISSUE,
            location = context.getLocation(node),
            message = "All SQL querying should be performed using `SqlDelight`",
          )
        }
      }
    }

  companion object {
    private fun Implementation.toIssue(): Issue {
      return Issue.create(
        id = "DeprecatedSqlUsage",
        briefDescription = "Use SqlDelight!",
        explanation = "Safer, faster, etc",
        category = Category.CORRECTNESS,
        priority = 0,
        severity = Severity.WARNING,
        implementation = this,
      )
    }

    val ISSUE: Issue = sourceImplementation().toIssue()

    private val APPLICABLE_CALL_NAMES = listOf("query", "insert", "update", "delete", "execSQL")
    private val APPLICABLE_RECEIVER_TYPES =
      listOf("android.database.sqlite.SQLiteDatabase", "androidx.sqlite.db.SupportSQLiteDatabase")
  }
}