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

chore: add support for system label application rules #235

Merged
merged 5 commits into from
Sep 2, 2024
Merged

chore: add support for system label application rules #235

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d6d3c34
chore: add support for system label application rules
Aug 30, 2024
740ffd7
address review comment
Aug 30, 2024
5fb03f8
address review comments
Sep 2, 2024
953a4c4
address review comments
Sep 2, 2024
959ac0d
update catalog version
Sep 2, 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
67 changes: 67 additions & 0 deletions ...java/org/hypertrace/label/application/rule/config/service/LabelApplicationRuleConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
package org.hypertrace.label.application.rule.config.service;

import static java.util.function.Function.identity;

import com.google.protobuf.util.JsonFormat;
import com.typesafe.config.Config;
import com.typesafe.config.ConfigFactory;
import com.typesafe.config.ConfigObject;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.stream.Collectors;
import lombok.Getter;
import lombok.SneakyThrows;
import org.hypertrace.label.application.rule.config.service.v1.LabelApplicationRule;

public class LabelApplicationRuleConfig {
private static final String LABEL_APPLICATION_RULE_CONFIG_SERVICE_CONFIG =
"label.application.rule.config.service";
private static final String MAX_DYNAMIC_LABEL_APPLICATION_RULES_PER_TENANT =
"max.dynamic.label.application.rules.per.tenant";
private static final String SYSTEM_LABEL_APPLICATION_RULES = "system.label.application.rules";
private static final int DEFAULT_MAX_DYNAMIC_LABEL_APPLICATION_RULES_PER_TENANT = 100;

@Getter private final int maxDynamicLabelApplicationRulesAllowed;
@Getter private final List<LabelApplicationRule> systemLabelApplicationRules;
@Getter private final Map<String, LabelApplicationRule> systemLabelApplicationRulesMap;

public LabelApplicationRuleConfig(Config config) {
Config labelApplicationRuleConfig =
config.hasPath(LABEL_APPLICATION_RULE_CONFIG_SERVICE_CONFIG)
? config.getConfig(LABEL_APPLICATION_RULE_CONFIG_SERVICE_CONFIG)
: ConfigFactory.empty();
this.maxDynamicLabelApplicationRulesAllowed =
labelApplicationRuleConfig.hasPath(MAX_DYNAMIC_LABEL_APPLICATION_RULES_PER_TENANT)
? labelApplicationRuleConfig.getInt(MAX_DYNAMIC_LABEL_APPLICATION_RULES_PER_TENANT)
: DEFAULT_MAX_DYNAMIC_LABEL_APPLICATION_RULES_PER_TENANT;
if (labelApplicationRuleConfig.hasPath(SYSTEM_LABEL_APPLICATION_RULES)) {
final List<? extends ConfigObject> systemLabelApplicationRulesObjectList =
labelApplicationRuleConfig.getObjectList(SYSTEM_LABEL_APPLICATION_RULES);
this.systemLabelApplicationRules =
buildSystemLabelApplicationRuleList(systemLabelApplicationRulesObjectList);
this.systemLabelApplicationRulesMap =
this.systemLabelApplicationRules.stream()
.collect(Collectors.toUnmodifiableMap(LabelApplicationRule::getId, identity()));
} else {
this.systemLabelApplicationRules = Collections.emptyList();
this.systemLabelApplicationRulesMap = Collections.emptyMap();
}
}

private List<LabelApplicationRule> buildSystemLabelApplicationRuleList(
List<? extends com.typesafe.config.ConfigObject> configObjectList) {
return configObjectList.stream()
.map(LabelApplicationRuleConfig::buildLabelApplicationRuleFromConfig)
.collect(Collectors.toUnmodifiableList());
}

@SneakyThrows
private static LabelApplicationRule buildLabelApplicationRuleFromConfig(
com.typesafe.config.ConfigObject configObject) {
String jsonString = configObject.render();
LabelApplicationRule.Builder builder = LabelApplicationRule.newBuilder();
JsonFormat.parser().merge(jsonString, builder);
return builder.build();
}
}
49 changes: 31 additions & 18 deletions ...pertrace/label/application/rule/config/service/LabelApplicationRuleConfigServiceImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,11 @@
import com.typesafe.config.Config;
import io.grpc.Channel;
import io.grpc.Status;
import io.grpc.StatusRuntimeException;
import io.grpc.stub.StreamObserver;
import java.util.List;
import java.util.Optional;
import java.util.Set;
import java.util.UUID;
import java.util.stream.Collectors;
import org.hypertrace.config.objectstore.ConfigObject;
Expand All @@ -27,29 +30,15 @@

