Skip to content

Add button to refresh tool windows #7633

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Sep 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions flutter-idea/src/io/flutter/actions/RefreshToolWindowAction.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
/*
* Copyright 2024 The Chromium Authors. All rights reserved.
* Use of this source code is governed by a BSD-style license that can be
* found in the LICENSE file.
*/
package io.flutter.actions;

import com.intellij.icons.AllIcons;
import com.intellij.openapi.actionSystem.AnActionEvent;
import com.intellij.openapi.project.DumbAwareAction;
import com.intellij.openapi.project.Project;
import io.flutter.FlutterUtils;
import org.jetbrains.annotations.NotNull;

import java.util.Optional;

public class RefreshToolWindowAction extends DumbAwareAction {
private String toolWindowId;

public RefreshToolWindowAction() {
super(AllIcons.Actions.Refresh);
}

public RefreshToolWindowAction(@NotNull String toolWindowId) {
super(AllIcons.Actions.Refresh);
this.toolWindowId = toolWindowId;
}
@Override
public void actionPerformed(@NotNull AnActionEvent event) {
final Project project = event.getProject();
if (project == null) {
return;
}

Optional.ofNullable(
FlutterUtils.embeddedBrowser(project))
.ifPresent(embeddedBrowser -> embeddedBrowser.refresh(toolWindowId));
}
}
16 changes: 7 additions & 9 deletions flutter-idea/src/io/flutter/deeplinks/DeepLinksViewFactory.java
Original file line number Diff line number Diff line change
Expand Up @@ -5,32 +5,27 @@
*/
package io.flutter.deeplinks;

import com.intellij.ide.util.PropertiesComponent;
import com.intellij.openapi.application.ApplicationManager;
import com.intellij.openapi.project.Project;
import com.intellij.openapi.wm.ToolWindow;
import com.intellij.openapi.wm.ToolWindowFactory;
import com.intellij.openapi.wm.ToolWindowManager;
import com.intellij.ui.content.ContentManager;
import icons.FlutterIcons;
import io.flutter.FlutterUtils;
import io.flutter.actions.RefreshToolWindowAction;
import io.flutter.bazel.WorkspaceCache;
import io.flutter.devtools.DevToolsIdeFeature;
import io.flutter.devtools.DevToolsUrl;
import io.flutter.performance.FlutterPerformanceView;
import io.flutter.run.daemon.DevToolsService;
import io.flutter.sdk.FlutterSdk;
import io.flutter.sdk.FlutterSdkVersion;
import io.flutter.utils.AsyncUtils;
import io.flutter.utils.UIUtils;
import io.flutter.view.FlutterViewMessages;
import kotlin.coroutines.Continuation;
import org.jetbrains.annotations.NotNull;

import java.util.List;
import java.util.Optional;

public class DeepLinksViewFactory implements ToolWindowFactory {
private static String TOOL_WINDOW_ID = "Flutter Deep Links";
@NotNull private static String TOOL_WINDOW_ID = "Flutter Deep Links";

@Override
public Object isApplicableAsync(@NotNull Project project, @NotNull Continuation<? super Boolean> $completion) {
Expand All @@ -41,7 +36,6 @@ public Object isApplicableAsync(@NotNull Project project, @NotNull Continuation<

@Override
public void createToolWindowContent(@NotNull Project project, @NotNull ToolWindow toolWindow) {
final ContentManager contentManager = toolWindow.getContentManager();
FlutterSdk sdk = FlutterSdk.getFlutterSdk(project);
FlutterSdkVersion sdkVersion = sdk == null ? null : sdk.getVersion();

Expand Down Expand Up @@ -78,5 +72,9 @@ public void createToolWindowContent(@NotNull Project project, @NotNull ToolWindo
});
}
);

// TODO(helin24): It may be better to add this to the gear actions or to attach as a mouse event on individual tabs within a tool
// window, but I wasn't able to get either working immediately.
toolWindow.setTitleActions(List.of(new RefreshToolWindowAction(TOOL_WINDOW_ID)));
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
import com.intellij.ui.content.ContentManager;
import icons.FlutterIcons;
import io.flutter.FlutterUtils;
import io.flutter.actions.RefreshToolWindowAction;
import io.flutter.bazel.WorkspaceCache;
import io.flutter.run.daemon.DevToolsService;
import io.flutter.sdk.FlutterSdk;
Expand All @@ -24,9 +25,12 @@
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

import java.util.List;
import java.util.Optional;

public class DevToolsExtensionsViewFactory implements ToolWindowFactory {
@NotNull private static String TOOL_WINDOW_ID = "Flutter DevTools Extensions";

public static void init(Project project) {
project.getMessageBus().connect().subscribe(
FlutterViewMessages.FLUTTER_DEBUG_TOPIC, (FlutterViewMessages.FlutterDebugNotifier)event -> initView(project, event)
Expand Down Expand Up @@ -84,6 +88,8 @@ public void createToolWindowContent(@NotNull Project project, @NotNull ToolWindo
});
}
);

window.setTitleActions(List.of(new RefreshToolWindowAction(TOOL_WINDOW_ID)));
}

