wip: new summary panal

acke · acke · commit d8990d1a746a · 2025-01-30T11:26:11.000+01:00
New layout with two browsers
$/snyk.scanSummary callback
Placeholders for all issues scan tab/delta scan
diff --git a/plugin/src/main/java/io/snyk/eclipse/plugin/html/StaticPageHtmlProvider.java b/plugin/src/main/java/io/snyk/eclipse/plugin/html/StaticPageHtmlProvider.java
@@ -18,7 +18,7 @@ public static StaticPageHtmlProvider getInstance() {
 		}
 		return instance;
 	}
-	
+
 	private String head = """
 				<head>
 				    <meta charset="UTF-8">
@@ -148,6 +148,31 @@ public String getInitHtml() {
 				""".formatted(head, base64Image, snykWarningText);
 		return replaceCssVariables(html);
 	}
-	
-	
+
+	public String getSummaryInitHtml() {
+		var html = """
+				<!DOCTYPE html>
+				<html lang="en">
+				<body>
+				    <div class="container">
+				        <h3 class="summary-header">SUMMARY</h3>
+		                    <button type="button" onclick="window.showAllIssuesTab()">All issues</button>
+		                    <button type="button" onclick="window.showDeltaIssuesTab()">Delta issues</button>
+				        <div class="summary-row">
+				            <span class="icon">⚠️</span>
+				            <span class="text">312 issues found in your project</span>
+				        </div>
+				        <div class="summary-row">
+				            <span class="icon">⚡</span>
+				            <span class="text">183 issues are fixable</span>
+				        </div>
+
+				    </div>
+				</body>
+				</html>
+				"""
+				.formatted(head);
+		return replaceCssVariables(html);
+	}
+
 }
diff --git a/plugin/src/main/java/io/snyk/eclipse/plugin/views/snyktoolview/BrowserHandler.java b/plugin/src/main/java/io/snyk/eclipse/plugin/views/snyktoolview/BrowserHandler.java
@@ -5,11 +5,7 @@
 import java.nio.file.Paths;
 import java.util.concurrent.CompletableFuture;
 
-import org.eclipse.core.commands.ExecutionException;
-import org.eclipse.core.commands.NotEnabledException;
-import org.eclipse.core.commands.NotHandledException;
 import org.eclipse.core.commands.common.CommandException;
-import org.eclipse.core.commands.common.NotDefinedException;
 import org.eclipse.jface.viewers.TreeNode;
 import org.eclipse.lsp4e.LSPEclipseUtils;
 import org.eclipse.lsp4j.Location;
