Forbid android.util.Log (#21696)

Author: dnfield

shell/platform/android/BUILD.gn

@@ -251,6 +251,23 @@ embedding_dependencies_jars =
                 ],
                 "list lines")
 
+action("check_imports") {
+  script = "//flutter/tools/android_illegal_imports.py"
+
+  sources = android_java_sources
+
+  stamp_file = "$root_out_dir/check_android_imports"
+
+  # File does not actually get created, but GN expects us to have an output here.
+  outputs = [ stamp_file ]
+
+  args = [
+           "--stamp",
+           rebase_path(stamp_file),
+           "--files",
+         ] + rebase_path(android_java_sources)
+}
+
 action("flutter_shell_java") {
   script = "//build/android/gyp/javac.py"
   depfile = "$target_gen_dir/$target_name.d"
@@ -299,7 +316,10 @@ action("flutter_shell_java") {
 
   args += rebase_path(sources, root_build_dir)
 
-  deps = [ ":gen_android_build_config_java" ]
+  deps = [
+    ":check_imports",
+    ":gen_android_build_config_java",
+  ]
 }
 
 action("icudtl_object") {

shell/platform/android/io/flutter/Log.java

@@ -13,6 +13,13 @@
 public class Log {
   private static int logLevel = android.util.Log.DEBUG;
 
+  public static int ASSERT = android.util.Log.ASSERT;
+  public static int DEBUG = android.util.Log.DEBUG;
+  public static int ERROR = android.util.Log.ERROR;
+  public static int INFO = android.util.Log.INFO;
+  public static int VERBOSE = android.util.Log.VERBOSE;
+  public static int WARN = android.util.Log.WARN;
+
   /**
    * Sets a log cutoff such that a log level of lower priority than {@code logLevel} is filtered
    * out.
@@ -23,6 +30,12 @@ public static void setLogLevel(int logLevel) {
     Log.logLevel = logLevel;
   }
 
+  public static void println(@NonNull int level, @NonNull String tag, @NonNull String message) {
+    if (BuildConfig.DEBUG && logLevel <= level) {
+      android.util.Log.println(level, tag, message);
+    }
+  }
+
   public static void v(@NonNull String tag, @NonNull String message) {
     if (BuildConfig.DEBUG && logLevel <= android.util.Log.VERBOSE) {
       android.util.Log.v(tag, message);

shell/platform/android/io/flutter/app/FlutterActivityDelegate.java

@@ -19,12 +19,12 @@
 import android.graphics.drawable.Drawable;
 import android.os.Build;
 import android.os.Bundle;
-import android.util.Log;
 import android.util.TypedValue;
 import android.view.View;
 import android.view.ViewGroup;
 import android.view.Window;
 import android.view.WindowManager.LayoutParams;
+import io.flutter.Log;
 import io.flutter.plugin.common.PluginRegistry;
 import io.flutter.plugin.platform.PlatformPlugin;
 import io.flutter.util.Preconditions;

shell/platform/android/io/flutter/embedding/android/AndroidKeyProcessor.java

@@ -4,12 +4,12 @@
 
 package io.flutter.embedding.android;
 
-import android.util.Log;
 import android.view.KeyCharacterMap;
 import android.view.KeyEvent;
 import android.view.View;
 import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
+import io.flutter.Log;
 import io.flutter.embedding.engine.systemchannels.KeyEventChannel;
 import io.flutter.plugin.editing.TextInputPlugin;
 import java.util.AbstractMap.SimpleImmutableEntry;

shell/platform/android/io/flutter/embedding/engine/loader/FlutterLoader.java

@@ -10,12 +10,12 @@
 import android.os.Handler;
 import android.os.Looper;
 import android.os.SystemClock;
-import android.util.Log;
 import android.view.WindowManager;
 import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
 import io.flutter.BuildConfig;
 import io.flutter.FlutterInjector;
+import io.flutter.Log;
 import io.flutter.embedding.engine.FlutterJNI;
 import io.flutter.util.PathUtils;
 import io.flutter.view.VsyncWaiter;

shell/platform/android/io/flutter/embedding/engine/loader/ResourceExtractor.java

@@ -11,10 +11,10 @@
 import android.content.res.AssetManager;
 import android.os.AsyncTask;
 import android.os.Build;
-import android.util.Log;
 import androidx.annotation.NonNull;
 import androidx.annotation.WorkerThread;
 import io.flutter.BuildConfig;
+import io.flutter.Log;
 import java.io.*;
 import java.util.ArrayList;
 import java.util.Collection;

shell/platform/android/io/flutter/plugin/common/BasicMessageChannel.java

@@ -4,11 +4,11 @@
 
 package io.flutter.plugin.common;
 
-import android.util.Log;
 import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
 import androidx.annotation.UiThread;
 import io.flutter.BuildConfig;
+import io.flutter.Log;
 import io.flutter.plugin.common.BinaryMessenger.BinaryMessageHandler;
 import io.flutter.plugin.common.BinaryMessenger.BinaryReply;
 import java.nio.ByteBuffer;

shell/platform/android/io/flutter/plugin/common/ErrorLogResult.java

@@ -4,9 +4,9 @@
 
 package io.flutter.plugin.common;
 
-import android.util.Log;
 import androidx.annotation.Nullable;
 import io.flutter.BuildConfig;
+import io.flutter.Log;
 
 /**
  * An implementation of {@link MethodChannel.Result} that writes error results to the Android log.

shell/platform/android/io/flutter/plugin/common/EventChannel.java

@@ -4,9 +4,9 @@
 
 package io.flutter.plugin.common;
 
-import android.util.Log;
 import androidx.annotation.UiThread;
 import io.flutter.BuildConfig;
+import io.flutter.Log;
 import io.flutter.plugin.common.BinaryMessenger.BinaryMessageHandler;
 import io.flutter.plugin.common.BinaryMessenger.BinaryReply;
 import java.nio.ByteBuffer;

shell/platform/android/io/flutter/plugin/common/FlutterException.java

@@ -4,8 +4,8 @@
 
 package io.flutter.plugin.common;
 
-import android.util.Log;
 import io.flutter.BuildConfig;
+import io.flutter.Log;
 
 /** Thrown to indicate that a Flutter method invocation failed on the Flutter side. */
 public class FlutterException extends RuntimeException {