Fixed issue with file-download and service-transport CredentialsSupplier (#881)

artem-v · web-flow · commit 18995d24a78c · 2025-02-05T10:23:59.000+02:00
diff --git a/services-gateway/src/test/java/io/scalecube/services/gateway/files/FileDownloadTest.java b/services-gateway/src/test/java/io/scalecube/services/gateway/files/FileDownloadTest.java
@@ -7,11 +7,15 @@
 import static org.junit.jupiter.api.Assertions.assertNotNull;
 import static org.junit.jupiter.api.Assertions.assertTrue;
 import static org.junit.jupiter.api.Assertions.fail;
+import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.when;
 
 import io.scalecube.services.Address;
 import io.scalecube.services.Microservices;
 import io.scalecube.services.Microservices.Context;
 import io.scalecube.services.ServiceCall;
+import io.scalecube.services.ServiceReference;
 import io.scalecube.services.discovery.ScalecubeServiceDiscovery;
 import io.scalecube.services.exceptions.InternalServiceException;
 import io.scalecube.services.exceptions.ServiceUnavailableException;
@@ -20,6 +24,7 @@
 import io.scalecube.services.gateway.client.websocket.WebsocketGatewayClientTransport;
 import io.scalecube.services.gateway.http.HttpGateway;
 import io.scalecube.services.gateway.websocket.WebsocketGateway;
+import io.scalecube.services.transport.api.ServiceTransport.CredentialsSupplier;
 import io.scalecube.services.transport.rsocket.RSocketServiceTransport;
 import io.scalecube.transport.netty.websocket.WebsocketTransportFactory;
 import java.io.IOException;
@@ -36,6 +41,7 @@
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 import reactor.core.Exceptions;
+import reactor.core.publisher.Mono;
 import reactor.test.StepVerifier;
 
 public class FileDownloadTest {
@@ -46,11 +52,16 @@ public class FileDownloadTest {
   private static Microservices microservices;
   private static Address httpAddress;
   private static Address wsAddress;
+  private static CredentialsSupplier credentialsSupplier;
 
   private ServiceCall serviceCall;
 
   @BeforeAll
   static void beforeAll() {
+    credentialsSupplier = mock(CredentialsSupplier.class);
+    when(credentialsSupplier.apply(any(ServiceReference.class)))
+        .thenReturn(Mono.never());
+
     gateway =
         Microservices.start(
             new Context()
@@ -59,7 +70,8 @@ static void beforeAll() {
                         new ScalecubeServiceDiscovery()
                             .transport(cfg -> cfg.transportFactory(new WebsocketTransportFactory()))
                             .options(opts -> opts.metadata(serviceEndpoint)))
-                .transport(RSocketServiceTransport::new)
+                .transport(
+                    () -> new RSocketServiceTransport().credentialsSupplier(credentialsSupplier))
                 .gateway(() -> new HttpGateway.Builder().id("HTTP").build())
                 .gateway(() -> new WebsocketGateway.Builder().id("WS").build()));
 
diff --git a/services-transport-parent/services-transport-rsocket/src/main/java/io/scalecube/services/transport/rsocket/RSocketClientTransport.java b/services-transport-parent/services-transport-rsocket/src/main/java/io/scalecube/services/transport/rsocket/RSocketClientTransport.java
@@ -81,6 +81,11 @@ private Mono<Map<String, String>> getCredentials(ServiceReference serviceReferen
           if (credentialsSupplier == null) {
             return Mono.just(Collections.emptyMap());
           }
+
+          if (!serviceReference.isSecured()) {
+            return Mono.just(Collections.emptyMap());
+          }
+
           return credentialsSupplier
               .apply(serviceReference)
               .switchIfEmpty(Mono.just(Collections.emptyMap()))
@@ -140,8 +145,7 @@ private Payload encodeConnectionSetup(ConnectionSetup connectionSetup) {
   }
 
   private UnauthorizedException toUnauthorizedException(Throwable th) {
-    if (th instanceof ServiceException) {
-      ServiceException e = (ServiceException) th;
+    if (th instanceof ServiceException e) {
       return new UnauthorizedException(e.errorCode(), e.getMessage());
     } else {
       return new UnauthorizedException(th);
diff --git a/services/src/main/java/io/scalecube/services/files/FileService.java b/services/src/main/java/io/scalecube/services/files/FileService.java
@@ -6,23 +6,22 @@
 
 /**
  * Service interface for adding files locally, those added files will be accessible by {@link
- * FileStreamer}. Typical usage: client generates a file in the app service, then calls {@link
- * #addFile(AddFileRequest)}, then returns result (file path qualifier) all the way back to the
- * caller of app service. On the caller side file path qualifier gets combined with http-gateway
- * address, and then url for file streaming is ready. Then caller side has time to download a file
- * until file is not expired.
+ * FileStreamer}. Typical usage: client defines an app service with injected {@link FileService},
+ * client generates a file in the app service, then calls {@link #addFile(AddFileRequest)}, then
+ * returns result (file path qualifier) all the way back to the caller of app service. On the caller
+ * side file path qualifier gets combined with http-gateway address, and then url for file streaming
+ * is ready. Then caller side has time to download a file until file gets expired.
  */
 @Service
 public interface FileService {
 
   /**
    * Adding file and returning path qualifier for the added file. {@link AddFileRequest} must
    * contain {@code file} that exists, that is not directory, and must have valid path, another
-   * parameter - {@code ttl} (optional) represents time after which file will be deleted.
-   *
-   * <p>Returned file path qualifier comes as: {@code
-   * v1/scalecube.endpoints/${microservices:id}/files/:name}, for example: {@code
-   * v1/scalecube.endpoints/19e3afc1-fa46-4a55-8a41-1bdf4afc8a5b/files/report_03_01_2025.txt}.
+   * parameter - {@code ttl} (optional) represents time after which file will be deleted. Returned
+   * file path qualifier comes as: {@code v1/scalecube.endpoints/${microservices:id}/files/:name},
+   * for example: {@code
+   * v1/scalecube.endpoints/19e3afc1-fa46-4a55-8a41-1bdf4afc8a5b/files/report_03_01_2025.txt}
    *
    * @param request request
    * @return async result with path qualifier
diff --git a/services/src/main/java/io/scalecube/services/files/FileStreamer.java b/services/src/main/java/io/scalecube/services/files/FileStreamer.java
@@ -8,7 +8,8 @@
 
 /**
  * System service interface for streaming files after they have been added locally with {@link
- * FileService#addFile(AddFileRequest)}.
+ * FileService#addFile(AddFileRequest)}. NOTE: this is system service inerface, clients are not
+ * supposed to inject it into their app services and call it directly.
  */
 @Service(FileStreamer.NAMESPACE)
 public interface FileStreamer {
