armeria icon indicating copy to clipboard operation
armeria copied to clipboard

Provides a way for `DecoratorFactory` to be applied only once

Open ikhoon opened this issue 1 year ago • 4 comments

Say a decorator checks permission of request. I want to give all API write permissions in the class and optionally give read permissions. In this way, when a new API is added to the class, write permission is given by default. This will prevent the new API from being accidentally exposed with lower permissions.

This logic cannot be implemented using the DecoratorFactory. Because the decorators in the method and class are applied repeatedly even if it is the same class type.

In the SensitiveService, get() method can't be executed with READ permission. Both READ and WRITE are required instead.

@RequiresPermission(Permission.WRITE)
static class SensitiveService {
    @RequiresPermission(Permission.READ)
    @Get("/")
    public String get() { ... }

    @Post("/")
    public String create() { ... }

    @Put("/")
    public String update() { ... }
}

@DecoratorFactory(PermissionCheckerFactory.class)
@Retention(RetentionPolicy.RUNTIME)
@interface RequiresPermission {
    Permission value() default Permission.READ;
}

enum Permission {
    READ, WRITE
}

To solve this case, I suggest adding the repeatable option to DecoratorFactory. If repeatable=false, the decorator with a higher priority will be selected.

public @interface DecoratorFactory {

    Class<? extends DecoratorFactoryFunction<?>> value();
    
    boolean repeatable() default true;
}

@DecoratorFactory(value = PermissionCheckerFactory.class, repeatable = false)
@Retention(RetentionPolicy.RUNTIME)
@interface RequiresPermission {
    Permission value() default Permission.READ;
}

If there is any other good name other than repeatable, please recommend it.

ikhoon avatar Jun 13 '24 08:06 ikhoon

Although not a widely used term, this kind of reminds me of additivity in the logging community. ref: https://logback.qos.ch/manual/architecture.html#additivity

jrhee17 avatar Jun 14 '24 01:06 jrhee17

I love the way the maintainers explain the details of the issue and extra information. Just reading the issues sometimes help me a lot 😄

seonWKim avatar Jun 16 '24 03:06 seonWKim

Hi! I'm interested in handling this issue. I have some questions to ask.

Is it ideal that an annotation that has @DecoratorFactory annotation whose repeatable flag is true has higher priority than an annotation whose repeatable flag is false?

One more question. Do you imagine that priority comparison applies only to annotations that have @DecoratorFactory annotation whose value's class is the same?

my4-dev avatar Sep 12 '24 14:09 my4-dev

@DecoratorFactory annotation whose repeatable flag is true has higher priority than an annotation whose repeatable flag is false?

No, I don't think so. We need to keep the original priority. The innermost @DecoratorFactory or @Decorator will take precedence.

Do you imagine that priority comparison applies only to annotations that have @DecoratorFactory annotation whose value's class is the same?

Right. repeatable should be limited to the same DecoratorFactoryFunction.class.

ikhoon avatar Sep 13 '24 02:09 ikhoon