diff --git a/plugin/src/main/java/io/snyk/eclipse/plugin/views/snyktoolview/ISnykToolView.java b/plugin/src/main/java/io/snyk/eclipse/plugin/views/snyktoolview/ISnykToolView.java
@@ -80,6 +80,11 @@ public interface ISnykToolView {
 	 */
 	abstract void refreshBrowser(String status);
 
+	/**
+	 * Refreshes the SummaryPanel
+	 */
+	abstract void refreshSummary(String status);
+
 	/**
 	 * Returns the tree root
 	 * 
diff --git a/plugin/src/main/java/io/snyk/eclipse/plugin/views/snyktoolview/SnykToolView.java b/plugin/src/main/java/io/snyk/eclipse/plugin/views/snyktoolview/SnykToolView.java
@@ -67,16 +67,27 @@ public class SnykToolView extends ViewPart implements ISnykToolView {
 	private TreeViewer treeViewer;
 	private Browser browser;
 	private BrowserHandler browserHandler;
+	private Browser summaryBrowser;
+	private SummaryBrowserHandler summaryBrowserHandler;
 	private FolderConfigs folderConfigs = FolderConfigs.getInstance();
 	private TreeNode selectedNode;
 
 	@Override
 	public void createPartControl(Composite parent) {
-		SashForm sashForm = new SashForm(parent, SWT.HORIZONTAL);
-		sashForm.setLayout(new FillLayout());
+		SashForm horizontalSashForm = new SashForm(parent, SWT.HORIZONTAL);
+		horizontalSashForm.setLayout(new FillLayout());
+
+		// Create vertical SashForm for new Browser and TreeViewer
+		SashForm verticalSashForm = new SashForm(horizontalSashForm, SWT.VERTICAL);
+		verticalSashForm.setLayout(new FillLayout());
+
+		// Create new Browser (top quarter)
+		summaryBrowser = new Browser(verticalSashForm, SWT.EDGE);
+		summaryBrowserHandler = new SummaryBrowserHandler(summaryBrowser);
+		summaryBrowserHandler.initialize();
 
 		// Create TreeViewer
-		treeViewer = new TreeViewer(sashForm, SWT.BORDER);
+		treeViewer = new TreeViewer(verticalSashForm, SWT.BORDER);
 		Tree tree = treeViewer.getTree();
 		tree.setHeaderVisible(false);
 		tree.setLinesVisible(false);
@@ -93,13 +104,15 @@ public void createPartControl(Composite parent) {
 
 		registerTreeContextMenu(treeViewer.getControl());
 
+		verticalSashForm.setWeights(new int[] { 1, 3 });
+
 		// Create Browser
 		// SWT.EDGE will be ignored if OS not windows and will be set to SWT.NONE.
-		browser = new Browser(sashForm, SWT.EDGE);
+		browser = new Browser(horizontalSashForm, SWT.EDGE);
 		browserHandler = new BrowserHandler(browser);
 		browserHandler.initialize();
 		// Set sash weights
-		sashForm.setWeights(new int[] { 1, 2 });
+		horizontalSashForm.setWeights(new int[] { 1, 1 });
 
 		// Add selection listener to the tree
 		treeViewer.addSelectionChangedListener(new ISelectionChangedListener() {
@@ -133,7 +146,7 @@ public void selectionChanged(SelectionChangedEvent event) {
 
 		if (Preferences.isDeltaEnabled())
 			this.enableDelta();
-		
+
 		// initialize the filters
 		TreeFilterManager.getInstance();
 	}
@@ -164,7 +177,7 @@ public void run() {
 						protected IStatus run(IProgressMonitor monitor) {
 							try {
 								var result = CommandHandler.getInstance().ignoreIssue(issue).get(10, TimeUnit.SECONDS);
-								outputCommandResult(result); 
+								outputCommandResult(result);
 								itn.setText("[ IGNORED ] " + itn.getText());
 								Display.getDefault().asyncExec(() -> {
 									treeViewer.refresh(itn, true);
@@ -318,6 +331,11 @@ public void refreshBrowser(String status) {
 		});
 	};
 
+	@Override
+	public void refreshSummary(String summary) {
+		this.summaryBrowserHandler.setBrowserText(summary);
+	}
+
 	@Override
 	public void resetNode(BaseTreeNode node) {
 		if (node != null)
@@ -446,8 +464,9 @@ protected void outputCommandResult(Object result) {
 				SnykExtendedLanguageClient.getInstance().showMessage(messageParams);
 			} else {
 				SnykLogger.logError(new RuntimeException(stdOut));
+
 			}
 		}
 	}
 
-}
+}
diff --git a/plugin/src/main/java/io/snyk/eclipse/plugin/views/snyktoolview/SummaryBrowserHandler.java b/plugin/src/main/java/io/snyk/eclipse/plugin/views/snyktoolview/SummaryBrowserHandler.java
@@ -0,0 +1,46 @@
+package io.snyk.eclipse.plugin.views.snyktoolview;
+
+import org.eclipse.swt.browser.Browser;
+import org.eclipse.swt.browser.BrowserFunction;
+
+import io.snyk.eclipse.plugin.html.StaticPageHtmlProvider;
+
+public class SummaryBrowserHandler {
+	private Browser browser;
+
+	public SummaryBrowserHandler(Browser browser) {
+		this.browser = browser;
+	}
+
+	public void initialize() {
+
+		new BrowserFunction(browser, "showAllIssuesTab") {
+			@Override
+			public Object function(Object[] arguments) {
+				// TODO show all scan results
+				browser.execute("document.body.innerHTML += '<p>All issues tab clicked</p>';");
+				return null;
+			}
+		};
+
+		new BrowserFunction(browser, "showDeltaIssuesTab") {
+			@Override
+			public Object function(Object[] arguments) {
+				// TODO launch delta scan or show delta scan results
+				browser.execute("document.body.innerHTML += '<p>Delta issues tab clicked</p>';");
+				return null;
+			}
+		};
+
+		setDefaultBrowserText();
+	}
+
+	public void setDefaultBrowserText() {
+		browser.setText(StaticPageHtmlProvider.getInstance().getSummaryInitHtml());
+	}
+
+	public void setBrowserText(String summary) {
+		browser.setText(summary);
+	}
+
+}
diff --git a/plugin/src/main/java/io/snyk/languageserver/LsConstants.java b/plugin/src/main/java/io/snyk/languageserver/LsConstants.java
@@ -12,11 +12,12 @@ public interface LsConstants {
 	String COMMAND_GET_FEATURE_FLAG_STATUS = "snyk.getFeatureFlagStatus";
 	String COMMAND_CODE_FIX_DIFFS = "snyk.code.fixDiffs";
 	String COMMAND_CODE_SUBMIT_FIX_FEEDBACK = "snyk.code.submitFixFeedback";
+	String COMMAND_SNYK_CLI = "snyk.executeCLI";
 	String SNYK_HAS_AUTHENTICATED = "$/snyk.hasAuthenticated";
 	String SNYK_IS_AVAILABLE_CLI = "$/snyk.isAvailableCli";
 	String SNYK_ADD_TRUSTED_FOLDERS = "$/snyk.addTrustedFolders";
 	String SNYK_SCAN = "$/snyk.scan";
 	String SNYK_PUBLISH_DIAGNOSTICS_316 = "$/snyk.publishDiagnostics316";
 	String SNYK_FOLDER_CONFIG = "$/snyk.folderConfigs";
-	String COMMAND_SNYK_CLI = "snyk.executeCLI";
+	String SNYK_SCAN_SUMMARY = "$/snyk.scanSummary";
 }
diff --git a/plugin/src/main/java/io/snyk/languageserver/protocolextension/SnykExtendedLanguageClient.java b/plugin/src/main/java/io/snyk/languageserver/protocolextension/SnykExtendedLanguageClient.java
@@ -132,7 +132,7 @@ public LanguageServer getConnectedLanguageServer() {
 		}
 		return super.getLanguageServer();
 	}
-	
+
 	public void updateConfiguration() {
 		this.configurationUpdater.configurationChanged();
 		if (this.toolView != null) {
@@ -381,6 +381,12 @@ public void snykScan(SnykScanParam param) {
 		this.toolView.refreshBrowser(param.getStatus());
 	}
 
+	// TODO what data is returned in the SNYK_SCAN_SUMMARY?
+	@JsonNotification(value = LsConstants.SNYK_SCAN_SUMMARY)
+	public void updateSummaryPanel(String summary) {
+		this.toolView.refreshSummary(summary);
+	}
+
 	@JsonNotification(value = LsConstants.SNYK_FOLDER_CONFIG)
 	public void folderConfig(FolderConfigsParam folderConfigParam) {
 		List<FolderConfig> folderConfigs = folderConfigParam != null ? folderConfigParam.getFolderConfigs() : List.of();
