apiUrl should be able to apply path #10699

Author: anatol-sialitski

modules/lib/lib-portal/src/main/java/com/enonic/xp/lib/portal/url/ApiUrlHandler.java

@@ -1,28 +1,44 @@
 package com.enonic.xp.lib.portal.url;
 
+import java.util.List;
 import java.util.Set;
 
 import com.google.common.collect.Multimap;
 
 import com.enonic.xp.portal.url.ApiUrlParams;
+import com.enonic.xp.script.ScriptValue;
 
 public final class ApiUrlHandler
     extends AbstractUrlHandler
 {
     private static final Set<String> VALID_URL_PROPERTY_KEYS = Set.of( "application", "api", "type", "params" );
 
-    private Object path;
+    private String path;
+
+    private List<String> pathSegments;
 
     @Override
     protected String buildUrl( final Multimap<String, String> map )
     {
-        final ApiUrlParams params = new ApiUrlParams().portalRequest( this.request ).setAsMap( map ).path( this.path );
+        final ApiUrlParams params =
+            new ApiUrlParams().portalRequest( this.request ).setAsMap( map ).path( this.path ).pathSegments( this.pathSegments );
         return this.urlService.apiUrl( params );
     }
 
-    public void setPath( final Object path )
+    public void setPath( final Object value )
     {
-        this.path = path;
+        if ( value instanceof ScriptValue && ( (ScriptValue) value ).isArray() )
+        {
+            this.pathSegments = ( (ScriptValue) value ).getArray( String.class );
+        }
+        else if ( value instanceof String )
+        {
+            this.path = (String) value;
+        }
+        else
+        {
+            throw new IllegalArgumentException( "Invalid path value" );
+        }
     }
 
     @Override

modules/lib/lib-portal/src/main/resources/lib/xp/examples/portal/apiUrl.js

@@ -25,5 +25,5 @@ const apiUrl = portalLib.apiUrl({
 // END
 
 assert.assertEquals('ApiUrlParams{type=server, params={a=[1], b=[2]}, api=myapi, application=com.enonic.app.myapp, path=mypath/subpath}', url);
-assert.assertEquals('ApiUrlParams{type=server, params={}, application=com.enonic.app.myapp, path=[mypath, myotherpath]}', unnamedApiUrl);
+assert.assertEquals('ApiUrlParams{type=server, params={}, application=com.enonic.app.myapp, pathSegments=[mypath, myotherpath]}', unnamedApiUrl);
 assert.assertEquals('ApiUrlParams{type=server, params={}, api=myapi, application=com.enonic.app.myapp}', apiUrl);

modules/lib/lib-portal/src/main/resources/lib/xp/portal.ts

@@ -650,7 +650,7 @@ export function apiUrl(urlParams: ApiUrlParams): string {
     const bean = __.newBean<ApiUrlHandler>('com.enonic.xp.lib.portal.url.ApiUrlHandler');
     if (path) {
         if (Array.isArray(path)) {
-            bean.setPath(__.toScriptValue(([] as string[]).concat(path)));
+            bean.setPath(__.toScriptValue(path));
         } else {
             bean.setPath(path as string);
         }

modules/portal/portal-api/src/main/java/com/enonic/xp/portal/url/ApiUrlParams.java

@@ -1,13 +1,13 @@
 package com.enonic.xp.portal.url;
 
+import java.util.List;
 import java.util.Objects;
 
 import com.google.common.base.MoreObjects;
 import com.google.common.base.Strings;
 import com.google.common.collect.Multimap;
 
 import com.enonic.xp.annotation.PublicApi;
-import com.enonic.xp.script.ScriptValue;
 
 @PublicApi
 public final class ApiUrlParams
@@ -17,7 +17,9 @@ public final class ApiUrlParams
 
     private String api;
 
-    private Object path;
+    private String path;
+
+    private List<String> pathSegments;
 
     public String getApplication()
     {
@@ -29,11 +31,16 @@ public String getApi()
         return api;
     }
 
-    public Object getPath()
+    public String getPath()
     {
         return path;
     }
 
+    public List<String> getPathSegments()
+    {
+        return pathSegments;
+    }
+
     public ApiUrlParams application( final String value )
     {
         this.application = Objects.requireNonNull( value );
@@ -46,16 +53,15 @@ public ApiUrlParams api( final String value )
         return this;
     }
 
-    public ApiUrlParams path( final Object value )
+    public ApiUrlParams path( final String value )
+    {
+        this.path = value;
+        return this;
+    }
+
+    public ApiUrlParams pathSegments( final List<String> pathSegments )
     {
-        if ( value instanceof ScriptValue && ( (ScriptValue) value ).isArray() )
-        {
-            this.path = ( (ScriptValue) value ).getArray( String.class );
-        }
-        else
-        {
-            this.path = value;
-        }
+        this.pathSegments = pathSegments;
         return this;
     }
 
@@ -76,5 +82,6 @@ protected void buildToString( final MoreObjects.ToStringHelper helper )
         helper.add( "api", this.api );
         helper.add( "application", this.application );
         helper.add( "path", this.path );
+        helper.add( "pathSegments", this.pathSegments );
     }
 }

modules/portal/portal-impl/src/main/java/com/enonic/xp/portal/impl/url/SlashApiUrlBuilder.java

@@ -4,6 +4,7 @@
 
 import static com.enonic.xp.portal.impl.url.UrlBuilderHelper.appendParams;
 import static com.enonic.xp.portal.impl.url.UrlBuilderHelper.appendPart;
+import static com.enonic.xp.portal.impl.url.UrlBuilderHelper.appendPathSegments;
 import static com.enonic.xp.portal.impl.url.UrlBuilderHelper.appendSubPath;
 
 public class SlashApiUrlBuilder
@@ -25,6 +26,7 @@ public String build()
             appendPart( url, params.getApi() );
         }
         appendSubPath( url, this.params.getPath() );
+        appendPathSegments( url, this.params.getPathSegments() );
         appendParams( url, params.getParams().entries() );
         return url.toString();
     }

modules/portal/portal-impl/src/main/java/com/enonic/xp/portal/impl/url/UniversalApiUrlBuilder.java

@@ -10,6 +10,7 @@
 import com.enonic.xp.portal.url.ApiUrlParams;
 import com.enonic.xp.site.Site;
 
+import static com.enonic.xp.portal.impl.url.UrlBuilderHelper.appendPathSegments;
 import static com.enonic.xp.portal.impl.url.UrlBuilderHelper.appendSubPath;
 
 final class UniversalApiUrlBuilder
@@ -79,6 +80,7 @@ else if ( requestURI.startsWith( WEBAPP_PREFIX ) )
             appendPart( url, this.params.getApi() );
         }
         appendSubPath( url, this.params.getPath() );