@Nullable
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,25 +9,24 @@
import com.intellij.openapi.project.Project;
import com.intellij.openapi.wm.ToolWindow;
import com.intellij.openapi.wm.ToolWindowFactory;
import com.intellij.openapi.wm.ToolWindowManager;
import com.intellij.ui.content.ContentManager;
import icons.FlutterIcons;
import io.flutter.FlutterUtils;
import io.flutter.actions.RefreshToolWindowAction;
import io.flutter.bazel.WorkspaceCache;
import io.flutter.run.daemon.DevToolsService;
import io.flutter.sdk.FlutterSdk;
import io.flutter.sdk.FlutterSdkVersion;
import io.flutter.utils.AsyncUtils;
import io.flutter.utils.UIUtils;
import io.flutter.view.FlutterViewMessages;
import kotlin.coroutines.Continuation;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

import java.util.List;
import java.util.Optional;

public class RemainingDevToolsViewFactory implements ToolWindowFactory {
private static String TOOL_WINDOW_ID = "Flutter DevTools";
@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)
Expand Down Expand Up @@ -86,6 +85,8 @@ public void createToolWindowContent(@NotNull Project project, @NotNull ToolWindo
});
}
);

window.setTitleActions(List.of(new RefreshToolWindowAction(TOOL_WINDOW_ID)));
}

@Nullable
Expand Down
21 changes: 20 additions & 1 deletion flutter-idea/src/io/flutter/view/EmbeddedBrowser.java
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@
import io.flutter.analytics.Analytics;
import io.flutter.devtools.DevToolsUrl;
import io.flutter.utils.AsyncUtils;
import org.jetbrains.annotations.NotNull;
import io.flutter.utils.LabelInput;
import org.jetbrains.annotations.NotNull;

import javax.swing.*;
import java.awt.*;
Expand Down Expand Up @@ -270,6 +270,25 @@ public void updateVmServiceUri(@NotNull String newVmServiceUri) {
});
}

// This will refresh all the browser tabs within a tool window (e.g. if there are multiple apps running and the inspector tool window is
// refreshed, an inspector tab will refresh for each app.)
// TODO(helin24): Consider allowing refresh for single browser tabs within tool windows.
public void refresh(String toolWindowId) {
Map<String, BrowserTab> tabs = windows.get(toolWindowId);

if (tabs == null) {
return;
}

tabs.forEach((tabName, tab) -> {
if (tab == null || tab.devToolsUrlFuture == null) return;
tab.devToolsUrlFuture.thenAccept(devToolsUrl -> {
if (devToolsUrl == null) return;
tab.embeddedTab.loadUrl(devToolsUrl.getUrlString());
});
});
}

