Add logging to project initialization (#8322)

This logs any issues from project setup in `FlutterInitializer` to our
dedicated log file.

The log variable from `protected val log` is internal, and I'm not sure
why (despite asking Gemini multiple questions about it). That's why I'm
accessing the log from a function instead.

Author: helin24

flutter-idea/src/io/flutter/FlutterInitializer.java

@@ -18,7 +18,6 @@
 import com.intellij.openapi.application.ApplicationManager;
 import com.intellij.openapi.application.ModalityState;
 import com.intellij.openapi.application.ReadAction;
-import com.intellij.openapi.diagnostic.Logger;
 import com.intellij.openapi.editor.colors.EditorColorsListener;
 import com.intellij.openapi.editor.colors.EditorColorsManager;
 import com.intellij.openapi.extensions.PluginId;
@@ -41,7 +40,6 @@
 import io.flutter.devtools.RemainingDevToolsViewFactory;
 import io.flutter.editor.FlutterSaveActionsManager;
 import io.flutter.logging.FlutterConsoleLogManager;
-import io.flutter.logging.PluginLogger;
 import io.flutter.module.FlutterModuleBuilder;
 import io.flutter.pub.PubRoot;
 import io.flutter.pub.PubRoots;
@@ -58,7 +56,6 @@
 import io.flutter.utils.OpenApiUtils;
 import io.flutter.view.InspectorViewFactory;
 import org.jetbrains.annotations.NotNull;
-import org.jetbrains.annotations.Nullable;
 
 import java.util.ArrayList;
 import java.util.List;
@@ -75,7 +72,6 @@
  * may run when a project is being imported.
  */
 public class FlutterInitializer extends FlutterProjectActivity {
-  private static final @NotNull Logger LOG = PluginLogger.createLogger(FlutterInitializer.class);
   private boolean toolWindowsInitialized = false;
 
   private boolean busSubscribed = false;
@@ -84,7 +80,7 @@ public class FlutterInitializer extends FlutterProjectActivity {
 
   @Override
   public void executeProjectStartup(@NotNull Project project) {
-    LOG.info("Executing Flutter plugin startup for project: " + project.getName());
+    log().info("Executing Flutter plugin startup for project: " + project.getName());
     // Disable the 'Migrate Project to Gradle' notification.
     FlutterUtils.disableGradleProjectMigrationNotification(project);
 
@@ -109,7 +105,7 @@ public void executeProjectStartup(@NotNull Project project) {
         continue;
       }
 
-      LOG.info("Flutter module has been found for project: " + project.getName());
+      log().info("Flutter module has been found for project: " + project.getName());
       // Ensure SDKs are configured; needed for clean module import.
       FlutterModuleUtils.enableDartSDK(module);
 
@@ -130,7 +126,6 @@ public void executeProjectStartup(@NotNull Project project) {
       }
     }
 
-
     // Lambdas need final vars.
     boolean finalHasFlutterModule = hasFlutterModule;
     ReadAction.nonBlocking(() -> {
@@ -283,29 +278,29 @@ private void sendThemeChangedEvent(@NotNull Project project) {
           final DtdUtils dtdUtils = new DtdUtils();
           final DartToolingDaemonService dtdService = dtdUtils.readyDtdService(project).get();
           if (dtdService == null) {
-            LOG.error("Unable to send theme changed event because DTD service is null");
+            log().error("Unable to send theme changed event because DTD service is null");
             return;
           }
 
           dtdService.sendRequest("postEvent", params, false, object -> {
                                    JsonObject result = object.getAsJsonObject("result");
                                    if (result == null) {
-                                     LOG.error("Theme changed event returned null result");
+                                     log().error("Theme changed event returned null result");
                                      return;
                                    }
                                    JsonPrimitive type = result.getAsJsonPrimitive("type");
                                    if (type == null) {
-                                     LOG.error("Theme changed event result type is null");
+                                     log().error("Theme changed event result type is null");
                                      return;
                                    }
                                    if (!"Success".equals(type.getAsString())) {
-                                     LOG.error("Theme changed event result: " + type.getAsString());
+                                     log().error("Theme changed event result: " + type.getAsString());
                                    }
                                  }
           );
         }
         catch (WebSocketException | InterruptedException | ExecutionException e) {
-          LOG.error("Unable to send theme changed event", e);
+          log().error("Unable to send theme changed event", e);
         }
       }, 1, TimeUnit.SECONDS);
     }

flutter-idea/src/io/flutter/FlutterProjectActivity.kt

@@ -9,10 +9,11 @@ package io.flutter
 import com.intellij.openapi.diagnostic.Logger
 import com.intellij.openapi.project.Project
 import com.intellij.openapi.startup.ProjectActivity
+import io.flutter.logging.PluginLogger
 
 abstract class FlutterProjectActivity : ProjectActivity {
 
-  protected val log = Logger.getInstance(this::class.java)
+  protected val log = PluginLogger.createLogger(this::class.java)
   abstract fun executeProjectStartup(project: Project)
 
   override suspend fun execute(project: Project) {
@@ -22,4 +23,8 @@ abstract class FlutterProjectActivity : ProjectActivity {
       log.error(it)
     }
   }
+
+  protected fun log(): Logger {
+    return log;
+  }
 }

flutter-idea/src/io/flutter/logging/PluginLogger.java

@@ -30,7 +30,7 @@ public class PluginLogger {
     fileHandler.setFormatter(new SimpleFormatter());
   }
 
-  public static Logger createLogger(@NotNull Class<?> logClass) {
+  public static @NotNull Logger createLogger(@NotNull Class<?> logClass) {
     java.util.logging.Logger.getLogger(logClass.getName()).addHandler(fileHandler);
     return Logger.getInstance(logClass.getName());
   }