+        appendPathSegments( url, this.params.getPathSegments() );
 
         params.putAll( this.params.getParams() );
     }

modules/portal/portal-impl/src/main/java/com/enonic/xp/portal/impl/url/UrlBuilderHelper.java

@@ -52,18 +52,24 @@ public static void appendPartWithoutNormalization( final StringBuilder str, fina
         str.append( urlPart );
     }
 
-    public static void appendSubPath( final StringBuilder url, final Object subPath )
+    public static void appendPathSegments( final StringBuilder url, final Collection<String> pathSegments )
     {
-        if ( subPath != null )
+        if ( pathSegments != null )
         {
-            if ( subPath instanceof Collection )
-            {
-                ( (Collection<?>) subPath ).forEach( pathPart -> appendPart( url, (String) pathPart ) );
-            }
-            else
-            {
-                appendPartWithoutNormalization( url, subPath.toString() );
-            }
+            pathSegments.forEach( pathSegment -> {
+                if ( !isNullOrEmpty( pathSegment ) )
+                {
+                    appendPart( url, pathSegment );
+                }
+            } );
+        }
+    }
+
+    public static void appendSubPath( final StringBuilder url, final String subPath )
+    {
+        if ( !isNullOrEmpty( subPath ) )
+        {
+            appendPartWithoutNormalization( url, subPath );
         }
     }
 

modules/portal/portal-impl/src/test/java/com/enonic/xp/portal/impl/url/PortalUrlServiceImpl_apiUrlTest.java

@@ -100,10 +100,12 @@ void testCreateUrlWithoutPortalRequest()
         params.api( "myapi" );
         params.param( "k1", "v1" );
         params.param( "k2", "v2" );
-        params.path( List.of( "språk", "kurs" ) );
+        params.pathSegments( List.of( "språk", "kurs" ) );
 
-        final String url = this.service.apiUrl( params );
-        assertEquals( "/api/com.enonic.app.myapp/myapi/spr%C3%A5k/kurs?k1=v1&k2=v2", url );
+        assertEquals( "/api/com.enonic.app.myapp/myapi/spr%C3%A5k/kurs?k1=v1&k2=v2", this.service.apiUrl( params ) );
+
+        params.path( "språk/kurs" ) ;
+        assertEquals( "/api/com.enonic.app.myapp/myapi/språk/kurs/spr%C3%A5k/kurs?k1=v1&k2=v2", this.service.apiUrl( params ) );
     }
 
     @Test
@@ -156,7 +158,7 @@ void testCreateUrlApi()
         params.portalRequest( this.portalRequest );
         params.application( "myapp2" );
         params.api( "api2" );
-        params.path( List.of( "språk", "kurs" ) );
+        params.pathSegments( List.of( "språk", "kurs" ) );
 
         final String url = this.service.apiUrl( params );
         assertEquals( "/api/myapp2/api2/spr%C3%A5k/kurs", url );