diff options
author | Harald Musum <musum@verizonmedia.com> | 2020-07-17 12:04:07 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-07-17 12:04:07 +0200 |
commit | 1c69b4e72b3212e3ce989a8675db08ac51b7f79d (patch) | |
tree | 3714c4ea91a3e68826e5ddbb73f71daa93105aec /container-core/src/main/java/com/yahoo/container | |
parent | 174910488e7793d9962775c0325764ed265ea2ce (diff) |
Revert "Load platform bundles separately 3"
Diffstat (limited to 'container-core/src/main/java/com/yahoo/container')
7 files changed, 246 insertions, 252 deletions
diff --git a/container-core/src/main/java/com/yahoo/container/core/config/ApplicationBundleLoader.java b/container-core/src/main/java/com/yahoo/container/core/config/ApplicationBundleLoader.java deleted file mode 100644 index 5236daf0302..00000000000 --- a/container-core/src/main/java/com/yahoo/container/core/config/ApplicationBundleLoader.java +++ /dev/null @@ -1,142 +0,0 @@ -// Copyright 2020 Oath Inc. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root. -package com.yahoo.container.core.config; - -import com.yahoo.config.FileReference; -import com.yahoo.container.Container; -import com.yahoo.filedistribution.fileacquirer.FileAcquirer; -import com.yahoo.osgi.Osgi; -import org.osgi.framework.Bundle; -import org.osgi.framework.wiring.BundleRevision; - -import java.util.ArrayList; -import java.util.HashSet; -import java.util.LinkedHashMap; -import java.util.List; -import java.util.Map; -import java.util.Set; -import java.util.logging.Logger; -import java.util.stream.Collectors; - -/** - * Manages the set of installed and active/inactive bundles. - * - * @author gjoranv - * @author Tony Vaagenes - */ -public class ApplicationBundleLoader { - - /* Map of file refs of active bundles (not scheduled for uninstall) to the installed bundle. - * - * Used to: - * 1. Avoid installing already installed bundles. Just an optimization, installing the same bundle location is a NOP - * 2. Start bundles (all are started every time) - * 3. Calculate the set of bundles to uninstall - */ - private final Map<FileReference, Bundle> reference2Bundle = new LinkedHashMap<>(); - - private final Logger log = Logger.getLogger(ApplicationBundleLoader.class.getName()); - private final Osgi osgi; - - // A custom bundle installer for non-disk bundles, to be used for testing - private BundleInstaller customBundleInstaller = null; - - public ApplicationBundleLoader(Osgi osgi) { - this.osgi = osgi; - } - - /** - * Installs the given set of bundles and returns the set of bundles that is no longer used - * by the application, and should therefore be scheduled for uninstall. - */ - public synchronized Set<Bundle> useBundles(List<FileReference> newFileReferences) { - - Set<FileReference> obsoleteReferences = getObsoleteFileReferences(newFileReferences); - Set<Bundle> bundlesToUninstall = getObsoleteBundles(obsoleteReferences); - log.info("Bundles to schedule for uninstall: " + bundlesToUninstall); - - osgi.allowDuplicateBundles(bundlesToUninstall); - removeInactiveFileReferences(obsoleteReferences); - - installBundles(newFileReferences); - BundleStarter.startBundles(reference2Bundle.values()); - log.info(installedBundlesMessage()); - - return bundlesToUninstall; - } - - private Set<FileReference> getObsoleteFileReferences(List<FileReference> newReferences) { - Set<FileReference> obsoleteReferences = new HashSet<>(reference2Bundle.keySet()); - obsoleteReferences.removeAll(newReferences); - return obsoleteReferences; - } - - - /** - * Returns the bundles that will not be retained by the new application generation. - */ - private Set<Bundle> getObsoleteBundles(Set<FileReference> obsoleteReferences) { - return obsoleteReferences.stream().map(reference2Bundle::get).collect(Collectors.toSet()); - } - - private void removeInactiveFileReferences(Set<FileReference> fileReferencesToRemove) { - fileReferencesToRemove.forEach(reference2Bundle::remove); - } - - private void installBundles(List<FileReference> references) { - Set<FileReference> bundlesToInstall = new HashSet<>(references); - - // This is just an optimization, as installing a bundle with the same location id returns the already installed bundle. - bundlesToInstall.removeAll(reference2Bundle.keySet()); - - if (!bundlesToInstall.isEmpty()) { - FileAcquirer fileAcquirer = Container.get().getFileAcquirer(); - boolean hasFileDistribution = (fileAcquirer != null); - if (hasFileDistribution) { - installWithFileDistribution(bundlesToInstall, new FileAcquirerBundleInstaller(fileAcquirer)); - } else if (customBundleInstaller != null) { - installWithFileDistribution(bundlesToInstall, customBundleInstaller); - } else { - log.warning("Can't retrieve bundles since file distribution is disabled."); - } - } - } - - private void installWithFileDistribution(Set<FileReference> bundlesToInstall, BundleInstaller bundleInstaller) { - for (FileReference reference : bundlesToInstall) { - try { - log.info("Installing bundle with reference '" + reference.value() + "'"); - List<Bundle> bundles = bundleInstaller.installBundles(reference, osgi); - - // Throw if more than one bundle was installed, which means that the X-JDisc-Preinstall-Bundle header was used. - // However, if the OSGi framework is only a test framework, this rule does not apply. - if (bundles.size() > 1 && osgi.hasFelixFramework()) { - throw new RuntimeException("Bundle '" + bundles.get(0).getSymbolicName() + "' tried to pre-install other bundles."); - } - reference2Bundle.put(reference, bundles.get(0)); - } - catch(Exception e) { - throw new RuntimeException("Could not install bundle with reference '" + reference + "'", e); - } - } - } - - private String installedBundlesMessage() { - StringBuilder sb = new StringBuilder("Installed bundles: {" ); - for (Bundle b : osgi.getBundles()) - sb.append("[" + b.getBundleId() + "]" + b.getSymbolicName() + ":" + b.getVersion() + ", "); - sb.setLength(sb.length() - 2); - sb.append("}"); - return sb.toString(); - } - - // Only for testing - void useCustomBundleInstaller(BundleInstaller bundleInstaller) { - customBundleInstaller = bundleInstaller; - } - - // Only for testing - List<FileReference> getActiveFileReferences() { - return new ArrayList<>(reference2Bundle.keySet()); - } - -} diff --git a/container-core/src/main/java/com/yahoo/container/core/config/BundleManager.java b/container-core/src/main/java/com/yahoo/container/core/config/BundleManager.java new file mode 100644 index 00000000000..406d68408e3 --- /dev/null +++ b/container-core/src/main/java/com/yahoo/container/core/config/BundleManager.java @@ -0,0 +1,236 @@ +// Copyright 2020 Oath Inc. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root. +package com.yahoo.container.core.config; + +import com.yahoo.collections.PredicateSplit; +import com.yahoo.config.FileReference; +import com.yahoo.container.Container; +import com.yahoo.filedistribution.fileacquirer.FileAcquirer; +import com.yahoo.osgi.Osgi; +import org.osgi.framework.Bundle; +import org.osgi.framework.wiring.BundleRevision; + +import java.util.ArrayList; +import java.util.HashSet; +import java.util.LinkedHashMap; +import java.util.List; +import java.util.Map; +import java.util.Set; +import java.util.logging.Logger; +import java.util.stream.Collectors; + +import static com.yahoo.collections.PredicateSplit.partition; +import static com.yahoo.container.core.BundleLoaderProperties.DISK_BUNDLE_PREFIX; + +/** + * Manages the set of installed and active/inactive bundles. + * + * @author gjoranv + * @author Tony Vaagenes + */ +public class BundleManager { + + /* Map of file refs of active bundles (not scheduled for uninstall) to a list of all bundles that were installed + * (pre-install directive) by the bundle pointed to by the file ref (including itself). + * + * Used to: + * 1. Avoid installing already installed bundles. Just an optimization, installing the same bundle location is a NOP + * 2. Start bundles (all are started every time) + * 3. Calculate the set of bundles to uninstall + */ + private final Map<FileReference, List<Bundle>> reference2Bundles = new LinkedHashMap<>(); + + private final Logger log = Logger.getLogger(BundleManager.class.getName()); + private final Osgi osgi; + + // A custom bundle installer for non-disk bundles, to be used for testing + private BundleInstaller customBundleInstaller = null; + + public BundleManager(Osgi osgi) { + this.osgi = osgi; + } + + /** + * Installs the given set of bundles and returns the set of bundles that is no longer used + * by the application, and should therefore be scheduled for uninstall. + */ + public synchronized Set<Bundle> use(List<FileReference> newFileReferences) { + // Must be done before allowing duplicates because allowed duplicates affect osgi.getCurrentBundles + Set<Bundle> bundlesToUninstall = getObsoleteBundles(newFileReferences); + + Set<FileReference> obsoleteReferences = getObsoleteFileReferences(newFileReferences); + allowDuplicateBundles(obsoleteReferences); + removeInactiveFileReferences(obsoleteReferences); + + installBundles(newFileReferences); + startBundles(); + + bundlesToUninstall.removeAll(allActiveBundles()); + log.info("Bundles to schedule for uninstall: " + bundlesToUninstall); + + log.info(installedBundlesMessage()); + return bundlesToUninstall; + } + + /** + * Returns the bundles that are not assumed to be retained by the new application generation. + * Note that at this point we don't yet know the full set of new bundles, because of the potential + * pre-install directives in the new bundles. However, only "disk bundles" (file:) can be listed + * in the pre-install directive, so we know about all the obsolete application bundles. + */ + private Set<Bundle> getObsoleteBundles(List<FileReference> newReferences) { + Set<Bundle> bundlesToRemove = new HashSet<>(osgi.getCurrentBundles()); + + for (FileReference fileReferenceToKeep : newReferences) { + if (reference2Bundles.containsKey(fileReferenceToKeep)) { + bundlesToRemove.removeAll(reference2Bundles.get(fileReferenceToKeep)); + } + } + bundlesToRemove.removeAll(osgi.getInitialBundles()); + return bundlesToRemove; + } + + + private Set<FileReference> getObsoleteFileReferences(List<FileReference> newReferences) { + Set<FileReference> obsoleteReferences = new HashSet<>(reference2Bundles.keySet()); + obsoleteReferences.removeAll(newReferences); + return obsoleteReferences; + } + + /** + * Allow duplicates (bsn+version) for each bundle that corresponds to obsolete file references, + * and avoid allowing duplicates for bundles that were installed via the + * X-JDisc-Preinstall-Bundle directive. These bundles are always "disk bundles" (library + * bundles installed on the node, and not transferred via file distribution). + * Such bundles will never have duplicates because they always have the same location id. + */ + private void allowDuplicateBundles(Set<FileReference> obsoleteReferences) { + // The bundle at index 0 for each file reference always corresponds to the bundle at the file reference location + Set<Bundle> allowedDuplicates = obsoleteReferences.stream() + .filter(reference -> ! isDiskBundle(reference)) + .map(reference -> reference2Bundles.get(reference).get(0)) + .collect(Collectors.toSet()); + + log.info(() -> allowedDuplicates.isEmpty() ? "" : "Adding bundles to allowed duplicates: " + allowedDuplicates); + osgi.allowDuplicateBundles(allowedDuplicates); + } + + /** + * Cleans up the map of active file references + */ + private void removeInactiveFileReferences(Set<FileReference> fileReferencesToRemove) { + // Clean up the map of active bundles + fileReferencesToRemove.forEach(reference2Bundles::remove); + } + + private void installBundles(List<FileReference> references) { + Set<FileReference> bundlesToInstall = new HashSet<>(references); + + // This is just an optimization, as installing a bundle with the same location id returns the already installed bundle. + bundlesToInstall.removeAll(reference2Bundles.keySet()); + + PredicateSplit<FileReference> bundlesToInstall_isDisk = partition(bundlesToInstall, BundleManager::isDiskBundle); + installBundlesFromDisk(bundlesToInstall_isDisk.trueValues); + installBundlesFromFileDistribution(bundlesToInstall_isDisk.falseValues); + } + + private static boolean isDiskBundle(FileReference fileReference) { + return fileReference.value().startsWith(DISK_BUNDLE_PREFIX); + } + + private void installBundlesFromDisk(List<FileReference> bundlesToInstall) { + for (FileReference reference : bundlesToInstall) { + try { + installBundleFromDisk(reference); + } + catch(Exception e) { + throw new RuntimeException("Could not install bundle '" + reference + "'", e); + } + } + } + + private void installBundlesFromFileDistribution(List<FileReference> bundlesToInstall) { + if (!bundlesToInstall.isEmpty()) { + FileAcquirer fileAcquirer = Container.get().getFileAcquirer(); + boolean hasFileDistribution = (fileAcquirer != null); + if (hasFileDistribution) { + installWithFileDistribution(bundlesToInstall, new FileAcquirerBundleInstaller(fileAcquirer)); + } else if (customBundleInstaller != null) { + installWithFileDistribution(bundlesToInstall, customBundleInstaller); + } else { + log.warning("Can't retrieve bundles since file distribution is disabled."); + } + } + } + + private void installBundleFromDisk(FileReference reference) { + log.info("Installing bundle from disk with reference '" + reference.value() + "'"); + + var bundleInstaller = new DiskBundleInstaller(); + List<Bundle> bundles = bundleInstaller.installBundles(reference, osgi); + reference2Bundles.put(reference, bundles); + } + + private void installWithFileDistribution(List<FileReference> bundlesToInstall, BundleInstaller bundleInstaller) { + for (FileReference reference : bundlesToInstall) { + try { + log.info("Installing bundle with reference '" + reference.value() + "'"); + List<Bundle> bundles = bundleInstaller.installBundles(reference, osgi); + reference2Bundles.put(reference, bundles); + } + catch(Exception e) { + throw new RuntimeException("Could not install bundle '" + reference + "'", e); + } + } + } + + /** + * Resolves and starts (calls the Bundles BundleActivator) all bundles. Bundle resolution must take place + * after all bundles are installed to ensure that the framework can resolve dependencies between bundles. + */ + private void startBundles() { + for (List<Bundle> bundles : reference2Bundles.values()) { + for (Bundle bundle : bundles) { + try { + if ( ! isFragment(bundle)) + bundle.start(); // NOP for already ACTIVE bundles + } catch(Exception e) { + throw new RuntimeException("Could not start bundle '" + bundle.getSymbolicName() + "'", e); + } + } + } + } + + private boolean isFragment(Bundle bundle) { + BundleRevision bundleRevision = bundle.adapt(BundleRevision.class); + if (bundleRevision == null) + throw new NullPointerException("Null bundle revision means that bundle has probably been uninstalled: " + + bundle.getSymbolicName() + ":" + bundle.getVersion()); + return (bundleRevision.getTypes() & BundleRevision.TYPE_FRAGMENT) != 0; + } + + private Set<Bundle> allActiveBundles() { + return reference2Bundles.keySet().stream() + .flatMap(reference -> reference2Bundles.get(reference).stream()) + .collect(Collectors.toSet()); + } + + private String installedBundlesMessage() { + StringBuilder sb = new StringBuilder("Installed bundles: {" ); + for (Bundle b : osgi.getBundles()) + sb.append("[" + b.getBundleId() + "]" + b.getSymbolicName() + ":" + b.getVersion() + ", "); + sb.setLength(sb.length() - 2); + sb.append("}"); + return sb.toString(); + } + + // Only for testing + void useCustomBundleInstaller(BundleInstaller bundleInstaller) { + customBundleInstaller = bundleInstaller; + } + + // Only for testing + List<FileReference> getActiveFileReferences() { + return new ArrayList<>(reference2Bundles.keySet()); + } + +} diff --git a/container-core/src/main/java/com/yahoo/container/core/config/BundleStarter.java b/container-core/src/main/java/com/yahoo/container/core/config/BundleStarter.java deleted file mode 100644 index 4a87c27b990..00000000000 --- a/container-core/src/main/java/com/yahoo/container/core/config/BundleStarter.java +++ /dev/null @@ -1,40 +0,0 @@ -package com.yahoo.container.core.config; - -import org.osgi.framework.Bundle; -import org.osgi.framework.wiring.BundleRevision; - -import java.util.Collection; - -/** - * Utility to start a collection of bundles. - * - * @author gjoranv - */ -public class BundleStarter { - - private BundleStarter() { } - - /** - * Resolves and starts (calls the Bundles BundleActivator) all bundles. Bundle resolution must take place - * after all bundles are installed to ensure that the framework can resolve dependencies between bundles. - */ - static void startBundles(Collection<Bundle> bundles) { - for (var bundle : bundles) { - try { - if ( ! isFragment(bundle)) - bundle.start(); // NOP for already ACTIVE bundles - } catch(Exception e) { - throw new RuntimeException("Could not start bundle '" + bundle.getSymbolicName() + "'", e); - } - } - } - - private static boolean isFragment(Bundle bundle) { - BundleRevision bundleRevision = bundle.adapt(BundleRevision.class); - if (bundleRevision == null) - throw new NullPointerException("Null bundle revision means that bundle has probably been uninstalled: " + - bundle.getSymbolicName() + ":" + bundle.getVersion()); - return (bundleRevision.getTypes() & BundleRevision.TYPE_FRAGMENT) != 0; - } - -} diff --git a/container-core/src/main/java/com/yahoo/container/core/config/HandlersConfigurerDi.java b/container-core/src/main/java/com/yahoo/container/core/config/HandlersConfigurerDi.java index 80c39bef2cb..b983cbcfe37 100644 --- a/container-core/src/main/java/com/yahoo/container/core/config/HandlersConfigurerDi.java +++ b/container-core/src/main/java/com/yahoo/container/core/config/HandlersConfigurerDi.java @@ -101,16 +101,12 @@ public class HandlersConfigurerDi { private static class ContainerAndDiOsgi extends OsgiImpl implements OsgiWrapper { private final OsgiFramework osgiFramework; - private final ApplicationBundleLoader applicationBundleLoader; - private final PlatformBundleLoader platformBundleLoader; + private final BundleManager bundleManager; public ContainerAndDiOsgi(OsgiFramework osgiFramework) { super(osgiFramework); this.osgiFramework = osgiFramework; - - OsgiImpl osgi = new OsgiImpl(osgiFramework); - applicationBundleLoader = new ApplicationBundleLoader(osgi); - platformBundleLoader = new PlatformBundleLoader(osgi); + bundleManager = new BundleManager(new OsgiImpl(osgiFramework)); } @@ -135,15 +131,9 @@ public class HandlersConfigurerDi { } @Override - public void installPlatformBundles(Collection<FileReference> bundles) { - log.fine("Installing platform bundles."); - platformBundleLoader.useBundles(new ArrayList<>(bundles)); - } - - @Override - public Set<Bundle> useApplicationBundles(Collection<FileReference> bundles) { + public Set<Bundle> useBundles(Collection<FileReference> bundles) { log.info("Installing bundles from the latest application"); - return applicationBundleLoader.useBundles(new ArrayList<>(bundles)); + return bundleManager.use(new ArrayList<>(bundles)); } } diff --git a/container-core/src/main/java/com/yahoo/container/core/config/PlatformBundleLoader.java b/container-core/src/main/java/com/yahoo/container/core/config/PlatformBundleLoader.java deleted file mode 100644 index f922bc0cb25..00000000000 --- a/container-core/src/main/java/com/yahoo/container/core/config/PlatformBundleLoader.java +++ /dev/null @@ -1,54 +0,0 @@ -package com.yahoo.container.core.config; - -import com.yahoo.config.FileReference; -import com.yahoo.osgi.Osgi; -import org.osgi.framework.Bundle; - -import java.util.LinkedHashSet; -import java.util.List; -import java.util.Set; -import java.util.logging.Logger; - -/** - * Installs all platform bundles, using the {@link DiskBundleInstaller}. - * All platform bundles reside on disk, and they are never uninstalled. - * - * @author gjoranv - */ -public class PlatformBundleLoader { - private static final Logger log = Logger.getLogger(PlatformBundleLoader.class.getName()); - - private final Osgi osgi; - private final DiskBundleInstaller installer; - - public PlatformBundleLoader(Osgi osgi) { - this.osgi = osgi; - installer = new DiskBundleInstaller(); - } - - public void useBundles(List<FileReference> fileReferences) { - Set<Bundle> installedBundles = install(fileReferences); - BundleStarter.startBundles(installedBundles); - } - - private Set<Bundle> install(List<FileReference> bundlesToInstall) { - var installedBundles = new LinkedHashSet<Bundle>(); - for (FileReference reference : bundlesToInstall) { - try { - installedBundles.addAll(installBundleFromDisk(reference)); - } - catch(Exception e) { - throw new RuntimeException("Could not install bundle '" + reference + "'", e); - } - } - return installedBundles; - } - - private List<Bundle> installBundleFromDisk(FileReference reference) { - log.info("Installing bundle from disk with reference '" + reference.value() + "'"); - List<Bundle> bundles = installer.installBundles(reference, osgi); - log.fine("Installed " + bundles.size() + " bundles for file reference " + reference); - return bundles; - } - -} diff --git a/container-core/src/main/java/com/yahoo/container/core/config/testutil/HandlersConfigurerTestWrapper.java b/container-core/src/main/java/com/yahoo/container/core/config/testutil/HandlersConfigurerTestWrapper.java index 503bf2f2db1..9f49b016b68 100644 --- a/container-core/src/main/java/com/yahoo/container/core/config/testutil/HandlersConfigurerTestWrapper.java +++ b/container-core/src/main/java/com/yahoo/container/core/config/testutil/HandlersConfigurerTestWrapper.java @@ -41,8 +41,7 @@ public class HandlersConfigurerTestWrapper { private final static String testFiles[] = { "components.cfg", "handlers.cfg", - "platform-bundles.cfg", - "application-bundles.cfg", + "bundles.cfg", "string.cfg", "int.cfg", "renderers.cfg", diff --git a/container-core/src/main/java/com/yahoo/container/core/config/testutil/MockOsgiWrapper.java b/container-core/src/main/java/com/yahoo/container/core/config/testutil/MockOsgiWrapper.java index 98c927b8efd..ac0fbd71671 100644 --- a/container-core/src/main/java/com/yahoo/container/core/config/testutil/MockOsgiWrapper.java +++ b/container-core/src/main/java/com/yahoo/container/core/config/testutil/MockOsgiWrapper.java @@ -16,6 +16,11 @@ import static java.util.Collections.emptyList; public class MockOsgiWrapper implements OsgiWrapper { @Override + public List<Bundle> getInitialBundles() { + return emptyList(); + } + + @Override public Bundle[] getBundles() { return new Bundle[0]; } |