NoSQL: CDI / Quarkus

bom/build.gradle.kts

@@ -64,6 +64,7 @@ dependencies {
     api(project(":polaris-persistence-nosql-benchmark"))
     api(project(":polaris-persistence-nosql-correctness"))
     api(project(":polaris-persistence-nosql-cdi-common"))
+    api(project(":polaris-persistence-nosql-cdi-quarkus"))
     api(project(":polaris-persistence-nosql-cdi-quarkus-distcache"))
     api(project(":polaris-persistence-nosql-cdi-weld"))
     api(project(":polaris-persistence-nosql-standalone"))

gradle/projects.main.properties

@@ -79,6 +79,7 @@ polaris-persistence-nosql-impl=persistence/nosql/persistence/impl
 polaris-persistence-nosql-benchmark=persistence/nosql/persistence/benchmark
 polaris-persistence-nosql-correctness=persistence/nosql/persistence/correctness
 polaris-persistence-nosql-cdi-common=persistence/nosql/persistence/cdi/common
+polaris-persistence-nosql-cdi-quarkus=persistence/nosql/persistence/cdi/quarkus
 polaris-persistence-nosql-cdi-quarkus-distcache=persistence/nosql/persistence/cdi/quarkus-distcache
 polaris-persistence-nosql-cdi-weld=persistence/nosql/persistence/cdi/weld
 polaris-persistence-nosql-standalone=persistence/nosql/persistence/standalone

persistence/nosql/persistence/api/src/main/java/org/apache/polaris/persistence/nosql/api/backend/BackendConfiguration.java

@@ -25,12 +25,12 @@
 import org.apache.polaris.immutables.PolarisImmutable;
 
 /** Polaris persistence backend configuration. */
-@ConfigMapping(prefix = "polaris.persistence.backend")
+@ConfigMapping(prefix = "polaris.persistence.nosql")
 @JsonSerialize(as = ImmutableBuildableBackendConfiguration.class)
 @JsonDeserialize(as = ImmutableBuildableBackendConfiguration.class)
 public interface BackendConfiguration {
   /** Name of the persistence backend to use. */
-  Optional<String> type();
+  Optional<String> backend();
 
   @PolarisImmutable
   interface BuildableBackendConfiguration extends BackendConfiguration {
@@ -39,6 +39,6 @@ static ImmutableBuildableBackendConfiguration.Builder builder() {
     }
 
     @Override
-    Optional<String> type();
+    Optional<String> backend();
   }
 }

persistence/nosql/persistence/benchmark/NOTES.md

@@ -28,14 +28,14 @@ podman run --rm -ti \
 
 ```bash
 ./gradlew :polaris-persistence-nosql-benchmark:jmhJar && java \
-  -Dpolaris.persistence.backend.type=InMemory \
+  -Dpolaris.persistence.nosql.backend=InMemory \
   -jar persistence/benchmark/build/libs/polaris-persistence-nosql-benchmark-1.0.0-incubating-SNAPSHOT-jmh.jar
 ```
 
 ```bash
 ./gradlew :polaris-persistence-nosql-benchmark:jmhJar && java \
-  -Dpolaris.persistence.backend.type=MongoDb \
-  -Dpolaris.persistence.backend.mongodb.connection-string=mongodb://localhost:27017/ \
-  -Dpolaris.persistence.backend.mongodb.database-name=test \
+  -Dpolaris.persistence.nosql.backend=MongoDb \
+  -Dpolaris.persistence.nosql.mongodb.connection-string=mongodb://localhost:27017/ \
+  -Dpolaris.persistence.nosql.mongodb.database-name=test \
   -jar persistence/benchmark/build/libs/polaris-persistence-nosql-benchmark-1.0.0-incubating-SNAPSHOT-jmh.jar
 ```

persistence/nosql/persistence/cdi/quarkus/build.gradle.kts

@@ -0,0 +1,66 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+plugins {
+  id("org.kordamp.gradle.jandex")
+  id("polaris-server")
+}
+
+description = "Polaris NoSQL persistence, providers for Quarkus."
+
+dependencies {
+  implementation(project(":polaris-persistence-nosql-cdi-common"))
+  implementation(project(":polaris-persistence-nosql-api"))
+  implementation(project(":polaris-persistence-nosql-inmemory"))
+  implementation(project(":polaris-persistence-nosql-mongodb"))
+  implementation(project(":polaris-idgen-api"))
+  runtimeOnly(project(":polaris-nodes-impl"))
+  runtimeOnly(project(":polaris-nodes-store-nosql"))
+  runtimeOnly(project(":polaris-persistence-nosql-realms-impl"))
+  runtimeOnly(project(":polaris-persistence-nosql-realms-store-nosql"))
+  runtimeOnly(project(":polaris-async-vertx"))
+  runtimeOnly(project(":polaris-idgen-impl"))
+  runtimeOnly(project(":polaris-persistence-nosql-authz-impl"))
+  runtimeOnly(project(":polaris-persistence-nosql-authz-store-nosql"))
+
+  compileOnly(platform(libs.micrometer.bom))
+  compileOnly("io.micrometer:micrometer-core")
+  compileOnly(platform(libs.opentelemetry.instrumentation.bom.alpha))
+  compileOnly("io.opentelemetry.instrumentation:opentelemetry-instrumentation-annotations")
+
+  compileOnly(libs.smallrye.config.core)
+
+  compileOnly(project(":polaris-immutables"))
+  annotationProcessor(project(":polaris-immutables", configuration = "processor"))
+
+  implementation(platform(libs.quarkus.bom))
+  implementation("io.quarkus:quarkus-core")
+  implementation("io.quarkus:quarkus-mongodb-client")
+  runtimeOnly("io.quarkus:quarkus-micrometer")
+
+  implementation(libs.jakarta.ws.rs.api)
+
+  implementation(libs.guava)
+  implementation(libs.slf4j.api)
+
+  compileOnly(libs.jakarta.annotation.api)
+  compileOnly(libs.jakarta.validation.api)
+  compileOnly(libs.jakarta.inject.api)
+  compileOnly(libs.jakarta.enterprise.cdi.api)
+}

persistence/nosql/persistence/cdi/quarkus/src/main/java/org/apache/polaris/persistence/nosql/quarkus/backend/BackendBuilder.java

@@ -0,0 +1,25 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.apache.polaris.persistence.nosql.quarkus.backend;
+
+import org.apache.polaris.persistence.nosql.api.backend.Backend;
+
+interface BackendBuilder {
+  Backend buildBackend();
+}

persistence/nosql/persistence/cdi/quarkus/src/main/java/org/apache/polaris/persistence/nosql/quarkus/backend/BackendProvider.java

@@ -0,0 +1,105 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.apache.polaris.persistence.nosql.quarkus.backend;
+
+import static java.lang.String.format;
+
+import jakarta.enterprise.context.ApplicationScoped;
+import jakarta.enterprise.inject.Any;
+import jakarta.enterprise.inject.Instance;
+import jakarta.enterprise.inject.Produces;
+import java.util.Optional;
+import org.apache.polaris.persistence.nosql.api.backend.Backend;
+import org.apache.polaris.persistence.nosql.api.backend.BackendConfiguration;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+@ApplicationScoped
+class BackendProvider {
+  private static final Logger LOGGER = LoggerFactory.getLogger(BackendProvider.class);
+
+  @Produces
+  @ApplicationScoped
+  @NotObserved
+  Backend backend(
+      BackendConfiguration backendConfiguration, @Any Instance<BackendBuilder> backendBuilders) {
+
+    var backendName =
+        backendConfiguration
+            .backend()
+            .orElseThrow(
+                () ->
+                    new IllegalStateException(
+                        "Mandatory configuration option polaris.persistence.nosql.backend is missing!"));
+
+    var backendBuilder = backendBuilders.select(BackendType.Literal.of(backendName));
+    if (!backendBuilder.isResolvable()) {
+      throw new IllegalStateException(
+          format(
+              "Backend '%s' provided in configuration polaris.persistence.nosql.backend is not available. Available backends: %s",
+              backendName,
+              backendBuilders
+                  .handlesStream()
+                  .map(
+                      h ->
+                          h.getBean().getQualifiers().stream()
+                              .filter(q -> q instanceof BackendType)
+                              .map(BackendType.class::cast)
+                              .findFirst()
+                              .map(BackendType::value))
+                  .filter(Optional::isPresent)
+                  .map(Optional::get)
+                  .toList()));
+    }
+    if (backendBuilder.isAmbiguous()) {
+      throw new IllegalStateException(
+          format(
+              "Multiple implementations match the backend name '%s' provided in configuration polaris.persistence.nosql.backend is not available. All available backends: %s",
+              backendName,
+              backendBuilders
+                  .handlesStream()
+                  .map(
+                      h ->
+                          h.getBean().getQualifiers().stream()
+                              .filter(q -> q instanceof BackendType)
+                              .map(BackendType.class::cast)
+                              .findFirst()
+                              .map(BackendType::value))
+                  .filter(Optional::isPresent)
+                  .map(Optional::get)
+                  .toList()));
+    }
+    var builder = backendBuilder.get();
+
+    var backend = builder.buildBackend();
+    try {
+      var setupSchemaResult = backend.setupSchema().orElse("");
+      LOGGER.info("Opened new persistence backend '{}' {}", backend.type(), setupSchemaResult);
+
+      return builder.buildBackend();
+    } catch (Exception e) {
+      try {
+        backend.close();
+      } catch (Exception e2) {
+        e.addSuppressed(e2);
+      }
+      throw e;
+    }
+  }
+}

persistence/nosql/persistence/cdi/quarkus/src/main/java/org/apache/polaris/persistence/nosql/quarkus/backend/BackendType.java

@@ -0,0 +1,59 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.apache.polaris.persistence.nosql.quarkus.backend;
+
+import static java.lang.annotation.ElementType.FIELD;
+import static java.lang.annotation.ElementType.METHOD;
+import static java.lang.annotation.ElementType.PARAMETER;
+import static java.lang.annotation.ElementType.TYPE;
+import static java.lang.annotation.RetentionPolicy.RUNTIME;
+
+import jakarta.enterprise.util.AnnotationLiteral;
+import jakarta.inject.Qualifier;
+import java.lang.annotation.Documented;
+import java.lang.annotation.Retention;
+import java.lang.annotation.Target;
+
+@Target({TYPE, METHOD, PARAMETER, FIELD})
+@Retention(RUNTIME)
+@Documented
+@Qualifier
+public @interface BackendType {
+  /** Gets the store type. */
+  String value();
+
+  /** Supports inline instantiation of the {@link BackendType} qualifier. */
+  final class Literal extends AnnotationLiteral<BackendType> implements BackendType {
+
+    private final String value;
+
+    private Literal(String value) {
+      this.value = value;
+    }
+
+    public static Literal of(String value) {
+      return new Literal(value);
+    }
+
+    @Override
+    public String value() {
+      return value;
+    }
+  }
+}

persistence/nosql/persistence/cdi/quarkus/src/main/java/org/apache/polaris/persistence/nosql/quarkus/backend/InMemoryBackendBuilder.java

@@ -0,0 +1,34 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.apache.polaris.persistence.nosql.quarkus.backend;
+
+import jakarta.enterprise.context.ApplicationScoped;
+import org.apache.polaris.persistence.nosql.api.backend.Backend;
+import org.apache.polaris.persistence.nosql.inmemory.InMemoryBackendFactory;
+import org.apache.polaris.persistence.nosql.inmemory.InMemoryConfiguration;
+
+@BackendType(InMemoryBackendFactory.NAME)
+@ApplicationScoped
+class InMemoryBackendBuilder implements BackendBuilder {
+  @Override
+  public Backend buildBackend() {
+    var factory = new InMemoryBackendFactory();
+    return factory.buildBackend(factory.buildConfiguration(new InMemoryConfiguration() {}));
+  }
+}