-
Notifications
You must be signed in to change notification settings - Fork 4
866: FeatureFlag annotation #878
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.
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
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
53 changes: 53 additions & 0 deletions
53
src/main/java/org/patinanetwork/codebloom/common/ff/FFAspect.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| package org.patinanetwork.codebloom.common.ff; | ||
|
|
||
| import lombok.extern.slf4j.Slf4j; | ||
| import org.aspectj.lang.ProceedingJoinPoint; | ||
| import org.aspectj.lang.annotation.Around; | ||
| import org.aspectj.lang.annotation.Aspect; | ||
| import org.patinanetwork.codebloom.common.ff.annotation.FF; | ||
| import org.springframework.context.expression.MapAccessor; | ||
| import org.springframework.expression.ExpressionParser; | ||
| import org.springframework.expression.spel.standard.SpelExpressionParser; | ||
| import org.springframework.expression.spel.support.StandardEvaluationContext; | ||
| import org.springframework.http.HttpStatus; | ||
| import org.springframework.stereotype.Component; | ||
| import org.springframework.web.server.ResponseStatusException; | ||
|
|
||
| @Aspect | ||
| @Component | ||
| @Slf4j | ||
| public class FFAspect { | ||
|
|
||
| private final FeatureFlagManager featureFlagManager; | ||
| private final ExpressionParser parser; | ||
|
|
||
| public FFAspect(final FeatureFlagManager featureFlagManager) { | ||
| this.featureFlagManager = featureFlagManager; | ||
| this.parser = new SpelExpressionParser(); | ||
| } | ||
|
|
||
| @Around("@annotation(ff)") | ||
| public Object gateMethodByFeatureFlags(final ProceedingJoinPoint joinPoint, final FF ff) throws Throwable { | ||
| String expression = ff.value(); | ||
|
|
||
| var flags = featureFlagManager.getAllFlags(); | ||
| StandardEvaluationContext context = new StandardEvaluationContext(flags); | ||
| context.addPropertyAccessor(new MapAccessor()); | ||
|
|
||
| Boolean isEnabled; | ||
| try { | ||
| isEnabled = parser.parseExpression(expression).getValue(context, Boolean.class); | ||
| } catch (Exception e) { | ||
| log.error("Invalid @FF expression: " + expression, e); | ||
| throw new IllegalArgumentException("Invalid @FF expression: " + expression, e); | ||
| } | ||
|
|
||
| if (!Boolean.TRUE.equals(isEnabled)) { | ||
| throw new ResponseStatusException( | ||
| HttpStatus.FORBIDDEN, | ||
| "Endpoint is not available. Feature flag expression evaluated to false: " + expression); | ||
| } | ||
|
|
||
| return joinPoint.proceed(); | ||
| } | ||
| } |
41 changes: 41 additions & 0 deletions
41
src/main/java/org/patinanetwork/codebloom/common/ff/FeatureFlagManager.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| package org.patinanetwork.codebloom.common.ff; | ||
|
|
||
| import java.beans.Introspector; | ||
| import java.lang.reflect.Method; | ||
| import java.util.HashMap; | ||
| import java.util.Map; | ||
| import org.patinanetwork.codebloom.jda.properties.FeatureFlagConfiguration; | ||
| import org.springframework.stereotype.Component; | ||
|
|
||
| @Component | ||
| public class FeatureFlagManager { | ||
| private final FeatureFlagConfiguration ff; | ||
| private final Map<String, Boolean> cachedFlags; | ||
|
|
||
| public FeatureFlagManager(final FeatureFlagConfiguration ff) { | ||
| this.ff = ff; | ||
| this.cachedFlags = initializeFlags(); | ||
| } | ||
|
|
||
| private Map<String, Boolean> initializeFlags() { | ||
| Map<String, Boolean> flags = new HashMap<>(); | ||
| for (Method method : ff.getClass().getMethods()) { | ||
| if (method.getName().startsWith("is") | ||
| && method.getReturnType() == boolean.class | ||
| && method.getParameterCount() == 0) { | ||
| try { | ||
| String flagName = Introspector.decapitalize(method.getName().substring(2)); | ||
| flags.put(flagName, (Boolean) method.invoke(ff)); | ||
| } catch (Exception e) { | ||
| throw new IllegalStateException( | ||
| "Failed to resolve feature flag value from method: " + method.getName(), e); | ||
| } | ||
| } | ||
| } | ||
| return Map.copyOf(flags); | ||
| } | ||
|
|
||
| public Map<String, Boolean> getAllFlags() { | ||
| return cachedFlags; | ||
| } | ||
| } | ||
20 changes: 20 additions & 0 deletions
20
src/main/java/org/patinanetwork/codebloom/common/ff/annotation/FF.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| package org.patinanetwork.codebloom.common.ff.annotation; | ||
|
|
||
| import java.lang.annotation.Documented; | ||
| import java.lang.annotation.ElementType; | ||
| import java.lang.annotation.Retention; | ||
| import java.lang.annotation.RetentionPolicy; | ||
| import java.lang.annotation.Target; | ||
|
|
||
| /** | ||
| * Feature flag gate | ||
| * | ||
| * <p>The value must be a SpEL boolean expression using feature flag names from FeatureFlagManager. Example: | ||
| * {@code "duels && userMetrics"} | ||
| */ | ||
| @Target(ElementType.METHOD) | ||
| @Retention(RetentionPolicy.RUNTIME) | ||
| @Documented | ||
| public @interface FF { | ||
| String value(); | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.