private void updateUrlAndReload(Function<DevToolsUrl, DevToolsUrl> newDevToolsUrlFn) {
this.windows.forEach((window, tabs) -> {
tabs.forEach((tabName, tab) -> {
Expand Down
17 changes: 11 additions & 6 deletions flutter-idea/src/io/flutter/view/FlutterView.java
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@
package io.flutter.view;

import com.google.common.annotations.VisibleForTesting;
import com.intellij.execution.runners.ExecutionUtil;
import com.intellij.ide.browsers.BrowserLauncher;
import com.intellij.ide.ui.UISettingsListener;
import com.intellij.openapi.Disposable;
Expand All @@ -17,7 +16,6 @@
import com.intellij.openapi.editor.colors.EditorColorsListener;
import com.intellij.openapi.editor.colors.EditorColorsManager;
import com.intellij.openapi.progress.EmptyProgressIndicator;
import com.intellij.openapi.progress.ProgressIndicator;
import com.intellij.openapi.progress.ProgressManager;
import com.intellij.openapi.project.Project;
import com.intellij.openapi.ui.VerticalFlowLayout;
Expand All @@ -35,18 +33,21 @@
import com.intellij.util.ui.JBUI;
import com.intellij.util.ui.UIUtil;
import com.intellij.xdebugger.XSourcePosition;
import icons.FlutterIcons;
import io.flutter.FlutterBundle;
import io.flutter.FlutterInitializer;
import io.flutter.FlutterUtils;
import io.flutter.actions.RefreshToolWindowAction;
import io.flutter.bazel.WorkspaceCache;
import io.flutter.devtools.DevToolsIdeFeature;
import io.flutter.devtools.DevToolsUrl;
import io.flutter.inspector.DiagnosticsNode;
import io.flutter.inspector.InspectorGroupManagerService;
import io.flutter.inspector.InspectorService;
import io.flutter.inspector.InspectorSourceLocation;
import io.flutter.jxbrowser.*;
import io.flutter.jxbrowser.FailureType;
import io.flutter.jxbrowser.InstallationFailedReason;
import io.flutter.jxbrowser.JxBrowserManager;
import io.flutter.jxbrowser.JxBrowserStatus;
import io.flutter.run.FlutterDevice;
import io.flutter.run.daemon.DevToolsInstance;
import io.flutter.run.daemon.DevToolsService;
Expand All @@ -64,10 +65,12 @@

import javax.swing.*;
import java.awt.*;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.*;
import java.util.concurrent.atomic.AtomicReference;
import java.util.Optional;
import java.util.concurrent.TimeoutException;
import java.util.concurrent.atomic.AtomicReference;

@com.intellij.openapi.components.State(
name = "FlutterView",
Expand Down Expand Up @@ -244,6 +247,8 @@ private void addBrowserInspectorViewContent(FlutterApp app,
);
busSubscribed = true;
}

toolWindow.setTitleActions(List.of(new RefreshToolWindowAction(TOOL_WINDOW_ID)));
} else {
BrowserLauncher.getInstance().browse(
new DevToolsUrl.Builder()
Expand Down
4 changes: 4 additions & 0 deletions resources/META-INF/plugin.xml
Original file line number Diff line number Diff line change
Expand Up @@ -546,6 +546,10 @@
text="Open Flutter DevTools" description="Open Flutter DevTools" icon="FlutterIcons.Dart_16">
</action>

<action id="io.flutter.RefreshToolWindow" class="io.flutter.actions.RefreshToolWindowAction" text="Refresh Tool Window"
description="Refresh current tool window contents">
</action>

<!-- action
id="DeveloperServices.FlutterNewsAssistant"
class="io.flutter.actions.OpenFlutterNewsSidePanelAction"
Expand Down
4 changes: 4 additions & 0 deletions resources/META-INF/plugin_template.xml
Original file line number Diff line number Diff line change
Expand Up @@ -245,6 +245,10 @@
text="Open Flutter DevTools" description="Open Flutter DevTools" icon="FlutterIcons.Dart_16">
</action>

<action id="io.flutter.RefreshToolWindow" class="io.flutter.actions.RefreshToolWindowAction" text="Refresh Tool Window"
description="Refresh current tool window contents">
</action>

<!-- action
id="DeveloperServices.FlutterNewsAssistant"
class="io.flutter.actions.OpenFlutterNewsSidePanelAction"
Expand Down