Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Don't let certain errors fail SPI loading #41991

Merged
merged 2 commits into from
Sep 23, 2024
Merged

Don't let certain errors fail SPI loading #41991

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e1dc87a
Don't let certain errors fail SPI loading
alzimmermsft Sep 23, 2024
2874b28
Merge branch 'main' into AzCore_DontLetLinkageErrorsLeakFromSpiLoading
alzimmermsft Sep 23, 2024
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
4 changes: 2 additions & 2 deletions sdk/core/azure-core-test/src/main/java/com/azure/core/test/TestBase.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -268,8 +268,8 @@ public static Stream<HttpClient> getHttpClients() {
httpClientProvider.getClass().getSimpleName().toLowerCase(Locale.ROOT))) {
httpClientsToTest.add(httpClientProvider.createInstance());
}
} catch (ServiceConfigurationError | UnsupportedClassVersionError error) {
LOGGER.atWarning().log(() -> "Skipping HttpClientProvider due to UnsupportedClassVersionError.", error);
} catch (ServiceConfigurationError | LinkageError error) {
LOGGER.atWarning().log(() -> "Skipping HttpClientProvider due to LinkageError.", error);
}
}

Expand Down
53 changes: 31 additions & 22 deletions sdk/core/azure-core/src/main/java/com/azure/core/implementation/util/Providers.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,17 @@

import com.azure.core.util.CoreUtils;
import com.azure.core.util.logging.ClientLogger;
import com.azure.core.util.logging.LogLevel;

import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;
import java.util.ServiceConfigurationError;
import java.util.ServiceLoader;
import java.util.function.Function;

/**
* Helper class that unifies SPI instances creation.
*
*
* @param <TProvider> Service Provider interface.
* @param <TInstance> Service interface type.
*/
Expand Down Expand Up @@ -44,30 +44,39 @@ public Providers(Class<TProvider> providerClass, String defaultImplementationNam
// System classloader to load TProvider classes.
ServiceLoader<TProvider> serviceLoader = ServiceLoader.load(providerClass, Providers.class.getClassLoader());

availableProviders = new HashMap<>();
// Use the first provider found in the service loader iterator.
Iterator<TProvider> it = serviceLoader.iterator();
if (it.hasNext()) {
defaultProvider = it.next();
defaultProviderName = defaultProvider.getClass().getName();
availableProviders.put(defaultProviderName, defaultProvider);
LOGGER.log(LogLevel.VERBOSE,
() -> "Using " + defaultProviderName + " as the default " + providerClass.getName() + ".");
} else {
defaultProvider = null;
defaultProviderName = null;
}
TProvider defaultProvider = null;
String defaultProviderName = null;
this.availableProviders = new HashMap<>();

// Load all provider instances.
Iterator<TProvider> it = serviceLoader.iterator();
while (it.hasNext()) {
TProvider additionalProvider = it.next();
String additionalProviderName = additionalProvider.getClass().getName();
availableProviders.put(additionalProviderName, additionalProvider);
LOGGER.log(LogLevel.VERBOSE, () -> "Additional provider found on the classpath: " + additionalProviderName);
try {
TProvider provider = it.next();
String providerName = provider.getClass().getName();
availableProviders.put(providerName, provider);
if (defaultProvider == null) {
defaultProvider = provider;
defaultProviderName = providerName;
LOGGER.atVerbose()
.addKeyValue("providerName", providerName)
.addKeyValue("providerClass", providerClass.getName())
.log("Loaded default provider.");
} else {
LOGGER.atVerbose()
.addKeyValue("providerName", providerName)
.log("Additional provider found on the classpath");
}
} catch (LinkageError | ServiceConfigurationError error) {
LOGGER.atWarning().log(() -> "Failed to load a provider instance.", error);
}
}

defaultImplementation = defaultImplementationName;
noDefaultImplementation = CoreUtils.isNullOrEmpty(defaultImplementation);
noProviderMessage = noProviderErrorMessage;
this.defaultProvider = defaultProvider;
this.defaultProviderName = defaultProviderName;
this.defaultImplementation = defaultImplementationName;
this.noDefaultImplementation = CoreUtils.isNullOrEmpty(defaultImplementation);
this.noProviderMessage = noProviderErrorMessage;
}

private String formatNoSpecificProviderErrorMessage(String selectedImplementation) {
Expand Down
Loading