Merge pull request #81 from eharris369/41-NoAppMonitorActionIfNotSupported

eharris369 · web-flow · commit dd13928b0583 · 2019-04-05T11:42:39.000-04:00
Issue #41: Hide app monitor action when not supported
diff --git a/dev/com.ibm.microclimate.core/src/com/ibm/microclimate/core/internal/MicroclimateApplication.java b/dev/com.ibm.microclimate.core/src/com/ibm/microclimate/core/internal/MicroclimateApplication.java
@@ -49,6 +49,7 @@ public class MicroclimateApplication {
 	private ProjectCapabilities projectCapabilities;
 	private String action;
 	private List<ProjectLogInfo> logInfos;
+	private boolean metricsAvailable = false;
 
 	// Must be updated whenever httpPort changes. Can be null
 	private URL baseUrl;
@@ -137,6 +138,10 @@ public synchronized void setLogInfos(List<ProjectLogInfo> logInfos) {
 		this.logInfos = logInfos;
 	}
 	
+	public synchronized void setMetricsAvailable(boolean value) {
+		metricsAvailable = value;
+	}
+	
 	/**
 	 * Can return null if this project hasn't started yet (ie httpPort == -1)
 	 */
@@ -208,6 +213,10 @@ public List<ProjectLogInfo> getLogInfos() {
 	public boolean hasBuildLog() {
 		return (!projectType.isType(ProjectType.TYPE_NODEJS));
 	}
+	
+	public synchronized boolean getMetricsAvailable() {
+		return metricsAvailable;
+	}
 
 	public synchronized void setHttpPort(int httpPort) {
 		MCLogger.log("Set HTTP port for " + baseUrl + " to " + httpPort); //$NON-NLS-1$ //$NON-NLS-2$
diff --git a/dev/com.ibm.microclimate.core/src/com/ibm/microclimate/core/internal/MicroclimateApplicationFactory.java b/dev/com.ibm.microclimate.core/src/com/ibm/microclimate/core/internal/MicroclimateApplicationFactory.java
@@ -226,5 +226,17 @@ public static void updateApp(MicroclimateApplication mcApp, JSONObject appJso) {
 			MCLogger.logError("An error occurred while updating the log information for project: " + mcApp.name, e);
 		}
 		
+		// Check for metrics support
+		boolean metricsAvailable = true;
+		try {
+			JSONObject obj = mcApp.mcConnection.requestProjectMetricsStatus(mcApp);
+			if (obj != null && obj.has(MCConstants.KEY_METRICS_AVAILABLE)) {
+				metricsAvailable = obj.getBoolean(MCConstants.KEY_METRICS_AVAILABLE);
+			}
+		} catch (Exception e) {
+			MCLogger.logError("An error occurred checking if metrics are available: " + mcApp.name, e);
+		}
+		mcApp.setMetricsAvailable(metricsAvailable);
+		
 	}
 }
diff --git a/dev/com.ibm.microclimate.core/src/com/ibm/microclimate/core/internal/connection/MicroclimateConnection.java b/dev/com.ibm.microclimate.core/src/com/ibm/microclimate/core/internal/connection/MicroclimateConnection.java
@@ -417,6 +417,20 @@ else if (result.response == null) {
 		MCLogger.log("Didn't find status info for project " + app.name); //$NON-NLS-1$
 		return null;
 	}
+	
+	public JSONObject requestProjectMetricsStatus(MicroclimateApplication app) throws IOException, JSONException {
+		if (!app.mcConnection.checkVersion(1905, "2019_M5_E")) {
+			return null;
+		}
+		String endpoint = MCConstants.APIPATH_PROJECT_LIST + "/" 	//$NON-NLS-1$
+				+ app.projectID + "/" 								//$NON-NLS-1$
+				+ MCConstants.APIPATH_METRICS_STATUS;
+
+		URI uri = baseUrl.resolve(endpoint);
+		HttpResult result = HttpUtil.get(uri);
+		checkResult(result, uri, true);
+		return new JSONObject(result.response);
+	}
 
 	/**
 	 * Request a build on an application
@@ -439,6 +453,11 @@ public void requestProjectBuild(MicroclimateApplication app, String action)
 	}
 	
 	public List<ProjectLogInfo> requestProjectLogs(MicroclimateApplication app) throws JSONException, IOException {
+		List<ProjectLogInfo> logList = new ArrayList<ProjectLogInfo>();
+		if (!app.mcConnection.checkVersion(1905, "2019_M5_E")) {
+			return logList;
+		}
+		
 		String endpoint = MCConstants.APIPATH_PROJECT_LIST + "/"	//$NON-NLS-1$
 				+ app.projectID + "/"								//$NON-NLS-1$
 				+ MCConstants.APIPATH_LOGS;
@@ -447,7 +466,6 @@ public List<ProjectLogInfo> requestProjectLogs(MicroclimateApplication app) thro
 		HttpResult result = HttpUtil.get(uri);
 		checkResult(result, uri, true);
         
-		List<ProjectLogInfo> logList = new ArrayList<ProjectLogInfo>();
 		JSONObject logs = new JSONObject(result.response);
 		JSONArray buildLogs = logs.getJSONArray(MCConstants.KEY_LOG_BUILD);
 		logList.addAll(getLogs(buildLogs, MCConstants.KEY_LOG_BUILD));
diff --git a/dev/com.ibm.microclimate.core/src/com/ibm/microclimate/core/internal/constants/MCConstants.java b/dev/com.ibm.microclimate.core/src/com/ibm/microclimate/core/internal/constants/MCConstants.java
@@ -36,6 +36,7 @@ private MCConstants() {}
 			APIPATH_OPEN = "open",
 			APIPATH_CAPABILITIES = "capabilities",
 			APIPATH_LOGS = "logs",
+			APIPATH_METRICS_STATUS = "metrics/status",
 
 			// JSON keys
 			KEY_PROJECT_ID = "projectID",
@@ -106,6 +107,7 @@ private MCConstants() {}
 			KEY_CAPABILIITES = "capabilities",
 			KEY_START_MODES = "startModes",
 			KEY_CONTROL_COMMANDS = "controlCommands",
+			KEY_METRICS_AVAILABLE = "metricsAvailable",
 			
 			KEY_AUTO_GENERATE = "autoGenerate",
 
diff --git a/dev/com.ibm.microclimate.ui/plugin.properties b/dev/com.ibm.microclimate.ui/plugin.properties
@@ -29,7 +29,6 @@ ACTION_IMPORT_PROJECT=&Import Project
 ACTION_RESTART_RUN_MODE=Restart in &Run Mode
 ACTION_RESTART_DEBUG_MODE=Restart in &Debug Mode
 ACTION_ENABLE_DISABLE_AUTO_BUILD=Disable &Auto Build
-ACTION_OPEN_APP_MONITOR=Open Application &Monitor
 ACTION_OPEN_APP_OVERVIEW=Open Project O&verview
 
 PREFS_PARENT_PAGE_NAME=Microclimate
diff --git a/dev/com.ibm.microclimate.ui/plugin.xml b/dev/com.ibm.microclimate.ui/plugin.xml
@@ -118,13 +118,6 @@
 		<objectContribution
 			id="com.ibm.microclimate.ui.appObjectActions"
 			objectClass="com.ibm.microclimate.core.internal.MicroclimateApplication">
-			<action
-				id="com.ibm.microclimate.ui.openAppMonitor"
-				enablesFor="1"
-				menubarPath="group.open"
-				icon="%OPEN_BROWSER_ICON_PATH"
-				label="%ACTION_OPEN_APP_MONITOR"
-				class="com.ibm.microclimate.ui.internal.actions.OpenAppMonitorAction"/>
 			<action
 				id="com.ibm.microclimate.ui.containerShell"
 				enablesFor="1"
diff --git a/dev/com.ibm.microclimate.ui/src/com/ibm/microclimate/ui/internal/actions/MicroclimateApplicationActionProvider.java b/dev/com.ibm.microclimate.ui/src/com/ibm/microclimate/ui/internal/actions/MicroclimateApplicationActionProvider.java
@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2018 IBM Corporation and others.
+ * Copyright (c) 2018, 2019 IBM Corporation and others.
  * All rights reserved. This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License v2.0
  * which accompanies this distribution, and is available at
@@ -24,13 +24,15 @@ public class MicroclimateApplicationActionProvider extends CommonActionProvider
 	
 	private ValidateAction validateAction;
 	private AttachDebuggerAction attachDebuggerAction;
+	private OpenAppMonitorAction openAppMonitorAction;
 	
     @Override
     public void init(ICommonActionExtensionSite aSite) {
         super.init(aSite);
         ISelectionProvider selProvider = aSite.getStructuredViewer();
         validateAction = new ValidateAction(selProvider);
         attachDebuggerAction = new AttachDebuggerAction(selProvider);
+        openAppMonitorAction = new OpenAppMonitorAction(selProvider);
     }
     
     @Override
@@ -41,6 +43,9 @@ public void fillContextMenu(IMenuManager menu) {
     	if (attachDebuggerAction.showAction()) {
     		menu.appendToGroup(ICommonMenuConstants.GROUP_GENERATE, attachDebuggerAction);
     	}
+    	if (openAppMonitorAction.showAction()) {
+    		menu.appendToGroup(ICommonMenuConstants.GROUP_OPEN, openAppMonitorAction);
+    	}
     }
 
 }
diff --git a/dev/com.ibm.microclimate.ui/src/com/ibm/microclimate/ui/internal/actions/OpenAppMonitorAction.java b/dev/com.ibm.microclimate.ui/src/com/ibm/microclimate/ui/internal/actions/OpenAppMonitorAction.java
@@ -15,12 +15,13 @@
 
 import org.eclipse.jface.action.IAction;
 import org.eclipse.jface.viewers.ISelection;
+import org.eclipse.jface.viewers.ISelectionProvider;
 import org.eclipse.jface.viewers.IStructuredSelection;
 import org.eclipse.osgi.util.NLS;
-import org.eclipse.ui.IObjectActionDelegate;
 import org.eclipse.ui.IWorkbenchPart;
 import org.eclipse.ui.PartInitException;
 import org.eclipse.ui.PlatformUI;
+import org.eclipse.ui.actions.SelectionProviderAction;
 import org.eclipse.ui.browser.IWebBrowser;
 import org.eclipse.ui.browser.IWorkbenchBrowserSupport;
 
@@ -34,31 +35,31 @@
 /**
  * Action to open the application monitor in a browser.
  */
-public class OpenAppMonitorAction implements IObjectActionDelegate {
+public class OpenAppMonitorAction extends SelectionProviderAction {
 
     protected MicroclimateApplication app;
+    
+	public OpenAppMonitorAction(ISelectionProvider selectionProvider) {
+        super(selectionProvider, Messages.ActionOpenAppMonitor);
+        selectionChanged(getStructuredSelection());
+    }
 
-    @Override
-    public void selectionChanged(IAction action, ISelection selection) {
-        if (!(selection instanceof IStructuredSelection)) {
-            action.setEnabled(false);
-            return;
-        }
 
-        IStructuredSelection sel = (IStructuredSelection) selection;
+    @Override
+    public void selectionChanged(IStructuredSelection sel) {
         if (sel.size() == 1) {
             Object obj = sel.getFirstElement();
             if (obj instanceof MicroclimateApplication) {
             	app = (MicroclimateApplication)obj;
-            	action.setEnabled(app.isAvailable() && app.getAppState() == AppState.STARTED);
+            	setEnabled(app.isAvailable() && app.getAppState() == AppState.STARTED);
             	return;
             }
         }
-        action.setEnabled(false);
+        setEnabled(false);
     }
 
     @Override
-    public void run(IAction action) {
+    public void run() {
         if (app == null) {
         	// should not be possible
         	MCLogger.logError("OpenAppMonitorAction ran but no Microclimate application was selected");
@@ -92,9 +93,8 @@ public void run(IAction action) {
 			MCLogger.logError("Error opening the app monitor in browser", e); //$NON-NLS-1$
 		}
     }
-
-	@Override
-	public void setActivePart(IAction arg0, IWorkbenchPart arg1) {
-		// nothing
-	}
+    
+    public boolean showAction() {
+    	return app != null && app.getMetricsAvailable();
+    }
 }
diff --git a/dev/com.ibm.microclimate.ui/src/com/ibm/microclimate/ui/internal/messages/Messages.java b/dev/com.ibm.microclimate.ui/src/com/ibm/microclimate/ui/internal/messages/Messages.java
@@ -74,6 +74,8 @@ public class Messages extends NLS {
 	
 	public static String ActionNewConnection;
 	
+	public static String ActionOpenAppMonitor;
+
 	public static String ValidateLabel;
 	public static String AttachDebuggerLabel;
 	public static String LaunchDebugSessionLabel;
diff --git a/dev/com.ibm.microclimate.ui/src/com/ibm/microclimate/ui/internal/messages/messages.properties b/dev/com.ibm.microclimate.ui/src/com/ibm/microclimate/ui/internal/messages/messages.properties
@@ -67,6 +67,8 @@ ErrorOnShowLogFileDialogTitle=An error occurred while opening or closing the str
 
 ActionNewConnection=&New Microclimate Connection
 
+ActionOpenAppMonitor=Open Application &Monitor
+
 ValidateLabel=Validate
 AttachDebuggerLabel=A&ttach Debugger
 LaunchDebugSessionLabel=&Launch Debug Session

Original file line number	Diff line number	Diff line change
`@@ -226,5 +226,17 @@ public static void updateApp(MicroclimateApplication mcApp, JSONObject appJso) {`
`226`	`226`	`MCLogger.logError("An error occurred while updating the log information for project: " + mcApp.name, e);`
`227`	`227`	`}`
`228`	`228`
	`229`	`+ // Check for metrics support`
	`230`	`+ boolean metricsAvailable = true;`
	`231`	`+ try {`
	`232`	`+ JSONObject obj = mcApp.mcConnection.requestProjectMetricsStatus(mcApp);`
	`233`	`+ if (obj != null && obj.has(MCConstants.KEY_METRICS_AVAILABLE)) {`
	`234`	`+ metricsAvailable = obj.getBoolean(MCConstants.KEY_METRICS_AVAILABLE);`
	`235`	`+ }`
	`236`	`+ } catch (Exception e) {`
	`237`	`+ MCLogger.logError("An error occurred checking if metrics are available: " + mcApp.name, e);`
	`238`	`+ }`
	`239`	`+ mcApp.setMetricsAvailable(metricsAvailable);`
	`240`	`+`
`229`	`241`	`}`
`230`	`242`	`}`