Skip to content

Commit

Permalink
Use BundleCapability to get all the installed bundles in platform
Browse files Browse the repository at this point in the history 
Signed-off-by: Sheng Chen <[email protected]>
  • Loading branch information
@jdneo
jdneo committed Nov 13, 2019
1 parent 633074a commit 34d5f95
Show file tree
Hide file tree
Showing 2 changed files with 90 additions and 41 deletions.
81 changes: 45 additions & 36 deletions org.eclipse.jdt.ls.core/src/org/eclipse/jdt/ls/core/internal/handlers/BundleUtils.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,9 @@
import java.io.File;
import java.io.IOException;
import java.net.MalformedURLException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.HashMap;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.CountDownLatch;
Expand All @@ -31,9 +28,9 @@
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.MultiStatus;
import org.eclipse.core.runtime.Platform;
import org.eclipse.core.runtime.Status;
import org.eclipse.jdt.ls.core.internal.JavaLanguageServerPlugin;
import org.eclipse.osgi.container.ModuleContainer;
import org.eclipse.osgi.util.ManifestElement;
import org.osgi.framework.Bundle;
import org.osgi.framework.BundleContext;
Expand All @@ -42,8 +39,11 @@
import org.osgi.framework.FrameworkEvent;
import org.osgi.framework.FrameworkListener;
import org.osgi.framework.Version;
import org.osgi.framework.namespace.IdentityNamespace;
import org.osgi.framework.startlevel.BundleStartLevel;
import org.osgi.framework.wiring.BundleCapability;
import org.osgi.framework.wiring.FrameworkWiring;
import org.osgi.resource.Namespace;

