Convert run files to use PluginLogger (flutter#8526)

helin24 · web-flow · commit f87aa6817009 · 2025-09-12T14:00:37.000-07:00
Part of flutter#8369
diff --git a/src/io/flutter/FlutterUtils.java b/src/io/flutter/FlutterUtils.java
@@ -111,22 +111,30 @@ public static boolean isAndroidStudio() {
     }
   }
 
-  public static void info(@NotNull Logger logger, @NotNull String message, @NotNull Exception e, boolean sanitizePaths) {
+  public static void info(@NotNull Logger logger, @NotNull String message, @NotNull Throwable t, boolean sanitizePaths) {
     if (sanitizePaths && FlutterSettings.getInstance().isFilePathLoggingEnabled()) {
-      logger.info(message, e);
+      logger.info(message, t);
     } else {
       logger.info(message);
     }
   }
 
-  public static void warn(@NotNull Logger logger, @NotNull String message, @NotNull Exception e, boolean sanitizePaths) {
+  public static void warn(@NotNull Logger logger, @NotNull String message, @NotNull Throwable t, boolean sanitizePaths) {
     if (sanitizePaths && FlutterSettings.getInstance().isFilePathLoggingEnabled()) {
-      logger.warn(message, e);
+      logger.warn(message, t);
     } else {
       logger.warn(message);
     }
   }
 
+  public static void error(@NotNull Logger logger, @NotNull String message, @NotNull Throwable t, boolean sanitizePaths) {
+    if (sanitizePaths && FlutterSettings.getInstance().isFilePathLoggingEnabled()) {
+      logger.error(message, t);
+    } else {
+      logger.error(message);
+    }
+  }
+
   /**
    * Write a warning message to the IntelliJ log.
    * <p>
diff --git a/src/io/flutter/run/FlutterDebugProcess.java b/src/io/flutter/run/FlutterDebugProcess.java
@@ -23,6 +23,7 @@
 import io.flutter.actions.ReloadFlutterApp;
 import io.flutter.actions.RestartAllFlutterApps;
 import io.flutter.actions.RestartFlutterApp;
+import io.flutter.logging.PluginLogger;
 import io.flutter.run.common.RunMode;
 import io.flutter.run.daemon.FlutterApp;
 import io.flutter.view.FlutterViewMessages;
@@ -42,7 +43,7 @@
  * when not debugging in order to support hot reload.)
  */
 public class FlutterDebugProcess extends DartVmServiceDebugProcess {
-  private static final @NotNull Logger LOG = Logger.getInstance(FlutterDebugProcess.class);
+  private static final @NotNull Logger LOG = PluginLogger.createLogger(FlutterDebugProcess.class);
 
   private final @NotNull FlutterApp app;
 
@@ -141,7 +142,7 @@ private static void suppressDebugViews(@Nullable RunnerLayoutUi ui) {
           }
         }
         catch (ProcessCanceledException e) {
-          FlutterUtils.warn(LOG, "Failed to suppress debug views", e, true);
+          FlutterUtils.warn(LOG, "ProcessCanceledException in suppressDebugViews", e, true);
           throw e;
         }
       }
diff --git a/src/io/flutter/run/FlutterPositionMapper.java b/src/io/flutter/run/FlutterPositionMapper.java
@@ -22,6 +22,7 @@
 import com.jetbrains.lang.dart.util.DartUrlResolver;
 import io.flutter.FlutterUtils;
 import io.flutter.dart.DartPlugin;
+import io.flutter.logging.PluginLogger;
 import io.flutter.utils.OpenApiUtils;
 import io.flutter.vmService.DartVmServiceDebugProcess;
 import org.dartlang.vm.service.element.LibraryRef;
@@ -40,7 +41,7 @@
  * Used when setting breakpoints, stepping through code, and so on while debugging.
  */
 public class FlutterPositionMapper implements DartVmServiceDebugProcess.PositionMapper {
-  private static final @NotNull Logger LOG = Logger.getInstance(FlutterPositionMapper.class);
+  private static final @NotNull Logger LOG = PluginLogger.createLogger(FlutterPositionMapper.class);
 
   /**
    * This Project can't be non-null as we set it to null {@link #shutdown()} so the Project isn't held onto.
@@ -257,7 +258,7 @@ private XSourcePosition getSourcePosition(@NotNull final String isolateId, @NotN
   private XSourcePosition getSourcePosition(@NotNull final String isolateId, @NotNull final String scriptId,
                                             @NotNull final String scriptUri, int tokenPos, CompletableFuture<String> fileFuture) {
     if (scriptProvider == null) {
-      FlutterUtils.warn(LOG, "attempted to get source position before connected to observatory");
+      LOG.warn("attempted to get source position before connected to observatory");
       return null;
     }
 
@@ -379,13 +380,13 @@ static Analyzer create(@NotNull Project project, @NotNull VirtualFile sourceLoca
       }
 
       if (!dartAnalysisServerService.serverReadyForRequest()) {
-        FlutterUtils.warn(LOG, "Dart analysis server is not running. Some breakpoints may not work.");
+        LOG.warn("Dart analysis server is not running. Some breakpoints may not work.");
         return null;
       }
 
       final String contextId = dartAnalysisServerService.execution_createContext(sourceLocation.getPath());
       if (contextId == null) {
-        FlutterUtils.warn(LOG, "Failed to get execution context from analysis server. Some breakpoints may not work.");
+        LOG.warn("Failed to get execution context from analysis server. Some breakpoints may not work.");
         return null;
       }
 
diff --git a/src/io/flutter/run/FlutterReloadManager.java b/src/io/flutter/run/FlutterReloadManager.java
@@ -55,6 +55,7 @@
 import io.flutter.bazel.Workspace;
 import io.flutter.bazel.WorkspaceCache;
 import io.flutter.dart.FlutterDartAnalysisServer;
+import io.flutter.logging.PluginLogger;
 import io.flutter.run.common.RunMode;
 import io.flutter.run.daemon.FlutterApp;
 import io.flutter.settings.FlutterSettings;
@@ -74,7 +75,7 @@
  * Handle the mechanics of performing a hot reload on file save.
  */
 public class FlutterReloadManager {
-  private static final @NotNull Logger LOG = Logger.getInstance(FlutterReloadManager.class);
+  private static final @NotNull Logger LOG = PluginLogger.createLogger(FlutterReloadManager.class);
 
   private static final Map<String, NotificationGroup> toolWindowNotificationGroups = new HashMap<>();
 
@@ -142,7 +143,7 @@ public void beforeActionPerformed(@NotNull AnAction action, @NotNull AnActionEve
         }
         catch (Throwable t) {
           // A catch-all, so any exceptions don't bubble through to the users.
-          LOG.warn("Exception from FlutterReloadManager", t);
+          FlutterUtils.warn(LOG, "Exception from FlutterReloadManager", t, true);
         }
       }
 
@@ -161,7 +162,7 @@ public void afterActionPerformed(@NotNull AnAction action, @NotNull AnActionEven
           handleSaveAllNotification(eventEditor);
         }
         catch (Throwable t) {
-          FlutterUtils.warn(LOG, "Exception from hot reload on save", t);
+          FlutterUtils.warn(LOG, "Exception from hot reload on save", t, true);
         }
         finally {
           // Context: "Released EditorImpl held by lambda in FlutterReloadManager" (https://github.com/flutter/flutter-intellij/issues/7507)
@@ -325,7 +326,7 @@ private void syncFiles() {
       }
     }
     catch (ExecutionException | InterruptedException e) {
-      LOG.error("Unable to sync files: " + e);
+      FlutterUtils.error(LOG, "Unable to sync files", e, true);
     }
   }
 
diff --git a/src/io/flutter/run/OpenDevToolsAction.java b/src/io/flutter/run/OpenDevToolsAction.java
@@ -13,21 +13,24 @@
 import com.intellij.openapi.project.Project;
 import com.intellij.openapi.util.Computable;
 import icons.FlutterIcons;
+import io.flutter.FlutterUtils;
 import io.flutter.ObservatoryConnector;
 import io.flutter.bazel.WorkspaceCache;
 import io.flutter.devtools.DevToolsIdeFeature;
 import io.flutter.devtools.DevToolsUrl;
+import io.flutter.logging.PluginLogger;
 import io.flutter.run.daemon.DevToolsService;
 import io.flutter.run.daemon.FlutterApp;
 import io.flutter.sdk.FlutterSdk;
+import io.flutter.settings.FlutterSettings;
 import io.flutter.utils.AsyncUtils;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
 import java.util.Objects;
 
 public class OpenDevToolsAction extends DumbAwareAction {
-  private static final @NotNull Logger LOG = Logger.getInstance(OpenDevToolsAction.class);
+  private static final @NotNull Logger LOG = PluginLogger.createLogger(OpenDevToolsAction.class);
   private static final String title = "Open Flutter DevTools in Browser";
   private final @Nullable ObservatoryConnector myConnector;
   private final Computable<Boolean> myIsApplicable;
@@ -76,7 +79,7 @@ public void actionPerformed(@NotNull final AnActionEvent event) {
       }
 
       if (ex != null) {
-        LOG.error(ex);
+        FlutterUtils.error(LOG, "Exception in getDevToolsInstance", ex, true);
         return;
       }
 
diff --git a/src/io/flutter/run/SdkRunConfig.java b/src/io/flutter/run/SdkRunConfig.java
@@ -40,9 +40,11 @@
 import io.flutter.FlutterUtils;
 import io.flutter.console.FlutterConsoleFilter;
 import io.flutter.dart.FlutterDartAnalysisServer;
+import io.flutter.logging.PluginLogger;
 import io.flutter.run.common.RunMode;
 import io.flutter.run.daemon.FlutterApp;
 import io.flutter.sdk.FlutterSdkManager;
+import io.flutter.settings.FlutterSettings;
 import org.jdom.Element;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
@@ -59,7 +61,7 @@
 public class SdkRunConfig extends LocatableConfigurationBase<LaunchState>
   implements LaunchState.RunConfig, RefactoringListenerProvider, RunConfigurationWithSuppressedDefaultRunAction {
 
-  private static final @NotNull Logger LOG = Logger.getInstance(SdkRunConfig.class);
+  private static final @NotNull Logger LOG = PluginLogger.createLogger(SdkRunConfig.class);
   private boolean firstRun = true;
 
   private @NotNull SdkFields fields = new SdkFields();
@@ -117,7 +119,7 @@ public static class RecursiveDeleter extends SimpleFileVisitor<Path> {
 
     @Override
     public @NotNull FileVisitResult visitFileFailed(@NotNull Path file, @NotNull IOException exc) {
-      FlutterUtils.warn(LOG, "Unable to visit file", exc, true);
+      FlutterUtils.warn(LOG, "Unable to visit file in RecursiveDeleter", exc, true);
       return CONTINUE;
     }
   }
@@ -165,7 +167,8 @@ public LaunchState getState(@NotNull Executor executor, @NotNull ExecutionEnviro
           existingJson = Files.readString(cachedParametersPath);
         }
         catch (IOException e) {
-          FlutterUtils.warn(LOG, "Unable to get existing json from " + cachedParametersPath);
+          LOG.warn("Unable to get existing json from " +
+                   (FlutterSettings.getInstance().isFilePathLoggingEnabled() ? cachedParametersPath : cachedParametersPath.getFileName()));
         }
       }
       if (!StringUtil.equals(json, existingJson)) {

Original file line number	Diff line number	Diff line change
`@@ -111,22 +111,30 @@ public static boolean isAndroidStudio() {`
`111`	`111`	`}`
`112`	`112`	`}`
`113`	`113`
`114`		`- public static void info(@NotNull Logger logger, @NotNull String message, @NotNull Exception e, boolean sanitizePaths) {`
	`114`	`+ public static void info(@NotNull Logger logger, @NotNull String message, @NotNull Throwable t, boolean sanitizePaths) {`
`115`	`115`	`if (sanitizePaths && FlutterSettings.getInstance().isFilePathLoggingEnabled()) {`
`116`		`- logger.info(message, e);`
	`116`	`+ logger.info(message, t);`
`117`	`117`	`} else {`
`118`	`118`	`logger.info(message);`
`119`	`119`	`}`
`120`	`120`	`}`
`121`	`121`
`122`		`- public static void warn(@NotNull Logger logger, @NotNull String message, @NotNull Exception e, boolean sanitizePaths) {`
	`122`	`+ public static void warn(@NotNull Logger logger, @NotNull String message, @NotNull Throwable t, boolean sanitizePaths) {`
`123`	`123`	`if (sanitizePaths && FlutterSettings.getInstance().isFilePathLoggingEnabled()) {`
`124`		`- logger.warn(message, e);`
	`124`	`+ logger.warn(message, t);`
`125`	`125`	`} else {`
`126`	`126`	`logger.warn(message);`
`127`	`127`	`}`
`128`	`128`	`}`
`129`	`129`
	`130`	`+ public static void error(@NotNull Logger logger, @NotNull String message, @NotNull Throwable t, boolean sanitizePaths) {`
	`131`	`+ if (sanitizePaths && FlutterSettings.getInstance().isFilePathLoggingEnabled()) {`
	`132`	`+ logger.error(message, t);`
	`133`	`+ } else {`
	`134`	`+ logger.error(message);`
	`135`	`+ }`
	`136`	`+ }`
	`137`	`+`
`130`	`138`	`/**`
`131`	`139`	`* Write a warning message to the IntelliJ log.`
`132`	`140`	`* <p>`
Original file line number	Diff line number	Diff line change
`@@ -23,6 +23,7 @@`
`23`	`23`	`import io.flutter.actions.ReloadFlutterApp;`
`24`	`24`	`import io.flutter.actions.RestartAllFlutterApps;`
`25`	`25`	`import io.flutter.actions.RestartFlutterApp;`
	`26`	`+import io.flutter.logging.PluginLogger;`
`26`	`27`	`import io.flutter.run.common.RunMode;`
`27`	`28`	`import io.flutter.run.daemon.FlutterApp;`
`28`	`29`	`import io.flutter.view.FlutterViewMessages;`
`@@ -42,7 +43,7 @@`
`42`	`43`	`* when not debugging in order to support hot reload.)`
`43`	`44`	`*/`
`44`	`45`	`public class FlutterDebugProcess extends DartVmServiceDebugProcess {`
`45`		`- private static final @NotNull Logger LOG = Logger.getInstance(FlutterDebugProcess.class);`
	`46`	`+ private static final @NotNull Logger LOG = PluginLogger.createLogger(FlutterDebugProcess.class);`
`46`	`47`
`47`	`48`	`private final @NotNull FlutterApp app;`
`48`	`49`
`@@ -141,7 +142,7 @@ private static void suppressDebugViews(@Nullable RunnerLayoutUi ui) {`
`141`	`142`	`}`
`142`	`143`	`}`
`143`	`144`	`catch (ProcessCanceledException e) {`
`144`		`- FlutterUtils.warn(LOG, "Failed to suppress debug views", e, true);`
	`145`	`+ FlutterUtils.warn(LOG, "ProcessCanceledException in suppressDebugViews", e, true);`
`145`	`146`	`throw e;`
`146`	`147`	`}`
`147`	`148`	`}`
Original file line number	Diff line number	Diff line change
`@@ -55,6 +55,7 @@`
`55`	`55`	`import io.flutter.bazel.Workspace;`
`56`	`56`	`import io.flutter.bazel.WorkspaceCache;`
`57`	`57`	`import io.flutter.dart.FlutterDartAnalysisServer;`
	`58`	`+import io.flutter.logging.PluginLogger;`
`58`	`59`	`import io.flutter.run.common.RunMode;`
`59`	`60`	`import io.flutter.run.daemon.FlutterApp;`
`60`	`61`	`import io.flutter.settings.FlutterSettings;`
`@@ -74,7 +75,7 @@`
`74`	`75`	`* Handle the mechanics of performing a hot reload on file save.`
`75`	`76`	`*/`
`76`	`77`	`public class FlutterReloadManager {`
`77`		`- private static final @NotNull Logger LOG = Logger.getInstance(FlutterReloadManager.class);`
	`78`	`+ private static final @NotNull Logger LOG = PluginLogger.createLogger(FlutterReloadManager.class);`
`78`	`79`
`79`	`80`	`private static final Map<String, NotificationGroup> toolWindowNotificationGroups = new HashMap<>();`
`80`	`81`
`@@ -142,7 +143,7 @@ public void beforeActionPerformed(@NotNull AnAction action, @NotNull AnActionEve`
`142`	`143`	`}`
`143`	`144`	`catch (Throwable t) {`
`144`	`145`	`// A catch-all, so any exceptions don't bubble through to the users.`
`145`		`- LOG.warn("Exception from FlutterReloadManager", t);`
	`146`	`+ FlutterUtils.warn(LOG, "Exception from FlutterReloadManager", t, true);`
`146`	`147`	`}`
`147`	`148`	`}`
`148`	`149`
`@@ -161,7 +162,7 @@ public void afterActionPerformed(@NotNull AnAction action, @NotNull AnActionEven`
`161`	`162`	`handleSaveAllNotification(eventEditor);`
`162`	`163`	`}`
`163`	`164`	`catch (Throwable t) {`
`164`		`- FlutterUtils.warn(LOG, "Exception from hot reload on save", t);`
	`165`	`+ FlutterUtils.warn(LOG, "Exception from hot reload on save", t, true);`
`165`	`166`	`}`
`166`	`167`	`finally {`
`167`	`168`	`// Context: "Released EditorImpl held by lambda in FlutterReloadManager" (https://github.com/flutter/flutter-intellij/issues/7507)`
`@@ -325,7 +326,7 @@ private void syncFiles() {`
`325`	`326`	`}`
`326`	`327`	`}`
`327`	`328`	`catch (ExecutionException \| InterruptedException e) {`
`328`		`- LOG.error("Unable to sync files: " + e);`
	`329`	`+ FlutterUtils.error(LOG, "Unable to sync files", e, true);`
`329`	`330`	`}`
`330`	`331`	`}`
`331`	`332`