Skip to content

[Backport 2.19-dev] change Anonymizer to mask PPL #4488

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

Merged
ykmr1224 merged 2 commits into from
Oct 10, 2025
Merged

[Backport 2.19-dev] change Anonymizer to mask PPL #4488

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bc6f2e8
change Anonymizer to mask PPL (#4352)
github-actions[bot] Oct 9, 2025
73c6ebe
Fix test failure
ykmr1224 Oct 9, 2025
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
50 changes: 25 additions & 25 deletions ppl/src/main/java/org/opensearch/sql/ppl/utils/PPLQueryDataAnonymizer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,10 @@ public class PPLQueryDataAnonymizer extends AbstractNodeVisitor<String, String>
private static final String MASK_LITERAL = "***";
private static final String MASK_IDENTIFIER = "identifier";

private static final String MASK_COLUMN = "identifier";

private static final String MASK_TABLE = "table";

private final AnonymizerExpressionAnalyzer expressionAnalyzer;
private final Settings settings;

Expand Down Expand Up @@ -145,12 +149,9 @@ public String visitExplain(Explain node, String context) {
@Override
public String visitRelation(Relation node, String context) {
if (node instanceof DescribeRelation) {
// remove the system table suffix
String systemTable = node.getTableQualifiedName().toString();
return StringUtils.format(
"describe %s", systemTable.substring(0, systemTable.lastIndexOf('.')));
return StringUtils.format("describe %s", MASK_TABLE);
}
return StringUtils.format("source=%s", node.getTableQualifiedName().toString());
return StringUtils.format("source=%s", MASK_TABLE);
}

@Override
Expand Down Expand Up @@ -185,31 +186,30 @@ public String visitJoin(Join node, String context) {
.collect(Collectors.toList()));
return StringUtils.format(
"%s | join type=%s overwrite=%s max=%s %s %s",
left, joinType, overwrite, max, fieldList, right);
left, joinType, MASK_LITERAL, MASK_LITERAL, fieldList, right);
} else {
String joinType = node.getJoinType().name().toLowerCase(Locale.ROOT);
String leftAlias = node.getLeftAlias().map(l -> " left = " + l).orElse("");
String rightAlias = node.getRightAlias().map(r -> " right = " + r).orElse("");
String leftAlias = node.getLeftAlias().map(l -> " left = " + MASK_COLUMN).orElse("");
String rightAlias = node.getRightAlias().map(r -> " right = " + MASK_COLUMN).orElse("");
String condition =
node.getJoinCondition().map(c -> expressionAnalyzer.analyze(c, context)).orElse("true");
return StringUtils.format(
"%s | %s join max=%s%s%s on %s %s",
left, joinType, max, leftAlias, rightAlias, condition, right);
left, joinType, MASK_LITERAL, leftAlias, rightAlias, condition, right);
}
}

@Override
public String visitLookup(Lookup node, String context) {
String child = node.getChild().get(0).accept(this, context);
String lookupTable = ((Relation) node.getLookupRelation()).getTableQualifiedName().toString();
String mappingFields = formatFieldAlias(node.getMappingAliasMap());
String strategy =
node.getOutputAliasMap().isEmpty()
? ""
: String.format(" %s ", node.getOutputStrategy().toString().toLowerCase());
String outputFields = formatFieldAlias(node.getOutputAliasMap());
return StringUtils.format(
"%s | lookup %s %s%s%s", child, lookupTable, mappingFields, strategy, outputFields);
"%s | lookup %s %s%s%s", child, MASK_TABLE, mappingFields, strategy, outputFields);
}

private String formatFieldAlias(java.util.Map<String, String> fieldMap) {
Expand All @@ -234,7 +234,7 @@ public String visitSubqueryAlias(SubqueryAlias node, String context) {
}
// add "[]" only if its child is not a root
String format = childNode.getChild().isEmpty() ? "%s as %s" : "[ %s ] as %s";
return StringUtils.format(format, child, node.getAlias());
return StringUtils.format(format, child, MASK_COLUMN);
}

@Override
Expand Down Expand Up @@ -274,8 +274,8 @@ public String visitRename(Rename node, String context) {
((Field) renameMap.getTarget()).getField().toString());
}
String renames =
renameMapBuilder.build().entrySet().stream()
.map(entry -> StringUtils.format("%s as %s", entry.getKey(), entry.getValue()))
node.getRenameList().stream()
.map(entry -> StringUtils.format("%s as %s", MASK_COLUMN, MASK_COLUMN))
.collect(Collectors.joining(","));
return StringUtils.format("%s | rename %s", child, renames);
}
Expand Down Expand Up @@ -340,7 +340,7 @@ public String visitBin(Bin node, String context) {
}