/**
* BundleContext and Bundle utilities
Expand Down Expand Up @@ -99,9 +99,8 @@ public static void loadBundles(Collection<String> bundleLocations) throws CoreEx

BundleContext context = JavaLanguageServerPlugin.getBundleContext();
MultiStatus status = new MultiStatus(context.getBundle().getSymbolicName(), IStatus.OK, "Load bundle list", null);
Collection<Bundle> bundlesToStart = new ArrayList<>();
Set<Bundle> bundlesToStart = new HashSet<>();
Set<Bundle> toRefresh = new HashSet<>();
Map<String, List<BundleInfo>> installedBundles = new HashMap<>();
FrameworkWiring frameworkWiring = context.getBundle(0).adapt(FrameworkWiring.class);
for (String bundleLocation : bundleLocations) {
try {
Expand All @@ -119,47 +118,33 @@ public static void loadBundles(Collection<String> bundleLocations) throws CoreEx
continue;
}

// Platform.getBundle() won't return the bundle with INSTALLED state, so we use this Map to persist the current installed bundles
List<BundleInfo> installedBundleList = installedBundles.get(bundleInfo.getSymbolicName());
if (installedBundleList != null) {
Bundle[] bundles = getBundles(bundleInfo.getSymbolicName(), frameworkWiring);
if (bundles != null) {
boolean shouldSkip = false;
for (BundleInfo info : installedBundleList) {
if (info.isSingleton()) {
// We have installed this singleton bundle before, so skip this one.
shouldSkip = true;
break;
} else if (info.getVersion().equals(bundleInfo.getVersion())) {
// if It's not singleton, make sure the same version does not get installed
for (Bundle bundle : bundles) {
if (bundle.getVersion().equals(Version.parseVersion(bundleInfo.getVersion()))) {
shouldSkip = true;
break;
}
}
if (shouldSkip) {
continue;
}
}

Bundle bundle = Platform.getBundle(bundleInfo.getSymbolicName());
if (bundle != null) {
if (bundle.getVersion().equals(Version.parseVersion(bundleInfo.getVersion()))) {
// Same bundle exists
continue;
}

if (bundleInfo.isSingleton()) {
if (bundles.length > 1) {
status.add(new Status(IStatus.ERROR, context.getBundle().getSymbolicName(), "Multiple singleton bundles are installed: " + bundleInfo.getSymbolicName()));
continue;
}
// The uninstallation will only happen when the bundle is singleton with different version
bundle.uninstall();
JavaLanguageServerPlugin.logInfo("Uninstalled " + bundle.getLocation());
toRefresh.add(bundle);
bundles[0].uninstall();
JavaLanguageServerPlugin.logInfo("Uninstalled " + bundles[0].getLocation());
toRefresh.add(bundles[0]);
bundlesToStart.remove(bundles[0]);
}
}
bundle = context.installBundle(location);

Bundle bundle = context.installBundle(location);
JavaLanguageServerPlugin.logInfo("Installed " + bundle.getLocation());
if (installedBundles.containsKey(bundle.getSymbolicName())) {
installedBundleList.add(bundleInfo);
} else {
installedBundles.put(bundle.getSymbolicName(), new ArrayList<>(Arrays.asList(bundleInfo)));
}
bundlesToStart.add(bundle);

} catch (BundleException e) {
Expand All @@ -179,6 +164,30 @@ public static void loadBundles(Collection<String> bundleLocations) throws CoreEx
}
}

private static Bundle[] getBundles(String symbolicName, FrameworkWiring fwkWiring) {
BundleContext context = fwkWiring.getBundle().getBundleContext();
if (Constants.SYSTEM_BUNDLE_SYMBOLICNAME.equals(symbolicName)) {
symbolicName = context.getBundle(Constants.SYSTEM_BUNDLE_LOCATION).getSymbolicName();
}
StringBuilder filter = new StringBuilder();
filter.append('(')
.append(IdentityNamespace.IDENTITY_NAMESPACE)
.append('=')
.append(symbolicName)
.append(')');
Map<String, String> directives = Collections.singletonMap(Namespace.REQUIREMENT_FILTER_DIRECTIVE, filter.toString());
Collection<BundleCapability> matchingBundleCapabilities = fwkWiring.findProviders(ModuleContainer.createRequirement(IdentityNamespace.IDENTITY_NAMESPACE, directives, Collections.emptyMap()));
if (matchingBundleCapabilities.isEmpty()) {
return null;
}
Bundle[] results = matchingBundleCapabilities.stream().map(c -> c.getRevision().getBundle())
// Remove all the bundles that are uninstalled
.filter(bundle -> (bundle.getState() & (Bundle.UNINSTALLED)) == 0)
.sorted((b1, b2) -> b2.getVersion().compareTo(b1.getVersion())) // highest version first
.toArray(Bundle[]::new);
return results.length > 0 ? results : null;
}

private static void refreshBundles(Set<Bundle> toRefresh, FrameworkWiring frameworkWiring) {
if (!toRefresh.isEmpty()) {
JavaLanguageServerPlugin.logInfo("Refresh the bundles");
Expand All @@ -189,8 +198,8 @@ public void frameworkEvent(FrameworkEvent event) {
if (event.getType() == FrameworkEvent.PACKAGES_REFRESHED) {
latch.countDown();
} else if (event.getType() == FrameworkEvent.ERROR) {
latch.countDown();
JavaLanguageServerPlugin.logException("Error happens when refreshing the bundles", event.getThrowable());
latch.countDown();
}
}
});
Expand Down
50 changes: 45 additions & 5 deletions org.eclipse.jdt.ls.tests/src/org/eclipse/jdt/ls/core/internal/BundleUtilsTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ public void testLoadSameBundleMultipleTimes() throws Exception {
}

@Test
public void testLoadMultipleNonSongletonBundles() throws Exception {
public void testLoadMultipleNonSingletonBundles() throws Exception {
Bundle bundleA = null;
Bundle bundleB = null;
Bundle bundleC = null;
Expand Down Expand Up @@ -331,16 +331,56 @@ public void testLoadSameBundleWithDifferentVersionMultipleTimes() throws Excepti
newBundleB = context.getBundle(newDependencyBLocation);

assertTrue(oldDependencyBundle.getState() == Bundle.UNINSTALLED);
assertNotNull(newBundleA);
assertTrue(newBundleA.getState() == Bundle.ACTIVE);
// skipped newBundleB since this is a singleton bundle
assertNull(newBundleB);
assertNull(newBundleA);
assertNotNull(newBundleB);
assertTrue(newBundleB.getState() == Bundle.ACTIVE);
} finally {
// Uninstall the bundle to clean up the testing bundle context.
uninstallBundles(Arrays.asList(oldDependencyBundle, newBundleA, newBundleB));
}
}

@Test
public void testLoadMultipleExtensionsRequiringSameBundleButDifferentUrl() throws Exception {
Bundle extensionBundleA = null;
Bundle extensionBundleB = null;
Bundle dependencyA = null;
Bundle dependencyB = null;

try {
String extensionBundleAPath = getBundle("testresources/extension-with-dependency-0.0.1", "jdt.ls.extension.with.dependency_0.0.1.jar");
String dependencyAPath = getBundle("testresources/extension-with-dependency-0.0.1", "dependency_0.0.1.201911081535.jar");
String extensionBundleBPath = getBundle("testresources/another-extension-with-dependency-0.0.1", "jdt.ls.another.extension.with.dependency_0.0.1.jar");
String dependencyBPath = getBundle("testresources/another-extension-with-dependency-0.0.1", "dependency_0.0.1.201911081535.jar");

BundleUtils.loadBundles(Arrays.asList(extensionBundleAPath, dependencyAPath, extensionBundleBPath, dependencyBPath));
String extensionBundleALocation = getBundleLocation(extensionBundleAPath, true);
String dependencyALocation = getBundleLocation(dependencyAPath, true);
String extensionBundleBLocation = getBundleLocation(extensionBundleBPath, true);
String dependencyBLocation = getBundleLocation(dependencyBPath, true);

BundleContext context = JavaLanguageServerPlugin.getBundleContext();
extensionBundleA = context.getBundle(extensionBundleALocation);
dependencyA = context.getBundle(dependencyALocation);
extensionBundleB = context.getBundle(extensionBundleBLocation);
dependencyB = context.getBundle(dependencyBLocation);

assertTrue(extensionBundleA.getState() == Bundle.STARTING || extensionBundleA.getState() == Bundle.ACTIVE);
assertTrue(extensionBundleB.getState() == Bundle.STARTING || extensionBundleB.getState() == Bundle.ACTIVE);
extensionBundleA.loadClass("jdt.ls.extension.with.dependency.Activator");
assertEquals(extensionBundleA.getState(), Bundle.ACTIVE);
extensionBundleB.loadClass("jdt.ls.another.extension.with.dependency.Activator");
assertEquals(extensionBundleB.getState(), Bundle.ACTIVE);

// Bundles with same version but different URL, only the first one will be loaded
assertTrue(dependencyA.getState() == Bundle.ACTIVE);
assertNull(dependencyB);
} finally {
// Uninstall the bundle to clean up the testing bundle context.
uninstallBundles(Arrays.asList(extensionBundleA, extensionBundleB, dependencyA, dependencyB));
}
}

@Test(expected = CoreException.class)
public void testLoadThrowCoreException() throws Exception {
BundleUtils.loadBundles(Arrays.asList(new String[] { "Fakedlocation" }));
Expand Down

0 comments on commit 34d5f95

Please sign in to comment.