Mark CallableProcedure as forbidden

knutwalker · jjaderberg · commit 280182364fd3 · 2022-11-28T16:40:25.000+01:00
diff --git a/compatibility/4.3/neo4j-kernel-adapter/src/main/java/org/neo4j/gds/compat/_43/CallableProcedureImpl.java b/compatibility/4.3/neo4j-kernel-adapter/src/main/java/org/neo4j/gds/compat/_43/CallableProcedureImpl.java
@@ -20,6 +20,7 @@
 package org.neo4j.gds.compat._43;
 
 import org.neo4j.collection.RawIterator;
+import org.neo4j.gds.annotation.SuppressForbidden;
 import org.neo4j.gds.compat.CompatCallableProcedure;
 import org.neo4j.internal.kernel.api.exceptions.ProcedureException;
 import org.neo4j.internal.kernel.api.procs.ProcedureSignature;
@@ -28,6 +29,7 @@
 import org.neo4j.kernel.api.procedure.Context;
 import org.neo4j.values.AnyValue;
 
+@SuppressForbidden(reason = "This is the compat API")
 public final class CallableProcedureImpl implements CallableProcedure {
     private final CompatCallableProcedure procedure;
 
diff --git a/compatibility/4.3/neo4j-kernel-adapter/src/main/java/org/neo4j/gds/compat/_43/Neo4jProxyImpl.java b/compatibility/4.3/neo4j-kernel-adapter/src/main/java/org/neo4j/gds/compat/_43/Neo4jProxyImpl.java
@@ -752,6 +752,7 @@ public UserFunctionSignature userFunctionSignature(
     }
 
     @Override
+    @SuppressForbidden(reason = "This is the compat API")
     public CallableProcedure callableProcedure(CompatCallableProcedure procedure) {
         return new CallableProcedureImpl(procedure);
     }
diff --git a/compatibility/4.4/neo4j-kernel-adapter/src/main/java/org/neo4j/gds/compat/_44/CallableProcedureImpl.java b/compatibility/4.4/neo4j-kernel-adapter/src/main/java/org/neo4j/gds/compat/_44/CallableProcedureImpl.java
@@ -20,6 +20,7 @@
 package org.neo4j.gds.compat._44;
 
 import org.neo4j.collection.RawIterator;
+import org.neo4j.gds.annotation.SuppressForbidden;
 import org.neo4j.gds.compat.CompatCallableProcedure;
 import org.neo4j.internal.kernel.api.exceptions.ProcedureException;
 import org.neo4j.internal.kernel.api.procs.ProcedureSignature;
@@ -28,6 +29,7 @@
 import org.neo4j.kernel.api.procedure.Context;
 import org.neo4j.values.AnyValue;
 
+@SuppressForbidden(reason = "This is the compat API")
 public final class CallableProcedureImpl implements CallableProcedure {
     private final CompatCallableProcedure procedure;
 
diff --git a/compatibility/4.4/neo4j-kernel-adapter/src/main/java/org/neo4j/gds/compat/_44/Neo4jProxyImpl.java b/compatibility/4.4/neo4j-kernel-adapter/src/main/java/org/neo4j/gds/compat/_44/Neo4jProxyImpl.java
@@ -755,6 +755,7 @@ public UserFunctionSignature userFunctionSignature(
     }
 
     @Override
+    @SuppressForbidden(reason = "This is the compat API")
     public CallableProcedure callableProcedure(CompatCallableProcedure procedure) {
         return new CallableProcedureImpl(procedure);
     }
diff --git a/compatibility/5.1/neo4j-kernel-adapter/src/main/java17/org/neo4j/gds/compat/_51/CallableProcedureImpl.java b/compatibility/5.1/neo4j-kernel-adapter/src/main/java17/org/neo4j/gds/compat/_51/CallableProcedureImpl.java
@@ -20,6 +20,7 @@
 package org.neo4j.gds.compat._51;
 
 import org.neo4j.collection.RawIterator;
+import org.neo4j.gds.annotation.SuppressForbidden;
 import org.neo4j.gds.compat.CompatCallableProcedure;
 import org.neo4j.internal.kernel.api.exceptions.ProcedureException;
 import org.neo4j.internal.kernel.api.procs.ProcedureSignature;
@@ -28,6 +29,7 @@
 import org.neo4j.kernel.api.procedure.Context;
 import org.neo4j.values.AnyValue;
 
+@SuppressForbidden(reason = "This is the compat API")
 public final class CallableProcedureImpl implements CallableProcedure {
     private final CompatCallableProcedure procedure;
 
diff --git a/compatibility/5.1/neo4j-kernel-adapter/src/main/java17/org/neo4j/gds/compat/_51/Neo4jProxyImpl.java b/compatibility/5.1/neo4j-kernel-adapter/src/main/java17/org/neo4j/gds/compat/_51/Neo4jProxyImpl.java
@@ -882,6 +882,7 @@ public long transactionId(KernelTransactionHandle kernelTransactionHandle) {
     }
 
     @Override
+    @SuppressForbidden(reason = "This is the compat API")
     public CallableProcedure callableProcedure(CompatCallableProcedure procedure) {
         return new CallableProcedureImpl(procedure);
     }
diff --git a/compatibility/5.2/neo4j-kernel-adapter/src/main/java17/org/neo4j/gds/compat/_52/CallableProcedureImpl.java b/compatibility/5.2/neo4j-kernel-adapter/src/main/java17/org/neo4j/gds/compat/_52/CallableProcedureImpl.java
@@ -20,6 +20,7 @@
 package org.neo4j.gds.compat._52;
 
 import org.neo4j.collection.RawIterator;
+import org.neo4j.gds.annotation.SuppressForbidden;
 import org.neo4j.gds.compat.CompatCallableProcedure;
 import org.neo4j.internal.kernel.api.exceptions.ProcedureException;
 import org.neo4j.internal.kernel.api.procs.ProcedureSignature;
@@ -28,6 +29,7 @@
 import org.neo4j.kernel.api.procedure.Context;
 import org.neo4j.values.AnyValue;
 
+@SuppressForbidden(reason = "This is the compat API")
 public final class CallableProcedureImpl implements CallableProcedure {
     private final CompatCallableProcedure procedure;
 
diff --git a/compatibility/5.2/neo4j-kernel-adapter/src/main/java17/org/neo4j/gds/compat/_52/Neo4jProxyImpl.java b/compatibility/5.2/neo4j-kernel-adapter/src/main/java17/org/neo4j/gds/compat/_52/Neo4jProxyImpl.java
@@ -875,6 +875,7 @@ public UserFunctionSignature userFunctionSignature(
     }
 
     @Override
+    @SuppressForbidden(reason = "This is the compat API")
     public CallableProcedure callableProcedure(CompatCallableProcedure procedure) {
         return new CallableProcedureImpl(procedure);
     }
diff --git a/compatibility/api/neo4j-kernel-adapter/src/main/java/org/neo4j/gds/compat/Neo4jProxyApi.java b/compatibility/api/neo4j-kernel-adapter/src/main/java/org/neo4j/gds/compat/Neo4jProxyApi.java
@@ -25,6 +25,7 @@
 import org.neo4j.configuration.connectors.ConnectorPortRegister;
 import org.neo4j.dbms.api.DatabaseManagementService;
 import org.neo4j.exceptions.KernelException;
+import org.neo4j.gds.annotation.SuppressForbidden;
 import org.neo4j.graphdb.GraphDatabaseService;
 import org.neo4j.graphdb.Node;
 import org.neo4j.graphdb.Relationship;
@@ -294,6 +295,7 @@ UserFunctionSignature userFunctionSignature(
         boolean threadSafe
     );
 
+    @SuppressForbidden(reason = "This is the compat API")
     CallableProcedure callableProcedure(CompatCallableProcedure procedure);
 
     long transactionId(KernelTransactionHandle kernelTransactionHandle);
diff --git a/compatibility/common/neo4j-kernel-adapter/src/main/java/org/neo4j/gds/compat/Neo4jProxy.java b/compatibility/common/neo4j-kernel-adapter/src/main/java/org/neo4j/gds/compat/Neo4jProxy.java
@@ -25,6 +25,7 @@
 import org.neo4j.configuration.connectors.ConnectorPortRegister;
 import org.neo4j.dbms.api.DatabaseManagementService;
 import org.neo4j.exceptions.KernelException;
+import org.neo4j.gds.annotation.SuppressForbidden;
 import org.neo4j.graphdb.GraphDatabaseService;
 import org.neo4j.graphdb.Node;
 import org.neo4j.graphdb.Relationship;
@@ -442,6 +443,7 @@ public static UserFunctionSignature userFunctionSignature(
         return IMPL.userFunctionSignature(name, inputSignature, type, description, internal, threadSafe);
     }
 
+    @SuppressForbidden(reason = "This is the compat API")
     public static CallableProcedure callableProcedure(CompatCallableProcedure procedure) {
         return IMPL.callableProcedure(procedure);
     }
diff --git a/etc/forbidden-apis b/etc/forbidden-apis
@@ -12,3 +12,5 @@ org.neo4j.configuration.SettingImpl#newBuilder(java.lang.String, org.neo4j.confi
 org.neo4j.configuration.SettingBuilder(java.lang.String, org.neo4j.configuration.SettingValueParser, java.lang.Object) @ Use SettingProxy#newBuilder instead.
 
 java.util.ServiceLoader#load(java.lang.Class) @ Must pass explicit class loader with service loading, as the context class loader for the thread may be the wrong one
+
+org.neo4j.kernel.api.procedure.CallableProcedure @ Implement org.neo4j.gds.compat.CompatCallableProcedure instead and call Neo4jProxy.callableProcedure(compat).

Original file line number	Diff line number	Diff line change
`@@ -752,6 +752,7 @@ public UserFunctionSignature userFunctionSignature(`
`752`	`752`	`}`
`753`	`753`
`754`	`754`	`@Override`
	`755`	`+ @SuppressForbidden(reason = "This is the compat API")`
`755`	`756`	`public CallableProcedure callableProcedure(CompatCallableProcedure procedure) {`
`756`	`757`	`return new CallableProcedureImpl(procedure);`
`757`	`758`	`}`
Original file line number	Diff line number	Diff line change
`@@ -755,6 +755,7 @@ public UserFunctionSignature userFunctionSignature(`
`755`	`755`	`}`
`756`	`756`
`757`	`757`	`@Override`
	`758`	`+ @SuppressForbidden(reason = "This is the compat API")`
`758`	`759`	`public CallableProcedure callableProcedure(CompatCallableProcedure procedure) {`
`759`	`760`	`return new CallableProcedureImpl(procedure);`
`760`	`761`	`}`
Original file line number	Diff line number	Diff line change
`@@ -882,6 +882,7 @@ public long transactionId(KernelTransactionHandle kernelTransactionHandle) {`
`882`	`882`	`}`
`883`	`883`
`884`	`884`	`@Override`
	`885`	`+ @SuppressForbidden(reason = "This is the compat API")`
`885`	`886`	`public CallableProcedure callableProcedure(CompatCallableProcedure procedure) {`
`886`	`887`	`return new CallableProcedureImpl(procedure);`
`887`	`888`	`}`
Original file line number	Diff line number	Diff line change
`@@ -875,6 +875,7 @@ public UserFunctionSignature userFunctionSignature(`
`875`	`875`	`}`
`876`	`876`
`877`	`877`	`@Override`
	`878`	`+ @SuppressForbidden(reason = "This is the compat API")`
`878`	`879`	`public CallableProcedure callableProcedure(CompatCallableProcedure procedure) {`
`879`	`880`	`return new CallableProcedureImpl(procedure);`
`880`	`881`	`}`
Original file line number	Diff line number	Diff line change
`@@ -25,6 +25,7 @@`
`25`	`25`	`import org.neo4j.configuration.connectors.ConnectorPortRegister;`
`26`	`26`	`import org.neo4j.dbms.api.DatabaseManagementService;`
`27`	`27`	`import org.neo4j.exceptions.KernelException;`
	`28`	`+import org.neo4j.gds.annotation.SuppressForbidden;`
`28`	`29`	`import org.neo4j.graphdb.GraphDatabaseService;`
`29`	`30`	`import org.neo4j.graphdb.Node;`
`30`	`31`	`import org.neo4j.graphdb.Relationship;`
`@@ -442,6 +443,7 @@ public static UserFunctionSignature userFunctionSignature(`
`442`	`443`	`return IMPL.userFunctionSignature(name, inputSignature, type, description, internal, threadSafe);`
`443`	`444`	`}`
`444`	`445`
	`446`	`+ @SuppressForbidden(reason = "This is the compat API")`
`445`	`447`	`public static CallableProcedure callableProcedure(CompatCallableProcedure procedure) {`
`446`	`448`	`return IMPL.callableProcedure(procedure);`
`447`	`449`	`}`