if (node.getAlias() != null) {
binCommand.append(" as ").append(node.getAlias());
binCommand.append(" as ").append(MASK_COLUMN);
}

return StringUtils.format("%s%s", child, binCommand.toString());
Expand Down Expand Up @@ -410,7 +410,7 @@ public String visitEval(Eval node, String context) {
}
String expressions =
expressionsBuilder.build().stream()
.map(pair -> StringUtils.format("%s" + "=%s", pair.getLeft(), pair.getRight()))
.map(pair -> StringUtils.format("%s" + "=%s", MASK_COLUMN, pair.getRight()))
.collect(Collectors.joining(" "));
return StringUtils.format("%s | eval %s", child, expressions);
}
Expand Down Expand Up @@ -500,7 +500,7 @@ public String visitTimechart(Timechart node, String context) {
public String visitRex(Rex node, String context) {
String child = node.getChild().get(0).accept(this, context);
String field = visitExpression(node.getField());
String pattern = "\"" + node.getPattern().toString() + "\"";
String pattern = "\"" + MASK_LITERAL + "\"";
StringBuilder command = new StringBuilder();

command.append(
Expand All @@ -509,11 +509,11 @@ public String visitRex(Rex node, String context) {
child, field, node.getMode().toString().toLowerCase(), pattern));

if (node.getMaxMatch().isPresent()) {
command.append(" max_match=").append(node.getMaxMatch().get());
command.append(" max_match=").append(MASK_LITERAL);
}

if (node.getOffsetField().isPresent()) {
command.append(" offset_field=").append(node.getOffsetField().get());
command.append(" offset_field=").append(MASK_COLUMN);
}

return command.toString();
Expand All @@ -539,7 +539,7 @@ public String visitParse(Parse node, String context) {
}
return ParseMethod.PATTERNS.equals(node.getParseMethod()) && regex.isEmpty()
? StringUtils.format("%s | %s %s", child, commandName, source)
: StringUtils.format("%s | %s %s '%s'", child, commandName, source, regex);
: StringUtils.format("%s | %s %s '%s'", child, commandName, source, MASK_LITERAL);
}

@Override
Expand Down Expand Up @@ -696,7 +696,7 @@ public String visitPatterns(Patterns node, String context) {
builder.append(" mode=").append(node.getPatternMode().toString());
builder.append(" max_sample_count=").append(visitExpression(node.getPatternMaxSampleCount()));
builder.append(" buffer_limit=").append(visitExpression(node.getPatternBufferLimit()));
builder.append(" new_field=").append(node.getAlias());
builder.append(" new_field=").append(MASK_COLUMN);
if (!node.getArguments().isEmpty()) {
for (java.util.Map.Entry<String, Literal> entry : node.getArguments().entrySet()) {
builder.append(
Expand Down Expand Up @@ -830,7 +830,7 @@ public String visitIn(In node, String context) {

@Override
public String visitField(Field node, String context) {
return node.getField().toString();
return MASK_COLUMN;
}

@Override
Expand All @@ -852,7 +852,7 @@ public String visitAlias(Alias node, String context) {
@Override
public String visitTrendlineComputation(Trendline.TrendlineComputation node, String context) {
final String dataField = node.getDataField().accept(this, context);
final String aliasClause = " as " + node.getAlias();
final String aliasClause = " as " + MASK_COLUMN;
final String computationType = node.getComputationType().name().toLowerCase(Locale.ROOT);
return StringUtils.format(
"%s(%d, %s)%s", computationType, node.getNumberOfDataPoints(), dataField, aliasClause);
Expand Down Expand Up @@ -881,7 +881,7 @@ public String visitExistsSubquery(ExistsSubquery node, String context) {
@Override
public String visitCase(Case node, String context) {
StringBuilder builder = new StringBuilder();
builder.append("cast(");
builder.append("case(");
for (When when : node.getWhenClauses()) {
builder.append(analyze(when.getCondition(), context));
builder.append(",");
Expand All @@ -908,7 +908,7 @@ public String visitCast(Cast node, String context) {
@Override
public String visitQualifiedName(
org.opensearch.sql.ast.expression.QualifiedName node, String context) {
return String.join(".", node.getParts());
return MASK_COLUMN;
}
}
}
Loading
Loading