dan/per-11891-add-proxy-facts-to-java-sdk (#31)

danyi1212 · ankmish14 · web-flow · commit 59a59004b9a9 · 2025-02-26T12:57:20.000+02:00
* Add support for proxy facts via PDP

* Add support for proxy facts via PDP

* Added proxy facts urls to all facts APIs

---------

Co-authored-by: Mishra &lt;anmishra@navan.com&gt;
diff --git a/src/main/java/io/permit/sdk/PermitConfig.java b/src/main/java/io/permit/sdk/PermitConfig.java
@@ -12,6 +12,8 @@ public class PermitConfig {
     private final String opa;
     private final String apiUrl;
     private final Boolean debugMode;
+    private final Boolean proxyFactsViaPdp;
+    private final int factsSyncTimeout;
 
     // logger config
     private final String logLevel;
@@ -45,6 +47,8 @@ private PermitConfig(Builder builder) {
         this.defaultTenant = builder.defaultTenant;
         this.useDefaultTenantIfEmpty = builder.useDefaultTenantIfEmpty;
         this.context = builder.context;
+        this.proxyFactsViaPdp = builder.proxyFactsViaPdp;
+        this.factsSyncTimeout = builder.factsSyncTimeout;
         String runtimeVersion = Permit.class.getPackage().getImplementationVersion();
         this.version = (runtimeVersion == null) ? defaultVersion : runtimeVersion;
     }
@@ -95,6 +99,24 @@ public Boolean isDebugMode() {
         return debugMode;
     }
 
+    /**
+     * Returns whether the facts via the PDP API instead of using the default Permit REST API
+     *
+     * @return {@code true} if proxying facts via the PDP is enabled, {@code false} otherwise.
+     */
+    public Boolean isProxyFactsViaPdp() {
+        return proxyFactsViaPdp;
+    }
+
+    /**
+     * Returns the timeout for facts synchronization.
+     *
+     * @return The facts synchronization timeout.
+     */
+    public int getFactsSyncTimeout() {
+        return factsSyncTimeout;
+    }
+
     /**
      * Returns the log level configured for the Permit SDK Logger.
      *
@@ -208,6 +230,8 @@ public static class Builder {
         private String opa = "http://localhost:8181";
         private String apiUrl = "https://api.permit.io";
         private Boolean debugMode = false;
+        private Boolean proxyFactsViaPdp = false;
+        private int factsSyncTimeout = 0;
 
         // logger config
         private String logLevel = "info";
@@ -279,6 +303,28 @@ public Builder withDebugMode(Boolean debugMode) {
             return this;
         }
 
+        /**
+         * Configures whether the SDK should proxy facts via the PDP API instead of using the default Permit REST API.
+         *
+         * @param proxyFactsViaPdp The proxy facts via PDP mode to be set.
+         * @return The updated {@code Builder} object.
+         */
+        public Builder withProxyFactsViaPdp(Boolean proxyFactsViaPdp) {
+            this.proxyFactsViaPdp = proxyFactsViaPdp;
+            return this;
+        }
+
+        /**
+         * Configures the timeout for facts synchronization.
+         *
+         * @param factsSyncTimeout The facts synchronization timeout to be set.
+         * @return The updated {@code Builder} object.
+         */
+        public Builder withFactsSyncTimeout(int factsSyncTimeout) {
+            this.factsSyncTimeout = factsSyncTimeout;
+            return this;
+        }
+
         /**
          * Sets the log level configured for the Permit SDK Logger.
          *
diff --git a/src/main/java/io/permit/sdk/api/BaseApi.java b/src/main/java/io/permit/sdk/api/BaseApi.java
@@ -26,11 +26,15 @@ protected BaseApi(OkHttpClient client, PermitConfig config, Logger logger) {
         this.client = client;
         this.config = config;
         this.logger = logger;
-        this.headers = new Headers.Builder()
+        Headers.Builder headersBuilder = new Headers.Builder()
             .add("Content-Type", "application/json")
             .add("Authorization", String.format("Bearer %s", this.config.getToken()))
-            .add("X-Permit-SDK-Version", String.format("java:%s", this.config.version))
-            .build();
+            .add("X-Permit-SDK-Version", String.format("java:%s", this.config.version));
+
+        if (config.isProxyFactsViaPdp() && config.getFactsSyncTimeout() > 0) {
+            headersBuilder.add("X-Wait-Timeout", String.valueOf(config.getFactsSyncTimeout()));
+        }
+        this.headers = headersBuilder.build();
     }
 
     protected <T> T callApiAndParseJson(Request request, Class<T> modelClass) throws IOException, PermitApiError {
@@ -86,6 +90,10 @@ protected String buildUrl(String relativeUrl) {
         return String.format("%s%s", config.getApiUrl(), relativeUrl);
     }
 
+    protected String buildPdpUrl(String relativeUrl) {
+        return String.format("%s%s", config.getPdpAddress(), relativeUrl);
+    }
+
     protected Request buildRequest(Request.Builder builder) {
         return builder.headers(this.headers).build();
     }
diff --git a/src/main/java/io/permit/sdk/api/RelationshipTuplesApi.java b/src/main/java/io/permit/sdk/api/RelationshipTuplesApi.java
@@ -4,11 +4,12 @@
 import io.permit.sdk.ApiContextLevel;
 import io.permit.sdk.ApiKeyLevel;
 import io.permit.sdk.PermitConfig;
-import io.permit.sdk.openapi.models.*;
+import io.permit.sdk.openapi.models.RelationshipTupleCreate;
+import io.permit.sdk.openapi.models.RelationshipTupleDelete;
+import io.permit.sdk.openapi.models.RelationshipTupleRead;
 import okhttp3.*;
 import org.slf4j.LoggerFactory;
 import java.io.IOException;
-import java.util.List;
 import java.util.Objects;
 
 interface IRelationshipTuplesApi {
@@ -41,14 +42,23 @@ public RelationshipTuplesApi(OkHttpClient client, PermitConfig config) {
      * @return The complete URL for relationship tuples.
      */
     private String getRelationshipTuplesUrl(String url) {
-        return buildUrl(
-                String.format(
-                        "/v2/facts/%s/%s/relationship_tuples%s",
-                        config.getContext().getProject(),
-                        config.getContext().getEnvironment(),
-                        url
-                )
-        );
+        if (Boolean.TRUE.equals(config.isProxyFactsViaPdp())) {
+            return buildPdpUrl(
+                    String.format(
+                            "/facts/relationship_tuples%s",
+                            url
+                    )
+            );
+        } else {
+            return buildUrl(
+                    String.format(
+                            "/v2/facts/%s/%s/relationship_tuples%s",
+                            config.getContext().getProject(),
+                            config.getContext().getEnvironment(),
+                            url
+                    )
+            );
+        }
     }
 
     /**
diff --git a/src/main/java/io/permit/sdk/api/ResourceInstancesApi.java b/src/main/java/io/permit/sdk/api/ResourceInstancesApi.java
@@ -46,14 +46,23 @@ public ResourceInstancesApi(OkHttpClient client, PermitConfig config) {
      * @return The formatted URL for the ResourceInstances API.
      */
     private String getResourceInstancesUrl(String url) {
-        return buildUrl(
-                String.format(
-                        "/v2/facts/%s/%s/resource_instances%s",
-                        config.getContext().getProject(),
-                        config.getContext().getEnvironment(),
-                        url
-                )
-        );
+        if (Boolean.TRUE.equals(config.isProxyFactsViaPdp())) {
+            return buildPdpUrl(
+                    String.format(
+                            "/facts/resource_instances%s",
+                            url
+                    )
+            );
+        } else {
+            return buildUrl(
+                    String.format(
+                            "/v2/facts/%s/%s/resource_instances%s",
+                            config.getContext().getProject(),
+                            config.getContext().getEnvironment(),
+                            url
+                    )
+            );
+        }
     }
 
     /**
diff --git a/src/main/java/io/permit/sdk/api/RoleAssignmentsApi.java b/src/main/java/io/permit/sdk/api/RoleAssignmentsApi.java
@@ -44,14 +44,23 @@ public RoleAssignmentsApi(OkHttpClient client, PermitConfig config) {
      * @return The complete URL for role assignments.
      */
     private String getRoleAssignmentsUrl(String url) {
-        return buildUrl(
-                String.format(
-                        "/v2/facts/%s/%s/role_assignments%s",
-                        config.getContext().getProject(),
-                        config.getContext().getEnvironment(),
-                        url
-                )
-        );
+        if (Boolean.TRUE.equals(config.isProxyFactsViaPdp())) {
+            return buildPdpUrl(
+                    String.format(
+                            "/facts/role_assignments%s",
+                            url
+                    )
+            );
+        } else {
+            return buildUrl(
+                    String.format(
+                            "/v2/facts/%s/%s/role_assignments%s",
+                            config.getContext().getProject(),
+                            config.getContext().getEnvironment(),
+                            url
+                    )
+            );
+        }
     }
 
     /**
diff --git a/src/main/java/io/permit/sdk/api/TenantsApi.java b/src/main/java/io/permit/sdk/api/TenantsApi.java
@@ -49,14 +49,23 @@ public TenantsApi(OkHttpClient client, PermitConfig config) {
      * @return The formatted URL for the Tenants API.
      */
     private String getTenantsUrl(String url) {
-        return buildUrl(
-                String.format(
-                        "/v2/facts/%s/%s/tenants%s",
-                        config.getContext().getProject(),
-                        config.getContext().getEnvironment(),
-                        url
-                )
-        );
+        if (Boolean.TRUE.equals(config.isProxyFactsViaPdp())) {
+            return buildPdpUrl(
+                    String.format(
+                            "/facts/tenants%s",
+                            url
+                    )
+            );
+        } else {
+            return buildUrl(
+                    String.format(
+                            "/v2/facts/%s/%s/tenants%s",
+                            config.getContext().getProject(),
+                            config.getContext().getEnvironment(),
+                            url
+                    )
+            );
+        }
     }
 
     /**
diff --git a/src/main/java/io/permit/sdk/api/UsersApi.java b/src/main/java/io/permit/sdk/api/UsersApi.java
@@ -56,14 +56,23 @@ public UsersApi(OkHttpClient client, PermitConfig config) {
      * @return The formatted URL for the endpoint.
      */
     private String getUsersUrl(String url) {
-        return buildUrl(
-                String.format(
-                        "/v2/facts/%s/%s/users%s",
-                        config.getContext().getProject(),
-                        config.getContext().getEnvironment(),
-                        url
-                )
-        );
+        if (Boolean.TRUE.equals(config.isProxyFactsViaPdp())) {
+            return buildPdpUrl(
+                    String.format(
+                            "/facts/users%s",
+                            url
+                    )
+            );
+        } else {
+            return buildUrl(
+                    String.format(
+                            "/v2/facts/%s/%s/users%s",
+                            config.getContext().getProject(),
+                            config.getContext().getEnvironment(),
+                            url
+                    )
+            );
+        }
     }
 
     /**
