Working impl of HK2 dependency injection (#493)

* Working impl of HK2 dependency injection * Add RealmScope and make EntityCache and PolarisMetaStoreManager realm-scoped services * Remove dependency on HK2 from core module * Fix EntityCache to work with RealmScope * fix TimedApplicationEventListener.class * Add integration test to validate EntityCache in RealmScope * Added comments on PolarisApplication startup * Update HK2 setup to use PolarisApplicationConfig as interface to serviceLocator and handle DI for configured instances * Fixed RealmEntityManagerFactory to use EntityCache provider * Update Dockerfile to use entrypoint and fix vended-credentials delegation header * fix spotless * Update polaris-core/src/main/java/org/apache/polaris/core/context/RealmScope.java Co-authored-by: Robert Stupp <[email protected]> * Removed Jackson type annotations from interfaces * Address PR comments * Update build versions to include jakarta.inject * Removed unnecessary Discoverable service files * Fixes for rebase on main * Update Jersey ServiceLocator to use bootstrapped locator as parent * Addressed more PR comments * Update RealmScopeContext to use request-scoped RealmContext bean * Update CDI impls to use @Identifier and replaced all setter injection with field injection * Fix helm test to match expectation * Revert PolarisStorageIntegrationProviderImpl back to service module * Fix missing project mentions in LICENSE * Fix lint issue in helm values * Add logic in build to merge multiple hks-locator files --------- Co-authored-by: Robert Stupp <[email protected]> Co-authored-by: Michael Collado <[email protected]>
apache · Dec 9, 2024 · 9809e0e · 9809e0e
1 parent 5c3c7d6
commit 9809e0e
Show file tree

Hide file tree

Showing 80 changed files with 1,427 additions and 822 deletions.
diff --git a/LICENSE b/LICENSE
@@ -375,6 +375,14 @@ io.prometheus:prometheus-metrics-exposition-formats
 io.prometheus:prometheus-metrics-model
 io.prometheus:prometheus-metrics-shaded-protobuf
 io.prometheus:prometheus-metrics-tracer-common
+io.smallrye.common:smallrye-common-annotation
+io.smallrye.common:smallrye-common-classloader
+io.smallrye.common:smallrye-common-constraint
+io.smallrye.common:smallrye-common-expression
+io.smallrye.common:smallrye-common-function
+io.smallrye.config:smallrye-config
+io.smallrye.config:smallrye-config-common
+io.smallrye.config:smallrye-config-core
 io.swagger:swagger-annotations
 io.swagger:swagger-core
 io.swagger:swagger-jaxrs
@@ -446,6 +454,7 @@ org.eclipse.jetty:jetty-servlets
 org.eclipse.jetty:jetty-util
 org.eclipse.jetty:jetty-webapp
 org.eclipse.jetty:jetty-xml
+org.eclipse.microprofile.config:microprofile-config-api
 org.glassfish.jersey.containers:jersey-container-servlet
 org.glassfish.jersey.containers:jersey-container-servlet-core
 org.glassfish.jersey.core:jersey-client

diff --git a/extension/persistence/eclipselink/build.gradle.kts b/extension/persistence/eclipselink/build.gradle.kts
@@ -32,6 +32,8 @@ dependencies {
   implementation(project(":polaris-jpa-model"))
   implementation(libs.eclipselink)
   implementation(platform(libs.dropwizard.bom))
+  implementation(libs.jakarta.inject.api)
+  implementation(libs.smallrye)
   implementation("io.dropwizard:dropwizard-jackson")
   val eclipseLinkDeps: String? = project.findProperty("eclipseLinkDeps") as String?
   eclipseLinkDeps?.let {

diff --git a/...ris/extension/persistence/impl/eclipselink/EclipseLinkPolarisMetaStoreManagerFactory.java b/...ris/extension/persistence/impl/eclipselink/EclipseLinkPolarisMetaStoreManagerFactory.java
@@ -19,29 +19,32 @@
 package org.apache.polaris.extension.persistence.impl.eclipselink;
 
 import com.fasterxml.jackson.annotation.JsonProperty;
-import com.fasterxml.jackson.annotation.JsonTypeName;
-import io.dropwizard.jackson.Discoverable;
+import io.smallrye.common.annotation.Identifier;
 import jakarta.annotation.Nonnull;
+import jakarta.inject.Inject;
 import org.apache.polaris.core.PolarisDiagnostics;
 import org.apache.polaris.core.context.RealmContext;
 import org.apache.polaris.core.persistence.LocalPolarisMetaStoreManagerFactory;
 import org.apache.polaris.core.persistence.PolarisMetaStoreManager;
 import org.apache.polaris.core.persistence.PolarisMetaStoreSession;
+import org.apache.polaris.core.storage.PolarisStorageIntegrationProvider;
 
 /**
  * The implementation of Configuration interface for configuring the {@link PolarisMetaStoreManager}
  * using an EclipseLink based meta store to store and retrieve all Polaris metadata. It can be
  * configured through persistence.xml to use supported RDBMS as the meta store.
  */
-@JsonTypeName("eclipse-link")
+@Identifier("eclipse-link")
 public class EclipseLinkPolarisMetaStoreManagerFactory
-    extends LocalPolarisMetaStoreManagerFactory<PolarisEclipseLinkStore> implements Discoverable {
+    extends LocalPolarisMetaStoreManagerFactory<PolarisEclipseLinkStore> {
   @JsonProperty("conf-file")
   private String confFile;
 
   @JsonProperty("persistence-unit")
   private String persistenceUnitName;
 
+  @Inject protected PolarisStorageIntegrationProvider storageIntegration;
+
   @Override
   protected PolarisEclipseLinkStore createBackingStore(@Nonnull PolarisDiagnostics diagnostics) {
     return new PolarisEclipseLinkStore(diagnostics);

diff --git a/...ris/core/monitor/MetricRegistryAware.java → ...in/resources/META-INF/hk2-locator/default b/...ris/core/monitor/MetricRegistryAware.java → ...in/resources/META-INF/hk2-locator/default
@@ -16,9 +16,8 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-package org.apache.polaris.core.monitor;
+[org.apache.polaris.extension.persistence.impl.eclipselink.EclipseLinkPolarisMetaStoreManagerFactory]S
+contract={org.apache.polaris.core.persistence.MetaStoreManagerFactory}
+name=eclipse-link
+qualifier={io.smallrye.common.annotation.Identifier}
 
-/** Allows setting a configured instance of {@link PolarisMetricRegistry} */
-public interface MetricRegistryAware {
-  void setMetricRegistry(PolarisMetricRegistry metricRegistry);
-}
diff --git a/...tence/eclipselink/src/main/resources/META-INF/services/io.dropwizard.jackson.Discoverable b/...tence/eclipselink/src/main/resources/META-INF/services/io.dropwizard.jackson.Discoverable
diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml
@@ -52,6 +52,7 @@ hadoop-hdfs-client = { module = "org.apache.hadoop:hadoop-hdfs-client", version.
 iceberg-bom = { module = "org.apache.iceberg:iceberg-bom", version.ref = "iceberg" }
 jackson-bom = { module = "com.fasterxml.jackson:jackson-bom", version = "2.17.2" }
 jakarta-annotation-api = { module = "jakarta.annotation:jakarta.annotation-api", version = "3.0.0" }
+jakarta-inject-api = { module = "jakarta.inject:jakarta.inject-api", version = "2.0.1" }
 jakarta-validation-api = { module = "jakarta.validation:jakarta.validation-api", version = "3.1.0" }
 jakarta-persistence-api = { module = "jakarta.persistence:jakarta.persistence-api", version = "3.1.0" }
 javax-annotation-api = { module = "javax.annotation:javax.annotation-api", version = "1.3.2" }
@@ -71,6 +72,7 @@ swagger-annotations = { module = "io.swagger:swagger-annotations", version.ref =
 swagger-jaxrs = { module = "io.swagger:swagger-jaxrs", version.ref = "swagger" }
 testcontainers-bom = { module = "org.testcontainers:testcontainers-bom", version = "1.20.3" }
 threeten-extra = { module = "org.threeten:threeten-extra", version = "1.8.0" }
+smallrye = { module = "io.smallrye.config:smallrye-config", version = "3.10.2" }
 
 [plugins]
 openapi-generator = { id = "org.openapi.generator", version = "7.6.0" }

diff --git a/helm/polaris/tests/configmap_test.yaml b/helm/polaris/tests/configmap_test.yaml
@@ -184,14 +184,11 @@ tests:
           factoryType: default
         oauth2:
           type: default
-          tokenBroker:
-            type: symmetric-key
-            secret: polaris
+        tokenBroker:
+          type: symmetric-key
+          secret: polaris
         authenticator:
           class: org.apache.polaris.service.auth.DefaultPolarisAuthenticator
-          tokenBroker:
-            type: symmetric-key
-            secret: polaris
         cors:
           allowed-origins:
           - http://localhost:8080
@@ -228,9 +225,6 @@ tests:
             polaris-server.yml: |-
               authenticator:
                 class: org.apache.polaris.service.auth.DefaultPolarisAuthenticator
-                tokenBroker:
-                  secret: polaris
-                  type: symmetric-key
               callContextResolver:
                 type: default
               cors:
@@ -274,9 +268,6 @@ tests:
                 persistence-unit: polaris
                 type: eclipse-link
               oauth2:
-                tokenBroker:
-                  secret: polaris
-                  type: symmetric-key
                 type: default
               rateLimiter:
                 type: no-op
@@ -294,3 +285,6 @@ tests:
                 requestLog:
                   appenders:
                   - type: console
+              tokenBroker:
+                secret: polaris
+                type: symmetric-key
diff --git a/helm/polaris/values.yaml b/helm/polaris/values.yaml
@@ -321,9 +321,9 @@ polarisServerConfig:
   oauth2:
     type: test
   #  type: default # - uncomment to support Auth0 JWT tokens
-  #  tokenBroker:
-  #    type: symmetric-key
-  #    secret: polaris
+# tokenBroker:
+#  type: symmetric-key
+#  secret: polaris
 
   authenticator:
     class: org.apache.polaris.service.auth.TestInlineBearerTokenPolarisAuthenticator

diff --git a/polaris-core/build.gradle.kts b/polaris-core/build.gradle.kts
@@ -67,7 +67,9 @@ dependencies {
   implementation(libs.javax.inject)
   implementation(libs.swagger.annotations)
   implementation(libs.swagger.jaxrs)
+  implementation(libs.jakarta.inject.api)
   implementation(libs.jakarta.validation.api)
+  implementation(libs.smallrye)
 
   implementation("org.apache.iceberg:iceberg-aws")
   implementation(platform(libs.awssdk.bom))

diff --git a/polaris-core/src/main/java/org/apache/polaris/core/auth/PolarisAuthorizerImpl.java b/polaris-core/src/main/java/org/apache/polaris/core/auth/PolarisAuthorizerImpl.java
@@ -93,6 +93,7 @@
 import com.google.common.collect.SetMultimap;
 import jakarta.annotation.Nonnull;
 import jakarta.annotation.Nullable;
+import jakarta.inject.Inject;
 import java.util.List;
 import java.util.Set;
 import java.util.stream.Collectors;
@@ -460,6 +461,7 @@ public class PolarisAuthorizerImpl implements PolarisAuthorizer {
 
   private final PolarisConfigurationStore featureConfig;
 
+  @Inject
   public PolarisAuthorizerImpl(PolarisConfigurationStore featureConfig) {
     this.featureConfig = featureConfig;
   }

diff --git a/...rvice/config/ConfigurationStoreAware.java → ...che/polaris/core/context/RealmScoped.java b/...rvice/config/ConfigurationStoreAware.java → ...che/polaris/core/context/RealmScoped.java
@@ -16,12 +16,16 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-package org.apache.polaris.service.config;
+package org.apache.polaris.core.context;
 
-import org.apache.polaris.core.PolarisConfigurationStore;
+import jakarta.inject.Scope;
+import java.lang.annotation.Documented;
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.Target;
 
-/** Interface allows injection of a {@link PolarisConfigurationStore} */
-public interface ConfigurationStoreAware {
-
-  void setConfigurationStore(PolarisConfigurationStore configurationStore);
-}
+@Scope
+@Documented
+@Retention(java.lang.annotation.RetentionPolicy.RUNTIME)
+@Target({ElementType.TYPE, ElementType.METHOD})
+public @interface RealmScoped {}
diff --git a/polaris-core/src/main/java/org/apache/polaris/core/monitor/PolarisMetricRegistry.java b/polaris-core/src/main/java/org/apache/polaris/core/monitor/PolarisMetricRegistry.java
@@ -28,6 +28,7 @@
 import io.micrometer.core.instrument.binder.jvm.JvmMemoryMetrics;
 import io.micrometer.core.instrument.binder.jvm.JvmThreadMetrics;
 import io.micrometer.core.instrument.binder.system.ProcessorMetrics;
+import jakarta.inject.Inject;
 import java.lang.reflect.Method;
 import java.util.Collections;
 import java.util.concurrent.ConcurrentHashMap;
@@ -68,6 +69,7 @@ public class PolarisMetricRegistry {
   public static final String SUFFIX_ERROR = ".error";
   public static final String SUFFIX_REALM = ".realm";
 
+  @Inject
   public PolarisMetricRegistry(MeterRegistry meterRegistry) {
     this.meterRegistry = meterRegistry;
     new ClassLoaderMetrics().bindTo(meterRegistry);

diff --git a/...rc/main/java/org/apache/polaris/core/persistence/LocalPolarisMetaStoreManagerFactory.java b/...rc/main/java/org/apache/polaris/core/persistence/LocalPolarisMetaStoreManagerFactory.java
@@ -34,8 +34,6 @@
 import org.apache.polaris.core.entity.PolarisEntitySubType;
 import org.apache.polaris.core.entity.PolarisEntityType;
 import org.apache.polaris.core.entity.PolarisPrincipalSecrets;
-import org.apache.polaris.core.monitor.PolarisMetricRegistry;
-import org.apache.polaris.core.storage.PolarisStorageIntegrationProvider;
 import org.apache.polaris.core.storage.cache.StorageCredentialCache;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -54,8 +52,6 @@ public abstract class LocalPolarisMetaStoreManagerFactory<StoreType>
   final Map<String, Supplier<PolarisMetaStoreSession>> sessionSupplierMap = new HashMap<>();
   protected final PolarisDiagnostics diagServices = new PolarisDefaultDiagServiceImpl();
 
-  protected PolarisStorageIntegrationProvider storageIntegration;
-
   private static final Logger LOGGER =
       LoggerFactory.getLogger(LocalPolarisMetaStoreManagerFactory.class);
 
@@ -157,16 +153,6 @@ public synchronized StorageCredentialCache getOrCreateStorageCredentialCache(
     return storageCredentialCacheMap.get(realmContext.getRealmIdentifier());
   }
 
-  @Override
-  public void setMetricRegistry(PolarisMetricRegistry metricRegistry) {
-    // no-op
-  }
-
-  @Override
-  public void setStorageIntegrationProvider(PolarisStorageIntegrationProvider storageIntegration) {
-    this.storageIntegration = storageIntegration;
-  }
-
   /**
    * This method bootstraps service for a given realm: i.e. creates all the needed entities in the
    * metastore and creates a root service principal. After that we rotate the root principal

diff --git a/polaris-core/src/main/java/org/apache/polaris/core/persistence/MetaStoreManagerFactory.java b/polaris-core/src/main/java/org/apache/polaris/core/persistence/MetaStoreManagerFactory.java
@@ -18,21 +18,17 @@
  */
 package org.apache.polaris.core.persistence;
 
-import com.fasterxml.jackson.annotation.JsonTypeInfo;
 import java.util.List;
 import java.util.Map;
 import java.util.function.Supplier;
 import org.apache.polaris.core.auth.PolarisSecretsManager.PrincipalSecretsResult;
 import org.apache.polaris.core.context.RealmContext;
-import org.apache.polaris.core.monitor.PolarisMetricRegistry;
-import org.apache.polaris.core.storage.PolarisStorageIntegrationProvider;
 import org.apache.polaris.core.storage.cache.StorageCredentialCache;
 
 /**
  * Configuration interface for configuring the {@link PolarisMetaStoreManager} via Dropwizard
  * configuration
  */
-@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, include = JsonTypeInfo.As.PROPERTY, property = "type")
 public interface MetaStoreManagerFactory {
 
   PolarisMetaStoreManager getOrCreateMetaStoreManager(RealmContext realmContext);
@@ -41,10 +37,6 @@ public interface MetaStoreManagerFactory {
 
   StorageCredentialCache getOrCreateStorageCredentialCache(RealmContext realmContext);
 
-  void setStorageIntegrationProvider(PolarisStorageIntegrationProvider storageIntegrationProvider);
-
-  void setMetricRegistry(PolarisMetricRegistry metricRegistry);
-
   Map<String, PrincipalSecretsResult> bootstrapRealms(List<String> realms);
 
   /** Purge all metadata for the realms provided */

diff --git a/polaris-core/src/main/java/org/apache/polaris/core/persistence/PolarisEntityManager.java b/polaris-core/src/main/java/org/apache/polaris/core/persistence/PolarisEntityManager.java
@@ -51,11 +51,14 @@ public class PolarisEntityManager {
   /**
    * @param metaStoreManager the metastore manager for the current realm
    * @param credentialCache the storage credential cache for the current realm
+   * @param entityCache the entity cache
    */
   public PolarisEntityManager(
-      PolarisMetaStoreManager metaStoreManager, StorageCredentialCache credentialCache) {
+      PolarisMetaStoreManager metaStoreManager,
+      StorageCredentialCache credentialCache,
+      EntityCache entityCache) {
     this.metaStoreManager = metaStoreManager;
-    this.entityCache = new EntityCache(metaStoreManager);
+    this.entityCache = entityCache;
     this.credentialCache = credentialCache;
   }
 

diff --git a/polaris-core/src/main/java/org/apache/polaris/core/persistence/cache/EntityCache.java b/polaris-core/src/main/java/org/apache/polaris/core/persistence/cache/EntityCache.java
@@ -23,17 +23,20 @@
 import com.github.benmanes.caffeine.cache.RemovalListener;
 import jakarta.annotation.Nonnull;
 import jakarta.annotation.Nullable;
+import jakarta.inject.Inject;
 import java.util.AbstractMap;
 import java.util.List;
 import java.util.concurrent.ConcurrentHashMap;
 import java.util.concurrent.TimeUnit;
 import org.apache.polaris.core.PolarisCallContext;
+import org.apache.polaris.core.context.RealmScoped;
 import org.apache.polaris.core.entity.PolarisBaseEntity;
 import org.apache.polaris.core.entity.PolarisEntityType;
 import org.apache.polaris.core.entity.PolarisGrantRecord;
 import org.apache.polaris.core.persistence.cache.PolarisRemoteCache.CachedEntryResult;
 
 /** The entity cache, can be private or shared */
+@RealmScoped
 public class EntityCache {
 
   // cache mode
@@ -53,6 +56,7 @@ public class EntityCache {
    *
    * @param polarisRemoteCache the meta store manager implementation
    */
+  @Inject
   public EntityCache(@Nonnull PolarisRemoteCache polarisRemoteCache) {
 
     // by name cache

diff --git a/polaris-server.yml b/polaris-server.yml
@@ -93,17 +93,19 @@ io:
 # TODO - avoid duplicating token broker config
 oauth2:
   type: test
-#  type: default # - uncomment to support Auth0 JWT tokens
-#  tokenBroker:
-#    type: symmetric-key
-#    secret: polaris
 
 authenticator:
   class: org.apache.polaris.service.auth.TestInlineBearerTokenPolarisAuthenticator
+
+# - uncomment to support Auth0 JWT tokens
+#oauth2:
+#  type: default
+#authenticator:
 #  class: org.apache.polaris.service.auth.DefaultPolarisAuthenticator # - uncomment to support Auth0 JWT tokens
-#  tokenBroker:
-#    type: symmetric-key
-#    secret: polaris
+#
+#tokenBroker:
+#  type: symmetric-key
+#  secret: polaris
 
 cors:
   allowed-origins:
@@ -133,7 +135,7 @@ logging:
   # Logger-specific levels.
   loggers:
     org.apache.iceberg.rest: DEBUG
-    org.apache.polaris: DEBUG
+    org.apache.polaris: INFO
 
   appenders: