Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

API descriptor can be optional #10673 #10674

Merged
merged 3 commits into from
Sep 5, 2024
Merged

API descriptor can be optional #10673 #10674

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
47893f0
Remove tool path segment for admin tools #10625
anatol-sialitski Sep 2, 2024
f1fc04e
API descriptor can be optional #10673
anatol-sialitski Sep 4, 2024
236c6c3
Merge branch 'master' into issue-10673
anatol-sialitski Sep 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
109 changes: 53 additions & 56 deletions ...s/portal/portal-impl/src/main/java/com/enonic/xp/portal/impl/handler/SlashApiHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ public SlashApiHandler( @Reference final ControllerScriptFactory controllerScrip
@Reference(cardinality = ReferenceCardinality.MULTIPLE, policy = ReferencePolicy.DYNAMIC)
public void addApiHandler( final UniversalApiHandler apiHandler, final Map<String, ?> properties )
{
final ApiDescriptor apiDescriptor = resolveDynamicApiDescriptor( properties );
final ApiDescriptor apiDescriptor = createDynamicApiDescriptor( properties );
this.dynamicApiHandlers.put( apiDescriptor.getKey(), new UniversalApiHandlerWrapper( apiHandler, apiDescriptor ) );
}

Expand Down Expand Up @@ -173,18 +173,34 @@ public WebResponse handle( final WebRequest webRequest )

if ( dynamicApiHandler != null )
{
return execute( portalRequest, dynamicApiHandler.apiDescriptor, restPath,
return execute( portalRequest, dynamicApiHandler.apiDescriptor.getKey(), restPath,
() -> dynamicApiHandler.apiHandler.handle( portalRequest ) );
}
else
{
final DescriptorKey descriptorKey = resolveDescriptorKey( applicationKey, apiKey, portalRequest );
return execute( portalRequest, descriptorKey, restPath, () -> executeController( portalRequest, descriptorKey ) );
}
}

final ApiDescriptor apiDescriptor = resolveApiDescriptor( applicationKey, apiKey );

if ( !verifyRequestMounted( apiDescriptor, portalRequest ) )
private DescriptorKey resolveDescriptorKey( final ApplicationKey applicationKey, final String apiKey,
final PortalRequest portalRequest )
{
// If the unnamed API is present, then the named APIs are skipped.
DescriptorKey descriptorKey = DescriptorKey.from( applicationKey, UNNAMED_API_KEY );
ApiDescriptor apiDescriptor = apiDescriptorService.getByKey( descriptorKey );
if ( apiDescriptor == null )
{
descriptorKey = DescriptorKey.from( applicationKey, apiKey );
apiDescriptor = apiDescriptorService.getByKey( descriptorKey );
}
if ( apiDescriptor != null )
{
throw WebException.notFound( String.format( "API [%s] is not mounted", apiDescriptor.getKey() ) );
verifyAccessToApi( apiDescriptor );
}
verifyRequestMounted( descriptorKey, portalRequest );

return execute( portalRequest, apiDescriptor, restPath, () -> executeController( portalRequest, apiDescriptor ) );
return descriptorKey;
}

private UniversalApiHandlerWrapper resolveDynamicApiHandler( final ApplicationKey applicationKey, final String apiKey,
Expand All @@ -203,16 +219,12 @@ private UniversalApiHandlerWrapper resolveDynamicApiHandler( final ApplicationKe
}

verifyAccessToApi( handlerWrapper.apiDescriptor );

if ( !verifyRequestMounted( handlerWrapper.apiDescriptor, portalRequest ) )
{
throw WebException.notFound( String.format( "API [%s] is not mounted", handlerWrapper.apiDescriptor.getKey() ) );
}
verifyRequestMounted( handlerWrapper.apiDescriptor.getKey(), portalRequest );

return handlerWrapper;
}

private WebResponse execute( final PortalRequest portalRequest, final ApiDescriptor apiDescriptor, final String restPath,
private WebResponse execute( final PortalRequest portalRequest, final DescriptorKey descriptorKey, final String restPath,
final Supplier<WebResponse> supplier )
throws Exception
{
Expand All @@ -223,38 +235,41 @@ private WebResponse execute( final PortalRequest portalRequest, final ApiDescrip
}
return Tracer.traceEx( trace, () -> {
final WebResponse response = handleAPIRequest( portalRequest, supplier );
addTranceInfo( trace, apiDescriptor.getKey(), restPath, response );
addTranceInfo( trace, descriptorKey, restPath, response );
return response;
} );
}

private boolean verifyRequestMounted( final ApiDescriptor apiDescriptor, final PortalRequest portalRequest )
private void verifyRequestMounted( final DescriptorKey descriptorKey, final PortalRequest portalRequest )
{
final String rawPath = portalRequest.getRawPath();

boolean isMounted = false;

if ( portalRequest.getEndpointPath() == null && rawPath.startsWith( "/api/" ) )
{
return true;
isMounted = true;
}
else if ( portalRequest.getEndpointPath() != null && rawPath.startsWith( "/site/" ) || rawPath.startsWith( "/admin/site/" ) )
{
return verifyRequestMountedOnSites( apiDescriptor, portalRequest );
isMounted = verifyRequestMountedOnSites( descriptorKey, portalRequest );
}
else if ( portalRequest.getEndpointPath() != null && rawPath.startsWith( "/webapp/" ) )
{
return verifyPathMountedOnWebapps( apiDescriptor, portalRequest );
isMounted = verifyPathMountedOnWebapps( descriptorKey, portalRequest );
}
else if ( portalRequest.getEndpointPath() != null && rawPath.startsWith( "/admin/" ) )
{
return verifyPathMountedOnAdminTool( apiDescriptor, portalRequest );
isMounted = verifyPathMountedOnAdminTool( descriptorKey, portalRequest );
}
else

if ( !isMounted )
{
return false;
throw WebException.notFound( String.format( "API [%s] is not mounted", descriptorKey ) );
}
}

private boolean verifyPathMountedOnAdminTool( final ApiDescriptor apiDescriptor, final PortalRequest portalRequest )
private boolean verifyPathMountedOnAdminTool( final DescriptorKey descriptorKey, final PortalRequest portalRequest )
{
final Matcher matcher = MOUNT_ADMINTOOL_API_PATTERN.matcher( portalRequest.getRawPath() );
if ( !matcher.find() )
Expand All @@ -265,20 +280,19 @@ private boolean verifyPathMountedOnAdminTool( final ApiDescriptor apiDescriptor,
final ApplicationKey applicationKey = HandlerHelper.resolveApplicationKey( matcher.group( "appKey" ) );
final String tool = matcher.group( "tool" );

final DescriptorKey descriptorKey = DescriptorKey.from( applicationKey, tool );
final AdminToolDescriptor adminToolDescriptor = adminToolDescriptorService.getByKey( descriptorKey );
final AdminToolDescriptor adminToolDescriptor = adminToolDescriptorService.getByKey( DescriptorKey.from( applicationKey, tool ) );
if ( adminToolDescriptor == null )
{
return false;
}

return adminToolDescriptor.getApiMounts()
.stream()
.anyMatch( descriptor -> descriptor.getApiKey().equals( apiDescriptor.getKey().getName() ) &&
descriptor.getApplicationKey().equals( apiDescriptor.getKey().getApplicationKey() ) );
.anyMatch( descriptor -> descriptor.getApiKey().equals( descriptorKey.getName() ) &&
descriptor.getApplicationKey().equals( descriptorKey.getApplicationKey() ) );
}

private boolean verifyPathMountedOnWebapps( final ApiDescriptor apiDescriptor, final PortalRequest portalRequest )
private boolean verifyPathMountedOnWebapps( final DescriptorKey descriptorKey, final PortalRequest portalRequest )
{
final Matcher webappMatcher = MOUNT_WEBAPP_ENDPOINT_PATTERN.matcher( portalRequest.getRawPath() );
if ( !webappMatcher.find() )
Expand All @@ -296,11 +310,11 @@ private boolean verifyPathMountedOnWebapps( final ApiDescriptor apiDescriptor, f

return webappDescriptor.getApiMounts()
.stream()
.anyMatch( descriptor -> descriptor.getApiKey().equals( apiDescriptor.getKey().getName() ) &&
descriptor.getApplicationKey().equals( apiDescriptor.getKey().getApplicationKey() ) );
.anyMatch( descriptor -> descriptor.getApiKey().equals( descriptorKey.getName() ) &&
descriptor.getApplicationKey().equals( descriptorKey.getApplicationKey() ) );
}

private boolean verifyRequestMountedOnSites( final ApiDescriptor apiDescriptor, final PortalRequest portalRequest )
private boolean verifyRequestMountedOnSites( final DescriptorKey descriptorKey, final PortalRequest portalRequest )
{
final ContentResolverResult contentResolverResult = new ContentResolver( contentService ).resolve( portalRequest );

Expand All @@ -321,8 +335,8 @@ private boolean verifyRequestMountedOnSites( final ApiDescriptor apiDescriptor,
{
final ApiMountDescriptor apiMountDescriptor = siteDescriptor.getApiDescriptors()
.stream()
.filter( descriptor -> descriptor.getApiKey().equals( apiDescriptor.getKey().getName() ) &&
descriptor.getApplicationKey().equals( apiDescriptor.getKey().getApplicationKey() ) )
.filter( descriptor -> descriptor.getApiKey().equals( descriptorKey.getName() ) &&
descriptor.getApplicationKey().equals( descriptorKey.getApplicationKey() ) )
.findAny()
.orElse( null );

Expand Down Expand Up @@ -378,23 +392,7 @@ private WebResponse handleAPIRequest( final PortalRequest portalRequest, final S
}
}

private ApiDescriptor resolveApiDescriptor( final ApplicationKey applicationKey, final String apiKey )
{
// If the unnamed API is present, then the named APIs are skipped.
ApiDescriptor apiDescriptor = apiDescriptorService.getByKey( DescriptorKey.from( applicationKey, UNNAMED_API_KEY ) );
if ( apiDescriptor == null )
{
final DescriptorKey descriptorKey = DescriptorKey.from( applicationKey, apiKey );
apiDescriptor = apiDescriptorService.getByKey( descriptorKey );
if ( apiDescriptor == null )
{
throw WebException.notFound( String.format( "API [%s] not found", descriptorKey ) );
}
}
return verifyAccessToApi( apiDescriptor );
}

private ApiDescriptor verifyAccessToApi( final ApiDescriptor apiDescriptor )
private void verifyAccessToApi( final ApiDescriptor apiDescriptor )
{
final PrincipalKeys principals = ContextAccessor.current().getAuthInfo().getPrincipals();
if ( !apiDescriptor.isAccessAllowed( principals ) )
Expand All @@ -403,7 +401,6 @@ private ApiDescriptor verifyAccessToApi( final ApiDescriptor apiDescriptor )
String.format( "You don't have permission to access \"%s\" API for \"%s\"", apiDescriptor.getKey().getName(),
apiDescriptor.getKey().getApplicationKey() ) );
}
return apiDescriptor;
}

private PortalRequest createPortalRequest( final WebRequest webRequest, final ApplicationKey applicationKey )
Expand All @@ -417,17 +414,17 @@ private PortalRequest createPortalRequest( final WebRequest webRequest, final Ap
return portalRequest;
}

private PortalResponse executeController( final PortalRequest req, final ApiDescriptor apiDescriptor )
private PortalResponse executeController( final PortalRequest req, final DescriptorKey descriptorKey )
{
final ControllerScript script = getScript( apiDescriptor );
final ControllerScript script = getScript( descriptorKey );
final PortalResponse res = script.execute( req );

final WebSocketConfig webSocketConfig = res.getWebSocket();
final WebSocketContext webSocketContext = req.getWebSocketContext();
if ( webSocketContext != null && webSocketConfig != null )
{
final WebSocketEndpoint webSocketEndpoint =
newWebSocketEndpoint( webSocketConfig, script, apiDescriptor.getKey().getApplicationKey() );
newWebSocketEndpoint( webSocketConfig, script, descriptorKey.getApplicationKey() );
try
{
webSocketContext.apply( webSocketEndpoint );
Expand All @@ -452,9 +449,9 @@ private WebSocketEndpoint newWebSocketEndpoint( final WebSocketConfig config, fi
return new WebSocketEndpointImpl( config, () -> script );
}

private ControllerScript getScript( final ApiDescriptor apiDescriptor )
private ControllerScript getScript( final DescriptorKey descriptorKey )
{
final ResourceKey script = ApiDescriptor.toResourceKey( apiDescriptor.getKey(), "js" );
final ResourceKey script = ApiDescriptor.toResourceKey( descriptorKey, "js" );
final Trace trace = Tracer.current();
if ( trace != null )
{
Expand All @@ -471,7 +468,7 @@ private WebResponse handleError( final WebRequest webRequest, final Exception e
return webResponse;
}

private ApiDescriptor resolveDynamicApiDescriptor( final Map<String, ?> properties )
private ApiDescriptor createDynamicApiDescriptor( final Map<String, ?> properties )
{
final ApplicationKey applicationKey = ApplicationKey.from( (String) properties.get( "applicationKey" ) );
final String apiKey = Objects.requireNonNullElse( (String) properties.get( "apiKey" ), UNNAMED_API_KEY );
Expand Down
40 changes: 1 addition & 39 deletions ...rtal/portal-impl/src/test/java/com/enonic/xp/portal/impl/handler/SlashApiHandlerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -199,21 +199,6 @@ void testHttpOptions()
assertEquals( "GET,POST,HEAD,OPTIONS,PUT,DELETE,TRACE", res.getHeaders().get( "Allow" ) );
}

@Test
void testHandleApiNotFound()
{
final WebRequest webRequest = mock( WebRequest.class );
when( webRequest.getMethod() ).thenReturn( HttpMethod.GET );
when( webRequest.getEndpointPath() ).thenReturn( null );
when( webRequest.getRawPath() ).thenReturn( "/api/com.enonic.app.myapp/api-key" );

when( apiDescriptorService.getByKey( any( DescriptorKey.class ) ) ).thenReturn( null );

WebException ex = assertThrows( WebException.class, () -> this.handler.handle( webRequest ) );
assertEquals( HttpStatus.NOT_FOUND, ex.getStatus() );
assertEquals( "API [com.enonic.app.myapp:api-key] not found", ex.getMessage() );
}

@Test
void testHandleApiAccessDenied()
{
Expand Down Expand Up @@ -501,8 +486,7 @@ void testWebappMountOwnUnnamedAPI()
{
final ApplicationKey webappApplicationKey = ApplicationKey.from( "com.enonic.app.mywebapp" );

final ApiMountDescriptor unnamedApiInWebapp =
ApiMountDescriptor.create().applicationKey( webappApplicationKey ).build();
final ApiMountDescriptor unnamedApiInWebapp = ApiMountDescriptor.create().applicationKey( webappApplicationKey ).build();

final WebappDescriptor webappDescriptor = WebappDescriptor.create()
.applicationKey( webappApplicationKey )
Expand Down Expand Up @@ -750,28 +734,6 @@ void testAddAndRemoveDynamicApiHandler()
handler.removeApiHandler( myUniversalApiHandler );
}

@Test
void testHandleDynamicApiHandlerDoesNotRegister()
{
final ApplicationKey apiApplicationKey = ApplicationKey.from( "com.enonic.app.external.app" );
final ApplicationKey applicationKey = ApplicationKey.from( "com.enonic.app.myapp" );
final DescriptorKey descriptorKey = DescriptorKey.from( applicationKey, "mytool" );
final AdminToolDescriptor toolDescriptor = AdminToolDescriptor.create()
.displayName( "My Tool" )
.key( descriptorKey )
.apiMounts(
ApiMountDescriptors.from( ApiMountDescriptor.create().applicationKey( apiApplicationKey ).apiKey( "myapi" ).build() ) )
.build();

when( adminToolDescriptorService.getByKey( eq( descriptorKey ) ) ).thenReturn( toolDescriptor );

request.setEndpointPath( "/_/com.enonic.app.external.app/myapi" );
request.setRawPath( "/admin/com.enonic.app.myapp/mytool/_/com.enonic.app.external.app/myapi" );

WebException ex = assertThrows( WebException.class, () -> this.handler.handle( request ) );
assertEquals( HttpStatus.NOT_FOUND, ex.getStatus() );
}

@Test
void testHandleDynamicApiHandlerWhichDoesNotMountToAPI()
{
Expand Down