[CQ] introduce null-safe OpenApi wrappers (#8139)

Currently there are a number of common platform accesses that are not
safe, prone to runtime exceptions and spam the inspection log with
nullability warnings. This change introduces a host of wrappers around
common IntelliJ Open API calls that introduce null-safety, reducing NPE
risk, quieting 86 "Nullability and data flow problems" inspections.

Specifically, this change introduces and migrates calls to new
`OpenApiUtils` utility methods:

* `safeRunWriteAction`
* `safeInvokeAndWait`
* `safeInvokeLater`
* `getModules`
* `getLibraryTable`
* `getContentRoots`
 

---

- [x] I’ve reviewed the contributor guide and applied the relevant
portions to this PR.

<details>
  <summary>Contribution guidelines:</summary><br>

- See our [contributor
guide]([https://github.com/dart-lang/sdk/blob/main/CONTRIBUTING.md](https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#overview)
for general expectations for PRs.
- Larger or significant changes should be discussed in an issue before
creating a PR.
- Dart contributions to our repos should follow the [Dart style
guide](https://dart.dev/guides/language/effective-dart) and use `dart
format`.
- Java and Kotlin contributions should strive to follow Java and Kotlin
best practices
([discussion](#8098)).
</details>

Author: pq

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

@@ -10,7 +10,9 @@
 import com.intellij.ide.browsers.BrowserLauncher;
 import com.intellij.ide.plugins.PluginManagerCore;
 import com.intellij.ide.ui.UISettingsListener;
-import com.intellij.notification.*;
+import com.intellij.notification.Notification;
+import com.intellij.notification.NotificationType;
+import com.intellij.notification.Notifications;
 import com.intellij.openapi.actionSystem.AnAction;
 import com.intellij.openapi.actionSystem.AnActionEvent;
 import com.intellij.openapi.application.ApplicationManager;
@@ -20,7 +22,6 @@
 import com.intellij.openapi.extensions.PluginId;
 import com.intellij.openapi.fileEditor.FileEditorManager;
 import com.intellij.openapi.module.Module;
-import com.intellij.openapi.module.ModuleManager;
 import com.intellij.openapi.project.ModuleListener;
 import com.intellij.openapi.project.Project;
 import com.intellij.openapi.roots.ProjectRootManager;
@@ -50,6 +51,7 @@
 import io.flutter.settings.FlutterSettings;
 import io.flutter.survey.FlutterSurveyNotifications;
 import io.flutter.utils.FlutterModuleUtils;
+import io.flutter.utils.OpenApiUtils;
 import io.flutter.view.FlutterViewFactory;
 import org.jetbrains.annotations.NotNull;
 
@@ -90,7 +92,7 @@ public void runActivity(@NotNull Project project) {
     // If the project declares a Flutter dependency, do some extra initialization.
     boolean hasFlutterModule = false;
 
-    for (Module module : ModuleManager.getInstance(project).getModules()) {
+    for (Module module : OpenApiUtils.getModules(project)) {
       final boolean declaresFlutter = FlutterModuleUtils.declaresFlutter(module);
 
       hasFlutterModule = hasFlutterModule || declaresFlutter;
@@ -289,7 +291,7 @@ private void checkSdkVersionNotification(@NotNull Project project) {
       final FlutterSettings settings = FlutterSettings.getInstance();
       if (settings == null || settings.isSdkVersionOutdatedWarningAcknowledged(version.getVersionText())) return;
 
-      ApplicationManager.getApplication().invokeLater(() -> {
+      OpenApiUtils.safeInvokeLater(() -> {
         final Notification notification = new Notification(FlutterMessages.FLUTTER_NOTIFICATION_GROUP_ID,
                                                            "Flutter SDK requires update",
                                                            "Support for v" +
@@ -383,6 +385,6 @@ private void ensureAndroidSdk(@NotNull Project project) {
       return; // ANDROID_HOME not set or Android SDK not created in IDEA; not clear what to do.
     }
 
-    ApplicationManager.getApplication().runWriteAction(() -> wanted.setCurrent(project));
+    OpenApiUtils.safeRunWriteAction(() -> wanted.setCurrent(project));
   }
 }

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

@@ -12,7 +12,6 @@
 import com.intellij.openapi.diagnostic.Logger;
 import com.intellij.openapi.extensions.PluginId;
 import com.intellij.openapi.module.Module;
-import com.intellij.openapi.module.ModuleManager;
 import com.intellij.openapi.project.Project;
 import com.intellij.openapi.project.ProjectManager;
 import com.intellij.openapi.roots.*;
@@ -34,6 +33,7 @@
 import io.flutter.settings.FlutterSettings;
 import io.flutter.utils.AndroidUtils;
 import io.flutter.utils.FlutterModuleUtils;
+import io.flutter.utils.OpenApiUtils;
 import io.flutter.view.EmbeddedBrowser;
 import io.flutter.view.EmbeddedJcefBrowser;
 import org.jetbrains.annotations.NotNull;
@@ -479,8 +479,7 @@ private static VirtualFile getFlutterManagedAndroidDir(VirtualFile dir) {
 
   @Nullable
   public static Module findModuleNamed(@NotNull Project project, @NotNull String name) {
-    final Module[] modules = ModuleManager.getInstance(project).getModules();
-    assert modules != null;
+    final Module[] modules = OpenApiUtils.getModules(project);
     for (Module module : modules) {
       assert module != null;
       if (module.getName().equals(name)) {

flutter-idea/src/io/flutter/actions/AttachDebuggerAction.java

@@ -10,8 +10,9 @@
 import com.intellij.execution.process.ProcessHandler;
 import com.intellij.execution.runners.ExecutionEnvironment;
 import com.intellij.execution.runners.ExecutionEnvironmentBuilder;
-import com.intellij.openapi.actionSystem.*;
-import com.intellij.openapi.application.ApplicationManager;
+import com.intellij.openapi.actionSystem.ActionUpdateThread;
+import com.intellij.openapi.actionSystem.AnActionEvent;
+import com.intellij.openapi.actionSystem.DataContext;
 import com.intellij.openapi.application.ModalityState;
 import com.intellij.openapi.project.Project;
 import com.intellij.openapi.ui.DialogWrapper;
@@ -30,6 +31,7 @@
 import io.flutter.run.bazel.BazelRunConfig;
 import io.flutter.sdk.FlutterSdk;
 import io.flutter.sdk.FlutterSdkUtil;
+import io.flutter.utils.OpenApiUtils;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
@@ -200,7 +202,7 @@ public void processTerminated(@NotNull String executorId,
   }
 
   private static void showSelectConfigDialog() {
-    ApplicationManager.getApplication().invokeLater(() -> new SelectConfigDialog().show(), ModalityState.nonModal());
+    OpenApiUtils.safeInvokeLater(() -> new SelectConfigDialog().show(), ModalityState.nonModal());
   }
 
   private static class SelectConfigDialog extends DialogWrapper {

flutter-idea/src/io/flutter/actions/DeviceSelectorRefresherAction.java

@@ -31,8 +31,9 @@ public void actionPerformed(@NotNull AnActionEvent e) {
 
   @Override
   public void update(@NotNull AnActionEvent e) {
-    if (e.getProject() != null) {
-      e.getPresentation().setVisible(FlutterModuleUtils.hasInternalDartSdkPath(e.getProject()));
+    var project = e.getProject();
+    if (project != null) {
+      e.getPresentation().setVisible(FlutterModuleUtils.hasInternalDartSdkPath(project));
     }
   }
 }

flutter-idea/src/io/flutter/actions/FlutterBuildActionGroup.java

@@ -12,14 +12,14 @@
 import com.intellij.openapi.module.Module;
 import com.intellij.openapi.module.ModuleUtilCore;
 import com.intellij.openapi.project.Project;
-import com.intellij.openapi.roots.ModuleRootManager;
 import com.intellij.openapi.util.SystemInfo;
 import com.intellij.openapi.vfs.VirtualFile;
 import io.flutter.FlutterMessages;
 import io.flutter.pub.PubRoot;
 import io.flutter.pub.PubRoots;
 import io.flutter.sdk.FlutterSdk;
 import io.flutter.utils.FlutterModuleUtils;
+import io.flutter.utils.OpenApiUtils;
 import io.flutter.utils.ProgressHelper;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
@@ -105,7 +105,7 @@ public static Module findFlutterModule(@NotNull Project project, @NotNull Virtua
       return module;
     }
     // We may get here if the file is in the Android module of a Flutter module project.
-    final VirtualFile parent = ModuleRootManager.getInstance(module).getContentRoots()[0].getParent();
+    final VirtualFile parent = OpenApiUtils.getContentRoots(module)[0].getParent();
     module = ModuleUtilCore.findModuleForFile(parent, project);
     if (module == null) {
       return null;

flutter-idea/src/io/flutter/analytics/UnifiedAnalytics.java

@@ -12,13 +12,13 @@
 import com.intellij.notification.Notifications;
 import com.intellij.openapi.actionSystem.AnAction;
 import com.intellij.openapi.actionSystem.AnActionEvent;
-import com.intellij.openapi.application.ApplicationManager;
 import com.intellij.openapi.diagnostic.Logger;
 import com.intellij.openapi.project.Project;
 import com.jetbrains.lang.dart.ide.toolingDaemon.DartToolingDaemonService;
 import de.roderick.weberknecht.WebSocketException;
 import io.flutter.dart.DtdUtils;
 import io.flutter.sdk.FlutterSdkUtil;
+import io.flutter.utils.OpenApiUtils;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
@@ -118,7 +118,9 @@ private CompletableFuture<JsonObject> makeUnifiedAnalyticsRequest(String request
     });
   }
 
-  private @Nullable CompletableFuture<Boolean> setTelemetry(@NotNull DartToolingDaemonService service, @NotNull JsonObject params, Boolean canSendAnalytics) {
+  private @Nullable CompletableFuture<Boolean> setTelemetry(@NotNull DartToolingDaemonService service,
+                                                            @NotNull JsonObject params,
+                                                            Boolean canSendAnalytics) {
     params.addProperty("enable", canSendAnalytics);
     return makeUnifiedAnalyticsRequest("setTelemetry", service, params).thenCompose(result -> {
       assert result != null;
@@ -135,7 +137,7 @@ private CompletableFuture<JsonObject> makeUnifiedAnalyticsRequest(String request
 
   private CompletableFuture<Boolean> showMessage(@NotNull String message) {
     CompletableFuture<Boolean> finalResult = new CompletableFuture<>();
-    ApplicationManager.getApplication().invokeLater(() -> {
+    OpenApiUtils.safeInvokeLater(() -> {
       final Notification notification = new Notification(
         "Flutter Usage Statistics", // Analytics.GROUP_DISPLAY_ID,
         "Welcome to Flutter!",

flutter-idea/src/io/flutter/android/AndroidEmulator.java

@@ -21,6 +21,7 @@
 import com.intellij.util.ReflectionUtil;
 import io.flutter.FlutterMessages;
 import io.flutter.utils.MostlySilentColoredProcessHandler;
+import io.flutter.utils.OpenApiUtils;
 import org.jetbrains.annotations.NotNull;
 
 import java.lang.reflect.InvocationTargetException;
@@ -119,7 +120,7 @@ private void openEmulatorToolWindow(boolean shouldLaunchEmulatorInToolWindow) {
     }
 
     assert ApplicationManager.getApplication() != null;
-    ApplicationManager.getApplication().invokeLater(() -> {
+    OpenApiUtils.safeInvokeLater(() -> {
       tw.setAutoHide(false);
       tw.show();
     }, ModalityState.stateForComponent(tw.getComponent()));

flutter-idea/src/io/flutter/bazel/Workspace.java

@@ -12,7 +12,6 @@
 import com.intellij.openapi.diagnostic.Logger;
 import com.intellij.openapi.module.Module;
 import com.intellij.openapi.project.Project;
-import com.intellij.openapi.roots.ModuleRootManager;
 import com.intellij.openapi.roots.ProjectRootManager;
 import com.intellij.openapi.util.Computable;
 import com.intellij.openapi.vfs.InvalidVirtualFileAccessException;
@@ -90,7 +89,7 @@ private Workspace(@NotNull VirtualFile root,
   @NotNull
   public ImmutableSet<String> getContentPaths(@NotNull final Module module) {
     // Find all the content roots within this workspace.
-    final VirtualFile[] contentRoots = ModuleRootManager.getInstance(module).getContentRoots();
+    final VirtualFile[] contentRoots = OpenApiUtils.getContentRoots(module);
     final ImmutableSet.Builder<String> result = ImmutableSet.builder();
     for (VirtualFile root : contentRoots) {
       final String path = getRelativePath(root);

flutter-idea/src/io/flutter/console/FlutterConsoleFilter.java

@@ -18,14 +18,14 @@
 import com.intellij.openapi.editor.markup.TextAttributes;
 import com.intellij.openapi.module.Module;
 import com.intellij.openapi.project.Project;
-import com.intellij.openapi.roots.ModuleRootManager;
 import com.intellij.openapi.ui.Messages;
 import com.intellij.openapi.vfs.LocalFileSystem;
 import com.intellij.openapi.vfs.VirtualFile;
 import com.intellij.util.ui.UIUtil;
 import io.flutter.FlutterMessages;
 import io.flutter.FlutterUtils;
 import io.flutter.sdk.FlutterSdk;
+import io.flutter.utils.OpenApiUtils;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
@@ -91,7 +91,7 @@ public VirtualFile fileAtPath(@NotNull String pathPart) {
       return null;
     }
 
-    final VirtualFile[] roots = ModuleRootManager.getInstance(module).getContentRoots();
+    final VirtualFile[] roots = OpenApiUtils.getContentRoots(module);
     for (VirtualFile root : roots) {
       if (!pathPart.isEmpty()) {
         final String baseDirPath = root.getPath();
@@ -237,7 +237,7 @@ else if (split.length == 4 && Objects.equals(split[0], "file")) {
   }
 
   private String findRelativePath(String threeSlashFileName) {
-    final VirtualFile[] roots = ModuleRootManager.getInstance(module).getContentRoots();
+    final VirtualFile[] roots = OpenApiUtils.getContentRoots(module);
     for (VirtualFile root : roots) {
       final String path = root.getPath();
       int index = threeSlashFileName.indexOf(path);

flutter-idea/src/io/flutter/console/FlutterConsoles.java

@@ -7,12 +7,12 @@
 
 import com.intellij.execution.process.ColoredProcessHandler;
 import com.intellij.execution.ui.ConsoleViewContentType;
-import com.intellij.openapi.application.ApplicationManager;
 import com.intellij.openapi.module.Module;
 import com.intellij.openapi.project.Project;
 import com.intellij.openapi.util.Key;
 import com.intellij.ui.content.Content;
 import com.intellij.ui.content.MessageView;
+import io.flutter.utils.OpenApiUtils;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
@@ -37,7 +37,7 @@ public static void displayProcessLater(@NotNull ColoredProcessHandler process,
                                          @NotNull Runnable onReady) {
 
     // Getting a MessageView has to happen on the UI thread.
-    ApplicationManager.getApplication().invokeLater(() -> {
+    OpenApiUtils.safeInvokeLater(() -> {
       final MessageView messageView = MessageView.getInstance(project);
       messageView.runWhenInitialized(() -> {
         final FlutterConsole console = findOrCreate(project, module);
@@ -54,7 +54,7 @@ public static void displayMessage(@NotNull Project project, @Nullable Module mod
 
   public static void displayMessage(@NotNull Project project, @Nullable Module module, @NotNull String message, boolean clearContent) {
     // Getting a MessageView has to happen on the UI thread.
-    ApplicationManager.getApplication().invokeLater(() -> {
+    OpenApiUtils.safeInvokeLater(() -> {
       final MessageView messageView = MessageView.getInstance(project);
       messageView.runWhenInitialized(() -> {
         final FlutterConsole console = findOrCreate(project, module);

flutter-idea/src/io/flutter/deeplinks/DeepLinksViewFactory.java

@@ -5,7 +5,6 @@
  */
 package io.flutter.deeplinks;
 
-import com.intellij.openapi.application.ApplicationManager;
 import com.intellij.openapi.project.Project;
 import com.intellij.openapi.wm.ToolWindow;
 import com.intellij.openapi.wm.ToolWindowFactory;
@@ -18,6 +17,7 @@
 import io.flutter.sdk.FlutterSdk;
 import io.flutter.sdk.FlutterSdkVersion;
 import io.flutter.utils.AsyncUtils;
+import io.flutter.utils.OpenApiUtils;
 import kotlin.coroutines.Continuation;
 import org.jetbrains.annotations.NotNull;
 
@@ -65,7 +65,7 @@ public void createToolWindowContent(@NotNull Project project, @NotNull ToolWindo
           .setIdeFeature(DevToolsIdeFeature.TOOL_WINDOW)
           .build();
 
-        ApplicationManager.getApplication().invokeLater(() -> {
+        OpenApiUtils.safeInvokeLater(() -> {
           Optional.ofNullable(
               FlutterUtils.embeddedBrowser(project))
             .ifPresent(embeddedBrowser -> embeddedBrowser.openPanel(toolWindow, "Deep Links", devToolsUrl, System.out::println));

flutter-idea/src/io/flutter/devtools/DevToolsExtensionsViewFactory.java

@@ -5,7 +5,6 @@
  */
 package io.flutter.devtools;
 
-import com.intellij.openapi.application.ApplicationManager;
 import com.intellij.openapi.project.Project;
 import com.intellij.openapi.wm.ToolWindow;
 import com.intellij.openapi.wm.ToolWindowFactory;
@@ -17,6 +16,7 @@
 import io.flutter.sdk.FlutterSdk;
 import io.flutter.sdk.FlutterSdkVersion;
 import io.flutter.utils.AsyncUtils;
+import io.flutter.utils.OpenApiUtils;
 import io.flutter.view.FlutterViewMessages;
 import kotlin.coroutines.Continuation;
 import org.jetbrains.annotations.NotNull;
@@ -73,7 +73,7 @@ public void createToolWindowContent(@NotNull Project project, @NotNull ToolWindo
           .setIdeFeature(DevToolsIdeFeature.TOOL_WINDOW)
           .build();
 
-        ApplicationManager.getApplication().invokeLater(() -> {
+        OpenApiUtils.safeInvokeLater(() -> {
           Optional.ofNullable(
               FlutterUtils.embeddedBrowser(project))
             .ifPresent(embeddedBrowser -> {

flutter-idea/src/io/flutter/devtools/RemainingDevToolsViewFactory.java

@@ -5,7 +5,6 @@
  */
 package io.flutter.devtools;
 
-import com.intellij.openapi.application.ApplicationManager;
 import com.intellij.openapi.project.Project;
 import com.intellij.openapi.wm.ToolWindow;
 import com.intellij.openapi.wm.ToolWindowFactory;
@@ -17,6 +16,7 @@
 import io.flutter.sdk.FlutterSdk;
 import io.flutter.sdk.FlutterSdkVersion;
 import io.flutter.utils.AsyncUtils;
+import io.flutter.utils.OpenApiUtils;
 import io.flutter.view.FlutterViewMessages;
 import kotlin.coroutines.Continuation;
 import org.jetbrains.annotations.NotNull;
@@ -27,6 +27,7 @@
 
 public class RemainingDevToolsViewFactory implements ToolWindowFactory {
   @NotNull private static String TOOL_WINDOW_ID = "Flutter DevTools";
+
   public static void init(Project project) {
     project.getMessageBus().connect().subscribe(
       FlutterViewMessages.FLUTTER_DEBUG_TOPIC, (FlutterViewMessages.FlutterDebugNotifier)event -> initView(project, event)
@@ -73,7 +74,7 @@ public void createToolWindowContent(@NotNull Project project, @NotNull ToolWindo
           .setIdeFeature(DevToolsIdeFeature.TOOL_WINDOW)
           .build();
 
-        ApplicationManager.getApplication().invokeLater(() -> {
+        OpenApiUtils.safeInvokeLater(() -> {
           Optional.ofNullable(
               FlutterUtils.embeddedBrowser(project))
             .ifPresent(embeddedBrowser -> {