public class LabelApplicationRuleConfigServiceImpl
extends LabelApplicationRuleConfigServiceGrpc.LabelApplicationRuleConfigServiceImplBase {
static final String LABEL_APPLICATION_RULE_CONFIG_SERVICE_CONFIG =
"label.application.rule.config.service";
static final String MAX_DYNAMIC_LABEL_APPLICATION_RULES_PER_TENANT =
"max.dynamic.label.application.rules.per.tenant";
static final int DEFAULT_MAX_DYNAMIC_LABEL_APPLICATION_RULES_PER_TENANT = 100;
private final IdentifiedObjectStore<LabelApplicationRule> labelApplicationRuleStore;
private final LabelApplicationRuleValidator requestValidator;
private final int maxDynamicLabelApplicationRulesAllowed;
private final LabelApplicationRuleConfig labelApplicationRuleConfig;

public LabelApplicationRuleConfigServiceImpl(
Channel configChannel, Config config, ConfigChangeEventGenerator configChangeEventGenerator) {
int maxDynamicRules = DEFAULT_MAX_DYNAMIC_LABEL_APPLICATION_RULES_PER_TENANT;
if (config.hasPath(LABEL_APPLICATION_RULE_CONFIG_SERVICE_CONFIG)) {
Config labelApplicationRuleConfig =
config.getConfig(LABEL_APPLICATION_RULE_CONFIG_SERVICE_CONFIG);
if (labelApplicationRuleConfig.hasPath(MAX_DYNAMIC_LABEL_APPLICATION_RULES_PER_TENANT)) {
maxDynamicRules =
labelApplicationRuleConfig.getInt(MAX_DYNAMIC_LABEL_APPLICATION_RULES_PER_TENANT);
}
}
this.maxDynamicLabelApplicationRulesAllowed = maxDynamicRules;
this.labelApplicationRuleConfig = new LabelApplicationRuleConfig(config);
aaron-steinfeld marked this conversation as resolved.
Show resolved Hide resolved

ConfigServiceBlockingStub configServiceBlockingStub =
final ConfigServiceBlockingStub configServiceBlockingStub =
ConfigServiceGrpc.newBlockingStub(configChannel)
.withCallCredentials(
RequestContextClientCallCredsProviderFactory.getClientCallCredsProvider().get());
Expand Down Expand Up @@ -96,9 +85,18 @@ public void getLabelApplicationRules(
this.labelApplicationRuleStore.getAllObjects(requestContext).stream()
.map(ConfigObject::getData)
.collect(Collectors.toUnmodifiableList());
Set<String> labelApplicationRuleIds =
labelApplicationRules.stream()
.map(LabelApplicationRule::getId)
.collect(Collectors.toUnmodifiableSet());
List<LabelApplicationRule> filteredSystemLabelApplicationRules =
this.labelApplicationRuleConfig.getSystemLabelApplicationRules().stream()
.filter(rule -> !labelApplicationRuleIds.contains(rule.getId()))
.collect(Collectors.toUnmodifiableList());
responseObserver.onNext(
GetLabelApplicationRulesResponse.newBuilder()
.addAllLabelApplicationRules(labelApplicationRules)
.addAllLabelApplicationRules(filteredSystemLabelApplicationRules)
.build());
responseObserver.onCompleted();
} catch (Exception e) {
Expand All @@ -116,6 +114,12 @@ public void updateLabelApplicationRule(
LabelApplicationRule existingRule =
this.labelApplicationRuleStore
.getData(requestContext, request.getId())
.or(
() ->
Optional.ofNullable(
this.labelApplicationRuleConfig
.getSystemLabelApplicationRulesMap()
.get(request.getId())))
.orElseThrow(Status.NOT_FOUND::asRuntimeException);
LabelApplicationRule updateLabelApplicationRule =
existingRule.toBuilder().setData(request.getData()).build();
Expand All @@ -140,6 +144,14 @@ public void deleteLabelApplicationRule(
try {
RequestContext requestContext = RequestContext.CURRENT.get();
this.requestValidator.validateOrThrow(requestContext, request);
String labelApplicationRuleId = request.getId();
if (this.labelApplicationRuleConfig
.getSystemLabelApplicationRulesMap()
.containsKey(labelApplicationRuleId)) {
// Deleting a system label application rule is not allowed
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We generally allow users to delete default config. Why is this different?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can be done. However deleting a default rule will require a new config store to persist it. Will add it if need arises.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

will do it in separate PR

responseObserver.onError(new StatusRuntimeException(Status.INVALID_ARGUMENT));
return;
}
this.labelApplicationRuleStore
.deleteObject(requestContext, request.getId())
.orElseThrow(Status.NOT_FOUND::asRuntimeException);
Expand All @@ -161,7 +173,8 @@ private void checkRequestForDynamicLabelsLimit(
.filter(
action -> action.hasDynamicLabelExpression() || action.hasDynamicLabelKey())
.count();
if (dynamicLabelApplicationRules >= maxDynamicLabelApplicationRulesAllowed) {
if (dynamicLabelApplicationRules
>= this.labelApplicationRuleConfig.getMaxDynamicLabelApplicationRulesAllowed()) {
throw Status.RESOURCE_EXHAUSTED.asRuntimeException();
}
}
Expand Down
57 changes: 48 additions & 9 deletions ...race/label/application/rule/config/service/LabelApplicationRuleConfigServiceImplTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
package org.hypertrace.label.application.rule.config.service;

import static org.hypertrace.label.application.rule.config.service.LabelApplicationRuleConfigServiceImpl.LABEL_APPLICATION_RULE_CONFIG_SERVICE_CONFIG;
import static org.hypertrace.label.application.rule.config.service.LabelApplicationRuleConfigServiceImpl.MAX_DYNAMIC_LABEL_APPLICATION_RULES_PER_TENANT;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.mockito.Mockito.mock;

import com.google.protobuf.InvalidProtocolBufferException;
import com.google.protobuf.util.JsonFormat;
import com.typesafe.config.Config;
import com.typesafe.config.ConfigFactory;
import io.grpc.Channel;
Expand Down Expand Up @@ -44,20 +44,29 @@
import org.junit.jupiter.api.Test;

public class LabelApplicationRuleConfigServiceImplTest {
private static final String SYSTEM_LABEL_APPLICATION_RULE_STR =
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This test is mocking the config, so mock it (i.e. return a prebuilt rule) rather than do the real parse logic and put it behind a mock. Not only is that not the responsibility of this class/test, but if a change were added to the rule structure this test would miss it silently.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done. Hopefully last review comment to address ;-)

"{\"id\":\"system-label-application-rule-1\",\"data\":{\"name\":\"SystemLabelApplicationRule1\",\"matching_condition\":{\"leaf_condition\":{\"key_condition\":{\"operator\":\"OPERATOR_EQUALS\",\"value\":\"test.key\"},\"unary_condition\":{\"operator\":\"OPERATOR_EXISTS\"}}},\"label_action\":{\"entity_types\":[\"API\"],\"operation\":\"OPERATION_MERGE\",\"static_labels\":{\"ids\":[\"static-label-id-1\"]}},\"enabled\":false}}";
MockGenericConfigService mockGenericConfigService;
LabelApplicationRuleConfigServiceBlockingStub labelApplicationRuleConfigServiceBlockingStub;
LabelApplicationRule systemLabelApplicationRule;

@BeforeEach
void setUp() {
void setUp() throws InvalidProtocolBufferException {
mockGenericConfigService =
new MockGenericConfigService().mockUpsert().mockGet().mockGetAll().mockDelete();
Channel channel = mockGenericConfigService.channel();
ConfigChangeEventGenerator configChangeEventGenerator = mock(ConfigChangeEventGenerator.class);
Config config =
ConfigFactory.parseMap(
Map.of(
LABEL_APPLICATION_RULE_CONFIG_SERVICE_CONFIG,
Map.of(MAX_DYNAMIC_LABEL_APPLICATION_RULES_PER_TENANT, 2)));
String configStr =
aaron-steinfeld marked this conversation as resolved.
Show resolved Hide resolved
"label.application.rule.config.service {\n"
+ "max.dynamic.label.application.rules.per.tenant = 2\n"
+ "system.label.application.rules = [\n"
+ SYSTEM_LABEL_APPLICATION_RULE_STR
+ "\n]\n"
+ "}\n";
Config config = ConfigFactory.parseString(configStr);
LabelApplicationRule.Builder builder = LabelApplicationRule.newBuilder().clear();
JsonFormat.parser().merge(SYSTEM_LABEL_APPLICATION_RULE_STR, builder);
systemLabelApplicationRule = builder.build();
mockGenericConfigService
.addService(
new LabelApplicationRuleConfigServiceImpl(channel, config, configChangeEventGenerator))
Expand Down Expand Up @@ -109,7 +118,8 @@ void createLabelApplicationRuleWithDynamicLabelApplicationRulesLimitReached() {
void getLabelApplicationRules() {
LabelApplicationRule simpleRule = createSimpleRule("auth", "valid");
LabelApplicationRule compositeRule = createCompositeRule();
Set<LabelApplicationRule> expectedRules = Set.of(simpleRule, compositeRule);
Set<LabelApplicationRule> expectedRules =
Set.of(simpleRule, compositeRule, systemLabelApplicationRule);
GetLabelApplicationRulesResponse response =
labelApplicationRuleConfigServiceBlockingStub.getLabelApplicationRules(
GetLabelApplicationRulesRequest.getDefaultInstance());
Expand All @@ -133,6 +143,20 @@ void updateLabelApplicationRule() {
assertEquals(expectedData, response.getLabelApplicationRule().getData());
}

@Test
void updateSystemLabelApplicationRule() {
LabelApplicationRuleData expectedData = buildSimpleRuleData("auth", "not-valid");
UpdateLabelApplicationRuleRequest request =
UpdateLabelApplicationRuleRequest.newBuilder()
.setId(systemLabelApplicationRule.getId())
.setData(expectedData)
.build();
UpdateLabelApplicationRuleResponse response =
labelApplicationRuleConfigServiceBlockingStub.updateLabelApplicationRule(request);
assertEquals(systemLabelApplicationRule.getId(), response.getLabelApplicationRule().getId());
assertEquals(expectedData, response.getLabelApplicationRule().getData());
}

@Test
void updateLabelApplicationRuleError() {
LabelApplicationRule simpleRule = createSimpleRule("auth", "valid");
Expand Down Expand Up @@ -179,6 +203,21 @@ void deleteApplicationRuleError() {
assertEquals(Status.NOT_FOUND, Status.fromThrowable(exception));
}

@Test
void deleteSystemApplicationRuleError() {
DeleteLabelApplicationRuleRequest request =
DeleteLabelApplicationRuleRequest.newBuilder()
.setId(systemLabelApplicationRule.getId())
.build();
Throwable exception =
assertThrows(
StatusRuntimeException.class,
() -> {
labelApplicationRuleConfigServiceBlockingStub.deleteLabelApplicationRule(request);
});
assertEquals(Status.INVALID_ARGUMENT, Status.fromThrowable(exception));
}

private LabelApplicationRuleData buildCompositeRuleData() {
// This condition implies foo(key) exists AND foo(key) = bar(value) AND
// req.http.headers.auth(key) = valid(value)
Expand Down
Loading