Skip to content

Commit

Permalink
Fix RateLimiterFilter configuration (#765)
Browse files Browse the repository at this point in the history
The filter itself was missing some important annotations. Its configuration has been simplified slightly as well.
  • Loading branch information
adutra authored Jan 15, 2025
1 parent d7c07dd commit df538b3
Show file tree
Hide file tree
Showing 9 changed files with 57 additions and 37 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,8 @@
import org.apache.polaris.service.quarkus.catalog.io.QuarkusFileIOConfiguration;
import org.apache.polaris.service.quarkus.context.QuarkusRealmContextConfiguration;
import org.apache.polaris.service.quarkus.persistence.QuarkusPersistenceConfiguration;
import org.apache.polaris.service.quarkus.ratelimiter.QuarkusRateLimiterConfiguration;
import org.apache.polaris.service.quarkus.ratelimiter.QuarkusRateLimiterFilterConfiguration;
import org.apache.polaris.service.quarkus.ratelimiter.QuarkusTokenBucketConfiguration;
import org.apache.polaris.service.ratelimiter.RateLimiter;
import org.apache.polaris.service.ratelimiter.TokenBucketFactory;
import org.apache.polaris.service.task.TaskHandlerConfiguration;
Expand Down Expand Up @@ -186,15 +187,15 @@ public void maybeInitializeInMemoryRealm(

@Produces
public RateLimiter rateLimiter(
QuarkusRateLimiterConfiguration config, @Any Instance<RateLimiter> rateLimiters) {
QuarkusRateLimiterFilterConfiguration config, @Any Instance<RateLimiter> rateLimiters) {
return rateLimiters.select(Identifier.Literal.of(config.type())).get();
}

@Produces
public TokenBucketFactory tokenBucketFactory(
QuarkusRateLimiterConfiguration config,
QuarkusTokenBucketConfiguration config,
@Any Instance<TokenBucketFactory> tokenBucketFactories) {
return tokenBucketFactories.select(Identifier.Literal.of(config.tokenBucket().type())).get();
return tokenBucketFactories.select(Identifier.Literal.of(config.type())).get();
}

@Produces
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,28 +20,14 @@

import io.quarkus.runtime.annotations.StaticInitSafe;
import io.smallrye.config.ConfigMapping;
import org.apache.polaris.service.ratelimiter.RateLimiterConfiguration;

@StaticInitSafe
@ConfigMapping(prefix = "polaris.rate-limiter")
public interface QuarkusRateLimiterConfiguration extends RateLimiterConfiguration {
@ConfigMapping(prefix = "polaris.rate-limiter.filter")
public interface QuarkusRateLimiterFilterConfiguration {

/**
* The type of the rate limiter. Must be a registered {@link
* org.apache.polaris.service.ratelimiter.RateLimiter} identifier.
*/
String type();

/** The configuration for the token bucket rate limiter. */
@Override
QuarkusTokenBucketConfiguration tokenBucket();

interface QuarkusTokenBucketConfiguration extends TokenBucketConfiguration {

/**
* The type of the token bucket factory. Must be a registered {@link
* org.apache.polaris.service.ratelimiter.TokenBucketFactory} identifier.
*/
String type();
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.polaris.service.quarkus.ratelimiter;

import io.quarkus.runtime.annotations.StaticInitSafe;
import io.smallrye.config.ConfigMapping;
import org.apache.polaris.service.ratelimiter.TokenBucketConfiguration;

@StaticInitSafe
@ConfigMapping(prefix = "polaris.rate-limiter.token-bucket")
public interface QuarkusTokenBucketConfiguration extends TokenBucketConfiguration {

/**
* The type of the token bucket factory. Must be a registered {@link
* org.apache.polaris.service.ratelimiter.TokenBucketFactory} identifier.
*/
String type();
}
2 changes: 1 addition & 1 deletion quarkus/service/src/main/resources/application.properties
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ polaris.metrics.tags.application=Polaris
# polaris.tasks.max-concurrent-tasks=100
# polaris.tasks.max-queued-tasks=1000

polaris.rate-limiter.type=no-op
polaris.rate-limiter.filter.type=no-op
polaris.rate-limiter.token-bucket.type=default
polaris.rate-limiter.token-bucket.requests-per-second=9999
polaris.rate-limiter.token-bucket.window=PT10S
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
import java.time.Instant;
import java.time.ZoneOffset;
import org.apache.polaris.service.ratelimiter.DefaultTokenBucketFactory;
import org.apache.polaris.service.ratelimiter.RateLimiterConfiguration;
import org.apache.polaris.service.ratelimiter.TokenBucketConfiguration;
import org.threeten.extra.MutableClock;

/** TokenBucketFactory with a mock clock */
Expand All @@ -38,7 +38,7 @@ public MockTokenBucketFactory() {
}

@Inject
public MockTokenBucketFactory(RateLimiterConfiguration configuration) {
public MockTokenBucketFactory(TokenBucketConfiguration configuration) {
super(configuration, CLOCK);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ public Set<Class<?>> getEnabledAlternatives() {
@Override
public Map<String, String> getConfigOverrides() {
return Map.of(
"polaris.rate-limiter.type",
"polaris.rate-limiter.filter.type",
"default",
"polaris.rate-limiter.token-bucket.type",
"default",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,11 +37,8 @@ public class DefaultTokenBucketFactory implements TokenBucketFactory {
private final Map<String, TokenBucket> perRealmBuckets = new ConcurrentHashMap<>();

@Inject
public DefaultTokenBucketFactory(RateLimiterConfiguration configuration, Clock clock) {
this(
configuration.tokenBucket().requestsPerSecond(),
configuration.tokenBucket().window(),
clock);
public DefaultTokenBucketFactory(TokenBucketConfiguration configuration, Clock clock) {
this(configuration.requestsPerSecond(), configuration.window(), clock);
}

public DefaultTokenBucketFactory(long requestsPerSecond, Duration window, Clock clock) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,13 @@
*/
package org.apache.polaris.service.ratelimiter;

import jakarta.annotation.Priority;
import jakarta.enterprise.context.ApplicationScoped;
import jakarta.inject.Inject;
import jakarta.ws.rs.Priorities;
import jakarta.ws.rs.container.ContainerRequestContext;
import jakarta.ws.rs.container.ContainerRequestFilter;
import jakarta.ws.rs.container.PreMatching;
import jakarta.ws.rs.core.Response;
import jakarta.ws.rs.ext.Provider;
import java.io.IOException;
Expand All @@ -29,6 +33,9 @@

/** Request filter that returns a 429 Too Many Requests if the rate limiter says so */
@Provider
@PreMatching
@Priority(Priorities.USER)
@ApplicationScoped
public class RateLimiterFilter implements ContainerRequestFilter {
private static final Logger LOGGER = LoggerFactory.getLogger(RateLimiterFilter.class);

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,9 @@

import java.time.Duration;

public interface RateLimiterConfiguration {
public interface TokenBucketConfiguration {

TokenBucketConfiguration tokenBucket();
long requestsPerSecond();

interface TokenBucketConfiguration {

long requestsPerSecond();

Duration window();
}
Duration window();
}

0 comments on commit df538b3

Please sign in to comment.