Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
9 changes: 9 additions & 0 deletions CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,15 @@ Each Python module has a gradle setup similar to `metadata-ingestion/` (document
- **MCE/MCL**: Metadata Change Events/Logs for updates
- **Entity Registry**: YAML config defining entity-aspect relationships (`metadata-models/src/main/resources/entity-registry.yml`)

### Validation Architecture

**IMPORTANT**: Validation must work across all APIs (GraphQL, OpenAPI, RestLI).

- **Never add validation in API-specific layers** (GraphQL resolvers, REST controllers) - this only protects one API
- **Always implement AspectPayloadValidators** in `metadata-io/src/main/java/com/linkedin/metadata/aspect/validation/`
- **Register as Spring beans** in `SpringStandardPluginConfiguration.java`
- **Follow existing patterns**: See `SystemPolicyValidator.java` and `PolicyFieldTypeValidator.java` as examples

## Development Flow

1. **Schema changes** in `metadata-models/` trigger code generation across all languages
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
package com.linkedin.metadata.aspect.validation;

import com.datahub.authorization.EntityFieldType;
import com.linkedin.metadata.aspect.RetrieverContext;
import com.linkedin.metadata.aspect.batch.BatchItem;
import com.linkedin.metadata.aspect.batch.ChangeMCP;
import com.linkedin.metadata.aspect.plugins.config.AspectPluginConfig;
import com.linkedin.metadata.aspect.plugins.validation.AspectPayloadValidator;
import com.linkedin.metadata.aspect.plugins.validation.AspectValidationException;
import com.linkedin.metadata.aspect.plugins.validation.ValidationExceptionCollection;
import com.linkedin.policy.DataHubPolicyInfo;
import com.linkedin.policy.PolicyMatchCriterion;
import com.linkedin.policy.PolicyMatchFilter;
import java.util.Arrays;
import java.util.Collection;
import java.util.Set;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import javax.annotation.Nonnull;
import lombok.Getter;
import lombok.Setter;
import lombok.experimental.Accessors;
import lombok.extern.slf4j.Slf4j;

/**
* Validator to ensure that policy filter field types and privilege constraint field types are valid
* EntityFieldType enum values.
*/
@Slf4j
@Setter
@Getter
@Accessors(chain = true)
public class PolicyFieldTypeValidator extends AspectPayloadValidator {
@Nonnull private AspectPluginConfig config;

private static final Set<String> VALID_ENTITY_FIELD_TYPES =
Arrays.stream(EntityFieldType.values())
.map(EntityFieldType::name)
.collect(Collectors.toSet());

@Override
protected Stream<AspectValidationException> validateProposedAspects(
@Nonnull Collection<? extends BatchItem> mcpItems,
@Nonnull RetrieverContext retrieverContext) {

ValidationExceptionCollection exceptions = ValidationExceptionCollection.newCollection();

mcpItems.forEach(
item -> {
DataHubPolicyInfo policyInfo = item.getAspect(DataHubPolicyInfo.class);
if (policyInfo != null && policyInfo.hasResources()) {
if (policyInfo.getResources().hasFilter()) {
validateFilter(item, policyInfo.getResources().getFilter(), exceptions);
}
if (policyInfo.getResources().hasPrivilegeConstraints()) {
validateFilter(item, policyInfo.getResources().getPrivilegeConstraints(), exceptions);
}
}
});

return exceptions.streamAllExceptions();
}

private void validateFilter(
BatchItem item, PolicyMatchFilter filter, ValidationExceptionCollection exceptions) {
if (filter != null && filter.hasCriteria()) {
for (PolicyMatchCriterion criterion : filter.getCriteria()) {
String field = criterion.getField();
if (!VALID_ENTITY_FIELD_TYPES.contains(field)) {
exceptions.addException(
AspectValidationException.forItem(
item,
String.format(
"Invalid field type '%s'. Must be one of: %s",
field, String.join(", ", VALID_ENTITY_FIELD_TYPES))));
}
}
}
}

@Override
protected Stream<AspectValidationException> validatePreCommitAspects(
@Nonnull Collection<ChangeMCP> changeMCPs, @Nonnull RetrieverContext retrieverContext) {
return Stream.empty();
}
}
Loading
Loading