Move JPA types to separate module (#500)

`polaris-core` should be rather generic and not depend on JPA per se, so moving the types to a new module + package.
apache · Nov 29, 2024 · aee3a02 · aee3a02
1 parent a6197bd
commit aee3a02
Show file tree

Hide file tree

Showing 18 changed files with 79 additions and 49 deletions.
diff --git a/extension/persistence/eclipselink/build.gradle.kts b/extension/persistence/eclipselink/build.gradle.kts
@@ -29,6 +29,7 @@ plugins {
 
 dependencies {
   implementation(project(":polaris-core"))
+  implementation(project(":polaris-jpa-model"))
   implementation(libs.eclipselink)
   implementation(platform(libs.dropwizard.bom))
   implementation("io.dropwizard:dropwizard-jackson")

diff --git a/...olaris/extension/persistence/impl/eclipselink/PolarisEclipseLinkMetaStoreSessionImpl.java b/...olaris/extension/persistence/impl/eclipselink/PolarisEclipseLinkMetaStoreSessionImpl.java
@@ -68,14 +68,14 @@
 import org.apache.polaris.core.persistence.PolarisMetaStoreSession;
 import org.apache.polaris.core.persistence.PrincipalSecretsGenerator;
 import org.apache.polaris.core.persistence.RetryOnConcurrencyException;
-import org.apache.polaris.core.persistence.models.ModelEntity;
-import org.apache.polaris.core.persistence.models.ModelEntityActive;
-import org.apache.polaris.core.persistence.models.ModelEntityChangeTracking;
-import org.apache.polaris.core.persistence.models.ModelGrantRecord;
-import org.apache.polaris.core.persistence.models.ModelPrincipalSecrets;
 import org.apache.polaris.core.storage.PolarisStorageConfigurationInfo;
 import org.apache.polaris.core.storage.PolarisStorageIntegration;
 import org.apache.polaris.core.storage.PolarisStorageIntegrationProvider;
+import org.apache.polaris.jpa.models.ModelEntity;
+import org.apache.polaris.jpa.models.ModelEntityActive;
+import org.apache.polaris.jpa.models.ModelEntityChangeTracking;
+import org.apache.polaris.jpa.models.ModelGrantRecord;
+import org.apache.polaris.jpa.models.ModelPrincipalSecrets;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.w3c.dom.Document;

diff --git a/...va/org/apache/polaris/extension/persistence/impl/eclipselink/PolarisEclipseLinkStore.java b/...va/org/apache/polaris/extension/persistence/impl/eclipselink/PolarisEclipseLinkStore.java
@@ -35,12 +35,12 @@
 import org.apache.polaris.core.entity.PolarisEntityType;
 import org.apache.polaris.core.entity.PolarisGrantRecord;
 import org.apache.polaris.core.entity.PolarisPrincipalSecrets;
-import org.apache.polaris.core.persistence.models.ModelEntity;
-import org.apache.polaris.core.persistence.models.ModelEntityActive;
-import org.apache.polaris.core.persistence.models.ModelEntityChangeTracking;
-import org.apache.polaris.core.persistence.models.ModelEntityDropped;
-import org.apache.polaris.core.persistence.models.ModelGrantRecord;
-import org.apache.polaris.core.persistence.models.ModelPrincipalSecrets;
+import org.apache.polaris.jpa.models.ModelEntity;
+import org.apache.polaris.jpa.models.ModelEntityActive;
+import org.apache.polaris.jpa.models.ModelEntityChangeTracking;
+import org.apache.polaris.jpa.models.ModelEntityDropped;
+import org.apache.polaris.jpa.models.ModelGrantRecord;
+import org.apache.polaris.jpa.models.ModelPrincipalSecrets;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 

diff --git a/...n/java/org/apache/polaris/extension/persistence/impl/eclipselink/PolarisSequenceUtil.java b/...n/java/org/apache/polaris/extension/persistence/impl/eclipselink/PolarisSequenceUtil.java
@@ -21,7 +21,7 @@
 import jakarta.persistence.*;
 import java.util.Optional;
 import java.util.concurrent.atomic.AtomicBoolean;
-import org.apache.polaris.core.persistence.models.ModelSequenceId;
+import org.apache.polaris.jpa.models.ModelSequenceId;
 import org.eclipse.persistence.internal.jpa.EntityManagerImpl;
 import org.eclipse.persistence.platform.database.DatabasePlatform;
 import org.eclipse.persistence.platform.database.PostgreSQLPlatform;

diff --git a/extension/persistence/eclipselink/src/main/resources/META-INF/persistence.xml b/extension/persistence/eclipselink/src/main/resources/META-INF/persistence.xml
@@ -25,13 +25,13 @@
 
   <persistence-unit name="polaris" transaction-type="RESOURCE_LOCAL">
     <provider>org.eclipse.persistence.jpa.PersistenceProvider</provider>
-    <class>org.apache.polaris.core.persistence.models.ModelEntity</class>
-    <class>org.apache.polaris.core.persistence.models.ModelEntityActive</class>
-    <class>org.apache.polaris.core.persistence.models.ModelEntityChangeTracking</class>
-    <class>org.apache.polaris.core.persistence.models.ModelEntityDropped</class>
-    <class>org.apache.polaris.core.persistence.models.ModelGrantRecord</class>
-    <class>org.apache.polaris.core.persistence.models.ModelPrincipalSecrets</class>
-    <class>org.apache.polaris.core.persistence.models.ModelSequenceId</class>
+    <class>org.apache.polaris.jpa.models.ModelEntity</class>
+    <class>org.apache.polaris.jpa.models.ModelEntityActive</class>
+    <class>org.apache.polaris.jpa.models.ModelEntityChangeTracking</class>
+    <class>org.apache.polaris.jpa.models.ModelEntityDropped</class>
+    <class>org.apache.polaris.jpa.models.ModelGrantRecord</class>
+    <class>org.apache.polaris.jpa.models.ModelPrincipalSecrets</class>
+    <class>org.apache.polaris.jpa.models.ModelSequenceId</class>
     <shared-cache-mode>NONE</shared-cache-mode>
     <properties>
       <property name="jakarta.persistence.jdbc.url"

diff --git a/...olaris/extension/persistence/impl/eclipselink/PolarisEclipseLinkMetaStoreManagerTest.java b/...olaris/extension/persistence/impl/eclipselink/PolarisEclipseLinkMetaStoreManagerTest.java
@@ -35,7 +35,7 @@
 import org.apache.polaris.core.persistence.BasePolarisMetaStoreManagerTest;
 import org.apache.polaris.core.persistence.PolarisMetaStoreManagerImpl;
 import org.apache.polaris.core.persistence.PolarisTestMetaStoreManager;
-import org.apache.polaris.core.persistence.models.ModelPrincipalSecrets;
+import org.apache.polaris.jpa.models.ModelPrincipalSecrets;
 import org.junit.jupiter.api.Assertions;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.ExtensionContext;

diff --git a/extension/persistence/jpa-model/build.gradle.kts b/extension/persistence/jpa-model/build.gradle.kts
@@ -0,0 +1,29 @@
+/*
+ * 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("java-library")
+}
+
+dependencies {
+  implementation(project(":polaris-core"))
+  compileOnly(libs.jakarta.validation.api)
+  compileOnly(libs.jakarta.annotation.api)
+  compileOnly(libs.jakarta.persistence.api)
+}
diff --git a/.../core/persistence/models/ModelEntity.java → ...pache/polaris/jpa/models/ModelEntity.java b/.../core/persistence/models/ModelEntity.java → ...pache/polaris/jpa/models/ModelEntity.java
@@ -16,7 +16,7 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-package org.apache.polaris.core.persistence.models;
+package org.apache.polaris.jpa.models;
 
 import jakarta.persistence.Column;
 import jakarta.persistence.Entity;

diff --git a/...persistence/models/ModelEntityActive.java → ...polaris/jpa/models/ModelEntityActive.java b/...persistence/models/ModelEntityActive.java → ...polaris/jpa/models/ModelEntityActive.java
@@ -16,7 +16,7 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-package org.apache.polaris.core.persistence.models;
+package org.apache.polaris.jpa.models;
 
 import jakarta.persistence.Entity;
 import jakarta.persistence.Id;

diff --git a/...nce/models/ModelEntityChangeTracking.java → ...jpa/models/ModelEntityChangeTracking.java b/...nce/models/ModelEntityChangeTracking.java → ...jpa/models/ModelEntityChangeTracking.java
@@ -16,7 +16,7 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-package org.apache.polaris.core.persistence.models;
+package org.apache.polaris.jpa.models;
 
 import jakarta.persistence.Entity;
 import jakarta.persistence.Id;

diff --git a/...ersistence/models/ModelEntityDropped.java → ...olaris/jpa/models/ModelEntityDropped.java b/...ersistence/models/ModelEntityDropped.java → ...olaris/jpa/models/ModelEntityDropped.java
@@ -16,7 +16,7 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-package org.apache.polaris.core.persistence.models;
+package org.apache.polaris.jpa.models;
 
 import jakarta.persistence.Entity;
 import jakarta.persistence.Id;

diff --git a/.../persistence/models/ModelGrantRecord.java → .../polaris/jpa/models/ModelGrantRecord.java b/.../persistence/models/ModelGrantRecord.java → .../polaris/jpa/models/ModelGrantRecord.java
@@ -16,7 +16,7 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-package org.apache.polaris.core.persistence.models;
+package org.apache.polaris.jpa.models;
 
 import jakarta.persistence.Entity;
 import jakarta.persistence.Id;

diff --git a/...istence/models/ModelPrincipalSecrets.java → ...ris/jpa/models/ModelPrincipalSecrets.java b/...istence/models/ModelPrincipalSecrets.java → ...ris/jpa/models/ModelPrincipalSecrets.java
@@ -16,7 +16,7 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-package org.apache.polaris.core.persistence.models;
+package org.apache.polaris.jpa.models;
 
 import jakarta.persistence.Entity;
 import jakarta.persistence.Id;

diff --git a/...e/persistence/models/ModelSequenceId.java → ...e/polaris/jpa/models/ModelSequenceId.java b/...e/persistence/models/ModelSequenceId.java → ...e/polaris/jpa/models/ModelSequenceId.java
@@ -16,7 +16,7 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-package org.apache.polaris.core.persistence.models;
+package org.apache.polaris.jpa.models;
 
 import jakarta.persistence.Entity;
 import jakarta.persistence.GeneratedValue;

diff --git a/gradle/projects.main.properties b/gradle/projects.main.properties
@@ -21,4 +21,5 @@
 polaris-core=polaris-core
 polaris-service=polaris-service
 polaris-eclipselink=extension/persistence/eclipselink
+polaris-jpa-model=extension/persistence/jpa-model
 aggregated-license-report=aggregated-license-report
diff --git a/helm/polaris/ci/fixtures/persistence.yaml b/helm/polaris/ci/fixtures/persistence.yaml
@@ -29,13 +29,13 @@ stringData:
       xsi:schemaLocation="http://java.sun.com/xml/ns/persistence http://java.sun.com/xml/ns/persistence/persistence_2_0.xsd">
       <persistence-unit name="polaris" transaction-type="RESOURCE_LOCAL">
         <provider>org.eclipse.persistence.jpa.PersistenceProvider</provider>
-        <class>org.apache.polaris.core.persistence.models.ModelEntity</class>
-        <class>org.apache.polaris.core.persistence.models.ModelEntityActive</class>
-        <class>org.apache.polaris.core.persistence.models.ModelEntityChangeTracking</class>
-        <class>org.apache.polaris.core.persistence.models.ModelEntityDropped</class>
-        <class>org.apache.polaris.core.persistence.models.ModelGrantRecord</class>
-        <class>org.apache.polaris.core.persistence.models.ModelPrincipalSecrets</class>
-        <class>org.apache.polaris.core.persistence.models.ModelSequenceId</class>
+        <class>org.apache.polaris.jpa.models.ModelEntity</class>
+        <class>org.apache.polaris.jpa.models.ModelEntityActive</class>
+        <class>org.apache.polaris.jpa.models.ModelEntityChangeTracking</class>
+        <class>org.apache.polaris.jpa.models.ModelEntityDropped</class>
+        <class>org.apache.polaris.jpa.models.ModelGrantRecord</class>
+        <class>org.apache.polaris.jpa.models.ModelPrincipalSecrets</class>
+        <class>org.apache.polaris.jpa.models.ModelSequenceId</class>
         <shared-cache-mode>NONE</shared-cache-mode>
         <properties>
           <property name="jakarta.persistence.jdbc.url" value="jdbc:h2:mem:polaris-{realm}"/>

diff --git a/polaris-core/build.gradle.kts b/polaris-core/build.gradle.kts
@@ -110,7 +110,6 @@ dependencies {
   testFixturesApi(libs.jakarta.annotation.api)
 
   compileOnly(libs.jakarta.annotation.api)
-  compileOnly(libs.jakarta.persistence.api)
 }
 
 openApiValidate { inputSpec = "$rootDir/spec/polaris-management-service.yml" }

diff --git a/site/content/in-dev/unreleased/metastores.md b/site/content/in-dev/unreleased/metastores.md
@@ -53,13 +53,13 @@ Polaris creates and connects to a separate database for each realm. Specifically
 ```xml
 <persistence-unit name="polaris" transaction-type="RESOURCE_LOCAL">
     <provider>org.eclipse.persistence.jpa.PersistenceProvider</provider>
-    <class>org.apache.polaris.core.persistence.models.ModelEntity</class>
-    <class>org.apache.polaris.core.persistence.models.ModelEntityActive</class>
-    <class>org.apache.polaris.core.persistence.models.ModelEntityChangeTracking</class>
-    <class>org.apache.polaris.core.persistence.models.ModelEntityDropped</class>
-    <class>org.apache.polaris.core.persistence.models.ModelGrantRecord</class>
-    <class>org.apache.polaris.core.persistence.models.ModelPrincipalSecrets</class>
-    <class>org.apache.polaris.core.persistence.models.ModelSequenceId</class>
+    <class>org.apache.polaris.jpa.models.ModelEntity</class>
+    <class>org.apache.polaris.jpa.models.ModelEntityActive</class>
+    <class>org.apache.polaris.jpa.models.ModelEntityChangeTracking</class>
+    <class>org.apache.polaris.jpa.models.ModelEntityDropped</class>
+    <class>org.apache.polaris.jpa.models.ModelGrantRecord</class>
+    <class>org.apache.polaris.jpa.models.ModelPrincipalSecrets</class>
+    <class>org.apache.polaris.jpa.models.ModelSequenceId</class>
     <shared-cache-mode>NONE</shared-cache-mode>
     <properties>
       <property name="jakarta.persistence.jdbc.url"
@@ -86,13 +86,13 @@ The following shows a sample configuration for integrating Polaris with Postgres
 ```xml
 <persistence-unit name="polaris" transaction-type="RESOURCE_LOCAL">
   <provider>org.eclipse.persistence.jpa.PersistenceProvider</provider>
-  <class>org.apache.polaris.core.persistence.models.ModelEntity</class>
-  <class>org.apache.polaris.core.persistence.models.ModelEntityActive</class>
-  <class>org.apache.polaris.core.persistence.models.ModelEntityChangeTracking</class>
-  <class>org.apache.polaris.core.persistence.models.ModelEntityDropped</class>
-  <class>org.apache.polaris.core.persistence.models.ModelGrantRecord</class>
-  <class>org.apache.polaris.core.persistence.models.ModelPrincipalSecrets</class>
-  <class>org.apache.polaris.core.persistence.models.ModelSequenceId</class>
+  <class>org.apache.polaris.jpa.models.ModelEntity</class>
+  <class>org.apache.polaris.jpa.models.ModelEntityActive</class>
+  <class>org.apache.polaris.jpa.models.ModelEntityChangeTracking</class>
+  <class>org.apache.polaris.jpa.models.ModelEntityDropped</class>
+  <class>org.apache.polaris.jpa.models.ModelGrantRecord</class>
+  <class>org.apache.polaris.jpa.models.ModelPrincipalSecrets</class>
+  <class>org.apache.polaris.jpa.models.ModelSequenceId</class>
   <shared-cache-mode>NONE</shared-cache-mode>
   <properties>
     <property name="jakarta.persistence.jdbc.url"